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
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
40 * @defgroup libavc Encoding/Decoding Library
43 * @defgroup lavc_decoding Decoding
47 * @defgroup lavc_encoding Encoding
51 * @defgroup lavc_codec Codecs
53 * @defgroup lavc_codec_native Native Codecs
56 * @defgroup lavc_codec_wrappers External library wrappers
59 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
63 * @defgroup lavc_internal Internal
71 * @defgroup lavc_core Core functions/structures.
74 * Basic definitions, functions for querying libavcodec capabilities,
75 * allocating core structures, etc.
81 * Identify the syntax and semantics of the bitstream.
82 * The principle is roughly:
83 * Two decoders with the same ID can decode the same streams.
84 * Two encoders with the same ID can encode compatible streams.
85 * There may be slight deviations from the principle due to implementation
88 * If you add a codec ID to this list, add it so that
89 * 1. no value of a existing codec ID changes (that would break ABI),
90 * 2. it is as close as possible to similar codecs.
92 * After adding new codec IDs, do not forget to add an entry to the codec
93 * descriptor list and bump libavcodec minor version.
99 AV_CODEC_ID_MPEG1VIDEO,
100 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
101 AV_CODEC_ID_MPEG2VIDEO_XVMC,
112 AV_CODEC_ID_RAWVIDEO,
113 AV_CODEC_ID_MSMPEG4V1,
114 AV_CODEC_ID_MSMPEG4V2,
115 AV_CODEC_ID_MSMPEG4V3,
138 AV_CODEC_ID_INTERPLAY_VIDEO,
145 AV_CODEC_ID_MSVIDEO1,
150 AV_CODEC_ID_TRUEMOTION1,
151 AV_CODEC_ID_VMDVIDEO,
177 AV_CODEC_ID_TRUEMOTION2,
183 AV_CODEC_ID_SMACKVIDEO,
188 AV_CODEC_ID_JPEG2000,
194 AV_CODEC_ID_DSICINVIDEO,
195 AV_CODEC_ID_TIERTEXSEQVIDEO,
203 AV_CODEC_ID_BETHSOFTVID,
215 AV_CODEC_ID_ESCAPE124,
219 AV_CODEC_ID_MOTIONPIXELS,
231 AV_CODEC_ID_FLASHSV2,
232 AV_CODEC_ID_CDGRAPHICS,
235 AV_CODEC_ID_BINKVIDEO,
236 AV_CODEC_ID_IFF_ILBM,
237 AV_CODEC_ID_IFF_BYTERUN1,
243 AV_CODEC_ID_A64_MULTI,
244 AV_CODEC_ID_A64_MULTI5,
247 AV_CODEC_ID_LAGARITH,
251 AV_CODEC_ID_WMV3IMAGE,
252 AV_CODEC_ID_VC1IMAGE,
254 AV_CODEC_ID_BMV_VIDEO,
261 AV_CODEC_ID_ZEROCODEC,
268 /* various PCM "codecs" */
269 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
270 AV_CODEC_ID_PCM_S16LE = 0x10000,
271 AV_CODEC_ID_PCM_S16BE,
272 AV_CODEC_ID_PCM_U16LE,
273 AV_CODEC_ID_PCM_U16BE,
276 AV_CODEC_ID_PCM_MULAW,
277 AV_CODEC_ID_PCM_ALAW,
278 AV_CODEC_ID_PCM_S32LE,
279 AV_CODEC_ID_PCM_S32BE,
280 AV_CODEC_ID_PCM_U32LE,
281 AV_CODEC_ID_PCM_U32BE,
282 AV_CODEC_ID_PCM_S24LE,
283 AV_CODEC_ID_PCM_S24BE,
284 AV_CODEC_ID_PCM_U24LE,
285 AV_CODEC_ID_PCM_U24BE,
286 AV_CODEC_ID_PCM_S24DAUD,
287 AV_CODEC_ID_PCM_ZORK,
288 AV_CODEC_ID_PCM_S16LE_PLANAR,
290 AV_CODEC_ID_PCM_F32BE,
291 AV_CODEC_ID_PCM_F32LE,
292 AV_CODEC_ID_PCM_F64BE,
293 AV_CODEC_ID_PCM_F64LE,
294 AV_CODEC_ID_PCM_BLURAY,
297 AV_CODEC_ID_PCM_S8_PLANAR,
299 /* various ADPCM codecs */
300 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
301 AV_CODEC_ID_ADPCM_IMA_WAV,
302 AV_CODEC_ID_ADPCM_IMA_DK3,
303 AV_CODEC_ID_ADPCM_IMA_DK4,
304 AV_CODEC_ID_ADPCM_IMA_WS,
305 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
306 AV_CODEC_ID_ADPCM_MS,
307 AV_CODEC_ID_ADPCM_4XM,
308 AV_CODEC_ID_ADPCM_XA,
309 AV_CODEC_ID_ADPCM_ADX,
310 AV_CODEC_ID_ADPCM_EA,
311 AV_CODEC_ID_ADPCM_G726,
312 AV_CODEC_ID_ADPCM_CT,
313 AV_CODEC_ID_ADPCM_SWF,
314 AV_CODEC_ID_ADPCM_YAMAHA,
315 AV_CODEC_ID_ADPCM_SBPRO_4,
316 AV_CODEC_ID_ADPCM_SBPRO_3,
317 AV_CODEC_ID_ADPCM_SBPRO_2,
318 AV_CODEC_ID_ADPCM_THP,
319 AV_CODEC_ID_ADPCM_IMA_AMV,
320 AV_CODEC_ID_ADPCM_EA_R1,
321 AV_CODEC_ID_ADPCM_EA_R3,
322 AV_CODEC_ID_ADPCM_EA_R2,
323 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
324 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
325 AV_CODEC_ID_ADPCM_EA_XAS,
326 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
327 AV_CODEC_ID_ADPCM_IMA_ISS,
328 AV_CODEC_ID_ADPCM_G722,
329 AV_CODEC_ID_ADPCM_IMA_APC,
332 AV_CODEC_ID_AMR_NB = 0x12000,
335 /* RealAudio codecs*/
336 AV_CODEC_ID_RA_144 = 0x13000,
339 /* various DPCM codecs */
340 AV_CODEC_ID_ROQ_DPCM = 0x14000,
341 AV_CODEC_ID_INTERPLAY_DPCM,
342 AV_CODEC_ID_XAN_DPCM,
343 AV_CODEC_ID_SOL_DPCM,
346 AV_CODEC_ID_MP2 = 0x15000,
347 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
357 AV_CODEC_ID_VMDAUDIO,
363 AV_CODEC_ID_WESTWOOD_SND1,
364 AV_CODEC_ID_GSM, ///< as in Berlin toast format
367 AV_CODEC_ID_TRUESPEECH,
369 AV_CODEC_ID_SMACKAUDIO,
372 AV_CODEC_ID_DSICINAUDIO,
374 AV_CODEC_ID_MUSEPACK7,
376 AV_CODEC_ID_GSM_MS, /* as found in WAV */
380 AV_CODEC_ID_NELLYMOSER,
381 AV_CODEC_ID_MUSEPACK8,
383 AV_CODEC_ID_WMAVOICE,
385 AV_CODEC_ID_WMALOSSLESS,
394 AV_CODEC_ID_BINKAUDIO_RDFT,
395 AV_CODEC_ID_BINKAUDIO_DCT,
396 AV_CODEC_ID_AAC_LATM,
401 AV_CODEC_ID_8SVX_EXP,
402 AV_CODEC_ID_8SVX_FIB,
403 AV_CODEC_ID_BMV_AUDIO,
408 /* subtitle codecs */
409 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
410 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
411 AV_CODEC_ID_DVB_SUBTITLE,
412 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
415 AV_CODEC_ID_MOV_TEXT,
416 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
417 AV_CODEC_ID_DVB_TELETEXT,
420 /* other specific kind of codecs (generally used for attachments) */
421 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
422 AV_CODEC_ID_TTF = 0x18000,
424 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
426 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
427 * stream (only used by libavformat) */
428 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
429 * stream (only used by libavformat) */
430 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
433 #include "old_codec_ids.h"
438 #define CodecID AVCodecID
442 * This struct describes the properties of a single codec described by an
444 * @see avcodec_get_descriptor()
446 typedef struct AVCodecDescriptor {
448 enum AVMediaType type;
450 * Name of the codec described by this descriptor. It is non-empty and
451 * unique for each codec descriptor. It should contain alphanumeric
452 * characters and '_' only.
456 * A more descriptive name for this codec. May be NULL.
458 const char *long_name;
460 * Codec properties, a combination of AV_CODEC_PROP_* flags.
466 * Codec uses only intra compression.
469 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
471 #if FF_API_OLD_DECODE_AUDIO
473 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
477 * @ingroup lavc_decoding
478 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
479 * This is mainly needed because some optimized bitstream readers read
480 * 32 or 64 bit at once and could read over the end.<br>
481 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
482 * MPEG bitstreams could cause overread and segfault.
484 #define FF_INPUT_BUFFER_PADDING_SIZE 8
487 * @ingroup lavc_encoding
488 * minimum encoding buffer size
489 * Used to avoid some checks during header writing.
491 #define FF_MIN_BUFFER_SIZE 16384
495 * @ingroup lavc_encoding
496 * motion estimation type.
499 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
503 ME_EPZS, ///< enhanced predictive zonal search
504 ME_X1, ///< reserved for experiments
505 ME_HEX, ///< hexagon based search
506 ME_UMH, ///< uneven multi-hexagon search
507 ME_ITER, ///< iterative search
508 ME_TESA, ///< transformed exhaustive search algorithm
512 * @ingroup lavc_decoding
515 /* We leave some space between them for extensions (drop some
516 * keyframes for intra-only or drop just some bidir frames). */
517 AVDISCARD_NONE =-16, ///< discard nothing
518 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
519 AVDISCARD_NONREF = 8, ///< discard all non reference
520 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
521 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
522 AVDISCARD_ALL = 48, ///< discard all
525 enum AVColorPrimaries{
526 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
527 AVCOL_PRI_UNSPECIFIED = 2,
528 AVCOL_PRI_BT470M = 4,
529 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
530 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
531 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
533 AVCOL_PRI_NB , ///< Not part of ABI
536 enum AVColorTransferCharacteristic{
537 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
538 AVCOL_TRC_UNSPECIFIED = 2,
539 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
540 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
541 AVCOL_TRC_SMPTE240M = 7,
542 AVCOL_TRC_NB , ///< Not part of ABI
547 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
548 AVCOL_SPC_UNSPECIFIED = 2,
550 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
551 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
552 AVCOL_SPC_SMPTE240M = 7,
553 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
554 AVCOL_SPC_NB , ///< Not part of ABI
558 AVCOL_RANGE_UNSPECIFIED = 0,
559 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
560 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
561 AVCOL_RANGE_NB , ///< Not part of ABI
565 * X X 3 4 X X are luma samples,
566 * 1 2 1-6 are possible chroma positions
567 * X X 5 6 X 0 is undefined/unknown position
569 enum AVChromaLocation{
570 AVCHROMA_LOC_UNSPECIFIED = 0,
571 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
572 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
573 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
574 AVCHROMA_LOC_TOP = 4,
575 AVCHROMA_LOC_BOTTOMLEFT = 5,
576 AVCHROMA_LOC_BOTTOM = 6,
577 AVCHROMA_LOC_NB , ///< Not part of ABI
580 enum AVAudioServiceType {
581 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
582 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
583 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
584 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
585 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
586 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
587 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
588 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
589 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
590 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
594 * @ingroup lavc_encoding
596 typedef struct RcOverride{
599 int qscale; // If this is 0 then quality_factor will be used instead.
600 float quality_factor;
603 #define FF_MAX_B_FRAMES 16
606 These flags can be passed in AVCodecContext.flags before initialization.
607 Note: Not everything is supported yet.
610 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
611 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
612 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
613 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
614 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
616 * The parent program guarantees that the input for B-frames containing
617 * streams is not written to for at least s->max_b_frames+1 frames, if
618 * this is not set the input will be copied.
620 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
621 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
622 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
623 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
624 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
625 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
626 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
627 location instead of only at frame boundaries. */
628 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
629 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
630 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
631 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
632 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
633 /* Fx : Flag for h263+ extra options */
634 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
635 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
636 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
637 #define CODEC_FLAG_CLOSED_GOP 0x80000000
638 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
639 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
640 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
641 #if FF_API_MPV_GLOBAL_OPTS
642 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
643 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
644 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
645 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
647 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
649 /* Unsupported options :
650 * Syntax Arithmetic coding (SAC)
651 * Reference Picture Selection
652 * Independent Segment Decoding */
654 /* codec capabilities */
656 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
658 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
659 * If not set, it might not use get_buffer() at all or use operations that
660 * assume the buffer was allocated by avcodec_default_get_buffer.
662 #define CODEC_CAP_DR1 0x0002
663 #define CODEC_CAP_TRUNCATED 0x0008
664 /* Codec can export data for HW decoding (XvMC). */
665 #define CODEC_CAP_HWACCEL 0x0010
667 * Encoder or decoder requires flushing with NULL input at the end in order to
668 * give the complete and correct output.
670 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
671 * with NULL data. The user can still send NULL data to the public encode
672 * or decode function, but libavcodec will not pass it along to the codec
673 * unless this flag is set.
676 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
677 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
681 * The encoder needs to be fed with NULL data at the end of encoding until the
682 * encoder no longer returns data.
684 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
685 * flag also means that the encoder must set the pts and duration for
686 * each output packet. If this flag is not set, the pts and duration will
687 * be determined by libavcodec from the input frame.
689 #define CODEC_CAP_DELAY 0x0020
691 * Codec can be fed a final frame with a smaller size.
692 * This can be used to prevent truncation of the last audio samples.
694 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
696 * Codec can export data for HW decoding (VDPAU).
698 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
700 * Codec can output multiple frames per AVPacket
701 * Normally demuxers return one frame at a time, demuxers which do not do
702 * are connected to a parser to split what they return into proper frames.
703 * This flag is reserved to the very rare category of codecs which have a
704 * bitstream that cannot be split into frames without timeconsuming
705 * operations like full decoding. Demuxers carring such bitstreams thus
706 * may return multiple frames in a packet. This has many disadvantages like
707 * prohibiting stream copy in many cases thus it should only be considered
710 #define CODEC_CAP_SUBFRAMES 0x0100
712 * Codec is experimental and is thus avoided in favor of non experimental
715 #define CODEC_CAP_EXPERIMENTAL 0x0200
717 * Codec should fill in channel configuration and samplerate instead of container
719 #define CODEC_CAP_CHANNEL_CONF 0x0400
721 * Codec is able to deal with negative linesizes
723 #define CODEC_CAP_NEG_LINESIZES 0x0800
725 * Codec supports frame-level multithreading.
727 #define CODEC_CAP_FRAME_THREADS 0x1000
729 * Codec supports slice-based (or partition-based) multithreading.
731 #define CODEC_CAP_SLICE_THREADS 0x2000
733 * Codec supports changed parameters at any point.
735 #define CODEC_CAP_PARAM_CHANGE 0x4000
737 * Codec supports avctx->thread_count == 0 (auto).
739 #define CODEC_CAP_AUTO_THREADS 0x8000
741 * Audio encoder supports receiving a different number of samples in each call.
743 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
745 //The following defines may change, don't expect compatibility if you use them.
746 #define MB_TYPE_INTRA4x4 0x0001
747 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
748 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
749 #define MB_TYPE_16x16 0x0008
750 #define MB_TYPE_16x8 0x0010
751 #define MB_TYPE_8x16 0x0020
752 #define MB_TYPE_8x8 0x0040
753 #define MB_TYPE_INTERLACED 0x0080
754 #define MB_TYPE_DIRECT2 0x0100 //FIXME
755 #define MB_TYPE_ACPRED 0x0200
756 #define MB_TYPE_GMC 0x0400
757 #define MB_TYPE_SKIP 0x0800
758 #define MB_TYPE_P0L0 0x1000
759 #define MB_TYPE_P1L0 0x2000
760 #define MB_TYPE_P0L1 0x4000
761 #define MB_TYPE_P1L1 0x8000
762 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
763 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
764 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
765 #define MB_TYPE_QUANT 0x00010000
766 #define MB_TYPE_CBP 0x00020000
767 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
771 * This specifies the area which should be displayed.
772 * Note there may be multiple such areas for one frame.
774 typedef struct AVPanScan{
777 * - encoding: Set by user.
778 * - decoding: Set by libavcodec.
783 * width and height in 1/16 pel
784 * - encoding: Set by user.
785 * - decoding: Set by libavcodec.
791 * position of the top left corner in 1/16 pel for up to 3 fields/frames
792 * - encoding: Set by user.
793 * - decoding: Set by libavcodec.
795 int16_t position[3][2];
798 #define FF_QSCALE_TYPE_MPEG1 0
799 #define FF_QSCALE_TYPE_MPEG2 1
800 #define FF_QSCALE_TYPE_H264 2
801 #define FF_QSCALE_TYPE_VP56 3
803 #define FF_BUFFER_TYPE_INTERNAL 1
804 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
805 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
806 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
808 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
809 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
810 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
811 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
814 * @defgroup lavc_packet AVPacket
816 * Types and functions for working with AVPacket.
819 enum AVPacketSideDataType {
821 AV_PKT_DATA_NEW_EXTRADATA,
824 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
827 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
828 * s32le channel_count
829 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
830 * u64le channel_layout
831 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
833 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
838 AV_PKT_DATA_PARAM_CHANGE,
841 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
842 * structures with info about macroblocks relevant to splitting the
843 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
844 * That is, it does not necessarily contain info about all macroblocks,
845 * as long as the distance between macroblocks in the info is smaller
846 * than the target payload size.
847 * Each MB info structure is 12 bytes, and is laid out as follows:
849 * u32le bit offset from the start of the packet
850 * u8 current quantizer at the start of the macroblock
852 * u16le macroblock address within the GOB
853 * u8 horizontal MV predictor
854 * u8 vertical MV predictor
855 * u8 horizontal MV predictor for block number 3
856 * u8 vertical MV predictor for block number 3
859 AV_PKT_DATA_H263_MB_INFO,
862 typedef struct AVPacket {
864 * Presentation timestamp in AVStream->time_base units; the time at which
865 * the decompressed packet will be presented to the user.
866 * Can be AV_NOPTS_VALUE if it is not stored in the file.
867 * pts MUST be larger or equal to dts as presentation cannot happen before
868 * decompression, unless one wants to view hex dumps. Some formats misuse
869 * the terms dts and pts/cts to mean something different. Such timestamps
870 * must be converted to true pts/dts before they are stored in AVPacket.
874 * Decompression timestamp in AVStream->time_base units; the time at which
875 * the packet is decompressed.
876 * Can be AV_NOPTS_VALUE if it is not stored in the file.
883 * A combination of AV_PKT_FLAG values
887 * Additional packet data that can be provided by the container.
888 * Packet can contain several types of side information.
893 enum AVPacketSideDataType type;
898 * Duration of this packet in AVStream->time_base units, 0 if unknown.
899 * Equals next_pts - this_pts in presentation order.
902 void (*destruct)(struct AVPacket *);
904 int64_t pos; ///< byte position in stream, -1 if unknown
907 * Time difference in AVStream->time_base units from the pts of this
908 * packet to the point at which the output from the decoder has converged
909 * independent from the availability of previous frames. That is, the
910 * frames are virtually identical no matter if decoding started from
911 * the very first frame or from this keyframe.
912 * Is AV_NOPTS_VALUE if unknown.
913 * This field is not the display duration of the current packet.
914 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
917 * The purpose of this field is to allow seeking in streams that have no
918 * keyframes in the conventional sense. It corresponds to the
919 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
920 * essential for some types of subtitle streams to ensure that all
921 * subtitles are correctly displayed after seeking.
923 int64_t convergence_duration;
925 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
926 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
928 enum AVSideDataParamChangeFlags {
929 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
930 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
931 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
932 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
940 * New fields can be added to the end of AVFRAME with minor version
941 * bumps. Removal, reordering and changes to existing fields require
942 * a major version bump.
943 * sizeof(AVFrame) must not be used outside libav*.
945 typedef struct AVFrame {
946 #define AV_NUM_DATA_POINTERS 8
948 * pointer to the picture/channel planes.
949 * This might be different from the first allocated byte
950 * - encoding: Set by user
951 * - decoding: set by AVCodecContext.get_buffer()
953 uint8_t *data[AV_NUM_DATA_POINTERS];
956 * Size, in bytes, of the data for each picture/channel plane.
958 * For audio, only linesize[0] may be set. For planar audio, each channel
959 * plane must be the same size.
961 * - encoding: Set by user
962 * - decoding: set by AVCodecContext.get_buffer()
964 int linesize[AV_NUM_DATA_POINTERS];
967 * pointers to the data planes/channels.
969 * For video, this should simply point to data[].
971 * For planar audio, each channel has a separate data pointer, and
972 * linesize[0] contains the size of each channel buffer.
973 * For packed audio, there is just one data pointer, and linesize[0]
974 * contains the total size of the buffer for all channels.
976 * Note: Both data and extended_data will always be set by get_buffer(),
977 * but for planar audio with more channels that can fit in data,
978 * extended_data must be used by the decoder in order to access all
982 * decoding: set by AVCodecContext.get_buffer()
984 uint8_t **extended_data;
987 * width and height of the video frame
989 * - decoding: Read by user.
994 * number of audio samples (per channel) described by this frame
995 * - encoding: Set by user
996 * - decoding: Set by libavcodec
1001 * format of the frame, -1 if unknown or unset
1002 * Values correspond to enum PixelFormat for video frames,
1003 * enum AVSampleFormat for audio)
1004 * - encoding: unused
1005 * - decoding: Read by user.
1010 * 1 -> keyframe, 0-> not
1011 * - encoding: Set by libavcodec.
1012 * - decoding: Set by libavcodec.
1017 * Picture type of the frame, see ?_TYPE below.
1018 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1019 * - decoding: Set by libavcodec.
1021 enum AVPictureType pict_type;
1024 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1025 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1029 uint8_t *base[AV_NUM_DATA_POINTERS];
1032 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1033 * - encoding: unused
1034 * - decoding: Read by user.
1036 AVRational sample_aspect_ratio;
1039 * presentation timestamp in time_base units (time when frame should be shown to user)
1040 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1041 * - encoding: MUST be set by user.
1042 * - decoding: Set by libavcodec.
1047 * reordered pts from the last AVPacket that has been input into the decoder
1048 * - encoding: unused
1049 * - decoding: Read by user.
1054 * dts from the last AVPacket that has been input into the decoder
1055 * - encoding: unused
1056 * - decoding: Read by user.
1061 * picture number in bitstream order
1062 * - encoding: set by
1063 * - decoding: Set by libavcodec.
1065 int coded_picture_number;
1067 * picture number in display order
1068 * - encoding: set by
1069 * - decoding: Set by libavcodec.
1071 int display_picture_number;
1074 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1075 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1076 * - decoding: Set by libavcodec.
1081 * is this picture used as reference
1082 * The values for this are the same as the MpegEncContext.picture_structure
1083 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1084 * Set to 4 for delayed, non-reference frames.
1085 * - encoding: unused
1086 * - decoding: Set by libavcodec. (before get_buffer() call)).
1092 * - encoding: unused
1093 * - decoding: Set by libavcodec.
1095 int8_t *qscale_table;
1098 * - encoding: unused
1099 * - decoding: Set by libavcodec.
1109 * mbskip_table[mb]>=1 if MB didn't change
1110 * stride= mb_width = (width+15)>>4
1111 * - encoding: unused
1112 * - decoding: Set by libavcodec.
1114 uint8_t *mbskip_table;
1117 * motion vector table
1120 * int mv_sample_log2= 4 - motion_subsample_log2;
1121 * int mb_width= (width+15)>>4;
1122 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1123 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1125 * - encoding: Set by user.
1126 * - decoding: Set by libavcodec.
1128 int16_t (*motion_val[2])[2];
1131 * macroblock type table
1132 * mb_type_base + mb_width + 2
1133 * - encoding: Set by user.
1134 * - decoding: Set by libavcodec.
1140 * - encoding: unused
1141 * - decoding: Set by libavcodec.
1146 * motion reference frame index
1147 * the order in which these are stored can depend on the codec.
1148 * - encoding: Set by user.
1149 * - decoding: Set by libavcodec.
1151 int8_t *ref_index[2];
1154 * for some private data of the user
1155 * - encoding: unused
1156 * - decoding: Set by user.
1162 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1163 * - decoding: unused
1165 uint64_t error[AV_NUM_DATA_POINTERS];
1168 * type of the buffer (to keep track of who has to deallocate data[*])
1169 * - encoding: Set by the one who allocates it.
1170 * - decoding: Set by the one who allocates it.
1171 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1176 * When decoding, this signals how much the picture must be delayed.
1177 * extra_delay = repeat_pict / (2*fps)
1178 * - encoding: unused
1179 * - decoding: Set by libavcodec.
1184 * The content of the picture is interlaced.
1185 * - encoding: Set by user.
1186 * - decoding: Set by libavcodec. (default 0)
1188 int interlaced_frame;
1191 * If the content is interlaced, is top field displayed first.
1192 * - encoding: Set by user.
1193 * - decoding: Set by libavcodec.
1195 int top_field_first;
1198 * Tell user application that palette has changed from previous frame.
1199 * - encoding: ??? (no palette-enabled encoder yet)
1200 * - decoding: Set by libavcodec. (default 0).
1202 int palette_has_changed;
1205 * codec suggestion on buffer type if != 0
1206 * - encoding: unused
1207 * - decoding: Set by libavcodec. (before get_buffer() call)).
1213 * - encoding: Set by user.
1214 * - decoding: Set by libavcodec.
1216 AVPanScan *pan_scan;
1219 * reordered opaque 64bit (generally an integer or a double precision float
1220 * PTS but can be anything).
1221 * The user sets AVCodecContext.reordered_opaque to represent the input at
1223 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1224 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1225 * @deprecated in favor of pkt_pts
1226 * - encoding: unused
1227 * - decoding: Read by user.
1229 int64_t reordered_opaque;
1232 * hardware accelerator private data (Libav-allocated)
1233 * - encoding: unused
1234 * - decoding: Set by libavcodec
1236 void *hwaccel_picture_private;
1239 * the AVCodecContext which ff_thread_get_buffer() was last called on
1240 * - encoding: Set by libavcodec.
1241 * - decoding: Set by libavcodec.
1243 struct AVCodecContext *owner;
1246 * used by multithreading to store frame-specific info
1247 * - encoding: Set by libavcodec.
1248 * - decoding: Set by libavcodec.
1250 void *thread_opaque;
1253 * log2 of the size of the block which a single vector in motion_val represents:
1254 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1255 * - encoding: unused
1256 * - decoding: Set by libavcodec.
1258 uint8_t motion_subsample_log2;
1261 * Sample rate of the audio data.
1263 * - encoding: unused
1264 * - decoding: set by get_buffer()
1269 * Channel layout of the audio data.
1271 * - encoding: unused
1272 * - decoding: set by get_buffer()
1274 uint64_t channel_layout;
1277 struct AVCodecInternal;
1281 AV_FIELD_PROGRESSIVE,
1282 AV_FIELD_TT, //< Top coded_first, top displayed first
1283 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1284 AV_FIELD_TB, //< Top coded first, bottom displayed first
1285 AV_FIELD_BT, //< Bottom coded first, top displayed first
1289 * main external API structure.
1290 * New fields can be added to the end with minor version bumps.
1291 * Removal, reordering and changes to existing fields require a major
1293 * sizeof(AVCodecContext) must not be used outside libav*.
1295 typedef struct AVCodecContext {
1297 * information on struct for av_log
1298 * - set by avcodec_alloc_context3
1300 const AVClass *av_class;
1301 int log_level_offset;
1303 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1304 const struct AVCodec *codec;
1305 char codec_name[32];
1306 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1309 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1310 * This is used to work around some encoder bugs.
1311 * A demuxer should set this to what is stored in the field used to identify the codec.
1312 * If there are multiple such fields in a container then the demuxer should choose the one
1313 * which maximizes the information about the used codec.
1314 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1315 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1316 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1318 * - encoding: Set by user, if not then the default based on codec_id will be used.
1319 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1321 unsigned int codec_tag;
1324 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1325 * This is used to work around some encoder bugs.
1326 * - encoding: unused
1327 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1329 unsigned int stream_codec_tag;
1333 * @deprecated this field is unused
1335 attribute_deprecated int sub_id;
1341 * Private context used for internal data.
1343 * Unlike priv_data, this is not codec-specific. It is used in general
1344 * libavcodec functions.
1346 struct AVCodecInternal *internal;
1349 * Private data of the user, can be used to carry app specific stuff.
1350 * - encoding: Set by user.
1351 * - decoding: Set by user.
1356 * the average bitrate
1357 * - encoding: Set by user; unused for constant quantizer encoding.
1358 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1363 * number of bits the bitstream is allowed to diverge from the reference.
1364 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1365 * - encoding: Set by user; unused for constant quantizer encoding.
1366 * - decoding: unused
1368 int bit_rate_tolerance;
1371 * Global quality for codecs which cannot change it per frame.
1372 * This should be proportional to MPEG-1/2/4 qscale.
1373 * - encoding: Set by user.
1374 * - decoding: unused
1379 * - encoding: Set by user.
1380 * - decoding: unused
1382 int compression_level;
1383 #define FF_COMPRESSION_DEFAULT -1
1387 * - encoding: Set by user.
1388 * - decoding: Set by user.
1394 * - encoding: Set by user.
1395 * - decoding: Set by user.
1400 * some codecs need / can use extradata like Huffman tables.
1401 * mjpeg: Huffman tables
1402 * rv10: additional flags
1403 * mpeg4: global headers (they can be in the bitstream or here)
1404 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1405 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1406 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1407 * - encoding: Set/allocated/freed by libavcodec.
1408 * - decoding: Set/allocated/freed by user.
1414 * This is the fundamental unit of time (in seconds) in terms
1415 * of which frame timestamps are represented. For fixed-fps content,
1416 * timebase should be 1/framerate and timestamp increments should be
1418 * - encoding: MUST be set by user.
1419 * - decoding: Set by libavcodec.
1421 AVRational time_base;
1424 * For some codecs, the time base is closer to the field rate than the frame rate.
1425 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1426 * if no telecine is used ...
1428 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1430 int ticks_per_frame;
1436 * Number of frames the decoded output will be delayed relative to the
1440 * Number of "priming" samples added to the beginning of the stream
1441 * during encoding. The decoded output will be delayed by this many
1442 * samples relative to the input to the encoder. Note that this field is
1443 * purely informational and does not directly affect the pts output by
1444 * the encoder, which should always be based on the actual presentation
1445 * time, including any delay.
1447 * - encoding: Set by libavcodec.
1448 * - decoding: unused
1455 * picture width / height.
1456 * - encoding: MUST be set by user.
1457 * - decoding: Set by libavcodec.
1458 * Note: For compatibility it is possible to set this instead of
1459 * coded_width/height before decoding.
1464 * Bitstream width / height, may be different from width/height.
1465 * - encoding: unused
1466 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1468 int coded_width, coded_height;
1470 #define FF_ASPECT_EXTENDED 15
1473 * the number of pictures in a group of pictures, or 0 for intra_only
1474 * - encoding: Set by user.
1475 * - decoding: unused
1480 * Pixel format, see PIX_FMT_xxx.
1481 * May be set by the demuxer if known from headers.
1482 * May be overriden by the decoder if it knows better.
1483 * - encoding: Set by user.
1484 * - decoding: Set by user if known, overridden by libavcodec if known
1486 enum PixelFormat pix_fmt;
1489 * Motion estimation algorithm used for video coding.
1490 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1491 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1492 * - encoding: MUST be set by user.
1493 * - decoding: unused
1498 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1499 * decoder to draw a horizontal band. It improves cache usage. Not
1500 * all codecs can do that. You must check the codec capabilities
1502 * When multithreading is used, it may be called from multiple threads
1503 * at the same time; threads might draw different parts of the same AVFrame,
1504 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1506 * The function is also used by hardware acceleration APIs.
1507 * It is called at least once during frame decoding to pass
1508 * the data needed for hardware render.
1509 * In that mode instead of pixel data, AVFrame points to
1510 * a structure specific to the acceleration API. The application
1511 * reads the structure and can change some fields to indicate progress
1513 * - encoding: unused
1514 * - decoding: Set by user.
1515 * @param height the height of the slice
1516 * @param y the y position of the slice
1517 * @param type 1->top field, 2->bottom field, 3->frame
1518 * @param offset offset into the AVFrame.data from which the slice should be read
1520 void (*draw_horiz_band)(struct AVCodecContext *s,
1521 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1522 int y, int type, int height);
1525 * callback to negotiate the pixelFormat
1526 * @param fmt is the list of formats which are supported by the codec,
1527 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1528 * The first is always the native one.
1529 * @return the chosen format
1530 * - encoding: unused
1531 * - decoding: Set by user, if not set the native format will be chosen.
1533 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1536 * maximum number of B-frames between non-B-frames
1537 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1538 * - encoding: Set by user.
1539 * - decoding: unused
1544 * qscale factor between IP and B-frames
1545 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1546 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1547 * - encoding: Set by user.
1548 * - decoding: unused
1550 float b_quant_factor;
1552 /** obsolete FIXME remove */
1554 #define FF_RC_STRATEGY_XVID 1
1556 int b_frame_strategy;
1558 #if FF_API_MPV_GLOBAL_OPTS
1560 * luma single coefficient elimination threshold
1561 * - encoding: Set by user.
1562 * - decoding: unused
1564 attribute_deprecated int luma_elim_threshold;
1567 * chroma single coeff elimination threshold
1568 * - encoding: Set by user.
1569 * - decoding: unused
1571 attribute_deprecated int chroma_elim_threshold;
1575 * qscale offset between IP and B-frames
1576 * - encoding: Set by user.
1577 * - decoding: unused
1579 float b_quant_offset;
1582 * Size of the frame reordering buffer in the decoder.
1583 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1584 * - encoding: Set by libavcodec.
1585 * - decoding: Set by libavcodec.
1590 * 0-> h263 quant 1-> mpeg quant
1591 * - encoding: Set by user.
1592 * - decoding: unused
1597 * qscale factor between P and I-frames
1598 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1599 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1600 * - encoding: Set by user.
1601 * - decoding: unused
1603 float i_quant_factor;
1606 * qscale offset between P and I-frames
1607 * - encoding: Set by user.
1608 * - decoding: unused
1610 float i_quant_offset;
1613 * luminance masking (0-> disabled)
1614 * - encoding: Set by user.
1615 * - decoding: unused
1620 * temporary complexity masking (0-> disabled)
1621 * - encoding: Set by user.
1622 * - decoding: unused
1624 float temporal_cplx_masking;
1627 * spatial complexity masking (0-> disabled)
1628 * - encoding: Set by user.
1629 * - decoding: unused
1631 float spatial_cplx_masking;
1634 * p block masking (0-> disabled)
1635 * - encoding: Set by user.
1636 * - decoding: unused
1641 * darkness masking (0-> disabled)
1642 * - encoding: Set by user.
1643 * - decoding: unused
1649 * - encoding: Set by libavcodec.
1650 * - decoding: Set by user (or 0).
1654 * prediction method (needed for huffyuv)
1655 * - encoding: Set by user.
1656 * - decoding: unused
1658 int prediction_method;
1659 #define FF_PRED_LEFT 0
1660 #define FF_PRED_PLANE 1
1661 #define FF_PRED_MEDIAN 2
1664 * slice offsets in the frame in bytes
1665 * - encoding: Set/allocated by libavcodec.
1666 * - decoding: Set/allocated by user (or NULL).
1671 * sample aspect ratio (0 if unknown)
1672 * That is the width of a pixel divided by the height of the pixel.
1673 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1674 * - encoding: Set by user.
1675 * - decoding: Set by libavcodec.
1677 AVRational sample_aspect_ratio;
1680 * motion estimation comparison function
1681 * - encoding: Set by user.
1682 * - decoding: unused
1686 * subpixel motion estimation comparison function
1687 * - encoding: Set by user.
1688 * - decoding: unused
1692 * macroblock comparison function (not supported yet)
1693 * - encoding: Set by user.
1694 * - decoding: unused
1698 * interlaced DCT comparison function
1699 * - encoding: Set by user.
1700 * - decoding: unused
1703 #define FF_CMP_SAD 0
1704 #define FF_CMP_SSE 1
1705 #define FF_CMP_SATD 2
1706 #define FF_CMP_DCT 3
1707 #define FF_CMP_PSNR 4
1708 #define FF_CMP_BIT 5
1710 #define FF_CMP_ZERO 7
1711 #define FF_CMP_VSAD 8
1712 #define FF_CMP_VSSE 9
1713 #define FF_CMP_NSSE 10
1714 #define FF_CMP_W53 11
1715 #define FF_CMP_W97 12
1716 #define FF_CMP_DCTMAX 13
1717 #define FF_CMP_DCT264 14
1718 #define FF_CMP_CHROMA 256
1721 * ME diamond size & shape
1722 * - encoding: Set by user.
1723 * - decoding: unused
1728 * amount of previous MV predictors (2a+1 x 2a+1 square)
1729 * - encoding: Set by user.
1730 * - decoding: unused
1732 int last_predictor_count;
1735 * prepass for motion estimation
1736 * - encoding: Set by user.
1737 * - decoding: unused
1742 * motion estimation prepass comparison function
1743 * - encoding: Set by user.
1744 * - decoding: unused
1749 * ME prepass diamond size & shape
1750 * - encoding: Set by user.
1751 * - decoding: unused
1757 * - encoding: Set by user.
1758 * - decoding: unused
1760 int me_subpel_quality;
1763 * DTG active format information (additional aspect ratio
1764 * information only used in DVB MPEG-2 transport streams)
1767 * - encoding: unused
1768 * - decoding: Set by decoder.
1770 int dtg_active_format;
1771 #define FF_DTG_AFD_SAME 8
1772 #define FF_DTG_AFD_4_3 9
1773 #define FF_DTG_AFD_16_9 10
1774 #define FF_DTG_AFD_14_9 11
1775 #define FF_DTG_AFD_4_3_SP_14_9 13
1776 #define FF_DTG_AFD_16_9_SP_14_9 14
1777 #define FF_DTG_AFD_SP_4_3 15
1780 * maximum motion estimation search range in subpel units
1781 * If 0 then no limit.
1783 * - encoding: Set by user.
1784 * - decoding: unused
1789 * intra quantizer bias
1790 * - encoding: Set by user.
1791 * - decoding: unused
1793 int intra_quant_bias;
1794 #define FF_DEFAULT_QUANT_BIAS 999999
1797 * inter quantizer bias
1798 * - encoding: Set by user.
1799 * - decoding: unused
1801 int inter_quant_bias;
1803 #if FF_API_COLOR_TABLE_ID
1806 * - encoding: unused
1807 * - decoding: Which clrtable should be used for 8bit RGB images.
1808 * Tables have to be stored somewhere. FIXME
1810 attribute_deprecated int color_table_id;
1815 * - encoding: unused
1816 * - decoding: Set by user.
1819 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1820 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1821 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1824 * XVideo Motion Acceleration
1825 * - encoding: forbidden
1826 * - decoding: set by decoder
1828 int xvmc_acceleration;
1831 * macroblock decision mode
1832 * - encoding: Set by user.
1833 * - decoding: unused
1836 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1837 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1838 #define FF_MB_DECISION_RD 2 ///< rate distortion
1841 * custom intra quantization matrix
1842 * - encoding: Set by user, can be NULL.
1843 * - decoding: Set by libavcodec.
1845 uint16_t *intra_matrix;
1848 * custom inter quantization matrix
1849 * - encoding: Set by user, can be NULL.
1850 * - decoding: Set by libavcodec.
1852 uint16_t *inter_matrix;
1855 * scene change detection threshold
1856 * 0 is default, larger means fewer detected scene changes.
1857 * - encoding: Set by user.
1858 * - decoding: unused
1860 int scenechange_threshold;
1863 * noise reduction strength
1864 * - encoding: Set by user.
1865 * - decoding: unused
1867 int noise_reduction;
1869 #if FF_API_INTER_THRESHOLD
1871 * @deprecated this field is unused
1873 attribute_deprecated int inter_threshold;
1876 #if FF_API_MPV_GLOBAL_OPTS
1878 * @deprecated use mpegvideo private options instead
1880 attribute_deprecated int quantizer_noise_shaping;
1884 * Motion estimation threshold below which no motion estimation is
1885 * performed, but instead the user specified motion vectors are used.
1887 * - encoding: Set by user.
1888 * - decoding: unused
1893 * Macroblock threshold below which the user specified macroblock types will be used.
1894 * - encoding: Set by user.
1895 * - decoding: unused
1900 * precision of the intra DC coefficient - 8
1901 * - encoding: Set by user.
1902 * - decoding: unused
1904 int intra_dc_precision;
1907 * Number of macroblock rows at the top which are skipped.
1908 * - encoding: unused
1909 * - decoding: Set by user.
1914 * Number of macroblock rows at the bottom which are skipped.
1915 * - encoding: unused
1916 * - decoding: Set by user.
1921 * Border processing masking, raises the quantizer for mbs on the borders
1923 * - encoding: Set by user.
1924 * - decoding: unused
1926 float border_masking;
1929 * minimum MB lagrange multipler
1930 * - encoding: Set by user.
1931 * - decoding: unused
1936 * maximum MB lagrange multipler
1937 * - encoding: Set by user.
1938 * - decoding: unused
1944 * - encoding: Set by user.
1945 * - decoding: unused
1947 int me_penalty_compensation;
1951 * - encoding: Set by user.
1952 * - decoding: unused
1958 * - encoding: Set by user.
1959 * - decoding: unused
1965 * - encoding: Set by user.
1966 * - decoding: unused
1971 * number of reference frames
1972 * - encoding: Set by user.
1973 * - decoding: Set by lavc.
1978 * chroma qp offset from luma
1979 * - encoding: Set by user.
1980 * - decoding: unused
1985 * Multiplied by qscale for each frame and added to scene_change_score.
1986 * - encoding: Set by user.
1987 * - decoding: unused
1989 int scenechange_factor;
1993 * Note: Value depends upon the compare function used for fullpel ME.
1994 * - encoding: Set by user.
1995 * - decoding: unused
2000 * Adjust sensitivity of b_frame_strategy 1.
2001 * - encoding: Set by user.
2002 * - decoding: unused
2007 * Chromaticity coordinates of the source primaries.
2008 * - encoding: Set by user
2009 * - decoding: Set by libavcodec
2011 enum AVColorPrimaries color_primaries;
2014 * Color Transfer Characteristic.
2015 * - encoding: Set by user
2016 * - decoding: Set by libavcodec
2018 enum AVColorTransferCharacteristic color_trc;
2021 * YUV colorspace type.
2022 * - encoding: Set by user
2023 * - decoding: Set by libavcodec
2025 enum AVColorSpace colorspace;
2028 * MPEG vs JPEG YUV range.
2029 * - encoding: Set by user
2030 * - decoding: Set by libavcodec
2032 enum AVColorRange color_range;
2035 * This defines the location of chroma samples.
2036 * - encoding: Set by user
2037 * - decoding: Set by libavcodec
2039 enum AVChromaLocation chroma_sample_location;
2043 * Indicates number of picture subdivisions. Used for parallelized
2045 * - encoding: Set by user
2046 * - decoding: unused
2051 * - encoding: set by libavcodec
2052 * - decoding: Set by libavcodec
2054 enum AVFieldOrder field_order;
2057 int sample_rate; ///< samples per second
2058 int channels; ///< number of audio channels
2061 * audio sample format
2062 * - encoding: Set by user.
2063 * - decoding: Set by libavcodec.
2065 enum AVSampleFormat sample_fmt; ///< sample format
2067 /* The following data should not be initialized. */
2069 * Samples per packet, initialized when calling 'init'.
2074 * Frame counter, set by libavcodec.
2076 * - decoding: total number of frames returned from the decoder so far.
2077 * - encoding: total number of frames passed to the encoder so far.
2079 * @note the counter is not incremented if encoding/decoding resulted in
2085 * number of bytes per packet if constant and known or 0
2086 * Used by some WAV based audio codecs.
2091 * Audio cutoff bandwidth (0 means "automatic")
2092 * - encoding: Set by user.
2093 * - decoding: unused
2097 #if FF_API_REQUEST_CHANNELS
2099 * Decoder should decode to this many channels if it can (0 for default)
2100 * - encoding: unused
2101 * - decoding: Set by user.
2102 * @deprecated Deprecated in favor of request_channel_layout.
2104 int request_channels;
2108 * Audio channel layout.
2109 * - encoding: set by user.
2110 * - decoding: set by libavcodec.
2112 uint64_t channel_layout;
2115 * Request decoder to use this channel layout if it can (0 for default)
2116 * - encoding: unused
2117 * - decoding: Set by user.
2119 uint64_t request_channel_layout;
2122 * Type of service that the audio stream conveys.
2123 * - encoding: Set by user.
2124 * - decoding: Set by libavcodec.
2126 enum AVAudioServiceType audio_service_type;
2129 * Used to request a sample format from the decoder.
2130 * - encoding: unused.
2131 * - decoding: Set by user.
2133 enum AVSampleFormat request_sample_fmt;
2136 * Called at the beginning of each frame to get a buffer for it.
2138 * The function will set AVFrame.data[], AVFrame.linesize[].
2139 * AVFrame.extended_data[] must also be set, but it should be the same as
2140 * AVFrame.data[] except for planar audio with more channels than can fit
2141 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2142 * many data pointers as it can hold.
2144 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2145 * avcodec_default_get_buffer() instead of providing buffers allocated by
2148 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2149 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2150 * but if get_buffer() is overridden then alignment considerations should
2151 * be taken into account.
2153 * @see avcodec_default_get_buffer()
2157 * If pic.reference is set then the frame will be read later by libavcodec.
2158 * avcodec_align_dimensions2() should be used to find the required width and
2159 * height, as they normally need to be rounded up to the next multiple of 16.
2161 * If frame multithreading is used and thread_safe_callbacks is set,
2162 * it may be called from a different thread, but not from more than one at
2163 * once. Does not need to be reentrant.
2165 * @see release_buffer(), reget_buffer()
2166 * @see avcodec_align_dimensions2()
2170 * Decoders request a buffer of a particular size by setting
2171 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2172 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2173 * to a smaller value in the output frame.
2175 * Decoders cannot use the buffer after returning from
2176 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2177 * is assumed to be released immediately upon return.
2179 * As a convenience, av_samples_get_buffer_size() and
2180 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2181 * functions to find the required data size and to fill data pointers and
2182 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2183 * since all planes must be the same size.
2185 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2187 * - encoding: unused
2188 * - decoding: Set by libavcodec, user can override.
2190 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2193 * Called to release buffers which were allocated with get_buffer.
2194 * A released buffer can be reused in get_buffer().
2195 * pic.data[*] must be set to NULL.
2196 * May be called from a different thread if frame multithreading is used,
2197 * but not by more than one thread at once, so does not need to be reentrant.
2198 * - encoding: unused
2199 * - decoding: Set by libavcodec, user can override.
2201 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2204 * Called at the beginning of a frame to get cr buffer for it.
2205 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2206 * libavcodec will pass previous buffer in pic, function should return
2207 * same buffer or new buffer with old frame "painted" into it.
2208 * If pic.data[0] == NULL must behave like get_buffer().
2209 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2210 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2212 * - encoding: unused
2213 * - decoding: Set by libavcodec, user can override.
2215 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2218 /* - encoding parameters */
2219 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2220 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2224 * - encoding: Set by user.
2225 * - decoding: unused
2231 * - encoding: Set by user.
2232 * - decoding: unused
2237 * maximum quantizer difference between frames
2238 * - encoding: Set by user.
2239 * - decoding: unused
2244 * ratecontrol qmin qmax limiting method
2245 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2246 * - encoding: Set by user.
2247 * - decoding: unused
2255 * decoder bitstream buffer size
2256 * - encoding: Set by user.
2257 * - decoding: unused
2262 * ratecontrol override, see RcOverride
2263 * - encoding: Allocated/set/freed by user.
2264 * - decoding: unused
2266 int rc_override_count;
2267 RcOverride *rc_override;
2270 * rate control equation
2271 * - encoding: Set by user
2272 * - decoding: unused
2278 * - encoding: Set by user.
2279 * - decoding: unused
2285 * - encoding: Set by user.
2286 * - decoding: unused
2290 float rc_buffer_aggressivity;
2293 * initial complexity for pass1 ratecontrol
2294 * - encoding: Set by user.
2295 * - decoding: unused
2297 float rc_initial_cplx;
2300 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2301 * - encoding: Set by user.
2302 * - decoding: unused.
2304 float rc_max_available_vbv_use;
2307 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2308 * - encoding: Set by user.
2309 * - decoding: unused.
2311 float rc_min_vbv_overflow_use;
2314 * Number of bits which should be loaded into the rc buffer before decoding starts.
2315 * - encoding: Set by user.
2316 * - decoding: unused
2318 int rc_initial_buffer_occupancy;
2320 #define FF_CODER_TYPE_VLC 0
2321 #define FF_CODER_TYPE_AC 1
2322 #define FF_CODER_TYPE_RAW 2
2323 #define FF_CODER_TYPE_RLE 3
2324 #define FF_CODER_TYPE_DEFLATE 4
2327 * - encoding: Set by user.
2328 * - decoding: unused
2334 * - encoding: Set by user.
2335 * - decoding: unused
2340 * minimum Lagrange multipler
2341 * - encoding: Set by user.
2342 * - decoding: unused
2347 * maximum Lagrange multipler
2348 * - encoding: Set by user.
2349 * - decoding: unused
2354 * frame skip threshold
2355 * - encoding: Set by user.
2356 * - decoding: unused
2358 int frame_skip_threshold;
2362 * - encoding: Set by user.
2363 * - decoding: unused
2365 int frame_skip_factor;
2368 * frame skip exponent
2369 * - encoding: Set by user.
2370 * - decoding: unused
2375 * frame skip comparison function
2376 * - encoding: Set by user.
2377 * - decoding: unused
2382 * trellis RD quantization
2383 * - encoding: Set by user.
2384 * - decoding: unused
2389 * - encoding: Set by user.
2390 * - decoding: unused
2392 int min_prediction_order;
2395 * - encoding: Set by user.
2396 * - decoding: unused
2398 int max_prediction_order;
2401 * GOP timecode frame start number, in non drop frame format
2402 * - encoding: Set by user.
2403 * - decoding: unused
2405 int64_t timecode_frame_start;
2407 /* The RTP callback: This function is called */
2408 /* every time the encoder has a packet to send. */
2409 /* It depends on the encoder if the data starts */
2410 /* with a Start Code (it should). H.263 does. */
2411 /* mb_nb contains the number of macroblocks */
2412 /* encoded in the RTP payload. */
2413 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2415 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2416 /* do its best to deliver a chunk with size */
2417 /* below rtp_payload_size, the chunk will start */
2418 /* with a start code on some codecs like H.263. */
2419 /* This doesn't take account of any particular */
2420 /* headers inside the transmitted RTP payload. */
2422 /* statistics, used for 2-pass encoding */
2433 * number of bits used for the previously encoded frame
2434 * - encoding: Set by libavcodec.
2435 * - decoding: unused
2440 * pass1 encoding statistics output buffer
2441 * - encoding: Set by libavcodec.
2442 * - decoding: unused
2447 * pass2 encoding statistics input buffer
2448 * Concatenated stuff from stats_out of pass1 should be placed here.
2449 * - encoding: Allocated/set/freed by user.
2450 * - decoding: unused
2455 * Work around bugs in encoders which sometimes cannot be detected automatically.
2456 * - encoding: Set by user
2457 * - decoding: Set by user
2459 int workaround_bugs;
2460 #define FF_BUG_AUTODETECT 1 ///< autodetection
2461 #define FF_BUG_OLD_MSMPEG4 2
2462 #define FF_BUG_XVID_ILACE 4
2463 #define FF_BUG_UMP4 8
2464 #define FF_BUG_NO_PADDING 16
2465 #define FF_BUG_AMV 32
2466 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2467 #define FF_BUG_QPEL_CHROMA 64
2468 #define FF_BUG_STD_QPEL 128
2469 #define FF_BUG_QPEL_CHROMA2 256
2470 #define FF_BUG_DIRECT_BLOCKSIZE 512
2471 #define FF_BUG_EDGE 1024
2472 #define FF_BUG_HPEL_CHROMA 2048
2473 #define FF_BUG_DC_CLIP 4096
2474 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2475 #define FF_BUG_TRUNCATED 16384
2478 * strictly follow the standard (MPEG4, ...).
2479 * - encoding: Set by user.
2480 * - decoding: Set by user.
2481 * Setting this to STRICT or higher means the encoder and decoder will
2482 * generally do stupid things, whereas setting it to unofficial or lower
2483 * will mean the encoder might produce output that is not supported by all
2484 * spec-compliant decoders. Decoders don't differentiate between normal,
2485 * unofficial and experimental (that is, they always try to decode things
2486 * when they can) unless they are explicitly asked to behave stupidly
2487 * (=strictly conform to the specs)
2489 int strict_std_compliance;
2490 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2491 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2492 #define FF_COMPLIANCE_NORMAL 0
2493 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2494 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2497 * error concealment flags
2498 * - encoding: unused
2499 * - decoding: Set by user.
2501 int error_concealment;
2502 #define FF_EC_GUESS_MVS 1
2503 #define FF_EC_DEBLOCK 2
2507 * - encoding: Set by user.
2508 * - decoding: Set by user.
2511 #define FF_DEBUG_PICT_INFO 1
2512 #define FF_DEBUG_RC 2
2513 #define FF_DEBUG_BITSTREAM 4
2514 #define FF_DEBUG_MB_TYPE 8
2515 #define FF_DEBUG_QP 16
2516 #define FF_DEBUG_MV 32
2517 #define FF_DEBUG_DCT_COEFF 0x00000040
2518 #define FF_DEBUG_SKIP 0x00000080
2519 #define FF_DEBUG_STARTCODE 0x00000100
2520 #define FF_DEBUG_PTS 0x00000200
2521 #define FF_DEBUG_ER 0x00000400
2522 #define FF_DEBUG_MMCO 0x00000800
2523 #define FF_DEBUG_BUGS 0x00001000
2524 #define FF_DEBUG_VIS_QP 0x00002000
2525 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2526 #define FF_DEBUG_BUFFERS 0x00008000
2527 #define FF_DEBUG_THREADS 0x00010000
2531 * - encoding: Set by user.
2532 * - decoding: Set by user.
2535 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2536 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2537 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2540 * Error recognition; may misdetect some more or less valid parts as errors.
2541 * - encoding: unused
2542 * - decoding: Set by user.
2544 int err_recognition;
2545 #define AV_EF_CRCCHECK (1<<0)
2546 #define AV_EF_BITSTREAM (1<<1)
2547 #define AV_EF_BUFFER (1<<2)
2548 #define AV_EF_EXPLODE (1<<3)
2551 * opaque 64bit number (generally a PTS) that will be reordered and
2552 * output in AVFrame.reordered_opaque
2553 * @deprecated in favor of pkt_pts
2554 * - encoding: unused
2555 * - decoding: Set by user.
2557 int64_t reordered_opaque;
2560 * Hardware accelerator in use
2561 * - encoding: unused.
2562 * - decoding: Set by libavcodec
2564 struct AVHWAccel *hwaccel;
2567 * Hardware accelerator context.
2568 * For some hardware accelerators, a global context needs to be
2569 * provided by the user. In that case, this holds display-dependent
2570 * data Libav cannot instantiate itself. Please refer to the
2571 * Libav HW accelerator documentation to know how to fill this
2572 * is. e.g. for VA API, this is a struct vaapi_context.
2573 * - encoding: unused
2574 * - decoding: Set by user
2576 void *hwaccel_context;
2580 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2581 * - decoding: unused
2583 uint64_t error[AV_NUM_DATA_POINTERS];
2586 * DCT algorithm, see FF_DCT_* below
2587 * - encoding: Set by user.
2588 * - decoding: unused
2591 #define FF_DCT_AUTO 0
2592 #define FF_DCT_FASTINT 1
2593 #define FF_DCT_INT 2
2594 #define FF_DCT_MMX 3
2595 #define FF_DCT_ALTIVEC 5
2596 #define FF_DCT_FAAN 6
2599 * IDCT algorithm, see FF_IDCT_* below.
2600 * - encoding: Set by user.
2601 * - decoding: Set by user.
2604 #define FF_IDCT_AUTO 0
2605 #define FF_IDCT_INT 1
2606 #define FF_IDCT_SIMPLE 2
2607 #define FF_IDCT_SIMPLEMMX 3
2608 #define FF_IDCT_LIBMPEG2MMX 4
2609 #define FF_IDCT_MMI 5
2610 #define FF_IDCT_ARM 7
2611 #define FF_IDCT_ALTIVEC 8
2612 #define FF_IDCT_SH4 9
2613 #define FF_IDCT_SIMPLEARM 10
2614 #define FF_IDCT_H264 11
2615 #define FF_IDCT_VP3 12
2616 #define FF_IDCT_IPP 13
2617 #define FF_IDCT_XVIDMMX 14
2618 #define FF_IDCT_CAVS 15
2619 #define FF_IDCT_SIMPLEARMV5TE 16
2620 #define FF_IDCT_SIMPLEARMV6 17
2621 #define FF_IDCT_SIMPLEVIS 18
2622 #define FF_IDCT_WMV2 19
2623 #define FF_IDCT_FAAN 20
2624 #define FF_IDCT_EA 21
2625 #define FF_IDCT_SIMPLENEON 22
2626 #define FF_IDCT_SIMPLEALPHA 23
2627 #define FF_IDCT_BINK 24
2632 * @deprecated use av_set_cpu_flags_mask() instead.
2634 attribute_deprecated unsigned dsp_mask;
2638 * bits per sample/pixel from the demuxer (needed for huffyuv).
2639 * - encoding: Set by libavcodec.
2640 * - decoding: Set by user.
2642 int bits_per_coded_sample;
2645 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2646 * - encoding: set by user.
2647 * - decoding: set by libavcodec.
2649 int bits_per_raw_sample;
2652 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2653 * - encoding: unused
2654 * - decoding: Set by user.
2656 attribute_deprecated int lowres;
2659 * the picture in the bitstream
2660 * - encoding: Set by libavcodec.
2661 * - decoding: Set by libavcodec.
2663 AVFrame *coded_frame;
2667 * is used to decide how many independent tasks should be passed to execute()
2668 * - encoding: Set by user.
2669 * - decoding: Set by user.
2674 * Which multithreading methods to use.
2675 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2676 * so clients which cannot provide future frames should not use it.
2678 * - encoding: Set by user, otherwise the default is used.
2679 * - decoding: Set by user, otherwise the default is used.
2682 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2683 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2686 * Which multithreading methods are in use by the codec.
2687 * - encoding: Set by libavcodec.
2688 * - decoding: Set by libavcodec.
2690 int active_thread_type;
2693 * Set by the client if its custom get_buffer() callback can be called
2694 * synchronously from another thread, which allows faster multithreaded decoding.
2695 * draw_horiz_band() will be called from other threads regardless of this setting.
2696 * Ignored if the default get_buffer() is used.
2697 * - encoding: Set by user.
2698 * - decoding: Set by user.
2700 int thread_safe_callbacks;
2703 * The codec may call this to execute several independent things.
2704 * It will return only after finishing all tasks.
2705 * The user may replace this with some multithreaded implementation,
2706 * the default implementation will execute the parts serially.
2707 * @param count the number of things to execute
2708 * - encoding: Set by libavcodec, user can override.
2709 * - decoding: Set by libavcodec, user can override.
2711 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2714 * The codec may call this to execute several independent things.
2715 * It will return only after finishing all tasks.
2716 * The user may replace this with some multithreaded implementation,
2717 * the default implementation will execute the parts serially.
2718 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2719 * @param c context passed also to func
2720 * @param count the number of things to execute
2721 * @param arg2 argument passed unchanged to func
2722 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2723 * @param func function that will be called count times, with jobnr from 0 to count-1.
2724 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2725 * two instances of func executing at the same time will have the same threadnr.
2726 * @return always 0 currently, but code should handle a future improvement where when any call to func
2727 * returns < 0 no further calls to func may be done and < 0 is returned.
2728 * - encoding: Set by libavcodec, user can override.
2729 * - decoding: Set by libavcodec, user can override.
2731 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2735 * Can be used by execute() to store some per AVCodecContext stuff.
2736 * - encoding: set by execute()
2737 * - decoding: set by execute()
2739 void *thread_opaque;
2742 * noise vs. sse weight for the nsse comparsion function
2743 * - encoding: Set by user.
2744 * - decoding: unused
2750 * - encoding: Set by user.
2751 * - decoding: Set by libavcodec.
2754 #define FF_PROFILE_UNKNOWN -99
2755 #define FF_PROFILE_RESERVED -100
2757 #define FF_PROFILE_AAC_MAIN 0
2758 #define FF_PROFILE_AAC_LOW 1
2759 #define FF_PROFILE_AAC_SSR 2
2760 #define FF_PROFILE_AAC_LTP 3
2761 #define FF_PROFILE_AAC_HE 4
2762 #define FF_PROFILE_AAC_HE_V2 28
2763 #define FF_PROFILE_AAC_LD 22
2764 #define FF_PROFILE_AAC_ELD 38
2766 #define FF_PROFILE_DTS 20
2767 #define FF_PROFILE_DTS_ES 30
2768 #define FF_PROFILE_DTS_96_24 40
2769 #define FF_PROFILE_DTS_HD_HRA 50
2770 #define FF_PROFILE_DTS_HD_MA 60
2772 #define FF_PROFILE_MPEG2_422 0
2773 #define FF_PROFILE_MPEG2_HIGH 1
2774 #define FF_PROFILE_MPEG2_SS 2
2775 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2776 #define FF_PROFILE_MPEG2_MAIN 4
2777 #define FF_PROFILE_MPEG2_SIMPLE 5
2779 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2780 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2782 #define FF_PROFILE_H264_BASELINE 66
2783 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2784 #define FF_PROFILE_H264_MAIN 77
2785 #define FF_PROFILE_H264_EXTENDED 88
2786 #define FF_PROFILE_H264_HIGH 100
2787 #define FF_PROFILE_H264_HIGH_10 110
2788 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2789 #define FF_PROFILE_H264_HIGH_422 122
2790 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2791 #define FF_PROFILE_H264_HIGH_444 144
2792 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2793 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2794 #define FF_PROFILE_H264_CAVLC_444 44
2796 #define FF_PROFILE_VC1_SIMPLE 0
2797 #define FF_PROFILE_VC1_MAIN 1
2798 #define FF_PROFILE_VC1_COMPLEX 2
2799 #define FF_PROFILE_VC1_ADVANCED 3
2801 #define FF_PROFILE_MPEG4_SIMPLE 0
2802 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2803 #define FF_PROFILE_MPEG4_CORE 2
2804 #define FF_PROFILE_MPEG4_MAIN 3
2805 #define FF_PROFILE_MPEG4_N_BIT 4
2806 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2807 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2808 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2809 #define FF_PROFILE_MPEG4_HYBRID 8
2810 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2811 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2812 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2813 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2814 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2815 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2816 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2820 * - encoding: Set by user.
2821 * - decoding: Set by libavcodec.
2824 #define FF_LEVEL_UNKNOWN -99
2828 * - encoding: unused
2829 * - decoding: Set by user.
2831 enum AVDiscard skip_loop_filter;
2835 * - encoding: unused
2836 * - decoding: Set by user.
2838 enum AVDiscard skip_idct;
2842 * - encoding: unused
2843 * - decoding: Set by user.
2845 enum AVDiscard skip_frame;
2848 * Header containing style information for text subtitles.
2849 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2850 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2851 * the Format line following. It shouldn't include any Dialogue line.
2852 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2853 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2855 uint8_t *subtitle_header;
2856 int subtitle_header_size;
2859 * Simulates errors in the bitstream to test error concealment.
2860 * - encoding: Set by user.
2861 * - decoding: unused
2866 * Current packet as passed into the decoder, to avoid having
2867 * to pass the packet into every function. Currently only valid
2868 * inside lavc and get/release_buffer callbacks.
2869 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2870 * - encoding: unused
2875 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2876 * Used for compliant TS muxing.
2877 * - encoding: Set by libavcodec.
2878 * - decoding: unused.
2886 typedef struct AVProfile {
2888 const char *name; ///< short name for the profile
2891 typedef struct AVCodecDefault AVCodecDefault;
2896 typedef struct AVCodec {
2898 * Name of the codec implementation.
2899 * The name is globally unique among encoders and among decoders (but an
2900 * encoder and a decoder can share the same name).
2901 * This is the primary way to find a codec from the user perspective.
2905 * Descriptive name for the codec, meant to be more human readable than name.
2906 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2908 const char *long_name;
2909 enum AVMediaType type;
2912 * Codec capabilities.
2916 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2917 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2918 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2919 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2920 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2921 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2922 const AVClass *priv_class; ///< AVClass for the private context
2923 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2925 /*****************************************************************
2926 * No fields below this line are part of the public API. They
2927 * may not be used outside of libavcodec and can be changed and
2929 * New public fields should be added right above.
2930 *****************************************************************
2933 struct AVCodec *next;
2935 * @name Frame-level threading support functions
2939 * If defined, called on thread contexts when they are created.
2940 * If the codec allocates writable tables in init(), re-allocate them here.
2941 * priv_data will be set to a copy of the original.
2943 int (*init_thread_copy)(AVCodecContext *);
2945 * Copy necessary context variables from a previous thread context to the current one.
2946 * If not defined, the next thread will start automatically; otherwise, the codec
2947 * must call ff_thread_finish_setup().
2949 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2951 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2955 * Private codec-specific defaults.
2957 const AVCodecDefault *defaults;
2960 * Initialize codec static data, called from avcodec_register().
2962 void (*init_static_data)(struct AVCodec *codec);
2964 int (*init)(AVCodecContext *);
2965 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2967 * Encode data to an AVPacket.
2969 * @param avctx codec context
2970 * @param avpkt output AVPacket (may contain a user-provided buffer)
2971 * @param[in] frame AVFrame containing the raw data to be encoded
2972 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2973 * non-empty packet was returned in avpkt.
2974 * @return 0 on success, negative error code on failure
2976 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2977 int *got_packet_ptr);
2978 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2979 int (*close)(AVCodecContext *);
2982 * Will be called when seeking
2984 void (*flush)(AVCodecContext *);
2990 typedef struct AVHWAccel {
2992 * Name of the hardware accelerated codec.
2993 * The name is globally unique among encoders and among decoders (but an
2994 * encoder and a decoder can share the same name).
2999 * Type of codec implemented by the hardware accelerator.
3001 * See AVMEDIA_TYPE_xxx
3003 enum AVMediaType type;
3006 * Codec implemented by the hardware accelerator.
3008 * See AV_CODEC_ID_xxx
3013 * Supported pixel format.
3015 * Only hardware accelerated formats are supported here.
3017 enum PixelFormat pix_fmt;
3020 * Hardware accelerated codec capabilities.
3021 * see FF_HWACCEL_CODEC_CAP_*
3025 struct AVHWAccel *next;
3028 * Called at the beginning of each frame or field picture.
3030 * Meaningful frame information (codec specific) is guaranteed to
3031 * be parsed at this point. This function is mandatory.
3033 * Note that buf can be NULL along with buf_size set to 0.
3034 * Otherwise, this means the whole frame is available at this point.
3036 * @param avctx the codec context
3037 * @param buf the frame data buffer base
3038 * @param buf_size the size of the frame in bytes
3039 * @return zero if successful, a negative value otherwise
3041 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3044 * Callback for each slice.
3046 * Meaningful slice information (codec specific) is guaranteed to
3047 * be parsed at this point. This function is mandatory.
3049 * @param avctx the codec context
3050 * @param buf the slice data buffer base
3051 * @param buf_size the size of the slice in bytes
3052 * @return zero if successful, a negative value otherwise
3054 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3057 * Called at the end of each frame or field picture.
3059 * The whole picture is parsed at this point and can now be sent
3060 * to the hardware accelerator. This function is mandatory.
3062 * @param avctx the codec context
3063 * @return zero if successful, a negative value otherwise
3065 int (*end_frame)(AVCodecContext *avctx);
3068 * Size of HW accelerator private data.
3070 * Private data is allocated with av_mallocz() before
3071 * AVCodecContext.get_buffer() and deallocated after
3072 * AVCodecContext.release_buffer().
3078 * @defgroup lavc_picture AVPicture
3080 * Functions for working with AVPicture
3085 * four components are given, that's all.
3086 * the last component is alpha
3088 typedef struct AVPicture {
3089 uint8_t *data[AV_NUM_DATA_POINTERS];
3090 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3097 #define AVPALETTE_SIZE 1024
3098 #define AVPALETTE_COUNT 256
3100 enum AVSubtitleType {
3103 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3106 * Plain text, the text field must be set by the decoder and is
3107 * authoritative. ass and pict fields may contain approximations.
3112 * Formatted text, the ass field must be set by the decoder and is
3113 * authoritative. pict and text fields may contain approximations.
3118 typedef struct AVSubtitleRect {
3119 int x; ///< top left corner of pict, undefined when pict is not set
3120 int y; ///< top left corner of pict, undefined when pict is not set
3121 int w; ///< width of pict, undefined when pict is not set
3122 int h; ///< height of pict, undefined when pict is not set
3123 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3126 * data+linesize for the bitmap of this subtitle.
3127 * can be set for text/ass as well once they where rendered
3130 enum AVSubtitleType type;
3132 char *text; ///< 0 terminated plain UTF-8 text
3135 * 0 terminated ASS/SSA compatible event line.
3136 * The pressentation of this is unaffected by the other values in this
3142 typedef struct AVSubtitle {
3143 uint16_t format; /* 0 = graphics */
3144 uint32_t start_display_time; /* relative to packet pts, in ms */
3145 uint32_t end_display_time; /* relative to packet pts, in ms */
3147 AVSubtitleRect **rects;
3148 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3152 * If c is NULL, returns the first registered codec,
3153 * if c is non-NULL, returns the next registered codec after c,
3154 * or NULL if c is the last one.
3156 AVCodec *av_codec_next(const AVCodec *c);
3159 * Return the LIBAVCODEC_VERSION_INT constant.
3161 unsigned avcodec_version(void);
3164 * Return the libavcodec build-time configuration.
3166 const char *avcodec_configuration(void);
3169 * Return the libavcodec license.
3171 const char *avcodec_license(void);
3174 * Register the codec codec and initialize libavcodec.
3176 * @warning either this function or avcodec_register_all() must be called
3177 * before any other libavcodec functions.
3179 * @see avcodec_register_all()
3181 void avcodec_register(AVCodec *codec);
3184 * Register all the codecs, parsers and bitstream filters which were enabled at
3185 * configuration time. If you do not call this function you can select exactly
3186 * which formats you want to support, by using the individual registration
3189 * @see avcodec_register
3190 * @see av_register_codec_parser
3191 * @see av_register_bitstream_filter
3193 void avcodec_register_all(void);
3196 * Allocate an AVCodecContext and set its fields to default values. The
3197 * resulting struct can be deallocated by calling avcodec_close() on it followed
3200 * @param codec if non-NULL, allocate private data and initialize defaults
3201 * for the given codec. It is illegal to then call avcodec_open2()
3202 * with a different codec.
3203 * If NULL, then the codec-specific defaults won't be initialized,
3204 * which may result in suboptimal default settings (this is
3205 * important mainly for encoders, e.g. libx264).
3207 * @return An AVCodecContext filled with default values or NULL on failure.
3208 * @see avcodec_get_context_defaults
3210 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3213 * Set the fields of the given AVCodecContext to default values corresponding
3214 * to the given codec (defaults may be codec-dependent).
3216 * Do not call this function if a non-NULL codec has been passed
3217 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3218 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3219 * different codec on this AVCodecContext.
3221 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3224 * Get the AVClass for AVCodecContext. It can be used in combination with
3225 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3227 * @see av_opt_find().
3229 const AVClass *avcodec_get_class(void);
3232 * Copy the settings of the source AVCodecContext into the destination
3233 * AVCodecContext. The resulting destination codec context will be
3234 * unopened, i.e. you are required to call avcodec_open2() before you
3235 * can use this AVCodecContext to decode/encode video/audio data.
3237 * @param dest target codec context, should be initialized with
3238 * avcodec_alloc_context3(), but otherwise uninitialized
3239 * @param src source codec context
3240 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3242 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3245 * Allocate an AVFrame and set its fields to default values. The resulting
3246 * struct can be deallocated by simply calling av_free().
3248 * @return An AVFrame filled with default values or NULL on failure.
3249 * @see avcodec_get_frame_defaults
3251 AVFrame *avcodec_alloc_frame(void);
3254 * Set the fields of the given AVFrame to default values.
3256 * @param pic The AVFrame of which the fields should be set to default values.
3258 void avcodec_get_frame_defaults(AVFrame *pic);
3261 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3262 * function the context has to be allocated with avcodec_alloc_context3().
3264 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3265 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3266 * retrieving a codec.
3268 * @warning This function is not thread safe!
3271 * avcodec_register_all();
3272 * av_dict_set(&opts, "b", "2.5M", 0);
3273 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3277 * context = avcodec_alloc_context3(codec);
3279 * if (avcodec_open2(context, codec, opts) < 0)
3283 * @param avctx The context to initialize.
3284 * @param codec The codec to open this context for. If a non-NULL codec has been
3285 * previously passed to avcodec_alloc_context3() or
3286 * avcodec_get_context_defaults3() for this context, then this
3287 * parameter MUST be either NULL or equal to the previously passed
3289 * @param options A dictionary filled with AVCodecContext and codec-private options.
3290 * On return this object will be filled with options that were not found.
3292 * @return zero on success, a negative value on error
3293 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3294 * av_dict_set(), av_opt_find().
3296 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3299 * Close a given AVCodecContext and free all the data associated with it
3300 * (but not the AVCodecContext itself).
3302 * Calling this function on an AVCodecContext that hasn't been opened will free
3303 * the codec-specific data allocated in avcodec_alloc_context3() /
3304 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3307 int avcodec_close(AVCodecContext *avctx);
3310 * Free all allocated data in the given subtitle struct.
3312 * @param sub AVSubtitle to free.
3314 void avsubtitle_free(AVSubtitle *sub);
3321 * @addtogroup lavc_packet
3326 * @deprecated use NULL instead
3328 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3331 * Default packet destructor.
3333 void av_destruct_packet(AVPacket *pkt);
3336 * Initialize optional fields of a packet with default values.
3338 * Note, this does not touch the data and size members, which have to be
3339 * initialized separately.
3343 void av_init_packet(AVPacket *pkt);
3346 * Allocate the payload of a packet and initialize its fields with
3350 * @param size wanted payload size
3351 * @return 0 if OK, AVERROR_xxx otherwise
3353 int av_new_packet(AVPacket *pkt, int size);
3356 * Reduce packet size, correctly zeroing padding
3359 * @param size new size
3361 void av_shrink_packet(AVPacket *pkt, int size);
3364 * Increase packet size, correctly zeroing padding
3367 * @param grow_by number of bytes by which to increase the size of the packet
3369 int av_grow_packet(AVPacket *pkt, int grow_by);
3372 * @warning This is a hack - the packet memory allocation stuff is broken. The
3373 * packet is allocated if it was not really allocated.
3375 int av_dup_packet(AVPacket *pkt);
3380 * @param pkt packet to free
3382 void av_free_packet(AVPacket *pkt);
3385 * Allocate new information of a packet.
3388 * @param type side information type
3389 * @param size side information size
3390 * @return pointer to fresh allocated data or NULL otherwise
3392 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3396 * Shrink the already allocated side data buffer
3399 * @param type side information type
3400 * @param size new side information size
3401 * @return 0 on success, < 0 on failure
3403 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3407 * Get side information from packet.
3410 * @param type desired side information type
3411 * @param size pointer for side information size to store (optional)
3412 * @return pointer to data if present or NULL otherwise
3414 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3422 * @addtogroup lavc_decoding
3427 * Find a registered decoder with a matching codec ID.
3429 * @param id AVCodecID of the requested decoder
3430 * @return A decoder if one was found, NULL otherwise.
3432 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3435 * Find a registered decoder with the specified name.
3437 * @param name name of the requested decoder
3438 * @return A decoder if one was found, NULL otherwise.
3440 AVCodec *avcodec_find_decoder_by_name(const char *name);
3442 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3443 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3444 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3447 * Return the amount of padding in pixels which the get_buffer callback must
3448 * provide around the edge of the image for codecs which do not have the
3449 * CODEC_FLAG_EMU_EDGE flag.
3451 * @return Required padding in pixels.
3453 unsigned avcodec_get_edge_width(void);
3456 * Modify width and height values so that they will result in a memory
3457 * buffer that is acceptable for the codec if you do not use any horizontal
3460 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3461 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3462 * according to avcodec_get_edge_width() before.
3464 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3467 * Modify width and height values so that they will result in a memory
3468 * buffer that is acceptable for the codec if you also ensure that all
3469 * line sizes are a multiple of the respective linesize_align[i].
3471 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3472 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3473 * according to avcodec_get_edge_width() before.
3475 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3476 int linesize_align[AV_NUM_DATA_POINTERS]);
3478 #if FF_API_OLD_DECODE_AUDIO
3480 * Wrapper function which calls avcodec_decode_audio4.
3482 * @deprecated Use avcodec_decode_audio4 instead.
3484 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3485 * Some decoders may support multiple frames in a single AVPacket, such
3486 * decoders would then just decode the first frame. In this case,
3487 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3488 * the remaining data in order to decode the second frame etc.
3490 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3491 * decompressed frame size in bytes.
3493 * @warning You must set frame_size_ptr to the allocated size of the
3494 * output buffer before calling avcodec_decode_audio3().
3496 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3497 * the actual read bytes because some optimized bitstream readers read 32 or 64
3498 * bits at once and could read over the end.
3500 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3501 * no overreading happens for damaged MPEG streams.
3503 * @warning You must not provide a custom get_buffer() when using
3504 * avcodec_decode_audio3(). Doing so will override it with
3505 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3506 * which does allow the application to provide a custom get_buffer().
3508 * @note You might have to align the input buffer avpkt->data and output buffer
3509 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3510 * necessary at all, on others it won't work at all if not aligned and on others
3511 * it will work but it will have an impact on performance.
3513 * In practice, avpkt->data should have 4 byte alignment at minimum and
3514 * samples should be 16 byte aligned unless the CPU doesn't need it
3515 * (AltiVec and SSE do).
3517 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3518 * between input and output, these need to be fed with avpkt->data=NULL,
3519 * avpkt->size=0 at the end to return the remaining frames.
3521 * @param avctx the codec context
3522 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3523 * If the sample format is planar, each channel plane will
3524 * be the same size, with no padding between channels.
3525 * @param[in,out] frame_size_ptr the output buffer size in bytes
3526 * @param[in] avpkt The input AVPacket containing the input buffer.
3527 * You can create such packet with av_init_packet() and by then setting
3528 * data and size, some decoders might in addition need other fields.
3529 * All decoders are designed to use the least fields possible though.
3530 * @return On error a negative value is returned, otherwise the number of bytes
3531 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3533 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3534 int *frame_size_ptr,
3539 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3541 * Some decoders may support multiple frames in a single AVPacket. Such
3542 * decoders would then just decode the first frame. In this case,
3543 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3544 * the remaining data in order to decode the second frame, etc...
3545 * Even if no frames are returned, the packet needs to be fed to the decoder
3546 * with remaining data until it is completely consumed or an error occurs.
3548 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3549 * larger than the actual read bytes because some optimized bitstream
3550 * readers read 32 or 64 bits at once and could read over the end.
3552 * @note You might have to align the input buffer. The alignment requirements
3553 * depend on the CPU and the decoder.
3555 * @param avctx the codec context
3556 * @param[out] frame The AVFrame in which to store decoded audio samples.
3557 * Decoders request a buffer of a particular size by setting
3558 * AVFrame.nb_samples prior to calling get_buffer(). The
3559 * decoder may, however, only utilize part of the buffer by
3560 * setting AVFrame.nb_samples to a smaller value in the
3562 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3564 * @param[in] avpkt The input AVPacket containing the input buffer.
3565 * At least avpkt->data and avpkt->size should be set. Some
3566 * decoders might also require additional fields to be set.
3567 * @return A negative error code is returned if an error occurred during
3568 * decoding, otherwise the number of bytes consumed from the input
3569 * AVPacket is returned.
3571 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3572 int *got_frame_ptr, AVPacket *avpkt);
3575 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3576 * Some decoders may support multiple frames in a single AVPacket, such
3577 * decoders would then just decode the first frame.
3579 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3580 * the actual read bytes because some optimized bitstream readers read 32 or 64
3581 * bits at once and could read over the end.
3583 * @warning The end of the input buffer buf should be set to 0 to ensure that
3584 * no overreading happens for damaged MPEG streams.
3586 * @note You might have to align the input buffer avpkt->data.
3587 * The alignment requirements depend on the CPU: on some CPUs it isn't
3588 * necessary at all, on others it won't work at all if not aligned and on others
3589 * it will work but it will have an impact on performance.
3591 * In practice, avpkt->data should have 4 byte alignment at minimum.
3593 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3594 * between input and output, these need to be fed with avpkt->data=NULL,
3595 * avpkt->size=0 at the end to return the remaining frames.
3597 * @param avctx the codec context
3598 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3599 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3600 * allocate memory for the actual bitmap.
3601 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3602 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3603 * decodes and the decoder tells the user once it does not need the data anymore,
3604 * the user app can at this point free/reuse/keep the memory as it sees fit.
3606 * @param[in] avpkt The input AVpacket containing the input buffer.
3607 * You can create such packet with av_init_packet() and by then setting
3608 * data and size, some decoders might in addition need other fields like
3609 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3611 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3612 * @return On error a negative value is returned, otherwise the number of bytes
3613 * used or zero if no frame could be decompressed.
3615 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3616 int *got_picture_ptr,
3620 * Decode a subtitle message.
3621 * Return a negative value on error, otherwise return the number of bytes used.
3622 * If no subtitle could be decompressed, got_sub_ptr is zero.
3623 * Otherwise, the subtitle is stored in *sub.
3624 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3625 * simplicity, because the performance difference is expect to be negligible
3626 * and reusing a get_buffer written for video codecs would probably perform badly
3627 * due to a potentially very different allocation pattern.
3629 * @param avctx the codec context
3630 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3631 freed with avsubtitle_free if *got_sub_ptr is set.
3632 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3633 * @param[in] avpkt The input AVPacket containing the input buffer.
3635 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3640 * @defgroup lavc_parsing Frame parsing
3644 typedef struct AVCodecParserContext {
3646 struct AVCodecParser *parser;
3647 int64_t frame_offset; /* offset of the current frame */
3648 int64_t cur_offset; /* current offset
3649 (incremented by each av_parser_parse()) */
3650 int64_t next_frame_offset; /* offset of the next frame */
3652 int pict_type; /* XXX: Put it back in AVCodecContext. */
3654 * This field is used for proper frame duration computation in lavf.
3655 * It signals, how much longer the frame duration of the current frame
3656 * is compared to normal frame duration.
3658 * frame_duration = (1 + repeat_pict) * time_base
3660 * It is used by codecs like H.264 to display telecined material.
3662 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3663 int64_t pts; /* pts of the current frame */
3664 int64_t dts; /* dts of the current frame */
3669 int fetch_timestamp;
3671 #define AV_PARSER_PTS_NB 4
3672 int cur_frame_start_index;
3673 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3674 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3675 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3678 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3679 #define PARSER_FLAG_ONCE 0x0002
3680 /// Set if the parser has a valid file offset
3681 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3683 int64_t offset; ///< byte offset from starting packet start
3684 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3687 * Set by parser to 1 for key frames and 0 for non-key frames.
3688 * It is initialized to -1, so if the parser doesn't set this flag,
3689 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3695 * Time difference in stream time base units from the pts of this
3696 * packet to the point at which the output from the decoder has converged
3697 * independent from the availability of previous frames. That is, the
3698 * frames are virtually identical no matter if decoding started from
3699 * the very first frame or from this keyframe.
3700 * Is AV_NOPTS_VALUE if unknown.
3701 * This field is not the display duration of the current frame.
3702 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3705 * The purpose of this field is to allow seeking in streams that have no
3706 * keyframes in the conventional sense. It corresponds to the
3707 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3708 * essential for some types of subtitle streams to ensure that all
3709 * subtitles are correctly displayed after seeking.
3711 int64_t convergence_duration;
3713 // Timestamp generation support:
3715 * Synchronization point for start of timestamp generation.
3717 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3720 * For example, this corresponds to presence of H.264 buffering period
3726 * Offset of the current timestamp against last timestamp sync point in
3727 * units of AVCodecContext.time_base.
3729 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3730 * contain a valid timestamp offset.
3732 * Note that the timestamp of sync point has usually a nonzero
3733 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3734 * the next frame after timestamp sync point will be usually 1.
3736 * For example, this corresponds to H.264 cpb_removal_delay.
3738 int dts_ref_dts_delta;
3741 * Presentation delay of current frame in units of AVCodecContext.time_base.
3743 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3744 * contain valid non-negative timestamp delta (presentation time of a frame
3745 * must not lie in the past).
3747 * This delay represents the difference between decoding and presentation
3748 * time of the frame.
3750 * For example, this corresponds to H.264 dpb_output_delay.
3755 * Position of the packet in file.
3757 * Analogous to cur_frame_pts/dts
3759 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3762 * Byte position of currently parsed frame in stream.
3767 * Previous frame byte position.
3772 * Duration of the current frame.
3773 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3774 * For all other types, this is in units of AVCodecContext.time_base.
3777 } AVCodecParserContext;
3779 typedef struct AVCodecParser {
3780 int codec_ids[5]; /* several codec IDs are permitted */
3782 int (*parser_init)(AVCodecParserContext *s);
3783 int (*parser_parse)(AVCodecParserContext *s,
3784 AVCodecContext *avctx,
3785 const uint8_t **poutbuf, int *poutbuf_size,
3786 const uint8_t *buf, int buf_size);
3787 void (*parser_close)(AVCodecParserContext *s);
3788 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3789 struct AVCodecParser *next;
3792 AVCodecParser *av_parser_next(AVCodecParser *c);
3794 void av_register_codec_parser(AVCodecParser *parser);
3795 AVCodecParserContext *av_parser_init(int codec_id);
3800 * @param s parser context.
3801 * @param avctx codec context.
3802 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3803 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3804 * @param buf input buffer.
3805 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3806 * @param pts input presentation timestamp.
3807 * @param dts input decoding timestamp.
3808 * @param pos input byte position in stream.
3809 * @return the number of bytes of the input bitstream used.
3814 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3821 * decode_frame(data, size);
3825 int av_parser_parse2(AVCodecParserContext *s,
3826 AVCodecContext *avctx,
3827 uint8_t **poutbuf, int *poutbuf_size,
3828 const uint8_t *buf, int buf_size,
3829 int64_t pts, int64_t dts,
3832 int av_parser_change(AVCodecParserContext *s,
3833 AVCodecContext *avctx,
3834 uint8_t **poutbuf, int *poutbuf_size,
3835 const uint8_t *buf, int buf_size, int keyframe);
3836 void av_parser_close(AVCodecParserContext *s);
3844 * @addtogroup lavc_encoding
3849 * Find a registered encoder with a matching codec ID.
3851 * @param id AVCodecID of the requested encoder
3852 * @return An encoder if one was found, NULL otherwise.
3854 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3857 * Find a registered encoder with the specified name.
3859 * @param name name of the requested encoder
3860 * @return An encoder if one was found, NULL otherwise.
3862 AVCodec *avcodec_find_encoder_by_name(const char *name);
3864 #if FF_API_OLD_ENCODE_AUDIO
3866 * Encode an audio frame from samples into buf.
3868 * @deprecated Use avcodec_encode_audio2 instead.
3870 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3871 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3872 * will know how much space is needed because it depends on the value passed
3873 * in buf_size as described below. In that case a lower value can be used.
3875 * @param avctx the codec context
3876 * @param[out] buf the output buffer
3877 * @param[in] buf_size the output buffer size
3878 * @param[in] samples the input buffer containing the samples
3879 * The number of samples read from this buffer is frame_size*channels,
3880 * both of which are defined in avctx.
3881 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3882 * samples read from samples is equal to:
3883 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3884 * This also implies that av_get_bits_per_sample() must not return 0 for these
3886 * @return On error a negative value is returned, on success zero or the number
3887 * of bytes used to encode the data read from the input buffer.
3889 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3890 uint8_t *buf, int buf_size,
3891 const short *samples);
3895 * Encode a frame of audio.
3897 * Takes input samples from frame and writes the next output packet, if
3898 * available, to avpkt. The output packet does not necessarily contain data for
3899 * the most recent frame, as encoders can delay, split, and combine input frames
3900 * internally as needed.
3902 * @param avctx codec context
3903 * @param avpkt output AVPacket.
3904 * The user can supply an output buffer by setting
3905 * avpkt->data and avpkt->size prior to calling the
3906 * function, but if the size of the user-provided data is not
3907 * large enough, encoding will fail. All other AVPacket fields
3908 * will be reset by the encoder using av_init_packet(). If
3909 * avpkt->data is NULL, the encoder will allocate it.
3910 * The encoder will set avpkt->size to the size of the
3913 * If this function fails or produces no output, avpkt will be
3914 * freed using av_free_packet() (i.e. avpkt->destruct will be
3915 * called to free the user supplied buffer).
3916 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3917 * May be NULL when flushing an encoder that has the
3918 * CODEC_CAP_DELAY capability set.
3919 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3920 * can have any number of samples.
3921 * If it is not set, frame->nb_samples must be equal to
3922 * avctx->frame_size for all frames except the last.
3923 * The final frame may be smaller than avctx->frame_size.
3924 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3925 * output packet is non-empty, and to 0 if it is
3926 * empty. If the function returns an error, the
3927 * packet can be assumed to be invalid, and the
3928 * value of got_packet_ptr is undefined and should
3930 * @return 0 on success, negative error code on failure
3932 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3933 const AVFrame *frame, int *got_packet_ptr);
3935 #if FF_API_OLD_ENCODE_VIDEO
3937 * @deprecated use avcodec_encode_video2() instead.
3939 * Encode a video frame from pict into buf.
3940 * The input picture should be
3941 * stored using a specific format, namely avctx.pix_fmt.
3943 * @param avctx the codec context
3944 * @param[out] buf the output buffer for the bitstream of encoded frame
3945 * @param[in] buf_size the size of the output buffer in bytes
3946 * @param[in] pict the input picture to encode
3947 * @return On error a negative value is returned, on success zero or the number
3948 * of bytes used from the output buffer.
3950 attribute_deprecated
3951 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3952 const AVFrame *pict);
3956 * Encode a frame of video.
3958 * Takes input raw video data from frame and writes the next output packet, if
3959 * available, to avpkt. The output packet does not necessarily contain data for
3960 * the most recent frame, as encoders can delay and reorder input frames
3961 * internally as needed.
3963 * @param avctx codec context
3964 * @param avpkt output AVPacket.
3965 * The user can supply an output buffer by setting
3966 * avpkt->data and avpkt->size prior to calling the
3967 * function, but if the size of the user-provided data is not
3968 * large enough, encoding will fail. All other AVPacket fields
3969 * will be reset by the encoder using av_init_packet(). If
3970 * avpkt->data is NULL, the encoder will allocate it.
3971 * The encoder will set avpkt->size to the size of the
3972 * output packet. The returned data (if any) belongs to the
3973 * caller, he is responsible for freeing it.
3975 * If this function fails or produces no output, avpkt will be
3976 * freed using av_free_packet() (i.e. avpkt->destruct will be
3977 * called to free the user supplied buffer).
3978 * @param[in] frame AVFrame containing the raw video data to be encoded.
3979 * May be NULL when flushing an encoder that has the
3980 * CODEC_CAP_DELAY capability set.
3981 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3982 * output packet is non-empty, and to 0 if it is
3983 * empty. If the function returns an error, the
3984 * packet can be assumed to be invalid, and the
3985 * value of got_packet_ptr is undefined and should
3987 * @return 0 on success, negative error code on failure
3989 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3990 const AVFrame *frame, int *got_packet_ptr);
3992 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3993 const AVSubtitle *sub);
4001 * @defgroup lavc_resample Audio resampling
4006 struct ReSampleContext;
4007 struct AVResampleContext;
4009 typedef struct ReSampleContext ReSampleContext;
4012 * Initialize audio resampling context.
4014 * @param output_channels number of output channels
4015 * @param input_channels number of input channels
4016 * @param output_rate output sample rate
4017 * @param input_rate input sample rate
4018 * @param sample_fmt_out requested output sample format
4019 * @param sample_fmt_in input sample format
4020 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4021 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4022 * @param linear if 1 then the used FIR filter will be linearly interpolated
4023 between the 2 closest, if 0 the closest will be used
4024 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4025 * @return allocated ReSampleContext, NULL if error occurred
4027 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4028 int output_rate, int input_rate,
4029 enum AVSampleFormat sample_fmt_out,
4030 enum AVSampleFormat sample_fmt_in,
4031 int filter_length, int log2_phase_count,
4032 int linear, double cutoff);
4034 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4037 * Free resample context.
4039 * @param s a non-NULL pointer to a resample context previously
4040 * created with av_audio_resample_init()
4042 void audio_resample_close(ReSampleContext *s);
4046 * Initialize an audio resampler.
4047 * Note, if either rate is not an integer then simply scale both rates up so they are.
4048 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4049 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4050 * @param linear If 1 then the used FIR filter will be linearly interpolated
4051 between the 2 closest, if 0 the closest will be used
4052 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4054 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4057 * Resample an array of samples using a previously configured context.
4058 * @param src an array of unconsumed samples
4059 * @param consumed the number of samples of src which have been consumed are returned here
4060 * @param src_size the number of unconsumed samples available
4061 * @param dst_size the amount of space in samples available in dst
4062 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
4063 * @return the number of samples written in dst or -1 if an error occurred
4065 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4069 * Compensate samplerate/timestamp drift. The compensation is done by changing
4070 * the resampler parameters, so no audible clicks or similar distortions occur
4071 * @param compensation_distance distance in output samples over which the compensation should be performed
4072 * @param sample_delta number of output samples which should be output less
4074 * example: av_resample_compensate(c, 10, 500)
4075 * here instead of 510 samples only 500 samples would be output
4077 * note, due to rounding the actual compensation might be slightly different,
4078 * especially if the compensation_distance is large and the in_rate used during init is small
4080 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4081 void av_resample_close(struct AVResampleContext *c);
4088 * @addtogroup lavc_picture
4093 * Allocate memory for a picture. Call avpicture_free() to free it.
4095 * @see avpicture_fill()
4097 * @param picture the picture to be filled in
4098 * @param pix_fmt the format of the picture
4099 * @param width the width of the picture
4100 * @param height the height of the picture
4101 * @return zero if successful, a negative value if not
4103 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
4106 * Free a picture previously allocated by avpicture_alloc().
4107 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4110 * @param picture the AVPicture to be freed
4112 void avpicture_free(AVPicture *picture);
4115 * Fill in the AVPicture fields.
4116 * The fields of the given AVPicture are filled in by using the 'ptr' address
4117 * which points to the image data buffer. Depending on the specified picture
4118 * format, one or multiple image data pointers and line sizes will be set.
4119 * If a planar format is specified, several pointers will be set pointing to
4120 * the different picture planes and the line sizes of the different planes
4121 * will be stored in the lines_sizes array.
4122 * Call with ptr == NULL to get the required size for the ptr buffer.
4124 * To allocate the buffer and fill in the AVPicture fields in one call,
4125 * use avpicture_alloc().
4127 * @param picture AVPicture whose fields are to be filled in
4128 * @param ptr Buffer which will contain or contains the actual image data
4129 * @param pix_fmt The format in which the picture data is stored.
4130 * @param width the width of the image in pixels
4131 * @param height the height of the image in pixels
4132 * @return size of the image data in bytes
4134 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4135 enum PixelFormat pix_fmt, int width, int height);
4138 * Copy pixel data from an AVPicture into a buffer.
4139 * The data is stored compactly, without any gaps for alignment or padding
4140 * which may be applied by avpicture_fill().
4142 * @see avpicture_get_size()
4144 * @param[in] src AVPicture containing image data
4145 * @param[in] pix_fmt The format in which the picture data is stored.
4146 * @param[in] width the width of the image in pixels.
4147 * @param[in] height the height of the image in pixels.
4148 * @param[out] dest A buffer into which picture data will be copied.
4149 * @param[in] dest_size The size of 'dest'.
4150 * @return The number of bytes written to dest, or a negative value (error code) on error.
4152 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
4153 unsigned char *dest, int dest_size);
4156 * Calculate the size in bytes that a picture of the given width and height
4157 * would occupy if stored in the given picture format.
4158 * Note that this returns the size of a compact representation as generated
4159 * by avpicture_layout(), which can be smaller than the size required for e.g.
4162 * @param pix_fmt the given picture format
4163 * @param width the width of the image
4164 * @param height the height of the image
4165 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
4167 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
4170 * deinterlace - if not supported return -1
4172 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4173 enum PixelFormat pix_fmt, int width, int height);
4175 * Copy image src to dst. Wraps av_picture_data_copy() above.
4177 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4178 enum PixelFormat pix_fmt, int width, int height);
4181 * Crop image top and left side.
4183 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4184 enum PixelFormat pix_fmt, int top_band, int left_band);
4189 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4190 int padtop, int padbottom, int padleft, int padright, int *color);
4197 * @defgroup lavc_misc Utility functions
4200 * Miscellaneous utility functions related to both encoding and decoding
4206 * @defgroup lavc_misc_pixfmt Pixel formats
4208 * Functions for working with pixel formats.
4212 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
4215 * Return a value representing the fourCC code associated to the
4216 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4219 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
4221 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4222 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4223 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4224 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4225 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4226 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4229 * Compute what kind of losses will occur when converting from one specific
4230 * pixel format to another.
4231 * When converting from one pixel format to another, information loss may occur.
4232 * For example, when converting from RGB24 to GRAY, the color information will
4233 * be lost. Similarly, other losses occur when converting from some formats to
4234 * other formats. These losses can involve loss of chroma, but also loss of
4235 * resolution, loss of color depth, loss due to the color space conversion, loss
4236 * of the alpha bits or loss due to color quantization.
4237 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4238 * which will occur when converting from one pixel format to another.
4240 * @param[in] dst_pix_fmt destination pixel format
4241 * @param[in] src_pix_fmt source pixel format
4242 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4243 * @return Combination of flags informing you what kind of losses will occur.
4245 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
4248 #if FF_API_FIND_BEST_PIX_FMT
4250 * @deprecated use avcodec_find_best_pix_fmt2() instead.
4252 * Find the best pixel format to convert to given a certain source pixel
4253 * format. When converting from one pixel format to another, information loss
4254 * may occur. For example, when converting from RGB24 to GRAY, the color
4255 * information will be lost. Similarly, other losses occur when converting from
4256 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4257 * the given pixel formats should be used to suffer the least amount of loss.
4258 * The pixel formats from which it chooses one, are determined by the
4259 * pix_fmt_mask parameter.
4262 * src_pix_fmt = PIX_FMT_YUV420P;
4263 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
4264 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4267 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4268 * @param[in] src_pix_fmt source pixel format
4269 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4270 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4271 * @return The best pixel format to convert to or -1 if none was found.
4273 attribute_deprecated
4274 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
4275 int has_alpha, int *loss_ptr);
4276 #endif /* FF_API_FIND_BEST_PIX_FMT */
4279 * Find the best pixel format to convert to given a certain source pixel
4280 * format. When converting from one pixel format to another, information loss
4281 * may occur. For example, when converting from RGB24 to GRAY, the color
4282 * information will be lost. Similarly, other losses occur when converting from
4283 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4284 * the given pixel formats should be used to suffer the least amount of loss.
4285 * The pixel formats from which it chooses one, are determined by the
4286 * pix_fmt_list parameter.
4289 * @param[in] pix_fmt_list PIX_FMT_NONE terminated array of pixel formats to choose from
4290 * @param[in] src_pix_fmt source pixel format
4291 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4292 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4293 * @return The best pixel format to convert to or -1 if none was found.
4295 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat *pix_fmt_list,
4296 enum PixelFormat src_pix_fmt,
4297 int has_alpha, int *loss_ptr);
4299 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4305 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4308 * Put a string representing the codec tag codec_tag in buf.
4310 * @param buf_size size in bytes of buf
4311 * @return the length of the string that would have been generated if
4312 * enough space had been available, excluding the trailing null
4314 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4316 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4319 * Return a name for the specified profile, if available.
4321 * @param codec the codec that is searched for the given profile
4322 * @param profile the profile value for which a name is requested
4323 * @return A name for the profile if found, NULL otherwise.
4325 const char *av_get_profile_name(const AVCodec *codec, int profile);
4327 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4328 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4329 //FIXME func typedef
4332 * Fill audio frame data and linesize.
4333 * AVFrame extended_data channel pointers are allocated if necessary for
4336 * @param frame the AVFrame
4337 * frame->nb_samples must be set prior to calling the
4338 * function. This function fills in frame->data,
4339 * frame->extended_data, frame->linesize[0].
4340 * @param nb_channels channel count
4341 * @param sample_fmt sample format
4342 * @param buf buffer to use for frame data
4343 * @param buf_size size of buffer
4344 * @param align plane size sample alignment (0 = default)
4345 * @return 0 on success, negative error code on failure
4347 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4348 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4349 int buf_size, int align);
4352 * Flush buffers, should be called when seeking or when switching to a different stream.
4354 void avcodec_flush_buffers(AVCodecContext *avctx);
4356 void avcodec_default_free_buffers(AVCodecContext *s);
4359 * Return codec bits per sample.
4361 * @param[in] codec_id the codec
4362 * @return Number of bits per sample or zero if unknown for the given codec.
4364 int av_get_bits_per_sample(enum AVCodecID codec_id);
4367 * Return codec bits per sample.
4368 * Only return non-zero if the bits per sample is exactly correct, not an
4371 * @param[in] codec_id the codec
4372 * @return Number of bits per sample or zero if unknown for the given codec.
4374 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4377 * Return audio frame duration.
4379 * @param avctx codec context
4380 * @param frame_bytes size of the frame, or 0 if unknown
4381 * @return frame duration, in samples, if known. 0 if not able to
4384 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4387 typedef struct AVBitStreamFilterContext {
4389 struct AVBitStreamFilter *filter;
4390 AVCodecParserContext *parser;
4391 struct AVBitStreamFilterContext *next;
4392 } AVBitStreamFilterContext;
4395 typedef struct AVBitStreamFilter {
4398 int (*filter)(AVBitStreamFilterContext *bsfc,
4399 AVCodecContext *avctx, const char *args,
4400 uint8_t **poutbuf, int *poutbuf_size,
4401 const uint8_t *buf, int buf_size, int keyframe);
4402 void (*close)(AVBitStreamFilterContext *bsfc);
4403 struct AVBitStreamFilter *next;
4404 } AVBitStreamFilter;
4406 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4407 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4408 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4409 AVCodecContext *avctx, const char *args,
4410 uint8_t **poutbuf, int *poutbuf_size,
4411 const uint8_t *buf, int buf_size, int keyframe);
4412 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4414 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4419 * Reallocate the given block if it is not large enough, otherwise do nothing.
4423 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4426 * Allocate a buffer, reusing the given one if large enough.
4428 * Contrary to av_fast_realloc the current buffer contents might not be
4429 * preserved and on error the old buffer is freed, thus no special
4430 * handling to avoid memleaks is necessary.
4432 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4433 * @param size size of the buffer *ptr points to
4434 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4435 * *size 0 if an error occurred.
4437 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4440 * Allocate a buffer with padding, reusing the given one if large enough.
4442 * Same behaviour av_fast_malloc but the buffer has additional
4443 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4446 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4449 * Encode extradata length to a buffer. Used by xiph codecs.
4451 * @param s buffer to write to; must be at least (v/255+1) bytes long
4452 * @param v size of extradata in bytes
4453 * @return number of bytes written to the buffer.
4455 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4458 * Log a generic warning message about a missing feature. This function is
4459 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4460 * only, and would normally not be used by applications.
4461 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4462 * a pointer to an AVClass struct
4463 * @param[in] feature string containing the name of the missing feature
4464 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4465 * If want_sample is non-zero, additional verbage will be added to the log
4466 * message which tells the user how to report samples to the development
4469 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4472 * Log a generic warning message asking for a sample. This function is
4473 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4474 * only, and would normally not be used by applications.
4475 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4476 * a pointer to an AVClass struct
4477 * @param[in] msg string containing an optional message, or NULL if no message
4479 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4482 * Register the hardware accelerator hwaccel.
4484 void av_register_hwaccel(AVHWAccel *hwaccel);
4487 * If hwaccel is NULL, returns the first registered hardware accelerator,
4488 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4489 * after hwaccel, or NULL if hwaccel is the last one.
4491 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4495 * Lock operation used by lockmgr
4498 AV_LOCK_CREATE, ///< Create a mutex
4499 AV_LOCK_OBTAIN, ///< Lock the mutex
4500 AV_LOCK_RELEASE, ///< Unlock the mutex
4501 AV_LOCK_DESTROY, ///< Free mutex resources
4505 * Register a user provided lock manager supporting the operations
4506 * specified by AVLockOp. mutex points to a (void *) where the
4507 * lockmgr should store/get a pointer to a user allocated mutex. It's
4508 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4510 * @param cb User defined callback. Note: Libav may invoke calls to this
4511 * callback during the call to av_lockmgr_register().
4512 * Thus, the application must be prepared to handle that.
4513 * If cb is set to NULL the lockmgr will be unregistered.
4514 * Also note that during unregistration the previously registered
4515 * lockmgr callback may also be invoked.
4517 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4520 * Get the type of the given codec.
4522 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4525 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4526 * with no corresponding avcodec_close()), 0 otherwise.
4528 int avcodec_is_open(AVCodecContext *s);
4531 * @return a non-zero number if codec is an encoder, zero otherwise
4533 int av_codec_is_encoder(const AVCodec *codec);
4536 * @return a non-zero number if codec is a decoder, zero otherwise
4538 int av_codec_is_decoder(const AVCodec *codec);
4541 * @return descriptor for given codec ID or NULL if no descriptor exists.
4543 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4546 * Iterate over all codec descriptors known to libavcodec.
4548 * @param prev previous descriptor. NULL to get the first descriptor.
4550 * @return next descriptor or NULL after the last descriptor
4552 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4555 * @return codec descriptor with the given name or NULL if no such descriptor
4558 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4564 #endif /* AVCODEC_AVCODEC_H */