2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * Libav is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
40 * @defgroup libavc Encoding/Decoding Library
43 * @defgroup lavc_decoding Decoding
47 * @defgroup lavc_encoding Encoding
51 * @defgroup lavc_codec Codecs
53 * @defgroup lavc_codec_native Native Codecs
56 * @defgroup lavc_codec_wrappers External library wrappers
59 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
63 * @defgroup lavc_internal Internal
72 * Identify the syntax and semantics of the bitstream.
73 * The principle is roughly:
74 * Two decoders with the same ID can decode the same streams.
75 * Two encoders with the same ID can encode compatible streams.
76 * There may be slight deviations from the principle due to implementation
79 * If you add a codec ID to this list, add it so that
80 * 1. no value of a existing codec ID changes (that would break ABI),
81 * 2. it is as close as possible to similar codecs.
88 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
89 CODEC_ID_MPEG2VIDEO_XVMC,
126 CODEC_ID_INTERPLAY_VIDEO,
138 CODEC_ID_TRUEMOTION1,
165 CODEC_ID_TRUEMOTION2,
182 CODEC_ID_DSICINVIDEO,
183 CODEC_ID_TIERTEXSEQVIDEO,
191 CODEC_ID_BETHSOFTVID,
207 CODEC_ID_MOTIONPIXELS,
225 CODEC_ID_IFF_BYTERUN1,
249 /* various PCM "codecs" */
250 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
251 CODEC_ID_PCM_S16LE = 0x10000,
267 CODEC_ID_PCM_S24DAUD,
269 CODEC_ID_PCM_S16LE_PLANAR,
278 CODEC_ID_PCM_S8_PLANAR,
280 /* various ADPCM codecs */
281 CODEC_ID_ADPCM_IMA_QT = 0x11000,
282 CODEC_ID_ADPCM_IMA_WAV,
283 CODEC_ID_ADPCM_IMA_DK3,
284 CODEC_ID_ADPCM_IMA_DK4,
285 CODEC_ID_ADPCM_IMA_WS,
286 CODEC_ID_ADPCM_IMA_SMJPEG,
295 CODEC_ID_ADPCM_YAMAHA,
296 CODEC_ID_ADPCM_SBPRO_4,
297 CODEC_ID_ADPCM_SBPRO_3,
298 CODEC_ID_ADPCM_SBPRO_2,
300 CODEC_ID_ADPCM_IMA_AMV,
301 CODEC_ID_ADPCM_EA_R1,
302 CODEC_ID_ADPCM_EA_R3,
303 CODEC_ID_ADPCM_EA_R2,
304 CODEC_ID_ADPCM_IMA_EA_SEAD,
305 CODEC_ID_ADPCM_IMA_EA_EACS,
306 CODEC_ID_ADPCM_EA_XAS,
307 CODEC_ID_ADPCM_EA_MAXIS_XA,
308 CODEC_ID_ADPCM_IMA_ISS,
310 CODEC_ID_ADPCM_IMA_APC,
313 CODEC_ID_AMR_NB = 0x12000,
316 /* RealAudio codecs*/
317 CODEC_ID_RA_144 = 0x13000,
320 /* various DPCM codecs */
321 CODEC_ID_ROQ_DPCM = 0x14000,
322 CODEC_ID_INTERPLAY_DPCM,
327 CODEC_ID_MP2 = 0x15000,
328 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
344 CODEC_ID_WESTWOOD_SND1,
345 CODEC_ID_GSM, ///< as in Berlin toast format
353 CODEC_ID_DSICINAUDIO,
357 CODEC_ID_GSM_MS, /* as found in WAV */
366 CODEC_ID_WMALOSSLESS,
375 CODEC_ID_BINKAUDIO_RDFT,
376 CODEC_ID_BINKAUDIO_DCT,
386 /* subtitle codecs */
387 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
388 CODEC_ID_DVD_SUBTITLE = 0x17000,
389 CODEC_ID_DVB_SUBTITLE,
390 CODEC_ID_TEXT, ///< raw UTF-8 text
394 CODEC_ID_HDMV_PGS_SUBTITLE,
395 CODEC_ID_DVB_TELETEXT,
398 /* other specific kind of codecs (generally used for attachments) */
399 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
400 CODEC_ID_TTF = 0x18000,
402 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
404 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
405 * stream (only used by libavformat) */
406 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
407 * stream (only used by libavformat) */
408 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
411 #if FF_API_OLD_DECODE_AUDIO
413 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
417 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
418 * This is mainly needed because some optimized bitstream readers read
419 * 32 or 64 bit at once and could read over the end.<br>
420 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
421 * MPEG bitstreams could cause overread and segfault.
423 #define FF_INPUT_BUFFER_PADDING_SIZE 8
426 * minimum encoding buffer size
427 * Used to avoid some checks during header writing.
429 #define FF_MIN_BUFFER_SIZE 16384
433 * motion estimation type.
436 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
440 ME_EPZS, ///< enhanced predictive zonal search
441 ME_X1, ///< reserved for experiments
442 ME_HEX, ///< hexagon based search
443 ME_UMH, ///< uneven multi-hexagon search
444 ME_ITER, ///< iterative search
445 ME_TESA, ///< transformed exhaustive search algorithm
449 /* We leave some space between them for extensions (drop some
450 * keyframes for intra-only or drop just some bidir frames). */
451 AVDISCARD_NONE =-16, ///< discard nothing
452 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
453 AVDISCARD_NONREF = 8, ///< discard all non reference
454 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
455 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
456 AVDISCARD_ALL = 48, ///< discard all
459 enum AVColorPrimaries{
460 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
461 AVCOL_PRI_UNSPECIFIED=2,
463 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
464 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
465 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
467 AVCOL_PRI_NB , ///< Not part of ABI
470 enum AVColorTransferCharacteristic{
471 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
472 AVCOL_TRC_UNSPECIFIED=2,
473 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
474 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
475 AVCOL_TRC_NB , ///< Not part of ABI
480 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
481 AVCOL_SPC_UNSPECIFIED=2,
483 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
484 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
485 AVCOL_SPC_SMPTE240M =7,
486 AVCOL_SPC_NB , ///< Not part of ABI
490 AVCOL_RANGE_UNSPECIFIED=0,
491 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
492 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
493 AVCOL_RANGE_NB , ///< Not part of ABI
497 * X X 3 4 X X are luma samples,
498 * 1 2 1-6 are possible chroma positions
499 * X X 5 6 X 0 is undefined/unknown position
501 enum AVChromaLocation{
502 AVCHROMA_LOC_UNSPECIFIED=0,
503 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
504 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
505 AVCHROMA_LOC_TOPLEFT =3, ///< DV
507 AVCHROMA_LOC_BOTTOMLEFT =5,
508 AVCHROMA_LOC_BOTTOM =6,
509 AVCHROMA_LOC_NB , ///< Not part of ABI
512 enum AVAudioServiceType {
513 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
514 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
515 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
516 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
517 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
518 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
519 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
520 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
521 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
522 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
525 typedef struct RcOverride{
528 int qscale; // If this is 0 then quality_factor will be used instead.
529 float quality_factor;
532 #define FF_MAX_B_FRAMES 16
535 These flags can be passed in AVCodecContext.flags before initialization.
536 Note: Not everything is supported yet.
539 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
540 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
541 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
542 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
543 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
545 * The parent program guarantees that the input for B-frames containing
546 * streams is not written to for at least s->max_b_frames+1 frames, if
547 * this is not set the input will be copied.
549 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
550 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
551 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
552 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
553 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
554 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
555 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
556 location instead of only at frame boundaries. */
557 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
558 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
559 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
560 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
561 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
562 /* Fx : Flag for h263+ extra options */
563 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
564 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
565 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
566 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
567 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
568 #define CODEC_FLAG_CLOSED_GOP 0x80000000
569 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
570 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
571 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
572 #if FF_API_MPV_GLOBAL_OPTS
573 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
574 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
576 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
578 /* Unsupported options :
579 * Syntax Arithmetic coding (SAC)
580 * Reference Picture Selection
581 * Independent Segment Decoding */
583 /* codec capabilities */
585 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
587 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
588 * If not set, it might not use get_buffer() at all or use operations that
589 * assume the buffer was allocated by avcodec_default_get_buffer.
591 #define CODEC_CAP_DR1 0x0002
592 #define CODEC_CAP_TRUNCATED 0x0008
593 /* Codec can export data for HW decoding (XvMC). */
594 #define CODEC_CAP_HWACCEL 0x0010
596 * Encoder or decoder requires flushing with NULL input at the end in order to
597 * give the complete and correct output.
599 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
600 * with NULL data. The user can still send NULL data to the public encode
601 * or decode function, but libavcodec will not pass it along to the codec
602 * unless this flag is set.
605 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
606 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
610 * The encoder needs to be fed with NULL data at the end of encoding until the
611 * encoder no longer returns data.
613 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
614 * flag also means that the encoder must set the pts and duration for
615 * each output packet. If this flag is not set, the pts and duration will
616 * be determined by libavcodec from the input frame.
618 #define CODEC_CAP_DELAY 0x0020
620 * Codec can be fed a final frame with a smaller size.
621 * This can be used to prevent truncation of the last audio samples.
623 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
625 * Codec can export data for HW decoding (VDPAU).
627 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
629 * Codec can output multiple frames per AVPacket
630 * Normally demuxers return one frame at a time, demuxers which do not do
631 * are connected to a parser to split what they return into proper frames.
632 * This flag is reserved to the very rare category of codecs which have a
633 * bitstream that cannot be split into frames without timeconsuming
634 * operations like full decoding. Demuxers carring such bitstreams thus
635 * may return multiple frames in a packet. This has many disadvantages like
636 * prohibiting stream copy in many cases thus it should only be considered
639 #define CODEC_CAP_SUBFRAMES 0x0100
641 * Codec is experimental and is thus avoided in favor of non experimental
644 #define CODEC_CAP_EXPERIMENTAL 0x0200
646 * Codec should fill in channel configuration and samplerate instead of container
648 #define CODEC_CAP_CHANNEL_CONF 0x0400
650 * Codec is able to deal with negative linesizes
652 #define CODEC_CAP_NEG_LINESIZES 0x0800
654 * Codec supports frame-level multithreading.
656 #define CODEC_CAP_FRAME_THREADS 0x1000
658 * Codec supports slice-based (or partition-based) multithreading.
660 #define CODEC_CAP_SLICE_THREADS 0x2000
662 * Codec supports changed parameters at any point.
664 #define CODEC_CAP_PARAM_CHANGE 0x4000
666 * Codec supports avctx->thread_count == 0 (auto).
668 #define CODEC_CAP_AUTO_THREADS 0x8000
670 * Audio encoder supports receiving a different number of samples in each call.
672 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
674 //The following defines may change, don't expect compatibility if you use them.
675 #define MB_TYPE_INTRA4x4 0x0001
676 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
677 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
678 #define MB_TYPE_16x16 0x0008
679 #define MB_TYPE_16x8 0x0010
680 #define MB_TYPE_8x16 0x0020
681 #define MB_TYPE_8x8 0x0040
682 #define MB_TYPE_INTERLACED 0x0080
683 #define MB_TYPE_DIRECT2 0x0100 //FIXME
684 #define MB_TYPE_ACPRED 0x0200
685 #define MB_TYPE_GMC 0x0400
686 #define MB_TYPE_SKIP 0x0800
687 #define MB_TYPE_P0L0 0x1000
688 #define MB_TYPE_P1L0 0x2000
689 #define MB_TYPE_P0L1 0x4000
690 #define MB_TYPE_P1L1 0x8000
691 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
692 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
693 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
694 #define MB_TYPE_QUANT 0x00010000
695 #define MB_TYPE_CBP 0x00020000
696 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
700 * This specifies the area which should be displayed.
701 * Note there may be multiple such areas for one frame.
703 typedef struct AVPanScan{
706 * - encoding: Set by user.
707 * - decoding: Set by libavcodec.
712 * width and height in 1/16 pel
713 * - encoding: Set by user.
714 * - decoding: Set by libavcodec.
720 * position of the top left corner in 1/16 pel for up to 3 fields/frames
721 * - encoding: Set by user.
722 * - decoding: Set by libavcodec.
724 int16_t position[3][2];
727 #define FF_QSCALE_TYPE_MPEG1 0
728 #define FF_QSCALE_TYPE_MPEG2 1
729 #define FF_QSCALE_TYPE_H264 2
730 #define FF_QSCALE_TYPE_VP56 3
732 #define FF_BUFFER_TYPE_INTERNAL 1
733 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
734 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
735 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
737 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
738 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
739 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
740 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
742 enum AVPacketSideDataType {
744 AV_PKT_DATA_NEW_EXTRADATA,
745 AV_PKT_DATA_PARAM_CHANGE,
748 typedef struct AVPacket {
750 * Presentation timestamp in AVStream->time_base units; the time at which
751 * the decompressed packet will be presented to the user.
752 * Can be AV_NOPTS_VALUE if it is not stored in the file.
753 * pts MUST be larger or equal to dts as presentation cannot happen before
754 * decompression, unless one wants to view hex dumps. Some formats misuse
755 * the terms dts and pts/cts to mean something different. Such timestamps
756 * must be converted to true pts/dts before they are stored in AVPacket.
760 * Decompression timestamp in AVStream->time_base units; the time at which
761 * the packet is decompressed.
762 * Can be AV_NOPTS_VALUE if it is not stored in the file.
769 * A combination of AV_PKT_FLAG values
773 * Additional packet data that can be provided by the container.
774 * Packet can contain several types of side information.
779 enum AVPacketSideDataType type;
784 * Duration of this packet in AVStream->time_base units, 0 if unknown.
785 * Equals next_pts - this_pts in presentation order.
788 void (*destruct)(struct AVPacket *);
790 int64_t pos; ///< byte position in stream, -1 if unknown
793 * Time difference in AVStream->time_base units from the pts of this
794 * packet to the point at which the output from the decoder has converged
795 * independent from the availability of previous frames. That is, the
796 * frames are virtually identical no matter if decoding started from
797 * the very first frame or from this keyframe.
798 * Is AV_NOPTS_VALUE if unknown.
799 * This field is not the display duration of the current packet.
800 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
803 * The purpose of this field is to allow seeking in streams that have no
804 * keyframes in the conventional sense. It corresponds to the
805 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
806 * essential for some types of subtitle streams to ensure that all
807 * subtitles are correctly displayed after seeking.
809 int64_t convergence_duration;
811 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
812 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
815 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
817 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
818 * s32le channel_count
819 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
820 * u64le channel_layout
821 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
823 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
828 enum AVSideDataParamChangeFlags {
829 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
830 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
831 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
832 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
837 * New fields can be added to the end of AVFRAME with minor version
838 * bumps. Removal, reordering and changes to existing fields require
839 * a major version bump.
840 * sizeof(AVFrame) must not be used outside libav*.
842 typedef struct AVFrame {
843 #define AV_NUM_DATA_POINTERS 8
845 * pointer to the picture/channel planes.
846 * This might be different from the first allocated byte
847 * - encoding: Set by user
848 * - decoding: set by AVCodecContext.get_buffer()
850 uint8_t *data[AV_NUM_DATA_POINTERS];
853 * Size, in bytes, of the data for each picture/channel plane.
855 * For audio, only linesize[0] may be set. For planar audio, each channel
856 * plane must be the same size.
858 * - encoding: Set by user
859 * - decoding: set by AVCodecContext.get_buffer()
861 int linesize[AV_NUM_DATA_POINTERS];
864 * pointers to the data planes/channels.
866 * For video, this should simply point to data[].
868 * For planar audio, each channel has a separate data pointer, and
869 * linesize[0] contains the size of each channel buffer.
870 * For packed audio, there is just one data pointer, and linesize[0]
871 * contains the total size of the buffer for all channels.
873 * Note: Both data and extended_data will always be set by get_buffer(),
874 * but for planar audio with more channels that can fit in data,
875 * extended_data must be used by the decoder in order to access all
879 * decoding: set by AVCodecContext.get_buffer()
881 uint8_t **extended_data;
884 * width and height of the video frame
886 * - decoding: Read by user.
891 * number of audio samples (per channel) described by this frame
892 * - encoding: Set by user
893 * - decoding: Set by libavcodec
898 * format of the frame, -1 if unknown or unset
899 * Values correspond to enum PixelFormat for video frames,
900 * enum AVSampleFormat for audio)
902 * - decoding: Read by user.
907 * 1 -> keyframe, 0-> not
908 * - encoding: Set by libavcodec.
909 * - decoding: Set by libavcodec.
914 * Picture type of the frame, see ?_TYPE below.
915 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
916 * - decoding: Set by libavcodec.
918 enum AVPictureType pict_type;
921 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
922 * This isn't used by libavcodec unless the default get/release_buffer() is used.
926 uint8_t *base[AV_NUM_DATA_POINTERS];
929 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
931 * - decoding: Read by user.
933 AVRational sample_aspect_ratio;
936 * presentation timestamp in time_base units (time when frame should be shown to user)
937 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
938 * - encoding: MUST be set by user.
939 * - decoding: Set by libavcodec.
944 * reordered pts from the last AVPacket that has been input into the decoder
946 * - decoding: Read by user.
951 * dts from the last AVPacket that has been input into the decoder
953 * - decoding: Read by user.
958 * picture number in bitstream order
960 * - decoding: Set by libavcodec.
962 int coded_picture_number;
964 * picture number in display order
966 * - decoding: Set by libavcodec.
968 int display_picture_number;
971 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
972 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
973 * - decoding: Set by libavcodec.
978 * is this picture used as reference
979 * The values for this are the same as the MpegEncContext.picture_structure
980 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
981 * Set to 4 for delayed, non-reference frames.
983 * - decoding: Set by libavcodec. (before get_buffer() call)).
990 * - decoding: Set by libavcodec.
992 int8_t *qscale_table;
996 * - decoding: Set by libavcodec.
1006 * mbskip_table[mb]>=1 if MB didn't change
1007 * stride= mb_width = (width+15)>>4
1008 * - encoding: unused
1009 * - decoding: Set by libavcodec.
1011 uint8_t *mbskip_table;
1014 * motion vector table
1017 * int mv_sample_log2= 4 - motion_subsample_log2;
1018 * int mb_width= (width+15)>>4;
1019 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1020 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1022 * - encoding: Set by user.
1023 * - decoding: Set by libavcodec.
1025 int16_t (*motion_val[2])[2];
1028 * macroblock type table
1029 * mb_type_base + mb_width + 2
1030 * - encoding: Set by user.
1031 * - decoding: Set by libavcodec.
1037 * - encoding: unused
1038 * - decoding: Set by libavcodec.
1043 * motion reference frame index
1044 * the order in which these are stored can depend on the codec.
1045 * - encoding: Set by user.
1046 * - decoding: Set by libavcodec.
1048 int8_t *ref_index[2];
1051 * for some private data of the user
1052 * - encoding: unused
1053 * - decoding: Set by user.
1059 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1060 * - decoding: unused
1062 uint64_t error[AV_NUM_DATA_POINTERS];
1065 * type of the buffer (to keep track of who has to deallocate data[*])
1066 * - encoding: Set by the one who allocates it.
1067 * - decoding: Set by the one who allocates it.
1068 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1073 * When decoding, this signals how much the picture must be delayed.
1074 * extra_delay = repeat_pict / (2*fps)
1075 * - encoding: unused
1076 * - decoding: Set by libavcodec.
1081 * The content of the picture is interlaced.
1082 * - encoding: Set by user.
1083 * - decoding: Set by libavcodec. (default 0)
1085 int interlaced_frame;
1088 * If the content is interlaced, is top field displayed first.
1089 * - encoding: Set by user.
1090 * - decoding: Set by libavcodec.
1092 int top_field_first;
1095 * Tell user application that palette has changed from previous frame.
1096 * - encoding: ??? (no palette-enabled encoder yet)
1097 * - decoding: Set by libavcodec. (default 0).
1099 int palette_has_changed;
1102 * codec suggestion on buffer type if != 0
1103 * - encoding: unused
1104 * - decoding: Set by libavcodec. (before get_buffer() call)).
1110 * - encoding: Set by user.
1111 * - decoding: Set by libavcodec.
1113 AVPanScan *pan_scan;
1116 * reordered opaque 64bit (generally an integer or a double precision float
1117 * PTS but can be anything).
1118 * The user sets AVCodecContext.reordered_opaque to represent the input at
1120 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1121 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1122 * @deprecated in favor of pkt_pts
1123 * - encoding: unused
1124 * - decoding: Read by user.
1126 int64_t reordered_opaque;
1129 * hardware accelerator private data (Libav-allocated)
1130 * - encoding: unused
1131 * - decoding: Set by libavcodec
1133 void *hwaccel_picture_private;
1136 * the AVCodecContext which ff_thread_get_buffer() was last called on
1137 * - encoding: Set by libavcodec.
1138 * - decoding: Set by libavcodec.
1140 struct AVCodecContext *owner;
1143 * used by multithreading to store frame-specific info
1144 * - encoding: Set by libavcodec.
1145 * - decoding: Set by libavcodec.
1147 void *thread_opaque;
1150 * log2 of the size of the block which a single vector in motion_val represents:
1151 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1152 * - encoding: unused
1153 * - decoding: Set by libavcodec.
1155 uint8_t motion_subsample_log2;
1158 struct AVCodecInternal;
1162 AV_FIELD_PROGRESSIVE,
1163 AV_FIELD_TT, //< Top coded_first, top displayed first
1164 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1165 AV_FIELD_TB, //< Top coded first, bottom displayed first
1166 AV_FIELD_BT, //< Bottom coded first, top displayed first
1170 * main external API structure.
1171 * New fields can be added to the end with minor version bumps.
1172 * Removal, reordering and changes to existing fields require a major
1174 * sizeof(AVCodecContext) must not be used outside libav*.
1176 typedef struct AVCodecContext {
1178 * information on struct for av_log
1179 * - set by avcodec_alloc_context3
1181 const AVClass *av_class;
1182 int log_level_offset;
1184 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1185 struct AVCodec *codec;
1186 char codec_name[32];
1187 enum CodecID codec_id; /* see CODEC_ID_xxx */
1190 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1191 * This is used to work around some encoder bugs.
1192 * A demuxer should set this to what is stored in the field used to identify the codec.
1193 * If there are multiple such fields in a container then the demuxer should choose the one
1194 * which maximizes the information about the used codec.
1195 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1196 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1197 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1199 * - encoding: Set by user, if not then the default based on codec_id will be used.
1200 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1202 unsigned int codec_tag;
1205 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1206 * This is used to work around some encoder bugs.
1207 * - encoding: unused
1208 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1210 unsigned int stream_codec_tag;
1213 * Some codecs need additional format info. It is stored here.
1214 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1215 * specific codec MUST set it correctly otherwise stream copy breaks.
1216 * In general use of this field by muxers is not recommended.
1217 * - encoding: Set by libavcodec.
1218 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1225 * Private context used for internal data.
1227 * Unlike priv_data, this is not codec-specific. It is used in general
1228 * libavcodec functions.
1230 struct AVCodecInternal *internal;
1233 * Private data of the user, can be used to carry app specific stuff.
1234 * - encoding: Set by user.
1235 * - decoding: Set by user.
1240 * the average bitrate
1241 * - encoding: Set by user; unused for constant quantizer encoding.
1242 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1247 * number of bits the bitstream is allowed to diverge from the reference.
1248 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1249 * - encoding: Set by user; unused for constant quantizer encoding.
1250 * - decoding: unused
1252 int bit_rate_tolerance;
1255 * Global quality for codecs which cannot change it per frame.
1256 * This should be proportional to MPEG-1/2/4 qscale.
1257 * - encoding: Set by user.
1258 * - decoding: unused
1263 * - encoding: Set by user.
1264 * - decoding: unused
1266 int compression_level;
1267 #define FF_COMPRESSION_DEFAULT -1
1271 * - encoding: Set by user.
1272 * - decoding: Set by user.
1278 * - encoding: Set by user.
1279 * - decoding: Set by user.
1284 * some codecs need / can use extradata like Huffman tables.
1285 * mjpeg: Huffman tables
1286 * rv10: additional flags
1287 * mpeg4: global headers (they can be in the bitstream or here)
1288 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1289 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1290 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1291 * - encoding: Set/allocated/freed by libavcodec.
1292 * - decoding: Set/allocated/freed by user.
1298 * This is the fundamental unit of time (in seconds) in terms
1299 * of which frame timestamps are represented. For fixed-fps content,
1300 * timebase should be 1/framerate and timestamp increments should be
1302 * - encoding: MUST be set by user.
1303 * - decoding: Set by libavcodec.
1305 AVRational time_base;
1308 * For some codecs, the time base is closer to the field rate than the frame rate.
1309 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1310 * if no telecine is used ...
1312 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1314 int ticks_per_frame;
1320 * Number of frames the decoded output will be delayed relative to the
1324 * Number of "priming" samples added to the beginning of the stream
1325 * during encoding. The decoded output will be delayed by this many
1326 * samples relative to the input to the encoder. Note that this field is
1327 * purely informational and does not directly affect the pts output by
1328 * the encoder, which should always be based on the actual presentation
1329 * time, including any delay.
1331 * - encoding: Set by libavcodec.
1332 * - decoding: unused
1339 * picture width / height.
1340 * - encoding: MUST be set by user.
1341 * - decoding: Set by libavcodec.
1342 * Note: For compatibility it is possible to set this instead of
1343 * coded_width/height before decoding.
1348 * Bitstream width / height, may be different from width/height if lowres enabled.
1349 * - encoding: unused
1350 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1352 int coded_width, coded_height;
1354 #define FF_ASPECT_EXTENDED 15
1357 * the number of pictures in a group of pictures, or 0 for intra_only
1358 * - encoding: Set by user.
1359 * - decoding: unused
1364 * Pixel format, see PIX_FMT_xxx.
1365 * May be set by the demuxer if known from headers.
1366 * May be overriden by the decoder if it knows better.
1367 * - encoding: Set by user.
1368 * - decoding: Set by user if known, overridden by libavcodec if known
1370 enum PixelFormat pix_fmt;
1373 * Motion estimation algorithm used for video coding.
1374 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1375 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1376 * - encoding: MUST be set by user.
1377 * - decoding: unused
1382 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1383 * decoder to draw a horizontal band. It improves cache usage. Not
1384 * all codecs can do that. You must check the codec capabilities
1386 * When multithreading is used, it may be called from multiple threads
1387 * at the same time; threads might draw different parts of the same AVFrame,
1388 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1390 * The function is also used by hardware acceleration APIs.
1391 * It is called at least once during frame decoding to pass
1392 * the data needed for hardware render.
1393 * In that mode instead of pixel data, AVFrame points to
1394 * a structure specific to the acceleration API. The application
1395 * reads the structure and can change some fields to indicate progress
1397 * - encoding: unused
1398 * - decoding: Set by user.
1399 * @param height the height of the slice
1400 * @param y the y position of the slice
1401 * @param type 1->top field, 2->bottom field, 3->frame
1402 * @param offset offset into the AVFrame.data from which the slice should be read
1404 void (*draw_horiz_band)(struct AVCodecContext *s,
1405 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1406 int y, int type, int height);
1409 * callback to negotiate the pixelFormat
1410 * @param fmt is the list of formats which are supported by the codec,
1411 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1412 * The first is always the native one.
1413 * @return the chosen format
1414 * - encoding: unused
1415 * - decoding: Set by user, if not set the native format will be chosen.
1417 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1420 * maximum number of B-frames between non-B-frames
1421 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1422 * - encoding: Set by user.
1423 * - decoding: unused
1428 * qscale factor between IP and B-frames
1429 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1430 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1431 * - encoding: Set by user.
1432 * - decoding: unused
1434 float b_quant_factor;
1436 /** obsolete FIXME remove */
1438 #define FF_RC_STRATEGY_XVID 1
1440 int b_frame_strategy;
1443 * luma single coefficient elimination threshold
1444 * - encoding: Set by user.
1445 * - decoding: unused
1447 int luma_elim_threshold;
1450 * chroma single coeff elimination threshold
1451 * - encoding: Set by user.
1452 * - decoding: unused
1454 int chroma_elim_threshold;
1457 * qscale offset between IP and B-frames
1458 * - encoding: Set by user.
1459 * - decoding: unused
1461 float b_quant_offset;
1464 * Size of the frame reordering buffer in the decoder.
1465 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1466 * - encoding: Set by libavcodec.
1467 * - decoding: Set by libavcodec.
1472 * 0-> h263 quant 1-> mpeg quant
1473 * - encoding: Set by user.
1474 * - decoding: unused
1479 * qscale factor between P and I-frames
1480 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1481 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1482 * - encoding: Set by user.
1483 * - decoding: unused
1485 float i_quant_factor;
1488 * qscale offset between P and I-frames
1489 * - encoding: Set by user.
1490 * - decoding: unused
1492 float i_quant_offset;
1495 * luminance masking (0-> disabled)
1496 * - encoding: Set by user.
1497 * - decoding: unused
1502 * temporary complexity masking (0-> disabled)
1503 * - encoding: Set by user.
1504 * - decoding: unused
1506 float temporal_cplx_masking;
1509 * spatial complexity masking (0-> disabled)
1510 * - encoding: Set by user.
1511 * - decoding: unused
1513 float spatial_cplx_masking;
1516 * p block masking (0-> disabled)
1517 * - encoding: Set by user.
1518 * - decoding: unused
1523 * darkness masking (0-> disabled)
1524 * - encoding: Set by user.
1525 * - decoding: unused
1531 * - encoding: Set by libavcodec.
1532 * - decoding: Set by user (or 0).
1536 * prediction method (needed for huffyuv)
1537 * - encoding: Set by user.
1538 * - decoding: unused
1540 int prediction_method;
1541 #define FF_PRED_LEFT 0
1542 #define FF_PRED_PLANE 1
1543 #define FF_PRED_MEDIAN 2
1546 * slice offsets in the frame in bytes
1547 * - encoding: Set/allocated by libavcodec.
1548 * - decoding: Set/allocated by user (or NULL).
1553 * sample aspect ratio (0 if unknown)
1554 * That is the width of a pixel divided by the height of the pixel.
1555 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1556 * - encoding: Set by user.
1557 * - decoding: Set by libavcodec.
1559 AVRational sample_aspect_ratio;
1562 * motion estimation comparison function
1563 * - encoding: Set by user.
1564 * - decoding: unused
1568 * subpixel motion estimation comparison function
1569 * - encoding: Set by user.
1570 * - decoding: unused
1574 * macroblock comparison function (not supported yet)
1575 * - encoding: Set by user.
1576 * - decoding: unused
1580 * interlaced DCT comparison function
1581 * - encoding: Set by user.
1582 * - decoding: unused
1585 #define FF_CMP_SAD 0
1586 #define FF_CMP_SSE 1
1587 #define FF_CMP_SATD 2
1588 #define FF_CMP_DCT 3
1589 #define FF_CMP_PSNR 4
1590 #define FF_CMP_BIT 5
1592 #define FF_CMP_ZERO 7
1593 #define FF_CMP_VSAD 8
1594 #define FF_CMP_VSSE 9
1595 #define FF_CMP_NSSE 10
1596 #define FF_CMP_W53 11
1597 #define FF_CMP_W97 12
1598 #define FF_CMP_DCTMAX 13
1599 #define FF_CMP_DCT264 14
1600 #define FF_CMP_CHROMA 256
1603 * ME diamond size & shape
1604 * - encoding: Set by user.
1605 * - decoding: unused
1610 * amount of previous MV predictors (2a+1 x 2a+1 square)
1611 * - encoding: Set by user.
1612 * - decoding: unused
1614 int last_predictor_count;
1617 * prepass for motion estimation
1618 * - encoding: Set by user.
1619 * - decoding: unused
1624 * motion estimation prepass comparison function
1625 * - encoding: Set by user.
1626 * - decoding: unused
1631 * ME prepass diamond size & shape
1632 * - encoding: Set by user.
1633 * - decoding: unused
1639 * - encoding: Set by user.
1640 * - decoding: unused
1642 int me_subpel_quality;
1645 * DTG active format information (additional aspect ratio
1646 * information only used in DVB MPEG-2 transport streams)
1649 * - encoding: unused
1650 * - decoding: Set by decoder.
1652 int dtg_active_format;
1653 #define FF_DTG_AFD_SAME 8
1654 #define FF_DTG_AFD_4_3 9
1655 #define FF_DTG_AFD_16_9 10
1656 #define FF_DTG_AFD_14_9 11
1657 #define FF_DTG_AFD_4_3_SP_14_9 13
1658 #define FF_DTG_AFD_16_9_SP_14_9 14
1659 #define FF_DTG_AFD_SP_4_3 15
1662 * maximum motion estimation search range in subpel units
1663 * If 0 then no limit.
1665 * - encoding: Set by user.
1666 * - decoding: unused
1671 * intra quantizer bias
1672 * - encoding: Set by user.
1673 * - decoding: unused
1675 int intra_quant_bias;
1676 #define FF_DEFAULT_QUANT_BIAS 999999
1679 * inter quantizer bias
1680 * - encoding: Set by user.
1681 * - decoding: unused
1683 int inter_quant_bias;
1687 * - encoding: unused
1688 * - decoding: Which clrtable should be used for 8bit RGB images.
1689 * Tables have to be stored somewhere. FIXME
1695 * - encoding: unused
1696 * - decoding: Set by user.
1699 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1700 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1701 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1704 * XVideo Motion Acceleration
1705 * - encoding: forbidden
1706 * - decoding: set by decoder
1708 int xvmc_acceleration;
1711 * macroblock decision mode
1712 * - encoding: Set by user.
1713 * - decoding: unused
1716 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1717 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1718 #define FF_MB_DECISION_RD 2 ///< rate distortion
1721 * custom intra quantization matrix
1722 * - encoding: Set by user, can be NULL.
1723 * - decoding: Set by libavcodec.
1725 uint16_t *intra_matrix;
1728 * custom inter quantization matrix
1729 * - encoding: Set by user, can be NULL.
1730 * - decoding: Set by libavcodec.
1732 uint16_t *inter_matrix;
1735 * scene change detection threshold
1736 * 0 is default, larger means fewer detected scene changes.
1737 * - encoding: Set by user.
1738 * - decoding: unused
1740 int scenechange_threshold;
1743 * noise reduction strength
1744 * - encoding: Set by user.
1745 * - decoding: unused
1747 int noise_reduction;
1751 * - encoding: Set by user.
1752 * - decoding: unused
1754 int inter_threshold;
1757 * quantizer noise shaping
1758 * - encoding: Set by user.
1759 * - decoding: unused
1761 int quantizer_noise_shaping;
1764 * Motion estimation threshold below which no motion estimation is
1765 * performed, but instead the user specified motion vectors are used.
1767 * - encoding: Set by user.
1768 * - decoding: unused
1773 * Macroblock threshold below which the user specified macroblock types will be used.
1774 * - encoding: Set by user.
1775 * - decoding: unused
1780 * precision of the intra DC coefficient - 8
1781 * - encoding: Set by user.
1782 * - decoding: unused
1784 int intra_dc_precision;
1787 * Number of macroblock rows at the top which are skipped.
1788 * - encoding: unused
1789 * - decoding: Set by user.
1794 * Number of macroblock rows at the bottom which are skipped.
1795 * - encoding: unused
1796 * - decoding: Set by user.
1801 * Border processing masking, raises the quantizer for mbs on the borders
1803 * - encoding: Set by user.
1804 * - decoding: unused
1806 float border_masking;
1809 * minimum MB lagrange multipler
1810 * - encoding: Set by user.
1811 * - decoding: unused
1816 * maximum MB lagrange multipler
1817 * - encoding: Set by user.
1818 * - decoding: unused
1824 * - encoding: Set by user.
1825 * - decoding: unused
1827 int me_penalty_compensation;
1831 * - encoding: Set by user.
1832 * - decoding: unused
1838 * - encoding: Set by user.
1839 * - decoding: unused
1845 * - encoding: Set by user.
1846 * - decoding: unused
1851 * number of reference frames
1852 * - encoding: Set by user.
1853 * - decoding: Set by lavc.
1858 * chroma qp offset from luma
1859 * - encoding: Set by user.
1860 * - decoding: unused
1865 * Multiplied by qscale for each frame and added to scene_change_score.
1866 * - encoding: Set by user.
1867 * - decoding: unused
1869 int scenechange_factor;
1873 * Note: Value depends upon the compare function used for fullpel ME.
1874 * - encoding: Set by user.
1875 * - decoding: unused
1880 * Adjust sensitivity of b_frame_strategy 1.
1881 * - encoding: Set by user.
1882 * - decoding: unused
1887 * Chromaticity coordinates of the source primaries.
1888 * - encoding: Set by user
1889 * - decoding: Set by libavcodec
1891 enum AVColorPrimaries color_primaries;
1894 * Color Transfer Characteristic.
1895 * - encoding: Set by user
1896 * - decoding: Set by libavcodec
1898 enum AVColorTransferCharacteristic color_trc;
1901 * YUV colorspace type.
1902 * - encoding: Set by user
1903 * - decoding: Set by libavcodec
1905 enum AVColorSpace colorspace;
1908 * MPEG vs JPEG YUV range.
1909 * - encoding: Set by user
1910 * - decoding: Set by libavcodec
1912 enum AVColorRange color_range;
1915 * This defines the location of chroma samples.
1916 * - encoding: Set by user
1917 * - decoding: Set by libavcodec
1919 enum AVChromaLocation chroma_sample_location;
1923 * Indicates number of picture subdivisions. Used for parallelized
1925 * - encoding: Set by user
1926 * - decoding: unused
1931 * - encoding: set by libavcodec
1932 * - decoding: Set by libavcodec
1934 enum AVFieldOrder field_order;
1937 int sample_rate; ///< samples per second
1938 int channels; ///< number of audio channels
1941 * audio sample format
1942 * - encoding: Set by user.
1943 * - decoding: Set by libavcodec.
1945 enum AVSampleFormat sample_fmt; ///< sample format
1947 /* The following data should not be initialized. */
1949 * Samples per packet, initialized when calling 'init'.
1952 int frame_number; ///< audio or video frame number
1955 * number of bytes per packet if constant and known or 0
1956 * Used by some WAV based audio codecs.
1961 * Audio cutoff bandwidth (0 means "automatic")
1962 * - encoding: Set by user.
1963 * - decoding: unused
1967 #if FF_API_REQUEST_CHANNELS
1969 * Decoder should decode to this many channels if it can (0 for default)
1970 * - encoding: unused
1971 * - decoding: Set by user.
1972 * @deprecated Deprecated in favor of request_channel_layout.
1974 int request_channels;
1978 * Audio channel layout.
1979 * - encoding: set by user.
1980 * - decoding: set by libavcodec.
1982 uint64_t channel_layout;
1985 * Request decoder to use this channel layout if it can (0 for default)
1986 * - encoding: unused
1987 * - decoding: Set by user.
1989 uint64_t request_channel_layout;
1992 * Type of service that the audio stream conveys.
1993 * - encoding: Set by user.
1994 * - decoding: Set by libavcodec.
1996 enum AVAudioServiceType audio_service_type;
1999 * Used to request a sample format from the decoder.
2000 * - encoding: unused.
2001 * - decoding: Set by user.
2003 enum AVSampleFormat request_sample_fmt;
2006 * Called at the beginning of each frame to get a buffer for it.
2008 * The function will set AVFrame.data[], AVFrame.linesize[].
2009 * AVFrame.extended_data[] must also be set, but it should be the same as
2010 * AVFrame.data[] except for planar audio with more channels than can fit
2011 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2012 * many data pointers as it can hold.
2014 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2015 * avcodec_default_get_buffer() instead of providing buffers allocated by
2018 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2019 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2020 * but if get_buffer() is overridden then alignment considerations should
2021 * be taken into account.
2023 * @see avcodec_default_get_buffer()
2027 * If pic.reference is set then the frame will be read later by libavcodec.
2028 * avcodec_align_dimensions2() should be used to find the required width and
2029 * height, as they normally need to be rounded up to the next multiple of 16.
2031 * If frame multithreading is used and thread_safe_callbacks is set,
2032 * it may be called from a different thread, but not from more than one at
2033 * once. Does not need to be reentrant.
2035 * @see release_buffer(), reget_buffer()
2036 * @see avcodec_align_dimensions2()
2040 * Decoders request a buffer of a particular size by setting
2041 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2042 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2043 * to a smaller value in the output frame.
2045 * Decoders cannot use the buffer after returning from
2046 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2047 * is assumed to be released immediately upon return.
2049 * As a convenience, av_samples_get_buffer_size() and
2050 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2051 * functions to find the required data size and to fill data pointers and
2052 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2053 * since all planes must be the same size.
2055 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2057 * - encoding: unused
2058 * - decoding: Set by libavcodec, user can override.
2060 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2063 * Called to release buffers which were allocated with get_buffer.
2064 * A released buffer can be reused in get_buffer().
2065 * pic.data[*] must be set to NULL.
2066 * May be called from a different thread if frame multithreading is used,
2067 * but not by more than one thread at once, so does not need to be reentrant.
2068 * - encoding: unused
2069 * - decoding: Set by libavcodec, user can override.
2071 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2074 * Called at the beginning of a frame to get cr buffer for it.
2075 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2076 * libavcodec will pass previous buffer in pic, function should return
2077 * same buffer or new buffer with old frame "painted" into it.
2078 * If pic.data[0] == NULL must behave like get_buffer().
2079 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2080 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2082 * - encoding: unused
2083 * - decoding: Set by libavcodec, user can override.
2085 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2088 /* - encoding parameters */
2089 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2090 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2094 * - encoding: Set by user.
2095 * - decoding: unused
2101 * - encoding: Set by user.
2102 * - decoding: unused
2107 * maximum quantizer difference between frames
2108 * - encoding: Set by user.
2109 * - decoding: unused
2114 * ratecontrol qmin qmax limiting method
2115 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2116 * - encoding: Set by user.
2117 * - decoding: unused
2125 * decoder bitstream buffer size
2126 * - encoding: Set by user.
2127 * - decoding: unused
2132 * ratecontrol override, see RcOverride
2133 * - encoding: Allocated/set/freed by user.
2134 * - decoding: unused
2136 int rc_override_count;
2137 RcOverride *rc_override;
2140 * rate control equation
2141 * - encoding: Set by user
2142 * - decoding: unused
2148 * - encoding: Set by user.
2149 * - decoding: unused
2155 * - encoding: Set by user.
2156 * - decoding: unused
2160 float rc_buffer_aggressivity;
2163 * initial complexity for pass1 ratecontrol
2164 * - encoding: Set by user.
2165 * - decoding: unused
2167 float rc_initial_cplx;
2170 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2171 * - encoding: Set by user.
2172 * - decoding: unused.
2174 float rc_max_available_vbv_use;
2177 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2178 * - encoding: Set by user.
2179 * - decoding: unused.
2181 float rc_min_vbv_overflow_use;
2184 * Number of bits which should be loaded into the rc buffer before decoding starts.
2185 * - encoding: Set by user.
2186 * - decoding: unused
2188 int rc_initial_buffer_occupancy;
2190 #define FF_CODER_TYPE_VLC 0
2191 #define FF_CODER_TYPE_AC 1
2192 #define FF_CODER_TYPE_RAW 2
2193 #define FF_CODER_TYPE_RLE 3
2194 #define FF_CODER_TYPE_DEFLATE 4
2197 * - encoding: Set by user.
2198 * - decoding: unused
2204 * - encoding: Set by user.
2205 * - decoding: unused
2210 * minimum Lagrange multipler
2211 * - encoding: Set by user.
2212 * - decoding: unused
2217 * maximum Lagrange multipler
2218 * - encoding: Set by user.
2219 * - decoding: unused
2224 * frame skip threshold
2225 * - encoding: Set by user.
2226 * - decoding: unused
2228 int frame_skip_threshold;
2232 * - encoding: Set by user.
2233 * - decoding: unused
2235 int frame_skip_factor;
2238 * frame skip exponent
2239 * - encoding: Set by user.
2240 * - decoding: unused
2245 * frame skip comparison function
2246 * - encoding: Set by user.
2247 * - decoding: unused
2252 * trellis RD quantization
2253 * - encoding: Set by user.
2254 * - decoding: unused
2259 * - encoding: Set by user.
2260 * - decoding: unused
2262 int min_prediction_order;
2265 * - encoding: Set by user.
2266 * - decoding: unused
2268 int max_prediction_order;
2271 * GOP timecode frame start number, in non drop frame format
2272 * - encoding: Set by user.
2273 * - decoding: unused
2275 int64_t timecode_frame_start;
2277 /* The RTP callback: This function is called */
2278 /* every time the encoder has a packet to send. */
2279 /* It depends on the encoder if the data starts */
2280 /* with a Start Code (it should). H.263 does. */
2281 /* mb_nb contains the number of macroblocks */
2282 /* encoded in the RTP payload. */
2283 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2285 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2286 /* do its best to deliver a chunk with size */
2287 /* below rtp_payload_size, the chunk will start */
2288 /* with a start code on some codecs like H.263. */
2289 /* This doesn't take account of any particular */
2290 /* headers inside the transmitted RTP payload. */
2292 /* statistics, used for 2-pass encoding */
2303 * number of bits used for the previously encoded frame
2304 * - encoding: Set by libavcodec.
2305 * - decoding: unused
2310 * pass1 encoding statistics output buffer
2311 * - encoding: Set by libavcodec.
2312 * - decoding: unused
2317 * pass2 encoding statistics input buffer
2318 * Concatenated stuff from stats_out of pass1 should be placed here.
2319 * - encoding: Allocated/set/freed by user.
2320 * - decoding: unused
2325 * Work around bugs in encoders which sometimes cannot be detected automatically.
2326 * - encoding: Set by user
2327 * - decoding: Set by user
2329 int workaround_bugs;
2330 #define FF_BUG_AUTODETECT 1 ///< autodetection
2331 #define FF_BUG_OLD_MSMPEG4 2
2332 #define FF_BUG_XVID_ILACE 4
2333 #define FF_BUG_UMP4 8
2334 #define FF_BUG_NO_PADDING 16
2335 #define FF_BUG_AMV 32
2336 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2337 #define FF_BUG_QPEL_CHROMA 64
2338 #define FF_BUG_STD_QPEL 128
2339 #define FF_BUG_QPEL_CHROMA2 256
2340 #define FF_BUG_DIRECT_BLOCKSIZE 512
2341 #define FF_BUG_EDGE 1024
2342 #define FF_BUG_HPEL_CHROMA 2048
2343 #define FF_BUG_DC_CLIP 4096
2344 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2345 #define FF_BUG_TRUNCATED 16384
2348 * strictly follow the standard (MPEG4, ...).
2349 * - encoding: Set by user.
2350 * - decoding: Set by user.
2351 * Setting this to STRICT or higher means the encoder and decoder will
2352 * generally do stupid things, whereas setting it to unofficial or lower
2353 * will mean the encoder might produce output that is not supported by all
2354 * spec-compliant decoders. Decoders don't differentiate between normal,
2355 * unofficial and experimental (that is, they always try to decode things
2356 * when they can) unless they are explicitly asked to behave stupidly
2357 * (=strictly conform to the specs)
2359 int strict_std_compliance;
2360 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2361 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2362 #define FF_COMPLIANCE_NORMAL 0
2363 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2364 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2367 * error concealment flags
2368 * - encoding: unused
2369 * - decoding: Set by user.
2371 int error_concealment;
2372 #define FF_EC_GUESS_MVS 1
2373 #define FF_EC_DEBLOCK 2
2377 * - encoding: Set by user.
2378 * - decoding: Set by user.
2381 #define FF_DEBUG_PICT_INFO 1
2382 #define FF_DEBUG_RC 2
2383 #define FF_DEBUG_BITSTREAM 4
2384 #define FF_DEBUG_MB_TYPE 8
2385 #define FF_DEBUG_QP 16
2386 #define FF_DEBUG_MV 32
2387 #define FF_DEBUG_DCT_COEFF 0x00000040
2388 #define FF_DEBUG_SKIP 0x00000080
2389 #define FF_DEBUG_STARTCODE 0x00000100
2390 #define FF_DEBUG_PTS 0x00000200
2391 #define FF_DEBUG_ER 0x00000400
2392 #define FF_DEBUG_MMCO 0x00000800
2393 #define FF_DEBUG_BUGS 0x00001000
2394 #define FF_DEBUG_VIS_QP 0x00002000
2395 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2396 #define FF_DEBUG_BUFFERS 0x00008000
2397 #define FF_DEBUG_THREADS 0x00010000
2401 * - encoding: Set by user.
2402 * - decoding: Set by user.
2405 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2406 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2407 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2410 * Error recognition; may misdetect some more or less valid parts as errors.
2411 * - encoding: unused
2412 * - decoding: Set by user.
2414 int err_recognition;
2415 #define AV_EF_CRCCHECK (1<<0)
2416 #define AV_EF_BITSTREAM (1<<1)
2417 #define AV_EF_BUFFER (1<<2)
2418 #define AV_EF_EXPLODE (1<<3)
2421 * opaque 64bit number (generally a PTS) that will be reordered and
2422 * output in AVFrame.reordered_opaque
2423 * @deprecated in favor of pkt_pts
2424 * - encoding: unused
2425 * - decoding: Set by user.
2427 int64_t reordered_opaque;
2430 * Hardware accelerator in use
2431 * - encoding: unused.
2432 * - decoding: Set by libavcodec
2434 struct AVHWAccel *hwaccel;
2437 * Hardware accelerator context.
2438 * For some hardware accelerators, a global context needs to be
2439 * provided by the user. In that case, this holds display-dependent
2440 * data Libav cannot instantiate itself. Please refer to the
2441 * Libav HW accelerator documentation to know how to fill this
2442 * is. e.g. for VA API, this is a struct vaapi_context.
2443 * - encoding: unused
2444 * - decoding: Set by user
2446 void *hwaccel_context;
2450 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2451 * - decoding: unused
2453 uint64_t error[AV_NUM_DATA_POINTERS];
2456 * DCT algorithm, see FF_DCT_* below
2457 * - encoding: Set by user.
2458 * - decoding: unused
2461 #define FF_DCT_AUTO 0
2462 #define FF_DCT_FASTINT 1
2463 #define FF_DCT_INT 2
2464 #define FF_DCT_MMX 3
2465 #define FF_DCT_ALTIVEC 5
2466 #define FF_DCT_FAAN 6
2469 * IDCT algorithm, see FF_IDCT_* below.
2470 * - encoding: Set by user.
2471 * - decoding: Set by user.
2474 #define FF_IDCT_AUTO 0
2475 #define FF_IDCT_INT 1
2476 #define FF_IDCT_SIMPLE 2
2477 #define FF_IDCT_SIMPLEMMX 3
2478 #define FF_IDCT_LIBMPEG2MMX 4
2479 #define FF_IDCT_MMI 5
2480 #define FF_IDCT_ARM 7
2481 #define FF_IDCT_ALTIVEC 8
2482 #define FF_IDCT_SH4 9
2483 #define FF_IDCT_SIMPLEARM 10
2484 #define FF_IDCT_H264 11
2485 #define FF_IDCT_VP3 12
2486 #define FF_IDCT_IPP 13
2487 #define FF_IDCT_XVIDMMX 14
2488 #define FF_IDCT_CAVS 15
2489 #define FF_IDCT_SIMPLEARMV5TE 16
2490 #define FF_IDCT_SIMPLEARMV6 17
2491 #define FF_IDCT_SIMPLEVIS 18
2492 #define FF_IDCT_WMV2 19
2493 #define FF_IDCT_FAAN 20
2494 #define FF_IDCT_EA 21
2495 #define FF_IDCT_SIMPLENEON 22
2496 #define FF_IDCT_SIMPLEALPHA 23
2497 #define FF_IDCT_BINK 24
2500 * dsp_mask could be add used to disable unwanted CPU features
2501 * CPU features (i.e. MMX, SSE. ...)
2503 * With the FORCE flag you may instead enable given CPU features.
2504 * (Dangerous: Usable in case of misdetection, improper usage however will
2505 * result into program crash.)
2510 * bits per sample/pixel from the demuxer (needed for huffyuv).
2511 * - encoding: Set by libavcodec.
2512 * - decoding: Set by user.
2514 int bits_per_coded_sample;
2517 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2518 * - encoding: set by user.
2519 * - decoding: set by libavcodec.
2521 int bits_per_raw_sample;
2524 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2525 * - encoding: unused
2526 * - decoding: Set by user.
2531 * the picture in the bitstream
2532 * - encoding: Set by libavcodec.
2533 * - decoding: Set by libavcodec.
2535 AVFrame *coded_frame;
2539 * is used to decide how many independent tasks should be passed to execute()
2540 * - encoding: Set by user.
2541 * - decoding: Set by user.
2546 * Which multithreading methods to use.
2547 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2548 * so clients which cannot provide future frames should not use it.
2550 * - encoding: Set by user, otherwise the default is used.
2551 * - decoding: Set by user, otherwise the default is used.
2554 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2555 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2558 * Which multithreading methods are in use by the codec.
2559 * - encoding: Set by libavcodec.
2560 * - decoding: Set by libavcodec.
2562 int active_thread_type;
2565 * Set by the client if its custom get_buffer() callback can be called
2566 * from another thread, which allows faster multithreaded decoding.
2567 * draw_horiz_band() will be called from other threads regardless of this setting.
2568 * Ignored if the default get_buffer() is used.
2569 * - encoding: Set by user.
2570 * - decoding: Set by user.
2572 int thread_safe_callbacks;
2575 * The codec may call this to execute several independent things.
2576 * It will return only after finishing all tasks.
2577 * The user may replace this with some multithreaded implementation,
2578 * the default implementation will execute the parts serially.
2579 * @param count the number of things to execute
2580 * - encoding: Set by libavcodec, user can override.
2581 * - decoding: Set by libavcodec, user can override.
2583 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2586 * The codec may call this to execute several independent things.
2587 * It will return only after finishing all tasks.
2588 * The user may replace this with some multithreaded implementation,
2589 * the default implementation will execute the parts serially.
2590 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2591 * @param c context passed also to func
2592 * @param count the number of things to execute
2593 * @param arg2 argument passed unchanged to func
2594 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2595 * @param func function that will be called count times, with jobnr from 0 to count-1.
2596 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2597 * two instances of func executing at the same time will have the same threadnr.
2598 * @return always 0 currently, but code should handle a future improvement where when any call to func
2599 * returns < 0 no further calls to func may be done and < 0 is returned.
2600 * - encoding: Set by libavcodec, user can override.
2601 * - decoding: Set by libavcodec, user can override.
2603 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2607 * Can be used by execute() to store some per AVCodecContext stuff.
2608 * - encoding: set by execute()
2609 * - decoding: set by execute()
2611 void *thread_opaque;
2614 * noise vs. sse weight for the nsse comparsion function
2615 * - encoding: Set by user.
2616 * - decoding: unused
2622 * - encoding: Set by user.
2623 * - decoding: Set by libavcodec.
2626 #define FF_PROFILE_UNKNOWN -99
2627 #define FF_PROFILE_RESERVED -100
2629 #define FF_PROFILE_AAC_MAIN 0
2630 #define FF_PROFILE_AAC_LOW 1
2631 #define FF_PROFILE_AAC_SSR 2
2632 #define FF_PROFILE_AAC_LTP 3
2634 #define FF_PROFILE_DTS 20
2635 #define FF_PROFILE_DTS_ES 30
2636 #define FF_PROFILE_DTS_96_24 40
2637 #define FF_PROFILE_DTS_HD_HRA 50
2638 #define FF_PROFILE_DTS_HD_MA 60
2640 #define FF_PROFILE_MPEG2_422 0
2641 #define FF_PROFILE_MPEG2_HIGH 1
2642 #define FF_PROFILE_MPEG2_SS 2
2643 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2644 #define FF_PROFILE_MPEG2_MAIN 4
2645 #define FF_PROFILE_MPEG2_SIMPLE 5
2647 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2648 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2650 #define FF_PROFILE_H264_BASELINE 66
2651 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2652 #define FF_PROFILE_H264_MAIN 77
2653 #define FF_PROFILE_H264_EXTENDED 88
2654 #define FF_PROFILE_H264_HIGH 100
2655 #define FF_PROFILE_H264_HIGH_10 110
2656 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2657 #define FF_PROFILE_H264_HIGH_422 122
2658 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2659 #define FF_PROFILE_H264_HIGH_444 144
2660 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2661 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2662 #define FF_PROFILE_H264_CAVLC_444 44
2664 #define FF_PROFILE_VC1_SIMPLE 0
2665 #define FF_PROFILE_VC1_MAIN 1
2666 #define FF_PROFILE_VC1_COMPLEX 2
2667 #define FF_PROFILE_VC1_ADVANCED 3
2669 #define FF_PROFILE_MPEG4_SIMPLE 0
2670 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2671 #define FF_PROFILE_MPEG4_CORE 2
2672 #define FF_PROFILE_MPEG4_MAIN 3
2673 #define FF_PROFILE_MPEG4_N_BIT 4
2674 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2675 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2676 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2677 #define FF_PROFILE_MPEG4_HYBRID 8
2678 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2679 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2680 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2681 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2682 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2683 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2684 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2688 * - encoding: Set by user.
2689 * - decoding: Set by libavcodec.
2692 #define FF_LEVEL_UNKNOWN -99
2696 * - encoding: unused
2697 * - decoding: Set by user.
2699 enum AVDiscard skip_loop_filter;
2703 * - encoding: unused
2704 * - decoding: Set by user.
2706 enum AVDiscard skip_idct;
2710 * - encoding: unused
2711 * - decoding: Set by user.
2713 enum AVDiscard skip_frame;
2716 * Header containing style information for text subtitles.
2717 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2718 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2719 * the Format line following. It shouldn't include any Dialogue line.
2720 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2721 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2723 uint8_t *subtitle_header;
2724 int subtitle_header_size;
2727 * Simulates errors in the bitstream to test error concealment.
2728 * - encoding: Set by user.
2729 * - decoding: unused
2734 * Current packet as passed into the decoder, to avoid having
2735 * to pass the packet into every function. Currently only valid
2736 * inside lavc and get/release_buffer callbacks.
2737 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2738 * - encoding: unused
2743 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2744 * Used for compliant TS muxing.
2745 * - encoding: Set by libavcodec.
2746 * - decoding: unused.
2754 typedef struct AVProfile {
2756 const char *name; ///< short name for the profile
2759 typedef struct AVCodecDefault AVCodecDefault;
2764 typedef struct AVCodec {
2766 * Name of the codec implementation.
2767 * The name is globally unique among encoders and among decoders (but an
2768 * encoder and a decoder can share the same name).
2769 * This is the primary way to find a codec from the user perspective.
2773 * Descriptive name for the codec, meant to be more human readable than name.
2774 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2776 const char *long_name;
2777 enum AVMediaType type;
2780 * Codec capabilities.
2784 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2785 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2786 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2787 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2788 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2789 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2790 const AVClass *priv_class; ///< AVClass for the private context
2791 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2793 /*****************************************************************
2794 * No fields below this line are part of the public API. They
2795 * may not be used outside of libavcodec and can be changed and
2797 * New public fields should be added right above.
2798 *****************************************************************
2801 struct AVCodec *next;
2803 * @name Frame-level threading support functions
2807 * If defined, called on thread contexts when they are created.
2808 * If the codec allocates writable tables in init(), re-allocate them here.
2809 * priv_data will be set to a copy of the original.
2811 int (*init_thread_copy)(AVCodecContext *);
2813 * Copy necessary context variables from a previous thread context to the current one.
2814 * If not defined, the next thread will start automatically; otherwise, the codec
2815 * must call ff_thread_finish_setup().
2817 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2819 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2823 * Private codec-specific defaults.
2825 const AVCodecDefault *defaults;
2828 * Initialize codec static data, called from avcodec_register().
2830 void (*init_static_data)(struct AVCodec *codec);
2832 int (*init)(AVCodecContext *);
2833 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2835 * Encode data to an AVPacket.
2837 * @param avctx codec context
2838 * @param avpkt output AVPacket (may contain a user-provided buffer)
2839 * @param[in] frame AVFrame containing the raw data to be encoded
2840 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2841 * non-empty packet was returned in avpkt.
2842 * @return 0 on success, negative error code on failure
2844 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2845 int *got_packet_ptr);
2846 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2847 int (*close)(AVCodecContext *);
2850 * Will be called when seeking
2852 void (*flush)(AVCodecContext *);
2858 typedef struct AVHWAccel {
2860 * Name of the hardware accelerated codec.
2861 * The name is globally unique among encoders and among decoders (but an
2862 * encoder and a decoder can share the same name).
2867 * Type of codec implemented by the hardware accelerator.
2869 * See AVMEDIA_TYPE_xxx
2871 enum AVMediaType type;
2874 * Codec implemented by the hardware accelerator.
2881 * Supported pixel format.
2883 * Only hardware accelerated formats are supported here.
2885 enum PixelFormat pix_fmt;
2888 * Hardware accelerated codec capabilities.
2889 * see FF_HWACCEL_CODEC_CAP_*
2893 struct AVHWAccel *next;
2896 * Called at the beginning of each frame or field picture.
2898 * Meaningful frame information (codec specific) is guaranteed to
2899 * be parsed at this point. This function is mandatory.
2901 * Note that buf can be NULL along with buf_size set to 0.
2902 * Otherwise, this means the whole frame is available at this point.
2904 * @param avctx the codec context
2905 * @param buf the frame data buffer base
2906 * @param buf_size the size of the frame in bytes
2907 * @return zero if successful, a negative value otherwise
2909 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2912 * Callback for each slice.
2914 * Meaningful slice information (codec specific) is guaranteed to
2915 * be parsed at this point. This function is mandatory.
2917 * @param avctx the codec context
2918 * @param buf the slice data buffer base
2919 * @param buf_size the size of the slice in bytes
2920 * @return zero if successful, a negative value otherwise
2922 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2925 * Called at the end of each frame or field picture.
2927 * The whole picture is parsed at this point and can now be sent
2928 * to the hardware accelerator. This function is mandatory.
2930 * @param avctx the codec context
2931 * @return zero if successful, a negative value otherwise
2933 int (*end_frame)(AVCodecContext *avctx);
2936 * Size of HW accelerator private data.
2938 * Private data is allocated with av_mallocz() before
2939 * AVCodecContext.get_buffer() and deallocated after
2940 * AVCodecContext.release_buffer().
2946 * four components are given, that's all.
2947 * the last component is alpha
2949 typedef struct AVPicture {
2950 uint8_t *data[AV_NUM_DATA_POINTERS];
2951 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
2954 #define AVPALETTE_SIZE 1024
2955 #define AVPALETTE_COUNT 256
2957 enum AVSubtitleType {
2960 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2963 * Plain text, the text field must be set by the decoder and is
2964 * authoritative. ass and pict fields may contain approximations.
2969 * Formatted text, the ass field must be set by the decoder and is
2970 * authoritative. pict and text fields may contain approximations.
2975 typedef struct AVSubtitleRect {
2976 int x; ///< top left corner of pict, undefined when pict is not set
2977 int y; ///< top left corner of pict, undefined when pict is not set
2978 int w; ///< width of pict, undefined when pict is not set
2979 int h; ///< height of pict, undefined when pict is not set
2980 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2983 * data+linesize for the bitmap of this subtitle.
2984 * can be set for text/ass as well once they where rendered
2987 enum AVSubtitleType type;
2989 char *text; ///< 0 terminated plain UTF-8 text
2992 * 0 terminated ASS/SSA compatible event line.
2993 * The pressentation of this is unaffected by the other values in this
2999 typedef struct AVSubtitle {
3000 uint16_t format; /* 0 = graphics */
3001 uint32_t start_display_time; /* relative to packet pts, in ms */
3002 uint32_t end_display_time; /* relative to packet pts, in ms */
3004 AVSubtitleRect **rects;
3005 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3008 /* packet functions */
3011 * @deprecated use NULL instead
3013 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3016 * Default packet destructor.
3018 void av_destruct_packet(AVPacket *pkt);
3021 * Initialize optional fields of a packet with default values.
3025 void av_init_packet(AVPacket *pkt);
3028 * Allocate the payload of a packet and initialize its fields with
3032 * @param size wanted payload size
3033 * @return 0 if OK, AVERROR_xxx otherwise
3035 int av_new_packet(AVPacket *pkt, int size);
3038 * Reduce packet size, correctly zeroing padding
3041 * @param size new size
3043 void av_shrink_packet(AVPacket *pkt, int size);
3046 * Increase packet size, correctly zeroing padding
3049 * @param grow_by number of bytes by which to increase the size of the packet
3051 int av_grow_packet(AVPacket *pkt, int grow_by);
3054 * @warning This is a hack - the packet memory allocation stuff is broken. The
3055 * packet is allocated if it was not really allocated.
3057 int av_dup_packet(AVPacket *pkt);
3062 * @param pkt packet to free
3064 void av_free_packet(AVPacket *pkt);
3067 * Allocate new information of a packet.
3070 * @param type side information type
3071 * @param size side information size
3072 * @return pointer to fresh allocated data or NULL otherwise
3074 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3078 * Get side information from packet.
3081 * @param type desired side information type
3082 * @param size pointer for side information size to store (optional)
3083 * @return pointer to data if present or NULL otherwise
3085 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3090 struct ReSampleContext;
3091 struct AVResampleContext;
3093 typedef struct ReSampleContext ReSampleContext;
3096 * Initialize audio resampling context.
3098 * @param output_channels number of output channels
3099 * @param input_channels number of input channels
3100 * @param output_rate output sample rate
3101 * @param input_rate input sample rate
3102 * @param sample_fmt_out requested output sample format
3103 * @param sample_fmt_in input sample format
3104 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3105 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3106 * @param linear if 1 then the used FIR filter will be linearly interpolated
3107 between the 2 closest, if 0 the closest will be used
3108 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3109 * @return allocated ReSampleContext, NULL if error occurred
3111 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3112 int output_rate, int input_rate,
3113 enum AVSampleFormat sample_fmt_out,
3114 enum AVSampleFormat sample_fmt_in,
3115 int filter_length, int log2_phase_count,
3116 int linear, double cutoff);
3118 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3121 * Free resample context.
3123 * @param s a non-NULL pointer to a resample context previously
3124 * created with av_audio_resample_init()
3126 void audio_resample_close(ReSampleContext *s);
3130 * Initialize an audio resampler.
3131 * Note, if either rate is not an integer then simply scale both rates up so they are.
3132 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3133 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3134 * @param linear If 1 then the used FIR filter will be linearly interpolated
3135 between the 2 closest, if 0 the closest will be used
3136 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3138 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3141 * Resample an array of samples using a previously configured context.
3142 * @param src an array of unconsumed samples
3143 * @param consumed the number of samples of src which have been consumed are returned here
3144 * @param src_size the number of unconsumed samples available
3145 * @param dst_size the amount of space in samples available in dst
3146 * @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.
3147 * @return the number of samples written in dst or -1 if an error occurred
3149 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3153 * Compensate samplerate/timestamp drift. The compensation is done by changing
3154 * the resampler parameters, so no audible clicks or similar distortions occur
3155 * @param compensation_distance distance in output samples over which the compensation should be performed
3156 * @param sample_delta number of output samples which should be output less
3158 * example: av_resample_compensate(c, 10, 500)
3159 * here instead of 510 samples only 500 samples would be output
3161 * note, due to rounding the actual compensation might be slightly different,
3162 * especially if the compensation_distance is large and the in_rate used during init is small
3164 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3165 void av_resample_close(struct AVResampleContext *c);
3168 * Allocate memory for a picture. Call avpicture_free() to free it.
3170 * @see avpicture_fill()
3172 * @param picture the picture to be filled in
3173 * @param pix_fmt the format of the picture
3174 * @param width the width of the picture
3175 * @param height the height of the picture
3176 * @return zero if successful, a negative value if not
3178 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3181 * Free a picture previously allocated by avpicture_alloc().
3182 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3185 * @param picture the AVPicture to be freed
3187 void avpicture_free(AVPicture *picture);
3190 * Fill in the AVPicture fields.
3191 * The fields of the given AVPicture are filled in by using the 'ptr' address
3192 * which points to the image data buffer. Depending on the specified picture
3193 * format, one or multiple image data pointers and line sizes will be set.
3194 * If a planar format is specified, several pointers will be set pointing to
3195 * the different picture planes and the line sizes of the different planes
3196 * will be stored in the lines_sizes array.
3197 * Call with ptr == NULL to get the required size for the ptr buffer.
3199 * To allocate the buffer and fill in the AVPicture fields in one call,
3200 * use avpicture_alloc().
3202 * @param picture AVPicture whose fields are to be filled in
3203 * @param ptr Buffer which will contain or contains the actual image data
3204 * @param pix_fmt The format in which the picture data is stored.
3205 * @param width the width of the image in pixels
3206 * @param height the height of the image in pixels
3207 * @return size of the image data in bytes
3209 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3210 enum PixelFormat pix_fmt, int width, int height);
3213 * Copy pixel data from an AVPicture into a buffer.
3214 * The data is stored compactly, without any gaps for alignment or padding
3215 * which may be applied by avpicture_fill().
3217 * @see avpicture_get_size()
3219 * @param[in] src AVPicture containing image data
3220 * @param[in] pix_fmt The format in which the picture data is stored.
3221 * @param[in] width the width of the image in pixels.
3222 * @param[in] height the height of the image in pixels.
3223 * @param[out] dest A buffer into which picture data will be copied.
3224 * @param[in] dest_size The size of 'dest'.
3225 * @return The number of bytes written to dest, or a negative value (error code) on error.
3227 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3228 unsigned char *dest, int dest_size);
3231 * Calculate the size in bytes that a picture of the given width and height
3232 * would occupy if stored in the given picture format.
3233 * Note that this returns the size of a compact representation as generated
3234 * by avpicture_layout(), which can be smaller than the size required for e.g.
3237 * @param pix_fmt the given picture format
3238 * @param width the width of the image
3239 * @param height the height of the image
3240 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3242 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3243 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3245 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3248 * Return a value representing the fourCC code associated to the
3249 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3252 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3255 * Put a string representing the codec tag codec_tag in buf.
3257 * @param buf_size size in bytes of buf
3258 * @return the length of the string that would have been generated if
3259 * enough space had been available, excluding the trailing null
3261 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3263 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3264 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3265 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3266 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3267 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3268 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3271 * Compute what kind of losses will occur when converting from one specific
3272 * pixel format to another.
3273 * When converting from one pixel format to another, information loss may occur.
3274 * For example, when converting from RGB24 to GRAY, the color information will
3275 * be lost. Similarly, other losses occur when converting from some formats to
3276 * other formats. These losses can involve loss of chroma, but also loss of
3277 * resolution, loss of color depth, loss due to the color space conversion, loss
3278 * of the alpha bits or loss due to color quantization.
3279 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3280 * which will occur when converting from one pixel format to another.
3282 * @param[in] dst_pix_fmt destination pixel format
3283 * @param[in] src_pix_fmt source pixel format
3284 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3285 * @return Combination of flags informing you what kind of losses will occur.
3287 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3291 * Find the best pixel format to convert to given a certain source pixel
3292 * format. When converting from one pixel format to another, information loss
3293 * may occur. For example, when converting from RGB24 to GRAY, the color
3294 * information will be lost. Similarly, other losses occur when converting from
3295 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3296 * the given pixel formats should be used to suffer the least amount of loss.
3297 * The pixel formats from which it chooses one, are determined by the
3298 * pix_fmt_mask parameter.
3301 * src_pix_fmt = PIX_FMT_YUV420P;
3302 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3303 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3306 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3307 * @param[in] src_pix_fmt source pixel format
3308 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3309 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3310 * @return The best pixel format to convert to or -1 if none was found.
3312 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3313 int has_alpha, int *loss_ptr);
3315 /* deinterlace a picture */
3316 /* deinterlace - if not supported return -1 */
3317 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3318 enum PixelFormat pix_fmt, int width, int height);
3320 /* external high level API */
3323 * If c is NULL, returns the first registered codec,
3324 * if c is non-NULL, returns the next registered codec after c,
3325 * or NULL if c is the last one.
3327 AVCodec *av_codec_next(AVCodec *c);
3330 * Return the LIBAVCODEC_VERSION_INT constant.
3332 unsigned avcodec_version(void);
3335 * Return the libavcodec build-time configuration.
3337 const char *avcodec_configuration(void);
3340 * Return the libavcodec license.
3342 const char *avcodec_license(void);
3345 * Register the codec codec and initialize libavcodec.
3347 * @warning either this function or avcodec_register_all() must be called
3348 * before any other libavcodec functions.
3350 * @see avcodec_register_all()
3352 void avcodec_register(AVCodec *codec);
3355 * Find a registered encoder with a matching codec ID.
3357 * @param id CodecID of the requested encoder
3358 * @return An encoder if one was found, NULL otherwise.
3360 AVCodec *avcodec_find_encoder(enum CodecID id);
3363 * Find a registered encoder with the specified name.
3365 * @param name name of the requested encoder
3366 * @return An encoder if one was found, NULL otherwise.
3368 AVCodec *avcodec_find_encoder_by_name(const char *name);
3371 * Find a registered decoder with a matching codec ID.
3373 * @param id CodecID of the requested decoder
3374 * @return A decoder if one was found, NULL otherwise.
3376 AVCodec *avcodec_find_decoder(enum CodecID id);
3379 * Find a registered decoder with the specified name.
3381 * @param name name of the requested decoder
3382 * @return A decoder if one was found, NULL otherwise.
3384 AVCodec *avcodec_find_decoder_by_name(const char *name);
3385 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3388 * Return a name for the specified profile, if available.
3390 * @param codec the codec that is searched for the given profile
3391 * @param profile the profile value for which a name is requested
3392 * @return A name for the profile if found, NULL otherwise.
3394 const char *av_get_profile_name(const AVCodec *codec, int profile);
3397 * Set the fields of the given AVCodecContext to default values corresponding
3398 * to the given codec (defaults may be codec-dependent).
3400 * Do not call this function if a non-NULL codec has been passed
3401 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3402 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3403 * different codec on this AVCodecContext.
3405 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3408 * Allocate an AVCodecContext and set its fields to default values. The
3409 * resulting struct can be deallocated by calling avcodec_close() on it followed
3412 * @param codec if non-NULL, allocate private data and initialize defaults
3413 * for the given codec. It is illegal to then call avcodec_open2()
3414 * with a different codec.
3415 * If NULL, then the codec-specific defaults won't be initialized,
3416 * which may result in suboptimal default settings (this is
3417 * important mainly for encoders, e.g. libx264).
3419 * @return An AVCodecContext filled with default values or NULL on failure.
3420 * @see avcodec_get_context_defaults
3422 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3425 * Copy the settings of the source AVCodecContext into the destination
3426 * AVCodecContext. The resulting destination codec context will be
3427 * unopened, i.e. you are required to call avcodec_open2() before you
3428 * can use this AVCodecContext to decode/encode video/audio data.
3430 * @param dest target codec context, should be initialized with
3431 * avcodec_alloc_context3(), but otherwise uninitialized
3432 * @param src source codec context
3433 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3435 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3438 * Set the fields of the given AVFrame to default values.
3440 * @param pic The AVFrame of which the fields should be set to default values.
3442 void avcodec_get_frame_defaults(AVFrame *pic);
3445 * Allocate an AVFrame and set its fields to default values. The resulting
3446 * struct can be deallocated by simply calling av_free().
3448 * @return An AVFrame filled with default values or NULL on failure.
3449 * @see avcodec_get_frame_defaults
3451 AVFrame *avcodec_alloc_frame(void);
3453 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3454 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3455 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3458 * Return the amount of padding in pixels which the get_buffer callback must
3459 * provide around the edge of the image for codecs which do not have the
3460 * CODEC_FLAG_EMU_EDGE flag.
3462 * @return Required padding in pixels.
3464 unsigned avcodec_get_edge_width(void);
3466 * Modify width and height values so that they will result in a memory
3467 * buffer that is acceptable for the codec if you do not use any horizontal
3470 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3471 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3472 * according to avcodec_get_edge_width() before.
3474 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3476 * Modify width and height values so that they will result in a memory
3477 * buffer that is acceptable for the codec if you also ensure that all
3478 * line sizes are a multiple of the respective linesize_align[i].
3480 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3481 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3482 * according to avcodec_get_edge_width() before.
3484 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3485 int linesize_align[AV_NUM_DATA_POINTERS]);
3487 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3489 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3490 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3491 //FIXME func typedef
3494 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3495 * function the context has to be allocated with avcodec_alloc_context3().
3497 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3498 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3499 * retrieving a codec.
3501 * @warning This function is not thread safe!
3504 * avcodec_register_all();
3505 * av_dict_set(&opts, "b", "2.5M", 0);
3506 * codec = avcodec_find_decoder(CODEC_ID_H264);
3510 * context = avcodec_alloc_context3(codec);
3512 * if (avcodec_open2(context, codec, opts) < 0)
3516 * @param avctx The context to initialize.
3517 * @param codec The codec to open this context for. If a non-NULL codec has been
3518 * previously passed to avcodec_alloc_context3() or
3519 * avcodec_get_context_defaults3() for this context, then this
3520 * parameter MUST be either NULL or equal to the previously passed
3522 * @param options A dictionary filled with AVCodecContext and codec-private options.
3523 * On return this object will be filled with options that were not found.
3525 * @return zero on success, a negative value on error
3526 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3527 * av_dict_set(), av_opt_find().
3529 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3531 #if FF_API_OLD_DECODE_AUDIO
3533 * Wrapper function which calls avcodec_decode_audio4.
3535 * @deprecated Use avcodec_decode_audio4 instead.
3537 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3538 * Some decoders may support multiple frames in a single AVPacket, such
3539 * decoders would then just decode the first frame. In this case,
3540 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3541 * the remaining data in order to decode the second frame etc.
3543 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3544 * decompressed frame size in bytes.
3546 * @warning You must set frame_size_ptr to the allocated size of the
3547 * output buffer before calling avcodec_decode_audio3().
3549 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3550 * the actual read bytes because some optimized bitstream readers read 32 or 64
3551 * bits at once and could read over the end.
3553 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3554 * no overreading happens for damaged MPEG streams.
3556 * @warning You must not provide a custom get_buffer() when using
3557 * avcodec_decode_audio3(). Doing so will override it with
3558 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3559 * which does allow the application to provide a custom get_buffer().
3561 * @note You might have to align the input buffer avpkt->data and output buffer
3562 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3563 * necessary at all, on others it won't work at all if not aligned and on others
3564 * it will work but it will have an impact on performance.
3566 * In practice, avpkt->data should have 4 byte alignment at minimum and
3567 * samples should be 16 byte aligned unless the CPU doesn't need it
3568 * (AltiVec and SSE do).
3570 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3571 * between input and output, these need to be fed with avpkt->data=NULL,
3572 * avpkt->size=0 at the end to return the remaining frames.
3574 * @param avctx the codec context
3575 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3576 * If the sample format is planar, each channel plane will
3577 * be the same size, with no padding between channels.
3578 * @param[in,out] frame_size_ptr the output buffer size in bytes
3579 * @param[in] avpkt The input AVPacket containing the input buffer.
3580 * You can create such packet with av_init_packet() and by then setting
3581 * data and size, some decoders might in addition need other fields.
3582 * All decoders are designed to use the least fields possible though.
3583 * @return On error a negative value is returned, otherwise the number of bytes
3584 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3586 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3587 int *frame_size_ptr,
3592 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3594 * Some decoders may support multiple frames in a single AVPacket. Such
3595 * decoders would then just decode the first frame. In this case,
3596 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3597 * the remaining data in order to decode the second frame, etc...
3598 * Even if no frames are returned, the packet needs to be fed to the decoder
3599 * with remaining data until it is completely consumed or an error occurs.
3601 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3602 * larger than the actual read bytes because some optimized bitstream
3603 * readers read 32 or 64 bits at once and could read over the end.
3605 * @note You might have to align the input buffer. The alignment requirements
3606 * depend on the CPU and the decoder.
3608 * @param avctx the codec context
3609 * @param[out] frame The AVFrame in which to store decoded audio samples.
3610 * Decoders request a buffer of a particular size by setting
3611 * AVFrame.nb_samples prior to calling get_buffer(). The
3612 * decoder may, however, only utilize part of the buffer by
3613 * setting AVFrame.nb_samples to a smaller value in the
3615 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3617 * @param[in] avpkt The input AVPacket containing the input buffer.
3618 * At least avpkt->data and avpkt->size should be set. Some
3619 * decoders might also require additional fields to be set.
3620 * @return A negative error code is returned if an error occurred during
3621 * decoding, otherwise the number of bytes consumed from the input
3622 * AVPacket is returned.
3624 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3625 int *got_frame_ptr, AVPacket *avpkt);
3628 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3629 * Some decoders may support multiple frames in a single AVPacket, such
3630 * decoders would then just decode the first frame.
3632 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3633 * the actual read bytes because some optimized bitstream readers read 32 or 64
3634 * bits at once and could read over the end.
3636 * @warning The end of the input buffer buf should be set to 0 to ensure that
3637 * no overreading happens for damaged MPEG streams.
3639 * @note You might have to align the input buffer avpkt->data.
3640 * The alignment requirements depend on the CPU: on some CPUs it isn't
3641 * necessary at all, on others it won't work at all if not aligned and on others
3642 * it will work but it will have an impact on performance.
3644 * In practice, avpkt->data should have 4 byte alignment at minimum.
3646 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3647 * between input and output, these need to be fed with avpkt->data=NULL,
3648 * avpkt->size=0 at the end to return the remaining frames.
3650 * @param avctx the codec context
3651 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3652 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3653 * allocate memory for the actual bitmap.
3654 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3655 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3656 * decodes and the decoder tells the user once it does not need the data anymore,
3657 * the user app can at this point free/reuse/keep the memory as it sees fit.
3659 * @param[in] avpkt The input AVpacket containing the input buffer.
3660 * You can create such packet with av_init_packet() and by then setting
3661 * data and size, some decoders might in addition need other fields like
3662 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3664 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3665 * @return On error a negative value is returned, otherwise the number of bytes
3666 * used or zero if no frame could be decompressed.
3668 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3669 int *got_picture_ptr,
3673 * Decode a subtitle message.
3674 * Return a negative value on error, otherwise return the number of bytes used.
3675 * If no subtitle could be decompressed, got_sub_ptr is zero.
3676 * Otherwise, the subtitle is stored in *sub.
3677 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3678 * simplicity, because the performance difference is expect to be negligible
3679 * and reusing a get_buffer written for video codecs would probably perform badly
3680 * due to a potentially very different allocation pattern.
3682 * @param avctx the codec context
3683 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3684 freed with avsubtitle_free if *got_sub_ptr is set.
3685 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3686 * @param[in] avpkt The input AVPacket containing the input buffer.
3688 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3693 * Free all allocated data in the given subtitle struct.
3695 * @param sub AVSubtitle to free.
3697 void avsubtitle_free(AVSubtitle *sub);
3699 #if FF_API_OLD_ENCODE_AUDIO
3701 * Encode an audio frame from samples into buf.
3703 * @deprecated Use avcodec_encode_audio2 instead.
3705 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3706 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3707 * will know how much space is needed because it depends on the value passed
3708 * in buf_size as described below. In that case a lower value can be used.
3710 * @param avctx the codec context
3711 * @param[out] buf the output buffer
3712 * @param[in] buf_size the output buffer size
3713 * @param[in] samples the input buffer containing the samples
3714 * The number of samples read from this buffer is frame_size*channels,
3715 * both of which are defined in avctx.
3716 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3717 * samples read from samples is equal to:
3718 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3719 * This also implies that av_get_bits_per_sample() must not return 0 for these
3721 * @return On error a negative value is returned, on success zero or the number
3722 * of bytes used to encode the data read from the input buffer.
3724 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3725 uint8_t *buf, int buf_size,
3726 const short *samples);
3730 * Encode a frame of audio.
3732 * Takes input samples from frame and writes the next output packet, if
3733 * available, to avpkt. The output packet does not necessarily contain data for
3734 * the most recent frame, as encoders can delay, split, and combine input frames
3735 * internally as needed.
3737 * @param avctx codec context
3738 * @param avpkt output AVPacket.
3739 * The user can supply an output buffer by setting
3740 * avpkt->data and avpkt->size prior to calling the
3741 * function, but if the size of the user-provided data is not
3742 * large enough, encoding will fail. All other AVPacket fields
3743 * will be reset by the encoder using av_init_packet(). If
3744 * avpkt->data is NULL, the encoder will allocate it.
3745 * The encoder will set avpkt->size to the size of the
3747 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3748 * May be NULL when flushing an encoder that has the
3749 * CODEC_CAP_DELAY capability set.
3750 * There are 2 codec capabilities that affect the allowed
3751 * values of frame->nb_samples.
3752 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
3753 * frame may be smaller than avctx->frame_size, and all other
3754 * frames must be equal to avctx->frame_size.
3755 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3756 * can have any number of samples.
3757 * If neither is set, frame->nb_samples must be equal to
3758 * avctx->frame_size for all frames.
3759 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3760 * output packet is non-empty, and to 0 if it is
3761 * empty. If the function returns an error, the
3762 * packet can be assumed to be invalid, and the
3763 * value of got_packet_ptr is undefined and should
3765 * @return 0 on success, negative error code on failure
3767 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3768 const AVFrame *frame, int *got_packet_ptr);
3771 * Fill audio frame data and linesize.
3772 * AVFrame extended_data channel pointers are allocated if necessary for
3775 * @param frame the AVFrame
3776 * frame->nb_samples must be set prior to calling the
3777 * function. This function fills in frame->data,
3778 * frame->extended_data, frame->linesize[0].
3779 * @param nb_channels channel count
3780 * @param sample_fmt sample format
3781 * @param buf buffer to use for frame data
3782 * @param buf_size size of buffer
3783 * @param align plane size sample alignment
3784 * @return 0 on success, negative error code on failure
3786 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
3787 enum AVSampleFormat sample_fmt, const uint8_t *buf,
3788 int buf_size, int align);
3790 #if FF_API_OLD_ENCODE_VIDEO
3792 * @deprecated use avcodec_encode_video2() instead.
3794 * Encode a video frame from pict into buf.
3795 * The input picture should be
3796 * stored using a specific format, namely avctx.pix_fmt.
3798 * @param avctx the codec context
3799 * @param[out] buf the output buffer for the bitstream of encoded frame
3800 * @param[in] buf_size the size of the output buffer in bytes
3801 * @param[in] pict the input picture to encode
3802 * @return On error a negative value is returned, on success zero or the number
3803 * of bytes used from the output buffer.
3805 attribute_deprecated
3806 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3807 const AVFrame *pict);
3811 * Encode a frame of video.
3813 * Takes input raw video data from frame and writes the next output packet, if
3814 * available, to avpkt. The output packet does not necessarily contain data for
3815 * the most recent frame, as encoders can delay and reorder input frames
3816 * internally as needed.
3818 * @param avctx codec context
3819 * @param avpkt output AVPacket.
3820 * The user can supply an output buffer by setting
3821 * avpkt->data and avpkt->size prior to calling the
3822 * function, but if the size of the user-provided data is not
3823 * large enough, encoding will fail. All other AVPacket fields
3824 * will be reset by the encoder using av_init_packet(). If
3825 * avpkt->data is NULL, the encoder will allocate it.
3826 * The encoder will set avpkt->size to the size of the
3827 * output packet. The returned data (if any) belongs to the
3828 * caller, he is responsible for freeing it.
3829 * @param[in] frame AVFrame containing the raw video data to be encoded.
3830 * May be NULL when flushing an encoder that has the
3831 * CODEC_CAP_DELAY capability set.
3832 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3833 * output packet is non-empty, and to 0 if it is
3834 * empty. If the function returns an error, the
3835 * packet can be assumed to be invalid, and the
3836 * value of got_packet_ptr is undefined and should
3838 * @return 0 on success, negative error code on failure
3840 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3841 const AVFrame *frame, int *got_packet_ptr);
3843 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3844 const AVSubtitle *sub);
3847 * Close a given AVCodecContext and free all the data associated with it
3848 * (but not the AVCodecContext itself).
3850 * Calling this function on an AVCodecContext that hasn't been opened will free
3851 * the codec-specific data allocated in avcodec_alloc_context3() /
3852 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3855 int avcodec_close(AVCodecContext *avctx);
3858 * Register all the codecs, parsers and bitstream filters which were enabled at
3859 * configuration time. If you do not call this function you can select exactly
3860 * which formats you want to support, by using the individual registration
3863 * @see avcodec_register
3864 * @see av_register_codec_parser
3865 * @see av_register_bitstream_filter
3867 void avcodec_register_all(void);
3870 * Flush buffers, should be called when seeking or when switching to a different stream.
3872 void avcodec_flush_buffers(AVCodecContext *avctx);
3874 void avcodec_default_free_buffers(AVCodecContext *s);
3876 /* misc useful functions */
3879 * Return codec bits per sample.
3881 * @param[in] codec_id the codec
3882 * @return Number of bits per sample or zero if unknown for the given codec.
3884 int av_get_bits_per_sample(enum CodecID codec_id);
3887 typedef struct AVCodecParserContext {
3889 struct AVCodecParser *parser;
3890 int64_t frame_offset; /* offset of the current frame */
3891 int64_t cur_offset; /* current offset
3892 (incremented by each av_parser_parse()) */
3893 int64_t next_frame_offset; /* offset of the next frame */
3895 int pict_type; /* XXX: Put it back in AVCodecContext. */
3897 * This field is used for proper frame duration computation in lavf.
3898 * It signals, how much longer the frame duration of the current frame
3899 * is compared to normal frame duration.
3901 * frame_duration = (1 + repeat_pict) * time_base
3903 * It is used by codecs like H.264 to display telecined material.
3905 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3906 int64_t pts; /* pts of the current frame */
3907 int64_t dts; /* dts of the current frame */
3912 int fetch_timestamp;
3914 #define AV_PARSER_PTS_NB 4
3915 int cur_frame_start_index;
3916 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3917 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3918 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3921 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3922 #define PARSER_FLAG_ONCE 0x0002
3923 /// Set if the parser has a valid file offset
3924 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3926 int64_t offset; ///< byte offset from starting packet start
3927 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3930 * Set by parser to 1 for key frames and 0 for non-key frames.
3931 * It is initialized to -1, so if the parser doesn't set this flag,
3932 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3938 * Time difference in stream time base units from the pts of this
3939 * packet to the point at which the output from the decoder has converged
3940 * independent from the availability of previous frames. That is, the
3941 * frames are virtually identical no matter if decoding started from
3942 * the very first frame or from this keyframe.
3943 * Is AV_NOPTS_VALUE if unknown.
3944 * This field is not the display duration of the current frame.
3945 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3948 * The purpose of this field is to allow seeking in streams that have no
3949 * keyframes in the conventional sense. It corresponds to the
3950 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3951 * essential for some types of subtitle streams to ensure that all
3952 * subtitles are correctly displayed after seeking.
3954 int64_t convergence_duration;
3956 // Timestamp generation support:
3958 * Synchronization point for start of timestamp generation.
3960 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3963 * For example, this corresponds to presence of H.264 buffering period
3969 * Offset of the current timestamp against last timestamp sync point in
3970 * units of AVCodecContext.time_base.
3972 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3973 * contain a valid timestamp offset.
3975 * Note that the timestamp of sync point has usually a nonzero
3976 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3977 * the next frame after timestamp sync point will be usually 1.
3979 * For example, this corresponds to H.264 cpb_removal_delay.
3981 int dts_ref_dts_delta;
3984 * Presentation delay of current frame in units of AVCodecContext.time_base.
3986 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3987 * contain valid non-negative timestamp delta (presentation time of a frame
3988 * must not lie in the past).
3990 * This delay represents the difference between decoding and presentation
3991 * time of the frame.
3993 * For example, this corresponds to H.264 dpb_output_delay.
3998 * Position of the packet in file.
4000 * Analogous to cur_frame_pts/dts
4002 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4005 * Byte position of currently parsed frame in stream.
4010 * Previous frame byte position.
4015 * Duration of the current frame.
4016 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4017 * For all other types, this is in units of AVCodecContext.time_base.
4020 } AVCodecParserContext;
4022 typedef struct AVCodecParser {
4023 int codec_ids[5]; /* several codec IDs are permitted */
4025 int (*parser_init)(AVCodecParserContext *s);
4026 int (*parser_parse)(AVCodecParserContext *s,
4027 AVCodecContext *avctx,
4028 const uint8_t **poutbuf, int *poutbuf_size,
4029 const uint8_t *buf, int buf_size);
4030 void (*parser_close)(AVCodecParserContext *s);
4031 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4032 struct AVCodecParser *next;
4035 AVCodecParser *av_parser_next(AVCodecParser *c);
4037 void av_register_codec_parser(AVCodecParser *parser);
4038 AVCodecParserContext *av_parser_init(int codec_id);
4043 * @param s parser context.
4044 * @param avctx codec context.
4045 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4046 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4047 * @param buf input buffer.
4048 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4049 * @param pts input presentation timestamp.
4050 * @param dts input decoding timestamp.
4051 * @param pos input byte position in stream.
4052 * @return the number of bytes of the input bitstream used.
4057 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4064 * decode_frame(data, size);
4068 int av_parser_parse2(AVCodecParserContext *s,
4069 AVCodecContext *avctx,
4070 uint8_t **poutbuf, int *poutbuf_size,
4071 const uint8_t *buf, int buf_size,
4072 int64_t pts, int64_t dts,
4075 int av_parser_change(AVCodecParserContext *s,
4076 AVCodecContext *avctx,
4077 uint8_t **poutbuf, int *poutbuf_size,
4078 const uint8_t *buf, int buf_size, int keyframe);
4079 void av_parser_close(AVCodecParserContext *s);
4082 typedef struct AVBitStreamFilterContext {
4084 struct AVBitStreamFilter *filter;
4085 AVCodecParserContext *parser;
4086 struct AVBitStreamFilterContext *next;
4087 } AVBitStreamFilterContext;
4090 typedef struct AVBitStreamFilter {
4093 int (*filter)(AVBitStreamFilterContext *bsfc,
4094 AVCodecContext *avctx, const char *args,
4095 uint8_t **poutbuf, int *poutbuf_size,
4096 const uint8_t *buf, int buf_size, int keyframe);
4097 void (*close)(AVBitStreamFilterContext *bsfc);
4098 struct AVBitStreamFilter *next;
4099 } AVBitStreamFilter;
4101 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4102 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4103 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4104 AVCodecContext *avctx, const char *args,
4105 uint8_t **poutbuf, int *poutbuf_size,
4106 const uint8_t *buf, int buf_size, int keyframe);
4107 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4109 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4114 * Reallocate the given block if it is not large enough, otherwise do nothing.
4118 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4121 * Allocate a buffer, reusing the given one if large enough.
4123 * Contrary to av_fast_realloc the current buffer contents might not be
4124 * preserved and on error the old buffer is freed, thus no special
4125 * handling to avoid memleaks is necessary.
4127 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4128 * @param size size of the buffer *ptr points to
4129 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4130 * *size 0 if an error occurred.
4132 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4135 * Allocate a buffer with padding, reusing the given one if large enough.
4137 * Same behaviour av_fast_malloc but the buffer has additional
4138 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4141 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4144 * Copy image src to dst. Wraps av_picture_data_copy() above.
4146 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4147 enum PixelFormat pix_fmt, int width, int height);
4150 * Crop image top and left side.
4152 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4153 enum PixelFormat pix_fmt, int top_band, int left_band);
4158 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4159 int padtop, int padbottom, int padleft, int padright, int *color);
4162 * Encode extradata length to a buffer. Used by xiph codecs.
4164 * @param s buffer to write to; must be at least (v/255+1) bytes long
4165 * @param v size of extradata in bytes
4166 * @return number of bytes written to the buffer.
4168 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4171 * Log a generic warning message about a missing feature. This function is
4172 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4173 * only, and would normally not be used by applications.
4174 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4175 * a pointer to an AVClass struct
4176 * @param[in] feature string containing the name of the missing feature
4177 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4178 * If want_sample is non-zero, additional verbage will be added to the log
4179 * message which tells the user how to report samples to the development
4182 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4185 * Log a generic warning message asking for a sample. This function is
4186 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4187 * only, and would normally not be used by applications.
4188 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4189 * a pointer to an AVClass struct
4190 * @param[in] msg string containing an optional message, or NULL if no message
4192 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4195 * Register the hardware accelerator hwaccel.
4197 void av_register_hwaccel(AVHWAccel *hwaccel);
4200 * If hwaccel is NULL, returns the first registered hardware accelerator,
4201 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4202 * after hwaccel, or NULL if hwaccel is the last one.
4204 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4208 * Lock operation used by lockmgr
4211 AV_LOCK_CREATE, ///< Create a mutex
4212 AV_LOCK_OBTAIN, ///< Lock the mutex
4213 AV_LOCK_RELEASE, ///< Unlock the mutex
4214 AV_LOCK_DESTROY, ///< Free mutex resources
4218 * Register a user provided lock manager supporting the operations
4219 * specified by AVLockOp. mutex points to a (void *) where the
4220 * lockmgr should store/get a pointer to a user allocated mutex. It's
4221 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4223 * @param cb User defined callback. Note: Libav may invoke calls to this
4224 * callback during the call to av_lockmgr_register().
4225 * Thus, the application must be prepared to handle that.
4226 * If cb is set to NULL the lockmgr will be unregistered.
4227 * Also note that during unregistration the previously registered
4228 * lockmgr callback may also be invoked.
4230 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4233 * Get the type of the given codec.
4235 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4238 * Get the AVClass for AVCodecContext. It can be used in combination with
4239 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4241 * @see av_opt_find().
4243 const AVClass *avcodec_get_class(void);
4246 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4247 * with no corresponding avcodec_close()), 0 otherwise.
4249 int avcodec_is_open(AVCodecContext *s);
4251 #endif /* AVCODEC_AVCODEC_H */