2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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"
37 #include "libavutil/audioconvert.h"
39 #include "libavcodec/version.h"
41 * @defgroup libavc Encoding/Decoding Library
44 * @defgroup lavc_decoding Decoding
48 * @defgroup lavc_encoding Encoding
52 * @defgroup lavc_codec Codecs
54 * @defgroup lavc_codec_native Native Codecs
57 * @defgroup lavc_codec_wrappers External library wrappers
60 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
64 * @defgroup lavc_internal Internal
73 * Identify the syntax and semantics of the bitstream.
74 * The principle is roughly:
75 * Two decoders with the same ID can decode the same streams.
76 * Two encoders with the same ID can encode compatible streams.
77 * There may be slight deviations from the principle due to implementation
80 * If you add a codec ID to this list, add it so that
81 * 1. no value of a existing codec ID changes (that would break ABI),
82 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
83 * This ensures that 2 forks can independently add CodecIDs without producing conflicts.
90 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
91 CODEC_ID_MPEG2VIDEO_XVMC,
128 CODEC_ID_INTERPLAY_VIDEO,
140 CODEC_ID_TRUEMOTION1,
167 CODEC_ID_TRUEMOTION2,
184 CODEC_ID_DSICINVIDEO,
185 CODEC_ID_TIERTEXSEQVIDEO,
193 CODEC_ID_BETHSOFTVID,
209 CODEC_ID_MOTIONPIXELS,
227 CODEC_ID_IFF_BYTERUN1,
252 CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
253 CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
254 CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
256 CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
257 CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
258 CODEC_ID_V308 = MKBETAG('V','3','0','8'),
259 CODEC_ID_V408 = MKBETAG('V','4','0','8'),
260 CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
262 /* various PCM "codecs" */
263 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
264 CODEC_ID_PCM_S16LE = 0x10000,
280 CODEC_ID_PCM_S24DAUD,
282 CODEC_ID_PCM_S16LE_PLANAR,
291 CODEC_ID_PCM_S8_PLANAR,
293 /* various ADPCM codecs */
294 CODEC_ID_ADPCM_IMA_QT = 0x11000,
295 CODEC_ID_ADPCM_IMA_WAV,
296 CODEC_ID_ADPCM_IMA_DK3,
297 CODEC_ID_ADPCM_IMA_DK4,
298 CODEC_ID_ADPCM_IMA_WS,
299 CODEC_ID_ADPCM_IMA_SMJPEG,
308 CODEC_ID_ADPCM_YAMAHA,
309 CODEC_ID_ADPCM_SBPRO_4,
310 CODEC_ID_ADPCM_SBPRO_3,
311 CODEC_ID_ADPCM_SBPRO_2,
313 CODEC_ID_ADPCM_IMA_AMV,
314 CODEC_ID_ADPCM_EA_R1,
315 CODEC_ID_ADPCM_EA_R3,
316 CODEC_ID_ADPCM_EA_R2,
317 CODEC_ID_ADPCM_IMA_EA_SEAD,
318 CODEC_ID_ADPCM_IMA_EA_EACS,
319 CODEC_ID_ADPCM_EA_XAS,
320 CODEC_ID_ADPCM_EA_MAXIS_XA,
321 CODEC_ID_ADPCM_IMA_ISS,
323 CODEC_ID_ADPCM_IMA_APC,
326 CODEC_ID_AMR_NB = 0x12000,
329 /* RealAudio codecs*/
330 CODEC_ID_RA_144 = 0x13000,
333 /* various DPCM codecs */
334 CODEC_ID_ROQ_DPCM = 0x14000,
335 CODEC_ID_INTERPLAY_DPCM,
340 CODEC_ID_MP2 = 0x15000,
341 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
357 CODEC_ID_WESTWOOD_SND1,
358 CODEC_ID_GSM, ///< as in Berlin toast format
366 CODEC_ID_DSICINAUDIO,
370 CODEC_ID_GSM_MS, /* as found in WAV */
379 CODEC_ID_WMALOSSLESS,
388 CODEC_ID_BINKAUDIO_RDFT,
389 CODEC_ID_BINKAUDIO_DCT,
399 CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
400 CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
401 CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
402 CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
404 /* subtitle codecs */
405 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
406 CODEC_ID_DVD_SUBTITLE = 0x17000,
407 CODEC_ID_DVB_SUBTITLE,
408 CODEC_ID_TEXT, ///< raw UTF-8 text
412 CODEC_ID_HDMV_PGS_SUBTITLE,
413 CODEC_ID_DVB_TELETEXT,
415 CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
417 /* other specific kind of codecs (generally used for attachments) */
418 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
419 CODEC_ID_TTF = 0x18000,
420 CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
421 CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
422 CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
424 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
426 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
427 * stream (only used by libavformat) */
428 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
429 * stream (only used by libavformat) */
430 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
433 #if FF_API_OLD_DECODE_AUDIO
435 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
439 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
440 * This is mainly needed because some optimized bitstream readers read
441 * 32 or 64 bit at once and could read over the end.<br>
442 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
443 * MPEG bitstreams could cause overread and segfault.
445 #define FF_INPUT_BUFFER_PADDING_SIZE 16
448 * minimum encoding buffer size
449 * Used to avoid some checks during header writing.
451 #define FF_MIN_BUFFER_SIZE 16384
455 * motion estimation type.
458 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
462 ME_EPZS, ///< enhanced predictive zonal search
463 ME_X1, ///< reserved for experiments
464 ME_HEX, ///< hexagon based search
465 ME_UMH, ///< uneven multi-hexagon search
466 ME_ITER, ///< iterative search
467 ME_TESA, ///< transformed exhaustive search algorithm
471 /* We leave some space between them for extensions (drop some
472 * keyframes for intra-only or drop just some bidir frames). */
473 AVDISCARD_NONE =-16, ///< discard nothing
474 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
475 AVDISCARD_NONREF = 8, ///< discard all non reference
476 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
477 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
478 AVDISCARD_ALL = 48, ///< discard all
481 enum AVColorPrimaries{
482 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
483 AVCOL_PRI_UNSPECIFIED=2,
485 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
486 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
487 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
489 AVCOL_PRI_NB , ///< Not part of ABI
492 enum AVColorTransferCharacteristic{
493 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
494 AVCOL_TRC_UNSPECIFIED=2,
495 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
496 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
497 AVCOL_TRC_SMPTE240M =7,
498 AVCOL_TRC_NB , ///< Not part of ABI
503 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
504 AVCOL_SPC_UNSPECIFIED=2,
506 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
507 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
508 AVCOL_SPC_SMPTE240M =7,
510 AVCOL_SPC_NB , ///< Not part of ABI
514 AVCOL_RANGE_UNSPECIFIED=0,
515 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
516 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
517 AVCOL_RANGE_NB , ///< Not part of ABI
521 * X X 3 4 X X are luma samples,
522 * 1 2 1-6 are possible chroma positions
523 * X X 5 6 X 0 is undefined/unknown position
525 enum AVChromaLocation{
526 AVCHROMA_LOC_UNSPECIFIED=0,
527 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
528 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
529 AVCHROMA_LOC_TOPLEFT =3, ///< DV
531 AVCHROMA_LOC_BOTTOMLEFT =5,
532 AVCHROMA_LOC_BOTTOM =6,
533 AVCHROMA_LOC_NB , ///< Not part of ABI
536 enum AVAudioServiceType {
537 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
538 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
539 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
540 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
541 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
542 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
543 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
544 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
545 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
546 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
549 typedef struct RcOverride{
552 int qscale; // If this is 0 then quality_factor will be used instead.
553 float quality_factor;
556 #define FF_MAX_B_FRAMES 16
559 These flags can be passed in AVCodecContext.flags before initialization.
560 Note: Not everything is supported yet.
563 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
564 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
565 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
566 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
567 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
569 * The parent program guarantees that the input for B-frames containing
570 * streams is not written to for at least s->max_b_frames+1 frames, if
571 * this is not set the input will be copied.
573 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
574 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
575 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
576 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
577 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
578 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
579 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
580 location instead of only at frame boundaries. */
581 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
582 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
583 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
584 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
585 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
586 /* Fx : Flag for h263+ extra options */
587 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
588 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
589 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
590 #define CODEC_FLAG_CLOSED_GOP 0x80000000
591 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
592 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
593 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
594 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
595 #if FF_API_MPV_GLOBAL_OPTS
596 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
597 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
598 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
599 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
601 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
602 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
604 /* Unsupported options :
605 * Syntax Arithmetic coding (SAC)
606 * Reference Picture Selection
607 * Independent Segment Decoding */
609 /* codec capabilities */
611 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
613 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
614 * If not set, it might not use get_buffer() at all or use operations that
615 * assume the buffer was allocated by avcodec_default_get_buffer.
617 #define CODEC_CAP_DR1 0x0002
618 #define CODEC_CAP_TRUNCATED 0x0008
619 /* Codec can export data for HW decoding (XvMC). */
620 #define CODEC_CAP_HWACCEL 0x0010
622 * Encoder or decoder requires flushing with NULL input at the end in order to
623 * give the complete and correct output.
625 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
626 * with NULL data. The user can still send NULL data to the public encode
627 * or decode function, but libavcodec will not pass it along to the codec
628 * unless this flag is set.
631 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
632 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
636 * The encoder needs to be fed with NULL data at the end of encoding until the
637 * encoder no longer returns data.
639 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
640 * flag also means that the encoder must set the pts and duration for
641 * each output packet. If this flag is not set, the pts and duration will
642 * be determined by libavcodec from the input frame.
644 #define CODEC_CAP_DELAY 0x0020
646 * Codec can be fed a final frame with a smaller size.
647 * This can be used to prevent truncation of the last audio samples.
649 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
651 * Codec can export data for HW decoding (VDPAU).
653 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
655 * Codec can output multiple frames per AVPacket
656 * Normally demuxers return one frame at a time, demuxers which do not do
657 * are connected to a parser to split what they return into proper frames.
658 * This flag is reserved to the very rare category of codecs which have a
659 * bitstream that cannot be split into frames without timeconsuming
660 * operations like full decoding. Demuxers carring such bitstreams thus
661 * may return multiple frames in a packet. This has many disadvantages like
662 * prohibiting stream copy in many cases thus it should only be considered
665 #define CODEC_CAP_SUBFRAMES 0x0100
667 * Codec is experimental and is thus avoided in favor of non experimental
670 #define CODEC_CAP_EXPERIMENTAL 0x0200
672 * Codec should fill in channel configuration and samplerate instead of container
674 #define CODEC_CAP_CHANNEL_CONF 0x0400
677 * Codec is able to deal with negative linesizes
679 #define CODEC_CAP_NEG_LINESIZES 0x0800
682 * Codec supports frame-level multithreading.
684 #define CODEC_CAP_FRAME_THREADS 0x1000
686 * Codec supports slice-based (or partition-based) multithreading.
688 #define CODEC_CAP_SLICE_THREADS 0x2000
690 * Codec supports changed parameters at any point.
692 #define CODEC_CAP_PARAM_CHANGE 0x4000
694 * Codec supports avctx->thread_count == 0 (auto).
696 #define CODEC_CAP_AUTO_THREADS 0x8000
698 * Audio encoder supports receiving a different number of samples in each call.
700 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
704 #define CODEC_CAP_LOSSLESS 0x80000000
706 //The following defines may change, don't expect compatibility if you use them.
707 #define MB_TYPE_INTRA4x4 0x0001
708 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
709 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
710 #define MB_TYPE_16x16 0x0008
711 #define MB_TYPE_16x8 0x0010
712 #define MB_TYPE_8x16 0x0020
713 #define MB_TYPE_8x8 0x0040
714 #define MB_TYPE_INTERLACED 0x0080
715 #define MB_TYPE_DIRECT2 0x0100 //FIXME
716 #define MB_TYPE_ACPRED 0x0200
717 #define MB_TYPE_GMC 0x0400
718 #define MB_TYPE_SKIP 0x0800
719 #define MB_TYPE_P0L0 0x1000
720 #define MB_TYPE_P1L0 0x2000
721 #define MB_TYPE_P0L1 0x4000
722 #define MB_TYPE_P1L1 0x8000
723 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
724 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
725 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
726 #define MB_TYPE_QUANT 0x00010000
727 #define MB_TYPE_CBP 0x00020000
728 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
732 * This specifies the area which should be displayed.
733 * Note there may be multiple such areas for one frame.
735 typedef struct AVPanScan{
738 * - encoding: Set by user.
739 * - decoding: Set by libavcodec.
744 * width and height in 1/16 pel
745 * - encoding: Set by user.
746 * - decoding: Set by libavcodec.
752 * position of the top left corner in 1/16 pel for up to 3 fields/frames
753 * - encoding: Set by user.
754 * - decoding: Set by libavcodec.
756 int16_t position[3][2];
759 #define FF_QSCALE_TYPE_MPEG1 0
760 #define FF_QSCALE_TYPE_MPEG2 1
761 #define FF_QSCALE_TYPE_H264 2
762 #define FF_QSCALE_TYPE_VP56 3
764 #define FF_BUFFER_TYPE_INTERNAL 1
765 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
766 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
767 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
769 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
770 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
771 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
772 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
774 enum AVPacketSideDataType {
776 AV_PKT_DATA_NEW_EXTRADATA,
777 AV_PKT_DATA_PARAM_CHANGE,
778 AV_PKT_DATA_H263_MB_INFO,
781 typedef struct AVPacket {
783 * Presentation timestamp in AVStream->time_base units; the time at which
784 * the decompressed packet will be presented to the user.
785 * Can be AV_NOPTS_VALUE if it is not stored in the file.
786 * pts MUST be larger or equal to dts as presentation cannot happen before
787 * decompression, unless one wants to view hex dumps. Some formats misuse
788 * the terms dts and pts/cts to mean something different. Such timestamps
789 * must be converted to true pts/dts before they are stored in AVPacket.
793 * Decompression timestamp in AVStream->time_base units; the time at which
794 * the packet is decompressed.
795 * Can be AV_NOPTS_VALUE if it is not stored in the file.
802 * A combination of AV_PKT_FLAG values
806 * Additional packet data that can be provided by the container.
807 * Packet can contain several types of side information.
812 enum AVPacketSideDataType type;
817 * Duration of this packet in AVStream->time_base units, 0 if unknown.
818 * Equals next_pts - this_pts in presentation order.
821 void (*destruct)(struct AVPacket *);
823 int64_t pos; ///< byte position in stream, -1 if unknown
826 * Time difference in AVStream->time_base units from the pts of this
827 * packet to the point at which the output from the decoder has converged
828 * independent from the availability of previous frames. That is, the
829 * frames are virtually identical no matter if decoding started from
830 * the very first frame or from this keyframe.
831 * Is AV_NOPTS_VALUE if unknown.
832 * This field is not the display duration of the current packet.
833 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
836 * The purpose of this field is to allow seeking in streams that have no
837 * keyframes in the conventional sense. It corresponds to the
838 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
839 * essential for some types of subtitle streams to ensure that all
840 * subtitles are correctly displayed after seeking.
842 int64_t convergence_duration;
844 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
845 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
848 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
850 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
851 * s32le channel_count
852 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
853 * u64le channel_layout
854 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
856 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
862 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
863 * structures with info about macroblocks relevant to splitting the
864 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
865 * That is, it does not necessarily contain info about all macroblocks,
866 * as long as the distance between macroblocks in the info is smaller
867 * than the target payload size.
868 * Each MB info structure is 12 bytes, and is laid out as follows:
869 * u32le bit offset from the start of the packet
870 * u8 current quantizer at the start of the macroblock
872 * u16le macroblock address within the GOB
873 * u8 horizontal MV predictor
874 * u8 vertical MV predictor
875 * u8 horizontal MV predictor for block number 3
876 * u8 vertical MV predictor for block number 3
879 enum AVSideDataParamChangeFlags {
880 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
881 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
882 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
883 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
888 * New fields can be added to the end of AVFRAME with minor version
889 * bumps. Similarly fields that are marked as to be only accessed by
890 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
891 * without breaking compatibility with each other.
892 * Removal, reordering and changes in the remaining cases require
893 * a major version bump.
894 * sizeof(AVFrame) must not be used outside libavcodec.
896 typedef struct AVFrame {
897 #define AV_NUM_DATA_POINTERS 8
899 * pointer to the picture/channel planes.
900 * This might be different from the first allocated byte
901 * - encoding: Set by user
902 * - decoding: set by AVCodecContext.get_buffer()
904 uint8_t *data[AV_NUM_DATA_POINTERS];
907 * Size, in bytes, of the data for each picture/channel plane.
909 * For audio, only linesize[0] may be set. For planar audio, each channel
910 * plane must be the same size.
912 * - encoding: Set by user
913 * - decoding: set by AVCodecContext.get_buffer()
915 int linesize[AV_NUM_DATA_POINTERS];
918 * pointers to the data planes/channels.
920 * For video, this should simply point to data[].
922 * For planar audio, each channel has a separate data pointer, and
923 * linesize[0] contains the size of each channel buffer.
924 * For packed audio, there is just one data pointer, and linesize[0]
925 * contains the total size of the buffer for all channels.
927 * Note: Both data and extended_data will always be set by get_buffer(),
928 * but for planar audio with more channels that can fit in data,
929 * extended_data must be used by the decoder in order to access all
933 * decoding: set by AVCodecContext.get_buffer()
935 uint8_t **extended_data;
938 * width and height of the video frame
940 * - decoding: Read by user.
945 * number of audio samples (per channel) described by this frame
946 * - encoding: Set by user
947 * - decoding: Set by libavcodec
952 * format of the frame, -1 if unknown or unset
953 * Values correspond to enum PixelFormat for video frames,
954 * enum AVSampleFormat for audio)
956 * - decoding: Read by user.
961 * 1 -> keyframe, 0-> not
962 * - encoding: Set by libavcodec.
963 * - decoding: Set by libavcodec.
968 * Picture type of the frame, see ?_TYPE below.
969 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
970 * - decoding: Set by libavcodec.
972 enum AVPictureType pict_type;
975 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
976 * This isn't used by libavcodec unless the default get/release_buffer() is used.
980 uint8_t *base[AV_NUM_DATA_POINTERS];
983 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
985 * - decoding: Read by user.
987 AVRational sample_aspect_ratio;
990 * presentation timestamp in time_base units (time when frame should be shown to user)
991 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
992 * - encoding: MUST be set by user.
993 * - decoding: Set by libavcodec.
998 * reordered pts from the last AVPacket that has been input into the decoder
1000 * - decoding: Read by user.
1005 * dts from the last AVPacket that has been input into the decoder
1006 * - encoding: unused
1007 * - decoding: Read by user.
1012 * picture number in bitstream order
1013 * - encoding: set by
1014 * - decoding: Set by libavcodec.
1016 int coded_picture_number;
1018 * picture number in display order
1019 * - encoding: set by
1020 * - decoding: Set by libavcodec.
1022 int display_picture_number;
1025 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1026 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1027 * - decoding: Set by libavcodec.
1032 * is this picture used as reference
1033 * The values for this are the same as the MpegEncContext.picture_structure
1034 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1035 * Set to 4 for delayed, non-reference frames.
1036 * - encoding: unused
1037 * - decoding: Set by libavcodec. (before get_buffer() call)).
1043 * - encoding: unused
1044 * - decoding: Set by libavcodec.
1046 int8_t *qscale_table;
1049 * - encoding: unused
1050 * - decoding: Set by libavcodec.
1060 * mbskip_table[mb]>=1 if MB didn't change
1061 * stride= mb_width = (width+15)>>4
1062 * - encoding: unused
1063 * - decoding: Set by libavcodec.
1065 uint8_t *mbskip_table;
1068 * motion vector table
1071 * int mv_sample_log2= 4 - motion_subsample_log2;
1072 * int mb_width= (width+15)>>4;
1073 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1074 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1076 * - encoding: Set by user.
1077 * - decoding: Set by libavcodec.
1079 int16_t (*motion_val[2])[2];
1082 * macroblock type table
1083 * mb_type_base + mb_width + 2
1084 * - encoding: Set by user.
1085 * - decoding: Set by libavcodec.
1091 * - encoding: unused
1092 * - decoding: Set by libavcodec.
1097 * motion reference frame index
1098 * the order in which these are stored can depend on the codec.
1099 * - encoding: Set by user.
1100 * - decoding: Set by libavcodec.
1102 int8_t *ref_index[2];
1105 * for some private data of the user
1106 * - encoding: unused
1107 * - decoding: Set by user.
1113 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1114 * - decoding: unused
1116 uint64_t error[AV_NUM_DATA_POINTERS];
1119 * type of the buffer (to keep track of who has to deallocate data[*])
1120 * - encoding: Set by the one who allocates it.
1121 * - decoding: Set by the one who allocates it.
1122 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1127 * When decoding, this signals how much the picture must be delayed.
1128 * extra_delay = repeat_pict / (2*fps)
1129 * - encoding: unused
1130 * - decoding: Set by libavcodec.
1135 * The content of the picture is interlaced.
1136 * - encoding: Set by user.
1137 * - decoding: Set by libavcodec. (default 0)
1139 int interlaced_frame;
1142 * If the content is interlaced, is top field displayed first.
1143 * - encoding: Set by user.
1144 * - decoding: Set by libavcodec.
1146 int top_field_first;
1149 * Tell user application that palette has changed from previous frame.
1150 * - encoding: ??? (no palette-enabled encoder yet)
1151 * - decoding: Set by libavcodec. (default 0).
1153 int palette_has_changed;
1156 * codec suggestion on buffer type if != 0
1157 * - encoding: unused
1158 * - decoding: Set by libavcodec. (before get_buffer() call)).
1164 * - encoding: Set by user.
1165 * - decoding: Set by libavcodec.
1167 AVPanScan *pan_scan;
1170 * reordered opaque 64bit (generally an integer or a double precision float
1171 * PTS but can be anything).
1172 * The user sets AVCodecContext.reordered_opaque to represent the input at
1174 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1175 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1176 * @deprecated in favor of pkt_pts
1177 * - encoding: unused
1178 * - decoding: Read by user.
1180 int64_t reordered_opaque;
1183 * hardware accelerator private data (FFmpeg-allocated)
1184 * - encoding: unused
1185 * - decoding: Set by libavcodec
1187 void *hwaccel_picture_private;
1190 * the AVCodecContext which ff_thread_get_buffer() was last called on
1191 * - encoding: Set by libavcodec.
1192 * - decoding: Set by libavcodec.
1194 struct AVCodecContext *owner;
1197 * used by multithreading to store frame-specific info
1198 * - encoding: Set by libavcodec.
1199 * - decoding: Set by libavcodec.
1201 void *thread_opaque;
1204 * log2 of the size of the block which a single vector in motion_val represents:
1205 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1206 * - encoding: unused
1207 * - decoding: Set by libavcodec.
1209 uint8_t motion_subsample_log2;
1212 * frame timestamp estimated using various heuristics, in stream time base
1213 * Code outside libavcodec should access this field using:
1214 * av_opt_ptr(avcodec_get_frame_class(), frame, "best_effort_timestamp");
1215 * - encoding: unused
1216 * - decoding: set by libavcodec, read by user.
1218 int64_t best_effort_timestamp;
1221 * reordered pos from the last AVPacket that has been input into the decoder
1222 * Code outside libavcodec should access this field using:
1223 * av_opt_ptr(avcodec_get_frame_class(), frame, "pkt_pos");
1224 * - encoding: unused
1225 * - decoding: Read by user.
1230 struct AVCodecInternal;
1234 AV_FIELD_PROGRESSIVE,
1235 AV_FIELD_TT, //< Top coded_first, top displayed first
1236 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1237 AV_FIELD_TB, //< Top coded first, bottom displayed first
1238 AV_FIELD_BT, //< Bottom coded first, top displayed first
1242 * main external API structure.
1243 * New fields can be added to the end with minor version bumps.
1244 * Removal, reordering and changes to existing fields require a major
1246 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1248 * sizeof(AVCodecContext) must not be used outside libav*.
1250 typedef struct AVCodecContext {
1252 * information on struct for av_log
1253 * - set by avcodec_alloc_context3
1255 const AVClass *av_class;
1256 int log_level_offset;
1258 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1259 struct AVCodec *codec;
1260 char codec_name[32];
1261 enum CodecID codec_id; /* see CODEC_ID_xxx */
1264 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1265 * This is used to work around some encoder bugs.
1266 * A demuxer should set this to what is stored in the field used to identify the codec.
1267 * If there are multiple such fields in a container then the demuxer should choose the one
1268 * which maximizes the information about the used codec.
1269 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1270 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1271 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1273 * - encoding: Set by user, if not then the default based on codec_id will be used.
1274 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1276 unsigned int codec_tag;
1279 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1280 * This is used to work around some encoder bugs.
1281 * - encoding: unused
1282 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1284 unsigned int stream_codec_tag;
1288 * @deprecated this field is unused
1290 attribute_deprecated int sub_id;
1296 * Private context used for internal data.
1298 * Unlike priv_data, this is not codec-specific. It is used in general
1299 * libavcodec functions.
1301 struct AVCodecInternal *internal;
1304 * Private data of the user, can be used to carry app specific stuff.
1305 * - encoding: Set by user.
1306 * - decoding: Set by user.
1311 * the average bitrate
1312 * - encoding: Set by user; unused for constant quantizer encoding.
1313 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1318 * number of bits the bitstream is allowed to diverge from the reference.
1319 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1320 * - encoding: Set by user; unused for constant quantizer encoding.
1321 * - decoding: unused
1323 int bit_rate_tolerance;
1326 * Global quality for codecs which cannot change it per frame.
1327 * This should be proportional to MPEG-1/2/4 qscale.
1328 * - encoding: Set by user.
1329 * - decoding: unused
1334 * - encoding: Set by user.
1335 * - decoding: unused
1337 int compression_level;
1338 #define FF_COMPRESSION_DEFAULT -1
1342 * - encoding: Set by user.
1343 * - decoding: Set by user.
1349 * - encoding: Set by user.
1350 * - decoding: Set by user.
1355 * some codecs need / can use extradata like Huffman tables.
1356 * mjpeg: Huffman tables
1357 * rv10: additional flags
1358 * mpeg4: global headers (they can be in the bitstream or here)
1359 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1360 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1361 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1362 * - encoding: Set/allocated/freed by libavcodec.
1363 * - decoding: Set/allocated/freed by user.
1369 * This is the fundamental unit of time (in seconds) in terms
1370 * of which frame timestamps are represented. For fixed-fps content,
1371 * timebase should be 1/framerate and timestamp increments should be
1373 * - encoding: MUST be set by user.
1374 * - decoding: Set by libavcodec.
1376 AVRational time_base;
1379 * For some codecs, the time base is closer to the field rate than the frame rate.
1380 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1381 * if no telecine is used ...
1383 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1385 int ticks_per_frame;
1388 * Encoding: Number of frames delay there will be from the encoder input to
1389 * the decoder output. (we assume the decoder matches the spec)
1390 * Decoding: Number of frames delay in addition to what a standard decoder
1391 * as specified in the spec would produce.
1394 * Number of frames the decoded output will be delayed relative to the
1398 * Number of "priming" samples added to the beginning of the stream
1399 * during encoding. The decoded output will be delayed by this many
1400 * samples relative to the input to the encoder. Note that this field is
1401 * purely informational and does not directly affect the pts output by
1402 * the encoder, which should always be based on the actual presentation
1403 * time, including any delay.
1405 * - encoding: Set by libavcodec.
1406 * - decoding: Set by libavcodec.
1413 * picture width / height.
1414 * - encoding: MUST be set by user.
1415 * - decoding: Set by libavcodec.
1416 * Note: For compatibility it is possible to set this instead of
1417 * coded_width/height before decoding.
1422 * Bitstream width / height, may be different from width/height if lowres enabled.
1423 * - encoding: unused
1424 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1426 int coded_width, coded_height;
1428 #define FF_ASPECT_EXTENDED 15
1431 * the number of pictures in a group of pictures, or 0 for intra_only
1432 * - encoding: Set by user.
1433 * - decoding: unused
1438 * Pixel format, see PIX_FMT_xxx.
1439 * May be set by the demuxer if known from headers.
1440 * May be overriden by the decoder if it knows better.
1441 * - encoding: Set by user.
1442 * - decoding: Set by user if known, overridden by libavcodec if known
1444 enum PixelFormat pix_fmt;
1447 * Motion estimation algorithm used for video coding.
1448 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1449 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1450 * - encoding: MUST be set by user.
1451 * - decoding: unused
1456 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1457 * decoder to draw a horizontal band. It improves cache usage. Not
1458 * all codecs can do that. You must check the codec capabilities
1460 * When multithreading is used, it may be called from multiple threads
1461 * at the same time; threads might draw different parts of the same AVFrame,
1462 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1464 * The function is also used by hardware acceleration APIs.
1465 * It is called at least once during frame decoding to pass
1466 * the data needed for hardware render.
1467 * In that mode instead of pixel data, AVFrame points to
1468 * a structure specific to the acceleration API. The application
1469 * reads the structure and can change some fields to indicate progress
1471 * - encoding: unused
1472 * - decoding: Set by user.
1473 * @param height the height of the slice
1474 * @param y the y position of the slice
1475 * @param type 1->top field, 2->bottom field, 3->frame
1476 * @param offset offset into the AVFrame.data from which the slice should be read
1478 void (*draw_horiz_band)(struct AVCodecContext *s,
1479 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1480 int y, int type, int height);
1483 * callback to negotiate the pixelFormat
1484 * @param fmt is the list of formats which are supported by the codec,
1485 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1486 * The first is always the native one.
1487 * @return the chosen format
1488 * - encoding: unused
1489 * - decoding: Set by user, if not set the native format will be chosen.
1491 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1494 * maximum number of B-frames between non-B-frames
1495 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1496 * - encoding: Set by user.
1497 * - decoding: unused
1502 * qscale factor between IP and B-frames
1503 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1504 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1505 * - encoding: Set by user.
1506 * - decoding: unused
1508 float b_quant_factor;
1510 /** obsolete FIXME remove */
1512 #define FF_RC_STRATEGY_XVID 1
1514 int b_frame_strategy;
1516 #if FF_API_MPV_GLOBAL_OPTS
1518 * luma single coefficient elimination threshold
1519 * - encoding: Set by user.
1520 * - decoding: unused
1522 attribute_deprecated int luma_elim_threshold;
1525 * chroma single coeff elimination threshold
1526 * - encoding: Set by user.
1527 * - decoding: unused
1529 attribute_deprecated int chroma_elim_threshold;
1533 * qscale offset between IP and B-frames
1534 * - encoding: Set by user.
1535 * - decoding: unused
1537 float b_quant_offset;
1540 * Size of the frame reordering buffer in the decoder.
1541 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1542 * - encoding: Set by libavcodec.
1543 * - decoding: Set by libavcodec.
1548 * 0-> h263 quant 1-> mpeg quant
1549 * - encoding: Set by user.
1550 * - decoding: unused
1555 * qscale factor between P and I-frames
1556 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1557 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1558 * - encoding: Set by user.
1559 * - decoding: unused
1561 float i_quant_factor;
1564 * qscale offset between P and I-frames
1565 * - encoding: Set by user.
1566 * - decoding: unused
1568 float i_quant_offset;
1571 * luminance masking (0-> disabled)
1572 * - encoding: Set by user.
1573 * - decoding: unused
1578 * temporary complexity masking (0-> disabled)
1579 * - encoding: Set by user.
1580 * - decoding: unused
1582 float temporal_cplx_masking;
1585 * spatial complexity masking (0-> disabled)
1586 * - encoding: Set by user.
1587 * - decoding: unused
1589 float spatial_cplx_masking;
1592 * p block masking (0-> disabled)
1593 * - encoding: Set by user.
1594 * - decoding: unused
1599 * darkness masking (0-> disabled)
1600 * - encoding: Set by user.
1601 * - decoding: unused
1607 * - encoding: Set by libavcodec.
1608 * - decoding: Set by user (or 0).
1612 * prediction method (needed for huffyuv)
1613 * - encoding: Set by user.
1614 * - decoding: unused
1616 int prediction_method;
1617 #define FF_PRED_LEFT 0
1618 #define FF_PRED_PLANE 1
1619 #define FF_PRED_MEDIAN 2
1622 * slice offsets in the frame in bytes
1623 * - encoding: Set/allocated by libavcodec.
1624 * - decoding: Set/allocated by user (or NULL).
1629 * sample aspect ratio (0 if unknown)
1630 * That is the width of a pixel divided by the height of the pixel.
1631 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1632 * - encoding: Set by user.
1633 * - decoding: Set by libavcodec.
1635 AVRational sample_aspect_ratio;
1638 * motion estimation comparison function
1639 * - encoding: Set by user.
1640 * - decoding: unused
1644 * subpixel motion estimation comparison function
1645 * - encoding: Set by user.
1646 * - decoding: unused
1650 * macroblock comparison function (not supported yet)
1651 * - encoding: Set by user.
1652 * - decoding: unused
1656 * interlaced DCT comparison function
1657 * - encoding: Set by user.
1658 * - decoding: unused
1661 #define FF_CMP_SAD 0
1662 #define FF_CMP_SSE 1
1663 #define FF_CMP_SATD 2
1664 #define FF_CMP_DCT 3
1665 #define FF_CMP_PSNR 4
1666 #define FF_CMP_BIT 5
1668 #define FF_CMP_ZERO 7
1669 #define FF_CMP_VSAD 8
1670 #define FF_CMP_VSSE 9
1671 #define FF_CMP_NSSE 10
1672 #define FF_CMP_W53 11
1673 #define FF_CMP_W97 12
1674 #define FF_CMP_DCTMAX 13
1675 #define FF_CMP_DCT264 14
1676 #define FF_CMP_CHROMA 256
1679 * ME diamond size & shape
1680 * - encoding: Set by user.
1681 * - decoding: unused
1686 * amount of previous MV predictors (2a+1 x 2a+1 square)
1687 * - encoding: Set by user.
1688 * - decoding: unused
1690 int last_predictor_count;
1693 * prepass for motion estimation
1694 * - encoding: Set by user.
1695 * - decoding: unused
1700 * motion estimation prepass comparison function
1701 * - encoding: Set by user.
1702 * - decoding: unused
1707 * ME prepass diamond size & shape
1708 * - encoding: Set by user.
1709 * - decoding: unused
1715 * - encoding: Set by user.
1716 * - decoding: unused
1718 int me_subpel_quality;
1721 * DTG active format information (additional aspect ratio
1722 * information only used in DVB MPEG-2 transport streams)
1725 * - encoding: unused
1726 * - decoding: Set by decoder.
1728 int dtg_active_format;
1729 #define FF_DTG_AFD_SAME 8
1730 #define FF_DTG_AFD_4_3 9
1731 #define FF_DTG_AFD_16_9 10
1732 #define FF_DTG_AFD_14_9 11
1733 #define FF_DTG_AFD_4_3_SP_14_9 13
1734 #define FF_DTG_AFD_16_9_SP_14_9 14
1735 #define FF_DTG_AFD_SP_4_3 15
1738 * maximum motion estimation search range in subpel units
1739 * If 0 then no limit.
1741 * - encoding: Set by user.
1742 * - decoding: unused
1747 * intra quantizer bias
1748 * - encoding: Set by user.
1749 * - decoding: unused
1751 int intra_quant_bias;
1752 #define FF_DEFAULT_QUANT_BIAS 999999
1755 * inter quantizer bias
1756 * - encoding: Set by user.
1757 * - decoding: unused
1759 int inter_quant_bias;
1761 #if FF_API_COLOR_TABLE_ID
1764 * - encoding: unused
1765 * - decoding: Which clrtable should be used for 8bit RGB images.
1766 * Tables have to be stored somewhere. FIXME
1768 attribute_deprecated int color_table_id;
1773 * - encoding: unused
1774 * - decoding: Set by user.
1777 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1778 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1779 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1782 * XVideo Motion Acceleration
1783 * - encoding: forbidden
1784 * - decoding: set by decoder
1786 int xvmc_acceleration;
1789 * macroblock decision mode
1790 * - encoding: Set by user.
1791 * - decoding: unused
1794 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1795 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1796 #define FF_MB_DECISION_RD 2 ///< rate distortion
1799 * custom intra quantization matrix
1800 * - encoding: Set by user, can be NULL.
1801 * - decoding: Set by libavcodec.
1803 uint16_t *intra_matrix;
1806 * custom inter quantization matrix
1807 * - encoding: Set by user, can be NULL.
1808 * - decoding: Set by libavcodec.
1810 uint16_t *inter_matrix;
1813 * scene change detection threshold
1814 * 0 is default, larger means fewer detected scene changes.
1815 * - encoding: Set by user.
1816 * - decoding: unused
1818 int scenechange_threshold;
1821 * noise reduction strength
1822 * - encoding: Set by user.
1823 * - decoding: unused
1825 int noise_reduction;
1827 #if FF_API_INTER_THRESHOLD
1829 * @deprecated this field is unused
1831 attribute_deprecated int inter_threshold;
1834 #if FF_API_MPV_GLOBAL_OPTS
1836 * @deprecated use mpegvideo private options instead
1838 attribute_deprecated int quantizer_noise_shaping;
1842 * Motion estimation threshold below which no motion estimation is
1843 * performed, but instead the user specified motion vectors are used.
1845 * - encoding: Set by user.
1846 * - decoding: unused
1851 * Macroblock threshold below which the user specified macroblock types will be used.
1852 * - encoding: Set by user.
1853 * - decoding: unused
1858 * precision of the intra DC coefficient - 8
1859 * - encoding: Set by user.
1860 * - decoding: unused
1862 int intra_dc_precision;
1865 * Number of macroblock rows at the top which are skipped.
1866 * - encoding: unused
1867 * - decoding: Set by user.
1872 * Number of macroblock rows at the bottom which are skipped.
1873 * - encoding: unused
1874 * - decoding: Set by user.
1879 * Border processing masking, raises the quantizer for mbs on the borders
1881 * - encoding: Set by user.
1882 * - decoding: unused
1884 float border_masking;
1887 * minimum MB lagrange multipler
1888 * - encoding: Set by user.
1889 * - decoding: unused
1894 * maximum MB lagrange multipler
1895 * - encoding: Set by user.
1896 * - decoding: unused
1902 * - encoding: Set by user.
1903 * - decoding: unused
1905 int me_penalty_compensation;
1909 * - encoding: Set by user.
1910 * - decoding: unused
1916 * - encoding: Set by user.
1917 * - decoding: unused
1923 * - encoding: Set by user.
1924 * - decoding: unused
1929 * number of reference frames
1930 * - encoding: Set by user.
1931 * - decoding: Set by lavc.
1936 * chroma qp offset from luma
1937 * - encoding: Set by user.
1938 * - decoding: unused
1943 * Multiplied by qscale for each frame and added to scene_change_score.
1944 * - encoding: Set by user.
1945 * - decoding: unused
1947 int scenechange_factor;
1951 * Note: Value depends upon the compare function used for fullpel ME.
1952 * - encoding: Set by user.
1953 * - decoding: unused
1958 * Adjust sensitivity of b_frame_strategy 1.
1959 * - encoding: Set by user.
1960 * - decoding: unused
1965 * Chromaticity coordinates of the source primaries.
1966 * - encoding: Set by user
1967 * - decoding: Set by libavcodec
1969 enum AVColorPrimaries color_primaries;
1972 * Color Transfer Characteristic.
1973 * - encoding: Set by user
1974 * - decoding: Set by libavcodec
1976 enum AVColorTransferCharacteristic color_trc;
1979 * YUV colorspace type.
1980 * - encoding: Set by user
1981 * - decoding: Set by libavcodec
1983 enum AVColorSpace colorspace;
1986 * MPEG vs JPEG YUV range.
1987 * - encoding: Set by user
1988 * - decoding: Set by libavcodec
1990 enum AVColorRange color_range;
1993 * This defines the location of chroma samples.
1994 * - encoding: Set by user
1995 * - decoding: Set by libavcodec
1997 enum AVChromaLocation chroma_sample_location;
2001 * Indicates number of picture subdivisions. Used for parallelized
2003 * - encoding: Set by user
2004 * - decoding: unused
2009 * - encoding: set by libavcodec
2010 * - decoding: Set by libavcodec
2012 enum AVFieldOrder field_order;
2015 int sample_rate; ///< samples per second
2016 int channels; ///< number of audio channels
2019 * audio sample format
2020 * - encoding: Set by user.
2021 * - decoding: Set by libavcodec.
2023 enum AVSampleFormat sample_fmt; ///< sample format
2025 /* The following data should not be initialized. */
2027 * Samples per packet, initialized when calling 'init'.
2032 * Frame counter, set by libavcodec.
2034 * - decoding: total number of frames returned from the decoder so far.
2035 * - encoding: total number of frames passed to the encoder so far.
2037 * @note the counter is not incremented if encoding/decoding resulted in
2043 * number of bytes per packet if constant and known or 0
2044 * Used by some WAV based audio codecs.
2049 * Audio cutoff bandwidth (0 means "automatic")
2050 * - encoding: Set by user.
2051 * - decoding: unused
2055 #if FF_API_REQUEST_CHANNELS
2057 * Decoder should decode to this many channels if it can (0 for default)
2058 * - encoding: unused
2059 * - decoding: Set by user.
2060 * @deprecated Deprecated in favor of request_channel_layout.
2062 int request_channels;
2066 * Audio channel layout.
2067 * - encoding: set by user.
2068 * - decoding: set by user, may be overwritten by libavcodec.
2070 uint64_t channel_layout;
2073 * Request decoder to use this channel layout if it can (0 for default)
2074 * - encoding: unused
2075 * - decoding: Set by user.
2077 uint64_t request_channel_layout;
2080 * Type of service that the audio stream conveys.
2081 * - encoding: Set by user.
2082 * - decoding: Set by libavcodec.
2084 enum AVAudioServiceType audio_service_type;
2087 * desired sample format
2088 * - encoding: Not used.
2089 * - decoding: Set by user.
2090 * Decoder will decode to this format if it can.
2092 enum AVSampleFormat request_sample_fmt;
2095 * Called at the beginning of each frame to get a buffer for it.
2097 * The function will set AVFrame.data[], AVFrame.linesize[].
2098 * AVFrame.extended_data[] must also be set, but it should be the same as
2099 * AVFrame.data[] except for planar audio with more channels than can fit
2100 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2101 * many data pointers as it can hold.
2103 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2104 * avcodec_default_get_buffer() instead of providing buffers allocated by
2107 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2108 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2109 * but if get_buffer() is overridden then alignment considerations should
2110 * be taken into account.
2112 * @see avcodec_default_get_buffer()
2116 * If pic.reference is set then the frame will be read later by libavcodec.
2117 * avcodec_align_dimensions2() should be used to find the required width and
2118 * height, as they normally need to be rounded up to the next multiple of 16.
2120 * If frame multithreading is used and thread_safe_callbacks is set,
2121 * it may be called from a different thread, but not from more than one at
2122 * once. Does not need to be reentrant.
2124 * @see release_buffer(), reget_buffer()
2125 * @see avcodec_align_dimensions2()
2129 * Decoders request a buffer of a particular size by setting
2130 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2131 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2132 * to a smaller value in the output frame.
2134 * Decoders cannot use the buffer after returning from
2135 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2136 * is assumed to be released immediately upon return.
2138 * As a convenience, av_samples_get_buffer_size() and
2139 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2140 * functions to find the required data size and to fill data pointers and
2141 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2142 * since all planes must be the same size.
2144 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2146 * - encoding: unused
2147 * - decoding: Set by libavcodec, user can override.
2149 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2152 * Called to release buffers which were allocated with get_buffer.
2153 * A released buffer can be reused in get_buffer().
2154 * pic.data[*] must be set to NULL.
2155 * May be called from a different thread if frame multithreading is used,
2156 * but not by more than one thread at once, so does not need to be reentrant.
2157 * - encoding: unused
2158 * - decoding: Set by libavcodec, user can override.
2160 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2163 * Called at the beginning of a frame to get cr buffer for it.
2164 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2165 * libavcodec will pass previous buffer in pic, function should return
2166 * same buffer or new buffer with old frame "painted" into it.
2167 * If pic.data[0] == NULL must behave like get_buffer().
2168 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2169 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2171 * - encoding: unused
2172 * - decoding: Set by libavcodec, user can override.
2174 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2177 /* - encoding parameters */
2178 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2179 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2183 * - encoding: Set by user.
2184 * - decoding: unused
2190 * - encoding: Set by user.
2191 * - decoding: unused
2196 * maximum quantizer difference between frames
2197 * - encoding: Set by user.
2198 * - decoding: unused
2203 * ratecontrol qmin qmax limiting method
2204 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2205 * - encoding: Set by user.
2206 * - decoding: unused
2214 * decoder bitstream buffer size
2215 * - encoding: Set by user.
2216 * - decoding: unused
2221 * ratecontrol override, see RcOverride
2222 * - encoding: Allocated/set/freed by user.
2223 * - decoding: unused
2225 int rc_override_count;
2226 RcOverride *rc_override;
2229 * rate control equation
2230 * - encoding: Set by user
2231 * - decoding: unused
2237 * - encoding: Set by user.
2238 * - decoding: unused
2244 * - encoding: Set by user.
2245 * - decoding: unused
2249 float rc_buffer_aggressivity;
2252 * initial complexity for pass1 ratecontrol
2253 * - encoding: Set by user.
2254 * - decoding: unused
2256 float rc_initial_cplx;
2259 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2260 * - encoding: Set by user.
2261 * - decoding: unused.
2263 float rc_max_available_vbv_use;
2266 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2267 * - encoding: Set by user.
2268 * - decoding: unused.
2270 float rc_min_vbv_overflow_use;
2273 * Number of bits which should be loaded into the rc buffer before decoding starts.
2274 * - encoding: Set by user.
2275 * - decoding: unused
2277 int rc_initial_buffer_occupancy;
2279 #define FF_CODER_TYPE_VLC 0
2280 #define FF_CODER_TYPE_AC 1
2281 #define FF_CODER_TYPE_RAW 2
2282 #define FF_CODER_TYPE_RLE 3
2283 #define FF_CODER_TYPE_DEFLATE 4
2286 * - encoding: Set by user.
2287 * - decoding: unused
2293 * - encoding: Set by user.
2294 * - decoding: unused
2299 * minimum Lagrange multipler
2300 * - encoding: Set by user.
2301 * - decoding: unused
2306 * maximum Lagrange multipler
2307 * - encoding: Set by user.
2308 * - decoding: unused
2313 * frame skip threshold
2314 * - encoding: Set by user.
2315 * - decoding: unused
2317 int frame_skip_threshold;
2321 * - encoding: Set by user.
2322 * - decoding: unused
2324 int frame_skip_factor;
2327 * frame skip exponent
2328 * - encoding: Set by user.
2329 * - decoding: unused
2334 * frame skip comparison function
2335 * - encoding: Set by user.
2336 * - decoding: unused
2341 * trellis RD quantization
2342 * - encoding: Set by user.
2343 * - decoding: unused
2348 * - encoding: Set by user.
2349 * - decoding: unused
2351 int min_prediction_order;
2354 * - encoding: Set by user.
2355 * - decoding: unused
2357 int max_prediction_order;
2360 * GOP timecode frame start number
2361 * - encoding: Set by user, in non drop frame format
2362 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2364 int64_t timecode_frame_start;
2366 /* The RTP callback: This function is called */
2367 /* every time the encoder has a packet to send. */
2368 /* It depends on the encoder if the data starts */
2369 /* with a Start Code (it should). H.263 does. */
2370 /* mb_nb contains the number of macroblocks */
2371 /* encoded in the RTP payload. */
2372 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2374 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2375 /* do its best to deliver a chunk with size */
2376 /* below rtp_payload_size, the chunk will start */
2377 /* with a start code on some codecs like H.263. */
2378 /* This doesn't take account of any particular */
2379 /* headers inside the transmitted RTP payload. */
2381 /* statistics, used for 2-pass encoding */
2392 * number of bits used for the previously encoded frame
2393 * - encoding: Set by libavcodec.
2394 * - decoding: unused
2399 * pass1 encoding statistics output buffer
2400 * - encoding: Set by libavcodec.
2401 * - decoding: unused
2406 * pass2 encoding statistics input buffer
2407 * Concatenated stuff from stats_out of pass1 should be placed here.
2408 * - encoding: Allocated/set/freed by user.
2409 * - decoding: unused
2414 * Work around bugs in encoders which sometimes cannot be detected automatically.
2415 * - encoding: Set by user
2416 * - decoding: Set by user
2418 int workaround_bugs;
2419 #define FF_BUG_AUTODETECT 1 ///< autodetection
2420 #define FF_BUG_OLD_MSMPEG4 2
2421 #define FF_BUG_XVID_ILACE 4
2422 #define FF_BUG_UMP4 8
2423 #define FF_BUG_NO_PADDING 16
2424 #define FF_BUG_AMV 32
2425 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2426 #define FF_BUG_QPEL_CHROMA 64
2427 #define FF_BUG_STD_QPEL 128
2428 #define FF_BUG_QPEL_CHROMA2 256
2429 #define FF_BUG_DIRECT_BLOCKSIZE 512
2430 #define FF_BUG_EDGE 1024
2431 #define FF_BUG_HPEL_CHROMA 2048
2432 #define FF_BUG_DC_CLIP 4096
2433 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2434 #define FF_BUG_TRUNCATED 16384
2437 * strictly follow the standard (MPEG4, ...).
2438 * - encoding: Set by user.
2439 * - decoding: Set by user.
2440 * Setting this to STRICT or higher means the encoder and decoder will
2441 * generally do stupid things, whereas setting it to unofficial or lower
2442 * will mean the encoder might produce output that is not supported by all
2443 * spec-compliant decoders. Decoders don't differentiate between normal,
2444 * unofficial and experimental (that is, they always try to decode things
2445 * when they can) unless they are explicitly asked to behave stupidly
2446 * (=strictly conform to the specs)
2448 int strict_std_compliance;
2449 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2450 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2451 #define FF_COMPLIANCE_NORMAL 0
2452 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2453 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2456 * error concealment flags
2457 * - encoding: unused
2458 * - decoding: Set by user.
2460 int error_concealment;
2461 #define FF_EC_GUESS_MVS 1
2462 #define FF_EC_DEBLOCK 2
2466 * - encoding: Set by user.
2467 * - decoding: Set by user.
2470 #define FF_DEBUG_PICT_INFO 1
2471 #define FF_DEBUG_RC 2
2472 #define FF_DEBUG_BITSTREAM 4
2473 #define FF_DEBUG_MB_TYPE 8
2474 #define FF_DEBUG_QP 16
2475 #define FF_DEBUG_MV 32
2476 #define FF_DEBUG_DCT_COEFF 0x00000040
2477 #define FF_DEBUG_SKIP 0x00000080
2478 #define FF_DEBUG_STARTCODE 0x00000100
2479 #define FF_DEBUG_PTS 0x00000200
2480 #define FF_DEBUG_ER 0x00000400
2481 #define FF_DEBUG_MMCO 0x00000800
2482 #define FF_DEBUG_BUGS 0x00001000
2483 #define FF_DEBUG_VIS_QP 0x00002000
2484 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2485 #define FF_DEBUG_BUFFERS 0x00008000
2486 #define FF_DEBUG_THREADS 0x00010000
2490 * - encoding: Set by user.
2491 * - decoding: Set by user.
2494 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2495 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2496 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2499 * Error recognition; may misdetect some more or less valid parts as errors.
2500 * - encoding: unused
2501 * - decoding: Set by user.
2503 int err_recognition;
2504 #define AV_EF_CRCCHECK (1<<0)
2505 #define AV_EF_BITSTREAM (1<<1)
2506 #define AV_EF_BUFFER (1<<2)
2507 #define AV_EF_EXPLODE (1<<3)
2509 #define AV_EF_CAREFUL (1<<16)
2510 #define AV_EF_COMPLIANT (1<<17)
2511 #define AV_EF_AGGRESSIVE (1<<18)
2515 * opaque 64bit number (generally a PTS) that will be reordered and
2516 * output in AVFrame.reordered_opaque
2517 * @deprecated in favor of pkt_pts
2518 * - encoding: unused
2519 * - decoding: Set by user.
2521 int64_t reordered_opaque;
2524 * Hardware accelerator in use
2525 * - encoding: unused.
2526 * - decoding: Set by libavcodec
2528 struct AVHWAccel *hwaccel;
2531 * Hardware accelerator context.
2532 * For some hardware accelerators, a global context needs to be
2533 * provided by the user. In that case, this holds display-dependent
2534 * data FFmpeg cannot instantiate itself. Please refer to the
2535 * FFmpeg HW accelerator documentation to know how to fill this
2536 * is. e.g. for VA API, this is a struct vaapi_context.
2537 * - encoding: unused
2538 * - decoding: Set by user
2540 void *hwaccel_context;
2544 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2545 * - decoding: unused
2547 uint64_t error[AV_NUM_DATA_POINTERS];
2550 * DCT algorithm, see FF_DCT_* below
2551 * - encoding: Set by user.
2552 * - decoding: unused
2555 #define FF_DCT_AUTO 0
2556 #define FF_DCT_FASTINT 1
2557 #define FF_DCT_INT 2
2558 #define FF_DCT_MMX 3
2559 #define FF_DCT_ALTIVEC 5
2560 #define FF_DCT_FAAN 6
2563 * IDCT algorithm, see FF_IDCT_* below.
2564 * - encoding: Set by user.
2565 * - decoding: Set by user.
2568 #define FF_IDCT_AUTO 0
2569 #define FF_IDCT_INT 1
2570 #define FF_IDCT_SIMPLE 2
2571 #define FF_IDCT_SIMPLEMMX 3
2572 #define FF_IDCT_LIBMPEG2MMX 4
2573 #define FF_IDCT_MMI 5
2574 #define FF_IDCT_ARM 7
2575 #define FF_IDCT_ALTIVEC 8
2576 #define FF_IDCT_SH4 9
2577 #define FF_IDCT_SIMPLEARM 10
2578 #define FF_IDCT_H264 11
2579 #define FF_IDCT_VP3 12
2580 #define FF_IDCT_IPP 13
2581 #define FF_IDCT_XVIDMMX 14
2582 #define FF_IDCT_CAVS 15
2583 #define FF_IDCT_SIMPLEARMV5TE 16
2584 #define FF_IDCT_SIMPLEARMV6 17
2585 #define FF_IDCT_SIMPLEVIS 18
2586 #define FF_IDCT_WMV2 19
2587 #define FF_IDCT_FAAN 20
2588 #define FF_IDCT_EA 21
2589 #define FF_IDCT_SIMPLENEON 22
2590 #define FF_IDCT_SIMPLEALPHA 23
2591 #define FF_IDCT_BINK 24
2594 * dsp_mask could be add used to disable unwanted CPU features
2595 * CPU features (i.e. MMX, SSE. ...)
2597 * With the FORCE flag you may instead enable given CPU features.
2598 * (Dangerous: Usable in case of misdetection, improper usage however will
2599 * result into program crash.)
2604 * bits per sample/pixel from the demuxer (needed for huffyuv).
2605 * - encoding: Set by libavcodec.
2606 * - decoding: Set by user.
2608 int bits_per_coded_sample;
2611 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2612 * - encoding: set by user.
2613 * - decoding: set by libavcodec.
2615 int bits_per_raw_sample;
2618 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2619 * - encoding: unused
2620 * - decoding: Set by user.
2625 * the picture in the bitstream
2626 * - encoding: Set by libavcodec.
2627 * - decoding: Set by libavcodec.
2629 AVFrame *coded_frame;
2633 * is used to decide how many independent tasks should be passed to execute()
2634 * - encoding: Set by user.
2635 * - decoding: Set by user.
2640 * Which multithreading methods to use.
2641 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2642 * so clients which cannot provide future frames should not use it.
2644 * - encoding: Set by user, otherwise the default is used.
2645 * - decoding: Set by user, otherwise the default is used.
2648 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2649 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2652 * Which multithreading methods are in use by the codec.
2653 * - encoding: Set by libavcodec.
2654 * - decoding: Set by libavcodec.
2656 int active_thread_type;
2659 * Set by the client if its custom get_buffer() callback can be called
2660 * from another thread, which allows faster multithreaded decoding.
2661 * draw_horiz_band() will be called from other threads regardless of this setting.
2662 * Ignored if the default get_buffer() is used.
2663 * - encoding: Set by user.
2664 * - decoding: Set by user.
2666 int thread_safe_callbacks;
2669 * The codec may call this to execute several independent things.
2670 * It will return only after finishing all tasks.
2671 * The user may replace this with some multithreaded implementation,
2672 * the default implementation will execute the parts serially.
2673 * @param count the number of things to execute
2674 * - encoding: Set by libavcodec, user can override.
2675 * - decoding: Set by libavcodec, user can override.
2677 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2680 * The codec may call this to execute several independent things.
2681 * It will return only after finishing all tasks.
2682 * The user may replace this with some multithreaded implementation,
2683 * the default implementation will execute the parts serially.
2684 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2685 * @param c context passed also to func
2686 * @param count the number of things to execute
2687 * @param arg2 argument passed unchanged to func
2688 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2689 * @param func function that will be called count times, with jobnr from 0 to count-1.
2690 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2691 * two instances of func executing at the same time will have the same threadnr.
2692 * @return always 0 currently, but code should handle a future improvement where when any call to func
2693 * returns < 0 no further calls to func may be done and < 0 is returned.
2694 * - encoding: Set by libavcodec, user can override.
2695 * - decoding: Set by libavcodec, user can override.
2697 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2701 * Can be used by execute() to store some per AVCodecContext stuff.
2702 * - encoding: set by execute()
2703 * - decoding: set by execute()
2705 void *thread_opaque;
2708 * noise vs. sse weight for the nsse comparsion function
2709 * - encoding: Set by user.
2710 * - decoding: unused
2716 * - encoding: Set by user.
2717 * - decoding: Set by libavcodec.
2720 #define FF_PROFILE_UNKNOWN -99
2721 #define FF_PROFILE_RESERVED -100
2723 #define FF_PROFILE_AAC_MAIN 0
2724 #define FF_PROFILE_AAC_LOW 1
2725 #define FF_PROFILE_AAC_SSR 2
2726 #define FF_PROFILE_AAC_LTP 3
2728 #define FF_PROFILE_DTS 20
2729 #define FF_PROFILE_DTS_ES 30
2730 #define FF_PROFILE_DTS_96_24 40
2731 #define FF_PROFILE_DTS_HD_HRA 50
2732 #define FF_PROFILE_DTS_HD_MA 60
2734 #define FF_PROFILE_MPEG2_422 0
2735 #define FF_PROFILE_MPEG2_HIGH 1
2736 #define FF_PROFILE_MPEG2_SS 2
2737 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2738 #define FF_PROFILE_MPEG2_MAIN 4
2739 #define FF_PROFILE_MPEG2_SIMPLE 5
2741 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2742 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2744 #define FF_PROFILE_H264_BASELINE 66
2745 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2746 #define FF_PROFILE_H264_MAIN 77
2747 #define FF_PROFILE_H264_EXTENDED 88
2748 #define FF_PROFILE_H264_HIGH 100
2749 #define FF_PROFILE_H264_HIGH_10 110
2750 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2751 #define FF_PROFILE_H264_HIGH_422 122
2752 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2753 #define FF_PROFILE_H264_HIGH_444 144
2754 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2755 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2756 #define FF_PROFILE_H264_CAVLC_444 44
2758 #define FF_PROFILE_VC1_SIMPLE 0
2759 #define FF_PROFILE_VC1_MAIN 1
2760 #define FF_PROFILE_VC1_COMPLEX 2
2761 #define FF_PROFILE_VC1_ADVANCED 3
2763 #define FF_PROFILE_MPEG4_SIMPLE 0
2764 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2765 #define FF_PROFILE_MPEG4_CORE 2
2766 #define FF_PROFILE_MPEG4_MAIN 3
2767 #define FF_PROFILE_MPEG4_N_BIT 4
2768 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2769 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2770 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2771 #define FF_PROFILE_MPEG4_HYBRID 8
2772 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2773 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2774 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2775 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2776 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2777 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2778 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2782 * - encoding: Set by user.
2783 * - decoding: Set by libavcodec.
2786 #define FF_LEVEL_UNKNOWN -99
2790 * - encoding: unused
2791 * - decoding: Set by user.
2793 enum AVDiscard skip_loop_filter;
2797 * - encoding: unused
2798 * - decoding: Set by user.
2800 enum AVDiscard skip_idct;
2804 * - encoding: unused
2805 * - decoding: Set by user.
2807 enum AVDiscard skip_frame;
2810 * Header containing style information for text subtitles.
2811 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2812 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2813 * the Format line following. It shouldn't include any Dialogue line.
2814 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2815 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2817 uint8_t *subtitle_header;
2818 int subtitle_header_size;
2821 * Simulates errors in the bitstream to test error concealment.
2822 * - encoding: Set by user.
2823 * - decoding: unused
2828 * Current packet as passed into the decoder, to avoid having
2829 * to pass the packet into every function. Currently only valid
2830 * inside lavc and get/release_buffer callbacks.
2831 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2832 * - encoding: unused
2837 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2838 * Used for compliant TS muxing.
2839 * - encoding: Set by libavcodec.
2840 * - decoding: unused.
2845 * Current statistics for PTS correction.
2846 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2847 * - encoding: unused
2849 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2850 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2851 int64_t pts_correction_last_pts; /// PTS of the last frame
2852 int64_t pts_correction_last_dts; /// DTS of the last frame
2858 typedef struct AVProfile {
2860 const char *name; ///< short name for the profile
2863 typedef struct AVCodecDefault AVCodecDefault;
2868 typedef struct AVCodec {
2870 * Name of the codec implementation.
2871 * The name is globally unique among encoders and among decoders (but an
2872 * encoder and a decoder can share the same name).
2873 * This is the primary way to find a codec from the user perspective.
2877 * Descriptive name for the codec, meant to be more human readable than name.
2878 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2880 const char *long_name;
2881 enum AVMediaType type;
2884 * Codec capabilities.
2888 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2889 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2890 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2891 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2892 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2893 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2894 const AVClass *priv_class; ///< AVClass for the private context
2895 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2897 /*****************************************************************
2898 * No fields below this line are part of the public API. They
2899 * may not be used outside of libavcodec and can be changed and
2901 * New public fields should be added right above.
2902 *****************************************************************
2905 struct AVCodec *next;
2907 * @name Frame-level threading support functions
2911 * If defined, called on thread contexts when they are created.
2912 * If the codec allocates writable tables in init(), re-allocate them here.
2913 * priv_data will be set to a copy of the original.
2915 int (*init_thread_copy)(AVCodecContext *);
2917 * Copy necessary context variables from a previous thread context to the current one.
2918 * If not defined, the next thread will start automatically; otherwise, the codec
2919 * must call ff_thread_finish_setup().
2921 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2923 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2927 * Private codec-specific defaults.
2929 const AVCodecDefault *defaults;
2932 * Initialize codec static data, called from avcodec_register().
2934 void (*init_static_data)(struct AVCodec *codec);
2936 int (*init)(AVCodecContext *);
2937 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2939 * Encode data to an AVPacket.
2941 * @param avctx codec context
2942 * @param avpkt output AVPacket (may contain a user-provided buffer)
2943 * @param[in] frame AVFrame containing the raw data to be encoded
2944 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2945 * non-empty packet was returned in avpkt.
2946 * @return 0 on success, negative error code on failure
2948 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2949 int *got_packet_ptr);
2950 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2951 int (*close)(AVCodecContext *);
2954 * Will be called when seeking
2956 void (*flush)(AVCodecContext *);
2962 typedef struct AVHWAccel {
2964 * Name of the hardware accelerated codec.
2965 * The name is globally unique among encoders and among decoders (but an
2966 * encoder and a decoder can share the same name).
2971 * Type of codec implemented by the hardware accelerator.
2973 * See AVMEDIA_TYPE_xxx
2975 enum AVMediaType type;
2978 * Codec implemented by the hardware accelerator.
2985 * Supported pixel format.
2987 * Only hardware accelerated formats are supported here.
2989 enum PixelFormat pix_fmt;
2992 * Hardware accelerated codec capabilities.
2993 * see FF_HWACCEL_CODEC_CAP_*
2997 struct AVHWAccel *next;
3000 * Called at the beginning of each frame or field picture.
3002 * Meaningful frame information (codec specific) is guaranteed to
3003 * be parsed at this point. This function is mandatory.
3005 * Note that buf can be NULL along with buf_size set to 0.
3006 * Otherwise, this means the whole frame is available at this point.
3008 * @param avctx the codec context
3009 * @param buf the frame data buffer base
3010 * @param buf_size the size of the frame in bytes
3011 * @return zero if successful, a negative value otherwise
3013 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3016 * Callback for each slice.
3018 * Meaningful slice information (codec specific) is guaranteed to
3019 * be parsed at this point. This function is mandatory.
3021 * @param avctx the codec context
3022 * @param buf the slice data buffer base
3023 * @param buf_size the size of the slice in bytes
3024 * @return zero if successful, a negative value otherwise
3026 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3029 * Called at the end of each frame or field picture.
3031 * The whole picture is parsed at this point and can now be sent
3032 * to the hardware accelerator. This function is mandatory.
3034 * @param avctx the codec context
3035 * @return zero if successful, a negative value otherwise
3037 int (*end_frame)(AVCodecContext *avctx);
3040 * Size of HW accelerator private data.
3042 * Private data is allocated with av_mallocz() before
3043 * AVCodecContext.get_buffer() and deallocated after
3044 * AVCodecContext.release_buffer().
3050 * four components are given, that's all.
3051 * the last component is alpha
3053 typedef struct AVPicture {
3054 uint8_t *data[AV_NUM_DATA_POINTERS];
3055 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3058 #define AVPALETTE_SIZE 1024
3059 #define AVPALETTE_COUNT 256
3061 enum AVSubtitleType {
3064 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3067 * Plain text, the text field must be set by the decoder and is
3068 * authoritative. ass and pict fields may contain approximations.
3073 * Formatted text, the ass field must be set by the decoder and is
3074 * authoritative. pict and text fields may contain approximations.
3079 typedef struct AVSubtitleRect {
3080 int x; ///< top left corner of pict, undefined when pict is not set
3081 int y; ///< top left corner of pict, undefined when pict is not set
3082 int w; ///< width of pict, undefined when pict is not set
3083 int h; ///< height of pict, undefined when pict is not set
3084 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3087 * data+linesize for the bitmap of this subtitle.
3088 * can be set for text/ass as well once they where rendered
3091 enum AVSubtitleType type;
3093 char *text; ///< 0 terminated plain UTF-8 text
3096 * 0 terminated ASS/SSA compatible event line.
3097 * The pressentation of this is unaffected by the other values in this
3103 typedef struct AVSubtitle {
3104 uint16_t format; /* 0 = graphics */
3105 uint32_t start_display_time; /* relative to packet pts, in ms */
3106 uint32_t end_display_time; /* relative to packet pts, in ms */
3108 AVSubtitleRect **rects;
3109 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3112 /* packet functions */
3115 * @deprecated use NULL instead
3117 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3120 * Default packet destructor.
3122 void av_destruct_packet(AVPacket *pkt);
3125 * Initialize optional fields of a packet with default values.
3129 void av_init_packet(AVPacket *pkt);
3132 * Allocate the payload of a packet and initialize its fields with
3136 * @param size wanted payload size
3137 * @return 0 if OK, AVERROR_xxx otherwise
3139 int av_new_packet(AVPacket *pkt, int size);
3142 * Reduce packet size, correctly zeroing padding
3145 * @param size new size
3147 void av_shrink_packet(AVPacket *pkt, int size);
3150 * Increase packet size, correctly zeroing padding
3153 * @param grow_by number of bytes by which to increase the size of the packet
3155 int av_grow_packet(AVPacket *pkt, int grow_by);
3158 * @warning This is a hack - the packet memory allocation stuff is broken. The
3159 * packet is allocated if it was not really allocated.
3161 int av_dup_packet(AVPacket *pkt);
3166 * @param pkt packet to free
3168 void av_free_packet(AVPacket *pkt);
3171 * Allocate new information of a packet.
3174 * @param type side information type
3175 * @param size side information size
3176 * @return pointer to fresh allocated data or NULL otherwise
3178 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3182 * Shrink the already allocated side data buffer
3185 * @param type side information type
3186 * @param size new side information size
3187 * @return 0 on success, < 0 on failure
3189 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3193 * Get side information from packet.
3196 * @param type desired side information type
3197 * @param size pointer for side information size to store (optional)
3198 * @return pointer to data if present or NULL otherwise
3200 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3203 int av_packet_merge_side_data(AVPacket *pkt);
3205 int av_packet_split_side_data(AVPacket *pkt);
3210 struct ReSampleContext;
3211 struct AVResampleContext;
3213 typedef struct ReSampleContext ReSampleContext;
3216 * Initialize audio resampling context.
3218 * @param output_channels number of output channels
3219 * @param input_channels number of input channels
3220 * @param output_rate output sample rate
3221 * @param input_rate input sample rate
3222 * @param sample_fmt_out requested output sample format
3223 * @param sample_fmt_in input sample format
3224 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3225 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3226 * @param linear if 1 then the used FIR filter will be linearly interpolated
3227 between the 2 closest, if 0 the closest will be used
3228 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3229 * @return allocated ReSampleContext, NULL if error occurred
3231 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3232 int output_rate, int input_rate,
3233 enum AVSampleFormat sample_fmt_out,
3234 enum AVSampleFormat sample_fmt_in,
3235 int filter_length, int log2_phase_count,
3236 int linear, double cutoff);
3238 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3241 * Free resample context.
3243 * @param s a non-NULL pointer to a resample context previously
3244 * created with av_audio_resample_init()
3246 void audio_resample_close(ReSampleContext *s);
3250 * Initialize an audio resampler.
3251 * Note, if either rate is not an integer then simply scale both rates up so they are.
3252 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3253 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3254 * @param linear If 1 then the used FIR filter will be linearly interpolated
3255 between the 2 closest, if 0 the closest will be used
3256 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3258 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3261 * Resample an array of samples using a previously configured context.
3262 * @param src an array of unconsumed samples
3263 * @param consumed the number of samples of src which have been consumed are returned here
3264 * @param src_size the number of unconsumed samples available
3265 * @param dst_size the amount of space in samples available in dst
3266 * @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.
3267 * @return the number of samples written in dst or -1 if an error occurred
3269 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3273 * Compensate samplerate/timestamp drift. The compensation is done by changing
3274 * the resampler parameters, so no audible clicks or similar distortions occur
3275 * @param compensation_distance distance in output samples over which the compensation should be performed
3276 * @param sample_delta number of output samples which should be output less
3278 * example: av_resample_compensate(c, 10, 500)
3279 * here instead of 510 samples only 500 samples would be output
3281 * note, due to rounding the actual compensation might be slightly different,
3282 * especially if the compensation_distance is large and the in_rate used during init is small
3284 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3285 void av_resample_close(struct AVResampleContext *c);
3288 * Allocate memory for a picture. Call avpicture_free() to free it.
3290 * @see avpicture_fill()
3292 * @param picture the picture to be filled in
3293 * @param pix_fmt the format of the picture
3294 * @param width the width of the picture
3295 * @param height the height of the picture
3296 * @return zero if successful, a negative value if not
3298 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3301 * Free a picture previously allocated by avpicture_alloc().
3302 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3305 * @param picture the AVPicture to be freed
3307 void avpicture_free(AVPicture *picture);
3310 * Fill in the AVPicture fields.
3311 * The fields of the given AVPicture are filled in by using the 'ptr' address
3312 * which points to the image data buffer. Depending on the specified picture
3313 * format, one or multiple image data pointers and line sizes will be set.
3314 * If a planar format is specified, several pointers will be set pointing to
3315 * the different picture planes and the line sizes of the different planes
3316 * will be stored in the lines_sizes array.
3317 * Call with ptr == NULL to get the required size for the ptr buffer.
3319 * To allocate the buffer and fill in the AVPicture fields in one call,
3320 * use avpicture_alloc().
3322 * @param picture AVPicture whose fields are to be filled in
3323 * @param ptr Buffer which will contain or contains the actual image data
3324 * @param pix_fmt The format in which the picture data is stored.
3325 * @param width the width of the image in pixels
3326 * @param height the height of the image in pixels
3327 * @return size of the image data in bytes
3329 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3330 enum PixelFormat pix_fmt, int width, int height);
3333 * Copy pixel data from an AVPicture into a buffer.
3334 * The data is stored compactly, without any gaps for alignment or padding
3335 * which may be applied by avpicture_fill().
3337 * @see avpicture_get_size()
3339 * @param[in] src AVPicture containing image data
3340 * @param[in] pix_fmt The format in which the picture data is stored.
3341 * @param[in] width the width of the image in pixels.
3342 * @param[in] height the height of the image in pixels.
3343 * @param[out] dest A buffer into which picture data will be copied.
3344 * @param[in] dest_size The size of 'dest'.
3345 * @return The number of bytes written to dest, or a negative value (error code) on error.
3347 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3348 unsigned char *dest, int dest_size);
3351 * Calculate the size in bytes that a picture of the given width and height
3352 * would occupy if stored in the given picture format.
3353 * Note that this returns the size of a compact representation as generated
3354 * by avpicture_layout(), which can be smaller than the size required for e.g.
3357 * @param pix_fmt the given picture format
3358 * @param width the width of the image
3359 * @param height the height of the image
3360 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3362 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3363 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3366 * Get the name of a codec.
3367 * @return a static string identifying the codec; never NULL
3369 const char *avcodec_get_name(enum CodecID id);
3371 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3374 * Return a value representing the fourCC code associated to the
3375 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3378 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3381 * Put a string representing the codec tag codec_tag in buf.
3383 * @param buf_size size in bytes of buf
3384 * @return the length of the string that would have been generated if
3385 * enough space had been available, excluding the trailing null
3387 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3389 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3390 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3391 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3392 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3393 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3394 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3397 * Compute what kind of losses will occur when converting from one specific
3398 * pixel format to another.
3399 * When converting from one pixel format to another, information loss may occur.
3400 * For example, when converting from RGB24 to GRAY, the color information will
3401 * be lost. Similarly, other losses occur when converting from some formats to
3402 * other formats. These losses can involve loss of chroma, but also loss of
3403 * resolution, loss of color depth, loss due to the color space conversion, loss
3404 * of the alpha bits or loss due to color quantization.
3405 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3406 * which will occur when converting from one pixel format to another.
3408 * @param[in] dst_pix_fmt destination pixel format
3409 * @param[in] src_pix_fmt source pixel format
3410 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3411 * @return Combination of flags informing you what kind of losses will occur
3412 * (maximum loss for an invalid dst_pix_fmt).
3414 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3418 * Find the best pixel format to convert to given a certain source pixel
3419 * format. When converting from one pixel format to another, information loss
3420 * may occur. For example, when converting from RGB24 to GRAY, the color
3421 * information will be lost. Similarly, other losses occur when converting from
3422 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3423 * the given pixel formats should be used to suffer the least amount of loss.
3424 * The pixel formats from which it chooses one, are determined by the
3425 * pix_fmt_mask parameter.
3427 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
3430 * src_pix_fmt = PIX_FMT_YUV420P;
3431 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
3432 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3435 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3436 * @param[in] src_pix_fmt source pixel format
3437 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3438 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3439 * @return The best pixel format to convert to or -1 if none was found.
3441 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3442 int has_alpha, int *loss_ptr);
3445 * Find the best pixel format to convert to given a certain source pixel
3446 * format and a selection of two destination pixel formats. When converting from
3447 * one pixel format to another, information loss may occur. For example, when converting
3448 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
3449 * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
3450 * the given pixel formats should be used to suffer the least amount of loss.
3452 * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
3456 * src_pix_fmt = PIX_FMT_YUV420P;
3457 * dst_pix_fmt1= PIX_FMT_RGB24;
3458 * dst_pix_fmt2= PIX_FMT_GRAY8;
3459 * dst_pix_fmt3= PIX_FMT_RGB8;
3460 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
3461 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
3462 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
3465 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
3466 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
3467 * @param[in] src_pix_fmt Source pixel format
3468 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3469 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
3470 * NULL or value of zero means we care about all losses. Out: the loss
3471 * that occurs when converting from src to selected dst pixel format.
3472 * @return The best pixel format to convert to or -1 if none was found.
3474 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
3475 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3478 /* deinterlace a picture */
3479 /* deinterlace - if not supported return -1 */
3480 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3481 enum PixelFormat pix_fmt, int width, int height);
3483 /* external high level API */
3486 * If c is NULL, returns the first registered codec,
3487 * if c is non-NULL, returns the next registered codec after c,
3488 * or NULL if c is the last one.
3490 AVCodec *av_codec_next(AVCodec *c);
3493 * Return the LIBAVCODEC_VERSION_INT constant.
3495 unsigned avcodec_version(void);
3498 * Return the libavcodec build-time configuration.
3500 const char *avcodec_configuration(void);
3503 * Return the libavcodec license.
3505 const char *avcodec_license(void);
3508 * Register the codec codec and initialize libavcodec.
3510 * @warning either this function or avcodec_register_all() must be called
3511 * before any other libavcodec functions.
3513 * @see avcodec_register_all()
3515 void avcodec_register(AVCodec *codec);
3518 * Find a registered encoder with a matching codec ID.
3520 * @param id CodecID of the requested encoder
3521 * @return An encoder if one was found, NULL otherwise.
3523 AVCodec *avcodec_find_encoder(enum CodecID id);
3526 * Find a registered encoder with the specified name.
3528 * @param name name of the requested encoder
3529 * @return An encoder if one was found, NULL otherwise.
3531 AVCodec *avcodec_find_encoder_by_name(const char *name);
3534 * Find a registered decoder with a matching codec ID.
3536 * @param id CodecID of the requested decoder
3537 * @return A decoder if one was found, NULL otherwise.
3539 AVCodec *avcodec_find_decoder(enum CodecID id);
3542 * Find a registered decoder with the specified name.
3544 * @param name name of the requested decoder
3545 * @return A decoder if one was found, NULL otherwise.
3547 AVCodec *avcodec_find_decoder_by_name(const char *name);
3548 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3551 * Return a name for the specified profile, if available.
3553 * @param codec the codec that is searched for the given profile
3554 * @param profile the profile value for which a name is requested
3555 * @return A name for the profile if found, NULL otherwise.
3557 const char *av_get_profile_name(const AVCodec *codec, int profile);
3559 #if FF_API_ALLOC_CONTEXT
3561 * Set the fields of the given AVCodecContext to default values.
3563 * @param s The AVCodecContext of which the fields should be set to default values.
3564 * @deprecated use avcodec_get_context_defaults3
3566 attribute_deprecated
3567 void avcodec_get_context_defaults(AVCodecContext *s);
3569 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3570 * we WILL change its arguments and name a few times! */
3571 attribute_deprecated
3572 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3576 * Set the fields of the given AVCodecContext to default values corresponding
3577 * to the given codec (defaults may be codec-dependent).
3579 * Do not call this function if a non-NULL codec has been passed
3580 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3581 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3582 * different codec on this AVCodecContext.
3584 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3586 #if FF_API_ALLOC_CONTEXT
3588 * Allocate an AVCodecContext and set its fields to default values. The
3589 * resulting struct can be deallocated by simply calling av_free().
3591 * @return An AVCodecContext filled with default values or NULL on failure.
3592 * @see avcodec_get_context_defaults
3594 * @deprecated use avcodec_alloc_context3()
3596 attribute_deprecated
3597 AVCodecContext *avcodec_alloc_context(void);
3599 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3600 * we WILL change its arguments and name a few times! */
3601 attribute_deprecated
3602 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3606 * Allocate an AVCodecContext and set its fields to default values. The
3607 * resulting struct can be deallocated by calling avcodec_close() on it followed
3610 * @param codec if non-NULL, allocate private data and initialize defaults
3611 * for the given codec. It is illegal to then call avcodec_open2()
3612 * with a different codec.
3613 * If NULL, then the codec-specific defaults won't be initialized,
3614 * which may result in suboptimal default settings (this is
3615 * important mainly for encoders, e.g. libx264).
3617 * @return An AVCodecContext filled with default values or NULL on failure.
3618 * @see avcodec_get_context_defaults
3620 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3623 * Copy the settings of the source AVCodecContext into the destination
3624 * AVCodecContext. The resulting destination codec context will be
3625 * unopened, i.e. you are required to call avcodec_open2() before you
3626 * can use this AVCodecContext to decode/encode video/audio data.
3628 * @param dest target codec context, should be initialized with
3629 * avcodec_alloc_context3(), but otherwise uninitialized
3630 * @param src source codec context
3631 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3633 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3636 * Set the fields of the given AVFrame to default values.
3638 * @param pic The AVFrame of which the fields should be set to default values.
3640 void avcodec_get_frame_defaults(AVFrame *pic);
3643 * Allocate an AVFrame and set its fields to default values. The resulting
3644 * struct can be deallocated by simply calling av_free().
3646 * @return An AVFrame filled with default values or NULL on failure.
3647 * @see avcodec_get_frame_defaults
3649 AVFrame *avcodec_alloc_frame(void);
3651 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3652 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3653 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3656 * Return the amount of padding in pixels which the get_buffer callback must
3657 * provide around the edge of the image for codecs which do not have the
3658 * CODEC_FLAG_EMU_EDGE flag.
3660 * @return Required padding in pixels.
3662 unsigned avcodec_get_edge_width(void);
3664 * Modify width and height values so that they will result in a memory
3665 * buffer that is acceptable for the codec if you do not use any horizontal
3668 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3669 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3670 * according to avcodec_get_edge_width() before.
3672 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3674 * Modify width and height values so that they will result in a memory
3675 * buffer that is acceptable for the codec if you also ensure that all
3676 * line sizes are a multiple of the respective linesize_align[i].
3678 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3679 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3680 * according to avcodec_get_edge_width() before.
3682 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3683 int linesize_align[AV_NUM_DATA_POINTERS]);
3685 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3687 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3688 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3689 //FIXME func typedef
3691 #if FF_API_AVCODEC_OPEN
3693 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3694 * function the context has to be allocated.
3696 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3697 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3698 * retrieving a codec.
3700 * @warning This function is not thread safe!
3703 * avcodec_register_all();
3704 * codec = avcodec_find_decoder(CODEC_ID_H264);
3708 * context = avcodec_alloc_context3(codec);
3710 * if (avcodec_open(context, codec) < 0)
3714 * @param avctx The context which will be set up to use the given codec.
3715 * @param codec The codec to use within the context.
3716 * @return zero on success, a negative value on error
3717 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3719 * @deprecated use avcodec_open2
3721 attribute_deprecated
3722 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3726 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3727 * function the context has to be allocated with avcodec_alloc_context3().
3729 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3730 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3731 * retrieving a codec.
3733 * @warning This function is not thread safe!
3736 * avcodec_register_all();
3737 * av_dict_set(&opts, "b", "2.5M", 0);
3738 * codec = avcodec_find_decoder(CODEC_ID_H264);
3742 * context = avcodec_alloc_context3(codec);
3744 * if (avcodec_open2(context, codec, opts) < 0)
3748 * @param avctx The context to initialize.
3749 * @param codec The codec to open this context for. If a non-NULL codec has been
3750 * previously passed to avcodec_alloc_context3() or
3751 * avcodec_get_context_defaults3() for this context, then this
3752 * parameter MUST be either NULL or equal to the previously passed
3754 * @param options A dictionary filled with AVCodecContext and codec-private options.
3755 * On return this object will be filled with options that were not found.
3757 * @return zero on success, a negative value on error
3758 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3759 * av_dict_set(), av_opt_find().
3761 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3763 #if FF_API_OLD_DECODE_AUDIO
3765 * Wrapper function which calls avcodec_decode_audio4.
3767 * @deprecated Use avcodec_decode_audio4 instead.
3769 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3770 * Some decoders may support multiple frames in a single AVPacket, such
3771 * decoders would then just decode the first frame. In this case,
3772 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3773 * the remaining data in order to decode the second frame etc.
3775 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3776 * decompressed frame size in bytes.
3778 * @warning You must set frame_size_ptr to the allocated size of the
3779 * output buffer before calling avcodec_decode_audio3().
3781 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3782 * the actual read bytes because some optimized bitstream readers read 32 or 64
3783 * bits at once and could read over the end.
3785 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3786 * no overreading happens for damaged MPEG streams.
3788 * @warning You must not provide a custom get_buffer() when using
3789 * avcodec_decode_audio3(). Doing so will override it with
3790 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3791 * which does allow the application to provide a custom get_buffer().
3793 * @note You might have to align the input buffer avpkt->data and output buffer
3794 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3795 * necessary at all, on others it won't work at all if not aligned and on others
3796 * it will work but it will have an impact on performance.
3798 * In practice, avpkt->data should have 4 byte alignment at minimum and
3799 * samples should be 16 byte aligned unless the CPU doesn't need it
3800 * (AltiVec and SSE do).
3802 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3803 * between input and output, these need to be fed with avpkt->data=NULL,
3804 * avpkt->size=0 at the end to return the remaining frames.
3806 * @param avctx the codec context
3807 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3808 * If the sample format is planar, each channel plane will
3809 * be the same size, with no padding between channels.
3810 * @param[in,out] frame_size_ptr the output buffer size in bytes
3811 * @param[in] avpkt The input AVPacket containing the input buffer.
3812 * You can create such packet with av_init_packet() and by then setting
3813 * data and size, some decoders might in addition need other fields.
3814 * All decoders are designed to use the least fields possible though.
3815 * @return On error a negative value is returned, otherwise the number of bytes
3816 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3818 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3819 int *frame_size_ptr,
3824 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3826 * Some decoders may support multiple frames in a single AVPacket. Such
3827 * decoders would then just decode the first frame. In this case,
3828 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3829 * the remaining data in order to decode the second frame, etc...
3830 * Even if no frames are returned, the packet needs to be fed to the decoder
3831 * with remaining data until it is completely consumed or an error occurs.
3833 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3834 * larger than the actual read bytes because some optimized bitstream
3835 * readers read 32 or 64 bits at once and could read over the end.
3837 * @note You might have to align the input buffer. The alignment requirements
3838 * depend on the CPU and the decoder.
3840 * @param avctx the codec context
3841 * @param[out] frame The AVFrame in which to store decoded audio samples.
3842 * Decoders request a buffer of a particular size by setting
3843 * AVFrame.nb_samples prior to calling get_buffer(). The
3844 * decoder may, however, only utilize part of the buffer by
3845 * setting AVFrame.nb_samples to a smaller value in the
3847 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3849 * @param[in] avpkt The input AVPacket containing the input buffer.
3850 * At least avpkt->data and avpkt->size should be set. Some
3851 * decoders might also require additional fields to be set.
3852 * @return A negative error code is returned if an error occurred during
3853 * decoding, otherwise the number of bytes consumed from the input
3854 * AVPacket is returned.
3856 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3857 int *got_frame_ptr, AVPacket *avpkt);
3860 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3861 * Some decoders may support multiple frames in a single AVPacket, such
3862 * decoders would then just decode the first frame.
3864 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3865 * the actual read bytes because some optimized bitstream readers read 32 or 64
3866 * bits at once and could read over the end.
3868 * @warning The end of the input buffer buf should be set to 0 to ensure that
3869 * no overreading happens for damaged MPEG streams.
3871 * @note You might have to align the input buffer avpkt->data.
3872 * The alignment requirements depend on the CPU: on some CPUs it isn't
3873 * necessary at all, on others it won't work at all if not aligned and on others
3874 * it will work but it will have an impact on performance.
3876 * In practice, avpkt->data should have 4 byte alignment at minimum.
3878 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3879 * between input and output, these need to be fed with avpkt->data=NULL,
3880 * avpkt->size=0 at the end to return the remaining frames.
3882 * @param avctx the codec context
3883 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3884 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3885 * allocate memory for the actual bitmap.
3886 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3887 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3888 * decodes and the decoder tells the user once it does not need the data anymore,
3889 * the user app can at this point free/reuse/keep the memory as it sees fit.
3891 * @param[in] avpkt The input AVpacket containing the input buffer.
3892 * You can create such packet with av_init_packet() and by then setting
3893 * data and size, some decoders might in addition need other fields like
3894 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3896 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3897 * @return On error a negative value is returned, otherwise the number of bytes
3898 * used or zero if no frame could be decompressed.
3900 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3901 int *got_picture_ptr,
3902 const AVPacket *avpkt);
3905 * Decode a subtitle message.
3906 * Return a negative value on error, otherwise return the number of bytes used.
3907 * If no subtitle could be decompressed, got_sub_ptr is zero.
3908 * Otherwise, the subtitle is stored in *sub.
3909 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3910 * simplicity, because the performance difference is expect to be negligible
3911 * and reusing a get_buffer written for video codecs would probably perform badly
3912 * due to a potentially very different allocation pattern.
3914 * @param avctx the codec context
3915 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3916 freed with avsubtitle_free if *got_sub_ptr is set.
3917 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3918 * @param[in] avpkt The input AVPacket containing the input buffer.
3920 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3925 * Free all allocated data in the given subtitle struct.
3927 * @param sub AVSubtitle to free.
3929 void avsubtitle_free(AVSubtitle *sub);
3931 #if FF_API_OLD_ENCODE_AUDIO
3933 * Encode an audio frame from samples into buf.
3935 * @deprecated Use avcodec_encode_audio2 instead.
3937 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3938 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3939 * will know how much space is needed because it depends on the value passed
3940 * in buf_size as described below. In that case a lower value can be used.
3942 * @param avctx the codec context
3943 * @param[out] buf the output buffer
3944 * @param[in] buf_size the output buffer size
3945 * @param[in] samples the input buffer containing the samples
3946 * The number of samples read from this buffer is frame_size*channels,
3947 * both of which are defined in avctx.
3948 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3949 * samples read from samples is equal to:
3950 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3951 * This also implies that av_get_bits_per_sample() must not return 0 for these
3953 * @return On error a negative value is returned, on success zero or the number
3954 * of bytes used to encode the data read from the input buffer.
3956 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3957 uint8_t *buf, int buf_size,
3958 const short *samples);
3962 * Encode a frame of audio.
3964 * Takes input samples from frame and writes the next output packet, if
3965 * available, to avpkt. The output packet does not necessarily contain data for
3966 * the most recent frame, as encoders can delay, split, and combine input frames
3967 * internally as needed.
3969 * @param avctx codec context
3970 * @param avpkt output AVPacket.
3971 * The user can supply an output buffer by setting
3972 * avpkt->data and avpkt->size prior to calling the
3973 * function, but if the size of the user-provided data is not
3974 * large enough, encoding will fail. All other AVPacket fields
3975 * will be reset by the encoder using av_init_packet(). If
3976 * avpkt->data is NULL, the encoder will allocate it.
3977 * The encoder will set avpkt->size to the size of the
3980 * If this function fails or produces no output, avpkt will be
3981 * freed using av_free_packet() (i.e. avpkt->destruct will be
3982 * called to free the user supplied buffer).
3983 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3984 * May be NULL when flushing an encoder that has the
3985 * CODEC_CAP_DELAY capability set.
3986 * There are 2 codec capabilities that affect the allowed
3987 * values of frame->nb_samples.
3988 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
3989 * frame may be smaller than avctx->frame_size, and all other
3990 * frames must be equal to avctx->frame_size.
3991 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3992 * can have any number of samples.
3993 * If neither is set, frame->nb_samples must be equal to
3994 * avctx->frame_size for all frames.
3995 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3996 * output packet is non-empty, and to 0 if it is
3997 * empty. If the function returns an error, the
3998 * packet can be assumed to be invalid, and the
3999 * value of got_packet_ptr is undefined and should
4001 * @return 0 on success, negative error code on failure
4003 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4004 const AVFrame *frame, int *got_packet_ptr);
4007 * Fill audio frame data and linesize.
4008 * AVFrame extended_data channel pointers are allocated if necessary for
4011 * @param frame the AVFrame
4012 * frame->nb_samples must be set prior to calling the
4013 * function. This function fills in frame->data,
4014 * frame->extended_data, frame->linesize[0].
4015 * @param nb_channels channel count
4016 * @param sample_fmt sample format
4017 * @param buf buffer to use for frame data
4018 * @param buf_size size of buffer
4019 * @param align plane size sample alignment
4020 * @return 0 on success, negative error code on failure
4022 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4023 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4024 int buf_size, int align);
4026 #if FF_API_OLD_ENCODE_VIDEO
4028 * @deprecated use avcodec_encode_video2() instead.
4030 * Encode a video frame from pict into buf.
4031 * The input picture should be
4032 * stored using a specific format, namely avctx.pix_fmt.
4034 * @param avctx the codec context
4035 * @param[out] buf the output buffer for the bitstream of encoded frame
4036 * @param[in] buf_size the size of the output buffer in bytes
4037 * @param[in] pict the input picture to encode
4038 * @return On error a negative value is returned, on success zero or the number
4039 * of bytes used from the output buffer.
4041 attribute_deprecated
4042 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4043 const AVFrame *pict);
4047 * Encode a frame of video.
4049 * Takes input raw video data from frame and writes the next output packet, if
4050 * available, to avpkt. The output packet does not necessarily contain data for
4051 * the most recent frame, as encoders can delay and reorder input frames
4052 * internally as needed.
4054 * @param avctx codec context
4055 * @param avpkt output AVPacket.
4056 * The user can supply an output buffer by setting
4057 * avpkt->data and avpkt->size prior to calling the
4058 * function, but if the size of the user-provided data is not
4059 * large enough, encoding will fail. All other AVPacket fields
4060 * will be reset by the encoder using av_init_packet(). If
4061 * avpkt->data is NULL, the encoder will allocate it.
4062 * The encoder will set avpkt->size to the size of the
4063 * output packet. The returned data (if any) belongs to the
4064 * caller, he is responsible for freeing it.
4066 * If this function fails or produces no output, avpkt will be
4067 * freed using av_free_packet() (i.e. avpkt->destruct will be
4068 * called to free the user supplied buffer).
4069 * @param[in] frame AVFrame containing the raw video data to be encoded.
4070 * May be NULL when flushing an encoder that has the
4071 * CODEC_CAP_DELAY capability set.
4072 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4073 * output packet is non-empty, and to 0 if it is
4074 * empty. If the function returns an error, the
4075 * packet can be assumed to be invalid, and the
4076 * value of got_packet_ptr is undefined and should
4078 * @return 0 on success, negative error code on failure
4080 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4081 const AVFrame *frame, int *got_packet_ptr);
4083 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4084 const AVSubtitle *sub);
4087 * Close a given AVCodecContext and free all the data associated with it
4088 * (but not the AVCodecContext itself).
4090 * Calling this function on an AVCodecContext that hasn't been opened will free
4091 * the codec-specific data allocated in avcodec_alloc_context3() /
4092 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
4095 int avcodec_close(AVCodecContext *avctx);
4098 * Register all the codecs, parsers and bitstream filters which were enabled at
4099 * configuration time. If you do not call this function you can select exactly
4100 * which formats you want to support, by using the individual registration
4103 * @see avcodec_register
4104 * @see av_register_codec_parser
4105 * @see av_register_bitstream_filter
4107 void avcodec_register_all(void);
4110 * Flush buffers, should be called when seeking or when switching to a different stream.
4112 void avcodec_flush_buffers(AVCodecContext *avctx);
4114 void avcodec_default_free_buffers(AVCodecContext *s);
4116 /* misc useful functions */
4119 * Return codec bits per sample.
4121 * @param[in] codec_id the codec
4122 * @return Number of bits per sample or zero if unknown for the given codec.
4124 int av_get_bits_per_sample(enum CodecID codec_id);
4127 * Return the PCM codec associated with a sample format.
4128 * @param be endianness, 0 for little, 1 for big,
4129 * -1 (or anything else) for native
4130 * @return CODEC_ID_PCM_* or CODEC_ID_NONE
4132 enum CodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4135 * Return codec bits per sample.
4136 * Only return non-zero if the bits per sample is exactly correct, not an
4139 * @param[in] codec_id the codec
4140 * @return Number of bits per sample or zero if unknown for the given codec.
4142 int av_get_exact_bits_per_sample(enum CodecID codec_id);
4145 * Return audio frame duration.
4147 * @param avctx codec context
4148 * @param frame_bytes size of the frame, or 0 if unknown
4149 * @return frame duration, in samples, if known. 0 if not able to
4152 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4155 typedef struct AVCodecParserContext {
4157 struct AVCodecParser *parser;
4158 int64_t frame_offset; /* offset of the current frame */
4159 int64_t cur_offset; /* current offset
4160 (incremented by each av_parser_parse()) */
4161 int64_t next_frame_offset; /* offset of the next frame */
4163 int pict_type; /* XXX: Put it back in AVCodecContext. */
4165 * This field is used for proper frame duration computation in lavf.
4166 * It signals, how much longer the frame duration of the current frame
4167 * is compared to normal frame duration.
4169 * frame_duration = (1 + repeat_pict) * time_base
4171 * It is used by codecs like H.264 to display telecined material.
4173 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4174 int64_t pts; /* pts of the current frame */
4175 int64_t dts; /* dts of the current frame */
4180 int fetch_timestamp;
4182 #define AV_PARSER_PTS_NB 4
4183 int cur_frame_start_index;
4184 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4185 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4186 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4189 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4190 #define PARSER_FLAG_ONCE 0x0002
4191 /// Set if the parser has a valid file offset
4192 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4194 int64_t offset; ///< byte offset from starting packet start
4195 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4198 * Set by parser to 1 for key frames and 0 for non-key frames.
4199 * It is initialized to -1, so if the parser doesn't set this flag,
4200 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4206 * Time difference in stream time base units from the pts of this
4207 * packet to the point at which the output from the decoder has converged
4208 * independent from the availability of previous frames. That is, the
4209 * frames are virtually identical no matter if decoding started from
4210 * the very first frame or from this keyframe.
4211 * Is AV_NOPTS_VALUE if unknown.
4212 * This field is not the display duration of the current frame.
4213 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4216 * The purpose of this field is to allow seeking in streams that have no
4217 * keyframes in the conventional sense. It corresponds to the
4218 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4219 * essential for some types of subtitle streams to ensure that all
4220 * subtitles are correctly displayed after seeking.
4222 int64_t convergence_duration;
4224 // Timestamp generation support:
4226 * Synchronization point for start of timestamp generation.
4228 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4231 * For example, this corresponds to presence of H.264 buffering period
4237 * Offset of the current timestamp against last timestamp sync point in
4238 * units of AVCodecContext.time_base.
4240 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4241 * contain a valid timestamp offset.
4243 * Note that the timestamp of sync point has usually a nonzero
4244 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4245 * the next frame after timestamp sync point will be usually 1.
4247 * For example, this corresponds to H.264 cpb_removal_delay.
4249 int dts_ref_dts_delta;
4252 * Presentation delay of current frame in units of AVCodecContext.time_base.
4254 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4255 * contain valid non-negative timestamp delta (presentation time of a frame
4256 * must not lie in the past).
4258 * This delay represents the difference between decoding and presentation
4259 * time of the frame.
4261 * For example, this corresponds to H.264 dpb_output_delay.
4266 * Position of the packet in file.
4268 * Analogous to cur_frame_pts/dts
4270 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4273 * Byte position of currently parsed frame in stream.
4278 * Previous frame byte position.
4283 * Duration of the current frame.
4284 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4285 * For all other types, this is in units of AVCodecContext.time_base.
4288 } AVCodecParserContext;
4290 typedef struct AVCodecParser {
4291 int codec_ids[5]; /* several codec IDs are permitted */
4293 int (*parser_init)(AVCodecParserContext *s);
4294 int (*parser_parse)(AVCodecParserContext *s,
4295 AVCodecContext *avctx,
4296 const uint8_t **poutbuf, int *poutbuf_size,
4297 const uint8_t *buf, int buf_size);
4298 void (*parser_close)(AVCodecParserContext *s);
4299 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4300 struct AVCodecParser *next;
4303 AVCodecParser *av_parser_next(AVCodecParser *c);
4305 void av_register_codec_parser(AVCodecParser *parser);
4306 AVCodecParserContext *av_parser_init(int codec_id);
4311 * @param s parser context.
4312 * @param avctx codec context.
4313 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4314 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4315 * @param buf input buffer.
4316 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4317 * @param pts input presentation timestamp.
4318 * @param dts input decoding timestamp.
4319 * @param pos input byte position in stream.
4320 * @return the number of bytes of the input bitstream used.
4325 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4332 * decode_frame(data, size);
4336 int av_parser_parse2(AVCodecParserContext *s,
4337 AVCodecContext *avctx,
4338 uint8_t **poutbuf, int *poutbuf_size,
4339 const uint8_t *buf, int buf_size,
4340 int64_t pts, int64_t dts,
4343 int av_parser_change(AVCodecParserContext *s,
4344 AVCodecContext *avctx,
4345 uint8_t **poutbuf, int *poutbuf_size,
4346 const uint8_t *buf, int buf_size, int keyframe);
4347 void av_parser_close(AVCodecParserContext *s);
4350 typedef struct AVBitStreamFilterContext {
4352 struct AVBitStreamFilter *filter;
4353 AVCodecParserContext *parser;
4354 struct AVBitStreamFilterContext *next;
4355 } AVBitStreamFilterContext;
4358 typedef struct AVBitStreamFilter {
4361 int (*filter)(AVBitStreamFilterContext *bsfc,
4362 AVCodecContext *avctx, const char *args,
4363 uint8_t **poutbuf, int *poutbuf_size,
4364 const uint8_t *buf, int buf_size, int keyframe);
4365 void (*close)(AVBitStreamFilterContext *bsfc);
4366 struct AVBitStreamFilter *next;
4367 } AVBitStreamFilter;
4369 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4370 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4371 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4372 AVCodecContext *avctx, const char *args,
4373 uint8_t **poutbuf, int *poutbuf_size,
4374 const uint8_t *buf, int buf_size, int keyframe);
4375 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4377 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4382 * Reallocate the given block if it is not large enough, otherwise do nothing.
4386 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4389 * Allocate a buffer, reusing the given one if large enough.
4391 * Contrary to av_fast_realloc the current buffer contents might not be
4392 * preserved and on error the old buffer is freed, thus no special
4393 * handling to avoid memleaks is necessary.
4395 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4396 * @param size size of the buffer *ptr points to
4397 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4398 * *size 0 if an error occurred.
4400 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4403 * Same behaviour av_fast_malloc but the buffer has additional
4404 * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
4406 * In addition the whole buffer will initially and after resizes
4407 * be 0-initialized so that no uninitialized data will ever appear.
4409 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4412 * Copy image src to dst. Wraps av_picture_data_copy() above.
4414 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4415 enum PixelFormat pix_fmt, int width, int height);
4418 * Crop image top and left side.
4420 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4421 enum PixelFormat pix_fmt, int top_band, int left_band);
4426 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4427 int padtop, int padbottom, int padleft, int padright, int *color);
4430 * Encode extradata length to a buffer. Used by xiph codecs.
4432 * @param s buffer to write to; must be at least (v/255+1) bytes long
4433 * @param v size of extradata in bytes
4434 * @return number of bytes written to the buffer.
4436 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4439 * Log a generic warning message about a missing feature. This function is
4440 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4441 * only, and would normally not be used by applications.
4442 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4443 * a pointer to an AVClass struct
4444 * @param[in] feature string containing the name of the missing feature
4445 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4446 * If want_sample is non-zero, additional verbage will be added to the log
4447 * message which tells the user how to report samples to the development
4450 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4453 * Log a generic warning message asking for a sample. This function is
4454 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4455 * only, and would normally not be used by applications.
4456 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4457 * a pointer to an AVClass struct
4458 * @param[in] msg string containing an optional message, or NULL if no message
4460 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4463 * Register the hardware accelerator hwaccel.
4465 void av_register_hwaccel(AVHWAccel *hwaccel);
4468 * If hwaccel is NULL, returns the first registered hardware accelerator,
4469 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4470 * after hwaccel, or NULL if hwaccel is the last one.
4472 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4476 * Lock operation used by lockmgr
4479 AV_LOCK_CREATE, ///< Create a mutex
4480 AV_LOCK_OBTAIN, ///< Lock the mutex
4481 AV_LOCK_RELEASE, ///< Unlock the mutex
4482 AV_LOCK_DESTROY, ///< Free mutex resources
4486 * Register a user provided lock manager supporting the operations
4487 * specified by AVLockOp. mutex points to a (void *) where the
4488 * lockmgr should store/get a pointer to a user allocated mutex. It's
4489 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4491 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4492 * callback during the call to av_lockmgr_register().
4493 * Thus, the application must be prepared to handle that.
4494 * If cb is set to NULL the lockmgr will be unregistered.
4495 * Also note that during unregistration the previously registered
4496 * lockmgr callback may also be invoked.
4498 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4501 * Get the type of the given codec.
4503 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4506 * Get the AVClass for AVCodecContext. It can be used in combination with
4507 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4509 * @see av_opt_find().
4511 const AVClass *avcodec_get_class(void);
4514 * Get the AVClass for AVFrame. It can be used in combination with
4515 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4517 * @see av_opt_find().
4519 const AVClass *avcodec_get_frame_class(void);
4522 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4523 * with no corresponding avcodec_close()), 0 otherwise.
4525 int avcodec_is_open(AVCodecContext *s);
4528 * @return a non-zero number if codec is an encoder, zero otherwise
4530 int av_codec_is_encoder(AVCodec *codec);
4533 * @return a non-zero number if codec is a decoder, zero otherwise
4535 int av_codec_is_decoder(AVCodec *codec);
4537 #endif /* AVCODEC_AVCODEC_H */