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,
186 #if LIBAVCODEC_VERSION_MAJOR == 53
194 CODEC_ID_BETHSOFTVID,
206 #if LIBAVCODEC_VERSION_MAJOR == 53
214 CODEC_ID_MOTIONPIXELS,
232 CODEC_ID_IFF_BYTERUN1,
248 #if LIBAVCODEC_VERSION_MAJOR == 53
259 /* various PCM "codecs" */
260 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
261 CODEC_ID_PCM_S16LE = 0x10000,
277 CODEC_ID_PCM_S24DAUD,
279 CODEC_ID_PCM_S16LE_PLANAR,
288 CODEC_ID_PCM_S8_PLANAR,
290 /* various ADPCM codecs */
291 CODEC_ID_ADPCM_IMA_QT = 0x11000,
292 CODEC_ID_ADPCM_IMA_WAV,
293 CODEC_ID_ADPCM_IMA_DK3,
294 CODEC_ID_ADPCM_IMA_DK4,
295 CODEC_ID_ADPCM_IMA_WS,
296 CODEC_ID_ADPCM_IMA_SMJPEG,
305 CODEC_ID_ADPCM_YAMAHA,
306 CODEC_ID_ADPCM_SBPRO_4,
307 CODEC_ID_ADPCM_SBPRO_3,
308 CODEC_ID_ADPCM_SBPRO_2,
310 CODEC_ID_ADPCM_IMA_AMV,
311 CODEC_ID_ADPCM_EA_R1,
312 CODEC_ID_ADPCM_EA_R3,
313 CODEC_ID_ADPCM_EA_R2,
314 CODEC_ID_ADPCM_IMA_EA_SEAD,
315 CODEC_ID_ADPCM_IMA_EA_EACS,
316 CODEC_ID_ADPCM_EA_XAS,
317 CODEC_ID_ADPCM_EA_MAXIS_XA,
318 CODEC_ID_ADPCM_IMA_ISS,
320 CODEC_ID_ADPCM_IMA_APC,
323 CODEC_ID_AMR_NB = 0x12000,
326 /* RealAudio codecs*/
327 CODEC_ID_RA_144 = 0x13000,
330 /* various DPCM codecs */
331 CODEC_ID_ROQ_DPCM = 0x14000,
332 CODEC_ID_INTERPLAY_DPCM,
337 CODEC_ID_MP2 = 0x15000,
338 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
349 #if LIBAVCODEC_VERSION_MAJOR == 53
358 CODEC_ID_WESTWOOD_SND1,
359 CODEC_ID_GSM, ///< as in Berlin toast format
367 CODEC_ID_DSICINAUDIO,
371 CODEC_ID_GSM_MS, /* as found in WAV */
380 CODEC_ID_WMALOSSLESS,
389 CODEC_ID_BINKAUDIO_RDFT,
390 CODEC_ID_BINKAUDIO_DCT,
394 #if LIBAVCODEC_VERSION_MAJOR > 53
402 /* subtitle codecs */
403 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
404 CODEC_ID_DVD_SUBTITLE = 0x17000,
405 CODEC_ID_DVB_SUBTITLE,
406 CODEC_ID_TEXT, ///< raw UTF-8 text
410 CODEC_ID_HDMV_PGS_SUBTITLE,
411 CODEC_ID_DVB_TELETEXT,
414 /* other specific kind of codecs (generally used for attachments) */
415 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
416 CODEC_ID_TTF = 0x18000,
418 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
420 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
421 * stream (only used by libavformat) */
422 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
423 * stream (only used by libavformat) */
424 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
427 #if FF_API_OLD_DECODE_AUDIO
429 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
433 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
434 * This is mainly needed because some optimized bitstream readers read
435 * 32 or 64 bit at once and could read over the end.<br>
436 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
437 * MPEG bitstreams could cause overread and segfault.
439 #define FF_INPUT_BUFFER_PADDING_SIZE 8
442 * minimum encoding buffer size
443 * Used to avoid some checks during header writing.
445 #define FF_MIN_BUFFER_SIZE 16384
449 * motion estimation type.
452 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
456 ME_EPZS, ///< enhanced predictive zonal search
457 ME_X1, ///< reserved for experiments
458 ME_HEX, ///< hexagon based search
459 ME_UMH, ///< uneven multi-hexagon search
460 ME_ITER, ///< iterative search
461 ME_TESA, ///< transformed exhaustive search algorithm
465 /* We leave some space between them for extensions (drop some
466 * keyframes for intra-only or drop just some bidir frames). */
467 AVDISCARD_NONE =-16, ///< discard nothing
468 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
469 AVDISCARD_NONREF = 8, ///< discard all non reference
470 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
471 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
472 AVDISCARD_ALL = 48, ///< discard all
475 enum AVColorPrimaries{
476 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
477 AVCOL_PRI_UNSPECIFIED=2,
479 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
480 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
481 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
483 AVCOL_PRI_NB , ///< Not part of ABI
486 enum AVColorTransferCharacteristic{
487 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
488 AVCOL_TRC_UNSPECIFIED=2,
489 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
490 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
491 AVCOL_TRC_NB , ///< Not part of ABI
496 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
497 AVCOL_SPC_UNSPECIFIED=2,
499 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
500 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
501 AVCOL_SPC_SMPTE240M =7,
502 AVCOL_SPC_NB , ///< Not part of ABI
506 AVCOL_RANGE_UNSPECIFIED=0,
507 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
508 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
509 AVCOL_RANGE_NB , ///< Not part of ABI
513 * X X 3 4 X X are luma samples,
514 * 1 2 1-6 are possible chroma positions
515 * X X 5 6 X 0 is undefined/unknown position
517 enum AVChromaLocation{
518 AVCHROMA_LOC_UNSPECIFIED=0,
519 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
520 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
521 AVCHROMA_LOC_TOPLEFT =3, ///< DV
523 AVCHROMA_LOC_BOTTOMLEFT =5,
524 AVCHROMA_LOC_BOTTOM =6,
525 AVCHROMA_LOC_NB , ///< Not part of ABI
528 enum AVAudioServiceType {
529 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
530 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
531 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
532 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
533 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
534 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
535 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
536 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
537 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
538 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
541 typedef struct RcOverride{
544 int qscale; // If this is 0 then quality_factor will be used instead.
545 float quality_factor;
548 #define FF_MAX_B_FRAMES 16
551 These flags can be passed in AVCodecContext.flags before initialization.
552 Note: Not everything is supported yet.
555 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
556 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
557 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
558 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
559 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
561 * The parent program guarantees that the input for B-frames containing
562 * streams is not written to for at least s->max_b_frames+1 frames, if
563 * this is not set the input will be copied.
565 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
566 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
567 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
568 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
569 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
570 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
571 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
572 location instead of only at frame boundaries. */
573 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
574 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
575 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
576 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
577 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
578 /* Fx : Flag for h263+ extra options */
579 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
580 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
581 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
582 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
583 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
584 #define CODEC_FLAG_CLOSED_GOP 0x80000000
585 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
586 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
587 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
588 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
589 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
590 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
592 /* Unsupported options :
593 * Syntax Arithmetic coding (SAC)
594 * Reference Picture Selection
595 * Independent Segment Decoding */
597 /* codec capabilities */
599 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
601 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
602 * If not set, it might not use get_buffer() at all or use operations that
603 * assume the buffer was allocated by avcodec_default_get_buffer.
605 #define CODEC_CAP_DR1 0x0002
606 #if FF_API_PARSE_FRAME
607 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
608 #define CODEC_CAP_PARSE_ONLY 0x0004
610 #define CODEC_CAP_TRUNCATED 0x0008
611 /* Codec can export data for HW decoding (XvMC). */
612 #define CODEC_CAP_HWACCEL 0x0010
614 * Encoder or decoder requires flushing with NULL input at the end in order to
615 * give the complete and correct output.
617 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
618 * with NULL data. The user can still send NULL data to the public encode
619 * or decode function, but libavcodec will not pass it along to the codec
620 * unless this flag is set.
623 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
624 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
628 * The encoder needs to be fed with NULL data at the end of encoding until the
629 * encoder no longer returns data.
631 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
632 * flag also means that the encoder must set the pts and duration for
633 * each output packet. If this flag is not set, the pts and duration will
634 * be determined by libavcodec from the input frame.
636 #define CODEC_CAP_DELAY 0x0020
638 * Codec can be fed a final frame with a smaller size.
639 * This can be used to prevent truncation of the last audio samples.
641 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
643 * Codec can export data for HW decoding (VDPAU).
645 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
647 * Codec can output multiple frames per AVPacket
648 * Normally demuxers return one frame at a time, demuxers which do not do
649 * are connected to a parser to split what they return into proper frames.
650 * This flag is reserved to the very rare category of codecs which have a
651 * bitstream that cannot be split into frames without timeconsuming
652 * operations like full decoding. Demuxers carring such bitstreams thus
653 * may return multiple frames in a packet. This has many disadvantages like
654 * prohibiting stream copy in many cases thus it should only be considered
657 #define CODEC_CAP_SUBFRAMES 0x0100
659 * Codec is experimental and is thus avoided in favor of non experimental
662 #define CODEC_CAP_EXPERIMENTAL 0x0200
664 * Codec should fill in channel configuration and samplerate instead of container
666 #define CODEC_CAP_CHANNEL_CONF 0x0400
668 * Codec is able to deal with negative linesizes
670 #define CODEC_CAP_NEG_LINESIZES 0x0800
672 * Codec supports frame-level multithreading.
674 #define CODEC_CAP_FRAME_THREADS 0x1000
676 * Codec supports slice-based (or partition-based) multithreading.
678 #define CODEC_CAP_SLICE_THREADS 0x2000
680 * Codec supports changed parameters at any point.
682 #define CODEC_CAP_PARAM_CHANGE 0x4000
684 * Codec supports avctx->thread_count == 0 (auto).
686 #define CODEC_CAP_AUTO_THREADS 0x8000
688 * Audio encoder supports receiving a different number of samples in each call.
690 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
692 //The following defines may change, don't expect compatibility if you use them.
693 #define MB_TYPE_INTRA4x4 0x0001
694 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
695 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
696 #define MB_TYPE_16x16 0x0008
697 #define MB_TYPE_16x8 0x0010
698 #define MB_TYPE_8x16 0x0020
699 #define MB_TYPE_8x8 0x0040
700 #define MB_TYPE_INTERLACED 0x0080
701 #define MB_TYPE_DIRECT2 0x0100 //FIXME
702 #define MB_TYPE_ACPRED 0x0200
703 #define MB_TYPE_GMC 0x0400
704 #define MB_TYPE_SKIP 0x0800
705 #define MB_TYPE_P0L0 0x1000
706 #define MB_TYPE_P1L0 0x2000
707 #define MB_TYPE_P0L1 0x4000
708 #define MB_TYPE_P1L1 0x8000
709 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
710 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
711 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
712 #define MB_TYPE_QUANT 0x00010000
713 #define MB_TYPE_CBP 0x00020000
714 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
718 * This specifies the area which should be displayed.
719 * Note there may be multiple such areas for one frame.
721 typedef struct AVPanScan{
724 * - encoding: Set by user.
725 * - decoding: Set by libavcodec.
730 * width and height in 1/16 pel
731 * - encoding: Set by user.
732 * - decoding: Set by libavcodec.
738 * position of the top left corner in 1/16 pel for up to 3 fields/frames
739 * - encoding: Set by user.
740 * - decoding: Set by libavcodec.
742 int16_t position[3][2];
745 #define FF_QSCALE_TYPE_MPEG1 0
746 #define FF_QSCALE_TYPE_MPEG2 1
747 #define FF_QSCALE_TYPE_H264 2
748 #define FF_QSCALE_TYPE_VP56 3
750 #define FF_BUFFER_TYPE_INTERNAL 1
751 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
752 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
753 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
755 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
756 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
757 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
758 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
760 enum AVPacketSideDataType {
762 AV_PKT_DATA_NEW_EXTRADATA,
763 AV_PKT_DATA_PARAM_CHANGE,
766 typedef struct AVPacket {
768 * Presentation timestamp in AVStream->time_base units; the time at which
769 * the decompressed packet will be presented to the user.
770 * Can be AV_NOPTS_VALUE if it is not stored in the file.
771 * pts MUST be larger or equal to dts as presentation cannot happen before
772 * decompression, unless one wants to view hex dumps. Some formats misuse
773 * the terms dts and pts/cts to mean something different. Such timestamps
774 * must be converted to true pts/dts before they are stored in AVPacket.
778 * Decompression timestamp in AVStream->time_base units; the time at which
779 * the packet is decompressed.
780 * Can be AV_NOPTS_VALUE if it is not stored in the file.
787 * A combination of AV_PKT_FLAG values
791 * Additional packet data that can be provided by the container.
792 * Packet can contain several types of side information.
797 enum AVPacketSideDataType type;
802 * Duration of this packet in AVStream->time_base units, 0 if unknown.
803 * Equals next_pts - this_pts in presentation order.
806 void (*destruct)(struct AVPacket *);
808 int64_t pos; ///< byte position in stream, -1 if unknown
811 * Time difference in AVStream->time_base units from the pts of this
812 * packet to the point at which the output from the decoder has converged
813 * independent from the availability of previous frames. That is, the
814 * frames are virtually identical no matter if decoding started from
815 * the very first frame or from this keyframe.
816 * Is AV_NOPTS_VALUE if unknown.
817 * This field is not the display duration of the current packet.
818 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
821 * The purpose of this field is to allow seeking in streams that have no
822 * keyframes in the conventional sense. It corresponds to the
823 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
824 * essential for some types of subtitle streams to ensure that all
825 * subtitles are correctly displayed after seeking.
827 int64_t convergence_duration;
829 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
830 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
833 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
835 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
836 * s32le channel_count
837 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
838 * u64le channel_layout
839 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
841 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
846 enum AVSideDataParamChangeFlags {
847 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
848 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
849 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
850 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
855 * New fields can be added to the end of AVFRAME with minor version
856 * bumps. Removal, reordering and changes to existing fields require
857 * a major version bump.
858 * sizeof(AVFrame) must not be used outside libav*.
860 typedef struct AVFrame {
861 #if FF_API_DATA_POINTERS
862 #define AV_NUM_DATA_POINTERS 4
864 #define AV_NUM_DATA_POINTERS 8
867 * pointer to the picture/channel planes.
868 * This might be different from the first allocated byte
869 * - encoding: Set by user
870 * - decoding: set by AVCodecContext.get_buffer()
872 uint8_t *data[AV_NUM_DATA_POINTERS];
875 * Size, in bytes, of the data for each picture/channel plane.
877 * For audio, only linesize[0] may be set. For planar audio, each channel
878 * plane must be the same size.
880 * - encoding: Set by user (video only)
881 * - decoding: set by AVCodecContext.get_buffer()
883 int linesize[AV_NUM_DATA_POINTERS];
886 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
887 * This isn't used by libavcodec unless the default get/release_buffer() is used.
891 uint8_t *base[AV_NUM_DATA_POINTERS];
893 * 1 -> keyframe, 0-> not
894 * - encoding: Set by libavcodec.
895 * - decoding: Set by libavcodec.
900 * Picture type of the frame, see ?_TYPE below.
901 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
902 * - decoding: Set by libavcodec.
904 enum AVPictureType pict_type;
907 * presentation timestamp in time_base units (time when frame should be shown to user)
908 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
909 * - encoding: MUST be set by user.
910 * - decoding: Set by libavcodec.
915 * picture number in bitstream order
917 * - decoding: Set by libavcodec.
919 int coded_picture_number;
921 * picture number in display order
923 * - decoding: Set by libavcodec.
925 int display_picture_number;
928 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
929 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
930 * - decoding: Set by libavcodec.
934 #if FF_API_AVFRAME_AGE
938 attribute_deprecated int age;
942 * is this picture used as reference
943 * The values for this are the same as the MpegEncContext.picture_structure
944 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
945 * Set to 4 for delayed, non-reference frames.
947 * - decoding: Set by libavcodec. (before get_buffer() call)).
954 * - decoding: Set by libavcodec.
956 int8_t *qscale_table;
960 * - decoding: Set by libavcodec.
965 * mbskip_table[mb]>=1 if MB didn't change
966 * stride= mb_width = (width+15)>>4
968 * - decoding: Set by libavcodec.
970 uint8_t *mbskip_table;
973 * motion vector table
976 * int mv_sample_log2= 4 - motion_subsample_log2;
977 * int mb_width= (width+15)>>4;
978 * int mv_stride= (mb_width << mv_sample_log2) + 1;
979 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
981 * - encoding: Set by user.
982 * - decoding: Set by libavcodec.
984 int16_t (*motion_val[2])[2];
987 * macroblock type table
988 * mb_type_base + mb_width + 2
989 * - encoding: Set by user.
990 * - decoding: Set by libavcodec.
995 * log2 of the size of the block which a single vector in motion_val represents:
996 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
998 * - decoding: Set by libavcodec.
1000 uint8_t motion_subsample_log2;
1003 * for some private data of the user
1004 * - encoding: unused
1005 * - decoding: Set by user.
1011 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1012 * - decoding: unused
1014 uint64_t error[AV_NUM_DATA_POINTERS];
1017 * type of the buffer (to keep track of who has to deallocate data[*])
1018 * - encoding: Set by the one who allocates it.
1019 * - decoding: Set by the one who allocates it.
1020 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1025 * When decoding, this signals how much the picture must be delayed.
1026 * extra_delay = repeat_pict / (2*fps)
1027 * - encoding: unused
1028 * - decoding: Set by libavcodec.
1038 * The content of the picture is interlaced.
1039 * - encoding: Set by user.
1040 * - decoding: Set by libavcodec. (default 0)
1042 int interlaced_frame;
1045 * If the content is interlaced, is top field displayed first.
1046 * - encoding: Set by user.
1047 * - decoding: Set by libavcodec.
1049 int top_field_first;
1053 * - encoding: Set by user.
1054 * - decoding: Set by libavcodec.
1056 AVPanScan *pan_scan;
1059 * Tell user application that palette has changed from previous frame.
1060 * - encoding: ??? (no palette-enabled encoder yet)
1061 * - decoding: Set by libavcodec. (default 0).
1063 int palette_has_changed;
1066 * codec suggestion on buffer type if != 0
1067 * - encoding: unused
1068 * - decoding: Set by libavcodec. (before get_buffer() call)).
1074 * - encoding: unused
1075 * - decoding: Set by libavcodec.
1080 * motion reference frame index
1081 * the order in which these are stored can depend on the codec.
1082 * - encoding: Set by user.
1083 * - decoding: Set by libavcodec.
1085 int8_t *ref_index[2];
1088 * reordered opaque 64bit (generally an integer or a double precision float
1089 * PTS but can be anything).
1090 * The user sets AVCodecContext.reordered_opaque to represent the input at
1092 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1093 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1094 * @deprecated in favor of pkt_pts
1095 * - encoding: unused
1096 * - decoding: Read by user.
1098 int64_t reordered_opaque;
1101 * hardware accelerator private data (Libav-allocated)
1102 * - encoding: unused
1103 * - decoding: Set by libavcodec
1105 void *hwaccel_picture_private;
1108 * reordered pts from the last AVPacket that has been input into the decoder
1109 * - encoding: unused
1110 * - decoding: Read by user.
1115 * dts from the last AVPacket that has been input into the decoder
1116 * - encoding: unused
1117 * - decoding: Read by user.
1122 * the AVCodecContext which ff_thread_get_buffer() was last called on
1123 * - encoding: Set by libavcodec.
1124 * - decoding: Set by libavcodec.
1126 struct AVCodecContext *owner;
1129 * used by multithreading to store frame-specific info
1130 * - encoding: Set by libavcodec.
1131 * - decoding: Set by libavcodec.
1133 void *thread_opaque;
1136 * number of audio samples (per channel) described by this frame
1137 * - encoding: unused
1138 * - decoding: Set by libavcodec
1143 * pointers to the data planes/channels.
1145 * For video, this should simply point to data[].
1147 * For planar audio, each channel has a separate data pointer, and
1148 * linesize[0] contains the size of each channel buffer.
1149 * For packed audio, there is just one data pointer, and linesize[0]
1150 * contains the total size of the buffer for all channels.
1152 * Note: Both data and extended_data will always be set by get_buffer(),
1153 * but for planar audio with more channels that can fit in data,
1154 * extended_data must be used by the decoder in order to access all
1158 * decoding: set by AVCodecContext.get_buffer()
1160 uint8_t **extended_data;
1163 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1164 * - encoding: unused
1165 * - decoding: Read by user.
1167 AVRational sample_aspect_ratio;
1170 * width and height of the video frame
1171 * - encoding: unused
1172 * - decoding: Read by user.
1177 * format of the frame, -1 if unknown or unset
1178 * Values correspond to enum PixelFormat for video frames,
1179 * enum AVSampleFormat for audio)
1180 * - encoding: unused
1181 * - decoding: Read by user.
1186 struct AVCodecInternal;
1190 AV_FIELD_PROGRESSIVE,
1191 AV_FIELD_TT, //< Top coded_first, top displayed first
1192 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1193 AV_FIELD_TB, //< Top coded first, bottom displayed first
1194 AV_FIELD_BT, //< Bottom coded first, top displayed first
1198 * main external API structure.
1199 * New fields can be added to the end with minor version bumps.
1200 * Removal, reordering and changes to existing fields require a major
1202 * sizeof(AVCodecContext) must not be used outside libav*.
1204 typedef struct AVCodecContext {
1206 * information on struct for av_log
1207 * - set by avcodec_alloc_context3
1209 const AVClass *av_class;
1211 * the average bitrate
1212 * - encoding: Set by user; unused for constant quantizer encoding.
1213 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1218 * number of bits the bitstream is allowed to diverge from the reference.
1219 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1220 * - encoding: Set by user; unused for constant quantizer encoding.
1221 * - decoding: unused
1223 int bit_rate_tolerance;
1227 * - encoding: Set by user.
1228 * - decoding: Set by user.
1233 * Some codecs need additional format info. It is stored here.
1234 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1235 * specific codec MUST set it correctly otherwise stream copy breaks.
1236 * In general use of this field by muxers is not recommended.
1237 * - encoding: Set by libavcodec.
1238 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1243 * Motion estimation algorithm used for video coding.
1244 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1245 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1246 * - encoding: MUST be set by user.
1247 * - decoding: unused
1252 * some codecs need / can use extradata like Huffman tables.
1253 * mjpeg: Huffman tables
1254 * rv10: additional flags
1255 * mpeg4: global headers (they can be in the bitstream or here)
1256 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1257 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1258 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1259 * - encoding: Set/allocated/freed by libavcodec.
1260 * - decoding: Set/allocated/freed by user.
1266 * This is the fundamental unit of time (in seconds) in terms
1267 * of which frame timestamps are represented. For fixed-fps content,
1268 * timebase should be 1/framerate and timestamp increments should be
1270 * - encoding: MUST be set by user.
1271 * - decoding: Set by libavcodec.
1273 AVRational time_base;
1277 * picture width / height.
1278 * - encoding: MUST be set by user.
1279 * - decoding: Set by libavcodec.
1280 * Note: For compatibility it is possible to set this instead of
1281 * coded_width/height before decoding.
1285 #define FF_ASPECT_EXTENDED 15
1288 * the number of pictures in a group of pictures, or 0 for intra_only
1289 * - encoding: Set by user.
1290 * - decoding: unused
1295 * Pixel format, see PIX_FMT_xxx.
1296 * May be set by the demuxer if known from headers.
1297 * May be overriden by the decoder if it knows better.
1298 * - encoding: Set by user.
1299 * - decoding: Set by user if known, overridden by libavcodec if known
1301 enum PixelFormat pix_fmt;
1304 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1305 * decoder to draw a horizontal band. It improves cache usage. Not
1306 * all codecs can do that. You must check the codec capabilities
1308 * When multithreading is used, it may be called from multiple threads
1309 * at the same time; threads might draw different parts of the same AVFrame,
1310 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1312 * The function is also used by hardware acceleration APIs.
1313 * It is called at least once during frame decoding to pass
1314 * the data needed for hardware render.
1315 * In that mode instead of pixel data, AVFrame points to
1316 * a structure specific to the acceleration API. The application
1317 * reads the structure and can change some fields to indicate progress
1319 * - encoding: unused
1320 * - decoding: Set by user.
1321 * @param height the height of the slice
1322 * @param y the y position of the slice
1323 * @param type 1->top field, 2->bottom field, 3->frame
1324 * @param offset offset into the AVFrame.data from which the slice should be read
1326 void (*draw_horiz_band)(struct AVCodecContext *s,
1327 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1328 int y, int type, int height);
1331 int sample_rate; ///< samples per second
1332 int channels; ///< number of audio channels
1335 * audio sample format
1336 * - encoding: Set by user.
1337 * - decoding: Set by libavcodec.
1339 enum AVSampleFormat sample_fmt; ///< sample format
1341 /* The following data should not be initialized. */
1343 * Samples per packet, initialized when calling 'init'.
1346 int frame_number; ///< audio or video frame number
1349 * Number of frames the decoded output will be delayed relative to
1350 * the encoded input.
1351 * - encoding: Set by libavcodec.
1352 * - decoding: unused
1356 /* - encoding parameters */
1357 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1358 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1362 * - encoding: Set by user.
1363 * - decoding: unused
1369 * - encoding: Set by user.
1370 * - decoding: unused
1375 * maximum quantizer difference between frames
1376 * - encoding: Set by user.
1377 * - decoding: unused
1382 * maximum number of B-frames between non-B-frames
1383 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1384 * - encoding: Set by user.
1385 * - decoding: unused
1390 * qscale factor between IP and B-frames
1391 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1392 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1393 * - encoding: Set by user.
1394 * - decoding: unused
1396 float b_quant_factor;
1398 /** obsolete FIXME remove */
1400 #define FF_RC_STRATEGY_XVID 1
1402 int b_frame_strategy;
1404 struct AVCodec *codec;
1408 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1409 /* do its best to deliver a chunk with size */
1410 /* below rtp_payload_size, the chunk will start */
1411 /* with a start code on some codecs like H.263. */
1412 /* This doesn't take account of any particular */
1413 /* headers inside the transmitted RTP payload. */
1416 /* The RTP callback: This function is called */
1417 /* every time the encoder has a packet to send. */
1418 /* It depends on the encoder if the data starts */
1419 /* with a Start Code (it should). H.263 does. */
1420 /* mb_nb contains the number of macroblocks */
1421 /* encoded in the RTP payload. */
1422 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1424 /* statistics, used for 2-pass encoding */
1435 * number of bits used for the previously encoded frame
1436 * - encoding: Set by libavcodec.
1437 * - decoding: unused
1442 * Private data of the user, can be used to carry app specific stuff.
1443 * - encoding: Set by user.
1444 * - decoding: Set by user.
1448 char codec_name[32];
1449 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1450 enum CodecID codec_id; /* see CODEC_ID_xxx */
1453 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1454 * This is used to work around some encoder bugs.
1455 * A demuxer should set this to what is stored in the field used to identify the codec.
1456 * If there are multiple such fields in a container then the demuxer should choose the one
1457 * which maximizes the information about the used codec.
1458 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1459 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1460 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1462 * - encoding: Set by user, if not then the default based on codec_id will be used.
1463 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1465 unsigned int codec_tag;
1468 * Work around bugs in encoders which sometimes cannot be detected automatically.
1469 * - encoding: Set by user
1470 * - decoding: Set by user
1472 int workaround_bugs;
1473 #define FF_BUG_AUTODETECT 1 ///< autodetection
1474 #define FF_BUG_OLD_MSMPEG4 2
1475 #define FF_BUG_XVID_ILACE 4
1476 #define FF_BUG_UMP4 8
1477 #define FF_BUG_NO_PADDING 16
1478 #define FF_BUG_AMV 32
1479 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1480 #define FF_BUG_QPEL_CHROMA 64
1481 #define FF_BUG_STD_QPEL 128
1482 #define FF_BUG_QPEL_CHROMA2 256
1483 #define FF_BUG_DIRECT_BLOCKSIZE 512
1484 #define FF_BUG_EDGE 1024
1485 #define FF_BUG_HPEL_CHROMA 2048
1486 #define FF_BUG_DC_CLIP 4096
1487 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1488 #define FF_BUG_TRUNCATED 16384
1489 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1492 * luma single coefficient elimination threshold
1493 * - encoding: Set by user.
1494 * - decoding: unused
1496 int luma_elim_threshold;
1499 * chroma single coeff elimination threshold
1500 * - encoding: Set by user.
1501 * - decoding: unused
1503 int chroma_elim_threshold;
1506 * strictly follow the standard (MPEG4, ...).
1507 * - encoding: Set by user.
1508 * - decoding: Set by user.
1509 * Setting this to STRICT or higher means the encoder and decoder will
1510 * generally do stupid things, whereas setting it to unofficial or lower
1511 * will mean the encoder might produce output that is not supported by all
1512 * spec-compliant decoders. Decoders don't differentiate between normal,
1513 * unofficial and experimental (that is, they always try to decode things
1514 * when they can) unless they are explicitly asked to behave stupidly
1515 * (=strictly conform to the specs)
1517 int strict_std_compliance;
1518 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1519 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1520 #define FF_COMPLIANCE_NORMAL 0
1521 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1522 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1525 * qscale offset between IP and B-frames
1526 * - encoding: Set by user.
1527 * - decoding: unused
1529 float b_quant_offset;
1532 * Called at the beginning of each frame to get a buffer for it.
1534 * The function will set AVFrame.data[], AVFrame.linesize[].
1535 * AVFrame.extended_data[] must also be set, but it should be the same as
1536 * AVFrame.data[] except for planar audio with more channels than can fit
1537 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1538 * many data pointers as it can hold.
1540 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1541 * avcodec_default_get_buffer() instead of providing buffers allocated by
1544 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1545 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1546 * but if get_buffer() is overridden then alignment considerations should
1547 * be taken into account.
1549 * @see avcodec_default_get_buffer()
1553 * If pic.reference is set then the frame will be read later by libavcodec.
1554 * avcodec_align_dimensions2() should be used to find the required width and
1555 * height, as they normally need to be rounded up to the next multiple of 16.
1557 * If frame multithreading is used and thread_safe_callbacks is set,
1558 * it may be called from a different thread, but not from more than one at
1559 * once. Does not need to be reentrant.
1561 * @see release_buffer(), reget_buffer()
1562 * @see avcodec_align_dimensions2()
1566 * Decoders request a buffer of a particular size by setting
1567 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1568 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1569 * to a smaller value in the output frame.
1571 * Decoders cannot use the buffer after returning from
1572 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1573 * is assumed to be released immediately upon return.
1575 * As a convenience, av_samples_get_buffer_size() and
1576 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1577 * functions to find the required data size and to fill data pointers and
1578 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1579 * since all planes must be the same size.
1581 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1583 * - encoding: unused
1584 * - decoding: Set by libavcodec, user can override.
1586 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1589 * Called to release buffers which were allocated with get_buffer.
1590 * A released buffer can be reused in get_buffer().
1591 * pic.data[*] must be set to NULL.
1592 * May be called from a different thread if frame multithreading is used,
1593 * but not by more than one thread at once, so does not need to be reentrant.
1594 * - encoding: unused
1595 * - decoding: Set by libavcodec, user can override.
1597 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1600 * Size of the frame reordering buffer in the decoder.
1601 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1602 * - encoding: Set by libavcodec.
1603 * - decoding: Set by libavcodec.
1608 * number of bytes per packet if constant and known or 0
1609 * Used by some WAV based audio codecs.
1613 #if FF_API_PARSE_FRAME
1615 * If true, only parsing is done. The frame data is returned.
1616 * Only MPEG audio decoders support this now.
1617 * - encoding: unused
1618 * - decoding: Set by user
1620 attribute_deprecated int parse_only;
1624 * 0-> h263 quant 1-> mpeg quant
1625 * - encoding: Set by user.
1626 * - decoding: unused
1631 * pass1 encoding statistics output buffer
1632 * - encoding: Set by libavcodec.
1633 * - decoding: unused
1638 * pass2 encoding statistics input buffer
1639 * Concatenated stuff from stats_out of pass1 should be placed here.
1640 * - encoding: Allocated/set/freed by user.
1641 * - decoding: unused
1646 * ratecontrol qmin qmax limiting method
1647 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1648 * - encoding: Set by user.
1649 * - decoding: unused
1657 * ratecontrol override, see RcOverride
1658 * - encoding: Allocated/set/freed by user.
1659 * - decoding: unused
1661 RcOverride *rc_override;
1662 int rc_override_count;
1665 * rate control equation
1666 * - encoding: Set by user
1667 * - decoding: unused
1673 * - encoding: Set by user.
1674 * - decoding: unused
1680 * - encoding: Set by user.
1681 * - decoding: unused
1686 * decoder bitstream buffer size
1687 * - encoding: Set by user.
1688 * - decoding: unused
1691 float rc_buffer_aggressivity;
1694 * qscale factor between P and I-frames
1695 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1696 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1697 * - encoding: Set by user.
1698 * - decoding: unused
1700 float i_quant_factor;
1703 * qscale offset between P and I-frames
1704 * - encoding: Set by user.
1705 * - decoding: unused
1707 float i_quant_offset;
1710 * initial complexity for pass1 ratecontrol
1711 * - encoding: Set by user.
1712 * - decoding: unused
1714 float rc_initial_cplx;
1717 * DCT algorithm, see FF_DCT_* below
1718 * - encoding: Set by user.
1719 * - decoding: unused
1722 #define FF_DCT_AUTO 0
1723 #define FF_DCT_FASTINT 1
1724 #define FF_DCT_INT 2
1725 #define FF_DCT_MMX 3
1726 #define FF_DCT_MLIB 4
1727 #define FF_DCT_ALTIVEC 5
1728 #define FF_DCT_FAAN 6
1731 * luminance masking (0-> disabled)
1732 * - encoding: Set by user.
1733 * - decoding: unused
1738 * temporary complexity masking (0-> disabled)
1739 * - encoding: Set by user.
1740 * - decoding: unused
1742 float temporal_cplx_masking;
1745 * spatial complexity masking (0-> disabled)
1746 * - encoding: Set by user.
1747 * - decoding: unused
1749 float spatial_cplx_masking;
1752 * p block masking (0-> disabled)
1753 * - encoding: Set by user.
1754 * - decoding: unused
1759 * darkness masking (0-> disabled)
1760 * - encoding: Set by user.
1761 * - decoding: unused
1766 * IDCT algorithm, see FF_IDCT_* below.
1767 * - encoding: Set by user.
1768 * - decoding: Set by user.
1771 #define FF_IDCT_AUTO 0
1772 #define FF_IDCT_INT 1
1773 #define FF_IDCT_SIMPLE 2
1774 #define FF_IDCT_SIMPLEMMX 3
1775 #define FF_IDCT_LIBMPEG2MMX 4
1776 #define FF_IDCT_PS2 5
1777 #define FF_IDCT_MLIB 6
1778 #define FF_IDCT_ARM 7
1779 #define FF_IDCT_ALTIVEC 8
1780 #define FF_IDCT_SH4 9
1781 #define FF_IDCT_SIMPLEARM 10
1782 #define FF_IDCT_H264 11
1783 #define FF_IDCT_VP3 12
1784 #define FF_IDCT_IPP 13
1785 #define FF_IDCT_XVIDMMX 14
1786 #define FF_IDCT_CAVS 15
1787 #define FF_IDCT_SIMPLEARMV5TE 16
1788 #define FF_IDCT_SIMPLEARMV6 17
1789 #define FF_IDCT_SIMPLEVIS 18
1790 #define FF_IDCT_WMV2 19
1791 #define FF_IDCT_FAAN 20
1792 #define FF_IDCT_EA 21
1793 #define FF_IDCT_SIMPLENEON 22
1794 #define FF_IDCT_SIMPLEALPHA 23
1795 #define FF_IDCT_BINK 24
1799 * - encoding: Set by libavcodec.
1800 * - decoding: Set by user (or 0).
1804 * slice offsets in the frame in bytes
1805 * - encoding: Set/allocated by libavcodec.
1806 * - decoding: Set/allocated by user (or NULL).
1811 * error concealment flags
1812 * - encoding: unused
1813 * - decoding: Set by user.
1815 int error_concealment;
1816 #define FF_EC_GUESS_MVS 1
1817 #define FF_EC_DEBLOCK 2
1820 * dsp_mask could be add used to disable unwanted CPU features
1821 * CPU features (i.e. MMX, SSE. ...)
1823 * With the FORCE flag you may instead enable given CPU features.
1824 * (Dangerous: Usable in case of misdetection, improper usage however will
1825 * result into program crash.)
1830 * bits per sample/pixel from the demuxer (needed for huffyuv).
1831 * - encoding: Set by libavcodec.
1832 * - decoding: Set by user.
1834 int bits_per_coded_sample;
1837 * prediction method (needed for huffyuv)
1838 * - encoding: Set by user.
1839 * - decoding: unused
1841 int prediction_method;
1842 #define FF_PRED_LEFT 0
1843 #define FF_PRED_PLANE 1
1844 #define FF_PRED_MEDIAN 2
1847 * sample aspect ratio (0 if unknown)
1848 * That is the width of a pixel divided by the height of the pixel.
1849 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1850 * - encoding: Set by user.
1851 * - decoding: Set by libavcodec.
1853 AVRational sample_aspect_ratio;
1856 * the picture in the bitstream
1857 * - encoding: Set by libavcodec.
1858 * - decoding: Set by libavcodec.
1860 AVFrame *coded_frame;
1864 * - encoding: Set by user.
1865 * - decoding: Set by user.
1868 #define FF_DEBUG_PICT_INFO 1
1869 #define FF_DEBUG_RC 2
1870 #define FF_DEBUG_BITSTREAM 4
1871 #define FF_DEBUG_MB_TYPE 8
1872 #define FF_DEBUG_QP 16
1873 #define FF_DEBUG_MV 32
1874 #define FF_DEBUG_DCT_COEFF 0x00000040
1875 #define FF_DEBUG_SKIP 0x00000080
1876 #define FF_DEBUG_STARTCODE 0x00000100
1877 #define FF_DEBUG_PTS 0x00000200
1878 #define FF_DEBUG_ER 0x00000400
1879 #define FF_DEBUG_MMCO 0x00000800
1880 #define FF_DEBUG_BUGS 0x00001000
1881 #define FF_DEBUG_VIS_QP 0x00002000
1882 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1883 #define FF_DEBUG_BUFFERS 0x00008000
1884 #define FF_DEBUG_THREADS 0x00010000
1888 * - encoding: Set by user.
1889 * - decoding: Set by user.
1892 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1893 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1894 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1898 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1899 * - decoding: unused
1901 uint64_t error[AV_NUM_DATA_POINTERS];
1904 * motion estimation comparison function
1905 * - encoding: Set by user.
1906 * - decoding: unused
1910 * subpixel motion estimation comparison function
1911 * - encoding: Set by user.
1912 * - decoding: unused
1916 * macroblock comparison function (not supported yet)
1917 * - encoding: Set by user.
1918 * - decoding: unused
1922 * interlaced DCT comparison function
1923 * - encoding: Set by user.
1924 * - decoding: unused
1927 #define FF_CMP_SAD 0
1928 #define FF_CMP_SSE 1
1929 #define FF_CMP_SATD 2
1930 #define FF_CMP_DCT 3
1931 #define FF_CMP_PSNR 4
1932 #define FF_CMP_BIT 5
1934 #define FF_CMP_ZERO 7
1935 #define FF_CMP_VSAD 8
1936 #define FF_CMP_VSSE 9
1937 #define FF_CMP_NSSE 10
1938 #define FF_CMP_W53 11
1939 #define FF_CMP_W97 12
1940 #define FF_CMP_DCTMAX 13
1941 #define FF_CMP_DCT264 14
1942 #define FF_CMP_CHROMA 256
1945 * ME diamond size & shape
1946 * - encoding: Set by user.
1947 * - decoding: unused
1952 * amount of previous MV predictors (2a+1 x 2a+1 square)
1953 * - encoding: Set by user.
1954 * - decoding: unused
1956 int last_predictor_count;
1959 * prepass for motion estimation
1960 * - encoding: Set by user.
1961 * - decoding: unused
1966 * motion estimation prepass comparison function
1967 * - encoding: Set by user.
1968 * - decoding: unused
1973 * ME prepass diamond size & shape
1974 * - encoding: Set by user.
1975 * - decoding: unused
1981 * - encoding: Set by user.
1982 * - decoding: unused
1984 int me_subpel_quality;
1987 * callback to negotiate the pixelFormat
1988 * @param fmt is the list of formats which are supported by the codec,
1989 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1990 * The first is always the native one.
1991 * @return the chosen format
1992 * - encoding: unused
1993 * - decoding: Set by user, if not set the native format will be chosen.
1995 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1998 * DTG active format information (additional aspect ratio
1999 * information only used in DVB MPEG-2 transport streams)
2002 * - encoding: unused
2003 * - decoding: Set by decoder.
2005 int dtg_active_format;
2006 #define FF_DTG_AFD_SAME 8
2007 #define FF_DTG_AFD_4_3 9
2008 #define FF_DTG_AFD_16_9 10
2009 #define FF_DTG_AFD_14_9 11
2010 #define FF_DTG_AFD_4_3_SP_14_9 13
2011 #define FF_DTG_AFD_16_9_SP_14_9 14
2012 #define FF_DTG_AFD_SP_4_3 15
2015 * maximum motion estimation search range in subpel units
2016 * If 0 then no limit.
2018 * - encoding: Set by user.
2019 * - decoding: unused
2024 * intra quantizer bias
2025 * - encoding: Set by user.
2026 * - decoding: unused
2028 int intra_quant_bias;
2029 #define FF_DEFAULT_QUANT_BIAS 999999
2032 * inter quantizer bias
2033 * - encoding: Set by user.
2034 * - decoding: unused
2036 int inter_quant_bias;
2040 * - encoding: unused
2041 * - decoding: Which clrtable should be used for 8bit RGB images.
2042 * Tables have to be stored somewhere. FIXME
2046 #if FF_API_INTERNAL_CONTEXT
2048 * internal_buffer count
2049 * Don't touch, used by libavcodec default_get_buffer().
2050 * @deprecated this field was moved to an internal context
2052 attribute_deprecated int internal_buffer_count;
2056 * Don't touch, used by libavcodec default_get_buffer().
2057 * @deprecated this field was moved to an internal context
2059 attribute_deprecated void *internal_buffer;
2063 * Global quality for codecs which cannot change it per frame.
2064 * This should be proportional to MPEG-1/2/4 qscale.
2065 * - encoding: Set by user.
2066 * - decoding: unused
2070 #define FF_CODER_TYPE_VLC 0
2071 #define FF_CODER_TYPE_AC 1
2072 #define FF_CODER_TYPE_RAW 2
2073 #define FF_CODER_TYPE_RLE 3
2074 #define FF_CODER_TYPE_DEFLATE 4
2077 * - encoding: Set by user.
2078 * - decoding: unused
2084 * - encoding: Set by user.
2085 * - decoding: unused
2091 * - encoding: unused
2092 * - decoding: Set by user.
2094 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2099 * - encoding: unused
2100 * - decoding: Set by user.
2103 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2104 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2105 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2108 * XVideo Motion Acceleration
2109 * - encoding: forbidden
2110 * - decoding: set by decoder
2112 int xvmc_acceleration;
2115 * macroblock decision mode
2116 * - encoding: Set by user.
2117 * - decoding: unused
2120 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2121 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2122 #define FF_MB_DECISION_RD 2 ///< rate distortion
2125 * custom intra quantization matrix
2126 * - encoding: Set by user, can be NULL.
2127 * - decoding: Set by libavcodec.
2129 uint16_t *intra_matrix;
2132 * custom inter quantization matrix
2133 * - encoding: Set by user, can be NULL.
2134 * - decoding: Set by libavcodec.
2136 uint16_t *inter_matrix;
2139 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2140 * This is used to work around some encoder bugs.
2141 * - encoding: unused
2142 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2144 unsigned int stream_codec_tag;
2147 * scene change detection threshold
2148 * 0 is default, larger means fewer detected scene changes.
2149 * - encoding: Set by user.
2150 * - decoding: unused
2152 int scenechange_threshold;
2155 * minimum Lagrange multipler
2156 * - encoding: Set by user.
2157 * - decoding: unused
2162 * maximum Lagrange multipler
2163 * - encoding: Set by user.
2164 * - decoding: unused
2169 * noise reduction strength
2170 * - encoding: Set by user.
2171 * - decoding: unused
2173 int noise_reduction;
2176 * Called at the beginning of a frame to get cr buffer for it.
2177 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2178 * libavcodec will pass previous buffer in pic, function should return
2179 * same buffer or new buffer with old frame "painted" into it.
2180 * If pic.data[0] == NULL must behave like get_buffer().
2181 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2182 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2184 * - encoding: unused
2185 * - decoding: Set by libavcodec, user can override.
2187 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2190 * Number of bits which should be loaded into the rc buffer before decoding starts.
2191 * - encoding: Set by user.
2192 * - decoding: unused
2194 int rc_initial_buffer_occupancy;
2198 * - encoding: Set by user.
2199 * - decoding: unused
2201 int inter_threshold;
2205 * - encoding: Set by user.
2206 * - decoding: Set by user.
2211 * Simulates errors in the bitstream to test error concealment.
2212 * - encoding: Set by user.
2213 * - decoding: unused
2218 * quantizer noise shaping
2219 * - encoding: Set by user.
2220 * - decoding: unused
2222 int quantizer_noise_shaping;
2226 * is used to decide how many independent tasks should be passed to execute()
2227 * - encoding: Set by user.
2228 * - decoding: Set by user.
2233 * The codec may call this to execute several independent things.
2234 * It will return only after finishing all tasks.
2235 * The user may replace this with some multithreaded implementation,
2236 * the default implementation will execute the parts serially.
2237 * @param count the number of things to execute
2238 * - encoding: Set by libavcodec, user can override.
2239 * - decoding: Set by libavcodec, user can override.
2241 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2245 * Can be used by execute() to store some per AVCodecContext stuff.
2246 * - encoding: set by execute()
2247 * - decoding: set by execute()
2249 void *thread_opaque;
2252 * Motion estimation threshold below which no motion estimation is
2253 * performed, but instead the user specified motion vectors are used.
2255 * - encoding: Set by user.
2256 * - decoding: unused
2261 * Macroblock threshold below which the user specified macroblock types will be used.
2262 * - encoding: Set by user.
2263 * - decoding: unused
2268 * precision of the intra DC coefficient - 8
2269 * - encoding: Set by user.
2270 * - decoding: unused
2272 int intra_dc_precision;
2275 * noise vs. sse weight for the nsse comparsion function
2276 * - encoding: Set by user.
2277 * - decoding: unused
2282 * Number of macroblock rows at the top which are skipped.
2283 * - encoding: unused
2284 * - decoding: Set by user.
2289 * Number of macroblock rows at the bottom which are skipped.
2290 * - encoding: unused
2291 * - decoding: Set by user.
2297 * - encoding: Set by user.
2298 * - decoding: Set by libavcodec.
2301 #define FF_PROFILE_UNKNOWN -99
2302 #define FF_PROFILE_RESERVED -100
2304 #define FF_PROFILE_AAC_MAIN 0
2305 #define FF_PROFILE_AAC_LOW 1
2306 #define FF_PROFILE_AAC_SSR 2
2307 #define FF_PROFILE_AAC_LTP 3
2309 #define FF_PROFILE_DTS 20
2310 #define FF_PROFILE_DTS_ES 30
2311 #define FF_PROFILE_DTS_96_24 40
2312 #define FF_PROFILE_DTS_HD_HRA 50
2313 #define FF_PROFILE_DTS_HD_MA 60
2315 #define FF_PROFILE_MPEG2_422 0
2316 #define FF_PROFILE_MPEG2_HIGH 1
2317 #define FF_PROFILE_MPEG2_SS 2
2318 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2319 #define FF_PROFILE_MPEG2_MAIN 4
2320 #define FF_PROFILE_MPEG2_SIMPLE 5
2322 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2323 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2325 #define FF_PROFILE_H264_BASELINE 66
2326 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2327 #define FF_PROFILE_H264_MAIN 77
2328 #define FF_PROFILE_H264_EXTENDED 88
2329 #define FF_PROFILE_H264_HIGH 100
2330 #define FF_PROFILE_H264_HIGH_10 110
2331 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2332 #define FF_PROFILE_H264_HIGH_422 122
2333 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2334 #define FF_PROFILE_H264_HIGH_444 144
2335 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2336 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2337 #define FF_PROFILE_H264_CAVLC_444 44
2339 #define FF_PROFILE_VC1_SIMPLE 0
2340 #define FF_PROFILE_VC1_MAIN 1
2341 #define FF_PROFILE_VC1_COMPLEX 2
2342 #define FF_PROFILE_VC1_ADVANCED 3
2344 #define FF_PROFILE_MPEG4_SIMPLE 0
2345 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2346 #define FF_PROFILE_MPEG4_CORE 2
2347 #define FF_PROFILE_MPEG4_MAIN 3
2348 #define FF_PROFILE_MPEG4_N_BIT 4
2349 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2350 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2351 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2352 #define FF_PROFILE_MPEG4_HYBRID 8
2353 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2354 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2355 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2356 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2357 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2358 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2359 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2363 * - encoding: Set by user.
2364 * - decoding: Set by libavcodec.
2367 #define FF_LEVEL_UNKNOWN -99
2370 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2371 * - encoding: unused
2372 * - decoding: Set by user.
2377 * Bitstream width / height, may be different from width/height if lowres enabled.
2378 * - encoding: unused
2379 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2381 int coded_width, coded_height;
2384 * frame skip threshold
2385 * - encoding: Set by user.
2386 * - decoding: unused
2388 int frame_skip_threshold;
2392 * - encoding: Set by user.
2393 * - decoding: unused
2395 int frame_skip_factor;
2398 * frame skip exponent
2399 * - encoding: Set by user.
2400 * - decoding: unused
2405 * frame skip comparison function
2406 * - encoding: Set by user.
2407 * - decoding: unused
2412 * Border processing masking, raises the quantizer for mbs on the borders
2414 * - encoding: Set by user.
2415 * - decoding: unused
2417 float border_masking;
2420 * minimum MB lagrange multipler
2421 * - encoding: Set by user.
2422 * - decoding: unused
2427 * maximum MB lagrange multipler
2428 * - encoding: Set by user.
2429 * - decoding: unused
2435 * - encoding: Set by user.
2436 * - decoding: unused
2438 int me_penalty_compensation;
2442 * - encoding: unused
2443 * - decoding: Set by user.
2445 enum AVDiscard skip_loop_filter;
2449 * - encoding: unused
2450 * - decoding: Set by user.
2452 enum AVDiscard skip_idct;
2456 * - encoding: unused
2457 * - decoding: Set by user.
2459 enum AVDiscard skip_frame;
2463 * - encoding: Set by user.
2464 * - decoding: unused
2470 * - encoding: Set by user.
2471 * - decoding: unused
2477 * - encoding: Set by user.
2478 * - decoding: unused
2483 * number of reference frames
2484 * - encoding: Set by user.
2485 * - decoding: Set by lavc.
2490 * chroma qp offset from luma
2491 * - encoding: Set by user.
2492 * - decoding: unused
2497 * trellis RD quantization
2498 * - encoding: Set by user.
2499 * - decoding: unused
2504 * Audio cutoff bandwidth (0 means "automatic")
2505 * - encoding: Set by user.
2506 * - decoding: unused
2511 * Multiplied by qscale for each frame and added to scene_change_score.
2512 * - encoding: Set by user.
2513 * - decoding: unused
2515 int scenechange_factor;
2519 * Note: Value depends upon the compare function used for fullpel ME.
2520 * - encoding: Set by user.
2521 * - decoding: unused
2526 * Adjust sensitivity of b_frame_strategy 1.
2527 * - encoding: Set by user.
2528 * - decoding: unused
2533 * - encoding: Set by user.
2534 * - decoding: unused
2536 int compression_level;
2537 #define FF_COMPRESSION_DEFAULT -1
2540 * - encoding: Set by user.
2541 * - decoding: unused
2543 int min_prediction_order;
2546 * - encoding: Set by user.
2547 * - decoding: unused
2549 int max_prediction_order;
2552 * GOP timecode frame start number, in non drop frame format
2553 * - encoding: Set by user.
2554 * - decoding: unused
2556 int64_t timecode_frame_start;
2558 #if FF_API_REQUEST_CHANNELS
2560 * Decoder should decode to this many channels if it can (0 for default)
2561 * - encoding: unused
2562 * - decoding: Set by user.
2563 * @deprecated Deprecated in favor of request_channel_layout.
2565 int request_channels;
2569 * opaque 64bit number (generally a PTS) that will be reordered and
2570 * output in AVFrame.reordered_opaque
2571 * @deprecated in favor of pkt_pts
2572 * - encoding: unused
2573 * - decoding: Set by user.
2575 int64_t reordered_opaque;
2578 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2579 * - encoding: set by user.
2580 * - decoding: set by libavcodec.
2582 int bits_per_raw_sample;
2585 * Audio channel layout.
2586 * - encoding: set by user.
2587 * - decoding: set by libavcodec.
2589 uint64_t channel_layout;
2592 * Request decoder to use this channel layout if it can (0 for default)
2593 * - encoding: unused
2594 * - decoding: Set by user.
2596 uint64_t request_channel_layout;
2599 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2600 * - encoding: Set by user.
2601 * - decoding: unused.
2603 float rc_max_available_vbv_use;
2606 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2607 * - encoding: Set by user.
2608 * - decoding: unused.
2610 float rc_min_vbv_overflow_use;
2613 * Hardware accelerator in use
2614 * - encoding: unused.
2615 * - decoding: Set by libavcodec
2617 struct AVHWAccel *hwaccel;
2620 * For some codecs, the time base is closer to the field rate than the frame rate.
2621 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2622 * if no telecine is used ...
2624 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2626 int ticks_per_frame;
2629 * Hardware accelerator context.
2630 * For some hardware accelerators, a global context needs to be
2631 * provided by the user. In that case, this holds display-dependent
2632 * data Libav cannot instantiate itself. Please refer to the
2633 * Libav HW accelerator documentation to know how to fill this
2634 * is. e.g. for VA API, this is a struct vaapi_context.
2635 * - encoding: unused
2636 * - decoding: Set by user
2638 void *hwaccel_context;
2641 * Chromaticity coordinates of the source primaries.
2642 * - encoding: Set by user
2643 * - decoding: Set by libavcodec
2645 enum AVColorPrimaries color_primaries;
2648 * Color Transfer Characteristic.
2649 * - encoding: Set by user
2650 * - decoding: Set by libavcodec
2652 enum AVColorTransferCharacteristic color_trc;
2655 * YUV colorspace type.
2656 * - encoding: Set by user
2657 * - decoding: Set by libavcodec
2659 enum AVColorSpace colorspace;
2662 * MPEG vs JPEG YUV range.
2663 * - encoding: Set by user
2664 * - decoding: Set by libavcodec
2666 enum AVColorRange color_range;
2669 * This defines the location of chroma samples.
2670 * - encoding: Set by user
2671 * - decoding: Set by libavcodec
2673 enum AVChromaLocation chroma_sample_location;
2676 * The codec may call this to execute several independent things.
2677 * It will return only after finishing all tasks.
2678 * The user may replace this with some multithreaded implementation,
2679 * the default implementation will execute the parts serially.
2680 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2681 * @param c context passed also to func
2682 * @param count the number of things to execute
2683 * @param arg2 argument passed unchanged to func
2684 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2685 * @param func function that will be called count times, with jobnr from 0 to count-1.
2686 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2687 * two instances of func executing at the same time will have the same threadnr.
2688 * @return always 0 currently, but code should handle a future improvement where when any call to func
2689 * returns < 0 no further calls to func may be done and < 0 is returned.
2690 * - encoding: Set by libavcodec, user can override.
2691 * - decoding: Set by libavcodec, user can override.
2693 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2695 int log_level_offset;
2699 * Indicates number of picture subdivisions. Used for parallelized
2701 * - encoding: Set by user
2702 * - decoding: unused
2707 * Header containing style information for text subtitles.
2708 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2709 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2710 * the Format line following. It shouldn't include any Dialogue line.
2711 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2712 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2714 uint8_t *subtitle_header;
2715 int subtitle_header_size;
2718 * Current packet as passed into the decoder, to avoid having
2719 * to pass the packet into every function. Currently only valid
2720 * inside lavc and get/release_buffer callbacks.
2721 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2722 * - encoding: unused
2726 #if FF_API_INTERNAL_CONTEXT
2728 * Whether this is a copy of the context which had init() called on it.
2729 * This is used by multithreading - shared tables and picture pointers
2730 * should be freed from the original context only.
2731 * - encoding: Set by libavcodec.
2732 * - decoding: Set by libavcodec.
2734 * @deprecated this field has been moved to an internal context
2736 attribute_deprecated int is_copy;
2740 * Which multithreading methods to use.
2741 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2742 * so clients which cannot provide future frames should not use it.
2744 * - encoding: Set by user, otherwise the default is used.
2745 * - decoding: Set by user, otherwise the default is used.
2748 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2749 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2752 * Which multithreading methods are in use by the codec.
2753 * - encoding: Set by libavcodec.
2754 * - decoding: Set by libavcodec.
2756 int active_thread_type;
2759 * Set by the client if its custom get_buffer() callback can be called
2760 * from another thread, which allows faster multithreaded decoding.
2761 * draw_horiz_band() will be called from other threads regardless of this setting.
2762 * Ignored if the default get_buffer() is used.
2763 * - encoding: Set by user.
2764 * - decoding: Set by user.
2766 int thread_safe_callbacks;
2769 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2770 * Used for compliant TS muxing.
2771 * - encoding: Set by libavcodec.
2772 * - decoding: unused.
2777 * Type of service that the audio stream conveys.
2778 * - encoding: Set by user.
2779 * - decoding: Set by libavcodec.
2781 enum AVAudioServiceType audio_service_type;
2784 * Used to request a sample format from the decoder.
2785 * - encoding: unused.
2786 * - decoding: Set by user.
2788 enum AVSampleFormat request_sample_fmt;
2791 * Error recognition; may misdetect some more or less valid parts as errors.
2792 * - encoding: unused
2793 * - decoding: Set by user.
2795 int err_recognition;
2796 #define AV_EF_CRCCHECK (1<<0)
2797 #define AV_EF_BITSTREAM (1<<1)
2798 #define AV_EF_BUFFER (1<<2)
2799 #define AV_EF_EXPLODE (1<<3)
2802 * Private context used for internal data.
2804 * Unlike priv_data, this is not codec-specific. It is used in general
2805 * libavcodec functions.
2807 struct AVCodecInternal *internal;
2810 * - encoding: set by libavcodec
2811 * - decoding: Set by libavcodec
2813 enum AVFieldOrder field_order;
2819 typedef struct AVProfile {
2821 const char *name; ///< short name for the profile
2824 typedef struct AVCodecDefault AVCodecDefault;
2829 typedef struct AVCodec {
2831 * Name of the codec implementation.
2832 * The name is globally unique among encoders and among decoders (but an
2833 * encoder and a decoder can share the same name).
2834 * This is the primary way to find a codec from the user perspective.
2837 enum AVMediaType type;
2840 int (*init)(AVCodecContext *);
2841 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2842 int (*close)(AVCodecContext *);
2843 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2845 * Codec capabilities.
2849 struct AVCodec *next;
2852 * Will be called when seeking
2854 void (*flush)(AVCodecContext *);
2855 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2856 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2858 * Descriptive name for the codec, meant to be more human readable than name.
2859 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2861 const char *long_name;
2862 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2863 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2864 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2865 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2866 const AVClass *priv_class; ///< AVClass for the private context
2867 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2870 * @name Frame-level threading support functions
2874 * If defined, called on thread contexts when they are created.
2875 * If the codec allocates writable tables in init(), re-allocate them here.
2876 * priv_data will be set to a copy of the original.
2878 int (*init_thread_copy)(AVCodecContext *);
2880 * Copy necessary context variables from a previous thread context to the current one.
2881 * If not defined, the next thread will start automatically; otherwise, the codec
2882 * must call ff_thread_finish_setup().
2884 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2886 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2890 * Private codec-specific defaults.
2892 const AVCodecDefault *defaults;
2895 * Initialize codec static data, called from avcodec_register().
2897 void (*init_static_data)(struct AVCodec *codec);
2900 * Encode data to an AVPacket.
2902 * @param avctx codec context
2903 * @param avpkt output AVPacket (may contain a user-provided buffer)
2904 * @param[in] frame AVFrame containing the raw data to be encoded
2905 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2906 * non-empty packet was returned in avpkt.
2907 * @return 0 on success, negative error code on failure
2909 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2910 int *got_packet_ptr);
2916 typedef struct AVHWAccel {
2918 * Name of the hardware accelerated codec.
2919 * The name is globally unique among encoders and among decoders (but an
2920 * encoder and a decoder can share the same name).
2925 * Type of codec implemented by the hardware accelerator.
2927 * See AVMEDIA_TYPE_xxx
2929 enum AVMediaType type;
2932 * Codec implemented by the hardware accelerator.
2939 * Supported pixel format.
2941 * Only hardware accelerated formats are supported here.
2943 enum PixelFormat pix_fmt;
2946 * Hardware accelerated codec capabilities.
2947 * see FF_HWACCEL_CODEC_CAP_*
2951 struct AVHWAccel *next;
2954 * Called at the beginning of each frame or field picture.
2956 * Meaningful frame information (codec specific) is guaranteed to
2957 * be parsed at this point. This function is mandatory.
2959 * Note that buf can be NULL along with buf_size set to 0.
2960 * Otherwise, this means the whole frame is available at this point.
2962 * @param avctx the codec context
2963 * @param buf the frame data buffer base
2964 * @param buf_size the size of the frame in bytes
2965 * @return zero if successful, a negative value otherwise
2967 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2970 * Callback for each slice.
2972 * Meaningful slice information (codec specific) is guaranteed to
2973 * be parsed at this point. This function is mandatory.
2975 * @param avctx the codec context
2976 * @param buf the slice data buffer base
2977 * @param buf_size the size of the slice in bytes
2978 * @return zero if successful, a negative value otherwise
2980 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2983 * Called at the end of each frame or field picture.
2985 * The whole picture is parsed at this point and can now be sent
2986 * to the hardware accelerator. This function is mandatory.
2988 * @param avctx the codec context
2989 * @return zero if successful, a negative value otherwise
2991 int (*end_frame)(AVCodecContext *avctx);
2994 * Size of HW accelerator private data.
2996 * Private data is allocated with av_mallocz() before
2997 * AVCodecContext.get_buffer() and deallocated after
2998 * AVCodecContext.release_buffer().
3004 * four components are given, that's all.
3005 * the last component is alpha
3007 typedef struct AVPicture {
3008 uint8_t *data[AV_NUM_DATA_POINTERS];
3009 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3012 #define AVPALETTE_SIZE 1024
3013 #define AVPALETTE_COUNT 256
3015 enum AVSubtitleType {
3018 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3021 * Plain text, the text field must be set by the decoder and is
3022 * authoritative. ass and pict fields may contain approximations.
3027 * Formatted text, the ass field must be set by the decoder and is
3028 * authoritative. pict and text fields may contain approximations.
3033 typedef struct AVSubtitleRect {
3034 int x; ///< top left corner of pict, undefined when pict is not set
3035 int y; ///< top left corner of pict, undefined when pict is not set
3036 int w; ///< width of pict, undefined when pict is not set
3037 int h; ///< height of pict, undefined when pict is not set
3038 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3041 * data+linesize for the bitmap of this subtitle.
3042 * can be set for text/ass as well once they where rendered
3045 enum AVSubtitleType type;
3047 char *text; ///< 0 terminated plain UTF-8 text
3050 * 0 terminated ASS/SSA compatible event line.
3051 * The pressentation of this is unaffected by the other values in this
3057 typedef struct AVSubtitle {
3058 uint16_t format; /* 0 = graphics */
3059 uint32_t start_display_time; /* relative to packet pts, in ms */
3060 uint32_t end_display_time; /* relative to packet pts, in ms */
3062 AVSubtitleRect **rects;
3063 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3066 /* packet functions */
3069 * @deprecated use NULL instead
3071 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3074 * Default packet destructor.
3076 void av_destruct_packet(AVPacket *pkt);
3079 * Initialize optional fields of a packet with default values.
3083 void av_init_packet(AVPacket *pkt);
3086 * Allocate the payload of a packet and initialize its fields with
3090 * @param size wanted payload size
3091 * @return 0 if OK, AVERROR_xxx otherwise
3093 int av_new_packet(AVPacket *pkt, int size);
3096 * Reduce packet size, correctly zeroing padding
3099 * @param size new size
3101 void av_shrink_packet(AVPacket *pkt, int size);
3104 * Increase packet size, correctly zeroing padding
3107 * @param grow_by number of bytes by which to increase the size of the packet
3109 int av_grow_packet(AVPacket *pkt, int grow_by);
3112 * @warning This is a hack - the packet memory allocation stuff is broken. The
3113 * packet is allocated if it was not really allocated.
3115 int av_dup_packet(AVPacket *pkt);
3120 * @param pkt packet to free
3122 void av_free_packet(AVPacket *pkt);
3125 * Allocate new information of a packet.
3128 * @param type side information type
3129 * @param size side information size
3130 * @return pointer to fresh allocated data or NULL otherwise
3132 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3136 * Get side information from packet.
3139 * @param type desired side information type
3140 * @param size pointer for side information size to store (optional)
3141 * @return pointer to data if present or NULL otherwise
3143 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3148 struct ReSampleContext;
3149 struct AVResampleContext;
3151 typedef struct ReSampleContext ReSampleContext;
3154 * Initialize audio resampling context.
3156 * @param output_channels number of output channels
3157 * @param input_channels number of input channels
3158 * @param output_rate output sample rate
3159 * @param input_rate input sample rate
3160 * @param sample_fmt_out requested output sample format
3161 * @param sample_fmt_in input sample format
3162 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3163 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3164 * @param linear if 1 then the used FIR filter will be linearly interpolated
3165 between the 2 closest, if 0 the closest will be used
3166 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3167 * @return allocated ReSampleContext, NULL if error occurred
3169 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3170 int output_rate, int input_rate,
3171 enum AVSampleFormat sample_fmt_out,
3172 enum AVSampleFormat sample_fmt_in,
3173 int filter_length, int log2_phase_count,
3174 int linear, double cutoff);
3176 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3179 * Free resample context.
3181 * @param s a non-NULL pointer to a resample context previously
3182 * created with av_audio_resample_init()
3184 void audio_resample_close(ReSampleContext *s);
3188 * Initialize an audio resampler.
3189 * Note, if either rate is not an integer then simply scale both rates up so they are.
3190 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3191 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3192 * @param linear If 1 then the used FIR filter will be linearly interpolated
3193 between the 2 closest, if 0 the closest will be used
3194 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3196 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3199 * Resample an array of samples using a previously configured context.
3200 * @param src an array of unconsumed samples
3201 * @param consumed the number of samples of src which have been consumed are returned here
3202 * @param src_size the number of unconsumed samples available
3203 * @param dst_size the amount of space in samples available in dst
3204 * @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.
3205 * @return the number of samples written in dst or -1 if an error occurred
3207 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3211 * Compensate samplerate/timestamp drift. The compensation is done by changing
3212 * the resampler parameters, so no audible clicks or similar distortions occur
3213 * @param compensation_distance distance in output samples over which the compensation should be performed
3214 * @param sample_delta number of output samples which should be output less
3216 * example: av_resample_compensate(c, 10, 500)
3217 * here instead of 510 samples only 500 samples would be output
3219 * note, due to rounding the actual compensation might be slightly different,
3220 * especially if the compensation_distance is large and the in_rate used during init is small
3222 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3223 void av_resample_close(struct AVResampleContext *c);
3226 * Allocate memory for a picture. Call avpicture_free() to free it.
3228 * @see avpicture_fill()
3230 * @param picture the picture to be filled in
3231 * @param pix_fmt the format of the picture
3232 * @param width the width of the picture
3233 * @param height the height of the picture
3234 * @return zero if successful, a negative value if not
3236 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3239 * Free a picture previously allocated by avpicture_alloc().
3240 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3243 * @param picture the AVPicture to be freed
3245 void avpicture_free(AVPicture *picture);
3248 * Fill in the AVPicture fields.
3249 * The fields of the given AVPicture are filled in by using the 'ptr' address
3250 * which points to the image data buffer. Depending on the specified picture
3251 * format, one or multiple image data pointers and line sizes will be set.
3252 * If a planar format is specified, several pointers will be set pointing to
3253 * the different picture planes and the line sizes of the different planes
3254 * will be stored in the lines_sizes array.
3255 * Call with ptr == NULL to get the required size for the ptr buffer.
3257 * To allocate the buffer and fill in the AVPicture fields in one call,
3258 * use avpicture_alloc().
3260 * @param picture AVPicture whose fields are to be filled in
3261 * @param ptr Buffer which will contain or contains the actual image data
3262 * @param pix_fmt The format in which the picture data is stored.
3263 * @param width the width of the image in pixels
3264 * @param height the height of the image in pixels
3265 * @return size of the image data in bytes
3267 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3268 enum PixelFormat pix_fmt, int width, int height);
3271 * Copy pixel data from an AVPicture into a buffer.
3272 * The data is stored compactly, without any gaps for alignment or padding
3273 * which may be applied by avpicture_fill().
3275 * @see avpicture_get_size()
3277 * @param[in] src AVPicture containing image data
3278 * @param[in] pix_fmt The format in which the picture data is stored.
3279 * @param[in] width the width of the image in pixels.
3280 * @param[in] height the height of the image in pixels.
3281 * @param[out] dest A buffer into which picture data will be copied.
3282 * @param[in] dest_size The size of 'dest'.
3283 * @return The number of bytes written to dest, or a negative value (error code) on error.
3285 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3286 unsigned char *dest, int dest_size);
3289 * Calculate the size in bytes that a picture of the given width and height
3290 * would occupy if stored in the given picture format.
3291 * Note that this returns the size of a compact representation as generated
3292 * by avpicture_layout(), which can be smaller than the size required for e.g.
3295 * @param pix_fmt the given picture format
3296 * @param width the width of the image
3297 * @param height the height of the image
3298 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3300 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3301 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3303 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3306 * Return a value representing the fourCC code associated to the
3307 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3310 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3313 * Put a string representing the codec tag codec_tag in buf.
3315 * @param buf_size size in bytes of buf
3316 * @return the length of the string that would have been generated if
3317 * enough space had been available, excluding the trailing null
3319 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3321 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3322 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3323 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3324 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3325 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3326 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3329 * Compute what kind of losses will occur when converting from one specific
3330 * pixel format to another.
3331 * When converting from one pixel format to another, information loss may occur.
3332 * For example, when converting from RGB24 to GRAY, the color information will
3333 * be lost. Similarly, other losses occur when converting from some formats to
3334 * other formats. These losses can involve loss of chroma, but also loss of
3335 * resolution, loss of color depth, loss due to the color space conversion, loss
3336 * of the alpha bits or loss due to color quantization.
3337 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3338 * which will occur when converting from one pixel format to another.
3340 * @param[in] dst_pix_fmt destination pixel format
3341 * @param[in] src_pix_fmt source pixel format
3342 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3343 * @return Combination of flags informing you what kind of losses will occur.
3345 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3349 * Find the best pixel format to convert to given a certain source pixel
3350 * format. When converting from one pixel format to another, information loss
3351 * may occur. For example, when converting from RGB24 to GRAY, the color
3352 * information will be lost. Similarly, other losses occur when converting from
3353 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3354 * the given pixel formats should be used to suffer the least amount of loss.
3355 * The pixel formats from which it chooses one, are determined by the
3356 * pix_fmt_mask parameter.
3359 * src_pix_fmt = PIX_FMT_YUV420P;
3360 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3361 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3364 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3365 * @param[in] src_pix_fmt source pixel format
3366 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3367 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3368 * @return The best pixel format to convert to or -1 if none was found.
3370 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3371 int has_alpha, int *loss_ptr);
3373 #if FF_API_GET_ALPHA_INFO
3374 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3375 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3378 * Tell if an image really has transparent alpha values.
3379 * @return ored mask of FF_ALPHA_xxx constants
3381 attribute_deprecated
3382 int img_get_alpha_info(const AVPicture *src,
3383 enum PixelFormat pix_fmt, int width, int height);
3386 /* deinterlace a picture */
3387 /* deinterlace - if not supported return -1 */
3388 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3389 enum PixelFormat pix_fmt, int width, int height);
3391 /* external high level API */
3394 * If c is NULL, returns the first registered codec,
3395 * if c is non-NULL, returns the next registered codec after c,
3396 * or NULL if c is the last one.
3398 AVCodec *av_codec_next(AVCodec *c);
3401 * Return the LIBAVCODEC_VERSION_INT constant.
3403 unsigned avcodec_version(void);
3406 * Return the libavcodec build-time configuration.
3408 const char *avcodec_configuration(void);
3411 * Return the libavcodec license.
3413 const char *avcodec_license(void);
3416 * Register the codec codec and initialize libavcodec.
3418 * @warning either this function or avcodec_register_all() must be called
3419 * before any other libavcodec functions.
3421 * @see avcodec_register_all()
3423 void avcodec_register(AVCodec *codec);
3426 * Find a registered encoder with a matching codec ID.
3428 * @param id CodecID of the requested encoder
3429 * @return An encoder if one was found, NULL otherwise.
3431 AVCodec *avcodec_find_encoder(enum CodecID id);
3434 * Find a registered encoder with the specified name.
3436 * @param name name of the requested encoder
3437 * @return An encoder if one was found, NULL otherwise.
3439 AVCodec *avcodec_find_encoder_by_name(const char *name);
3442 * Find a registered decoder with a matching codec ID.
3444 * @param id CodecID of the requested decoder
3445 * @return A decoder if one was found, NULL otherwise.
3447 AVCodec *avcodec_find_decoder(enum CodecID id);
3450 * Find a registered decoder with the specified name.
3452 * @param name name of the requested decoder
3453 * @return A decoder if one was found, NULL otherwise.
3455 AVCodec *avcodec_find_decoder_by_name(const char *name);
3456 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3459 * Return a name for the specified profile, if available.
3461 * @param codec the codec that is searched for the given profile
3462 * @param profile the profile value for which a name is requested
3463 * @return A name for the profile if found, NULL otherwise.
3465 const char *av_get_profile_name(const AVCodec *codec, int profile);
3468 * Set the fields of the given AVCodecContext to default values corresponding
3469 * to the given codec (defaults may be codec-dependent).
3471 * Do not call this function if a non-NULL codec has been passed
3472 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3473 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3474 * different codec on this AVCodecContext.
3476 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3479 * Allocate an AVCodecContext and set its fields to default values. The
3480 * resulting struct can be deallocated by simply calling av_free().
3482 * @param codec if non-NULL, allocate private data and initialize defaults
3483 * for the given codec. It is illegal to then call avcodec_open2()
3484 * with a different codec.
3486 * @return An AVCodecContext filled with default values or NULL on failure.
3487 * @see avcodec_get_context_defaults
3489 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3492 * Copy the settings of the source AVCodecContext into the destination
3493 * AVCodecContext. The resulting destination codec context will be
3494 * unopened, i.e. you are required to call avcodec_open2() before you
3495 * can use this AVCodecContext to decode/encode video/audio data.
3497 * @param dest target codec context, should be initialized with
3498 * avcodec_alloc_context3(), but otherwise uninitialized
3499 * @param src source codec context
3500 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3502 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3505 * Set the fields of the given AVFrame to default values.
3507 * @param pic The AVFrame of which the fields should be set to default values.
3509 void avcodec_get_frame_defaults(AVFrame *pic);
3512 * Allocate an AVFrame and set its fields to default values. The resulting
3513 * struct can be deallocated by simply calling av_free().
3515 * @return An AVFrame filled with default values or NULL on failure.
3516 * @see avcodec_get_frame_defaults
3518 AVFrame *avcodec_alloc_frame(void);
3520 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3521 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3522 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3525 * Return the amount of padding in pixels which the get_buffer callback must
3526 * provide around the edge of the image for codecs which do not have the
3527 * CODEC_FLAG_EMU_EDGE flag.
3529 * @return Required padding in pixels.
3531 unsigned avcodec_get_edge_width(void);
3533 * Modify width and height values so that they will result in a memory
3534 * buffer that is acceptable for the codec if you do not use any horizontal
3537 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3538 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3539 * according to avcodec_get_edge_width() before.
3541 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3543 * Modify width and height values so that they will result in a memory
3544 * buffer that is acceptable for the codec if you also ensure that all
3545 * line sizes are a multiple of the respective linesize_align[i].
3547 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3548 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3549 * according to avcodec_get_edge_width() before.
3551 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3552 int linesize_align[AV_NUM_DATA_POINTERS]);
3554 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3556 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3557 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3558 //FIXME func typedef
3561 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3562 * function the context has to be allocated with avcodec_alloc_context3().
3564 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3565 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3566 * retrieving a codec.
3568 * @warning This function is not thread safe!
3571 * avcodec_register_all();
3572 * av_dict_set(&opts, "b", "2.5M", 0);
3573 * codec = avcodec_find_decoder(CODEC_ID_H264);
3577 * context = avcodec_alloc_context3(codec);
3579 * if (avcodec_open2(context, codec, opts) < 0)
3583 * @param avctx The context to initialize.
3584 * @param options A dictionary filled with AVCodecContext and codec-private options.
3585 * On return this object will be filled with options that were not found.
3587 * @return zero on success, a negative value on error
3588 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3589 * av_dict_set(), av_opt_find().
3591 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3593 #if FF_API_OLD_DECODE_AUDIO
3595 * Wrapper function which calls avcodec_decode_audio4.
3597 * @deprecated Use avcodec_decode_audio4 instead.
3599 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3600 * Some decoders may support multiple frames in a single AVPacket, such
3601 * decoders would then just decode the first frame. In this case,
3602 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3603 * the remaining data in order to decode the second frame etc.
3605 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3606 * decompressed frame size in bytes.
3608 * @warning You must set frame_size_ptr to the allocated size of the
3609 * output buffer before calling avcodec_decode_audio3().
3611 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3612 * the actual read bytes because some optimized bitstream readers read 32 or 64
3613 * bits at once and could read over the end.
3615 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3616 * no overreading happens for damaged MPEG streams.
3618 * @warning You must not provide a custom get_buffer() when using
3619 * avcodec_decode_audio3(). Doing so will override it with
3620 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3621 * which does allow the application to provide a custom get_buffer().
3623 * @note You might have to align the input buffer avpkt->data and output buffer
3624 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3625 * necessary at all, on others it won't work at all if not aligned and on others
3626 * it will work but it will have an impact on performance.
3628 * In practice, avpkt->data should have 4 byte alignment at minimum and
3629 * samples should be 16 byte aligned unless the CPU doesn't need it
3630 * (AltiVec and SSE do).
3632 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3633 * between input and output, these need to be fed with avpkt->data=NULL,
3634 * avpkt->size=0 at the end to return the remaining frames.
3636 * @param avctx the codec context
3637 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3638 * If the sample format is planar, each channel plane will
3639 * be the same size, with no padding between channels.
3640 * @param[in,out] frame_size_ptr the output buffer size in bytes
3641 * @param[in] avpkt The input AVPacket containing the input buffer.
3642 * You can create such packet with av_init_packet() and by then setting
3643 * data and size, some decoders might in addition need other fields.
3644 * All decoders are designed to use the least fields possible though.
3645 * @return On error a negative value is returned, otherwise the number of bytes
3646 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3648 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3649 int *frame_size_ptr,
3654 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3656 * Some decoders may support multiple frames in a single AVPacket. Such
3657 * decoders would then just decode the first frame. In this case,
3658 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3659 * the remaining data in order to decode the second frame, etc...
3660 * Even if no frames are returned, the packet needs to be fed to the decoder
3661 * with remaining data until it is completely consumed or an error occurs.
3663 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3664 * larger than the actual read bytes because some optimized bitstream
3665 * readers read 32 or 64 bits at once and could read over the end.
3667 * @note You might have to align the input buffer. The alignment requirements
3668 * depend on the CPU and the decoder.
3670 * @param avctx the codec context
3671 * @param[out] frame The AVFrame in which to store decoded audio samples.
3672 * Decoders request a buffer of a particular size by setting
3673 * AVFrame.nb_samples prior to calling get_buffer(). The
3674 * decoder may, however, only utilize part of the buffer by
3675 * setting AVFrame.nb_samples to a smaller value in the
3677 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3679 * @param[in] avpkt The input AVPacket containing the input buffer.
3680 * At least avpkt->data and avpkt->size should be set. Some
3681 * decoders might also require additional fields to be set.
3682 * @return A negative error code is returned if an error occurred during
3683 * decoding, otherwise the number of bytes consumed from the input
3684 * AVPacket is returned.
3686 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3687 int *got_frame_ptr, AVPacket *avpkt);
3690 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3691 * Some decoders may support multiple frames in a single AVPacket, such
3692 * decoders would then just decode the first frame.
3694 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3695 * the actual read bytes because some optimized bitstream readers read 32 or 64
3696 * bits at once and could read over the end.
3698 * @warning The end of the input buffer buf should be set to 0 to ensure that
3699 * no overreading happens for damaged MPEG streams.
3701 * @note You might have to align the input buffer avpkt->data.
3702 * The alignment requirements depend on the CPU: on some CPUs it isn't
3703 * necessary at all, on others it won't work at all if not aligned and on others
3704 * it will work but it will have an impact on performance.
3706 * In practice, avpkt->data should have 4 byte alignment at minimum.
3708 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3709 * between input and output, these need to be fed with avpkt->data=NULL,
3710 * avpkt->size=0 at the end to return the remaining frames.
3712 * @param avctx the codec context
3713 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3714 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3715 * allocate memory for the actual bitmap.
3716 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3717 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3718 * decodes and the decoder tells the user once it does not need the data anymore,
3719 * the user app can at this point free/reuse/keep the memory as it sees fit.
3721 * @param[in] avpkt The input AVpacket containing the input buffer.
3722 * You can create such packet with av_init_packet() and by then setting
3723 * data and size, some decoders might in addition need other fields like
3724 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3726 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3727 * @return On error a negative value is returned, otherwise the number of bytes
3728 * used or zero if no frame could be decompressed.
3730 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3731 int *got_picture_ptr,
3735 * Decode a subtitle message.
3736 * Return a negative value on error, otherwise return the number of bytes used.
3737 * If no subtitle could be decompressed, got_sub_ptr is zero.
3738 * Otherwise, the subtitle is stored in *sub.
3739 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3740 * simplicity, because the performance difference is expect to be negligible
3741 * and reusing a get_buffer written for video codecs would probably perform badly
3742 * due to a potentially very different allocation pattern.
3744 * @param avctx the codec context
3745 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3746 freed with avsubtitle_free if *got_sub_ptr is set.
3747 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3748 * @param[in] avpkt The input AVPacket containing the input buffer.
3750 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3755 * Free all allocated data in the given subtitle struct.
3757 * @param sub AVSubtitle to free.
3759 void avsubtitle_free(AVSubtitle *sub);
3761 #if FF_API_OLD_ENCODE_AUDIO
3763 * Encode an audio frame from samples into buf.
3765 * @deprecated Use avcodec_encode_audio2 instead.
3767 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3768 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3769 * will know how much space is needed because it depends on the value passed
3770 * in buf_size as described below. In that case a lower value can be used.
3772 * @param avctx the codec context
3773 * @param[out] buf the output buffer
3774 * @param[in] buf_size the output buffer size
3775 * @param[in] samples the input buffer containing the samples
3776 * The number of samples read from this buffer is frame_size*channels,
3777 * both of which are defined in avctx.
3778 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3779 * samples read from samples is equal to:
3780 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3781 * This also implies that av_get_bits_per_sample() must not return 0 for these
3783 * @return On error a negative value is returned, on success zero or the number
3784 * of bytes used to encode the data read from the input buffer.
3786 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3787 uint8_t *buf, int buf_size,
3788 const short *samples);
3792 * Encode a frame of audio.
3794 * Takes input samples from frame and writes the next output packet, if
3795 * available, to avpkt. The output packet does not necessarily contain data for
3796 * the most recent frame, as encoders can delay, split, and combine input frames
3797 * internally as needed.
3799 * @param avctx codec context
3800 * @param avpkt output AVPacket.
3801 * The user can supply an output buffer by setting
3802 * avpkt->data and avpkt->size prior to calling the
3803 * function, but if the size of the user-provided data is not
3804 * large enough, encoding will fail. All other AVPacket fields
3805 * will be reset by the encoder using av_init_packet(). If
3806 * avpkt->data is NULL, the encoder will allocate it.
3807 * The encoder will set avpkt->size to the size of the
3809 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3810 * May be NULL when flushing an encoder that has the
3811 * CODEC_CAP_DELAY capability set.
3812 * There are 2 codec capabilities that affect the allowed
3813 * values of frame->nb_samples.
3814 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
3815 * frame may be smaller than avctx->frame_size, and all other
3816 * frames must be equal to avctx->frame_size.
3817 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3818 * can have any number of samples.
3819 * If neither is set, frame->nb_samples must be equal to
3820 * avctx->frame_size for all frames.
3821 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3822 * output packet is non-empty, and to 0 if it is
3823 * empty. If the function returns an error, the
3824 * packet can be assumed to be invalid, and the
3825 * value of got_packet_ptr is undefined and should
3827 * @return 0 on success, negative error code on failure
3829 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3830 const AVFrame *frame, int *got_packet_ptr);
3833 * Fill audio frame data and linesize.
3834 * AVFrame extended_data channel pointers are allocated if necessary for
3837 * @param frame the AVFrame
3838 * frame->nb_samples must be set prior to calling the
3839 * function. This function fills in frame->data,
3840 * frame->extended_data, frame->linesize[0].
3841 * @param nb_channels channel count
3842 * @param sample_fmt sample format
3843 * @param buf buffer to use for frame data
3844 * @param buf_size size of buffer
3845 * @param align plane size sample alignment
3846 * @return 0 on success, negative error code on failure
3848 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
3849 enum AVSampleFormat sample_fmt, const uint8_t *buf,
3850 int buf_size, int align);
3853 * Encode a video frame from pict into buf.
3854 * The input picture should be
3855 * stored using a specific format, namely avctx.pix_fmt.
3857 * @param avctx the codec context
3858 * @param[out] buf the output buffer for the bitstream of encoded frame
3859 * @param[in] buf_size the size of the output buffer in bytes
3860 * @param[in] pict the input picture to encode
3861 * @return On error a negative value is returned, on success zero or the number
3862 * of bytes used from the output buffer.
3864 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3865 const AVFrame *pict);
3866 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3867 const AVSubtitle *sub);
3869 int avcodec_close(AVCodecContext *avctx);
3872 * Register all the codecs, parsers and bitstream filters which were enabled at
3873 * configuration time. If you do not call this function you can select exactly
3874 * which formats you want to support, by using the individual registration
3877 * @see avcodec_register
3878 * @see av_register_codec_parser
3879 * @see av_register_bitstream_filter
3881 void avcodec_register_all(void);
3884 * Flush buffers, should be called when seeking or when switching to a different stream.
3886 void avcodec_flush_buffers(AVCodecContext *avctx);
3888 void avcodec_default_free_buffers(AVCodecContext *s);
3890 /* misc useful functions */
3893 * Return codec bits per sample.
3895 * @param[in] codec_id the codec
3896 * @return Number of bits per sample or zero if unknown for the given codec.
3898 int av_get_bits_per_sample(enum CodecID codec_id);
3901 typedef struct AVCodecParserContext {
3903 struct AVCodecParser *parser;
3904 int64_t frame_offset; /* offset of the current frame */
3905 int64_t cur_offset; /* current offset
3906 (incremented by each av_parser_parse()) */
3907 int64_t next_frame_offset; /* offset of the next frame */
3909 int pict_type; /* XXX: Put it back in AVCodecContext. */
3911 * This field is used for proper frame duration computation in lavf.
3912 * It signals, how much longer the frame duration of the current frame
3913 * is compared to normal frame duration.
3915 * frame_duration = (1 + repeat_pict) * time_base
3917 * It is used by codecs like H.264 to display telecined material.
3919 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3920 int64_t pts; /* pts of the current frame */
3921 int64_t dts; /* dts of the current frame */
3926 int fetch_timestamp;
3928 #define AV_PARSER_PTS_NB 4
3929 int cur_frame_start_index;
3930 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3931 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3932 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3935 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3936 #define PARSER_FLAG_ONCE 0x0002
3937 /// Set if the parser has a valid file offset
3938 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3940 int64_t offset; ///< byte offset from starting packet start
3941 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3944 * Set by parser to 1 for key frames and 0 for non-key frames.
3945 * It is initialized to -1, so if the parser doesn't set this flag,
3946 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3952 * Time difference in stream time base units from the pts of this
3953 * packet to the point at which the output from the decoder has converged
3954 * independent from the availability of previous frames. That is, the
3955 * frames are virtually identical no matter if decoding started from
3956 * the very first frame or from this keyframe.
3957 * Is AV_NOPTS_VALUE if unknown.
3958 * This field is not the display duration of the current frame.
3959 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3962 * The purpose of this field is to allow seeking in streams that have no
3963 * keyframes in the conventional sense. It corresponds to the
3964 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3965 * essential for some types of subtitle streams to ensure that all
3966 * subtitles are correctly displayed after seeking.
3968 int64_t convergence_duration;
3970 // Timestamp generation support:
3972 * Synchronization point for start of timestamp generation.
3974 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3977 * For example, this corresponds to presence of H.264 buffering period
3983 * Offset of the current timestamp against last timestamp sync point in
3984 * units of AVCodecContext.time_base.
3986 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3987 * contain a valid timestamp offset.
3989 * Note that the timestamp of sync point has usually a nonzero
3990 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3991 * the next frame after timestamp sync point will be usually 1.
3993 * For example, this corresponds to H.264 cpb_removal_delay.
3995 int dts_ref_dts_delta;
3998 * Presentation delay of current frame in units of AVCodecContext.time_base.
4000 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4001 * contain valid non-negative timestamp delta (presentation time of a frame
4002 * must not lie in the past).
4004 * This delay represents the difference between decoding and presentation
4005 * time of the frame.
4007 * For example, this corresponds to H.264 dpb_output_delay.
4012 * Position of the packet in file.
4014 * Analogous to cur_frame_pts/dts
4016 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4019 * Byte position of currently parsed frame in stream.
4024 * Previous frame byte position.
4027 } AVCodecParserContext;
4029 typedef struct AVCodecParser {
4030 int codec_ids[5]; /* several codec IDs are permitted */
4032 int (*parser_init)(AVCodecParserContext *s);
4033 int (*parser_parse)(AVCodecParserContext *s,
4034 AVCodecContext *avctx,
4035 const uint8_t **poutbuf, int *poutbuf_size,
4036 const uint8_t *buf, int buf_size);
4037 void (*parser_close)(AVCodecParserContext *s);
4038 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4039 struct AVCodecParser *next;
4042 AVCodecParser *av_parser_next(AVCodecParser *c);
4044 void av_register_codec_parser(AVCodecParser *parser);
4045 AVCodecParserContext *av_parser_init(int codec_id);
4050 * @param s parser context.
4051 * @param avctx codec context.
4052 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4053 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4054 * @param buf input buffer.
4055 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4056 * @param pts input presentation timestamp.
4057 * @param dts input decoding timestamp.
4058 * @param pos input byte position in stream.
4059 * @return the number of bytes of the input bitstream used.
4064 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4071 * decode_frame(data, size);
4075 int av_parser_parse2(AVCodecParserContext *s,
4076 AVCodecContext *avctx,
4077 uint8_t **poutbuf, int *poutbuf_size,
4078 const uint8_t *buf, int buf_size,
4079 int64_t pts, int64_t dts,
4082 int av_parser_change(AVCodecParserContext *s,
4083 AVCodecContext *avctx,
4084 uint8_t **poutbuf, int *poutbuf_size,
4085 const uint8_t *buf, int buf_size, int keyframe);
4086 void av_parser_close(AVCodecParserContext *s);
4089 typedef struct AVBitStreamFilterContext {
4091 struct AVBitStreamFilter *filter;
4092 AVCodecParserContext *parser;
4093 struct AVBitStreamFilterContext *next;
4094 } AVBitStreamFilterContext;
4097 typedef struct AVBitStreamFilter {
4100 int (*filter)(AVBitStreamFilterContext *bsfc,
4101 AVCodecContext *avctx, const char *args,
4102 uint8_t **poutbuf, int *poutbuf_size,
4103 const uint8_t *buf, int buf_size, int keyframe);
4104 void (*close)(AVBitStreamFilterContext *bsfc);
4105 struct AVBitStreamFilter *next;
4106 } AVBitStreamFilter;
4108 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4109 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4110 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4111 AVCodecContext *avctx, const char *args,
4112 uint8_t **poutbuf, int *poutbuf_size,
4113 const uint8_t *buf, int buf_size, int keyframe);
4114 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4116 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4121 * Reallocate the given block if it is not large enough, otherwise do nothing.
4125 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4128 * Allocate a buffer, reusing the given one if large enough.
4130 * Contrary to av_fast_realloc the current buffer contents might not be
4131 * preserved and on error the old buffer is freed, thus no special
4132 * handling to avoid memleaks is necessary.
4134 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4135 * @param size size of the buffer *ptr points to
4136 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4137 * *size 0 if an error occurred.
4139 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4142 * Copy image src to dst. Wraps av_picture_data_copy() above.
4144 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4145 enum PixelFormat pix_fmt, int width, int height);
4148 * Crop image top and left side.
4150 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4151 enum PixelFormat pix_fmt, int top_band, int left_band);
4156 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4157 int padtop, int padbottom, int padleft, int padright, int *color);
4160 * Encode extradata length to a buffer. Used by xiph codecs.
4162 * @param s buffer to write to; must be at least (v/255+1) bytes long
4163 * @param v size of extradata in bytes
4164 * @return number of bytes written to the buffer.
4166 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4169 * Log a generic warning message about a missing feature. This function is
4170 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4171 * only, and would normally not be used by applications.
4172 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4173 * a pointer to an AVClass struct
4174 * @param[in] feature string containing the name of the missing feature
4175 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4176 * If want_sample is non-zero, additional verbage will be added to the log
4177 * message which tells the user how to report samples to the development
4180 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4183 * Log a generic warning message asking for a sample. This function is
4184 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4185 * only, and would normally not be used by applications.
4186 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4187 * a pointer to an AVClass struct
4188 * @param[in] msg string containing an optional message, or NULL if no message
4190 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4193 * Register the hardware accelerator hwaccel.
4195 void av_register_hwaccel(AVHWAccel *hwaccel);
4198 * If hwaccel is NULL, returns the first registered hardware accelerator,
4199 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4200 * after hwaccel, or NULL if hwaccel is the last one.
4202 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4206 * Lock operation used by lockmgr
4209 AV_LOCK_CREATE, ///< Create a mutex
4210 AV_LOCK_OBTAIN, ///< Lock the mutex
4211 AV_LOCK_RELEASE, ///< Unlock the mutex
4212 AV_LOCK_DESTROY, ///< Free mutex resources
4216 * Register a user provided lock manager supporting the operations
4217 * specified by AVLockOp. mutex points to a (void *) where the
4218 * lockmgr should store/get a pointer to a user allocated mutex. It's
4219 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4221 * @param cb User defined callback. Note: Libav may invoke calls to this
4222 * callback during the call to av_lockmgr_register().
4223 * Thus, the application must be prepared to handle that.
4224 * If cb is set to NULL the lockmgr will be unregistered.
4225 * Also note that during unregistration the previously registered
4226 * lockmgr callback may also be invoked.
4228 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4231 * Get the type of the given codec.
4233 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4236 * Get the AVClass for AVCodecContext. It can be used in combination with
4237 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4239 * @see av_opt_find().
4241 const AVClass *avcodec_get_class(void);
4243 #endif /* AVCODEC_AVCODEC_H */