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.
80 * Identify the syntax and semantics of the bitstream.
81 * The principle is roughly:
82 * Two decoders with the same ID can decode the same streams.
83 * Two encoders with the same ID can encode compatible streams.
84 * There may be slight deviations from the principle due to implementation
87 * If you add a codec ID to this list, add it so that
88 * 1. no value of a existing codec ID changes (that would break ABI),
89 * 2. it is as close as possible to similar codecs.
96 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
97 CODEC_ID_MPEG2VIDEO_XVMC,
134 CODEC_ID_INTERPLAY_VIDEO,
146 CODEC_ID_TRUEMOTION1,
173 CODEC_ID_TRUEMOTION2,
190 CODEC_ID_DSICINVIDEO,
191 CODEC_ID_TIERTEXSEQVIDEO,
199 CODEC_ID_BETHSOFTVID,
215 CODEC_ID_MOTIONPIXELS,
233 CODEC_ID_IFF_BYTERUN1,
259 /* various PCM "codecs" */
260 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
261 CODEC_ID_PCM_S16LE = 0x10000,
277 CODEC_ID_PCM_S24DAUD,
279 CODEC_ID_PCM_S16LE_PLANAR,
288 CODEC_ID_PCM_S8_PLANAR,
290 /* various ADPCM codecs */
291 CODEC_ID_ADPCM_IMA_QT = 0x11000,
292 CODEC_ID_ADPCM_IMA_WAV,
293 CODEC_ID_ADPCM_IMA_DK3,
294 CODEC_ID_ADPCM_IMA_DK4,
295 CODEC_ID_ADPCM_IMA_WS,
296 CODEC_ID_ADPCM_IMA_SMJPEG,
305 CODEC_ID_ADPCM_YAMAHA,
306 CODEC_ID_ADPCM_SBPRO_4,
307 CODEC_ID_ADPCM_SBPRO_3,
308 CODEC_ID_ADPCM_SBPRO_2,
310 CODEC_ID_ADPCM_IMA_AMV,
311 CODEC_ID_ADPCM_EA_R1,
312 CODEC_ID_ADPCM_EA_R3,
313 CODEC_ID_ADPCM_EA_R2,
314 CODEC_ID_ADPCM_IMA_EA_SEAD,
315 CODEC_ID_ADPCM_IMA_EA_EACS,
316 CODEC_ID_ADPCM_EA_XAS,
317 CODEC_ID_ADPCM_EA_MAXIS_XA,
318 CODEC_ID_ADPCM_IMA_ISS,
320 CODEC_ID_ADPCM_IMA_APC,
323 CODEC_ID_AMR_NB = 0x12000,
326 /* RealAudio codecs*/
327 CODEC_ID_RA_144 = 0x13000,
330 /* various DPCM codecs */
331 CODEC_ID_ROQ_DPCM = 0x14000,
332 CODEC_ID_INTERPLAY_DPCM,
337 CODEC_ID_MP2 = 0x15000,
338 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
354 CODEC_ID_WESTWOOD_SND1,
355 CODEC_ID_GSM, ///< as in Berlin toast format
363 CODEC_ID_DSICINAUDIO,
367 CODEC_ID_GSM_MS, /* as found in WAV */
376 CODEC_ID_WMALOSSLESS,
385 CODEC_ID_BINKAUDIO_RDFT,
386 CODEC_ID_BINKAUDIO_DCT,
397 /* subtitle codecs */
398 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
399 CODEC_ID_DVD_SUBTITLE = 0x17000,
400 CODEC_ID_DVB_SUBTITLE,
401 CODEC_ID_TEXT, ///< raw UTF-8 text
405 CODEC_ID_HDMV_PGS_SUBTITLE,
406 CODEC_ID_DVB_TELETEXT,
409 /* other specific kind of codecs (generally used for attachments) */
410 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
411 CODEC_ID_TTF = 0x18000,
413 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
415 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
416 * stream (only used by libavformat) */
417 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
418 * stream (only used by libavformat) */
419 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
422 #if FF_API_OLD_DECODE_AUDIO
424 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
428 * @ingroup lavc_decoding
429 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
430 * This is mainly needed because some optimized bitstream readers read
431 * 32 or 64 bit at once and could read over the end.<br>
432 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
433 * MPEG bitstreams could cause overread and segfault.
435 #define FF_INPUT_BUFFER_PADDING_SIZE 8
438 * @ingroup lavc_encoding
439 * minimum encoding buffer size
440 * Used to avoid some checks during header writing.
442 #define FF_MIN_BUFFER_SIZE 16384
446 * @ingroup lavc_encoding
447 * motion estimation type.
450 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
454 ME_EPZS, ///< enhanced predictive zonal search
455 ME_X1, ///< reserved for experiments
456 ME_HEX, ///< hexagon based search
457 ME_UMH, ///< uneven multi-hexagon search
458 ME_ITER, ///< iterative search
459 ME_TESA, ///< transformed exhaustive search algorithm
463 * @ingroup lavc_decoding
466 /* We leave some space between them for extensions (drop some
467 * keyframes for intra-only or drop just some bidir frames). */
468 AVDISCARD_NONE =-16, ///< discard nothing
469 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
470 AVDISCARD_NONREF = 8, ///< discard all non reference
471 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
472 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
473 AVDISCARD_ALL = 48, ///< discard all
476 enum AVColorPrimaries{
477 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
478 AVCOL_PRI_UNSPECIFIED=2,
480 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
481 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
482 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
484 AVCOL_PRI_NB , ///< Not part of ABI
487 enum AVColorTransferCharacteristic{
488 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
489 AVCOL_TRC_UNSPECIFIED=2,
490 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
491 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
492 AVCOL_TRC_NB , ///< Not part of ABI
497 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
498 AVCOL_SPC_UNSPECIFIED=2,
500 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
501 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
502 AVCOL_SPC_SMPTE240M =7,
503 AVCOL_SPC_NB , ///< Not part of ABI
507 AVCOL_RANGE_UNSPECIFIED=0,
508 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
509 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
510 AVCOL_RANGE_NB , ///< Not part of ABI
514 * X X 3 4 X X are luma samples,
515 * 1 2 1-6 are possible chroma positions
516 * X X 5 6 X 0 is undefined/unknown position
518 enum AVChromaLocation{
519 AVCHROMA_LOC_UNSPECIFIED=0,
520 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
521 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
522 AVCHROMA_LOC_TOPLEFT =3, ///< DV
524 AVCHROMA_LOC_BOTTOMLEFT =5,
525 AVCHROMA_LOC_BOTTOM =6,
526 AVCHROMA_LOC_NB , ///< Not part of ABI
529 enum AVAudioServiceType {
530 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
531 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
532 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
533 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
534 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
535 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
536 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
537 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
538 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
539 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
543 * @ingroup lavc_encoding
545 typedef struct RcOverride{
548 int qscale; // If this is 0 then quality_factor will be used instead.
549 float quality_factor;
552 #define FF_MAX_B_FRAMES 16
555 These flags can be passed in AVCodecContext.flags before initialization.
556 Note: Not everything is supported yet.
559 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
560 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
561 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
562 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
563 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
565 * The parent program guarantees that the input for B-frames containing
566 * streams is not written to for at least s->max_b_frames+1 frames, if
567 * this is not set the input will be copied.
569 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
570 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
571 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
572 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
573 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
574 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
575 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
576 location instead of only at frame boundaries. */
577 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
578 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
579 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
580 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
581 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
582 /* Fx : Flag for h263+ extra options */
583 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
584 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
585 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
586 #define CODEC_FLAG_CLOSED_GOP 0x80000000
587 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
588 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
589 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
590 #if FF_API_MPV_GLOBAL_OPTS
591 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
592 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
593 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
594 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
596 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
598 /* Unsupported options :
599 * Syntax Arithmetic coding (SAC)
600 * Reference Picture Selection
601 * Independent Segment Decoding */
603 /* codec capabilities */
605 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
607 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
608 * If not set, it might not use get_buffer() at all or use operations that
609 * assume the buffer was allocated by avcodec_default_get_buffer.
611 #define CODEC_CAP_DR1 0x0002
612 #define CODEC_CAP_TRUNCATED 0x0008
613 /* Codec can export data for HW decoding (XvMC). */
614 #define CODEC_CAP_HWACCEL 0x0010
616 * Encoder or decoder requires flushing with NULL input at the end in order to
617 * give the complete and correct output.
619 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
620 * with NULL data. The user can still send NULL data to the public encode
621 * or decode function, but libavcodec will not pass it along to the codec
622 * unless this flag is set.
625 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
626 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
630 * The encoder needs to be fed with NULL data at the end of encoding until the
631 * encoder no longer returns data.
633 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
634 * flag also means that the encoder must set the pts and duration for
635 * each output packet. If this flag is not set, the pts and duration will
636 * be determined by libavcodec from the input frame.
638 #define CODEC_CAP_DELAY 0x0020
640 * Codec can be fed a final frame with a smaller size.
641 * This can be used to prevent truncation of the last audio samples.
643 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
645 * Codec can export data for HW decoding (VDPAU).
647 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
649 * Codec can output multiple frames per AVPacket
650 * Normally demuxers return one frame at a time, demuxers which do not do
651 * are connected to a parser to split what they return into proper frames.
652 * This flag is reserved to the very rare category of codecs which have a
653 * bitstream that cannot be split into frames without timeconsuming
654 * operations like full decoding. Demuxers carring such bitstreams thus
655 * may return multiple frames in a packet. This has many disadvantages like
656 * prohibiting stream copy in many cases thus it should only be considered
659 #define CODEC_CAP_SUBFRAMES 0x0100
661 * Codec is experimental and is thus avoided in favor of non experimental
664 #define CODEC_CAP_EXPERIMENTAL 0x0200
666 * Codec should fill in channel configuration and samplerate instead of container
668 #define CODEC_CAP_CHANNEL_CONF 0x0400
670 * Codec is able to deal with negative linesizes
672 #define CODEC_CAP_NEG_LINESIZES 0x0800
674 * Codec supports frame-level multithreading.
676 #define CODEC_CAP_FRAME_THREADS 0x1000
678 * Codec supports slice-based (or partition-based) multithreading.
680 #define CODEC_CAP_SLICE_THREADS 0x2000
682 * Codec supports changed parameters at any point.
684 #define CODEC_CAP_PARAM_CHANGE 0x4000
686 * Codec supports avctx->thread_count == 0 (auto).
688 #define CODEC_CAP_AUTO_THREADS 0x8000
690 * Audio encoder supports receiving a different number of samples in each call.
692 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
694 //The following defines may change, don't expect compatibility if you use them.
695 #define MB_TYPE_INTRA4x4 0x0001
696 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
697 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
698 #define MB_TYPE_16x16 0x0008
699 #define MB_TYPE_16x8 0x0010
700 #define MB_TYPE_8x16 0x0020
701 #define MB_TYPE_8x8 0x0040
702 #define MB_TYPE_INTERLACED 0x0080
703 #define MB_TYPE_DIRECT2 0x0100 //FIXME
704 #define MB_TYPE_ACPRED 0x0200
705 #define MB_TYPE_GMC 0x0400
706 #define MB_TYPE_SKIP 0x0800
707 #define MB_TYPE_P0L0 0x1000
708 #define MB_TYPE_P1L0 0x2000
709 #define MB_TYPE_P0L1 0x4000
710 #define MB_TYPE_P1L1 0x8000
711 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
712 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
713 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
714 #define MB_TYPE_QUANT 0x00010000
715 #define MB_TYPE_CBP 0x00020000
716 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
720 * This specifies the area which should be displayed.
721 * Note there may be multiple such areas for one frame.
723 typedef struct AVPanScan{
726 * - encoding: Set by user.
727 * - decoding: Set by libavcodec.
732 * width and height in 1/16 pel
733 * - encoding: Set by user.
734 * - decoding: Set by libavcodec.
740 * position of the top left corner in 1/16 pel for up to 3 fields/frames
741 * - encoding: Set by user.
742 * - decoding: Set by libavcodec.
744 int16_t position[3][2];
747 #define FF_QSCALE_TYPE_MPEG1 0
748 #define FF_QSCALE_TYPE_MPEG2 1
749 #define FF_QSCALE_TYPE_H264 2
750 #define FF_QSCALE_TYPE_VP56 3
752 #define FF_BUFFER_TYPE_INTERNAL 1
753 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
754 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
755 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
757 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
758 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
759 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
760 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
763 * @defgroup lavc_packet AVPacket
765 * Types and functions for working with AVPacket.
768 enum AVPacketSideDataType {
770 AV_PKT_DATA_NEW_EXTRADATA,
773 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
776 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
777 * s32le channel_count
778 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
779 * u64le channel_layout
780 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
782 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
787 AV_PKT_DATA_PARAM_CHANGE,
790 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
791 * structures with info about macroblocks relevant to splitting the
792 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
793 * That is, it does not necessarily contain info about all macroblocks,
794 * as long as the distance between macroblocks in the info is smaller
795 * than the target payload size.
796 * Each MB info structure is 12 bytes, and is laid out as follows:
798 * u32le bit offset from the start of the packet
799 * u8 current quantizer at the start of the macroblock
801 * u16le macroblock address within the GOB
802 * u8 horizontal MV predictor
803 * u8 vertical MV predictor
804 * u8 horizontal MV predictor for block number 3
805 * u8 vertical MV predictor for block number 3
808 AV_PKT_DATA_H263_MB_INFO,
811 typedef struct AVPacket {
813 * Presentation timestamp in AVStream->time_base units; the time at which
814 * the decompressed packet will be presented to the user.
815 * Can be AV_NOPTS_VALUE if it is not stored in the file.
816 * pts MUST be larger or equal to dts as presentation cannot happen before
817 * decompression, unless one wants to view hex dumps. Some formats misuse
818 * the terms dts and pts/cts to mean something different. Such timestamps
819 * must be converted to true pts/dts before they are stored in AVPacket.
823 * Decompression timestamp in AVStream->time_base units; the time at which
824 * the packet is decompressed.
825 * Can be AV_NOPTS_VALUE if it is not stored in the file.
832 * A combination of AV_PKT_FLAG values
836 * Additional packet data that can be provided by the container.
837 * Packet can contain several types of side information.
842 enum AVPacketSideDataType type;
847 * Duration of this packet in AVStream->time_base units, 0 if unknown.
848 * Equals next_pts - this_pts in presentation order.
851 void (*destruct)(struct AVPacket *);
853 int64_t pos; ///< byte position in stream, -1 if unknown
856 * Time difference in AVStream->time_base units from the pts of this
857 * packet to the point at which the output from the decoder has converged
858 * independent from the availability of previous frames. That is, the
859 * frames are virtually identical no matter if decoding started from
860 * the very first frame or from this keyframe.
861 * Is AV_NOPTS_VALUE if unknown.
862 * This field is not the display duration of the current packet.
863 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
866 * The purpose of this field is to allow seeking in streams that have no
867 * keyframes in the conventional sense. It corresponds to the
868 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
869 * essential for some types of subtitle streams to ensure that all
870 * subtitles are correctly displayed after seeking.
872 int64_t convergence_duration;
874 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
875 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
877 enum AVSideDataParamChangeFlags {
878 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
879 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
880 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
881 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
889 * New fields can be added to the end of AVFRAME with minor version
890 * bumps. Removal, reordering and changes to existing fields require
891 * a major version bump.
892 * sizeof(AVFrame) must not be used outside libav*.
894 typedef struct AVFrame {
895 #define AV_NUM_DATA_POINTERS 8
897 * pointer to the picture/channel planes.
898 * This might be different from the first allocated byte
899 * - encoding: Set by user
900 * - decoding: set by AVCodecContext.get_buffer()
902 uint8_t *data[AV_NUM_DATA_POINTERS];
905 * Size, in bytes, of the data for each picture/channel plane.
907 * For audio, only linesize[0] may be set. For planar audio, each channel
908 * plane must be the same size.
910 * - encoding: Set by user
911 * - decoding: set by AVCodecContext.get_buffer()
913 int linesize[AV_NUM_DATA_POINTERS];
916 * pointers to the data planes/channels.
918 * For video, this should simply point to data[].
920 * For planar audio, each channel has a separate data pointer, and
921 * linesize[0] contains the size of each channel buffer.
922 * For packed audio, there is just one data pointer, and linesize[0]
923 * contains the total size of the buffer for all channels.
925 * Note: Both data and extended_data will always be set by get_buffer(),
926 * but for planar audio with more channels that can fit in data,
927 * extended_data must be used by the decoder in order to access all
931 * decoding: set by AVCodecContext.get_buffer()
933 uint8_t **extended_data;
936 * width and height of the video frame
938 * - decoding: Read by user.
943 * number of audio samples (per channel) described by this frame
944 * - encoding: Set by user
945 * - decoding: Set by libavcodec
950 * format of the frame, -1 if unknown or unset
951 * Values correspond to enum PixelFormat for video frames,
952 * enum AVSampleFormat for audio)
954 * - decoding: Read by user.
959 * 1 -> keyframe, 0-> not
960 * - encoding: Set by libavcodec.
961 * - decoding: Set by libavcodec.
966 * Picture type of the frame, see ?_TYPE below.
967 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
968 * - decoding: Set by libavcodec.
970 enum AVPictureType pict_type;
973 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
974 * This isn't used by libavcodec unless the default get/release_buffer() is used.
978 uint8_t *base[AV_NUM_DATA_POINTERS];
981 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
983 * - decoding: Read by user.
985 AVRational sample_aspect_ratio;
988 * presentation timestamp in time_base units (time when frame should be shown to user)
989 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
990 * - encoding: MUST be set by user.
991 * - decoding: Set by libavcodec.
996 * reordered pts from the last AVPacket that has been input into the decoder
998 * - decoding: Read by user.
1003 * dts from the last AVPacket that has been input into the decoder
1004 * - encoding: unused
1005 * - decoding: Read by user.
1010 * picture number in bitstream order
1011 * - encoding: set by
1012 * - decoding: Set by libavcodec.
1014 int coded_picture_number;
1016 * picture number in display order
1017 * - encoding: set by
1018 * - decoding: Set by libavcodec.
1020 int display_picture_number;
1023 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1024 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1025 * - decoding: Set by libavcodec.
1030 * is this picture used as reference
1031 * The values for this are the same as the MpegEncContext.picture_structure
1032 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1033 * Set to 4 for delayed, non-reference frames.
1034 * - encoding: unused
1035 * - decoding: Set by libavcodec. (before get_buffer() call)).
1041 * - encoding: unused
1042 * - decoding: Set by libavcodec.
1044 int8_t *qscale_table;
1047 * - encoding: unused
1048 * - decoding: Set by libavcodec.
1058 * mbskip_table[mb]>=1 if MB didn't change
1059 * stride= mb_width = (width+15)>>4
1060 * - encoding: unused
1061 * - decoding: Set by libavcodec.
1063 uint8_t *mbskip_table;
1066 * motion vector table
1069 * int mv_sample_log2= 4 - motion_subsample_log2;
1070 * int mb_width= (width+15)>>4;
1071 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1072 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1074 * - encoding: Set by user.
1075 * - decoding: Set by libavcodec.
1077 int16_t (*motion_val[2])[2];
1080 * macroblock type table
1081 * mb_type_base + mb_width + 2
1082 * - encoding: Set by user.
1083 * - decoding: Set by libavcodec.
1089 * - encoding: unused
1090 * - decoding: Set by libavcodec.
1095 * motion reference frame index
1096 * the order in which these are stored can depend on the codec.
1097 * - encoding: Set by user.
1098 * - decoding: Set by libavcodec.
1100 int8_t *ref_index[2];
1103 * for some private data of the user
1104 * - encoding: unused
1105 * - decoding: Set by user.
1111 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1112 * - decoding: unused
1114 uint64_t error[AV_NUM_DATA_POINTERS];
1117 * type of the buffer (to keep track of who has to deallocate data[*])
1118 * - encoding: Set by the one who allocates it.
1119 * - decoding: Set by the one who allocates it.
1120 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1125 * When decoding, this signals how much the picture must be delayed.
1126 * extra_delay = repeat_pict / (2*fps)
1127 * - encoding: unused
1128 * - decoding: Set by libavcodec.
1133 * The content of the picture is interlaced.
1134 * - encoding: Set by user.
1135 * - decoding: Set by libavcodec. (default 0)
1137 int interlaced_frame;
1140 * If the content is interlaced, is top field displayed first.
1141 * - encoding: Set by user.
1142 * - decoding: Set by libavcodec.
1144 int top_field_first;
1147 * Tell user application that palette has changed from previous frame.
1148 * - encoding: ??? (no palette-enabled encoder yet)
1149 * - decoding: Set by libavcodec. (default 0).
1151 int palette_has_changed;
1154 * codec suggestion on buffer type if != 0
1155 * - encoding: unused
1156 * - decoding: Set by libavcodec. (before get_buffer() call)).
1162 * - encoding: Set by user.
1163 * - decoding: Set by libavcodec.
1165 AVPanScan *pan_scan;
1168 * reordered opaque 64bit (generally an integer or a double precision float
1169 * PTS but can be anything).
1170 * The user sets AVCodecContext.reordered_opaque to represent the input at
1172 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1173 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1174 * @deprecated in favor of pkt_pts
1175 * - encoding: unused
1176 * - decoding: Read by user.
1178 int64_t reordered_opaque;
1181 * hardware accelerator private data (Libav-allocated)
1182 * - encoding: unused
1183 * - decoding: Set by libavcodec
1185 void *hwaccel_picture_private;
1188 * the AVCodecContext which ff_thread_get_buffer() was last called on
1189 * - encoding: Set by libavcodec.
1190 * - decoding: Set by libavcodec.
1192 struct AVCodecContext *owner;
1195 * used by multithreading to store frame-specific info
1196 * - encoding: Set by libavcodec.
1197 * - decoding: Set by libavcodec.
1199 void *thread_opaque;
1202 * log2 of the size of the block which a single vector in motion_val represents:
1203 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1204 * - encoding: unused
1205 * - decoding: Set by libavcodec.
1207 uint8_t motion_subsample_log2;
1210 struct AVCodecInternal;
1214 AV_FIELD_PROGRESSIVE,
1215 AV_FIELD_TT, //< Top coded_first, top displayed first
1216 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1217 AV_FIELD_TB, //< Top coded first, bottom displayed first
1218 AV_FIELD_BT, //< Bottom coded first, top displayed first
1222 * main external API structure.
1223 * New fields can be added to the end with minor version bumps.
1224 * Removal, reordering and changes to existing fields require a major
1226 * sizeof(AVCodecContext) must not be used outside libav*.
1228 typedef struct AVCodecContext {
1230 * information on struct for av_log
1231 * - set by avcodec_alloc_context3
1233 const AVClass *av_class;
1234 int log_level_offset;
1236 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1237 struct AVCodec *codec;
1238 char codec_name[32];
1239 enum CodecID codec_id; /* see CODEC_ID_xxx */
1242 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1243 * This is used to work around some encoder bugs.
1244 * A demuxer should set this to what is stored in the field used to identify the codec.
1245 * If there are multiple such fields in a container then the demuxer should choose the one
1246 * which maximizes the information about the used codec.
1247 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1248 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1249 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1251 * - encoding: Set by user, if not then the default based on codec_id will be used.
1252 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1254 unsigned int codec_tag;
1257 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1258 * This is used to work around some encoder bugs.
1259 * - encoding: unused
1260 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1262 unsigned int stream_codec_tag;
1266 * @deprecated this field is unused
1268 attribute_deprecated int sub_id;
1274 * Private context used for internal data.
1276 * Unlike priv_data, this is not codec-specific. It is used in general
1277 * libavcodec functions.
1279 struct AVCodecInternal *internal;
1282 * Private data of the user, can be used to carry app specific stuff.
1283 * - encoding: Set by user.
1284 * - decoding: Set by user.
1289 * the average bitrate
1290 * - encoding: Set by user; unused for constant quantizer encoding.
1291 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1296 * number of bits the bitstream is allowed to diverge from the reference.
1297 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1298 * - encoding: Set by user; unused for constant quantizer encoding.
1299 * - decoding: unused
1301 int bit_rate_tolerance;
1304 * Global quality for codecs which cannot change it per frame.
1305 * This should be proportional to MPEG-1/2/4 qscale.
1306 * - encoding: Set by user.
1307 * - decoding: unused
1312 * - encoding: Set by user.
1313 * - decoding: unused
1315 int compression_level;
1316 #define FF_COMPRESSION_DEFAULT -1
1320 * - encoding: Set by user.
1321 * - decoding: Set by user.
1327 * - encoding: Set by user.
1328 * - decoding: Set by user.
1333 * some codecs need / can use extradata like Huffman tables.
1334 * mjpeg: Huffman tables
1335 * rv10: additional flags
1336 * mpeg4: global headers (they can be in the bitstream or here)
1337 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1338 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1339 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1340 * - encoding: Set/allocated/freed by libavcodec.
1341 * - decoding: Set/allocated/freed by user.
1347 * This is the fundamental unit of time (in seconds) in terms
1348 * of which frame timestamps are represented. For fixed-fps content,
1349 * timebase should be 1/framerate and timestamp increments should be
1351 * - encoding: MUST be set by user.
1352 * - decoding: Set by libavcodec.
1354 AVRational time_base;
1357 * For some codecs, the time base is closer to the field rate than the frame rate.
1358 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1359 * if no telecine is used ...
1361 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1363 int ticks_per_frame;
1369 * Number of frames the decoded output will be delayed relative to the
1373 * Number of "priming" samples added to the beginning of the stream
1374 * during encoding. The decoded output will be delayed by this many
1375 * samples relative to the input to the encoder. Note that this field is
1376 * purely informational and does not directly affect the pts output by
1377 * the encoder, which should always be based on the actual presentation
1378 * time, including any delay.
1380 * - encoding: Set by libavcodec.
1381 * - decoding: unused
1388 * picture width / height.
1389 * - encoding: MUST be set by user.
1390 * - decoding: Set by libavcodec.
1391 * Note: For compatibility it is possible to set this instead of
1392 * coded_width/height before decoding.
1397 * Bitstream width / height, may be different from width/height if lowres enabled.
1398 * - encoding: unused
1399 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1401 int coded_width, coded_height;
1403 #define FF_ASPECT_EXTENDED 15
1406 * the number of pictures in a group of pictures, or 0 for intra_only
1407 * - encoding: Set by user.
1408 * - decoding: unused
1413 * Pixel format, see PIX_FMT_xxx.
1414 * May be set by the demuxer if known from headers.
1415 * May be overriden by the decoder if it knows better.
1416 * - encoding: Set by user.
1417 * - decoding: Set by user if known, overridden by libavcodec if known
1419 enum PixelFormat pix_fmt;
1422 * Motion estimation algorithm used for video coding.
1423 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1424 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1425 * - encoding: MUST be set by user.
1426 * - decoding: unused
1431 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1432 * decoder to draw a horizontal band. It improves cache usage. Not
1433 * all codecs can do that. You must check the codec capabilities
1435 * When multithreading is used, it may be called from multiple threads
1436 * at the same time; threads might draw different parts of the same AVFrame,
1437 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1439 * The function is also used by hardware acceleration APIs.
1440 * It is called at least once during frame decoding to pass
1441 * the data needed for hardware render.
1442 * In that mode instead of pixel data, AVFrame points to
1443 * a structure specific to the acceleration API. The application
1444 * reads the structure and can change some fields to indicate progress
1446 * - encoding: unused
1447 * - decoding: Set by user.
1448 * @param height the height of the slice
1449 * @param y the y position of the slice
1450 * @param type 1->top field, 2->bottom field, 3->frame
1451 * @param offset offset into the AVFrame.data from which the slice should be read
1453 void (*draw_horiz_band)(struct AVCodecContext *s,
1454 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1455 int y, int type, int height);
1458 * callback to negotiate the pixelFormat
1459 * @param fmt is the list of formats which are supported by the codec,
1460 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1461 * The first is always the native one.
1462 * @return the chosen format
1463 * - encoding: unused
1464 * - decoding: Set by user, if not set the native format will be chosen.
1466 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1469 * maximum number of B-frames between non-B-frames
1470 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1471 * - encoding: Set by user.
1472 * - decoding: unused
1477 * qscale factor between IP and B-frames
1478 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1479 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1480 * - encoding: Set by user.
1481 * - decoding: unused
1483 float b_quant_factor;
1485 /** obsolete FIXME remove */
1487 #define FF_RC_STRATEGY_XVID 1
1489 int b_frame_strategy;
1491 #if FF_API_MPV_GLOBAL_OPTS
1493 * luma single coefficient elimination threshold
1494 * - encoding: Set by user.
1495 * - decoding: unused
1497 attribute_deprecated int luma_elim_threshold;
1500 * chroma single coeff elimination threshold
1501 * - encoding: Set by user.
1502 * - decoding: unused
1504 attribute_deprecated int chroma_elim_threshold;
1508 * qscale offset between IP and B-frames
1509 * - encoding: Set by user.
1510 * - decoding: unused
1512 float b_quant_offset;
1515 * Size of the frame reordering buffer in the decoder.
1516 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1517 * - encoding: Set by libavcodec.
1518 * - decoding: Set by libavcodec.
1523 * 0-> h263 quant 1-> mpeg quant
1524 * - encoding: Set by user.
1525 * - decoding: unused
1530 * qscale factor between P and I-frames
1531 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1532 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1533 * - encoding: Set by user.
1534 * - decoding: unused
1536 float i_quant_factor;
1539 * qscale offset between P and I-frames
1540 * - encoding: Set by user.
1541 * - decoding: unused
1543 float i_quant_offset;
1546 * luminance masking (0-> disabled)
1547 * - encoding: Set by user.
1548 * - decoding: unused
1553 * temporary complexity masking (0-> disabled)
1554 * - encoding: Set by user.
1555 * - decoding: unused
1557 float temporal_cplx_masking;
1560 * spatial complexity masking (0-> disabled)
1561 * - encoding: Set by user.
1562 * - decoding: unused
1564 float spatial_cplx_masking;
1567 * p block masking (0-> disabled)
1568 * - encoding: Set by user.
1569 * - decoding: unused
1574 * darkness masking (0-> disabled)
1575 * - encoding: Set by user.
1576 * - decoding: unused
1582 * - encoding: Set by libavcodec.
1583 * - decoding: Set by user (or 0).
1587 * prediction method (needed for huffyuv)
1588 * - encoding: Set by user.
1589 * - decoding: unused
1591 int prediction_method;
1592 #define FF_PRED_LEFT 0
1593 #define FF_PRED_PLANE 1
1594 #define FF_PRED_MEDIAN 2
1597 * slice offsets in the frame in bytes
1598 * - encoding: Set/allocated by libavcodec.
1599 * - decoding: Set/allocated by user (or NULL).
1604 * sample aspect ratio (0 if unknown)
1605 * That is the width of a pixel divided by the height of the pixel.
1606 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1607 * - encoding: Set by user.
1608 * - decoding: Set by libavcodec.
1610 AVRational sample_aspect_ratio;
1613 * motion estimation comparison function
1614 * - encoding: Set by user.
1615 * - decoding: unused
1619 * subpixel motion estimation comparison function
1620 * - encoding: Set by user.
1621 * - decoding: unused
1625 * macroblock comparison function (not supported yet)
1626 * - encoding: Set by user.
1627 * - decoding: unused
1631 * interlaced DCT comparison function
1632 * - encoding: Set by user.
1633 * - decoding: unused
1636 #define FF_CMP_SAD 0
1637 #define FF_CMP_SSE 1
1638 #define FF_CMP_SATD 2
1639 #define FF_CMP_DCT 3
1640 #define FF_CMP_PSNR 4
1641 #define FF_CMP_BIT 5
1643 #define FF_CMP_ZERO 7
1644 #define FF_CMP_VSAD 8
1645 #define FF_CMP_VSSE 9
1646 #define FF_CMP_NSSE 10
1647 #define FF_CMP_W53 11
1648 #define FF_CMP_W97 12
1649 #define FF_CMP_DCTMAX 13
1650 #define FF_CMP_DCT264 14
1651 #define FF_CMP_CHROMA 256
1654 * ME diamond size & shape
1655 * - encoding: Set by user.
1656 * - decoding: unused
1661 * amount of previous MV predictors (2a+1 x 2a+1 square)
1662 * - encoding: Set by user.
1663 * - decoding: unused
1665 int last_predictor_count;
1668 * prepass for motion estimation
1669 * - encoding: Set by user.
1670 * - decoding: unused
1675 * motion estimation prepass comparison function
1676 * - encoding: Set by user.
1677 * - decoding: unused
1682 * ME prepass diamond size & shape
1683 * - encoding: Set by user.
1684 * - decoding: unused
1690 * - encoding: Set by user.
1691 * - decoding: unused
1693 int me_subpel_quality;
1696 * DTG active format information (additional aspect ratio
1697 * information only used in DVB MPEG-2 transport streams)
1700 * - encoding: unused
1701 * - decoding: Set by decoder.
1703 int dtg_active_format;
1704 #define FF_DTG_AFD_SAME 8
1705 #define FF_DTG_AFD_4_3 9
1706 #define FF_DTG_AFD_16_9 10
1707 #define FF_DTG_AFD_14_9 11
1708 #define FF_DTG_AFD_4_3_SP_14_9 13
1709 #define FF_DTG_AFD_16_9_SP_14_9 14
1710 #define FF_DTG_AFD_SP_4_3 15
1713 * maximum motion estimation search range in subpel units
1714 * If 0 then no limit.
1716 * - encoding: Set by user.
1717 * - decoding: unused
1722 * intra quantizer bias
1723 * - encoding: Set by user.
1724 * - decoding: unused
1726 int intra_quant_bias;
1727 #define FF_DEFAULT_QUANT_BIAS 999999
1730 * inter quantizer bias
1731 * - encoding: Set by user.
1732 * - decoding: unused
1734 int inter_quant_bias;
1736 #if FF_API_COLOR_TABLE_ID
1739 * - encoding: unused
1740 * - decoding: Which clrtable should be used for 8bit RGB images.
1741 * Tables have to be stored somewhere. FIXME
1743 attribute_deprecated int color_table_id;
1748 * - encoding: unused
1749 * - decoding: Set by user.
1752 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1753 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1754 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1757 * XVideo Motion Acceleration
1758 * - encoding: forbidden
1759 * - decoding: set by decoder
1761 int xvmc_acceleration;
1764 * macroblock decision mode
1765 * - encoding: Set by user.
1766 * - decoding: unused
1769 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1770 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1771 #define FF_MB_DECISION_RD 2 ///< rate distortion
1774 * custom intra quantization matrix
1775 * - encoding: Set by user, can be NULL.
1776 * - decoding: Set by libavcodec.
1778 uint16_t *intra_matrix;
1781 * custom inter quantization matrix
1782 * - encoding: Set by user, can be NULL.
1783 * - decoding: Set by libavcodec.
1785 uint16_t *inter_matrix;
1788 * scene change detection threshold
1789 * 0 is default, larger means fewer detected scene changes.
1790 * - encoding: Set by user.
1791 * - decoding: unused
1793 int scenechange_threshold;
1796 * noise reduction strength
1797 * - encoding: Set by user.
1798 * - decoding: unused
1800 int noise_reduction;
1802 #if FF_API_INTER_THRESHOLD
1804 * @deprecated this field is unused
1806 attribute_deprecated int inter_threshold;
1809 #if FF_API_MPV_GLOBAL_OPTS
1811 * @deprecated use mpegvideo private options instead
1813 attribute_deprecated int quantizer_noise_shaping;
1817 * Motion estimation threshold below which no motion estimation is
1818 * performed, but instead the user specified motion vectors are used.
1820 * - encoding: Set by user.
1821 * - decoding: unused
1826 * Macroblock threshold below which the user specified macroblock types will be used.
1827 * - encoding: Set by user.
1828 * - decoding: unused
1833 * precision of the intra DC coefficient - 8
1834 * - encoding: Set by user.
1835 * - decoding: unused
1837 int intra_dc_precision;
1840 * Number of macroblock rows at the top which are skipped.
1841 * - encoding: unused
1842 * - decoding: Set by user.
1847 * Number of macroblock rows at the bottom which are skipped.
1848 * - encoding: unused
1849 * - decoding: Set by user.
1854 * Border processing masking, raises the quantizer for mbs on the borders
1856 * - encoding: Set by user.
1857 * - decoding: unused
1859 float border_masking;
1862 * minimum MB lagrange multipler
1863 * - encoding: Set by user.
1864 * - decoding: unused
1869 * maximum MB lagrange multipler
1870 * - encoding: Set by user.
1871 * - decoding: unused
1877 * - encoding: Set by user.
1878 * - decoding: unused
1880 int me_penalty_compensation;
1884 * - encoding: Set by user.
1885 * - decoding: unused
1891 * - encoding: Set by user.
1892 * - decoding: unused
1898 * - encoding: Set by user.
1899 * - decoding: unused
1904 * number of reference frames
1905 * - encoding: Set by user.
1906 * - decoding: Set by lavc.
1911 * chroma qp offset from luma
1912 * - encoding: Set by user.
1913 * - decoding: unused
1918 * Multiplied by qscale for each frame and added to scene_change_score.
1919 * - encoding: Set by user.
1920 * - decoding: unused
1922 int scenechange_factor;
1926 * Note: Value depends upon the compare function used for fullpel ME.
1927 * - encoding: Set by user.
1928 * - decoding: unused
1933 * Adjust sensitivity of b_frame_strategy 1.
1934 * - encoding: Set by user.
1935 * - decoding: unused
1940 * Chromaticity coordinates of the source primaries.
1941 * - encoding: Set by user
1942 * - decoding: Set by libavcodec
1944 enum AVColorPrimaries color_primaries;
1947 * Color Transfer Characteristic.
1948 * - encoding: Set by user
1949 * - decoding: Set by libavcodec
1951 enum AVColorTransferCharacteristic color_trc;
1954 * YUV colorspace type.
1955 * - encoding: Set by user
1956 * - decoding: Set by libavcodec
1958 enum AVColorSpace colorspace;
1961 * MPEG vs JPEG YUV range.
1962 * - encoding: Set by user
1963 * - decoding: Set by libavcodec
1965 enum AVColorRange color_range;
1968 * This defines the location of chroma samples.
1969 * - encoding: Set by user
1970 * - decoding: Set by libavcodec
1972 enum AVChromaLocation chroma_sample_location;
1976 * Indicates number of picture subdivisions. Used for parallelized
1978 * - encoding: Set by user
1979 * - decoding: unused
1984 * - encoding: set by libavcodec
1985 * - decoding: Set by libavcodec
1987 enum AVFieldOrder field_order;
1990 int sample_rate; ///< samples per second
1991 int channels; ///< number of audio channels
1994 * audio sample format
1995 * - encoding: Set by user.
1996 * - decoding: Set by libavcodec.
1998 enum AVSampleFormat sample_fmt; ///< sample format
2000 /* The following data should not be initialized. */
2002 * Samples per packet, initialized when calling 'init'.
2007 * Frame counter, set by libavcodec.
2009 * - decoding: total number of frames returned from the decoder so far.
2010 * - encoding: total number of frames passed to the encoder so far.
2012 * @note the counter is not incremented if encoding/decoding resulted in
2018 * number of bytes per packet if constant and known or 0
2019 * Used by some WAV based audio codecs.
2024 * Audio cutoff bandwidth (0 means "automatic")
2025 * - encoding: Set by user.
2026 * - decoding: unused
2030 #if FF_API_REQUEST_CHANNELS
2032 * Decoder should decode to this many channels if it can (0 for default)
2033 * - encoding: unused
2034 * - decoding: Set by user.
2035 * @deprecated Deprecated in favor of request_channel_layout.
2037 int request_channels;
2041 * Audio channel layout.
2042 * - encoding: set by user.
2043 * - decoding: set by libavcodec.
2045 uint64_t channel_layout;
2048 * Request decoder to use this channel layout if it can (0 for default)
2049 * - encoding: unused
2050 * - decoding: Set by user.
2052 uint64_t request_channel_layout;
2055 * Type of service that the audio stream conveys.
2056 * - encoding: Set by user.
2057 * - decoding: Set by libavcodec.
2059 enum AVAudioServiceType audio_service_type;
2062 * Used to request a sample format from the decoder.
2063 * - encoding: unused.
2064 * - decoding: Set by user.
2066 enum AVSampleFormat request_sample_fmt;
2069 * Called at the beginning of each frame to get a buffer for it.
2071 * The function will set AVFrame.data[], AVFrame.linesize[].
2072 * AVFrame.extended_data[] must also be set, but it should be the same as
2073 * AVFrame.data[] except for planar audio with more channels than can fit
2074 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2075 * many data pointers as it can hold.
2077 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2078 * avcodec_default_get_buffer() instead of providing buffers allocated by
2081 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2082 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2083 * but if get_buffer() is overridden then alignment considerations should
2084 * be taken into account.
2086 * @see avcodec_default_get_buffer()
2090 * If pic.reference is set then the frame will be read later by libavcodec.
2091 * avcodec_align_dimensions2() should be used to find the required width and
2092 * height, as they normally need to be rounded up to the next multiple of 16.
2094 * If frame multithreading is used and thread_safe_callbacks is set,
2095 * it may be called from a different thread, but not from more than one at
2096 * once. Does not need to be reentrant.
2098 * @see release_buffer(), reget_buffer()
2099 * @see avcodec_align_dimensions2()
2103 * Decoders request a buffer of a particular size by setting
2104 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2105 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2106 * to a smaller value in the output frame.
2108 * Decoders cannot use the buffer after returning from
2109 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2110 * is assumed to be released immediately upon return.
2112 * As a convenience, av_samples_get_buffer_size() and
2113 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2114 * functions to find the required data size and to fill data pointers and
2115 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2116 * since all planes must be the same size.
2118 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2120 * - encoding: unused
2121 * - decoding: Set by libavcodec, user can override.
2123 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2126 * Called to release buffers which were allocated with get_buffer.
2127 * A released buffer can be reused in get_buffer().
2128 * pic.data[*] must be set to NULL.
2129 * May be called from a different thread if frame multithreading is used,
2130 * but not by more than one thread at once, so does not need to be reentrant.
2131 * - encoding: unused
2132 * - decoding: Set by libavcodec, user can override.
2134 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2137 * Called at the beginning of a frame to get cr buffer for it.
2138 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2139 * libavcodec will pass previous buffer in pic, function should return
2140 * same buffer or new buffer with old frame "painted" into it.
2141 * If pic.data[0] == NULL must behave like get_buffer().
2142 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2143 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2145 * - encoding: unused
2146 * - decoding: Set by libavcodec, user can override.
2148 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2151 /* - encoding parameters */
2152 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2153 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2157 * - encoding: Set by user.
2158 * - decoding: unused
2164 * - encoding: Set by user.
2165 * - decoding: unused
2170 * maximum quantizer difference between frames
2171 * - encoding: Set by user.
2172 * - decoding: unused
2177 * ratecontrol qmin qmax limiting method
2178 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2179 * - encoding: Set by user.
2180 * - decoding: unused
2188 * decoder bitstream buffer size
2189 * - encoding: Set by user.
2190 * - decoding: unused
2195 * ratecontrol override, see RcOverride
2196 * - encoding: Allocated/set/freed by user.
2197 * - decoding: unused
2199 int rc_override_count;
2200 RcOverride *rc_override;
2203 * rate control equation
2204 * - encoding: Set by user
2205 * - decoding: unused
2211 * - encoding: Set by user.
2212 * - decoding: unused
2218 * - encoding: Set by user.
2219 * - decoding: unused
2223 float rc_buffer_aggressivity;
2226 * initial complexity for pass1 ratecontrol
2227 * - encoding: Set by user.
2228 * - decoding: unused
2230 float rc_initial_cplx;
2233 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2234 * - encoding: Set by user.
2235 * - decoding: unused.
2237 float rc_max_available_vbv_use;
2240 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2241 * - encoding: Set by user.
2242 * - decoding: unused.
2244 float rc_min_vbv_overflow_use;
2247 * Number of bits which should be loaded into the rc buffer before decoding starts.
2248 * - encoding: Set by user.
2249 * - decoding: unused
2251 int rc_initial_buffer_occupancy;
2253 #define FF_CODER_TYPE_VLC 0
2254 #define FF_CODER_TYPE_AC 1
2255 #define FF_CODER_TYPE_RAW 2
2256 #define FF_CODER_TYPE_RLE 3
2257 #define FF_CODER_TYPE_DEFLATE 4
2260 * - encoding: Set by user.
2261 * - decoding: unused
2267 * - encoding: Set by user.
2268 * - decoding: unused
2273 * minimum Lagrange multipler
2274 * - encoding: Set by user.
2275 * - decoding: unused
2280 * maximum Lagrange multipler
2281 * - encoding: Set by user.
2282 * - decoding: unused
2287 * frame skip threshold
2288 * - encoding: Set by user.
2289 * - decoding: unused
2291 int frame_skip_threshold;
2295 * - encoding: Set by user.
2296 * - decoding: unused
2298 int frame_skip_factor;
2301 * frame skip exponent
2302 * - encoding: Set by user.
2303 * - decoding: unused
2308 * frame skip comparison function
2309 * - encoding: Set by user.
2310 * - decoding: unused
2315 * trellis RD quantization
2316 * - encoding: Set by user.
2317 * - decoding: unused
2322 * - encoding: Set by user.
2323 * - decoding: unused
2325 int min_prediction_order;
2328 * - encoding: Set by user.
2329 * - decoding: unused
2331 int max_prediction_order;
2334 * GOP timecode frame start number, in non drop frame format
2335 * - encoding: Set by user.
2336 * - decoding: unused
2338 int64_t timecode_frame_start;
2340 /* The RTP callback: This function is called */
2341 /* every time the encoder has a packet to send. */
2342 /* It depends on the encoder if the data starts */
2343 /* with a Start Code (it should). H.263 does. */
2344 /* mb_nb contains the number of macroblocks */
2345 /* encoded in the RTP payload. */
2346 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2348 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2349 /* do its best to deliver a chunk with size */
2350 /* below rtp_payload_size, the chunk will start */
2351 /* with a start code on some codecs like H.263. */
2352 /* This doesn't take account of any particular */
2353 /* headers inside the transmitted RTP payload. */
2355 /* statistics, used for 2-pass encoding */
2366 * number of bits used for the previously encoded frame
2367 * - encoding: Set by libavcodec.
2368 * - decoding: unused
2373 * pass1 encoding statistics output buffer
2374 * - encoding: Set by libavcodec.
2375 * - decoding: unused
2380 * pass2 encoding statistics input buffer
2381 * Concatenated stuff from stats_out of pass1 should be placed here.
2382 * - encoding: Allocated/set/freed by user.
2383 * - decoding: unused
2388 * Work around bugs in encoders which sometimes cannot be detected automatically.
2389 * - encoding: Set by user
2390 * - decoding: Set by user
2392 int workaround_bugs;
2393 #define FF_BUG_AUTODETECT 1 ///< autodetection
2394 #define FF_BUG_OLD_MSMPEG4 2
2395 #define FF_BUG_XVID_ILACE 4
2396 #define FF_BUG_UMP4 8
2397 #define FF_BUG_NO_PADDING 16
2398 #define FF_BUG_AMV 32
2399 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2400 #define FF_BUG_QPEL_CHROMA 64
2401 #define FF_BUG_STD_QPEL 128
2402 #define FF_BUG_QPEL_CHROMA2 256
2403 #define FF_BUG_DIRECT_BLOCKSIZE 512
2404 #define FF_BUG_EDGE 1024
2405 #define FF_BUG_HPEL_CHROMA 2048
2406 #define FF_BUG_DC_CLIP 4096
2407 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2408 #define FF_BUG_TRUNCATED 16384
2411 * strictly follow the standard (MPEG4, ...).
2412 * - encoding: Set by user.
2413 * - decoding: Set by user.
2414 * Setting this to STRICT or higher means the encoder and decoder will
2415 * generally do stupid things, whereas setting it to unofficial or lower
2416 * will mean the encoder might produce output that is not supported by all
2417 * spec-compliant decoders. Decoders don't differentiate between normal,
2418 * unofficial and experimental (that is, they always try to decode things
2419 * when they can) unless they are explicitly asked to behave stupidly
2420 * (=strictly conform to the specs)
2422 int strict_std_compliance;
2423 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2424 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2425 #define FF_COMPLIANCE_NORMAL 0
2426 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2427 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2430 * error concealment flags
2431 * - encoding: unused
2432 * - decoding: Set by user.
2434 int error_concealment;
2435 #define FF_EC_GUESS_MVS 1
2436 #define FF_EC_DEBLOCK 2
2440 * - encoding: Set by user.
2441 * - decoding: Set by user.
2444 #define FF_DEBUG_PICT_INFO 1
2445 #define FF_DEBUG_RC 2
2446 #define FF_DEBUG_BITSTREAM 4
2447 #define FF_DEBUG_MB_TYPE 8
2448 #define FF_DEBUG_QP 16
2449 #define FF_DEBUG_MV 32
2450 #define FF_DEBUG_DCT_COEFF 0x00000040
2451 #define FF_DEBUG_SKIP 0x00000080
2452 #define FF_DEBUG_STARTCODE 0x00000100
2453 #define FF_DEBUG_PTS 0x00000200
2454 #define FF_DEBUG_ER 0x00000400
2455 #define FF_DEBUG_MMCO 0x00000800
2456 #define FF_DEBUG_BUGS 0x00001000
2457 #define FF_DEBUG_VIS_QP 0x00002000
2458 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2459 #define FF_DEBUG_BUFFERS 0x00008000
2460 #define FF_DEBUG_THREADS 0x00010000
2464 * - encoding: Set by user.
2465 * - decoding: Set by user.
2468 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2469 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2470 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2473 * Error recognition; may misdetect some more or less valid parts as errors.
2474 * - encoding: unused
2475 * - decoding: Set by user.
2477 int err_recognition;
2478 #define AV_EF_CRCCHECK (1<<0)
2479 #define AV_EF_BITSTREAM (1<<1)
2480 #define AV_EF_BUFFER (1<<2)
2481 #define AV_EF_EXPLODE (1<<3)
2484 * opaque 64bit number (generally a PTS) that will be reordered and
2485 * output in AVFrame.reordered_opaque
2486 * @deprecated in favor of pkt_pts
2487 * - encoding: unused
2488 * - decoding: Set by user.
2490 int64_t reordered_opaque;
2493 * Hardware accelerator in use
2494 * - encoding: unused.
2495 * - decoding: Set by libavcodec
2497 struct AVHWAccel *hwaccel;
2500 * Hardware accelerator context.
2501 * For some hardware accelerators, a global context needs to be
2502 * provided by the user. In that case, this holds display-dependent
2503 * data Libav cannot instantiate itself. Please refer to the
2504 * Libav HW accelerator documentation to know how to fill this
2505 * is. e.g. for VA API, this is a struct vaapi_context.
2506 * - encoding: unused
2507 * - decoding: Set by user
2509 void *hwaccel_context;
2513 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2514 * - decoding: unused
2516 uint64_t error[AV_NUM_DATA_POINTERS];
2519 * DCT algorithm, see FF_DCT_* below
2520 * - encoding: Set by user.
2521 * - decoding: unused
2524 #define FF_DCT_AUTO 0
2525 #define FF_DCT_FASTINT 1
2526 #define FF_DCT_INT 2
2527 #define FF_DCT_MMX 3
2528 #define FF_DCT_ALTIVEC 5
2529 #define FF_DCT_FAAN 6
2532 * IDCT algorithm, see FF_IDCT_* below.
2533 * - encoding: Set by user.
2534 * - decoding: Set by user.
2537 #define FF_IDCT_AUTO 0
2538 #define FF_IDCT_INT 1
2539 #define FF_IDCT_SIMPLE 2
2540 #define FF_IDCT_SIMPLEMMX 3
2541 #define FF_IDCT_LIBMPEG2MMX 4
2542 #define FF_IDCT_MMI 5
2543 #define FF_IDCT_ARM 7
2544 #define FF_IDCT_ALTIVEC 8
2545 #define FF_IDCT_SH4 9
2546 #define FF_IDCT_SIMPLEARM 10
2547 #define FF_IDCT_H264 11
2548 #define FF_IDCT_VP3 12
2549 #define FF_IDCT_IPP 13
2550 #define FF_IDCT_XVIDMMX 14
2551 #define FF_IDCT_CAVS 15
2552 #define FF_IDCT_SIMPLEARMV5TE 16
2553 #define FF_IDCT_SIMPLEARMV6 17
2554 #define FF_IDCT_SIMPLEVIS 18
2555 #define FF_IDCT_WMV2 19
2556 #define FF_IDCT_FAAN 20
2557 #define FF_IDCT_EA 21
2558 #define FF_IDCT_SIMPLENEON 22
2559 #define FF_IDCT_SIMPLEALPHA 23
2560 #define FF_IDCT_BINK 24
2563 * dsp_mask could be add used to disable unwanted CPU features
2564 * CPU features (i.e. MMX, SSE. ...)
2566 * With the FORCE flag you may instead enable given CPU features.
2567 * (Dangerous: Usable in case of misdetection, improper usage however will
2568 * result into program crash.)
2573 * bits per sample/pixel from the demuxer (needed for huffyuv).
2574 * - encoding: Set by libavcodec.
2575 * - decoding: Set by user.
2577 int bits_per_coded_sample;
2580 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2581 * - encoding: set by user.
2582 * - decoding: set by libavcodec.
2584 int bits_per_raw_sample;
2587 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2588 * - encoding: unused
2589 * - decoding: Set by user.
2594 * the picture in the bitstream
2595 * - encoding: Set by libavcodec.
2596 * - decoding: Set by libavcodec.
2598 AVFrame *coded_frame;
2602 * is used to decide how many independent tasks should be passed to execute()
2603 * - encoding: Set by user.
2604 * - decoding: Set by user.
2609 * Which multithreading methods to use.
2610 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2611 * so clients which cannot provide future frames should not use it.
2613 * - encoding: Set by user, otherwise the default is used.
2614 * - decoding: Set by user, otherwise the default is used.
2617 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2618 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2621 * Which multithreading methods are in use by the codec.
2622 * - encoding: Set by libavcodec.
2623 * - decoding: Set by libavcodec.
2625 int active_thread_type;
2628 * Set by the client if its custom get_buffer() callback can be called
2629 * from another thread, which allows faster multithreaded decoding.
2630 * draw_horiz_band() will be called from other threads regardless of this setting.
2631 * Ignored if the default get_buffer() is used.
2632 * - encoding: Set by user.
2633 * - decoding: Set by user.
2635 int thread_safe_callbacks;
2638 * The codec may call this to execute several independent things.
2639 * It will return only after finishing all tasks.
2640 * The user may replace this with some multithreaded implementation,
2641 * the default implementation will execute the parts serially.
2642 * @param count the number of things to execute
2643 * - encoding: Set by libavcodec, user can override.
2644 * - decoding: Set by libavcodec, user can override.
2646 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2649 * The codec may call this to execute several independent things.
2650 * It will return only after finishing all tasks.
2651 * The user may replace this with some multithreaded implementation,
2652 * the default implementation will execute the parts serially.
2653 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2654 * @param c context passed also to func
2655 * @param count the number of things to execute
2656 * @param arg2 argument passed unchanged to func
2657 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2658 * @param func function that will be called count times, with jobnr from 0 to count-1.
2659 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2660 * two instances of func executing at the same time will have the same threadnr.
2661 * @return always 0 currently, but code should handle a future improvement where when any call to func
2662 * returns < 0 no further calls to func may be done and < 0 is returned.
2663 * - encoding: Set by libavcodec, user can override.
2664 * - decoding: Set by libavcodec, user can override.
2666 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2670 * Can be used by execute() to store some per AVCodecContext stuff.
2671 * - encoding: set by execute()
2672 * - decoding: set by execute()
2674 void *thread_opaque;
2677 * noise vs. sse weight for the nsse comparsion function
2678 * - encoding: Set by user.
2679 * - decoding: unused
2685 * - encoding: Set by user.
2686 * - decoding: Set by libavcodec.
2689 #define FF_PROFILE_UNKNOWN -99
2690 #define FF_PROFILE_RESERVED -100
2692 #define FF_PROFILE_AAC_MAIN 0
2693 #define FF_PROFILE_AAC_LOW 1
2694 #define FF_PROFILE_AAC_SSR 2
2695 #define FF_PROFILE_AAC_LTP 3
2697 #define FF_PROFILE_DTS 20
2698 #define FF_PROFILE_DTS_ES 30
2699 #define FF_PROFILE_DTS_96_24 40
2700 #define FF_PROFILE_DTS_HD_HRA 50
2701 #define FF_PROFILE_DTS_HD_MA 60
2703 #define FF_PROFILE_MPEG2_422 0
2704 #define FF_PROFILE_MPEG2_HIGH 1
2705 #define FF_PROFILE_MPEG2_SS 2
2706 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2707 #define FF_PROFILE_MPEG2_MAIN 4
2708 #define FF_PROFILE_MPEG2_SIMPLE 5
2710 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2711 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2713 #define FF_PROFILE_H264_BASELINE 66
2714 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2715 #define FF_PROFILE_H264_MAIN 77
2716 #define FF_PROFILE_H264_EXTENDED 88
2717 #define FF_PROFILE_H264_HIGH 100
2718 #define FF_PROFILE_H264_HIGH_10 110
2719 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2720 #define FF_PROFILE_H264_HIGH_422 122
2721 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2722 #define FF_PROFILE_H264_HIGH_444 144
2723 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2724 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2725 #define FF_PROFILE_H264_CAVLC_444 44
2727 #define FF_PROFILE_VC1_SIMPLE 0
2728 #define FF_PROFILE_VC1_MAIN 1
2729 #define FF_PROFILE_VC1_COMPLEX 2
2730 #define FF_PROFILE_VC1_ADVANCED 3
2732 #define FF_PROFILE_MPEG4_SIMPLE 0
2733 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2734 #define FF_PROFILE_MPEG4_CORE 2
2735 #define FF_PROFILE_MPEG4_MAIN 3
2736 #define FF_PROFILE_MPEG4_N_BIT 4
2737 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2738 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2739 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2740 #define FF_PROFILE_MPEG4_HYBRID 8
2741 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2742 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2743 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2744 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2745 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2746 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2747 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2751 * - encoding: Set by user.
2752 * - decoding: Set by libavcodec.
2755 #define FF_LEVEL_UNKNOWN -99
2759 * - encoding: unused
2760 * - decoding: Set by user.
2762 enum AVDiscard skip_loop_filter;
2766 * - encoding: unused
2767 * - decoding: Set by user.
2769 enum AVDiscard skip_idct;
2773 * - encoding: unused
2774 * - decoding: Set by user.
2776 enum AVDiscard skip_frame;
2779 * Header containing style information for text subtitles.
2780 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2781 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2782 * the Format line following. It shouldn't include any Dialogue line.
2783 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2784 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2786 uint8_t *subtitle_header;
2787 int subtitle_header_size;
2790 * Simulates errors in the bitstream to test error concealment.
2791 * - encoding: Set by user.
2792 * - decoding: unused
2797 * Current packet as passed into the decoder, to avoid having
2798 * to pass the packet into every function. Currently only valid
2799 * inside lavc and get/release_buffer callbacks.
2800 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2801 * - encoding: unused
2806 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2807 * Used for compliant TS muxing.
2808 * - encoding: Set by libavcodec.
2809 * - decoding: unused.
2817 typedef struct AVProfile {
2819 const char *name; ///< short name for the profile
2822 typedef struct AVCodecDefault AVCodecDefault;
2827 typedef struct AVCodec {
2829 * Name of the codec implementation.
2830 * The name is globally unique among encoders and among decoders (but an
2831 * encoder and a decoder can share the same name).
2832 * This is the primary way to find a codec from the user perspective.
2836 * Descriptive name for the codec, meant to be more human readable than name.
2837 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2839 const char *long_name;
2840 enum AVMediaType type;
2843 * Codec capabilities.
2847 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2848 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2849 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2850 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2851 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2852 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2853 const AVClass *priv_class; ///< AVClass for the private context
2854 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2856 /*****************************************************************
2857 * No fields below this line are part of the public API. They
2858 * may not be used outside of libavcodec and can be changed and
2860 * New public fields should be added right above.
2861 *****************************************************************
2864 struct AVCodec *next;
2866 * @name Frame-level threading support functions
2870 * If defined, called on thread contexts when they are created.
2871 * If the codec allocates writable tables in init(), re-allocate them here.
2872 * priv_data will be set to a copy of the original.
2874 int (*init_thread_copy)(AVCodecContext *);
2876 * Copy necessary context variables from a previous thread context to the current one.
2877 * If not defined, the next thread will start automatically; otherwise, the codec
2878 * must call ff_thread_finish_setup().
2880 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2882 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2886 * Private codec-specific defaults.
2888 const AVCodecDefault *defaults;
2891 * Initialize codec static data, called from avcodec_register().
2893 void (*init_static_data)(struct AVCodec *codec);
2895 int (*init)(AVCodecContext *);
2896 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2898 * Encode data to an AVPacket.
2900 * @param avctx codec context
2901 * @param avpkt output AVPacket (may contain a user-provided buffer)
2902 * @param[in] frame AVFrame containing the raw data to be encoded
2903 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2904 * non-empty packet was returned in avpkt.
2905 * @return 0 on success, negative error code on failure
2907 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2908 int *got_packet_ptr);
2909 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2910 int (*close)(AVCodecContext *);
2913 * Will be called when seeking
2915 void (*flush)(AVCodecContext *);
2921 typedef struct AVHWAccel {
2923 * Name of the hardware accelerated codec.
2924 * The name is globally unique among encoders and among decoders (but an
2925 * encoder and a decoder can share the same name).
2930 * Type of codec implemented by the hardware accelerator.
2932 * See AVMEDIA_TYPE_xxx
2934 enum AVMediaType type;
2937 * Codec implemented by the hardware accelerator.
2944 * Supported pixel format.
2946 * Only hardware accelerated formats are supported here.
2948 enum PixelFormat pix_fmt;
2951 * Hardware accelerated codec capabilities.
2952 * see FF_HWACCEL_CODEC_CAP_*
2956 struct AVHWAccel *next;
2959 * Called at the beginning of each frame or field picture.
2961 * Meaningful frame information (codec specific) is guaranteed to
2962 * be parsed at this point. This function is mandatory.
2964 * Note that buf can be NULL along with buf_size set to 0.
2965 * Otherwise, this means the whole frame is available at this point.
2967 * @param avctx the codec context
2968 * @param buf the frame data buffer base
2969 * @param buf_size the size of the frame in bytes
2970 * @return zero if successful, a negative value otherwise
2972 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2975 * Callback for each slice.
2977 * Meaningful slice information (codec specific) is guaranteed to
2978 * be parsed at this point. This function is mandatory.
2980 * @param avctx the codec context
2981 * @param buf the slice data buffer base
2982 * @param buf_size the size of the slice in bytes
2983 * @return zero if successful, a negative value otherwise
2985 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2988 * Called at the end of each frame or field picture.
2990 * The whole picture is parsed at this point and can now be sent
2991 * to the hardware accelerator. This function is mandatory.
2993 * @param avctx the codec context
2994 * @return zero if successful, a negative value otherwise
2996 int (*end_frame)(AVCodecContext *avctx);
2999 * Size of HW accelerator private data.
3001 * Private data is allocated with av_mallocz() before
3002 * AVCodecContext.get_buffer() and deallocated after
3003 * AVCodecContext.release_buffer().
3009 * @defgroup lavc_picture AVPicture
3011 * Functions for working with AVPicture
3016 * four components are given, that's all.
3017 * the last component is alpha
3019 typedef struct AVPicture {
3020 uint8_t *data[AV_NUM_DATA_POINTERS];
3021 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3028 #define AVPALETTE_SIZE 1024
3029 #define AVPALETTE_COUNT 256
3031 enum AVSubtitleType {
3034 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3037 * Plain text, the text field must be set by the decoder and is
3038 * authoritative. ass and pict fields may contain approximations.
3043 * Formatted text, the ass field must be set by the decoder and is
3044 * authoritative. pict and text fields may contain approximations.
3049 typedef struct AVSubtitleRect {
3050 int x; ///< top left corner of pict, undefined when pict is not set
3051 int y; ///< top left corner of pict, undefined when pict is not set
3052 int w; ///< width of pict, undefined when pict is not set
3053 int h; ///< height of pict, undefined when pict is not set
3054 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3057 * data+linesize for the bitmap of this subtitle.
3058 * can be set for text/ass as well once they where rendered
3061 enum AVSubtitleType type;
3063 char *text; ///< 0 terminated plain UTF-8 text
3066 * 0 terminated ASS/SSA compatible event line.
3067 * The pressentation of this is unaffected by the other values in this
3073 typedef struct AVSubtitle {
3074 uint16_t format; /* 0 = graphics */
3075 uint32_t start_display_time; /* relative to packet pts, in ms */
3076 uint32_t end_display_time; /* relative to packet pts, in ms */
3078 AVSubtitleRect **rects;
3079 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3083 * If c is NULL, returns the first registered codec,
3084 * if c is non-NULL, returns the next registered codec after c,
3085 * or NULL if c is the last one.
3087 AVCodec *av_codec_next(AVCodec *c);
3090 * Return the LIBAVCODEC_VERSION_INT constant.
3092 unsigned avcodec_version(void);
3095 * Return the libavcodec build-time configuration.
3097 const char *avcodec_configuration(void);
3100 * Return the libavcodec license.
3102 const char *avcodec_license(void);
3105 * Register the codec codec and initialize libavcodec.
3107 * @warning either this function or avcodec_register_all() must be called
3108 * before any other libavcodec functions.
3110 * @see avcodec_register_all()
3112 void avcodec_register(AVCodec *codec);
3115 * Register all the codecs, parsers and bitstream filters which were enabled at
3116 * configuration time. If you do not call this function you can select exactly
3117 * which formats you want to support, by using the individual registration
3120 * @see avcodec_register
3121 * @see av_register_codec_parser
3122 * @see av_register_bitstream_filter
3124 void avcodec_register_all(void);
3127 * Allocate an AVCodecContext and set its fields to default values. The
3128 * resulting struct can be deallocated by calling avcodec_close() on it followed
3131 * @param codec if non-NULL, allocate private data and initialize defaults
3132 * for the given codec. It is illegal to then call avcodec_open2()
3133 * with a different codec.
3134 * If NULL, then the codec-specific defaults won't be initialized,
3135 * which may result in suboptimal default settings (this is
3136 * important mainly for encoders, e.g. libx264).
3138 * @return An AVCodecContext filled with default values or NULL on failure.
3139 * @see avcodec_get_context_defaults
3141 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3144 * Set the fields of the given AVCodecContext to default values corresponding
3145 * to the given codec (defaults may be codec-dependent).
3147 * Do not call this function if a non-NULL codec has been passed
3148 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3149 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3150 * different codec on this AVCodecContext.
3152 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3155 * Get the AVClass for AVCodecContext. It can be used in combination with
3156 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3158 * @see av_opt_find().
3160 const AVClass *avcodec_get_class(void);
3163 * Copy the settings of the source AVCodecContext into the destination
3164 * AVCodecContext. The resulting destination codec context will be
3165 * unopened, i.e. you are required to call avcodec_open2() before you
3166 * can use this AVCodecContext to decode/encode video/audio data.
3168 * @param dest target codec context, should be initialized with
3169 * avcodec_alloc_context3(), but otherwise uninitialized
3170 * @param src source codec context
3171 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3173 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3176 * Allocate an AVFrame and set its fields to default values. The resulting
3177 * struct can be deallocated by simply calling av_free().
3179 * @return An AVFrame filled with default values or NULL on failure.
3180 * @see avcodec_get_frame_defaults
3182 AVFrame *avcodec_alloc_frame(void);
3185 * Set the fields of the given AVFrame to default values.
3187 * @param pic The AVFrame of which the fields should be set to default values.
3189 void avcodec_get_frame_defaults(AVFrame *pic);
3192 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3193 * function the context has to be allocated with avcodec_alloc_context3().
3195 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3196 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3197 * retrieving a codec.
3199 * @warning This function is not thread safe!
3202 * avcodec_register_all();
3203 * av_dict_set(&opts, "b", "2.5M", 0);
3204 * codec = avcodec_find_decoder(CODEC_ID_H264);
3208 * context = avcodec_alloc_context3(codec);
3210 * if (avcodec_open2(context, codec, opts) < 0)
3214 * @param avctx The context to initialize.
3215 * @param codec The codec to open this context for. If a non-NULL codec has been
3216 * previously passed to avcodec_alloc_context3() or
3217 * avcodec_get_context_defaults3() for this context, then this
3218 * parameter MUST be either NULL or equal to the previously passed
3220 * @param options A dictionary filled with AVCodecContext and codec-private options.
3221 * On return this object will be filled with options that were not found.
3223 * @return zero on success, a negative value on error
3224 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3225 * av_dict_set(), av_opt_find().
3227 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3230 * Close a given AVCodecContext and free all the data associated with it
3231 * (but not the AVCodecContext itself).
3233 * Calling this function on an AVCodecContext that hasn't been opened will free
3234 * the codec-specific data allocated in avcodec_alloc_context3() /
3235 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3238 int avcodec_close(AVCodecContext *avctx);
3241 * Free all allocated data in the given subtitle struct.
3243 * @param sub AVSubtitle to free.
3245 void avsubtitle_free(AVSubtitle *sub);
3252 * @addtogroup lavc_packet
3257 * @deprecated use NULL instead
3259 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3262 * Default packet destructor.
3264 void av_destruct_packet(AVPacket *pkt);
3267 * Initialize optional fields of a packet with default values.
3271 void av_init_packet(AVPacket *pkt);
3274 * Allocate the payload of a packet and initialize its fields with
3278 * @param size wanted payload size
3279 * @return 0 if OK, AVERROR_xxx otherwise
3281 int av_new_packet(AVPacket *pkt, int size);
3284 * Reduce packet size, correctly zeroing padding
3287 * @param size new size
3289 void av_shrink_packet(AVPacket *pkt, int size);
3292 * Increase packet size, correctly zeroing padding
3295 * @param grow_by number of bytes by which to increase the size of the packet
3297 int av_grow_packet(AVPacket *pkt, int grow_by);
3300 * @warning This is a hack - the packet memory allocation stuff is broken. The
3301 * packet is allocated if it was not really allocated.
3303 int av_dup_packet(AVPacket *pkt);
3308 * @param pkt packet to free
3310 void av_free_packet(AVPacket *pkt);
3313 * Allocate new information of a packet.
3316 * @param type side information type
3317 * @param size side information size
3318 * @return pointer to fresh allocated data or NULL otherwise
3320 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3324 * Shrink the already allocated side data buffer
3327 * @param type side information type
3328 * @param size new side information size
3329 * @return 0 on success, < 0 on failure
3331 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3335 * Get side information from packet.
3338 * @param type desired side information type
3339 * @param size pointer for side information size to store (optional)
3340 * @return pointer to data if present or NULL otherwise
3342 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3350 * @addtogroup lavc_decoding
3355 * Find a registered decoder with a matching codec ID.
3357 * @param id CodecID of the requested decoder
3358 * @return A decoder if one was found, NULL otherwise.
3360 AVCodec *avcodec_find_decoder(enum CodecID id);
3363 * Find a registered decoder with the specified name.
3365 * @param name name of the requested decoder
3366 * @return A decoder if one was found, NULL otherwise.
3368 AVCodec *avcodec_find_decoder_by_name(const char *name);
3370 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3371 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3372 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3375 * Return the amount of padding in pixels which the get_buffer callback must
3376 * provide around the edge of the image for codecs which do not have the
3377 * CODEC_FLAG_EMU_EDGE flag.
3379 * @return Required padding in pixels.
3381 unsigned avcodec_get_edge_width(void);
3384 * Modify width and height values so that they will result in a memory
3385 * buffer that is acceptable for the codec if you do not use any horizontal
3388 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3389 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3390 * according to avcodec_get_edge_width() before.
3392 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3395 * Modify width and height values so that they will result in a memory
3396 * buffer that is acceptable for the codec if you also ensure that all
3397 * line sizes are a multiple of the respective linesize_align[i].
3399 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3400 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3401 * according to avcodec_get_edge_width() before.
3403 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3404 int linesize_align[AV_NUM_DATA_POINTERS]);
3406 #if FF_API_OLD_DECODE_AUDIO
3408 * Wrapper function which calls avcodec_decode_audio4.
3410 * @deprecated Use avcodec_decode_audio4 instead.
3412 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3413 * Some decoders may support multiple frames in a single AVPacket, such
3414 * decoders would then just decode the first frame. In this case,
3415 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3416 * the remaining data in order to decode the second frame etc.
3418 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3419 * decompressed frame size in bytes.
3421 * @warning You must set frame_size_ptr to the allocated size of the
3422 * output buffer before calling avcodec_decode_audio3().
3424 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3425 * the actual read bytes because some optimized bitstream readers read 32 or 64
3426 * bits at once and could read over the end.
3428 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3429 * no overreading happens for damaged MPEG streams.
3431 * @warning You must not provide a custom get_buffer() when using
3432 * avcodec_decode_audio3(). Doing so will override it with
3433 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3434 * which does allow the application to provide a custom get_buffer().
3436 * @note You might have to align the input buffer avpkt->data and output buffer
3437 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3438 * necessary at all, on others it won't work at all if not aligned and on others
3439 * it will work but it will have an impact on performance.
3441 * In practice, avpkt->data should have 4 byte alignment at minimum and
3442 * samples should be 16 byte aligned unless the CPU doesn't need it
3443 * (AltiVec and SSE do).
3445 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3446 * between input and output, these need to be fed with avpkt->data=NULL,
3447 * avpkt->size=0 at the end to return the remaining frames.
3449 * @param avctx the codec context
3450 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3451 * If the sample format is planar, each channel plane will
3452 * be the same size, with no padding between channels.
3453 * @param[in,out] frame_size_ptr the output buffer size in bytes
3454 * @param[in] avpkt The input AVPacket containing the input buffer.
3455 * You can create such packet with av_init_packet() and by then setting
3456 * data and size, some decoders might in addition need other fields.
3457 * All decoders are designed to use the least fields possible though.
3458 * @return On error a negative value is returned, otherwise the number of bytes
3459 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3461 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3462 int *frame_size_ptr,
3467 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3469 * Some decoders may support multiple frames in a single AVPacket. Such
3470 * decoders would then just decode the first frame. In this case,
3471 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3472 * the remaining data in order to decode the second frame, etc...
3473 * Even if no frames are returned, the packet needs to be fed to the decoder
3474 * with remaining data until it is completely consumed or an error occurs.
3476 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3477 * larger than the actual read bytes because some optimized bitstream
3478 * readers read 32 or 64 bits at once and could read over the end.
3480 * @note You might have to align the input buffer. The alignment requirements
3481 * depend on the CPU and the decoder.
3483 * @param avctx the codec context
3484 * @param[out] frame The AVFrame in which to store decoded audio samples.
3485 * Decoders request a buffer of a particular size by setting
3486 * AVFrame.nb_samples prior to calling get_buffer(). The
3487 * decoder may, however, only utilize part of the buffer by
3488 * setting AVFrame.nb_samples to a smaller value in the
3490 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3492 * @param[in] avpkt The input AVPacket containing the input buffer.
3493 * At least avpkt->data and avpkt->size should be set. Some
3494 * decoders might also require additional fields to be set.
3495 * @return A negative error code is returned if an error occurred during
3496 * decoding, otherwise the number of bytes consumed from the input
3497 * AVPacket is returned.
3499 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3500 int *got_frame_ptr, AVPacket *avpkt);
3503 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3504 * Some decoders may support multiple frames in a single AVPacket, such
3505 * decoders would then just decode the first frame.
3507 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3508 * the actual read bytes because some optimized bitstream readers read 32 or 64
3509 * bits at once and could read over the end.
3511 * @warning The end of the input buffer buf should be set to 0 to ensure that
3512 * no overreading happens for damaged MPEG streams.
3514 * @note You might have to align the input buffer avpkt->data.
3515 * The alignment requirements depend on the CPU: on some CPUs it isn't
3516 * necessary at all, on others it won't work at all if not aligned and on others
3517 * it will work but it will have an impact on performance.
3519 * In practice, avpkt->data should have 4 byte alignment at minimum.
3521 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3522 * between input and output, these need to be fed with avpkt->data=NULL,
3523 * avpkt->size=0 at the end to return the remaining frames.
3525 * @param avctx the codec context
3526 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3527 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3528 * allocate memory for the actual bitmap.
3529 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3530 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3531 * decodes and the decoder tells the user once it does not need the data anymore,
3532 * the user app can at this point free/reuse/keep the memory as it sees fit.
3534 * @param[in] avpkt The input AVpacket containing the input buffer.
3535 * You can create such packet with av_init_packet() and by then setting
3536 * data and size, some decoders might in addition need other fields like
3537 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3539 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3540 * @return On error a negative value is returned, otherwise the number of bytes
3541 * used or zero if no frame could be decompressed.
3543 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3544 int *got_picture_ptr,
3548 * Decode a subtitle message.
3549 * Return a negative value on error, otherwise return the number of bytes used.
3550 * If no subtitle could be decompressed, got_sub_ptr is zero.
3551 * Otherwise, the subtitle is stored in *sub.
3552 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3553 * simplicity, because the performance difference is expect to be negligible
3554 * and reusing a get_buffer written for video codecs would probably perform badly
3555 * due to a potentially very different allocation pattern.
3557 * @param avctx the codec context
3558 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3559 freed with avsubtitle_free if *got_sub_ptr is set.
3560 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3561 * @param[in] avpkt The input AVPacket containing the input buffer.
3563 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3568 * @defgroup lavc_parsing Frame parsing
3572 typedef struct AVCodecParserContext {
3574 struct AVCodecParser *parser;
3575 int64_t frame_offset; /* offset of the current frame */
3576 int64_t cur_offset; /* current offset
3577 (incremented by each av_parser_parse()) */
3578 int64_t next_frame_offset; /* offset of the next frame */
3580 int pict_type; /* XXX: Put it back in AVCodecContext. */
3582 * This field is used for proper frame duration computation in lavf.
3583 * It signals, how much longer the frame duration of the current frame
3584 * is compared to normal frame duration.
3586 * frame_duration = (1 + repeat_pict) * time_base
3588 * It is used by codecs like H.264 to display telecined material.
3590 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3591 int64_t pts; /* pts of the current frame */
3592 int64_t dts; /* dts of the current frame */
3597 int fetch_timestamp;
3599 #define AV_PARSER_PTS_NB 4
3600 int cur_frame_start_index;
3601 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3602 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3603 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3606 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3607 #define PARSER_FLAG_ONCE 0x0002
3608 /// Set if the parser has a valid file offset
3609 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3611 int64_t offset; ///< byte offset from starting packet start
3612 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3615 * Set by parser to 1 for key frames and 0 for non-key frames.
3616 * It is initialized to -1, so if the parser doesn't set this flag,
3617 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3623 * Time difference in stream time base units from the pts of this
3624 * packet to the point at which the output from the decoder has converged
3625 * independent from the availability of previous frames. That is, the
3626 * frames are virtually identical no matter if decoding started from
3627 * the very first frame or from this keyframe.
3628 * Is AV_NOPTS_VALUE if unknown.
3629 * This field is not the display duration of the current frame.
3630 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3633 * The purpose of this field is to allow seeking in streams that have no
3634 * keyframes in the conventional sense. It corresponds to the
3635 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3636 * essential for some types of subtitle streams to ensure that all
3637 * subtitles are correctly displayed after seeking.
3639 int64_t convergence_duration;
3641 // Timestamp generation support:
3643 * Synchronization point for start of timestamp generation.
3645 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3648 * For example, this corresponds to presence of H.264 buffering period
3654 * Offset of the current timestamp against last timestamp sync point in
3655 * units of AVCodecContext.time_base.
3657 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3658 * contain a valid timestamp offset.
3660 * Note that the timestamp of sync point has usually a nonzero
3661 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3662 * the next frame after timestamp sync point will be usually 1.
3664 * For example, this corresponds to H.264 cpb_removal_delay.
3666 int dts_ref_dts_delta;
3669 * Presentation delay of current frame in units of AVCodecContext.time_base.
3671 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3672 * contain valid non-negative timestamp delta (presentation time of a frame
3673 * must not lie in the past).
3675 * This delay represents the difference between decoding and presentation
3676 * time of the frame.
3678 * For example, this corresponds to H.264 dpb_output_delay.
3683 * Position of the packet in file.
3685 * Analogous to cur_frame_pts/dts
3687 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3690 * Byte position of currently parsed frame in stream.
3695 * Previous frame byte position.
3700 * Duration of the current frame.
3701 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3702 * For all other types, this is in units of AVCodecContext.time_base.
3705 } AVCodecParserContext;
3707 typedef struct AVCodecParser {
3708 int codec_ids[5]; /* several codec IDs are permitted */
3710 int (*parser_init)(AVCodecParserContext *s);
3711 int (*parser_parse)(AVCodecParserContext *s,
3712 AVCodecContext *avctx,
3713 const uint8_t **poutbuf, int *poutbuf_size,
3714 const uint8_t *buf, int buf_size);
3715 void (*parser_close)(AVCodecParserContext *s);
3716 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3717 struct AVCodecParser *next;
3720 AVCodecParser *av_parser_next(AVCodecParser *c);
3722 void av_register_codec_parser(AVCodecParser *parser);
3723 AVCodecParserContext *av_parser_init(int codec_id);
3728 * @param s parser context.
3729 * @param avctx codec context.
3730 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3731 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3732 * @param buf input buffer.
3733 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3734 * @param pts input presentation timestamp.
3735 * @param dts input decoding timestamp.
3736 * @param pos input byte position in stream.
3737 * @return the number of bytes of the input bitstream used.
3742 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3749 * decode_frame(data, size);
3753 int av_parser_parse2(AVCodecParserContext *s,
3754 AVCodecContext *avctx,
3755 uint8_t **poutbuf, int *poutbuf_size,
3756 const uint8_t *buf, int buf_size,
3757 int64_t pts, int64_t dts,
3760 int av_parser_change(AVCodecParserContext *s,
3761 AVCodecContext *avctx,
3762 uint8_t **poutbuf, int *poutbuf_size,
3763 const uint8_t *buf, int buf_size, int keyframe);
3764 void av_parser_close(AVCodecParserContext *s);
3772 * @addtogroup lavc_encoding
3777 * Find a registered encoder with a matching codec ID.
3779 * @param id CodecID of the requested encoder
3780 * @return An encoder if one was found, NULL otherwise.
3782 AVCodec *avcodec_find_encoder(enum CodecID id);
3785 * Find a registered encoder with the specified name.
3787 * @param name name of the requested encoder
3788 * @return An encoder if one was found, NULL otherwise.
3790 AVCodec *avcodec_find_encoder_by_name(const char *name);
3792 #if FF_API_OLD_ENCODE_AUDIO
3794 * Encode an audio frame from samples into buf.
3796 * @deprecated Use avcodec_encode_audio2 instead.
3798 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3799 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3800 * will know how much space is needed because it depends on the value passed
3801 * in buf_size as described below. In that case a lower value can be used.
3803 * @param avctx the codec context
3804 * @param[out] buf the output buffer
3805 * @param[in] buf_size the output buffer size
3806 * @param[in] samples the input buffer containing the samples
3807 * The number of samples read from this buffer is frame_size*channels,
3808 * both of which are defined in avctx.
3809 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3810 * samples read from samples is equal to:
3811 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3812 * This also implies that av_get_bits_per_sample() must not return 0 for these
3814 * @return On error a negative value is returned, on success zero or the number
3815 * of bytes used to encode the data read from the input buffer.
3817 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3818 uint8_t *buf, int buf_size,
3819 const short *samples);
3823 * Encode a frame of audio.
3825 * Takes input samples from frame and writes the next output packet, if
3826 * available, to avpkt. The output packet does not necessarily contain data for
3827 * the most recent frame, as encoders can delay, split, and combine input frames
3828 * internally as needed.
3830 * @param avctx codec context
3831 * @param avpkt output AVPacket.
3832 * The user can supply an output buffer by setting
3833 * avpkt->data and avpkt->size prior to calling the
3834 * function, but if the size of the user-provided data is not
3835 * large enough, encoding will fail. All other AVPacket fields
3836 * will be reset by the encoder using av_init_packet(). If
3837 * avpkt->data is NULL, the encoder will allocate it.
3838 * The encoder will set avpkt->size to the size of the
3841 * If this function fails or produces no output, avpkt will be
3842 * freed using av_free_packet() (i.e. avpkt->destruct will be
3843 * called to free the user supplied buffer).
3844 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3845 * May be NULL when flushing an encoder that has the
3846 * CODEC_CAP_DELAY capability set.
3847 * There are 2 codec capabilities that affect the allowed
3848 * values of frame->nb_samples.
3849 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
3850 * frame may be smaller than avctx->frame_size, and all other
3851 * frames must be equal to avctx->frame_size.
3852 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3853 * can have any number of samples.
3854 * If neither is set, frame->nb_samples must be equal to
3855 * avctx->frame_size for all frames.
3856 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3857 * output packet is non-empty, and to 0 if it is
3858 * empty. If the function returns an error, the
3859 * packet can be assumed to be invalid, and the
3860 * value of got_packet_ptr is undefined and should
3862 * @return 0 on success, negative error code on failure
3864 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3865 const AVFrame *frame, int *got_packet_ptr);
3867 #if FF_API_OLD_ENCODE_VIDEO
3869 * @deprecated use avcodec_encode_video2() instead.
3871 * Encode a video frame from pict into buf.
3872 * The input picture should be
3873 * stored using a specific format, namely avctx.pix_fmt.
3875 * @param avctx the codec context
3876 * @param[out] buf the output buffer for the bitstream of encoded frame
3877 * @param[in] buf_size the size of the output buffer in bytes
3878 * @param[in] pict the input picture to encode
3879 * @return On error a negative value is returned, on success zero or the number
3880 * of bytes used from the output buffer.
3882 attribute_deprecated
3883 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3884 const AVFrame *pict);
3888 * Encode a frame of video.
3890 * Takes input raw video data from frame and writes the next output packet, if
3891 * available, to avpkt. The output packet does not necessarily contain data for
3892 * the most recent frame, as encoders can delay and reorder input frames
3893 * internally as needed.
3895 * @param avctx codec context
3896 * @param avpkt output AVPacket.
3897 * The user can supply an output buffer by setting
3898 * avpkt->data and avpkt->size prior to calling the
3899 * function, but if the size of the user-provided data is not
3900 * large enough, encoding will fail. All other AVPacket fields
3901 * will be reset by the encoder using av_init_packet(). If
3902 * avpkt->data is NULL, the encoder will allocate it.
3903 * The encoder will set avpkt->size to the size of the
3904 * output packet. The returned data (if any) belongs to the
3905 * caller, he is responsible for freeing it.
3907 * If this function fails or produces no output, avpkt will be
3908 * freed using av_free_packet() (i.e. avpkt->destruct will be
3909 * called to free the user supplied buffer).
3910 * @param[in] frame AVFrame containing the raw video data to be encoded.
3911 * May be NULL when flushing an encoder that has the
3912 * CODEC_CAP_DELAY capability set.
3913 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3914 * output packet is non-empty, and to 0 if it is
3915 * empty. If the function returns an error, the
3916 * packet can be assumed to be invalid, and the
3917 * value of got_packet_ptr is undefined and should
3919 * @return 0 on success, negative error code on failure
3921 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3922 const AVFrame *frame, int *got_packet_ptr);
3924 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3925 const AVSubtitle *sub);
3933 * @defgroup lavc_resample Audio resampling
3938 struct ReSampleContext;
3939 struct AVResampleContext;
3941 typedef struct ReSampleContext ReSampleContext;
3944 * Initialize audio resampling context.
3946 * @param output_channels number of output channels
3947 * @param input_channels number of input channels
3948 * @param output_rate output sample rate
3949 * @param input_rate input sample rate
3950 * @param sample_fmt_out requested output sample format
3951 * @param sample_fmt_in input sample format
3952 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3953 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3954 * @param linear if 1 then the used FIR filter will be linearly interpolated
3955 between the 2 closest, if 0 the closest will be used
3956 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3957 * @return allocated ReSampleContext, NULL if error occurred
3959 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3960 int output_rate, int input_rate,
3961 enum AVSampleFormat sample_fmt_out,
3962 enum AVSampleFormat sample_fmt_in,
3963 int filter_length, int log2_phase_count,
3964 int linear, double cutoff);
3966 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3969 * Free resample context.
3971 * @param s a non-NULL pointer to a resample context previously
3972 * created with av_audio_resample_init()
3974 void audio_resample_close(ReSampleContext *s);
3978 * Initialize an audio resampler.
3979 * Note, if either rate is not an integer then simply scale both rates up so they are.
3980 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3981 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3982 * @param linear If 1 then the used FIR filter will be linearly interpolated
3983 between the 2 closest, if 0 the closest will be used
3984 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3986 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3989 * Resample an array of samples using a previously configured context.
3990 * @param src an array of unconsumed samples
3991 * @param consumed the number of samples of src which have been consumed are returned here
3992 * @param src_size the number of unconsumed samples available
3993 * @param dst_size the amount of space in samples available in dst
3994 * @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.
3995 * @return the number of samples written in dst or -1 if an error occurred
3997 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4001 * Compensate samplerate/timestamp drift. The compensation is done by changing
4002 * the resampler parameters, so no audible clicks or similar distortions occur
4003 * @param compensation_distance distance in output samples over which the compensation should be performed
4004 * @param sample_delta number of output samples which should be output less
4006 * example: av_resample_compensate(c, 10, 500)
4007 * here instead of 510 samples only 500 samples would be output
4009 * note, due to rounding the actual compensation might be slightly different,
4010 * especially if the compensation_distance is large and the in_rate used during init is small
4012 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4013 void av_resample_close(struct AVResampleContext *c);
4020 * @addtogroup lavc_picture
4025 * Allocate memory for a picture. Call avpicture_free() to free it.
4027 * @see avpicture_fill()
4029 * @param picture the picture to be filled in
4030 * @param pix_fmt the format of the picture
4031 * @param width the width of the picture
4032 * @param height the height of the picture
4033 * @return zero if successful, a negative value if not
4035 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
4038 * Free a picture previously allocated by avpicture_alloc().
4039 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4042 * @param picture the AVPicture to be freed
4044 void avpicture_free(AVPicture *picture);
4047 * Fill in the AVPicture fields.
4048 * The fields of the given AVPicture are filled in by using the 'ptr' address
4049 * which points to the image data buffer. Depending on the specified picture
4050 * format, one or multiple image data pointers and line sizes will be set.
4051 * If a planar format is specified, several pointers will be set pointing to
4052 * the different picture planes and the line sizes of the different planes
4053 * will be stored in the lines_sizes array.
4054 * Call with ptr == NULL to get the required size for the ptr buffer.
4056 * To allocate the buffer and fill in the AVPicture fields in one call,
4057 * use avpicture_alloc().
4059 * @param picture AVPicture whose fields are to be filled in
4060 * @param ptr Buffer which will contain or contains the actual image data
4061 * @param pix_fmt The format in which the picture data is stored.
4062 * @param width the width of the image in pixels
4063 * @param height the height of the image in pixels
4064 * @return size of the image data in bytes
4066 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4067 enum PixelFormat pix_fmt, int width, int height);
4070 * Copy pixel data from an AVPicture into a buffer.
4071 * The data is stored compactly, without any gaps for alignment or padding
4072 * which may be applied by avpicture_fill().
4074 * @see avpicture_get_size()
4076 * @param[in] src AVPicture containing image data
4077 * @param[in] pix_fmt The format in which the picture data is stored.
4078 * @param[in] width the width of the image in pixels.
4079 * @param[in] height the height of the image in pixels.
4080 * @param[out] dest A buffer into which picture data will be copied.
4081 * @param[in] dest_size The size of 'dest'.
4082 * @return The number of bytes written to dest, or a negative value (error code) on error.
4084 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
4085 unsigned char *dest, int dest_size);
4088 * Calculate the size in bytes that a picture of the given width and height
4089 * would occupy if stored in the given picture format.
4090 * Note that this returns the size of a compact representation as generated
4091 * by avpicture_layout(), which can be smaller than the size required for e.g.
4094 * @param pix_fmt the given picture format
4095 * @param width the width of the image
4096 * @param height the height of the image
4097 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
4099 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
4102 * deinterlace - if not supported return -1
4104 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4105 enum PixelFormat pix_fmt, int width, int height);
4107 * Copy image src to dst. Wraps av_picture_data_copy() above.
4109 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4110 enum PixelFormat pix_fmt, int width, int height);
4113 * Crop image top and left side.
4115 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4116 enum PixelFormat pix_fmt, int top_band, int left_band);
4121 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4122 int padtop, int padbottom, int padleft, int padright, int *color);
4128 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
4130 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4133 * Return a value representing the fourCC code associated to the
4134 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4137 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
4140 * Put a string representing the codec tag codec_tag in buf.
4142 * @param buf_size size in bytes of buf
4143 * @return the length of the string that would have been generated if
4144 * enough space had been available, excluding the trailing null
4146 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4148 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4149 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4150 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4151 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4152 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4153 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4156 * Compute what kind of losses will occur when converting from one specific
4157 * pixel format to another.
4158 * When converting from one pixel format to another, information loss may occur.
4159 * For example, when converting from RGB24 to GRAY, the color information will
4160 * be lost. Similarly, other losses occur when converting from some formats to
4161 * other formats. These losses can involve loss of chroma, but also loss of
4162 * resolution, loss of color depth, loss due to the color space conversion, loss
4163 * of the alpha bits or loss due to color quantization.
4164 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4165 * which will occur when converting from one pixel format to another.
4167 * @param[in] dst_pix_fmt destination pixel format
4168 * @param[in] src_pix_fmt source pixel format
4169 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4170 * @return Combination of flags informing you what kind of losses will occur.
4172 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
4176 * Find the best pixel format to convert to given a certain source pixel
4177 * format. When converting from one pixel format to another, information loss
4178 * may occur. For example, when converting from RGB24 to GRAY, the color
4179 * information will be lost. Similarly, other losses occur when converting from
4180 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4181 * the given pixel formats should be used to suffer the least amount of loss.
4182 * The pixel formats from which it chooses one, are determined by the
4183 * pix_fmt_mask parameter.
4186 * src_pix_fmt = PIX_FMT_YUV420P;
4187 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
4188 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4191 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4192 * @param[in] src_pix_fmt source pixel format
4193 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4194 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4195 * @return The best pixel format to convert to or -1 if none was found.
4197 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
4198 int has_alpha, int *loss_ptr);
4200 /* external high level API */
4202 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4205 * Return a name for the specified profile, if available.
4207 * @param codec the codec that is searched for the given profile
4208 * @param profile the profile value for which a name is requested
4209 * @return A name for the profile if found, NULL otherwise.
4211 const char *av_get_profile_name(const AVCodec *codec, int profile);
4213 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4215 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4216 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4217 //FIXME func typedef
4220 * Fill audio frame data and linesize.
4221 * AVFrame extended_data channel pointers are allocated if necessary for
4224 * @param frame the AVFrame
4225 * frame->nb_samples must be set prior to calling the
4226 * function. This function fills in frame->data,
4227 * frame->extended_data, frame->linesize[0].
4228 * @param nb_channels channel count
4229 * @param sample_fmt sample format
4230 * @param buf buffer to use for frame data
4231 * @param buf_size size of buffer
4232 * @param align plane size sample alignment (0 = default)
4233 * @return 0 on success, negative error code on failure
4235 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4236 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4237 int buf_size, int align);
4240 * Flush buffers, should be called when seeking or when switching to a different stream.
4242 void avcodec_flush_buffers(AVCodecContext *avctx);
4244 void avcodec_default_free_buffers(AVCodecContext *s);
4246 /* misc useful functions */
4249 * Return codec bits per sample.
4251 * @param[in] codec_id the codec
4252 * @return Number of bits per sample or zero if unknown for the given codec.
4254 int av_get_bits_per_sample(enum CodecID codec_id);
4257 * Return codec bits per sample.
4258 * Only return non-zero if the bits per sample is exactly correct, not an
4261 * @param[in] codec_id the codec
4262 * @return Number of bits per sample or zero if unknown for the given codec.
4264 int av_get_exact_bits_per_sample(enum CodecID codec_id);
4267 * Return audio frame duration.
4269 * @param avctx codec context
4270 * @param frame_bytes size of the frame, or 0 if unknown
4271 * @return frame duration, in samples, if known. 0 if not able to
4274 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4277 typedef struct AVBitStreamFilterContext {
4279 struct AVBitStreamFilter *filter;
4280 AVCodecParserContext *parser;
4281 struct AVBitStreamFilterContext *next;
4282 } AVBitStreamFilterContext;
4285 typedef struct AVBitStreamFilter {
4288 int (*filter)(AVBitStreamFilterContext *bsfc,
4289 AVCodecContext *avctx, const char *args,
4290 uint8_t **poutbuf, int *poutbuf_size,
4291 const uint8_t *buf, int buf_size, int keyframe);
4292 void (*close)(AVBitStreamFilterContext *bsfc);
4293 struct AVBitStreamFilter *next;
4294 } AVBitStreamFilter;
4296 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4297 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4298 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4299 AVCodecContext *avctx, const char *args,
4300 uint8_t **poutbuf, int *poutbuf_size,
4301 const uint8_t *buf, int buf_size, int keyframe);
4302 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4304 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4309 * Reallocate the given block if it is not large enough, otherwise do nothing.
4313 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4316 * Allocate a buffer, reusing the given one if large enough.
4318 * Contrary to av_fast_realloc the current buffer contents might not be
4319 * preserved and on error the old buffer is freed, thus no special
4320 * handling to avoid memleaks is necessary.
4322 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4323 * @param size size of the buffer *ptr points to
4324 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4325 * *size 0 if an error occurred.
4327 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4330 * Allocate a buffer with padding, reusing the given one if large enough.
4332 * Same behaviour av_fast_malloc but the buffer has additional
4333 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4336 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4339 * Encode extradata length to a buffer. Used by xiph codecs.
4341 * @param s buffer to write to; must be at least (v/255+1) bytes long
4342 * @param v size of extradata in bytes
4343 * @return number of bytes written to the buffer.
4345 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4348 * Log a generic warning message about a missing feature. This function is
4349 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4350 * only, and would normally not be used by applications.
4351 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4352 * a pointer to an AVClass struct
4353 * @param[in] feature string containing the name of the missing feature
4354 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4355 * If want_sample is non-zero, additional verbage will be added to the log
4356 * message which tells the user how to report samples to the development
4359 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4362 * Log a generic warning message asking for a sample. This function is
4363 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4364 * only, and would normally not be used by applications.
4365 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4366 * a pointer to an AVClass struct
4367 * @param[in] msg string containing an optional message, or NULL if no message
4369 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4372 * Register the hardware accelerator hwaccel.
4374 void av_register_hwaccel(AVHWAccel *hwaccel);
4377 * If hwaccel is NULL, returns the first registered hardware accelerator,
4378 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4379 * after hwaccel, or NULL if hwaccel is the last one.
4381 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4385 * Lock operation used by lockmgr
4388 AV_LOCK_CREATE, ///< Create a mutex
4389 AV_LOCK_OBTAIN, ///< Lock the mutex
4390 AV_LOCK_RELEASE, ///< Unlock the mutex
4391 AV_LOCK_DESTROY, ///< Free mutex resources
4395 * Register a user provided lock manager supporting the operations
4396 * specified by AVLockOp. mutex points to a (void *) where the
4397 * lockmgr should store/get a pointer to a user allocated mutex. It's
4398 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4400 * @param cb User defined callback. Note: Libav may invoke calls to this
4401 * callback during the call to av_lockmgr_register().
4402 * Thus, the application must be prepared to handle that.
4403 * If cb is set to NULL the lockmgr will be unregistered.
4404 * Also note that during unregistration the previously registered
4405 * lockmgr callback may also be invoked.
4407 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4410 * Get the type of the given codec.
4412 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4415 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4416 * with no corresponding avcodec_close()), 0 otherwise.
4418 int avcodec_is_open(AVCodecContext *s);
4421 * @return a non-zero number if codec is an encoder, zero otherwise
4423 int av_codec_is_encoder(AVCodec *codec);
4426 * @return a non-zero number if codec is a decoder, zero otherwise
4428 int av_codec_is_decoder(AVCodec *codec);
4430 #endif /* AVCODEC_AVCODEC_H */