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.
96 AV_CODEC_ID_MPEG1VIDEO,
97 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
98 AV_CODEC_ID_MPEG2VIDEO_XVMC,
109 AV_CODEC_ID_RAWVIDEO,
110 AV_CODEC_ID_MSMPEG4V1,
111 AV_CODEC_ID_MSMPEG4V2,
112 AV_CODEC_ID_MSMPEG4V3,
135 AV_CODEC_ID_INTERPLAY_VIDEO,
142 AV_CODEC_ID_MSVIDEO1,
147 AV_CODEC_ID_TRUEMOTION1,
148 AV_CODEC_ID_VMDVIDEO,
174 AV_CODEC_ID_TRUEMOTION2,
180 AV_CODEC_ID_SMACKVIDEO,
185 AV_CODEC_ID_JPEG2000,
191 AV_CODEC_ID_DSICINVIDEO,
192 AV_CODEC_ID_TIERTEXSEQVIDEO,
200 AV_CODEC_ID_BETHSOFTVID,
212 AV_CODEC_ID_ESCAPE124,
216 AV_CODEC_ID_MOTIONPIXELS,
228 AV_CODEC_ID_FLASHSV2,
229 AV_CODEC_ID_CDGRAPHICS,
232 AV_CODEC_ID_BINKVIDEO,
233 AV_CODEC_ID_IFF_ILBM,
234 AV_CODEC_ID_IFF_BYTERUN1,
240 AV_CODEC_ID_A64_MULTI,
241 AV_CODEC_ID_A64_MULTI5,
244 AV_CODEC_ID_LAGARITH,
248 AV_CODEC_ID_WMV3IMAGE,
249 AV_CODEC_ID_VC1IMAGE,
251 AV_CODEC_ID_BMV_VIDEO,
258 AV_CODEC_ID_ZEROCODEC,
265 /* various PCM "codecs" */
266 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
267 AV_CODEC_ID_PCM_S16LE = 0x10000,
268 AV_CODEC_ID_PCM_S16BE,
269 AV_CODEC_ID_PCM_U16LE,
270 AV_CODEC_ID_PCM_U16BE,
273 AV_CODEC_ID_PCM_MULAW,
274 AV_CODEC_ID_PCM_ALAW,
275 AV_CODEC_ID_PCM_S32LE,
276 AV_CODEC_ID_PCM_S32BE,
277 AV_CODEC_ID_PCM_U32LE,
278 AV_CODEC_ID_PCM_U32BE,
279 AV_CODEC_ID_PCM_S24LE,
280 AV_CODEC_ID_PCM_S24BE,
281 AV_CODEC_ID_PCM_U24LE,
282 AV_CODEC_ID_PCM_U24BE,
283 AV_CODEC_ID_PCM_S24DAUD,
284 AV_CODEC_ID_PCM_ZORK,
285 AV_CODEC_ID_PCM_S16LE_PLANAR,
287 AV_CODEC_ID_PCM_F32BE,
288 AV_CODEC_ID_PCM_F32LE,
289 AV_CODEC_ID_PCM_F64BE,
290 AV_CODEC_ID_PCM_F64LE,
291 AV_CODEC_ID_PCM_BLURAY,
294 AV_CODEC_ID_PCM_S8_PLANAR,
296 /* various ADPCM codecs */
297 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
298 AV_CODEC_ID_ADPCM_IMA_WAV,
299 AV_CODEC_ID_ADPCM_IMA_DK3,
300 AV_CODEC_ID_ADPCM_IMA_DK4,
301 AV_CODEC_ID_ADPCM_IMA_WS,
302 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
303 AV_CODEC_ID_ADPCM_MS,
304 AV_CODEC_ID_ADPCM_4XM,
305 AV_CODEC_ID_ADPCM_XA,
306 AV_CODEC_ID_ADPCM_ADX,
307 AV_CODEC_ID_ADPCM_EA,
308 AV_CODEC_ID_ADPCM_G726,
309 AV_CODEC_ID_ADPCM_CT,
310 AV_CODEC_ID_ADPCM_SWF,
311 AV_CODEC_ID_ADPCM_YAMAHA,
312 AV_CODEC_ID_ADPCM_SBPRO_4,
313 AV_CODEC_ID_ADPCM_SBPRO_3,
314 AV_CODEC_ID_ADPCM_SBPRO_2,
315 AV_CODEC_ID_ADPCM_THP,
316 AV_CODEC_ID_ADPCM_IMA_AMV,
317 AV_CODEC_ID_ADPCM_EA_R1,
318 AV_CODEC_ID_ADPCM_EA_R3,
319 AV_CODEC_ID_ADPCM_EA_R2,
320 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
321 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
322 AV_CODEC_ID_ADPCM_EA_XAS,
323 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
324 AV_CODEC_ID_ADPCM_IMA_ISS,
325 AV_CODEC_ID_ADPCM_G722,
326 AV_CODEC_ID_ADPCM_IMA_APC,
329 AV_CODEC_ID_AMR_NB = 0x12000,
332 /* RealAudio codecs*/
333 AV_CODEC_ID_RA_144 = 0x13000,
336 /* various DPCM codecs */
337 AV_CODEC_ID_ROQ_DPCM = 0x14000,
338 AV_CODEC_ID_INTERPLAY_DPCM,
339 AV_CODEC_ID_XAN_DPCM,
340 AV_CODEC_ID_SOL_DPCM,
343 AV_CODEC_ID_MP2 = 0x15000,
344 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
354 AV_CODEC_ID_VMDAUDIO,
360 AV_CODEC_ID_WESTWOOD_SND1,
361 AV_CODEC_ID_GSM, ///< as in Berlin toast format
364 AV_CODEC_ID_TRUESPEECH,
366 AV_CODEC_ID_SMACKAUDIO,
369 AV_CODEC_ID_DSICINAUDIO,
371 AV_CODEC_ID_MUSEPACK7,
373 AV_CODEC_ID_GSM_MS, /* as found in WAV */
377 AV_CODEC_ID_NELLYMOSER,
378 AV_CODEC_ID_MUSEPACK8,
380 AV_CODEC_ID_WMAVOICE,
382 AV_CODEC_ID_WMALOSSLESS,
391 AV_CODEC_ID_BINKAUDIO_RDFT,
392 AV_CODEC_ID_BINKAUDIO_DCT,
393 AV_CODEC_ID_AAC_LATM,
398 AV_CODEC_ID_8SVX_EXP,
399 AV_CODEC_ID_8SVX_FIB,
400 AV_CODEC_ID_BMV_AUDIO,
405 /* subtitle codecs */
406 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
407 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
408 AV_CODEC_ID_DVB_SUBTITLE,
409 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
412 AV_CODEC_ID_MOV_TEXT,
413 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
414 AV_CODEC_ID_DVB_TELETEXT,
417 /* other specific kind of codecs (generally used for attachments) */
418 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
419 AV_CODEC_ID_TTF = 0x18000,
421 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
423 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
424 * stream (only used by libavformat) */
425 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
426 * stream (only used by libavformat) */
427 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
430 #include "old_codec_ids.h"
435 #define CodecID AVCodecID
439 * This struct describes the properties of a single codec described by an
441 * @see avcodec_get_descriptor()
443 typedef struct AVCodecDescriptor {
445 enum AVMediaType type;
447 * Name of the codec described by this descriptor. It is non-empty and
448 * unique for each codec descriptor. It should contain alphanumeric
449 * characters and '_' only.
453 * A more descriptive name for this codec. May be NULL.
455 const char *long_name;
457 * Codec properties, a combination of AV_CODEC_PROP_* flags.
463 * Codec uses only intra compression.
466 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
468 #if FF_API_OLD_DECODE_AUDIO
470 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
474 * @ingroup lavc_decoding
475 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
476 * This is mainly needed because some optimized bitstream readers read
477 * 32 or 64 bit at once and could read over the end.<br>
478 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
479 * MPEG bitstreams could cause overread and segfault.
481 #define FF_INPUT_BUFFER_PADDING_SIZE 8
484 * @ingroup lavc_encoding
485 * minimum encoding buffer size
486 * Used to avoid some checks during header writing.
488 #define FF_MIN_BUFFER_SIZE 16384
492 * @ingroup lavc_encoding
493 * motion estimation type.
496 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
500 ME_EPZS, ///< enhanced predictive zonal search
501 ME_X1, ///< reserved for experiments
502 ME_HEX, ///< hexagon based search
503 ME_UMH, ///< uneven multi-hexagon search
504 ME_ITER, ///< iterative search
505 ME_TESA, ///< transformed exhaustive search algorithm
509 * @ingroup lavc_decoding
512 /* We leave some space between them for extensions (drop some
513 * keyframes for intra-only or drop just some bidir frames). */
514 AVDISCARD_NONE =-16, ///< discard nothing
515 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
516 AVDISCARD_NONREF = 8, ///< discard all non reference
517 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
518 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
519 AVDISCARD_ALL = 48, ///< discard all
522 enum AVColorPrimaries{
523 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
524 AVCOL_PRI_UNSPECIFIED = 2,
525 AVCOL_PRI_BT470M = 4,
526 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
527 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
528 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
530 AVCOL_PRI_NB , ///< Not part of ABI
533 enum AVColorTransferCharacteristic{
534 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
535 AVCOL_TRC_UNSPECIFIED = 2,
536 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
537 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
538 AVCOL_TRC_SMPTE240M = 7,
539 AVCOL_TRC_NB , ///< Not part of ABI
544 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
545 AVCOL_SPC_UNSPECIFIED = 2,
547 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
548 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
549 AVCOL_SPC_SMPTE240M = 7,
550 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
551 AVCOL_SPC_NB , ///< Not part of ABI
555 AVCOL_RANGE_UNSPECIFIED = 0,
556 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
557 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
558 AVCOL_RANGE_NB , ///< Not part of ABI
562 * X X 3 4 X X are luma samples,
563 * 1 2 1-6 are possible chroma positions
564 * X X 5 6 X 0 is undefined/unknown position
566 enum AVChromaLocation{
567 AVCHROMA_LOC_UNSPECIFIED = 0,
568 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
569 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
570 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
571 AVCHROMA_LOC_TOP = 4,
572 AVCHROMA_LOC_BOTTOMLEFT = 5,
573 AVCHROMA_LOC_BOTTOM = 6,
574 AVCHROMA_LOC_NB , ///< Not part of ABI
577 enum AVAudioServiceType {
578 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
579 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
580 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
581 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
582 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
583 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
584 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
585 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
586 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
587 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
591 * @ingroup lavc_encoding
593 typedef struct RcOverride{
596 int qscale; // If this is 0 then quality_factor will be used instead.
597 float quality_factor;
600 #define FF_MAX_B_FRAMES 16
603 These flags can be passed in AVCodecContext.flags before initialization.
604 Note: Not everything is supported yet.
607 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
608 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
609 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
610 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
611 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
613 * The parent program guarantees that the input for B-frames containing
614 * streams is not written to for at least s->max_b_frames+1 frames, if
615 * this is not set the input will be copied.
617 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
618 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
619 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
620 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
621 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
622 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
623 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
624 location instead of only at frame boundaries. */
625 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
626 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
627 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
628 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
629 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
630 /* Fx : Flag for h263+ extra options */
631 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
632 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
633 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
634 #define CODEC_FLAG_CLOSED_GOP 0x80000000
635 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
636 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
637 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
638 #if FF_API_MPV_GLOBAL_OPTS
639 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
640 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
641 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
642 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
644 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
646 /* Unsupported options :
647 * Syntax Arithmetic coding (SAC)
648 * Reference Picture Selection
649 * Independent Segment Decoding */
651 /* codec capabilities */
653 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
655 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
656 * If not set, it might not use get_buffer() at all or use operations that
657 * assume the buffer was allocated by avcodec_default_get_buffer.
659 #define CODEC_CAP_DR1 0x0002
660 #define CODEC_CAP_TRUNCATED 0x0008
661 /* Codec can export data for HW decoding (XvMC). */
662 #define CODEC_CAP_HWACCEL 0x0010
664 * Encoder or decoder requires flushing with NULL input at the end in order to
665 * give the complete and correct output.
667 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
668 * with NULL data. The user can still send NULL data to the public encode
669 * or decode function, but libavcodec will not pass it along to the codec
670 * unless this flag is set.
673 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
674 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
678 * The encoder needs to be fed with NULL data at the end of encoding until the
679 * encoder no longer returns data.
681 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
682 * flag also means that the encoder must set the pts and duration for
683 * each output packet. If this flag is not set, the pts and duration will
684 * be determined by libavcodec from the input frame.
686 #define CODEC_CAP_DELAY 0x0020
688 * Codec can be fed a final frame with a smaller size.
689 * This can be used to prevent truncation of the last audio samples.
691 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
693 * Codec can export data for HW decoding (VDPAU).
695 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
697 * Codec can output multiple frames per AVPacket
698 * Normally demuxers return one frame at a time, demuxers which do not do
699 * are connected to a parser to split what they return into proper frames.
700 * This flag is reserved to the very rare category of codecs which have a
701 * bitstream that cannot be split into frames without timeconsuming
702 * operations like full decoding. Demuxers carring such bitstreams thus
703 * may return multiple frames in a packet. This has many disadvantages like
704 * prohibiting stream copy in many cases thus it should only be considered
707 #define CODEC_CAP_SUBFRAMES 0x0100
709 * Codec is experimental and is thus avoided in favor of non experimental
712 #define CODEC_CAP_EXPERIMENTAL 0x0200
714 * Codec should fill in channel configuration and samplerate instead of container
716 #define CODEC_CAP_CHANNEL_CONF 0x0400
718 * Codec is able to deal with negative linesizes
720 #define CODEC_CAP_NEG_LINESIZES 0x0800
722 * Codec supports frame-level multithreading.
724 #define CODEC_CAP_FRAME_THREADS 0x1000
726 * Codec supports slice-based (or partition-based) multithreading.
728 #define CODEC_CAP_SLICE_THREADS 0x2000
730 * Codec supports changed parameters at any point.
732 #define CODEC_CAP_PARAM_CHANGE 0x4000
734 * Codec supports avctx->thread_count == 0 (auto).
736 #define CODEC_CAP_AUTO_THREADS 0x8000
738 * Audio encoder supports receiving a different number of samples in each call.
740 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
742 //The following defines may change, don't expect compatibility if you use them.
743 #define MB_TYPE_INTRA4x4 0x0001
744 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
745 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
746 #define MB_TYPE_16x16 0x0008
747 #define MB_TYPE_16x8 0x0010
748 #define MB_TYPE_8x16 0x0020
749 #define MB_TYPE_8x8 0x0040
750 #define MB_TYPE_INTERLACED 0x0080
751 #define MB_TYPE_DIRECT2 0x0100 //FIXME
752 #define MB_TYPE_ACPRED 0x0200
753 #define MB_TYPE_GMC 0x0400
754 #define MB_TYPE_SKIP 0x0800
755 #define MB_TYPE_P0L0 0x1000
756 #define MB_TYPE_P1L0 0x2000
757 #define MB_TYPE_P0L1 0x4000
758 #define MB_TYPE_P1L1 0x8000
759 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
760 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
761 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
762 #define MB_TYPE_QUANT 0x00010000
763 #define MB_TYPE_CBP 0x00020000
764 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
768 * This specifies the area which should be displayed.
769 * Note there may be multiple such areas for one frame.
771 typedef struct AVPanScan{
774 * - encoding: Set by user.
775 * - decoding: Set by libavcodec.
780 * width and height in 1/16 pel
781 * - encoding: Set by user.
782 * - decoding: Set by libavcodec.
788 * position of the top left corner in 1/16 pel for up to 3 fields/frames
789 * - encoding: Set by user.
790 * - decoding: Set by libavcodec.
792 int16_t position[3][2];
795 #define FF_QSCALE_TYPE_MPEG1 0
796 #define FF_QSCALE_TYPE_MPEG2 1
797 #define FF_QSCALE_TYPE_H264 2
798 #define FF_QSCALE_TYPE_VP56 3
800 #define FF_BUFFER_TYPE_INTERNAL 1
801 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
802 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
803 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
805 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
806 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
807 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
808 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
811 * @defgroup lavc_packet AVPacket
813 * Types and functions for working with AVPacket.
816 enum AVPacketSideDataType {
818 AV_PKT_DATA_NEW_EXTRADATA,
821 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
824 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
825 * s32le channel_count
826 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
827 * u64le channel_layout
828 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
830 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
835 AV_PKT_DATA_PARAM_CHANGE,
838 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
839 * structures with info about macroblocks relevant to splitting the
840 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
841 * That is, it does not necessarily contain info about all macroblocks,
842 * as long as the distance between macroblocks in the info is smaller
843 * than the target payload size.
844 * Each MB info structure is 12 bytes, and is laid out as follows:
846 * u32le bit offset from the start of the packet
847 * u8 current quantizer at the start of the macroblock
849 * u16le macroblock address within the GOB
850 * u8 horizontal MV predictor
851 * u8 vertical MV predictor
852 * u8 horizontal MV predictor for block number 3
853 * u8 vertical MV predictor for block number 3
856 AV_PKT_DATA_H263_MB_INFO,
859 typedef struct AVPacket {
861 * Presentation timestamp in AVStream->time_base units; the time at which
862 * the decompressed packet will be presented to the user.
863 * Can be AV_NOPTS_VALUE if it is not stored in the file.
864 * pts MUST be larger or equal to dts as presentation cannot happen before
865 * decompression, unless one wants to view hex dumps. Some formats misuse
866 * the terms dts and pts/cts to mean something different. Such timestamps
867 * must be converted to true pts/dts before they are stored in AVPacket.
871 * Decompression timestamp in AVStream->time_base units; the time at which
872 * the packet is decompressed.
873 * Can be AV_NOPTS_VALUE if it is not stored in the file.
880 * A combination of AV_PKT_FLAG values
884 * Additional packet data that can be provided by the container.
885 * Packet can contain several types of side information.
890 enum AVPacketSideDataType type;
895 * Duration of this packet in AVStream->time_base units, 0 if unknown.
896 * Equals next_pts - this_pts in presentation order.
899 void (*destruct)(struct AVPacket *);
901 int64_t pos; ///< byte position in stream, -1 if unknown
904 * Time difference in AVStream->time_base units from the pts of this
905 * packet to the point at which the output from the decoder has converged
906 * independent from the availability of previous frames. That is, the
907 * frames are virtually identical no matter if decoding started from
908 * the very first frame or from this keyframe.
909 * Is AV_NOPTS_VALUE if unknown.
910 * This field is not the display duration of the current packet.
911 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
914 * The purpose of this field is to allow seeking in streams that have no
915 * keyframes in the conventional sense. It corresponds to the
916 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
917 * essential for some types of subtitle streams to ensure that all
918 * subtitles are correctly displayed after seeking.
920 int64_t convergence_duration;
922 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
923 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
925 enum AVSideDataParamChangeFlags {
926 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
927 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
928 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
929 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
937 * New fields can be added to the end of AVFRAME with minor version
938 * bumps. Removal, reordering and changes to existing fields require
939 * a major version bump.
940 * sizeof(AVFrame) must not be used outside libav*.
942 typedef struct AVFrame {
943 #define AV_NUM_DATA_POINTERS 8
945 * pointer to the picture/channel planes.
946 * This might be different from the first allocated byte
947 * - encoding: Set by user
948 * - decoding: set by AVCodecContext.get_buffer()
950 uint8_t *data[AV_NUM_DATA_POINTERS];
953 * Size, in bytes, of the data for each picture/channel plane.
955 * For audio, only linesize[0] may be set. For planar audio, each channel
956 * plane must be the same size.
958 * - encoding: Set by user
959 * - decoding: set by AVCodecContext.get_buffer()
961 int linesize[AV_NUM_DATA_POINTERS];
964 * pointers to the data planes/channels.
966 * For video, this should simply point to data[].
968 * For planar audio, each channel has a separate data pointer, and
969 * linesize[0] contains the size of each channel buffer.
970 * For packed audio, there is just one data pointer, and linesize[0]
971 * contains the total size of the buffer for all channels.
973 * Note: Both data and extended_data will always be set by get_buffer(),
974 * but for planar audio with more channels that can fit in data,
975 * extended_data must be used by the decoder in order to access all
979 * decoding: set by AVCodecContext.get_buffer()
981 uint8_t **extended_data;
984 * width and height of the video frame
986 * - decoding: Read by user.
991 * number of audio samples (per channel) described by this frame
992 * - encoding: Set by user
993 * - decoding: Set by libavcodec
998 * format of the frame, -1 if unknown or unset
999 * Values correspond to enum PixelFormat for video frames,
1000 * enum AVSampleFormat for audio)
1001 * - encoding: unused
1002 * - decoding: Read by user.
1007 * 1 -> keyframe, 0-> not
1008 * - encoding: Set by libavcodec.
1009 * - decoding: Set by libavcodec.
1014 * Picture type of the frame, see ?_TYPE below.
1015 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1016 * - decoding: Set by libavcodec.
1018 enum AVPictureType pict_type;
1021 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1022 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1026 uint8_t *base[AV_NUM_DATA_POINTERS];
1029 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1030 * - encoding: unused
1031 * - decoding: Read by user.
1033 AVRational sample_aspect_ratio;
1036 * presentation timestamp in time_base units (time when frame should be shown to user)
1037 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1038 * - encoding: MUST be set by user.
1039 * - decoding: Set by libavcodec.
1044 * reordered pts from the last AVPacket that has been input into the decoder
1045 * - encoding: unused
1046 * - decoding: Read by user.
1051 * dts from the last AVPacket that has been input into the decoder
1052 * - encoding: unused
1053 * - decoding: Read by user.
1058 * picture number in bitstream order
1059 * - encoding: set by
1060 * - decoding: Set by libavcodec.
1062 int coded_picture_number;
1064 * picture number in display order
1065 * - encoding: set by
1066 * - decoding: Set by libavcodec.
1068 int display_picture_number;
1071 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1072 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1073 * - decoding: Set by libavcodec.
1078 * is this picture used as reference
1079 * The values for this are the same as the MpegEncContext.picture_structure
1080 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1081 * Set to 4 for delayed, non-reference frames.
1082 * - encoding: unused
1083 * - decoding: Set by libavcodec. (before get_buffer() call)).
1089 * - encoding: unused
1090 * - decoding: Set by libavcodec.
1092 int8_t *qscale_table;
1095 * - encoding: unused
1096 * - decoding: Set by libavcodec.
1106 * mbskip_table[mb]>=1 if MB didn't change
1107 * stride= mb_width = (width+15)>>4
1108 * - encoding: unused
1109 * - decoding: Set by libavcodec.
1111 uint8_t *mbskip_table;
1114 * motion vector table
1117 * int mv_sample_log2= 4 - motion_subsample_log2;
1118 * int mb_width= (width+15)>>4;
1119 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1120 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1122 * - encoding: Set by user.
1123 * - decoding: Set by libavcodec.
1125 int16_t (*motion_val[2])[2];
1128 * macroblock type table
1129 * mb_type_base + mb_width + 2
1130 * - encoding: Set by user.
1131 * - decoding: Set by libavcodec.
1137 * - encoding: unused
1138 * - decoding: Set by libavcodec.
1143 * motion reference frame index
1144 * the order in which these are stored can depend on the codec.
1145 * - encoding: Set by user.
1146 * - decoding: Set by libavcodec.
1148 int8_t *ref_index[2];
1151 * for some private data of the user
1152 * - encoding: unused
1153 * - decoding: Set by user.
1159 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1160 * - decoding: unused
1162 uint64_t error[AV_NUM_DATA_POINTERS];
1165 * type of the buffer (to keep track of who has to deallocate data[*])
1166 * - encoding: Set by the one who allocates it.
1167 * - decoding: Set by the one who allocates it.
1168 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1173 * When decoding, this signals how much the picture must be delayed.
1174 * extra_delay = repeat_pict / (2*fps)
1175 * - encoding: unused
1176 * - decoding: Set by libavcodec.
1181 * The content of the picture is interlaced.
1182 * - encoding: Set by user.
1183 * - decoding: Set by libavcodec. (default 0)
1185 int interlaced_frame;
1188 * If the content is interlaced, is top field displayed first.
1189 * - encoding: Set by user.
1190 * - decoding: Set by libavcodec.
1192 int top_field_first;
1195 * Tell user application that palette has changed from previous frame.
1196 * - encoding: ??? (no palette-enabled encoder yet)
1197 * - decoding: Set by libavcodec. (default 0).
1199 int palette_has_changed;
1202 * codec suggestion on buffer type if != 0
1203 * - encoding: unused
1204 * - decoding: Set by libavcodec. (before get_buffer() call)).
1210 * - encoding: Set by user.
1211 * - decoding: Set by libavcodec.
1213 AVPanScan *pan_scan;
1216 * reordered opaque 64bit (generally an integer or a double precision float
1217 * PTS but can be anything).
1218 * The user sets AVCodecContext.reordered_opaque to represent the input at
1220 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1221 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1222 * @deprecated in favor of pkt_pts
1223 * - encoding: unused
1224 * - decoding: Read by user.
1226 int64_t reordered_opaque;
1229 * hardware accelerator private data (Libav-allocated)
1230 * - encoding: unused
1231 * - decoding: Set by libavcodec
1233 void *hwaccel_picture_private;
1236 * the AVCodecContext which ff_thread_get_buffer() was last called on
1237 * - encoding: Set by libavcodec.
1238 * - decoding: Set by libavcodec.
1240 struct AVCodecContext *owner;
1243 * used by multithreading to store frame-specific info
1244 * - encoding: Set by libavcodec.
1245 * - decoding: Set by libavcodec.
1247 void *thread_opaque;
1250 * log2 of the size of the block which a single vector in motion_val represents:
1251 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1252 * - encoding: unused
1253 * - decoding: Set by libavcodec.
1255 uint8_t motion_subsample_log2;
1258 * Sample rate of the audio data.
1260 * - encoding: unused
1261 * - decoding: set by get_buffer()
1266 * Channel layout of the audio data.
1268 * - encoding: unused
1269 * - decoding: set by get_buffer()
1271 uint64_t channel_layout;
1274 struct AVCodecInternal;
1278 AV_FIELD_PROGRESSIVE,
1279 AV_FIELD_TT, //< Top coded_first, top displayed first
1280 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1281 AV_FIELD_TB, //< Top coded first, bottom displayed first
1282 AV_FIELD_BT, //< Bottom coded first, top displayed first
1286 * main external API structure.
1287 * New fields can be added to the end with minor version bumps.
1288 * Removal, reordering and changes to existing fields require a major
1290 * sizeof(AVCodecContext) must not be used outside libav*.
1292 typedef struct AVCodecContext {
1294 * information on struct for av_log
1295 * - set by avcodec_alloc_context3
1297 const AVClass *av_class;
1298 int log_level_offset;
1300 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1301 const struct AVCodec *codec;
1302 char codec_name[32];
1303 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1306 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1307 * This is used to work around some encoder bugs.
1308 * A demuxer should set this to what is stored in the field used to identify the codec.
1309 * If there are multiple such fields in a container then the demuxer should choose the one
1310 * which maximizes the information about the used codec.
1311 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1312 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1313 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1315 * - encoding: Set by user, if not then the default based on codec_id will be used.
1316 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1318 unsigned int codec_tag;
1321 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1322 * This is used to work around some encoder bugs.
1323 * - encoding: unused
1324 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1326 unsigned int stream_codec_tag;
1330 * @deprecated this field is unused
1332 attribute_deprecated int sub_id;
1338 * Private context used for internal data.
1340 * Unlike priv_data, this is not codec-specific. It is used in general
1341 * libavcodec functions.
1343 struct AVCodecInternal *internal;
1346 * Private data of the user, can be used to carry app specific stuff.
1347 * - encoding: Set by user.
1348 * - decoding: Set by user.
1353 * the average bitrate
1354 * - encoding: Set by user; unused for constant quantizer encoding.
1355 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1360 * number of bits the bitstream is allowed to diverge from the reference.
1361 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1362 * - encoding: Set by user; unused for constant quantizer encoding.
1363 * - decoding: unused
1365 int bit_rate_tolerance;
1368 * Global quality for codecs which cannot change it per frame.
1369 * This should be proportional to MPEG-1/2/4 qscale.
1370 * - encoding: Set by user.
1371 * - decoding: unused
1376 * - encoding: Set by user.
1377 * - decoding: unused
1379 int compression_level;
1380 #define FF_COMPRESSION_DEFAULT -1
1384 * - encoding: Set by user.
1385 * - decoding: Set by user.
1391 * - encoding: Set by user.
1392 * - decoding: Set by user.
1397 * some codecs need / can use extradata like Huffman tables.
1398 * mjpeg: Huffman tables
1399 * rv10: additional flags
1400 * mpeg4: global headers (they can be in the bitstream or here)
1401 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1402 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1403 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1404 * - encoding: Set/allocated/freed by libavcodec.
1405 * - decoding: Set/allocated/freed by user.
1411 * This is the fundamental unit of time (in seconds) in terms
1412 * of which frame timestamps are represented. For fixed-fps content,
1413 * timebase should be 1/framerate and timestamp increments should be
1415 * - encoding: MUST be set by user.
1416 * - decoding: Set by libavcodec.
1418 AVRational time_base;
1421 * For some codecs, the time base is closer to the field rate than the frame rate.
1422 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1423 * if no telecine is used ...
1425 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1427 int ticks_per_frame;
1433 * Number of frames the decoded output will be delayed relative to the
1437 * Number of "priming" samples added to the beginning of the stream
1438 * during encoding. The decoded output will be delayed by this many
1439 * samples relative to the input to the encoder. Note that this field is
1440 * purely informational and does not directly affect the pts output by
1441 * the encoder, which should always be based on the actual presentation
1442 * time, including any delay.
1444 * - encoding: Set by libavcodec.
1445 * - decoding: unused
1452 * picture width / height.
1453 * - encoding: MUST be set by user.
1454 * - decoding: Set by libavcodec.
1455 * Note: For compatibility it is possible to set this instead of
1456 * coded_width/height before decoding.
1461 * Bitstream width / height, may be different from width/height.
1462 * - encoding: unused
1463 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1465 int coded_width, coded_height;
1467 #define FF_ASPECT_EXTENDED 15
1470 * the number of pictures in a group of pictures, or 0 for intra_only
1471 * - encoding: Set by user.
1472 * - decoding: unused
1477 * Pixel format, see PIX_FMT_xxx.
1478 * May be set by the demuxer if known from headers.
1479 * May be overriden by the decoder if it knows better.
1480 * - encoding: Set by user.
1481 * - decoding: Set by user if known, overridden by libavcodec if known
1483 enum PixelFormat pix_fmt;
1486 * Motion estimation algorithm used for video coding.
1487 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1488 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1489 * - encoding: MUST be set by user.
1490 * - decoding: unused
1495 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1496 * decoder to draw a horizontal band. It improves cache usage. Not
1497 * all codecs can do that. You must check the codec capabilities
1499 * When multithreading is used, it may be called from multiple threads
1500 * at the same time; threads might draw different parts of the same AVFrame,
1501 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1503 * The function is also used by hardware acceleration APIs.
1504 * It is called at least once during frame decoding to pass
1505 * the data needed for hardware render.
1506 * In that mode instead of pixel data, AVFrame points to
1507 * a structure specific to the acceleration API. The application
1508 * reads the structure and can change some fields to indicate progress
1510 * - encoding: unused
1511 * - decoding: Set by user.
1512 * @param height the height of the slice
1513 * @param y the y position of the slice
1514 * @param type 1->top field, 2->bottom field, 3->frame
1515 * @param offset offset into the AVFrame.data from which the slice should be read
1517 void (*draw_horiz_band)(struct AVCodecContext *s,
1518 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1519 int y, int type, int height);
1522 * callback to negotiate the pixelFormat
1523 * @param fmt is the list of formats which are supported by the codec,
1524 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1525 * The first is always the native one.
1526 * @return the chosen format
1527 * - encoding: unused
1528 * - decoding: Set by user, if not set the native format will be chosen.
1530 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1533 * maximum number of B-frames between non-B-frames
1534 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1535 * - encoding: Set by user.
1536 * - decoding: unused
1541 * qscale factor between IP and B-frames
1542 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1543 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1544 * - encoding: Set by user.
1545 * - decoding: unused
1547 float b_quant_factor;
1549 /** obsolete FIXME remove */
1551 #define FF_RC_STRATEGY_XVID 1
1553 int b_frame_strategy;
1555 #if FF_API_MPV_GLOBAL_OPTS
1557 * luma single coefficient elimination threshold
1558 * - encoding: Set by user.
1559 * - decoding: unused
1561 attribute_deprecated int luma_elim_threshold;
1564 * chroma single coeff elimination threshold
1565 * - encoding: Set by user.
1566 * - decoding: unused
1568 attribute_deprecated int chroma_elim_threshold;
1572 * qscale offset between IP and B-frames
1573 * - encoding: Set by user.
1574 * - decoding: unused
1576 float b_quant_offset;
1579 * Size of the frame reordering buffer in the decoder.
1580 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1581 * - encoding: Set by libavcodec.
1582 * - decoding: Set by libavcodec.
1587 * 0-> h263 quant 1-> mpeg quant
1588 * - encoding: Set by user.
1589 * - decoding: unused
1594 * qscale factor between P and I-frames
1595 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1596 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1597 * - encoding: Set by user.
1598 * - decoding: unused
1600 float i_quant_factor;
1603 * qscale offset between P and I-frames
1604 * - encoding: Set by user.
1605 * - decoding: unused
1607 float i_quant_offset;
1610 * luminance masking (0-> disabled)
1611 * - encoding: Set by user.
1612 * - decoding: unused
1617 * temporary complexity masking (0-> disabled)
1618 * - encoding: Set by user.
1619 * - decoding: unused
1621 float temporal_cplx_masking;
1624 * spatial complexity masking (0-> disabled)
1625 * - encoding: Set by user.
1626 * - decoding: unused
1628 float spatial_cplx_masking;
1631 * p block masking (0-> disabled)
1632 * - encoding: Set by user.
1633 * - decoding: unused
1638 * darkness masking (0-> disabled)
1639 * - encoding: Set by user.
1640 * - decoding: unused
1646 * - encoding: Set by libavcodec.
1647 * - decoding: Set by user (or 0).
1651 * prediction method (needed for huffyuv)
1652 * - encoding: Set by user.
1653 * - decoding: unused
1655 int prediction_method;
1656 #define FF_PRED_LEFT 0
1657 #define FF_PRED_PLANE 1
1658 #define FF_PRED_MEDIAN 2
1661 * slice offsets in the frame in bytes
1662 * - encoding: Set/allocated by libavcodec.
1663 * - decoding: Set/allocated by user (or NULL).
1668 * sample aspect ratio (0 if unknown)
1669 * That is the width of a pixel divided by the height of the pixel.
1670 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1671 * - encoding: Set by user.
1672 * - decoding: Set by libavcodec.
1674 AVRational sample_aspect_ratio;
1677 * motion estimation comparison function
1678 * - encoding: Set by user.
1679 * - decoding: unused
1683 * subpixel motion estimation comparison function
1684 * - encoding: Set by user.
1685 * - decoding: unused
1689 * macroblock comparison function (not supported yet)
1690 * - encoding: Set by user.
1691 * - decoding: unused
1695 * interlaced DCT comparison function
1696 * - encoding: Set by user.
1697 * - decoding: unused
1700 #define FF_CMP_SAD 0
1701 #define FF_CMP_SSE 1
1702 #define FF_CMP_SATD 2
1703 #define FF_CMP_DCT 3
1704 #define FF_CMP_PSNR 4
1705 #define FF_CMP_BIT 5
1707 #define FF_CMP_ZERO 7
1708 #define FF_CMP_VSAD 8
1709 #define FF_CMP_VSSE 9
1710 #define FF_CMP_NSSE 10
1711 #define FF_CMP_W53 11
1712 #define FF_CMP_W97 12
1713 #define FF_CMP_DCTMAX 13
1714 #define FF_CMP_DCT264 14
1715 #define FF_CMP_CHROMA 256
1718 * ME diamond size & shape
1719 * - encoding: Set by user.
1720 * - decoding: unused
1725 * amount of previous MV predictors (2a+1 x 2a+1 square)
1726 * - encoding: Set by user.
1727 * - decoding: unused
1729 int last_predictor_count;
1732 * prepass for motion estimation
1733 * - encoding: Set by user.
1734 * - decoding: unused
1739 * motion estimation prepass comparison function
1740 * - encoding: Set by user.
1741 * - decoding: unused
1746 * ME prepass diamond size & shape
1747 * - encoding: Set by user.
1748 * - decoding: unused
1754 * - encoding: Set by user.
1755 * - decoding: unused
1757 int me_subpel_quality;
1760 * DTG active format information (additional aspect ratio
1761 * information only used in DVB MPEG-2 transport streams)
1764 * - encoding: unused
1765 * - decoding: Set by decoder.
1767 int dtg_active_format;
1768 #define FF_DTG_AFD_SAME 8
1769 #define FF_DTG_AFD_4_3 9
1770 #define FF_DTG_AFD_16_9 10
1771 #define FF_DTG_AFD_14_9 11
1772 #define FF_DTG_AFD_4_3_SP_14_9 13
1773 #define FF_DTG_AFD_16_9_SP_14_9 14
1774 #define FF_DTG_AFD_SP_4_3 15
1777 * maximum motion estimation search range in subpel units
1778 * If 0 then no limit.
1780 * - encoding: Set by user.
1781 * - decoding: unused
1786 * intra quantizer bias
1787 * - encoding: Set by user.
1788 * - decoding: unused
1790 int intra_quant_bias;
1791 #define FF_DEFAULT_QUANT_BIAS 999999
1794 * inter quantizer bias
1795 * - encoding: Set by user.
1796 * - decoding: unused
1798 int inter_quant_bias;
1800 #if FF_API_COLOR_TABLE_ID
1803 * - encoding: unused
1804 * - decoding: Which clrtable should be used for 8bit RGB images.
1805 * Tables have to be stored somewhere. FIXME
1807 attribute_deprecated int color_table_id;
1812 * - encoding: unused
1813 * - decoding: Set by user.
1816 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1817 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1818 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1821 * XVideo Motion Acceleration
1822 * - encoding: forbidden
1823 * - decoding: set by decoder
1825 int xvmc_acceleration;
1828 * macroblock decision mode
1829 * - encoding: Set by user.
1830 * - decoding: unused
1833 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1834 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1835 #define FF_MB_DECISION_RD 2 ///< rate distortion
1838 * custom intra quantization matrix
1839 * - encoding: Set by user, can be NULL.
1840 * - decoding: Set by libavcodec.
1842 uint16_t *intra_matrix;
1845 * custom inter quantization matrix
1846 * - encoding: Set by user, can be NULL.
1847 * - decoding: Set by libavcodec.
1849 uint16_t *inter_matrix;
1852 * scene change detection threshold
1853 * 0 is default, larger means fewer detected scene changes.
1854 * - encoding: Set by user.
1855 * - decoding: unused
1857 int scenechange_threshold;
1860 * noise reduction strength
1861 * - encoding: Set by user.
1862 * - decoding: unused
1864 int noise_reduction;
1866 #if FF_API_INTER_THRESHOLD
1868 * @deprecated this field is unused
1870 attribute_deprecated int inter_threshold;
1873 #if FF_API_MPV_GLOBAL_OPTS
1875 * @deprecated use mpegvideo private options instead
1877 attribute_deprecated int quantizer_noise_shaping;
1881 * Motion estimation threshold below which no motion estimation is
1882 * performed, but instead the user specified motion vectors are used.
1884 * - encoding: Set by user.
1885 * - decoding: unused
1890 * Macroblock threshold below which the user specified macroblock types will be used.
1891 * - encoding: Set by user.
1892 * - decoding: unused
1897 * precision of the intra DC coefficient - 8
1898 * - encoding: Set by user.
1899 * - decoding: unused
1901 int intra_dc_precision;
1904 * Number of macroblock rows at the top which are skipped.
1905 * - encoding: unused
1906 * - decoding: Set by user.
1911 * Number of macroblock rows at the bottom which are skipped.
1912 * - encoding: unused
1913 * - decoding: Set by user.
1918 * Border processing masking, raises the quantizer for mbs on the borders
1920 * - encoding: Set by user.
1921 * - decoding: unused
1923 float border_masking;
1926 * minimum MB lagrange multipler
1927 * - encoding: Set by user.
1928 * - decoding: unused
1933 * maximum MB lagrange multipler
1934 * - encoding: Set by user.
1935 * - decoding: unused
1941 * - encoding: Set by user.
1942 * - decoding: unused
1944 int me_penalty_compensation;
1948 * - encoding: Set by user.
1949 * - decoding: unused
1955 * - encoding: Set by user.
1956 * - decoding: unused
1962 * - encoding: Set by user.
1963 * - decoding: unused
1968 * number of reference frames
1969 * - encoding: Set by user.
1970 * - decoding: Set by lavc.
1975 * chroma qp offset from luma
1976 * - encoding: Set by user.
1977 * - decoding: unused
1982 * Multiplied by qscale for each frame and added to scene_change_score.
1983 * - encoding: Set by user.
1984 * - decoding: unused
1986 int scenechange_factor;
1990 * Note: Value depends upon the compare function used for fullpel ME.
1991 * - encoding: Set by user.
1992 * - decoding: unused
1997 * Adjust sensitivity of b_frame_strategy 1.
1998 * - encoding: Set by user.
1999 * - decoding: unused
2004 * Chromaticity coordinates of the source primaries.
2005 * - encoding: Set by user
2006 * - decoding: Set by libavcodec
2008 enum AVColorPrimaries color_primaries;
2011 * Color Transfer Characteristic.
2012 * - encoding: Set by user
2013 * - decoding: Set by libavcodec
2015 enum AVColorTransferCharacteristic color_trc;
2018 * YUV colorspace type.
2019 * - encoding: Set by user
2020 * - decoding: Set by libavcodec
2022 enum AVColorSpace colorspace;
2025 * MPEG vs JPEG YUV range.
2026 * - encoding: Set by user
2027 * - decoding: Set by libavcodec
2029 enum AVColorRange color_range;
2032 * This defines the location of chroma samples.
2033 * - encoding: Set by user
2034 * - decoding: Set by libavcodec
2036 enum AVChromaLocation chroma_sample_location;
2040 * Indicates number of picture subdivisions. Used for parallelized
2042 * - encoding: Set by user
2043 * - decoding: unused
2048 * - encoding: set by libavcodec
2049 * - decoding: Set by libavcodec
2051 enum AVFieldOrder field_order;
2054 int sample_rate; ///< samples per second
2055 int channels; ///< number of audio channels
2058 * audio sample format
2059 * - encoding: Set by user.
2060 * - decoding: Set by libavcodec.
2062 enum AVSampleFormat sample_fmt; ///< sample format
2064 /* The following data should not be initialized. */
2066 * Samples per packet, initialized when calling 'init'.
2071 * Frame counter, set by libavcodec.
2073 * - decoding: total number of frames returned from the decoder so far.
2074 * - encoding: total number of frames passed to the encoder so far.
2076 * @note the counter is not incremented if encoding/decoding resulted in
2082 * number of bytes per packet if constant and known or 0
2083 * Used by some WAV based audio codecs.
2088 * Audio cutoff bandwidth (0 means "automatic")
2089 * - encoding: Set by user.
2090 * - decoding: unused
2094 #if FF_API_REQUEST_CHANNELS
2096 * Decoder should decode to this many channels if it can (0 for default)
2097 * - encoding: unused
2098 * - decoding: Set by user.
2099 * @deprecated Deprecated in favor of request_channel_layout.
2101 int request_channels;
2105 * Audio channel layout.
2106 * - encoding: set by user.
2107 * - decoding: set by libavcodec.
2109 uint64_t channel_layout;
2112 * Request decoder to use this channel layout if it can (0 for default)
2113 * - encoding: unused
2114 * - decoding: Set by user.
2116 uint64_t request_channel_layout;
2119 * Type of service that the audio stream conveys.
2120 * - encoding: Set by user.
2121 * - decoding: Set by libavcodec.
2123 enum AVAudioServiceType audio_service_type;
2126 * Used to request a sample format from the decoder.
2127 * - encoding: unused.
2128 * - decoding: Set by user.
2130 enum AVSampleFormat request_sample_fmt;
2133 * Called at the beginning of each frame to get a buffer for it.
2135 * The function will set AVFrame.data[], AVFrame.linesize[].
2136 * AVFrame.extended_data[] must also be set, but it should be the same as
2137 * AVFrame.data[] except for planar audio with more channels than can fit
2138 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2139 * many data pointers as it can hold.
2141 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2142 * avcodec_default_get_buffer() instead of providing buffers allocated by
2145 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2146 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2147 * but if get_buffer() is overridden then alignment considerations should
2148 * be taken into account.
2150 * @see avcodec_default_get_buffer()
2154 * If pic.reference is set then the frame will be read later by libavcodec.
2155 * avcodec_align_dimensions2() should be used to find the required width and
2156 * height, as they normally need to be rounded up to the next multiple of 16.
2158 * If frame multithreading is used and thread_safe_callbacks is set,
2159 * it may be called from a different thread, but not from more than one at
2160 * once. Does not need to be reentrant.
2162 * @see release_buffer(), reget_buffer()
2163 * @see avcodec_align_dimensions2()
2167 * Decoders request a buffer of a particular size by setting
2168 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2169 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2170 * to a smaller value in the output frame.
2172 * Decoders cannot use the buffer after returning from
2173 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2174 * is assumed to be released immediately upon return.
2176 * As a convenience, av_samples_get_buffer_size() and
2177 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2178 * functions to find the required data size and to fill data pointers and
2179 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2180 * since all planes must be the same size.
2182 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2184 * - encoding: unused
2185 * - decoding: Set by libavcodec, user can override.
2187 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2190 * Called to release buffers which were allocated with get_buffer.
2191 * A released buffer can be reused in get_buffer().
2192 * pic.data[*] must be set to NULL.
2193 * May be called from a different thread if frame multithreading is used,
2194 * but not by more than one thread at once, so does not need to be reentrant.
2195 * - encoding: unused
2196 * - decoding: Set by libavcodec, user can override.
2198 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2201 * Called at the beginning of a frame to get cr buffer for it.
2202 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2203 * libavcodec will pass previous buffer in pic, function should return
2204 * same buffer or new buffer with old frame "painted" into it.
2205 * If pic.data[0] == NULL must behave like get_buffer().
2206 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2207 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2209 * - encoding: unused
2210 * - decoding: Set by libavcodec, user can override.
2212 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2215 /* - encoding parameters */
2216 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2217 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2221 * - encoding: Set by user.
2222 * - decoding: unused
2228 * - encoding: Set by user.
2229 * - decoding: unused
2234 * maximum quantizer difference between frames
2235 * - encoding: Set by user.
2236 * - decoding: unused
2241 * ratecontrol qmin qmax limiting method
2242 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2243 * - encoding: Set by user.
2244 * - decoding: unused
2252 * decoder bitstream buffer size
2253 * - encoding: Set by user.
2254 * - decoding: unused
2259 * ratecontrol override, see RcOverride
2260 * - encoding: Allocated/set/freed by user.
2261 * - decoding: unused
2263 int rc_override_count;
2264 RcOverride *rc_override;
2267 * rate control equation
2268 * - encoding: Set by user
2269 * - decoding: unused
2275 * - encoding: Set by user.
2276 * - decoding: unused
2282 * - encoding: Set by user.
2283 * - decoding: unused
2287 float rc_buffer_aggressivity;
2290 * initial complexity for pass1 ratecontrol
2291 * - encoding: Set by user.
2292 * - decoding: unused
2294 float rc_initial_cplx;
2297 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2298 * - encoding: Set by user.
2299 * - decoding: unused.
2301 float rc_max_available_vbv_use;
2304 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2305 * - encoding: Set by user.
2306 * - decoding: unused.
2308 float rc_min_vbv_overflow_use;
2311 * Number of bits which should be loaded into the rc buffer before decoding starts.
2312 * - encoding: Set by user.
2313 * - decoding: unused
2315 int rc_initial_buffer_occupancy;
2317 #define FF_CODER_TYPE_VLC 0
2318 #define FF_CODER_TYPE_AC 1
2319 #define FF_CODER_TYPE_RAW 2
2320 #define FF_CODER_TYPE_RLE 3
2321 #define FF_CODER_TYPE_DEFLATE 4
2324 * - encoding: Set by user.
2325 * - decoding: unused
2331 * - encoding: Set by user.
2332 * - decoding: unused
2337 * minimum Lagrange multipler
2338 * - encoding: Set by user.
2339 * - decoding: unused
2344 * maximum Lagrange multipler
2345 * - encoding: Set by user.
2346 * - decoding: unused
2351 * frame skip threshold
2352 * - encoding: Set by user.
2353 * - decoding: unused
2355 int frame_skip_threshold;
2359 * - encoding: Set by user.
2360 * - decoding: unused
2362 int frame_skip_factor;
2365 * frame skip exponent
2366 * - encoding: Set by user.
2367 * - decoding: unused
2372 * frame skip comparison function
2373 * - encoding: Set by user.
2374 * - decoding: unused
2379 * trellis RD quantization
2380 * - encoding: Set by user.
2381 * - decoding: unused
2386 * - encoding: Set by user.
2387 * - decoding: unused
2389 int min_prediction_order;
2392 * - encoding: Set by user.
2393 * - decoding: unused
2395 int max_prediction_order;
2398 * GOP timecode frame start number, in non drop frame format
2399 * - encoding: Set by user.
2400 * - decoding: unused
2402 int64_t timecode_frame_start;
2404 /* The RTP callback: This function is called */
2405 /* every time the encoder has a packet to send. */
2406 /* It depends on the encoder if the data starts */
2407 /* with a Start Code (it should). H.263 does. */
2408 /* mb_nb contains the number of macroblocks */
2409 /* encoded in the RTP payload. */
2410 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2412 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2413 /* do its best to deliver a chunk with size */
2414 /* below rtp_payload_size, the chunk will start */
2415 /* with a start code on some codecs like H.263. */
2416 /* This doesn't take account of any particular */
2417 /* headers inside the transmitted RTP payload. */
2419 /* statistics, used for 2-pass encoding */
2430 * number of bits used for the previously encoded frame
2431 * - encoding: Set by libavcodec.
2432 * - decoding: unused
2437 * pass1 encoding statistics output buffer
2438 * - encoding: Set by libavcodec.
2439 * - decoding: unused
2444 * pass2 encoding statistics input buffer
2445 * Concatenated stuff from stats_out of pass1 should be placed here.
2446 * - encoding: Allocated/set/freed by user.
2447 * - decoding: unused
2452 * Work around bugs in encoders which sometimes cannot be detected automatically.
2453 * - encoding: Set by user
2454 * - decoding: Set by user
2456 int workaround_bugs;
2457 #define FF_BUG_AUTODETECT 1 ///< autodetection
2458 #define FF_BUG_OLD_MSMPEG4 2
2459 #define FF_BUG_XVID_ILACE 4
2460 #define FF_BUG_UMP4 8
2461 #define FF_BUG_NO_PADDING 16
2462 #define FF_BUG_AMV 32
2463 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2464 #define FF_BUG_QPEL_CHROMA 64
2465 #define FF_BUG_STD_QPEL 128
2466 #define FF_BUG_QPEL_CHROMA2 256
2467 #define FF_BUG_DIRECT_BLOCKSIZE 512
2468 #define FF_BUG_EDGE 1024
2469 #define FF_BUG_HPEL_CHROMA 2048
2470 #define FF_BUG_DC_CLIP 4096
2471 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2472 #define FF_BUG_TRUNCATED 16384
2475 * strictly follow the standard (MPEG4, ...).
2476 * - encoding: Set by user.
2477 * - decoding: Set by user.
2478 * Setting this to STRICT or higher means the encoder and decoder will
2479 * generally do stupid things, whereas setting it to unofficial or lower
2480 * will mean the encoder might produce output that is not supported by all
2481 * spec-compliant decoders. Decoders don't differentiate between normal,
2482 * unofficial and experimental (that is, they always try to decode things
2483 * when they can) unless they are explicitly asked to behave stupidly
2484 * (=strictly conform to the specs)
2486 int strict_std_compliance;
2487 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2488 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2489 #define FF_COMPLIANCE_NORMAL 0
2490 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2491 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2494 * error concealment flags
2495 * - encoding: unused
2496 * - decoding: Set by user.
2498 int error_concealment;
2499 #define FF_EC_GUESS_MVS 1
2500 #define FF_EC_DEBLOCK 2
2504 * - encoding: Set by user.
2505 * - decoding: Set by user.
2508 #define FF_DEBUG_PICT_INFO 1
2509 #define FF_DEBUG_RC 2
2510 #define FF_DEBUG_BITSTREAM 4
2511 #define FF_DEBUG_MB_TYPE 8
2512 #define FF_DEBUG_QP 16
2513 #define FF_DEBUG_MV 32
2514 #define FF_DEBUG_DCT_COEFF 0x00000040
2515 #define FF_DEBUG_SKIP 0x00000080
2516 #define FF_DEBUG_STARTCODE 0x00000100
2517 #define FF_DEBUG_PTS 0x00000200
2518 #define FF_DEBUG_ER 0x00000400
2519 #define FF_DEBUG_MMCO 0x00000800
2520 #define FF_DEBUG_BUGS 0x00001000
2521 #define FF_DEBUG_VIS_QP 0x00002000
2522 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2523 #define FF_DEBUG_BUFFERS 0x00008000
2524 #define FF_DEBUG_THREADS 0x00010000
2528 * - encoding: Set by user.
2529 * - decoding: Set by user.
2532 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2533 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2534 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2537 * Error recognition; may misdetect some more or less valid parts as errors.
2538 * - encoding: unused
2539 * - decoding: Set by user.
2541 int err_recognition;
2542 #define AV_EF_CRCCHECK (1<<0)
2543 #define AV_EF_BITSTREAM (1<<1)
2544 #define AV_EF_BUFFER (1<<2)
2545 #define AV_EF_EXPLODE (1<<3)
2548 * opaque 64bit number (generally a PTS) that will be reordered and
2549 * output in AVFrame.reordered_opaque
2550 * @deprecated in favor of pkt_pts
2551 * - encoding: unused
2552 * - decoding: Set by user.
2554 int64_t reordered_opaque;
2557 * Hardware accelerator in use
2558 * - encoding: unused.
2559 * - decoding: Set by libavcodec
2561 struct AVHWAccel *hwaccel;
2564 * Hardware accelerator context.
2565 * For some hardware accelerators, a global context needs to be
2566 * provided by the user. In that case, this holds display-dependent
2567 * data Libav cannot instantiate itself. Please refer to the
2568 * Libav HW accelerator documentation to know how to fill this
2569 * is. e.g. for VA API, this is a struct vaapi_context.
2570 * - encoding: unused
2571 * - decoding: Set by user
2573 void *hwaccel_context;
2577 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2578 * - decoding: unused
2580 uint64_t error[AV_NUM_DATA_POINTERS];
2583 * DCT algorithm, see FF_DCT_* below
2584 * - encoding: Set by user.
2585 * - decoding: unused
2588 #define FF_DCT_AUTO 0
2589 #define FF_DCT_FASTINT 1
2590 #define FF_DCT_INT 2
2591 #define FF_DCT_MMX 3
2592 #define FF_DCT_ALTIVEC 5
2593 #define FF_DCT_FAAN 6
2596 * IDCT algorithm, see FF_IDCT_* below.
2597 * - encoding: Set by user.
2598 * - decoding: Set by user.
2601 #define FF_IDCT_AUTO 0
2602 #define FF_IDCT_INT 1
2603 #define FF_IDCT_SIMPLE 2
2604 #define FF_IDCT_SIMPLEMMX 3
2605 #define FF_IDCT_LIBMPEG2MMX 4
2606 #define FF_IDCT_MMI 5
2607 #define FF_IDCT_ARM 7
2608 #define FF_IDCT_ALTIVEC 8
2609 #define FF_IDCT_SH4 9
2610 #define FF_IDCT_SIMPLEARM 10
2611 #define FF_IDCT_H264 11
2612 #define FF_IDCT_VP3 12
2613 #define FF_IDCT_IPP 13
2614 #define FF_IDCT_XVIDMMX 14
2615 #define FF_IDCT_CAVS 15
2616 #define FF_IDCT_SIMPLEARMV5TE 16
2617 #define FF_IDCT_SIMPLEARMV6 17
2618 #define FF_IDCT_SIMPLEVIS 18
2619 #define FF_IDCT_WMV2 19
2620 #define FF_IDCT_FAAN 20
2621 #define FF_IDCT_EA 21
2622 #define FF_IDCT_SIMPLENEON 22
2623 #define FF_IDCT_SIMPLEALPHA 23
2624 #define FF_IDCT_BINK 24
2629 * @deprecated use av_set_cpu_flags_mask() instead.
2631 attribute_deprecated unsigned dsp_mask;
2635 * bits per sample/pixel from the demuxer (needed for huffyuv).
2636 * - encoding: Set by libavcodec.
2637 * - decoding: Set by user.
2639 int bits_per_coded_sample;
2642 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2643 * - encoding: set by user.
2644 * - decoding: set by libavcodec.
2646 int bits_per_raw_sample;
2649 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2650 * - encoding: unused
2651 * - decoding: Set by user.
2653 attribute_deprecated int lowres;
2656 * the picture in the bitstream
2657 * - encoding: Set by libavcodec.
2658 * - decoding: Set by libavcodec.
2660 AVFrame *coded_frame;
2664 * is used to decide how many independent tasks should be passed to execute()
2665 * - encoding: Set by user.
2666 * - decoding: Set by user.
2671 * Which multithreading methods to use.
2672 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2673 * so clients which cannot provide future frames should not use it.
2675 * - encoding: Set by user, otherwise the default is used.
2676 * - decoding: Set by user, otherwise the default is used.
2679 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2680 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2683 * Which multithreading methods are in use by the codec.
2684 * - encoding: Set by libavcodec.
2685 * - decoding: Set by libavcodec.
2687 int active_thread_type;
2690 * Set by the client if its custom get_buffer() callback can be called
2691 * synchronously from another thread, which allows faster multithreaded decoding.
2692 * draw_horiz_band() will be called from other threads regardless of this setting.
2693 * Ignored if the default get_buffer() is used.
2694 * - encoding: Set by user.
2695 * - decoding: Set by user.
2697 int thread_safe_callbacks;
2700 * The codec may call this to execute several independent things.
2701 * It will return only after finishing all tasks.
2702 * The user may replace this with some multithreaded implementation,
2703 * the default implementation will execute the parts serially.
2704 * @param count the number of things to execute
2705 * - encoding: Set by libavcodec, user can override.
2706 * - decoding: Set by libavcodec, user can override.
2708 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2711 * The codec may call this to execute several independent things.
2712 * It will return only after finishing all tasks.
2713 * The user may replace this with some multithreaded implementation,
2714 * the default implementation will execute the parts serially.
2715 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2716 * @param c context passed also to func
2717 * @param count the number of things to execute
2718 * @param arg2 argument passed unchanged to func
2719 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2720 * @param func function that will be called count times, with jobnr from 0 to count-1.
2721 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2722 * two instances of func executing at the same time will have the same threadnr.
2723 * @return always 0 currently, but code should handle a future improvement where when any call to func
2724 * returns < 0 no further calls to func may be done and < 0 is returned.
2725 * - encoding: Set by libavcodec, user can override.
2726 * - decoding: Set by libavcodec, user can override.
2728 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2732 * Can be used by execute() to store some per AVCodecContext stuff.
2733 * - encoding: set by execute()
2734 * - decoding: set by execute()
2736 void *thread_opaque;
2739 * noise vs. sse weight for the nsse comparsion function
2740 * - encoding: Set by user.
2741 * - decoding: unused
2747 * - encoding: Set by user.
2748 * - decoding: Set by libavcodec.
2751 #define FF_PROFILE_UNKNOWN -99
2752 #define FF_PROFILE_RESERVED -100
2754 #define FF_PROFILE_AAC_MAIN 0
2755 #define FF_PROFILE_AAC_LOW 1
2756 #define FF_PROFILE_AAC_SSR 2
2757 #define FF_PROFILE_AAC_LTP 3
2758 #define FF_PROFILE_AAC_HE 4
2759 #define FF_PROFILE_AAC_HE_V2 28
2760 #define FF_PROFILE_AAC_LD 22
2761 #define FF_PROFILE_AAC_ELD 38
2763 #define FF_PROFILE_DTS 20
2764 #define FF_PROFILE_DTS_ES 30
2765 #define FF_PROFILE_DTS_96_24 40
2766 #define FF_PROFILE_DTS_HD_HRA 50
2767 #define FF_PROFILE_DTS_HD_MA 60
2769 #define FF_PROFILE_MPEG2_422 0
2770 #define FF_PROFILE_MPEG2_HIGH 1
2771 #define FF_PROFILE_MPEG2_SS 2
2772 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2773 #define FF_PROFILE_MPEG2_MAIN 4
2774 #define FF_PROFILE_MPEG2_SIMPLE 5
2776 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2777 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2779 #define FF_PROFILE_H264_BASELINE 66
2780 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2781 #define FF_PROFILE_H264_MAIN 77
2782 #define FF_PROFILE_H264_EXTENDED 88
2783 #define FF_PROFILE_H264_HIGH 100
2784 #define FF_PROFILE_H264_HIGH_10 110
2785 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2786 #define FF_PROFILE_H264_HIGH_422 122
2787 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2788 #define FF_PROFILE_H264_HIGH_444 144
2789 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2790 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2791 #define FF_PROFILE_H264_CAVLC_444 44
2793 #define FF_PROFILE_VC1_SIMPLE 0
2794 #define FF_PROFILE_VC1_MAIN 1
2795 #define FF_PROFILE_VC1_COMPLEX 2
2796 #define FF_PROFILE_VC1_ADVANCED 3
2798 #define FF_PROFILE_MPEG4_SIMPLE 0
2799 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2800 #define FF_PROFILE_MPEG4_CORE 2
2801 #define FF_PROFILE_MPEG4_MAIN 3
2802 #define FF_PROFILE_MPEG4_N_BIT 4
2803 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2804 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2805 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2806 #define FF_PROFILE_MPEG4_HYBRID 8
2807 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2808 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2809 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2810 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2811 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2812 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2813 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2817 * - encoding: Set by user.
2818 * - decoding: Set by libavcodec.
2821 #define FF_LEVEL_UNKNOWN -99
2825 * - encoding: unused
2826 * - decoding: Set by user.
2828 enum AVDiscard skip_loop_filter;
2832 * - encoding: unused
2833 * - decoding: Set by user.
2835 enum AVDiscard skip_idct;
2839 * - encoding: unused
2840 * - decoding: Set by user.
2842 enum AVDiscard skip_frame;
2845 * Header containing style information for text subtitles.
2846 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2847 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2848 * the Format line following. It shouldn't include any Dialogue line.
2849 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2850 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2852 uint8_t *subtitle_header;
2853 int subtitle_header_size;
2856 * Simulates errors in the bitstream to test error concealment.
2857 * - encoding: Set by user.
2858 * - decoding: unused
2863 * Current packet as passed into the decoder, to avoid having
2864 * to pass the packet into every function. Currently only valid
2865 * inside lavc and get/release_buffer callbacks.
2866 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2867 * - encoding: unused
2872 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2873 * Used for compliant TS muxing.
2874 * - encoding: Set by libavcodec.
2875 * - decoding: unused.
2883 typedef struct AVProfile {
2885 const char *name; ///< short name for the profile
2888 typedef struct AVCodecDefault AVCodecDefault;
2893 typedef struct AVCodec {
2895 * Name of the codec implementation.
2896 * The name is globally unique among encoders and among decoders (but an
2897 * encoder and a decoder can share the same name).
2898 * This is the primary way to find a codec from the user perspective.
2902 * Descriptive name for the codec, meant to be more human readable than name.
2903 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2905 const char *long_name;
2906 enum AVMediaType type;
2909 * Codec capabilities.
2913 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2914 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2915 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2916 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2917 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2918 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2919 const AVClass *priv_class; ///< AVClass for the private context
2920 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2922 /*****************************************************************
2923 * No fields below this line are part of the public API. They
2924 * may not be used outside of libavcodec and can be changed and
2926 * New public fields should be added right above.
2927 *****************************************************************
2930 struct AVCodec *next;
2932 * @name Frame-level threading support functions
2936 * If defined, called on thread contexts when they are created.
2937 * If the codec allocates writable tables in init(), re-allocate them here.
2938 * priv_data will be set to a copy of the original.
2940 int (*init_thread_copy)(AVCodecContext *);
2942 * Copy necessary context variables from a previous thread context to the current one.
2943 * If not defined, the next thread will start automatically; otherwise, the codec
2944 * must call ff_thread_finish_setup().
2946 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2948 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2952 * Private codec-specific defaults.
2954 const AVCodecDefault *defaults;
2957 * Initialize codec static data, called from avcodec_register().
2959 void (*init_static_data)(struct AVCodec *codec);
2961 int (*init)(AVCodecContext *);
2962 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2964 * Encode data to an AVPacket.
2966 * @param avctx codec context
2967 * @param avpkt output AVPacket (may contain a user-provided buffer)
2968 * @param[in] frame AVFrame containing the raw data to be encoded
2969 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2970 * non-empty packet was returned in avpkt.
2971 * @return 0 on success, negative error code on failure
2973 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2974 int *got_packet_ptr);
2975 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2976 int (*close)(AVCodecContext *);
2979 * Will be called when seeking
2981 void (*flush)(AVCodecContext *);
2987 typedef struct AVHWAccel {
2989 * Name of the hardware accelerated codec.
2990 * The name is globally unique among encoders and among decoders (but an
2991 * encoder and a decoder can share the same name).
2996 * Type of codec implemented by the hardware accelerator.
2998 * See AVMEDIA_TYPE_xxx
3000 enum AVMediaType type;
3003 * Codec implemented by the hardware accelerator.
3005 * See AV_CODEC_ID_xxx
3010 * Supported pixel format.
3012 * Only hardware accelerated formats are supported here.
3014 enum PixelFormat pix_fmt;
3017 * Hardware accelerated codec capabilities.
3018 * see FF_HWACCEL_CODEC_CAP_*
3022 struct AVHWAccel *next;
3025 * Called at the beginning of each frame or field picture.
3027 * Meaningful frame information (codec specific) is guaranteed to
3028 * be parsed at this point. This function is mandatory.
3030 * Note that buf can be NULL along with buf_size set to 0.
3031 * Otherwise, this means the whole frame is available at this point.
3033 * @param avctx the codec context
3034 * @param buf the frame data buffer base
3035 * @param buf_size the size of the frame in bytes
3036 * @return zero if successful, a negative value otherwise
3038 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3041 * Callback for each slice.
3043 * Meaningful slice information (codec specific) is guaranteed to
3044 * be parsed at this point. This function is mandatory.
3046 * @param avctx the codec context
3047 * @param buf the slice data buffer base
3048 * @param buf_size the size of the slice in bytes
3049 * @return zero if successful, a negative value otherwise
3051 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3054 * Called at the end of each frame or field picture.
3056 * The whole picture is parsed at this point and can now be sent
3057 * to the hardware accelerator. This function is mandatory.
3059 * @param avctx the codec context
3060 * @return zero if successful, a negative value otherwise
3062 int (*end_frame)(AVCodecContext *avctx);
3065 * Size of HW accelerator private data.
3067 * Private data is allocated with av_mallocz() before
3068 * AVCodecContext.get_buffer() and deallocated after
3069 * AVCodecContext.release_buffer().
3075 * @defgroup lavc_picture AVPicture
3077 * Functions for working with AVPicture
3082 * four components are given, that's all.
3083 * the last component is alpha
3085 typedef struct AVPicture {
3086 uint8_t *data[AV_NUM_DATA_POINTERS];
3087 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3094 #define AVPALETTE_SIZE 1024
3095 #define AVPALETTE_COUNT 256
3097 enum AVSubtitleType {
3100 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3103 * Plain text, the text field must be set by the decoder and is
3104 * authoritative. ass and pict fields may contain approximations.
3109 * Formatted text, the ass field must be set by the decoder and is
3110 * authoritative. pict and text fields may contain approximations.
3115 typedef struct AVSubtitleRect {
3116 int x; ///< top left corner of pict, undefined when pict is not set
3117 int y; ///< top left corner of pict, undefined when pict is not set
3118 int w; ///< width of pict, undefined when pict is not set
3119 int h; ///< height of pict, undefined when pict is not set
3120 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3123 * data+linesize for the bitmap of this subtitle.
3124 * can be set for text/ass as well once they where rendered
3127 enum AVSubtitleType type;
3129 char *text; ///< 0 terminated plain UTF-8 text
3132 * 0 terminated ASS/SSA compatible event line.
3133 * The pressentation of this is unaffected by the other values in this
3139 typedef struct AVSubtitle {
3140 uint16_t format; /* 0 = graphics */
3141 uint32_t start_display_time; /* relative to packet pts, in ms */
3142 uint32_t end_display_time; /* relative to packet pts, in ms */
3144 AVSubtitleRect **rects;
3145 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3149 * If c is NULL, returns the first registered codec,
3150 * if c is non-NULL, returns the next registered codec after c,
3151 * or NULL if c is the last one.
3153 AVCodec *av_codec_next(const AVCodec *c);
3156 * Return the LIBAVCODEC_VERSION_INT constant.
3158 unsigned avcodec_version(void);
3161 * Return the libavcodec build-time configuration.
3163 const char *avcodec_configuration(void);
3166 * Return the libavcodec license.
3168 const char *avcodec_license(void);
3171 * Register the codec codec and initialize libavcodec.
3173 * @warning either this function or avcodec_register_all() must be called
3174 * before any other libavcodec functions.
3176 * @see avcodec_register_all()
3178 void avcodec_register(AVCodec *codec);
3181 * Register all the codecs, parsers and bitstream filters which were enabled at
3182 * configuration time. If you do not call this function you can select exactly
3183 * which formats you want to support, by using the individual registration
3186 * @see avcodec_register
3187 * @see av_register_codec_parser
3188 * @see av_register_bitstream_filter
3190 void avcodec_register_all(void);
3193 * Allocate an AVCodecContext and set its fields to default values. The
3194 * resulting struct can be deallocated by calling avcodec_close() on it followed
3197 * @param codec if non-NULL, allocate private data and initialize defaults
3198 * for the given codec. It is illegal to then call avcodec_open2()
3199 * with a different codec.
3200 * If NULL, then the codec-specific defaults won't be initialized,
3201 * which may result in suboptimal default settings (this is
3202 * important mainly for encoders, e.g. libx264).
3204 * @return An AVCodecContext filled with default values or NULL on failure.
3205 * @see avcodec_get_context_defaults
3207 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3210 * Set the fields of the given AVCodecContext to default values corresponding
3211 * to the given codec (defaults may be codec-dependent).
3213 * Do not call this function if a non-NULL codec has been passed
3214 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3215 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3216 * different codec on this AVCodecContext.
3218 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3221 * Get the AVClass for AVCodecContext. It can be used in combination with
3222 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3224 * @see av_opt_find().
3226 const AVClass *avcodec_get_class(void);
3229 * Copy the settings of the source AVCodecContext into the destination
3230 * AVCodecContext. The resulting destination codec context will be
3231 * unopened, i.e. you are required to call avcodec_open2() before you
3232 * can use this AVCodecContext to decode/encode video/audio data.
3234 * @param dest target codec context, should be initialized with
3235 * avcodec_alloc_context3(), but otherwise uninitialized
3236 * @param src source codec context
3237 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3239 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3242 * Allocate an AVFrame and set its fields to default values. The resulting
3243 * struct can be deallocated by simply calling av_free().
3245 * @return An AVFrame filled with default values or NULL on failure.
3246 * @see avcodec_get_frame_defaults
3248 AVFrame *avcodec_alloc_frame(void);
3251 * Set the fields of the given AVFrame to default values.
3253 * @param pic The AVFrame of which the fields should be set to default values.
3255 void avcodec_get_frame_defaults(AVFrame *pic);
3258 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3259 * function the context has to be allocated with avcodec_alloc_context3().
3261 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3262 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3263 * retrieving a codec.
3265 * @warning This function is not thread safe!
3268 * avcodec_register_all();
3269 * av_dict_set(&opts, "b", "2.5M", 0);
3270 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3274 * context = avcodec_alloc_context3(codec);
3276 * if (avcodec_open2(context, codec, opts) < 0)
3280 * @param avctx The context to initialize.
3281 * @param codec The codec to open this context for. If a non-NULL codec has been
3282 * previously passed to avcodec_alloc_context3() or
3283 * avcodec_get_context_defaults3() for this context, then this
3284 * parameter MUST be either NULL or equal to the previously passed
3286 * @param options A dictionary filled with AVCodecContext and codec-private options.
3287 * On return this object will be filled with options that were not found.
3289 * @return zero on success, a negative value on error
3290 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3291 * av_dict_set(), av_opt_find().
3293 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3296 * Close a given AVCodecContext and free all the data associated with it
3297 * (but not the AVCodecContext itself).
3299 * Calling this function on an AVCodecContext that hasn't been opened will free
3300 * the codec-specific data allocated in avcodec_alloc_context3() /
3301 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3304 int avcodec_close(AVCodecContext *avctx);
3307 * Free all allocated data in the given subtitle struct.
3309 * @param sub AVSubtitle to free.
3311 void avsubtitle_free(AVSubtitle *sub);
3318 * @addtogroup lavc_packet
3323 * @deprecated use NULL instead
3325 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3328 * Default packet destructor.
3330 void av_destruct_packet(AVPacket *pkt);
3333 * Initialize optional fields of a packet with default values.
3335 * Note, this does not touch the data and size members, which have to be
3336 * initialized separately.
3340 void av_init_packet(AVPacket *pkt);
3343 * Allocate the payload of a packet and initialize its fields with
3347 * @param size wanted payload size
3348 * @return 0 if OK, AVERROR_xxx otherwise
3350 int av_new_packet(AVPacket *pkt, int size);
3353 * Reduce packet size, correctly zeroing padding
3356 * @param size new size
3358 void av_shrink_packet(AVPacket *pkt, int size);
3361 * Increase packet size, correctly zeroing padding
3364 * @param grow_by number of bytes by which to increase the size of the packet
3366 int av_grow_packet(AVPacket *pkt, int grow_by);
3369 * @warning This is a hack - the packet memory allocation stuff is broken. The
3370 * packet is allocated if it was not really allocated.
3372 int av_dup_packet(AVPacket *pkt);
3377 * @param pkt packet to free
3379 void av_free_packet(AVPacket *pkt);
3382 * Allocate new information of a packet.
3385 * @param type side information type
3386 * @param size side information size
3387 * @return pointer to fresh allocated data or NULL otherwise
3389 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3393 * Shrink the already allocated side data buffer
3396 * @param type side information type
3397 * @param size new side information size
3398 * @return 0 on success, < 0 on failure
3400 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3404 * Get side information from packet.
3407 * @param type desired side information type
3408 * @param size pointer for side information size to store (optional)
3409 * @return pointer to data if present or NULL otherwise
3411 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3419 * @addtogroup lavc_decoding
3424 * Find a registered decoder with a matching codec ID.
3426 * @param id AVCodecID of the requested decoder
3427 * @return A decoder if one was found, NULL otherwise.
3429 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3432 * Find a registered decoder with the specified name.
3434 * @param name name of the requested decoder
3435 * @return A decoder if one was found, NULL otherwise.
3437 AVCodec *avcodec_find_decoder_by_name(const char *name);
3439 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3440 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3441 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3444 * Return the amount of padding in pixels which the get_buffer callback must
3445 * provide around the edge of the image for codecs which do not have the
3446 * CODEC_FLAG_EMU_EDGE flag.
3448 * @return Required padding in pixels.
3450 unsigned avcodec_get_edge_width(void);
3453 * Modify width and height values so that they will result in a memory
3454 * buffer that is acceptable for the codec if you do not use any horizontal
3457 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3458 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3459 * according to avcodec_get_edge_width() before.
3461 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3464 * Modify width and height values so that they will result in a memory
3465 * buffer that is acceptable for the codec if you also ensure that all
3466 * line sizes are a multiple of the respective linesize_align[i].
3468 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3469 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3470 * according to avcodec_get_edge_width() before.
3472 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3473 int linesize_align[AV_NUM_DATA_POINTERS]);
3475 #if FF_API_OLD_DECODE_AUDIO
3477 * Wrapper function which calls avcodec_decode_audio4.
3479 * @deprecated Use avcodec_decode_audio4 instead.
3481 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3482 * Some decoders may support multiple frames in a single AVPacket, such
3483 * decoders would then just decode the first frame. In this case,
3484 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3485 * the remaining data in order to decode the second frame etc.
3487 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3488 * decompressed frame size in bytes.
3490 * @warning You must set frame_size_ptr to the allocated size of the
3491 * output buffer before calling avcodec_decode_audio3().
3493 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3494 * the actual read bytes because some optimized bitstream readers read 32 or 64
3495 * bits at once and could read over the end.
3497 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3498 * no overreading happens for damaged MPEG streams.
3500 * @warning You must not provide a custom get_buffer() when using
3501 * avcodec_decode_audio3(). Doing so will override it with
3502 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3503 * which does allow the application to provide a custom get_buffer().
3505 * @note You might have to align the input buffer avpkt->data and output buffer
3506 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3507 * necessary at all, on others it won't work at all if not aligned and on others
3508 * it will work but it will have an impact on performance.
3510 * In practice, avpkt->data should have 4 byte alignment at minimum and
3511 * samples should be 16 byte aligned unless the CPU doesn't need it
3512 * (AltiVec and SSE do).
3514 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3515 * between input and output, these need to be fed with avpkt->data=NULL,
3516 * avpkt->size=0 at the end to return the remaining frames.
3518 * @param avctx the codec context
3519 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3520 * If the sample format is planar, each channel plane will
3521 * be the same size, with no padding between channels.
3522 * @param[in,out] frame_size_ptr the output buffer size in bytes
3523 * @param[in] avpkt The input AVPacket containing the input buffer.
3524 * You can create such packet with av_init_packet() and by then setting
3525 * data and size, some decoders might in addition need other fields.
3526 * All decoders are designed to use the least fields possible though.
3527 * @return On error a negative value is returned, otherwise the number of bytes
3528 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3530 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3531 int *frame_size_ptr,
3536 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3538 * Some decoders may support multiple frames in a single AVPacket. Such
3539 * decoders would then just decode the first frame. In this case,
3540 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3541 * the remaining data in order to decode the second frame, etc...
3542 * Even if no frames are returned, the packet needs to be fed to the decoder
3543 * with remaining data until it is completely consumed or an error occurs.
3545 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3546 * larger than the actual read bytes because some optimized bitstream
3547 * readers read 32 or 64 bits at once and could read over the end.
3549 * @note You might have to align the input buffer. The alignment requirements
3550 * depend on the CPU and the decoder.
3552 * @param avctx the codec context
3553 * @param[out] frame The AVFrame in which to store decoded audio samples.
3554 * Decoders request a buffer of a particular size by setting
3555 * AVFrame.nb_samples prior to calling get_buffer(). The
3556 * decoder may, however, only utilize part of the buffer by
3557 * setting AVFrame.nb_samples to a smaller value in the
3559 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3561 * @param[in] avpkt The input AVPacket containing the input buffer.
3562 * At least avpkt->data and avpkt->size should be set. Some
3563 * decoders might also require additional fields to be set.
3564 * @return A negative error code is returned if an error occurred during
3565 * decoding, otherwise the number of bytes consumed from the input
3566 * AVPacket is returned.
3568 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3569 int *got_frame_ptr, AVPacket *avpkt);
3572 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3573 * Some decoders may support multiple frames in a single AVPacket, such
3574 * decoders would then just decode the first frame.
3576 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3577 * the actual read bytes because some optimized bitstream readers read 32 or 64
3578 * bits at once and could read over the end.
3580 * @warning The end of the input buffer buf should be set to 0 to ensure that
3581 * no overreading happens for damaged MPEG streams.
3583 * @note You might have to align the input buffer avpkt->data.
3584 * The alignment requirements depend on the CPU: on some CPUs it isn't
3585 * necessary at all, on others it won't work at all if not aligned and on others
3586 * it will work but it will have an impact on performance.
3588 * In practice, avpkt->data should have 4 byte alignment at minimum.
3590 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3591 * between input and output, these need to be fed with avpkt->data=NULL,
3592 * avpkt->size=0 at the end to return the remaining frames.
3594 * @param avctx the codec context
3595 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3596 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3597 * allocate memory for the actual bitmap.
3598 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3599 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3600 * decodes and the decoder tells the user once it does not need the data anymore,
3601 * the user app can at this point free/reuse/keep the memory as it sees fit.
3603 * @param[in] avpkt The input AVpacket containing the input buffer.
3604 * You can create such packet with av_init_packet() and by then setting
3605 * data and size, some decoders might in addition need other fields like
3606 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3608 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3609 * @return On error a negative value is returned, otherwise the number of bytes
3610 * used or zero if no frame could be decompressed.
3612 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3613 int *got_picture_ptr,
3617 * Decode a subtitle message.
3618 * Return a negative value on error, otherwise return the number of bytes used.
3619 * If no subtitle could be decompressed, got_sub_ptr is zero.
3620 * Otherwise, the subtitle is stored in *sub.
3621 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3622 * simplicity, because the performance difference is expect to be negligible
3623 * and reusing a get_buffer written for video codecs would probably perform badly
3624 * due to a potentially very different allocation pattern.
3626 * @param avctx the codec context
3627 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3628 freed with avsubtitle_free if *got_sub_ptr is set.
3629 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3630 * @param[in] avpkt The input AVPacket containing the input buffer.
3632 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3637 * @defgroup lavc_parsing Frame parsing
3641 typedef struct AVCodecParserContext {
3643 struct AVCodecParser *parser;
3644 int64_t frame_offset; /* offset of the current frame */
3645 int64_t cur_offset; /* current offset
3646 (incremented by each av_parser_parse()) */
3647 int64_t next_frame_offset; /* offset of the next frame */
3649 int pict_type; /* XXX: Put it back in AVCodecContext. */
3651 * This field is used for proper frame duration computation in lavf.
3652 * It signals, how much longer the frame duration of the current frame
3653 * is compared to normal frame duration.
3655 * frame_duration = (1 + repeat_pict) * time_base
3657 * It is used by codecs like H.264 to display telecined material.
3659 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3660 int64_t pts; /* pts of the current frame */
3661 int64_t dts; /* dts of the current frame */
3666 int fetch_timestamp;
3668 #define AV_PARSER_PTS_NB 4
3669 int cur_frame_start_index;
3670 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3671 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3672 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3675 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3676 #define PARSER_FLAG_ONCE 0x0002
3677 /// Set if the parser has a valid file offset
3678 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3680 int64_t offset; ///< byte offset from starting packet start
3681 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3684 * Set by parser to 1 for key frames and 0 for non-key frames.
3685 * It is initialized to -1, so if the parser doesn't set this flag,
3686 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3692 * Time difference in stream time base units from the pts of this
3693 * packet to the point at which the output from the decoder has converged
3694 * independent from the availability of previous frames. That is, the
3695 * frames are virtually identical no matter if decoding started from
3696 * the very first frame or from this keyframe.
3697 * Is AV_NOPTS_VALUE if unknown.
3698 * This field is not the display duration of the current frame.
3699 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3702 * The purpose of this field is to allow seeking in streams that have no
3703 * keyframes in the conventional sense. It corresponds to the
3704 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3705 * essential for some types of subtitle streams to ensure that all
3706 * subtitles are correctly displayed after seeking.
3708 int64_t convergence_duration;
3710 // Timestamp generation support:
3712 * Synchronization point for start of timestamp generation.
3714 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3717 * For example, this corresponds to presence of H.264 buffering period
3723 * Offset of the current timestamp against last timestamp sync point in
3724 * units of AVCodecContext.time_base.
3726 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3727 * contain a valid timestamp offset.
3729 * Note that the timestamp of sync point has usually a nonzero
3730 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3731 * the next frame after timestamp sync point will be usually 1.
3733 * For example, this corresponds to H.264 cpb_removal_delay.
3735 int dts_ref_dts_delta;
3738 * Presentation delay of current frame in units of AVCodecContext.time_base.
3740 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3741 * contain valid non-negative timestamp delta (presentation time of a frame
3742 * must not lie in the past).
3744 * This delay represents the difference between decoding and presentation
3745 * time of the frame.
3747 * For example, this corresponds to H.264 dpb_output_delay.
3752 * Position of the packet in file.
3754 * Analogous to cur_frame_pts/dts
3756 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3759 * Byte position of currently parsed frame in stream.
3764 * Previous frame byte position.
3769 * Duration of the current frame.
3770 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3771 * For all other types, this is in units of AVCodecContext.time_base.
3774 } AVCodecParserContext;
3776 typedef struct AVCodecParser {
3777 int codec_ids[5]; /* several codec IDs are permitted */
3779 int (*parser_init)(AVCodecParserContext *s);
3780 int (*parser_parse)(AVCodecParserContext *s,
3781 AVCodecContext *avctx,
3782 const uint8_t **poutbuf, int *poutbuf_size,
3783 const uint8_t *buf, int buf_size);
3784 void (*parser_close)(AVCodecParserContext *s);
3785 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3786 struct AVCodecParser *next;
3789 AVCodecParser *av_parser_next(AVCodecParser *c);
3791 void av_register_codec_parser(AVCodecParser *parser);
3792 AVCodecParserContext *av_parser_init(int codec_id);
3797 * @param s parser context.
3798 * @param avctx codec context.
3799 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3800 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3801 * @param buf input buffer.
3802 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3803 * @param pts input presentation timestamp.
3804 * @param dts input decoding timestamp.
3805 * @param pos input byte position in stream.
3806 * @return the number of bytes of the input bitstream used.
3811 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3818 * decode_frame(data, size);
3822 int av_parser_parse2(AVCodecParserContext *s,
3823 AVCodecContext *avctx,
3824 uint8_t **poutbuf, int *poutbuf_size,
3825 const uint8_t *buf, int buf_size,
3826 int64_t pts, int64_t dts,
3829 int av_parser_change(AVCodecParserContext *s,
3830 AVCodecContext *avctx,
3831 uint8_t **poutbuf, int *poutbuf_size,
3832 const uint8_t *buf, int buf_size, int keyframe);
3833 void av_parser_close(AVCodecParserContext *s);
3841 * @addtogroup lavc_encoding
3846 * Find a registered encoder with a matching codec ID.
3848 * @param id AVCodecID of the requested encoder
3849 * @return An encoder if one was found, NULL otherwise.
3851 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3854 * Find a registered encoder with the specified name.
3856 * @param name name of the requested encoder
3857 * @return An encoder if one was found, NULL otherwise.
3859 AVCodec *avcodec_find_encoder_by_name(const char *name);
3861 #if FF_API_OLD_ENCODE_AUDIO
3863 * Encode an audio frame from samples into buf.
3865 * @deprecated Use avcodec_encode_audio2 instead.
3867 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3868 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3869 * will know how much space is needed because it depends on the value passed
3870 * in buf_size as described below. In that case a lower value can be used.
3872 * @param avctx the codec context
3873 * @param[out] buf the output buffer
3874 * @param[in] buf_size the output buffer size
3875 * @param[in] samples the input buffer containing the samples
3876 * The number of samples read from this buffer is frame_size*channels,
3877 * both of which are defined in avctx.
3878 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3879 * samples read from samples is equal to:
3880 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3881 * This also implies that av_get_bits_per_sample() must not return 0 for these
3883 * @return On error a negative value is returned, on success zero or the number
3884 * of bytes used to encode the data read from the input buffer.
3886 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3887 uint8_t *buf, int buf_size,
3888 const short *samples);
3892 * Encode a frame of audio.
3894 * Takes input samples from frame and writes the next output packet, if
3895 * available, to avpkt. The output packet does not necessarily contain data for
3896 * the most recent frame, as encoders can delay, split, and combine input frames
3897 * internally as needed.
3899 * @param avctx codec context
3900 * @param avpkt output AVPacket.
3901 * The user can supply an output buffer by setting
3902 * avpkt->data and avpkt->size prior to calling the
3903 * function, but if the size of the user-provided data is not
3904 * large enough, encoding will fail. All other AVPacket fields
3905 * will be reset by the encoder using av_init_packet(). If
3906 * avpkt->data is NULL, the encoder will allocate it.
3907 * The encoder will set avpkt->size to the size of the
3910 * If this function fails or produces no output, avpkt will be
3911 * freed using av_free_packet() (i.e. avpkt->destruct will be
3912 * called to free the user supplied buffer).
3913 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3914 * May be NULL when flushing an encoder that has the
3915 * CODEC_CAP_DELAY capability set.
3916 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3917 * can have any number of samples.
3918 * If it is not set, frame->nb_samples must be equal to
3919 * avctx->frame_size for all frames except the last.
3920 * The final frame may be smaller than avctx->frame_size.
3921 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3922 * output packet is non-empty, and to 0 if it is
3923 * empty. If the function returns an error, the
3924 * packet can be assumed to be invalid, and the
3925 * value of got_packet_ptr is undefined and should
3927 * @return 0 on success, negative error code on failure
3929 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3930 const AVFrame *frame, int *got_packet_ptr);
3932 #if FF_API_OLD_ENCODE_VIDEO
3934 * @deprecated use avcodec_encode_video2() instead.
3936 * Encode a video frame from pict into buf.
3937 * The input picture should be
3938 * stored using a specific format, namely avctx.pix_fmt.
3940 * @param avctx the codec context
3941 * @param[out] buf the output buffer for the bitstream of encoded frame
3942 * @param[in] buf_size the size of the output buffer in bytes
3943 * @param[in] pict the input picture to encode
3944 * @return On error a negative value is returned, on success zero or the number
3945 * of bytes used from the output buffer.
3947 attribute_deprecated
3948 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3949 const AVFrame *pict);
3953 * Encode a frame of video.
3955 * Takes input raw video data from frame and writes the next output packet, if
3956 * available, to avpkt. The output packet does not necessarily contain data for
3957 * the most recent frame, as encoders can delay and reorder input frames
3958 * internally as needed.
3960 * @param avctx codec context
3961 * @param avpkt output AVPacket.
3962 * The user can supply an output buffer by setting
3963 * avpkt->data and avpkt->size prior to calling the
3964 * function, but if the size of the user-provided data is not
3965 * large enough, encoding will fail. All other AVPacket fields
3966 * will be reset by the encoder using av_init_packet(). If
3967 * avpkt->data is NULL, the encoder will allocate it.
3968 * The encoder will set avpkt->size to the size of the
3969 * output packet. The returned data (if any) belongs to the
3970 * caller, he is responsible for freeing it.
3972 * If this function fails or produces no output, avpkt will be
3973 * freed using av_free_packet() (i.e. avpkt->destruct will be
3974 * called to free the user supplied buffer).
3975 * @param[in] frame AVFrame containing the raw video data to be encoded.
3976 * May be NULL when flushing an encoder that has the
3977 * CODEC_CAP_DELAY capability set.
3978 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3979 * output packet is non-empty, and to 0 if it is
3980 * empty. If the function returns an error, the
3981 * packet can be assumed to be invalid, and the
3982 * value of got_packet_ptr is undefined and should
3984 * @return 0 on success, negative error code on failure
3986 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3987 const AVFrame *frame, int *got_packet_ptr);
3989 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3990 const AVSubtitle *sub);
3998 * @defgroup lavc_resample Audio resampling
4003 struct ReSampleContext;
4004 struct AVResampleContext;
4006 typedef struct ReSampleContext ReSampleContext;
4009 * Initialize audio resampling context.
4011 * @param output_channels number of output channels
4012 * @param input_channels number of input channels
4013 * @param output_rate output sample rate
4014 * @param input_rate input sample rate
4015 * @param sample_fmt_out requested output sample format
4016 * @param sample_fmt_in input sample format
4017 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4018 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4019 * @param linear if 1 then the used FIR filter will be linearly interpolated
4020 between the 2 closest, if 0 the closest will be used
4021 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4022 * @return allocated ReSampleContext, NULL if error occurred
4024 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4025 int output_rate, int input_rate,
4026 enum AVSampleFormat sample_fmt_out,
4027 enum AVSampleFormat sample_fmt_in,
4028 int filter_length, int log2_phase_count,
4029 int linear, double cutoff);
4031 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4034 * Free resample context.
4036 * @param s a non-NULL pointer to a resample context previously
4037 * created with av_audio_resample_init()
4039 void audio_resample_close(ReSampleContext *s);
4043 * Initialize an audio resampler.
4044 * Note, if either rate is not an integer then simply scale both rates up so they are.
4045 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4046 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4047 * @param linear If 1 then the used FIR filter will be linearly interpolated
4048 between the 2 closest, if 0 the closest will be used
4049 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4051 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4054 * Resample an array of samples using a previously configured context.
4055 * @param src an array of unconsumed samples
4056 * @param consumed the number of samples of src which have been consumed are returned here
4057 * @param src_size the number of unconsumed samples available
4058 * @param dst_size the amount of space in samples available in dst
4059 * @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.
4060 * @return the number of samples written in dst or -1 if an error occurred
4062 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4066 * Compensate samplerate/timestamp drift. The compensation is done by changing
4067 * the resampler parameters, so no audible clicks or similar distortions occur
4068 * @param compensation_distance distance in output samples over which the compensation should be performed
4069 * @param sample_delta number of output samples which should be output less
4071 * example: av_resample_compensate(c, 10, 500)
4072 * here instead of 510 samples only 500 samples would be output
4074 * note, due to rounding the actual compensation might be slightly different,
4075 * especially if the compensation_distance is large and the in_rate used during init is small
4077 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4078 void av_resample_close(struct AVResampleContext *c);
4085 * @addtogroup lavc_picture
4090 * Allocate memory for a picture. Call avpicture_free() to free it.
4092 * @see avpicture_fill()
4094 * @param picture the picture to be filled in
4095 * @param pix_fmt the format of the picture
4096 * @param width the width of the picture
4097 * @param height the height of the picture
4098 * @return zero if successful, a negative value if not
4100 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
4103 * Free a picture previously allocated by avpicture_alloc().
4104 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4107 * @param picture the AVPicture to be freed
4109 void avpicture_free(AVPicture *picture);
4112 * Fill in the AVPicture fields.
4113 * The fields of the given AVPicture are filled in by using the 'ptr' address
4114 * which points to the image data buffer. Depending on the specified picture
4115 * format, one or multiple image data pointers and line sizes will be set.
4116 * If a planar format is specified, several pointers will be set pointing to
4117 * the different picture planes and the line sizes of the different planes
4118 * will be stored in the lines_sizes array.
4119 * Call with ptr == NULL to get the required size for the ptr buffer.
4121 * To allocate the buffer and fill in the AVPicture fields in one call,
4122 * use avpicture_alloc().
4124 * @param picture AVPicture whose fields are to be filled in
4125 * @param ptr Buffer which will contain or contains the actual image data
4126 * @param pix_fmt The format in which the picture data is stored.
4127 * @param width the width of the image in pixels
4128 * @param height the height of the image in pixels
4129 * @return size of the image data in bytes
4131 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4132 enum PixelFormat pix_fmt, int width, int height);
4135 * Copy pixel data from an AVPicture into a buffer.
4136 * The data is stored compactly, without any gaps for alignment or padding
4137 * which may be applied by avpicture_fill().
4139 * @see avpicture_get_size()
4141 * @param[in] src AVPicture containing image data
4142 * @param[in] pix_fmt The format in which the picture data is stored.
4143 * @param[in] width the width of the image in pixels.
4144 * @param[in] height the height of the image in pixels.
4145 * @param[out] dest A buffer into which picture data will be copied.
4146 * @param[in] dest_size The size of 'dest'.
4147 * @return The number of bytes written to dest, or a negative value (error code) on error.
4149 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
4150 unsigned char *dest, int dest_size);
4153 * Calculate the size in bytes that a picture of the given width and height
4154 * would occupy if stored in the given picture format.
4155 * Note that this returns the size of a compact representation as generated
4156 * by avpicture_layout(), which can be smaller than the size required for e.g.
4159 * @param pix_fmt the given picture format
4160 * @param width the width of the image
4161 * @param height the height of the image
4162 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
4164 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
4167 * deinterlace - if not supported return -1
4169 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4170 enum PixelFormat pix_fmt, int width, int height);
4172 * Copy image src to dst. Wraps av_picture_data_copy() above.
4174 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4175 enum PixelFormat pix_fmt, int width, int height);
4178 * Crop image top and left side.
4180 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4181 enum PixelFormat pix_fmt, int top_band, int left_band);
4186 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4187 int padtop, int padbottom, int padleft, int padright, int *color);
4194 * @defgroup lavc_misc Utility functions
4197 * Miscellaneous utility functions related to both encoding and decoding
4203 * @defgroup lavc_misc_pixfmt Pixel formats
4205 * Functions for working with pixel formats.
4209 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
4212 * Return a value representing the fourCC code associated to the
4213 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4216 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
4218 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4219 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4220 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4221 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4222 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4223 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4226 * Compute what kind of losses will occur when converting from one specific
4227 * pixel format to another.
4228 * When converting from one pixel format to another, information loss may occur.
4229 * For example, when converting from RGB24 to GRAY, the color information will
4230 * be lost. Similarly, other losses occur when converting from some formats to
4231 * other formats. These losses can involve loss of chroma, but also loss of
4232 * resolution, loss of color depth, loss due to the color space conversion, loss
4233 * of the alpha bits or loss due to color quantization.
4234 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4235 * which will occur when converting from one pixel format to another.
4237 * @param[in] dst_pix_fmt destination pixel format
4238 * @param[in] src_pix_fmt source pixel format
4239 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4240 * @return Combination of flags informing you what kind of losses will occur.
4242 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
4245 #if FF_API_FIND_BEST_PIX_FMT
4247 * @deprecated use avcodec_find_best_pix_fmt2() instead.
4249 * Find the best pixel format to convert to given a certain source pixel
4250 * format. When converting from one pixel format to another, information loss
4251 * may occur. For example, when converting from RGB24 to GRAY, the color
4252 * information will be lost. Similarly, other losses occur when converting from
4253 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4254 * the given pixel formats should be used to suffer the least amount of loss.
4255 * The pixel formats from which it chooses one, are determined by the
4256 * pix_fmt_mask parameter.
4259 * src_pix_fmt = PIX_FMT_YUV420P;
4260 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
4261 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4264 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4265 * @param[in] src_pix_fmt source pixel format
4266 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4267 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4268 * @return The best pixel format to convert to or -1 if none was found.
4270 attribute_deprecated
4271 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
4272 int has_alpha, int *loss_ptr);
4273 #endif /* FF_API_FIND_BEST_PIX_FMT */
4276 * Find the best pixel format to convert to given a certain source pixel
4277 * format. When converting from one pixel format to another, information loss
4278 * may occur. For example, when converting from RGB24 to GRAY, the color
4279 * information will be lost. Similarly, other losses occur when converting from
4280 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4281 * the given pixel formats should be used to suffer the least amount of loss.
4282 * The pixel formats from which it chooses one, are determined by the
4283 * pix_fmt_list parameter.
4286 * @param[in] pix_fmt_list PIX_FMT_NONE terminated array of pixel formats to choose from
4287 * @param[in] src_pix_fmt source pixel format
4288 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4289 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4290 * @return The best pixel format to convert to or -1 if none was found.
4292 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat *pix_fmt_list,
4293 enum PixelFormat src_pix_fmt,
4294 int has_alpha, int *loss_ptr);
4296 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4302 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4305 * Put a string representing the codec tag codec_tag in buf.
4307 * @param buf_size size in bytes of buf
4308 * @return the length of the string that would have been generated if
4309 * enough space had been available, excluding the trailing null
4311 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4313 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4316 * Return a name for the specified profile, if available.
4318 * @param codec the codec that is searched for the given profile
4319 * @param profile the profile value for which a name is requested
4320 * @return A name for the profile if found, NULL otherwise.
4322 const char *av_get_profile_name(const AVCodec *codec, int profile);
4324 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4325 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4326 //FIXME func typedef
4329 * Fill audio frame data and linesize.
4330 * AVFrame extended_data channel pointers are allocated if necessary for
4333 * @param frame the AVFrame
4334 * frame->nb_samples must be set prior to calling the
4335 * function. This function fills in frame->data,
4336 * frame->extended_data, frame->linesize[0].
4337 * @param nb_channels channel count
4338 * @param sample_fmt sample format
4339 * @param buf buffer to use for frame data
4340 * @param buf_size size of buffer
4341 * @param align plane size sample alignment (0 = default)
4342 * @return 0 on success, negative error code on failure
4344 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4345 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4346 int buf_size, int align);
4349 * Flush buffers, should be called when seeking or when switching to a different stream.
4351 void avcodec_flush_buffers(AVCodecContext *avctx);
4353 void avcodec_default_free_buffers(AVCodecContext *s);
4356 * Return codec bits per sample.
4358 * @param[in] codec_id the codec
4359 * @return Number of bits per sample or zero if unknown for the given codec.
4361 int av_get_bits_per_sample(enum AVCodecID codec_id);
4364 * Return codec bits per sample.
4365 * Only return non-zero if the bits per sample is exactly correct, not an
4368 * @param[in] codec_id the codec
4369 * @return Number of bits per sample or zero if unknown for the given codec.
4371 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4374 * Return audio frame duration.
4376 * @param avctx codec context
4377 * @param frame_bytes size of the frame, or 0 if unknown
4378 * @return frame duration, in samples, if known. 0 if not able to
4381 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4384 typedef struct AVBitStreamFilterContext {
4386 struct AVBitStreamFilter *filter;
4387 AVCodecParserContext *parser;
4388 struct AVBitStreamFilterContext *next;
4389 } AVBitStreamFilterContext;
4392 typedef struct AVBitStreamFilter {
4395 int (*filter)(AVBitStreamFilterContext *bsfc,
4396 AVCodecContext *avctx, const char *args,
4397 uint8_t **poutbuf, int *poutbuf_size,
4398 const uint8_t *buf, int buf_size, int keyframe);
4399 void (*close)(AVBitStreamFilterContext *bsfc);
4400 struct AVBitStreamFilter *next;
4401 } AVBitStreamFilter;
4403 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4404 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4405 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4406 AVCodecContext *avctx, const char *args,
4407 uint8_t **poutbuf, int *poutbuf_size,
4408 const uint8_t *buf, int buf_size, int keyframe);
4409 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4411 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4416 * Reallocate the given block if it is not large enough, otherwise do nothing.
4420 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4423 * Allocate a buffer, reusing the given one if large enough.
4425 * Contrary to av_fast_realloc the current buffer contents might not be
4426 * preserved and on error the old buffer is freed, thus no special
4427 * handling to avoid memleaks is necessary.
4429 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4430 * @param size size of the buffer *ptr points to
4431 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4432 * *size 0 if an error occurred.
4434 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4437 * Allocate a buffer with padding, reusing the given one if large enough.
4439 * Same behaviour av_fast_malloc but the buffer has additional
4440 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4443 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4446 * Encode extradata length to a buffer. Used by xiph codecs.
4448 * @param s buffer to write to; must be at least (v/255+1) bytes long
4449 * @param v size of extradata in bytes
4450 * @return number of bytes written to the buffer.
4452 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4455 * Log a generic warning message about a missing feature. This function is
4456 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4457 * only, and would normally not be used by applications.
4458 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4459 * a pointer to an AVClass struct
4460 * @param[in] feature string containing the name of the missing feature
4461 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4462 * If want_sample is non-zero, additional verbage will be added to the log
4463 * message which tells the user how to report samples to the development
4466 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4469 * Log a generic warning message asking for a sample. This function is
4470 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4471 * only, and would normally not be used by applications.
4472 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4473 * a pointer to an AVClass struct
4474 * @param[in] msg string containing an optional message, or NULL if no message
4476 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4479 * Register the hardware accelerator hwaccel.
4481 void av_register_hwaccel(AVHWAccel *hwaccel);
4484 * If hwaccel is NULL, returns the first registered hardware accelerator,
4485 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4486 * after hwaccel, or NULL if hwaccel is the last one.
4488 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4492 * Lock operation used by lockmgr
4495 AV_LOCK_CREATE, ///< Create a mutex
4496 AV_LOCK_OBTAIN, ///< Lock the mutex
4497 AV_LOCK_RELEASE, ///< Unlock the mutex
4498 AV_LOCK_DESTROY, ///< Free mutex resources
4502 * Register a user provided lock manager supporting the operations
4503 * specified by AVLockOp. mutex points to a (void *) where the
4504 * lockmgr should store/get a pointer to a user allocated mutex. It's
4505 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4507 * @param cb User defined callback. Note: Libav may invoke calls to this
4508 * callback during the call to av_lockmgr_register().
4509 * Thus, the application must be prepared to handle that.
4510 * If cb is set to NULL the lockmgr will be unregistered.
4511 * Also note that during unregistration the previously registered
4512 * lockmgr callback may also be invoked.
4514 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4517 * Get the type of the given codec.
4519 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4522 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4523 * with no corresponding avcodec_close()), 0 otherwise.
4525 int avcodec_is_open(AVCodecContext *s);
4528 * @return a non-zero number if codec is an encoder, zero otherwise
4530 int av_codec_is_encoder(const AVCodec *codec);
4533 * @return a non-zero number if codec is a decoder, zero otherwise
4535 int av_codec_is_decoder(const AVCodec *codec);
4538 * @return descriptor for given codec ID or NULL if no descriptor exists.
4540 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4543 * Iterate over all codec descriptors known to libavcodec.
4545 * @param prev previous descriptor. NULL to get the first descriptor.
4547 * @return next descriptor or NULL after the last descriptor
4549 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4552 * @return codec descriptor with the given name or NULL if no such descriptor
4555 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4561 #endif /* AVCODEC_AVCODEC_H */