2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * Libav is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
40 * @defgroup libavc Encoding/Decoding Library
43 * @defgroup lavc_decoding Decoding
47 * @defgroup lavc_encoding Encoding
51 * @defgroup lavc_codec Codecs
53 * @defgroup lavc_codec_native Native Codecs
56 * @defgroup lavc_codec_wrappers External library wrappers
59 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
63 * @defgroup lavc_internal Internal
72 * Identify the syntax and semantics of the bitstream.
73 * The principle is roughly:
74 * Two decoders with the same ID can decode the same streams.
75 * Two encoders with the same ID can encode compatible streams.
76 * There may be slight deviations from the principle due to implementation
79 * If you add a codec ID to this list, add it so that
80 * 1. no value of a existing codec ID changes (that would break ABI),
81 * 2. it is as close as possible to similar codecs.
88 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
89 CODEC_ID_MPEG2VIDEO_XVMC,
126 CODEC_ID_INTERPLAY_VIDEO,
138 CODEC_ID_TRUEMOTION1,
165 CODEC_ID_TRUEMOTION2,
182 CODEC_ID_DSICINVIDEO,
183 CODEC_ID_TIERTEXSEQVIDEO,
191 CODEC_ID_BETHSOFTVID,
207 CODEC_ID_MOTIONPIXELS,
225 CODEC_ID_IFF_BYTERUN1,
249 /* various PCM "codecs" */
250 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
251 CODEC_ID_PCM_S16LE = 0x10000,
267 CODEC_ID_PCM_S24DAUD,
269 CODEC_ID_PCM_S16LE_PLANAR,
278 CODEC_ID_PCM_S8_PLANAR,
280 /* various ADPCM codecs */
281 CODEC_ID_ADPCM_IMA_QT = 0x11000,
282 CODEC_ID_ADPCM_IMA_WAV,
283 CODEC_ID_ADPCM_IMA_DK3,
284 CODEC_ID_ADPCM_IMA_DK4,
285 CODEC_ID_ADPCM_IMA_WS,
286 CODEC_ID_ADPCM_IMA_SMJPEG,
295 CODEC_ID_ADPCM_YAMAHA,
296 CODEC_ID_ADPCM_SBPRO_4,
297 CODEC_ID_ADPCM_SBPRO_3,
298 CODEC_ID_ADPCM_SBPRO_2,
300 CODEC_ID_ADPCM_IMA_AMV,
301 CODEC_ID_ADPCM_EA_R1,
302 CODEC_ID_ADPCM_EA_R3,
303 CODEC_ID_ADPCM_EA_R2,
304 CODEC_ID_ADPCM_IMA_EA_SEAD,
305 CODEC_ID_ADPCM_IMA_EA_EACS,
306 CODEC_ID_ADPCM_EA_XAS,
307 CODEC_ID_ADPCM_EA_MAXIS_XA,
308 CODEC_ID_ADPCM_IMA_ISS,
310 CODEC_ID_ADPCM_IMA_APC,
313 CODEC_ID_AMR_NB = 0x12000,
316 /* RealAudio codecs*/
317 CODEC_ID_RA_144 = 0x13000,
320 /* various DPCM codecs */
321 CODEC_ID_ROQ_DPCM = 0x14000,
322 CODEC_ID_INTERPLAY_DPCM,
327 CODEC_ID_MP2 = 0x15000,
328 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
344 CODEC_ID_WESTWOOD_SND1,
345 CODEC_ID_GSM, ///< as in Berlin toast format
353 CODEC_ID_DSICINAUDIO,
357 CODEC_ID_GSM_MS, /* as found in WAV */
366 CODEC_ID_WMALOSSLESS,
375 CODEC_ID_BINKAUDIO_RDFT,
376 CODEC_ID_BINKAUDIO_DCT,
386 /* subtitle codecs */
387 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
388 CODEC_ID_DVD_SUBTITLE = 0x17000,
389 CODEC_ID_DVB_SUBTITLE,
390 CODEC_ID_TEXT, ///< raw UTF-8 text
394 CODEC_ID_HDMV_PGS_SUBTITLE,
395 CODEC_ID_DVB_TELETEXT,
398 /* other specific kind of codecs (generally used for attachments) */
399 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
400 CODEC_ID_TTF = 0x18000,
402 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
404 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
405 * stream (only used by libavformat) */
406 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
407 * stream (only used by libavformat) */
408 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
411 #if FF_API_OLD_DECODE_AUDIO
413 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
417 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
418 * This is mainly needed because some optimized bitstream readers read
419 * 32 or 64 bit at once and could read over the end.<br>
420 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
421 * MPEG bitstreams could cause overread and segfault.
423 #define FF_INPUT_BUFFER_PADDING_SIZE 8
426 * minimum encoding buffer size
427 * Used to avoid some checks during header writing.
429 #define FF_MIN_BUFFER_SIZE 16384
433 * motion estimation type.
436 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
440 ME_EPZS, ///< enhanced predictive zonal search
441 ME_X1, ///< reserved for experiments
442 ME_HEX, ///< hexagon based search
443 ME_UMH, ///< uneven multi-hexagon search
444 ME_ITER, ///< iterative search
445 ME_TESA, ///< transformed exhaustive search algorithm
449 /* We leave some space between them for extensions (drop some
450 * keyframes for intra-only or drop just some bidir frames). */
451 AVDISCARD_NONE =-16, ///< discard nothing
452 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
453 AVDISCARD_NONREF = 8, ///< discard all non reference
454 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
455 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
456 AVDISCARD_ALL = 48, ///< discard all
459 enum AVColorPrimaries{
460 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
461 AVCOL_PRI_UNSPECIFIED=2,
463 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
464 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
465 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
467 AVCOL_PRI_NB , ///< Not part of ABI
470 enum AVColorTransferCharacteristic{
471 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
472 AVCOL_TRC_UNSPECIFIED=2,
473 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
474 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
475 AVCOL_TRC_NB , ///< Not part of ABI
480 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
481 AVCOL_SPC_UNSPECIFIED=2,
483 AVCOL_SPC_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
484 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
485 AVCOL_SPC_SMPTE240M =7,
486 AVCOL_SPC_NB , ///< Not part of ABI
490 AVCOL_RANGE_UNSPECIFIED=0,
491 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
492 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
493 AVCOL_RANGE_NB , ///< Not part of ABI
497 * X X 3 4 X X are luma samples,
498 * 1 2 1-6 are possible chroma positions
499 * X X 5 6 X 0 is undefined/unknown position
501 enum AVChromaLocation{
502 AVCHROMA_LOC_UNSPECIFIED=0,
503 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
504 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
505 AVCHROMA_LOC_TOPLEFT =3, ///< DV
507 AVCHROMA_LOC_BOTTOMLEFT =5,
508 AVCHROMA_LOC_BOTTOM =6,
509 AVCHROMA_LOC_NB , ///< Not part of ABI
512 enum AVAudioServiceType {
513 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
514 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
515 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
516 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
517 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
518 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
519 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
520 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
521 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
522 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
525 typedef struct RcOverride{
528 int qscale; // If this is 0 then quality_factor will be used instead.
529 float quality_factor;
532 #define FF_MAX_B_FRAMES 16
535 These flags can be passed in AVCodecContext.flags before initialization.
536 Note: Not everything is supported yet.
539 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
540 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
541 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
542 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
543 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
545 * The parent program guarantees that the input for B-frames containing
546 * streams is not written to for at least s->max_b_frames+1 frames, if
547 * this is not set the input will be copied.
549 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
550 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
551 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
552 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
553 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
554 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
555 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
556 location instead of only at frame boundaries. */
557 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
558 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
559 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
560 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
561 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
562 /* Fx : Flag for h263+ extra options */
563 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
564 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
565 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
566 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
567 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
568 #define CODEC_FLAG_CLOSED_GOP 0x80000000
569 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
570 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
571 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
572 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
573 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
574 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
576 /* Unsupported options :
577 * Syntax Arithmetic coding (SAC)
578 * Reference Picture Selection
579 * Independent Segment Decoding */
581 /* codec capabilities */
583 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
585 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
586 * If not set, it might not use get_buffer() at all or use operations that
587 * assume the buffer was allocated by avcodec_default_get_buffer.
589 #define CODEC_CAP_DR1 0x0002
590 #define CODEC_CAP_TRUNCATED 0x0008
591 /* Codec can export data for HW decoding (XvMC). */
592 #define CODEC_CAP_HWACCEL 0x0010
594 * Encoder or decoder requires flushing with NULL input at the end in order to
595 * give the complete and correct output.
597 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
598 * with NULL data. The user can still send NULL data to the public encode
599 * or decode function, but libavcodec will not pass it along to the codec
600 * unless this flag is set.
603 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
604 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
608 * The encoder needs to be fed with NULL data at the end of encoding until the
609 * encoder no longer returns data.
611 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
612 * flag also means that the encoder must set the pts and duration for
613 * each output packet. If this flag is not set, the pts and duration will
614 * be determined by libavcodec from the input frame.
616 #define CODEC_CAP_DELAY 0x0020
618 * Codec can be fed a final frame with a smaller size.
619 * This can be used to prevent truncation of the last audio samples.
621 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
623 * Codec can export data for HW decoding (VDPAU).
625 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
627 * Codec can output multiple frames per AVPacket
628 * Normally demuxers return one frame at a time, demuxers which do not do
629 * are connected to a parser to split what they return into proper frames.
630 * This flag is reserved to the very rare category of codecs which have a
631 * bitstream that cannot be split into frames without timeconsuming
632 * operations like full decoding. Demuxers carring such bitstreams thus
633 * may return multiple frames in a packet. This has many disadvantages like
634 * prohibiting stream copy in many cases thus it should only be considered
637 #define CODEC_CAP_SUBFRAMES 0x0100
639 * Codec is experimental and is thus avoided in favor of non experimental
642 #define CODEC_CAP_EXPERIMENTAL 0x0200
644 * Codec should fill in channel configuration and samplerate instead of container
646 #define CODEC_CAP_CHANNEL_CONF 0x0400
648 * Codec is able to deal with negative linesizes
650 #define CODEC_CAP_NEG_LINESIZES 0x0800
652 * Codec supports frame-level multithreading.
654 #define CODEC_CAP_FRAME_THREADS 0x1000
656 * Codec supports slice-based (or partition-based) multithreading.
658 #define CODEC_CAP_SLICE_THREADS 0x2000
660 * Codec supports changed parameters at any point.
662 #define CODEC_CAP_PARAM_CHANGE 0x4000
664 * Codec supports avctx->thread_count == 0 (auto).
666 #define CODEC_CAP_AUTO_THREADS 0x8000
668 * Audio encoder supports receiving a different number of samples in each call.
670 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
672 //The following defines may change, don't expect compatibility if you use them.
673 #define MB_TYPE_INTRA4x4 0x0001
674 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
675 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
676 #define MB_TYPE_16x16 0x0008
677 #define MB_TYPE_16x8 0x0010
678 #define MB_TYPE_8x16 0x0020
679 #define MB_TYPE_8x8 0x0040
680 #define MB_TYPE_INTERLACED 0x0080
681 #define MB_TYPE_DIRECT2 0x0100 //FIXME
682 #define MB_TYPE_ACPRED 0x0200
683 #define MB_TYPE_GMC 0x0400
684 #define MB_TYPE_SKIP 0x0800
685 #define MB_TYPE_P0L0 0x1000
686 #define MB_TYPE_P1L0 0x2000
687 #define MB_TYPE_P0L1 0x4000
688 #define MB_TYPE_P1L1 0x8000
689 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
690 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
691 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
692 #define MB_TYPE_QUANT 0x00010000
693 #define MB_TYPE_CBP 0x00020000
694 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
698 * This specifies the area which should be displayed.
699 * Note there may be multiple such areas for one frame.
701 typedef struct AVPanScan{
704 * - encoding: Set by user.
705 * - decoding: Set by libavcodec.
710 * width and height in 1/16 pel
711 * - encoding: Set by user.
712 * - decoding: Set by libavcodec.
718 * position of the top left corner in 1/16 pel for up to 3 fields/frames
719 * - encoding: Set by user.
720 * - decoding: Set by libavcodec.
722 int16_t position[3][2];
725 #define FF_QSCALE_TYPE_MPEG1 0
726 #define FF_QSCALE_TYPE_MPEG2 1
727 #define FF_QSCALE_TYPE_H264 2
728 #define FF_QSCALE_TYPE_VP56 3
730 #define FF_BUFFER_TYPE_INTERNAL 1
731 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
732 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
733 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
735 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
736 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
737 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
738 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
740 enum AVPacketSideDataType {
742 AV_PKT_DATA_NEW_EXTRADATA,
743 AV_PKT_DATA_PARAM_CHANGE,
746 typedef struct AVPacket {
748 * Presentation timestamp in AVStream->time_base units; the time at which
749 * the decompressed packet will be presented to the user.
750 * Can be AV_NOPTS_VALUE if it is not stored in the file.
751 * pts MUST be larger or equal to dts as presentation cannot happen before
752 * decompression, unless one wants to view hex dumps. Some formats misuse
753 * the terms dts and pts/cts to mean something different. Such timestamps
754 * must be converted to true pts/dts before they are stored in AVPacket.
758 * Decompression timestamp in AVStream->time_base units; the time at which
759 * the packet is decompressed.
760 * Can be AV_NOPTS_VALUE if it is not stored in the file.
767 * A combination of AV_PKT_FLAG values
771 * Additional packet data that can be provided by the container.
772 * Packet can contain several types of side information.
777 enum AVPacketSideDataType type;
782 * Duration of this packet in AVStream->time_base units, 0 if unknown.
783 * Equals next_pts - this_pts in presentation order.
786 void (*destruct)(struct AVPacket *);
788 int64_t pos; ///< byte position in stream, -1 if unknown
791 * Time difference in AVStream->time_base units from the pts of this
792 * packet to the point at which the output from the decoder has converged
793 * independent from the availability of previous frames. That is, the
794 * frames are virtually identical no matter if decoding started from
795 * the very first frame or from this keyframe.
796 * Is AV_NOPTS_VALUE if unknown.
797 * This field is not the display duration of the current packet.
798 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
801 * The purpose of this field is to allow seeking in streams that have no
802 * keyframes in the conventional sense. It corresponds to the
803 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
804 * essential for some types of subtitle streams to ensure that all
805 * subtitles are correctly displayed after seeking.
807 int64_t convergence_duration;
809 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
810 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
813 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
815 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
816 * s32le channel_count
817 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
818 * u64le channel_layout
819 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
821 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
826 enum AVSideDataParamChangeFlags {
827 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
828 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
829 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
830 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
835 * New fields can be added to the end of AVFRAME with minor version
836 * bumps. Removal, reordering and changes to existing fields require
837 * a major version bump.
838 * sizeof(AVFrame) must not be used outside libav*.
840 typedef struct AVFrame {
841 #define AV_NUM_DATA_POINTERS 8
843 * pointer to the picture/channel planes.
844 * This might be different from the first allocated byte
845 * - encoding: Set by user
846 * - decoding: set by AVCodecContext.get_buffer()
848 uint8_t *data[AV_NUM_DATA_POINTERS];
851 * Size, in bytes, of the data for each picture/channel plane.
853 * For audio, only linesize[0] may be set. For planar audio, each channel
854 * plane must be the same size.
856 * - encoding: Set by user
857 * - decoding: set by AVCodecContext.get_buffer()
859 int linesize[AV_NUM_DATA_POINTERS];
862 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
863 * This isn't used by libavcodec unless the default get/release_buffer() is used.
867 uint8_t *base[AV_NUM_DATA_POINTERS];
869 * 1 -> keyframe, 0-> not
870 * - encoding: Set by libavcodec.
871 * - decoding: Set by libavcodec.
876 * Picture type of the frame, see ?_TYPE below.
877 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
878 * - decoding: Set by libavcodec.
880 enum AVPictureType pict_type;
883 * presentation timestamp in time_base units (time when frame should be shown to user)
884 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
885 * - encoding: MUST be set by user.
886 * - decoding: Set by libavcodec.
891 * picture number in bitstream order
893 * - decoding: Set by libavcodec.
895 int coded_picture_number;
897 * picture number in display order
899 * - decoding: Set by libavcodec.
901 int display_picture_number;
904 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
905 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
906 * - decoding: Set by libavcodec.
911 * is this picture used as reference
912 * The values for this are the same as the MpegEncContext.picture_structure
913 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
914 * Set to 4 for delayed, non-reference frames.
916 * - decoding: Set by libavcodec. (before get_buffer() call)).
923 * - decoding: Set by libavcodec.
925 int8_t *qscale_table;
929 * - decoding: Set by libavcodec.
934 * mbskip_table[mb]>=1 if MB didn't change
935 * stride= mb_width = (width+15)>>4
937 * - decoding: Set by libavcodec.
939 uint8_t *mbskip_table;
942 * motion vector table
945 * int mv_sample_log2= 4 - motion_subsample_log2;
946 * int mb_width= (width+15)>>4;
947 * int mv_stride= (mb_width << mv_sample_log2) + 1;
948 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
950 * - encoding: Set by user.
951 * - decoding: Set by libavcodec.
953 int16_t (*motion_val[2])[2];
956 * macroblock type table
957 * mb_type_base + mb_width + 2
958 * - encoding: Set by user.
959 * - decoding: Set by libavcodec.
964 * log2 of the size of the block which a single vector in motion_val represents:
965 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
967 * - decoding: Set by libavcodec.
969 uint8_t motion_subsample_log2;
972 * for some private data of the user
974 * - decoding: Set by user.
980 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
983 uint64_t error[AV_NUM_DATA_POINTERS];
986 * type of the buffer (to keep track of who has to deallocate data[*])
987 * - encoding: Set by the one who allocates it.
988 * - decoding: Set by the one who allocates it.
989 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
994 * When decoding, this signals how much the picture must be delayed.
995 * extra_delay = repeat_pict / (2*fps)
997 * - decoding: Set by libavcodec.
1007 * The content of the picture is interlaced.
1008 * - encoding: Set by user.
1009 * - decoding: Set by libavcodec. (default 0)
1011 int interlaced_frame;
1014 * If the content is interlaced, is top field displayed first.
1015 * - encoding: Set by user.
1016 * - decoding: Set by libavcodec.
1018 int top_field_first;
1022 * - encoding: Set by user.
1023 * - decoding: Set by libavcodec.
1025 AVPanScan *pan_scan;
1028 * Tell user application that palette has changed from previous frame.
1029 * - encoding: ??? (no palette-enabled encoder yet)
1030 * - decoding: Set by libavcodec. (default 0).
1032 int palette_has_changed;
1035 * codec suggestion on buffer type if != 0
1036 * - encoding: unused
1037 * - decoding: Set by libavcodec. (before get_buffer() call)).
1043 * - encoding: unused
1044 * - decoding: Set by libavcodec.
1049 * motion reference frame index
1050 * the order in which these are stored can depend on the codec.
1051 * - encoding: Set by user.
1052 * - decoding: Set by libavcodec.
1054 int8_t *ref_index[2];
1057 * reordered opaque 64bit (generally an integer or a double precision float
1058 * PTS but can be anything).
1059 * The user sets AVCodecContext.reordered_opaque to represent the input at
1061 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1062 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1063 * @deprecated in favor of pkt_pts
1064 * - encoding: unused
1065 * - decoding: Read by user.
1067 int64_t reordered_opaque;
1070 * hardware accelerator private data (Libav-allocated)
1071 * - encoding: unused
1072 * - decoding: Set by libavcodec
1074 void *hwaccel_picture_private;
1077 * reordered pts from the last AVPacket that has been input into the decoder
1078 * - encoding: unused
1079 * - decoding: Read by user.
1084 * dts from the last AVPacket that has been input into the decoder
1085 * - encoding: unused
1086 * - decoding: Read by user.
1091 * the AVCodecContext which ff_thread_get_buffer() was last called on
1092 * - encoding: Set by libavcodec.
1093 * - decoding: Set by libavcodec.
1095 struct AVCodecContext *owner;
1098 * used by multithreading to store frame-specific info
1099 * - encoding: Set by libavcodec.
1100 * - decoding: Set by libavcodec.
1102 void *thread_opaque;
1105 * number of audio samples (per channel) described by this frame
1106 * - encoding: Set by user
1107 * - decoding: Set by libavcodec
1112 * pointers to the data planes/channels.
1114 * For video, this should simply point to data[].
1116 * For planar audio, each channel has a separate data pointer, and
1117 * linesize[0] contains the size of each channel buffer.
1118 * For packed audio, there is just one data pointer, and linesize[0]
1119 * contains the total size of the buffer for all channels.
1121 * Note: Both data and extended_data will always be set by get_buffer(),
1122 * but for planar audio with more channels that can fit in data,
1123 * extended_data must be used by the decoder in order to access all
1127 * decoding: set by AVCodecContext.get_buffer()
1129 uint8_t **extended_data;
1132 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1133 * - encoding: unused
1134 * - decoding: Read by user.
1136 AVRational sample_aspect_ratio;
1139 * width and height of the video frame
1140 * - encoding: unused
1141 * - decoding: Read by user.
1146 * format of the frame, -1 if unknown or unset
1147 * Values correspond to enum PixelFormat for video frames,
1148 * enum AVSampleFormat for audio)
1149 * - encoding: unused
1150 * - decoding: Read by user.
1155 struct AVCodecInternal;
1159 AV_FIELD_PROGRESSIVE,
1160 AV_FIELD_TT, //< Top coded_first, top displayed first
1161 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1162 AV_FIELD_TB, //< Top coded first, bottom displayed first
1163 AV_FIELD_BT, //< Bottom coded first, top displayed first
1167 * main external API structure.
1168 * New fields can be added to the end with minor version bumps.
1169 * Removal, reordering and changes to existing fields require a major
1171 * sizeof(AVCodecContext) must not be used outside libav*.
1173 typedef struct AVCodecContext {
1175 * information on struct for av_log
1176 * - set by avcodec_alloc_context3
1178 const AVClass *av_class;
1180 * the average bitrate
1181 * - encoding: Set by user; unused for constant quantizer encoding.
1182 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1187 * number of bits the bitstream is allowed to diverge from the reference.
1188 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1189 * - encoding: Set by user; unused for constant quantizer encoding.
1190 * - decoding: unused
1192 int bit_rate_tolerance;
1196 * - encoding: Set by user.
1197 * - decoding: Set by user.
1202 * Some codecs need additional format info. It is stored here.
1203 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1204 * specific codec MUST set it correctly otherwise stream copy breaks.
1205 * In general use of this field by muxers is not recommended.
1206 * - encoding: Set by libavcodec.
1207 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1212 * Motion estimation algorithm used for video coding.
1213 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1214 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1215 * - encoding: MUST be set by user.
1216 * - decoding: unused
1221 * some codecs need / can use extradata like Huffman tables.
1222 * mjpeg: Huffman tables
1223 * rv10: additional flags
1224 * mpeg4: global headers (they can be in the bitstream or here)
1225 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1226 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1227 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1228 * - encoding: Set/allocated/freed by libavcodec.
1229 * - decoding: Set/allocated/freed by user.
1235 * This is the fundamental unit of time (in seconds) in terms
1236 * of which frame timestamps are represented. For fixed-fps content,
1237 * timebase should be 1/framerate and timestamp increments should be
1239 * - encoding: MUST be set by user.
1240 * - decoding: Set by libavcodec.
1242 AVRational time_base;
1246 * picture width / height.
1247 * - encoding: MUST be set by user.
1248 * - decoding: Set by libavcodec.
1249 * Note: For compatibility it is possible to set this instead of
1250 * coded_width/height before decoding.
1254 #define FF_ASPECT_EXTENDED 15
1257 * the number of pictures in a group of pictures, or 0 for intra_only
1258 * - encoding: Set by user.
1259 * - decoding: unused
1264 * Pixel format, see PIX_FMT_xxx.
1265 * May be set by the demuxer if known from headers.
1266 * May be overriden by the decoder if it knows better.
1267 * - encoding: Set by user.
1268 * - decoding: Set by user if known, overridden by libavcodec if known
1270 enum PixelFormat pix_fmt;
1273 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1274 * decoder to draw a horizontal band. It improves cache usage. Not
1275 * all codecs can do that. You must check the codec capabilities
1277 * When multithreading is used, it may be called from multiple threads
1278 * at the same time; threads might draw different parts of the same AVFrame,
1279 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1281 * The function is also used by hardware acceleration APIs.
1282 * It is called at least once during frame decoding to pass
1283 * the data needed for hardware render.
1284 * In that mode instead of pixel data, AVFrame points to
1285 * a structure specific to the acceleration API. The application
1286 * reads the structure and can change some fields to indicate progress
1288 * - encoding: unused
1289 * - decoding: Set by user.
1290 * @param height the height of the slice
1291 * @param y the y position of the slice
1292 * @param type 1->top field, 2->bottom field, 3->frame
1293 * @param offset offset into the AVFrame.data from which the slice should be read
1295 void (*draw_horiz_band)(struct AVCodecContext *s,
1296 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1297 int y, int type, int height);
1300 int sample_rate; ///< samples per second
1301 int channels; ///< number of audio channels
1304 * audio sample format
1305 * - encoding: Set by user.
1306 * - decoding: Set by libavcodec.
1308 enum AVSampleFormat sample_fmt; ///< sample format
1310 /* The following data should not be initialized. */
1312 * Samples per packet, initialized when calling 'init'.
1315 int frame_number; ///< audio or video frame number
1321 * Number of frames the decoded output will be delayed relative to the
1325 * Number of "priming" samples added to the beginning of the stream
1326 * during encoding. The decoded output will be delayed by this many
1327 * samples relative to the input to the encoder. Note that this field is
1328 * purely informational and does not directly affect the pts output by
1329 * the encoder, which should always be based on the actual presentation
1330 * time, including any delay.
1332 * - encoding: Set by libavcodec.
1333 * - decoding: unused
1337 /* - encoding parameters */
1338 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1339 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1343 * - encoding: Set by user.
1344 * - decoding: unused
1350 * - encoding: Set by user.
1351 * - decoding: unused
1356 * maximum quantizer difference between frames
1357 * - encoding: Set by user.
1358 * - decoding: unused
1363 * maximum number of B-frames between non-B-frames
1364 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1365 * - encoding: Set by user.
1366 * - decoding: unused
1371 * qscale factor between IP and B-frames
1372 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1373 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1374 * - encoding: Set by user.
1375 * - decoding: unused
1377 float b_quant_factor;
1379 /** obsolete FIXME remove */
1381 #define FF_RC_STRATEGY_XVID 1
1383 int b_frame_strategy;
1385 struct AVCodec *codec;
1389 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1390 /* do its best to deliver a chunk with size */
1391 /* below rtp_payload_size, the chunk will start */
1392 /* with a start code on some codecs like H.263. */
1393 /* This doesn't take account of any particular */
1394 /* headers inside the transmitted RTP payload. */
1397 /* The RTP callback: This function is called */
1398 /* every time the encoder has a packet to send. */
1399 /* It depends on the encoder if the data starts */
1400 /* with a Start Code (it should). H.263 does. */
1401 /* mb_nb contains the number of macroblocks */
1402 /* encoded in the RTP payload. */
1403 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1405 /* statistics, used for 2-pass encoding */
1416 * number of bits used for the previously encoded frame
1417 * - encoding: Set by libavcodec.
1418 * - decoding: unused
1423 * Private data of the user, can be used to carry app specific stuff.
1424 * - encoding: Set by user.
1425 * - decoding: Set by user.
1429 char codec_name[32];
1430 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1431 enum CodecID codec_id; /* see CODEC_ID_xxx */
1434 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1435 * This is used to work around some encoder bugs.
1436 * A demuxer should set this to what is stored in the field used to identify the codec.
1437 * If there are multiple such fields in a container then the demuxer should choose the one
1438 * which maximizes the information about the used codec.
1439 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1440 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1441 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1443 * - encoding: Set by user, if not then the default based on codec_id will be used.
1444 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1446 unsigned int codec_tag;
1449 * Work around bugs in encoders which sometimes cannot be detected automatically.
1450 * - encoding: Set by user
1451 * - decoding: Set by user
1453 int workaround_bugs;
1454 #define FF_BUG_AUTODETECT 1 ///< autodetection
1455 #define FF_BUG_OLD_MSMPEG4 2
1456 #define FF_BUG_XVID_ILACE 4
1457 #define FF_BUG_UMP4 8
1458 #define FF_BUG_NO_PADDING 16
1459 #define FF_BUG_AMV 32
1460 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1461 #define FF_BUG_QPEL_CHROMA 64
1462 #define FF_BUG_STD_QPEL 128
1463 #define FF_BUG_QPEL_CHROMA2 256
1464 #define FF_BUG_DIRECT_BLOCKSIZE 512
1465 #define FF_BUG_EDGE 1024
1466 #define FF_BUG_HPEL_CHROMA 2048
1467 #define FF_BUG_DC_CLIP 4096
1468 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1469 #define FF_BUG_TRUNCATED 16384
1472 * luma single coefficient elimination threshold
1473 * - encoding: Set by user.
1474 * - decoding: unused
1476 int luma_elim_threshold;
1479 * chroma single coeff elimination threshold
1480 * - encoding: Set by user.
1481 * - decoding: unused
1483 int chroma_elim_threshold;
1486 * strictly follow the standard (MPEG4, ...).
1487 * - encoding: Set by user.
1488 * - decoding: Set by user.
1489 * Setting this to STRICT or higher means the encoder and decoder will
1490 * generally do stupid things, whereas setting it to unofficial or lower
1491 * will mean the encoder might produce output that is not supported by all
1492 * spec-compliant decoders. Decoders don't differentiate between normal,
1493 * unofficial and experimental (that is, they always try to decode things
1494 * when they can) unless they are explicitly asked to behave stupidly
1495 * (=strictly conform to the specs)
1497 int strict_std_compliance;
1498 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1499 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1500 #define FF_COMPLIANCE_NORMAL 0
1501 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1502 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1505 * qscale offset between IP and B-frames
1506 * - encoding: Set by user.
1507 * - decoding: unused
1509 float b_quant_offset;
1512 * Called at the beginning of each frame to get a buffer for it.
1514 * The function will set AVFrame.data[], AVFrame.linesize[].
1515 * AVFrame.extended_data[] must also be set, but it should be the same as
1516 * AVFrame.data[] except for planar audio with more channels than can fit
1517 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1518 * many data pointers as it can hold.
1520 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1521 * avcodec_default_get_buffer() instead of providing buffers allocated by
1524 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1525 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1526 * but if get_buffer() is overridden then alignment considerations should
1527 * be taken into account.
1529 * @see avcodec_default_get_buffer()
1533 * If pic.reference is set then the frame will be read later by libavcodec.
1534 * avcodec_align_dimensions2() should be used to find the required width and
1535 * height, as they normally need to be rounded up to the next multiple of 16.
1537 * If frame multithreading is used and thread_safe_callbacks is set,
1538 * it may be called from a different thread, but not from more than one at
1539 * once. Does not need to be reentrant.
1541 * @see release_buffer(), reget_buffer()
1542 * @see avcodec_align_dimensions2()
1546 * Decoders request a buffer of a particular size by setting
1547 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1548 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1549 * to a smaller value in the output frame.
1551 * Decoders cannot use the buffer after returning from
1552 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1553 * is assumed to be released immediately upon return.
1555 * As a convenience, av_samples_get_buffer_size() and
1556 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1557 * functions to find the required data size and to fill data pointers and
1558 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1559 * since all planes must be the same size.
1561 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1563 * - encoding: unused
1564 * - decoding: Set by libavcodec, user can override.
1566 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1569 * Called to release buffers which were allocated with get_buffer.
1570 * A released buffer can be reused in get_buffer().
1571 * pic.data[*] must be set to NULL.
1572 * May be called from a different thread if frame multithreading is used,
1573 * but not by more than one thread at once, so does not need to be reentrant.
1574 * - encoding: unused
1575 * - decoding: Set by libavcodec, user can override.
1577 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1580 * Size of the frame reordering buffer in the decoder.
1581 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1582 * - encoding: Set by libavcodec.
1583 * - decoding: Set by libavcodec.
1588 * number of bytes per packet if constant and known or 0
1589 * Used by some WAV based audio codecs.
1594 * 0-> h263 quant 1-> mpeg quant
1595 * - encoding: Set by user.
1596 * - decoding: unused
1601 * pass1 encoding statistics output buffer
1602 * - encoding: Set by libavcodec.
1603 * - decoding: unused
1608 * pass2 encoding statistics input buffer
1609 * Concatenated stuff from stats_out of pass1 should be placed here.
1610 * - encoding: Allocated/set/freed by user.
1611 * - decoding: unused
1616 * ratecontrol qmin qmax limiting method
1617 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1618 * - encoding: Set by user.
1619 * - decoding: unused
1627 * ratecontrol override, see RcOverride
1628 * - encoding: Allocated/set/freed by user.
1629 * - decoding: unused
1631 RcOverride *rc_override;
1632 int rc_override_count;
1635 * rate control equation
1636 * - encoding: Set by user
1637 * - decoding: unused
1643 * - encoding: Set by user.
1644 * - decoding: unused
1650 * - encoding: Set by user.
1651 * - decoding: unused
1656 * decoder bitstream buffer size
1657 * - encoding: Set by user.
1658 * - decoding: unused
1661 float rc_buffer_aggressivity;
1664 * qscale factor between P and I-frames
1665 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1666 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1667 * - encoding: Set by user.
1668 * - decoding: unused
1670 float i_quant_factor;
1673 * qscale offset between P and I-frames
1674 * - encoding: Set by user.
1675 * - decoding: unused
1677 float i_quant_offset;
1680 * initial complexity for pass1 ratecontrol
1681 * - encoding: Set by user.
1682 * - decoding: unused
1684 float rc_initial_cplx;
1687 * DCT algorithm, see FF_DCT_* below
1688 * - encoding: Set by user.
1689 * - decoding: unused
1692 #define FF_DCT_AUTO 0
1693 #define FF_DCT_FASTINT 1
1694 #define FF_DCT_INT 2
1695 #define FF_DCT_MMX 3
1696 #define FF_DCT_ALTIVEC 5
1697 #define FF_DCT_FAAN 6
1700 * luminance masking (0-> disabled)
1701 * - encoding: Set by user.
1702 * - decoding: unused
1707 * temporary complexity masking (0-> disabled)
1708 * - encoding: Set by user.
1709 * - decoding: unused
1711 float temporal_cplx_masking;
1714 * spatial complexity masking (0-> disabled)
1715 * - encoding: Set by user.
1716 * - decoding: unused
1718 float spatial_cplx_masking;
1721 * p block masking (0-> disabled)
1722 * - encoding: Set by user.
1723 * - decoding: unused
1728 * darkness masking (0-> disabled)
1729 * - encoding: Set by user.
1730 * - decoding: unused
1735 * IDCT algorithm, see FF_IDCT_* below.
1736 * - encoding: Set by user.
1737 * - decoding: Set by user.
1740 #define FF_IDCT_AUTO 0
1741 #define FF_IDCT_INT 1
1742 #define FF_IDCT_SIMPLE 2
1743 #define FF_IDCT_SIMPLEMMX 3
1744 #define FF_IDCT_LIBMPEG2MMX 4
1745 #define FF_IDCT_MMI 5
1746 #define FF_IDCT_ARM 7
1747 #define FF_IDCT_ALTIVEC 8
1748 #define FF_IDCT_SH4 9
1749 #define FF_IDCT_SIMPLEARM 10
1750 #define FF_IDCT_H264 11
1751 #define FF_IDCT_VP3 12
1752 #define FF_IDCT_IPP 13
1753 #define FF_IDCT_XVIDMMX 14
1754 #define FF_IDCT_CAVS 15
1755 #define FF_IDCT_SIMPLEARMV5TE 16
1756 #define FF_IDCT_SIMPLEARMV6 17
1757 #define FF_IDCT_SIMPLEVIS 18
1758 #define FF_IDCT_WMV2 19
1759 #define FF_IDCT_FAAN 20
1760 #define FF_IDCT_EA 21
1761 #define FF_IDCT_SIMPLENEON 22
1762 #define FF_IDCT_SIMPLEALPHA 23
1763 #define FF_IDCT_BINK 24
1767 * - encoding: Set by libavcodec.
1768 * - decoding: Set by user (or 0).
1772 * slice offsets in the frame in bytes
1773 * - encoding: Set/allocated by libavcodec.
1774 * - decoding: Set/allocated by user (or NULL).
1779 * error concealment flags
1780 * - encoding: unused
1781 * - decoding: Set by user.
1783 int error_concealment;
1784 #define FF_EC_GUESS_MVS 1
1785 #define FF_EC_DEBLOCK 2
1788 * dsp_mask could be add used to disable unwanted CPU features
1789 * CPU features (i.e. MMX, SSE. ...)
1791 * With the FORCE flag you may instead enable given CPU features.
1792 * (Dangerous: Usable in case of misdetection, improper usage however will
1793 * result into program crash.)
1798 * bits per sample/pixel from the demuxer (needed for huffyuv).
1799 * - encoding: Set by libavcodec.
1800 * - decoding: Set by user.
1802 int bits_per_coded_sample;
1805 * prediction method (needed for huffyuv)
1806 * - encoding: Set by user.
1807 * - decoding: unused
1809 int prediction_method;
1810 #define FF_PRED_LEFT 0
1811 #define FF_PRED_PLANE 1
1812 #define FF_PRED_MEDIAN 2
1815 * sample aspect ratio (0 if unknown)
1816 * That is the width of a pixel divided by the height of the pixel.
1817 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1818 * - encoding: Set by user.
1819 * - decoding: Set by libavcodec.
1821 AVRational sample_aspect_ratio;
1824 * the picture in the bitstream
1825 * - encoding: Set by libavcodec.
1826 * - decoding: Set by libavcodec.
1828 AVFrame *coded_frame;
1832 * - encoding: Set by user.
1833 * - decoding: Set by user.
1836 #define FF_DEBUG_PICT_INFO 1
1837 #define FF_DEBUG_RC 2
1838 #define FF_DEBUG_BITSTREAM 4
1839 #define FF_DEBUG_MB_TYPE 8
1840 #define FF_DEBUG_QP 16
1841 #define FF_DEBUG_MV 32
1842 #define FF_DEBUG_DCT_COEFF 0x00000040
1843 #define FF_DEBUG_SKIP 0x00000080
1844 #define FF_DEBUG_STARTCODE 0x00000100
1845 #define FF_DEBUG_PTS 0x00000200
1846 #define FF_DEBUG_ER 0x00000400
1847 #define FF_DEBUG_MMCO 0x00000800
1848 #define FF_DEBUG_BUGS 0x00001000
1849 #define FF_DEBUG_VIS_QP 0x00002000
1850 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1851 #define FF_DEBUG_BUFFERS 0x00008000
1852 #define FF_DEBUG_THREADS 0x00010000
1856 * - encoding: Set by user.
1857 * - decoding: Set by user.
1860 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1861 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1862 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1866 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1867 * - decoding: unused
1869 uint64_t error[AV_NUM_DATA_POINTERS];
1872 * motion estimation comparison function
1873 * - encoding: Set by user.
1874 * - decoding: unused
1878 * subpixel motion estimation comparison function
1879 * - encoding: Set by user.
1880 * - decoding: unused
1884 * macroblock comparison function (not supported yet)
1885 * - encoding: Set by user.
1886 * - decoding: unused
1890 * interlaced DCT comparison function
1891 * - encoding: Set by user.
1892 * - decoding: unused
1895 #define FF_CMP_SAD 0
1896 #define FF_CMP_SSE 1
1897 #define FF_CMP_SATD 2
1898 #define FF_CMP_DCT 3
1899 #define FF_CMP_PSNR 4
1900 #define FF_CMP_BIT 5
1902 #define FF_CMP_ZERO 7
1903 #define FF_CMP_VSAD 8
1904 #define FF_CMP_VSSE 9
1905 #define FF_CMP_NSSE 10
1906 #define FF_CMP_W53 11
1907 #define FF_CMP_W97 12
1908 #define FF_CMP_DCTMAX 13
1909 #define FF_CMP_DCT264 14
1910 #define FF_CMP_CHROMA 256
1913 * ME diamond size & shape
1914 * - encoding: Set by user.
1915 * - decoding: unused
1920 * amount of previous MV predictors (2a+1 x 2a+1 square)
1921 * - encoding: Set by user.
1922 * - decoding: unused
1924 int last_predictor_count;
1927 * prepass for motion estimation
1928 * - encoding: Set by user.
1929 * - decoding: unused
1934 * motion estimation prepass comparison function
1935 * - encoding: Set by user.
1936 * - decoding: unused
1941 * ME prepass diamond size & shape
1942 * - encoding: Set by user.
1943 * - decoding: unused
1949 * - encoding: Set by user.
1950 * - decoding: unused
1952 int me_subpel_quality;
1955 * callback to negotiate the pixelFormat
1956 * @param fmt is the list of formats which are supported by the codec,
1957 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1958 * The first is always the native one.
1959 * @return the chosen format
1960 * - encoding: unused
1961 * - decoding: Set by user, if not set the native format will be chosen.
1963 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1966 * DTG active format information (additional aspect ratio
1967 * information only used in DVB MPEG-2 transport streams)
1970 * - encoding: unused
1971 * - decoding: Set by decoder.
1973 int dtg_active_format;
1974 #define FF_DTG_AFD_SAME 8
1975 #define FF_DTG_AFD_4_3 9
1976 #define FF_DTG_AFD_16_9 10
1977 #define FF_DTG_AFD_14_9 11
1978 #define FF_DTG_AFD_4_3_SP_14_9 13
1979 #define FF_DTG_AFD_16_9_SP_14_9 14
1980 #define FF_DTG_AFD_SP_4_3 15
1983 * maximum motion estimation search range in subpel units
1984 * If 0 then no limit.
1986 * - encoding: Set by user.
1987 * - decoding: unused
1992 * intra quantizer bias
1993 * - encoding: Set by user.
1994 * - decoding: unused
1996 int intra_quant_bias;
1997 #define FF_DEFAULT_QUANT_BIAS 999999
2000 * inter quantizer bias
2001 * - encoding: Set by user.
2002 * - decoding: unused
2004 int inter_quant_bias;
2008 * - encoding: unused
2009 * - decoding: Which clrtable should be used for 8bit RGB images.
2010 * Tables have to be stored somewhere. FIXME
2015 * Global quality for codecs which cannot change it per frame.
2016 * This should be proportional to MPEG-1/2/4 qscale.
2017 * - encoding: Set by user.
2018 * - decoding: unused
2022 #define FF_CODER_TYPE_VLC 0
2023 #define FF_CODER_TYPE_AC 1
2024 #define FF_CODER_TYPE_RAW 2
2025 #define FF_CODER_TYPE_RLE 3
2026 #define FF_CODER_TYPE_DEFLATE 4
2029 * - encoding: Set by user.
2030 * - decoding: unused
2036 * - encoding: Set by user.
2037 * - decoding: unused
2043 * - encoding: unused
2044 * - decoding: Set by user.
2047 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2048 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2049 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2052 * XVideo Motion Acceleration
2053 * - encoding: forbidden
2054 * - decoding: set by decoder
2056 int xvmc_acceleration;
2059 * macroblock decision mode
2060 * - encoding: Set by user.
2061 * - decoding: unused
2064 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2065 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2066 #define FF_MB_DECISION_RD 2 ///< rate distortion
2069 * custom intra quantization matrix
2070 * - encoding: Set by user, can be NULL.
2071 * - decoding: Set by libavcodec.
2073 uint16_t *intra_matrix;
2076 * custom inter quantization matrix
2077 * - encoding: Set by user, can be NULL.
2078 * - decoding: Set by libavcodec.
2080 uint16_t *inter_matrix;
2083 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2084 * This is used to work around some encoder bugs.
2085 * - encoding: unused
2086 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2088 unsigned int stream_codec_tag;
2091 * scene change detection threshold
2092 * 0 is default, larger means fewer detected scene changes.
2093 * - encoding: Set by user.
2094 * - decoding: unused
2096 int scenechange_threshold;
2099 * minimum Lagrange multipler
2100 * - encoding: Set by user.
2101 * - decoding: unused
2106 * maximum Lagrange multipler
2107 * - encoding: Set by user.
2108 * - decoding: unused
2113 * noise reduction strength
2114 * - encoding: Set by user.
2115 * - decoding: unused
2117 int noise_reduction;
2120 * Called at the beginning of a frame to get cr buffer for it.
2121 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2122 * libavcodec will pass previous buffer in pic, function should return
2123 * same buffer or new buffer with old frame "painted" into it.
2124 * If pic.data[0] == NULL must behave like get_buffer().
2125 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2126 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2128 * - encoding: unused
2129 * - decoding: Set by libavcodec, user can override.
2131 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2134 * Number of bits which should be loaded into the rc buffer before decoding starts.
2135 * - encoding: Set by user.
2136 * - decoding: unused
2138 int rc_initial_buffer_occupancy;
2142 * - encoding: Set by user.
2143 * - decoding: unused
2145 int inter_threshold;
2149 * - encoding: Set by user.
2150 * - decoding: Set by user.
2155 * Simulates errors in the bitstream to test error concealment.
2156 * - encoding: Set by user.
2157 * - decoding: unused
2162 * quantizer noise shaping
2163 * - encoding: Set by user.
2164 * - decoding: unused
2166 int quantizer_noise_shaping;
2170 * is used to decide how many independent tasks should be passed to execute()
2171 * - encoding: Set by user.
2172 * - decoding: Set by user.
2177 * The codec may call this to execute several independent things.
2178 * It will return only after finishing all tasks.
2179 * The user may replace this with some multithreaded implementation,
2180 * the default implementation will execute the parts serially.
2181 * @param count the number of things to execute
2182 * - encoding: Set by libavcodec, user can override.
2183 * - decoding: Set by libavcodec, user can override.
2185 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2189 * Can be used by execute() to store some per AVCodecContext stuff.
2190 * - encoding: set by execute()
2191 * - decoding: set by execute()
2193 void *thread_opaque;
2196 * Motion estimation threshold below which no motion estimation is
2197 * performed, but instead the user specified motion vectors are used.
2199 * - encoding: Set by user.
2200 * - decoding: unused
2205 * Macroblock threshold below which the user specified macroblock types will be used.
2206 * - encoding: Set by user.
2207 * - decoding: unused
2212 * precision of the intra DC coefficient - 8
2213 * - encoding: Set by user.
2214 * - decoding: unused
2216 int intra_dc_precision;
2219 * noise vs. sse weight for the nsse comparsion function
2220 * - encoding: Set by user.
2221 * - decoding: unused
2226 * Number of macroblock rows at the top which are skipped.
2227 * - encoding: unused
2228 * - decoding: Set by user.
2233 * Number of macroblock rows at the bottom which are skipped.
2234 * - encoding: unused
2235 * - decoding: Set by user.
2241 * - encoding: Set by user.
2242 * - decoding: Set by libavcodec.
2245 #define FF_PROFILE_UNKNOWN -99
2246 #define FF_PROFILE_RESERVED -100
2248 #define FF_PROFILE_AAC_MAIN 0
2249 #define FF_PROFILE_AAC_LOW 1
2250 #define FF_PROFILE_AAC_SSR 2
2251 #define FF_PROFILE_AAC_LTP 3
2253 #define FF_PROFILE_DTS 20
2254 #define FF_PROFILE_DTS_ES 30
2255 #define FF_PROFILE_DTS_96_24 40
2256 #define FF_PROFILE_DTS_HD_HRA 50
2257 #define FF_PROFILE_DTS_HD_MA 60
2259 #define FF_PROFILE_MPEG2_422 0
2260 #define FF_PROFILE_MPEG2_HIGH 1
2261 #define FF_PROFILE_MPEG2_SS 2
2262 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2263 #define FF_PROFILE_MPEG2_MAIN 4
2264 #define FF_PROFILE_MPEG2_SIMPLE 5
2266 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2267 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2269 #define FF_PROFILE_H264_BASELINE 66
2270 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2271 #define FF_PROFILE_H264_MAIN 77
2272 #define FF_PROFILE_H264_EXTENDED 88
2273 #define FF_PROFILE_H264_HIGH 100
2274 #define FF_PROFILE_H264_HIGH_10 110
2275 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2276 #define FF_PROFILE_H264_HIGH_422 122
2277 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2278 #define FF_PROFILE_H264_HIGH_444 144
2279 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2280 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2281 #define FF_PROFILE_H264_CAVLC_444 44
2283 #define FF_PROFILE_VC1_SIMPLE 0
2284 #define FF_PROFILE_VC1_MAIN 1
2285 #define FF_PROFILE_VC1_COMPLEX 2
2286 #define FF_PROFILE_VC1_ADVANCED 3
2288 #define FF_PROFILE_MPEG4_SIMPLE 0
2289 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2290 #define FF_PROFILE_MPEG4_CORE 2
2291 #define FF_PROFILE_MPEG4_MAIN 3
2292 #define FF_PROFILE_MPEG4_N_BIT 4
2293 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2294 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2295 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2296 #define FF_PROFILE_MPEG4_HYBRID 8
2297 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2298 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2299 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2300 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2301 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2302 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2303 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2307 * - encoding: Set by user.
2308 * - decoding: Set by libavcodec.
2311 #define FF_LEVEL_UNKNOWN -99
2314 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2315 * - encoding: unused
2316 * - decoding: Set by user.
2321 * Bitstream width / height, may be different from width/height if lowres enabled.
2322 * - encoding: unused
2323 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2325 int coded_width, coded_height;
2328 * frame skip threshold
2329 * - encoding: Set by user.
2330 * - decoding: unused
2332 int frame_skip_threshold;
2336 * - encoding: Set by user.
2337 * - decoding: unused
2339 int frame_skip_factor;
2342 * frame skip exponent
2343 * - encoding: Set by user.
2344 * - decoding: unused
2349 * frame skip comparison function
2350 * - encoding: Set by user.
2351 * - decoding: unused
2356 * Border processing masking, raises the quantizer for mbs on the borders
2358 * - encoding: Set by user.
2359 * - decoding: unused
2361 float border_masking;
2364 * minimum MB lagrange multipler
2365 * - encoding: Set by user.
2366 * - decoding: unused
2371 * maximum MB lagrange multipler
2372 * - encoding: Set by user.
2373 * - decoding: unused
2379 * - encoding: Set by user.
2380 * - decoding: unused
2382 int me_penalty_compensation;
2386 * - encoding: unused
2387 * - decoding: Set by user.
2389 enum AVDiscard skip_loop_filter;
2393 * - encoding: unused
2394 * - decoding: Set by user.
2396 enum AVDiscard skip_idct;
2400 * - encoding: unused
2401 * - decoding: Set by user.
2403 enum AVDiscard skip_frame;
2407 * - encoding: Set by user.
2408 * - decoding: unused
2414 * - encoding: Set by user.
2415 * - decoding: unused
2421 * - encoding: Set by user.
2422 * - decoding: unused
2427 * number of reference frames
2428 * - encoding: Set by user.
2429 * - decoding: Set by lavc.
2434 * chroma qp offset from luma
2435 * - encoding: Set by user.
2436 * - decoding: unused
2441 * trellis RD quantization
2442 * - encoding: Set by user.
2443 * - decoding: unused
2448 * Audio cutoff bandwidth (0 means "automatic")
2449 * - encoding: Set by user.
2450 * - decoding: unused
2455 * Multiplied by qscale for each frame and added to scene_change_score.
2456 * - encoding: Set by user.
2457 * - decoding: unused
2459 int scenechange_factor;
2463 * Note: Value depends upon the compare function used for fullpel ME.
2464 * - encoding: Set by user.
2465 * - decoding: unused
2470 * Adjust sensitivity of b_frame_strategy 1.
2471 * - encoding: Set by user.
2472 * - decoding: unused
2477 * - encoding: Set by user.
2478 * - decoding: unused
2480 int compression_level;
2481 #define FF_COMPRESSION_DEFAULT -1
2484 * - encoding: Set by user.
2485 * - decoding: unused
2487 int min_prediction_order;
2490 * - encoding: Set by user.
2491 * - decoding: unused
2493 int max_prediction_order;
2496 * GOP timecode frame start number, in non drop frame format
2497 * - encoding: Set by user.
2498 * - decoding: unused
2500 int64_t timecode_frame_start;
2502 #if FF_API_REQUEST_CHANNELS
2504 * Decoder should decode to this many channels if it can (0 for default)
2505 * - encoding: unused
2506 * - decoding: Set by user.
2507 * @deprecated Deprecated in favor of request_channel_layout.
2509 int request_channels;
2513 * opaque 64bit number (generally a PTS) that will be reordered and
2514 * output in AVFrame.reordered_opaque
2515 * @deprecated in favor of pkt_pts
2516 * - encoding: unused
2517 * - decoding: Set by user.
2519 int64_t reordered_opaque;
2522 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2523 * - encoding: set by user.
2524 * - decoding: set by libavcodec.
2526 int bits_per_raw_sample;
2529 * Audio channel layout.
2530 * - encoding: set by user.
2531 * - decoding: set by libavcodec.
2533 uint64_t channel_layout;
2536 * Request decoder to use this channel layout if it can (0 for default)
2537 * - encoding: unused
2538 * - decoding: Set by user.
2540 uint64_t request_channel_layout;
2543 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2544 * - encoding: Set by user.
2545 * - decoding: unused.
2547 float rc_max_available_vbv_use;
2550 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2551 * - encoding: Set by user.
2552 * - decoding: unused.
2554 float rc_min_vbv_overflow_use;
2557 * Hardware accelerator in use
2558 * - encoding: unused.
2559 * - decoding: Set by libavcodec
2561 struct AVHWAccel *hwaccel;
2564 * For some codecs, the time base is closer to the field rate than the frame rate.
2565 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2566 * if no telecine is used ...
2568 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2570 int ticks_per_frame;
2573 * Hardware accelerator context.
2574 * For some hardware accelerators, a global context needs to be
2575 * provided by the user. In that case, this holds display-dependent
2576 * data Libav cannot instantiate itself. Please refer to the
2577 * Libav HW accelerator documentation to know how to fill this
2578 * is. e.g. for VA API, this is a struct vaapi_context.
2579 * - encoding: unused
2580 * - decoding: Set by user
2582 void *hwaccel_context;
2585 * Chromaticity coordinates of the source primaries.
2586 * - encoding: Set by user
2587 * - decoding: Set by libavcodec
2589 enum AVColorPrimaries color_primaries;
2592 * Color Transfer Characteristic.
2593 * - encoding: Set by user
2594 * - decoding: Set by libavcodec
2596 enum AVColorTransferCharacteristic color_trc;
2599 * YUV colorspace type.
2600 * - encoding: Set by user
2601 * - decoding: Set by libavcodec
2603 enum AVColorSpace colorspace;
2606 * MPEG vs JPEG YUV range.
2607 * - encoding: Set by user
2608 * - decoding: Set by libavcodec
2610 enum AVColorRange color_range;
2613 * This defines the location of chroma samples.
2614 * - encoding: Set by user
2615 * - decoding: Set by libavcodec
2617 enum AVChromaLocation chroma_sample_location;
2620 * The codec may call this to execute several independent things.
2621 * It will return only after finishing all tasks.
2622 * The user may replace this with some multithreaded implementation,
2623 * the default implementation will execute the parts serially.
2624 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2625 * @param c context passed also to func
2626 * @param count the number of things to execute
2627 * @param arg2 argument passed unchanged to func
2628 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2629 * @param func function that will be called count times, with jobnr from 0 to count-1.
2630 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2631 * two instances of func executing at the same time will have the same threadnr.
2632 * @return always 0 currently, but code should handle a future improvement where when any call to func
2633 * returns < 0 no further calls to func may be done and < 0 is returned.
2634 * - encoding: Set by libavcodec, user can override.
2635 * - decoding: Set by libavcodec, user can override.
2637 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2639 int log_level_offset;
2643 * Indicates number of picture subdivisions. Used for parallelized
2645 * - encoding: Set by user
2646 * - decoding: unused
2651 * Header containing style information for text subtitles.
2652 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2653 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2654 * the Format line following. It shouldn't include any Dialogue line.
2655 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2656 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2658 uint8_t *subtitle_header;
2659 int subtitle_header_size;
2662 * Current packet as passed into the decoder, to avoid having
2663 * to pass the packet into every function. Currently only valid
2664 * inside lavc and get/release_buffer callbacks.
2665 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2666 * - encoding: unused
2671 * Which multithreading methods to use.
2672 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2673 * so clients which cannot provide future frames should not use it.
2675 * - encoding: Set by user, otherwise the default is used.
2676 * - decoding: Set by user, otherwise the default is used.
2679 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2680 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2683 * Which multithreading methods are in use by the codec.
2684 * - encoding: Set by libavcodec.
2685 * - decoding: Set by libavcodec.
2687 int active_thread_type;
2690 * Set by the client if its custom get_buffer() callback can be called
2691 * from another thread, which allows faster multithreaded decoding.
2692 * draw_horiz_band() will be called from other threads regardless of this setting.
2693 * Ignored if the default get_buffer() is used.
2694 * - encoding: Set by user.
2695 * - decoding: Set by user.
2697 int thread_safe_callbacks;
2700 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2701 * Used for compliant TS muxing.
2702 * - encoding: Set by libavcodec.
2703 * - decoding: unused.
2708 * Type of service that the audio stream conveys.
2709 * - encoding: Set by user.
2710 * - decoding: Set by libavcodec.
2712 enum AVAudioServiceType audio_service_type;
2715 * Used to request a sample format from the decoder.
2716 * - encoding: unused.
2717 * - decoding: Set by user.
2719 enum AVSampleFormat request_sample_fmt;
2722 * Error recognition; may misdetect some more or less valid parts as errors.
2723 * - encoding: unused
2724 * - decoding: Set by user.
2726 int err_recognition;
2727 #define AV_EF_CRCCHECK (1<<0)
2728 #define AV_EF_BITSTREAM (1<<1)
2729 #define AV_EF_BUFFER (1<<2)
2730 #define AV_EF_EXPLODE (1<<3)
2733 * Private context used for internal data.
2735 * Unlike priv_data, this is not codec-specific. It is used in general
2736 * libavcodec functions.
2738 struct AVCodecInternal *internal;
2741 * - encoding: set by libavcodec
2742 * - decoding: Set by libavcodec
2744 enum AVFieldOrder field_order;
2750 typedef struct AVProfile {
2752 const char *name; ///< short name for the profile
2755 typedef struct AVCodecDefault AVCodecDefault;
2760 typedef struct AVCodec {
2762 * Name of the codec implementation.
2763 * The name is globally unique among encoders and among decoders (but an
2764 * encoder and a decoder can share the same name).
2765 * This is the primary way to find a codec from the user perspective.
2769 * Descriptive name for the codec, meant to be more human readable than name.
2770 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2772 const char *long_name;
2773 enum AVMediaType type;
2776 * Codec capabilities.
2780 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2781 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2782 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2783 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2784 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2785 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2786 const AVClass *priv_class; ///< AVClass for the private context
2787 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2789 /*****************************************************************
2790 * No fields below this line are part of the public API. They
2791 * may not be used outside of libavcodec and can be changed and
2793 * New public fields should be added right above.
2794 *****************************************************************
2797 struct AVCodec *next;
2799 * @name Frame-level threading support functions
2803 * If defined, called on thread contexts when they are created.
2804 * If the codec allocates writable tables in init(), re-allocate them here.
2805 * priv_data will be set to a copy of the original.
2807 int (*init_thread_copy)(AVCodecContext *);
2809 * Copy necessary context variables from a previous thread context to the current one.
2810 * If not defined, the next thread will start automatically; otherwise, the codec
2811 * must call ff_thread_finish_setup().
2813 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2815 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2819 * Private codec-specific defaults.
2821 const AVCodecDefault *defaults;
2824 * Initialize codec static data, called from avcodec_register().
2826 void (*init_static_data)(struct AVCodec *codec);
2828 int (*init)(AVCodecContext *);
2829 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2831 * Encode data to an AVPacket.
2833 * @param avctx codec context
2834 * @param avpkt output AVPacket (may contain a user-provided buffer)
2835 * @param[in] frame AVFrame containing the raw data to be encoded
2836 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2837 * non-empty packet was returned in avpkt.
2838 * @return 0 on success, negative error code on failure
2840 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2841 int *got_packet_ptr);
2842 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2843 int (*close)(AVCodecContext *);
2846 * Will be called when seeking
2848 void (*flush)(AVCodecContext *);
2854 typedef struct AVHWAccel {
2856 * Name of the hardware accelerated codec.
2857 * The name is globally unique among encoders and among decoders (but an
2858 * encoder and a decoder can share the same name).
2863 * Type of codec implemented by the hardware accelerator.
2865 * See AVMEDIA_TYPE_xxx
2867 enum AVMediaType type;
2870 * Codec implemented by the hardware accelerator.
2877 * Supported pixel format.
2879 * Only hardware accelerated formats are supported here.
2881 enum PixelFormat pix_fmt;
2884 * Hardware accelerated codec capabilities.
2885 * see FF_HWACCEL_CODEC_CAP_*
2889 struct AVHWAccel *next;
2892 * Called at the beginning of each frame or field picture.
2894 * Meaningful frame information (codec specific) is guaranteed to
2895 * be parsed at this point. This function is mandatory.
2897 * Note that buf can be NULL along with buf_size set to 0.
2898 * Otherwise, this means the whole frame is available at this point.
2900 * @param avctx the codec context
2901 * @param buf the frame data buffer base
2902 * @param buf_size the size of the frame in bytes
2903 * @return zero if successful, a negative value otherwise
2905 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2908 * Callback for each slice.
2910 * Meaningful slice information (codec specific) is guaranteed to
2911 * be parsed at this point. This function is mandatory.
2913 * @param avctx the codec context
2914 * @param buf the slice data buffer base
2915 * @param buf_size the size of the slice in bytes
2916 * @return zero if successful, a negative value otherwise
2918 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2921 * Called at the end of each frame or field picture.
2923 * The whole picture is parsed at this point and can now be sent
2924 * to the hardware accelerator. This function is mandatory.
2926 * @param avctx the codec context
2927 * @return zero if successful, a negative value otherwise
2929 int (*end_frame)(AVCodecContext *avctx);
2932 * Size of HW accelerator private data.
2934 * Private data is allocated with av_mallocz() before
2935 * AVCodecContext.get_buffer() and deallocated after
2936 * AVCodecContext.release_buffer().
2942 * four components are given, that's all.
2943 * the last component is alpha
2945 typedef struct AVPicture {
2946 uint8_t *data[AV_NUM_DATA_POINTERS];
2947 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
2950 #define AVPALETTE_SIZE 1024
2951 #define AVPALETTE_COUNT 256
2953 enum AVSubtitleType {
2956 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2959 * Plain text, the text field must be set by the decoder and is
2960 * authoritative. ass and pict fields may contain approximations.
2965 * Formatted text, the ass field must be set by the decoder and is
2966 * authoritative. pict and text fields may contain approximations.
2971 typedef struct AVSubtitleRect {
2972 int x; ///< top left corner of pict, undefined when pict is not set
2973 int y; ///< top left corner of pict, undefined when pict is not set
2974 int w; ///< width of pict, undefined when pict is not set
2975 int h; ///< height of pict, undefined when pict is not set
2976 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2979 * data+linesize for the bitmap of this subtitle.
2980 * can be set for text/ass as well once they where rendered
2983 enum AVSubtitleType type;
2985 char *text; ///< 0 terminated plain UTF-8 text
2988 * 0 terminated ASS/SSA compatible event line.
2989 * The pressentation of this is unaffected by the other values in this
2995 typedef struct AVSubtitle {
2996 uint16_t format; /* 0 = graphics */
2997 uint32_t start_display_time; /* relative to packet pts, in ms */
2998 uint32_t end_display_time; /* relative to packet pts, in ms */
3000 AVSubtitleRect **rects;
3001 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3004 /* packet functions */
3007 * @deprecated use NULL instead
3009 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3012 * Default packet destructor.
3014 void av_destruct_packet(AVPacket *pkt);
3017 * Initialize optional fields of a packet with default values.
3021 void av_init_packet(AVPacket *pkt);
3024 * Allocate the payload of a packet and initialize its fields with
3028 * @param size wanted payload size
3029 * @return 0 if OK, AVERROR_xxx otherwise
3031 int av_new_packet(AVPacket *pkt, int size);
3034 * Reduce packet size, correctly zeroing padding
3037 * @param size new size
3039 void av_shrink_packet(AVPacket *pkt, int size);
3042 * Increase packet size, correctly zeroing padding
3045 * @param grow_by number of bytes by which to increase the size of the packet
3047 int av_grow_packet(AVPacket *pkt, int grow_by);
3050 * @warning This is a hack - the packet memory allocation stuff is broken. The
3051 * packet is allocated if it was not really allocated.
3053 int av_dup_packet(AVPacket *pkt);
3058 * @param pkt packet to free
3060 void av_free_packet(AVPacket *pkt);
3063 * Allocate new information of a packet.
3066 * @param type side information type
3067 * @param size side information size
3068 * @return pointer to fresh allocated data or NULL otherwise
3070 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3074 * Get side information from packet.
3077 * @param type desired side information type
3078 * @param size pointer for side information size to store (optional)
3079 * @return pointer to data if present or NULL otherwise
3081 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3086 struct ReSampleContext;
3087 struct AVResampleContext;
3089 typedef struct ReSampleContext ReSampleContext;
3092 * Initialize audio resampling context.
3094 * @param output_channels number of output channels
3095 * @param input_channels number of input channels
3096 * @param output_rate output sample rate
3097 * @param input_rate input sample rate
3098 * @param sample_fmt_out requested output sample format
3099 * @param sample_fmt_in input sample format
3100 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3101 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3102 * @param linear if 1 then the used FIR filter will be linearly interpolated
3103 between the 2 closest, if 0 the closest will be used
3104 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3105 * @return allocated ReSampleContext, NULL if error occurred
3107 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3108 int output_rate, int input_rate,
3109 enum AVSampleFormat sample_fmt_out,
3110 enum AVSampleFormat sample_fmt_in,
3111 int filter_length, int log2_phase_count,
3112 int linear, double cutoff);
3114 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3117 * Free resample context.
3119 * @param s a non-NULL pointer to a resample context previously
3120 * created with av_audio_resample_init()
3122 void audio_resample_close(ReSampleContext *s);
3126 * Initialize an audio resampler.
3127 * Note, if either rate is not an integer then simply scale both rates up so they are.
3128 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3129 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3130 * @param linear If 1 then the used FIR filter will be linearly interpolated
3131 between the 2 closest, if 0 the closest will be used
3132 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3134 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3137 * Resample an array of samples using a previously configured context.
3138 * @param src an array of unconsumed samples
3139 * @param consumed the number of samples of src which have been consumed are returned here
3140 * @param src_size the number of unconsumed samples available
3141 * @param dst_size the amount of space in samples available in dst
3142 * @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.
3143 * @return the number of samples written in dst or -1 if an error occurred
3145 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3149 * Compensate samplerate/timestamp drift. The compensation is done by changing
3150 * the resampler parameters, so no audible clicks or similar distortions occur
3151 * @param compensation_distance distance in output samples over which the compensation should be performed
3152 * @param sample_delta number of output samples which should be output less
3154 * example: av_resample_compensate(c, 10, 500)
3155 * here instead of 510 samples only 500 samples would be output
3157 * note, due to rounding the actual compensation might be slightly different,
3158 * especially if the compensation_distance is large and the in_rate used during init is small
3160 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3161 void av_resample_close(struct AVResampleContext *c);
3164 * Allocate memory for a picture. Call avpicture_free() to free it.
3166 * @see avpicture_fill()
3168 * @param picture the picture to be filled in
3169 * @param pix_fmt the format of the picture
3170 * @param width the width of the picture
3171 * @param height the height of the picture
3172 * @return zero if successful, a negative value if not
3174 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3177 * Free a picture previously allocated by avpicture_alloc().
3178 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3181 * @param picture the AVPicture to be freed
3183 void avpicture_free(AVPicture *picture);
3186 * Fill in the AVPicture fields.
3187 * The fields of the given AVPicture are filled in by using the 'ptr' address
3188 * which points to the image data buffer. Depending on the specified picture
3189 * format, one or multiple image data pointers and line sizes will be set.
3190 * If a planar format is specified, several pointers will be set pointing to
3191 * the different picture planes and the line sizes of the different planes
3192 * will be stored in the lines_sizes array.
3193 * Call with ptr == NULL to get the required size for the ptr buffer.
3195 * To allocate the buffer and fill in the AVPicture fields in one call,
3196 * use avpicture_alloc().
3198 * @param picture AVPicture whose fields are to be filled in
3199 * @param ptr Buffer which will contain or contains the actual image data
3200 * @param pix_fmt The format in which the picture data is stored.
3201 * @param width the width of the image in pixels
3202 * @param height the height of the image in pixels
3203 * @return size of the image data in bytes
3205 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3206 enum PixelFormat pix_fmt, int width, int height);
3209 * Copy pixel data from an AVPicture into a buffer.
3210 * The data is stored compactly, without any gaps for alignment or padding
3211 * which may be applied by avpicture_fill().
3213 * @see avpicture_get_size()
3215 * @param[in] src AVPicture containing image data
3216 * @param[in] pix_fmt The format in which the picture data is stored.
3217 * @param[in] width the width of the image in pixels.
3218 * @param[in] height the height of the image in pixels.
3219 * @param[out] dest A buffer into which picture data will be copied.
3220 * @param[in] dest_size The size of 'dest'.
3221 * @return The number of bytes written to dest, or a negative value (error code) on error.
3223 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3224 unsigned char *dest, int dest_size);
3227 * Calculate the size in bytes that a picture of the given width and height
3228 * would occupy if stored in the given picture format.
3229 * Note that this returns the size of a compact representation as generated
3230 * by avpicture_layout(), which can be smaller than the size required for e.g.
3233 * @param pix_fmt the given picture format
3234 * @param width the width of the image
3235 * @param height the height of the image
3236 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3238 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3239 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3241 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3244 * Return a value representing the fourCC code associated to the
3245 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3248 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3251 * Put a string representing the codec tag codec_tag in buf.
3253 * @param buf_size size in bytes of buf
3254 * @return the length of the string that would have been generated if
3255 * enough space had been available, excluding the trailing null
3257 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3259 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3260 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3261 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3262 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3263 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3264 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3267 * Compute what kind of losses will occur when converting from one specific
3268 * pixel format to another.
3269 * When converting from one pixel format to another, information loss may occur.
3270 * For example, when converting from RGB24 to GRAY, the color information will
3271 * be lost. Similarly, other losses occur when converting from some formats to
3272 * other formats. These losses can involve loss of chroma, but also loss of
3273 * resolution, loss of color depth, loss due to the color space conversion, loss
3274 * of the alpha bits or loss due to color quantization.
3275 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3276 * which will occur when converting from one pixel format to another.
3278 * @param[in] dst_pix_fmt destination pixel format
3279 * @param[in] src_pix_fmt source pixel format
3280 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3281 * @return Combination of flags informing you what kind of losses will occur.
3283 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3287 * Find the best pixel format to convert to given a certain source pixel
3288 * format. When converting from one pixel format to another, information loss
3289 * may occur. For example, when converting from RGB24 to GRAY, the color
3290 * information will be lost. Similarly, other losses occur when converting from
3291 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3292 * the given pixel formats should be used to suffer the least amount of loss.
3293 * The pixel formats from which it chooses one, are determined by the
3294 * pix_fmt_mask parameter.
3297 * src_pix_fmt = PIX_FMT_YUV420P;
3298 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3299 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3302 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3303 * @param[in] src_pix_fmt source pixel format
3304 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3305 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3306 * @return The best pixel format to convert to or -1 if none was found.
3308 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3309 int has_alpha, int *loss_ptr);
3311 /* deinterlace a picture */
3312 /* deinterlace - if not supported return -1 */
3313 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3314 enum PixelFormat pix_fmt, int width, int height);
3316 /* external high level API */
3319 * If c is NULL, returns the first registered codec,
3320 * if c is non-NULL, returns the next registered codec after c,
3321 * or NULL if c is the last one.
3323 AVCodec *av_codec_next(AVCodec *c);
3326 * Return the LIBAVCODEC_VERSION_INT constant.
3328 unsigned avcodec_version(void);
3331 * Return the libavcodec build-time configuration.
3333 const char *avcodec_configuration(void);
3336 * Return the libavcodec license.
3338 const char *avcodec_license(void);
3341 * Register the codec codec and initialize libavcodec.
3343 * @warning either this function or avcodec_register_all() must be called
3344 * before any other libavcodec functions.
3346 * @see avcodec_register_all()
3348 void avcodec_register(AVCodec *codec);
3351 * Find a registered encoder with a matching codec ID.
3353 * @param id CodecID of the requested encoder
3354 * @return An encoder if one was found, NULL otherwise.
3356 AVCodec *avcodec_find_encoder(enum CodecID id);
3359 * Find a registered encoder with the specified name.
3361 * @param name name of the requested encoder
3362 * @return An encoder if one was found, NULL otherwise.
3364 AVCodec *avcodec_find_encoder_by_name(const char *name);
3367 * Find a registered decoder with a matching codec ID.
3369 * @param id CodecID of the requested decoder
3370 * @return A decoder if one was found, NULL otherwise.
3372 AVCodec *avcodec_find_decoder(enum CodecID id);
3375 * Find a registered decoder with the specified name.
3377 * @param name name of the requested decoder
3378 * @return A decoder if one was found, NULL otherwise.
3380 AVCodec *avcodec_find_decoder_by_name(const char *name);
3381 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3384 * Return a name for the specified profile, if available.
3386 * @param codec the codec that is searched for the given profile
3387 * @param profile the profile value for which a name is requested
3388 * @return A name for the profile if found, NULL otherwise.
3390 const char *av_get_profile_name(const AVCodec *codec, int profile);
3393 * Set the fields of the given AVCodecContext to default values corresponding
3394 * to the given codec (defaults may be codec-dependent).
3396 * Do not call this function if a non-NULL codec has been passed
3397 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3398 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3399 * different codec on this AVCodecContext.
3401 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3404 * Allocate an AVCodecContext and set its fields to default values. The
3405 * resulting struct can be deallocated by calling avcodec_close() on it followed
3408 * @param codec if non-NULL, allocate private data and initialize defaults
3409 * for the given codec. It is illegal to then call avcodec_open2()
3410 * with a different codec.
3411 * If NULL, then the codec-specific defaults won't be initialized,
3412 * which may result in suboptimal default settings (this is
3413 * important mainly for encoders, e.g. libx264).
3415 * @return An AVCodecContext filled with default values or NULL on failure.
3416 * @see avcodec_get_context_defaults
3418 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3421 * Copy the settings of the source AVCodecContext into the destination
3422 * AVCodecContext. The resulting destination codec context will be
3423 * unopened, i.e. you are required to call avcodec_open2() before you
3424 * can use this AVCodecContext to decode/encode video/audio data.
3426 * @param dest target codec context, should be initialized with
3427 * avcodec_alloc_context3(), but otherwise uninitialized
3428 * @param src source codec context
3429 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3431 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3434 * Set the fields of the given AVFrame to default values.
3436 * @param pic The AVFrame of which the fields should be set to default values.
3438 void avcodec_get_frame_defaults(AVFrame *pic);
3441 * Allocate an AVFrame and set its fields to default values. The resulting
3442 * struct can be deallocated by simply calling av_free().
3444 * @return An AVFrame filled with default values or NULL on failure.
3445 * @see avcodec_get_frame_defaults
3447 AVFrame *avcodec_alloc_frame(void);
3449 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3450 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3451 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3454 * Return the amount of padding in pixels which the get_buffer callback must
3455 * provide around the edge of the image for codecs which do not have the
3456 * CODEC_FLAG_EMU_EDGE flag.
3458 * @return Required padding in pixels.
3460 unsigned avcodec_get_edge_width(void);
3462 * Modify width and height values so that they will result in a memory
3463 * buffer that is acceptable for the codec if you do not use any horizontal
3466 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3467 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3468 * according to avcodec_get_edge_width() before.
3470 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3472 * Modify width and height values so that they will result in a memory
3473 * buffer that is acceptable for the codec if you also ensure that all
3474 * line sizes are a multiple of the respective linesize_align[i].
3476 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3477 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3478 * according to avcodec_get_edge_width() before.
3480 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3481 int linesize_align[AV_NUM_DATA_POINTERS]);
3483 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3485 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3486 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3487 //FIXME func typedef
3490 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3491 * function the context has to be allocated with avcodec_alloc_context3().
3493 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3494 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3495 * retrieving a codec.
3497 * @warning This function is not thread safe!
3500 * avcodec_register_all();
3501 * av_dict_set(&opts, "b", "2.5M", 0);
3502 * codec = avcodec_find_decoder(CODEC_ID_H264);
3506 * context = avcodec_alloc_context3(codec);
3508 * if (avcodec_open2(context, codec, opts) < 0)
3512 * @param avctx The context to initialize.
3513 * @param codec The codec to open this context for. If a non-NULL codec has been
3514 * previously passed to avcodec_alloc_context3() or
3515 * avcodec_get_context_defaults3() for this context, then this
3516 * parameter MUST be either NULL or equal to the previously passed
3518 * @param options A dictionary filled with AVCodecContext and codec-private options.
3519 * On return this object will be filled with options that were not found.
3521 * @return zero on success, a negative value on error
3522 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3523 * av_dict_set(), av_opt_find().
3525 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3527 #if FF_API_OLD_DECODE_AUDIO
3529 * Wrapper function which calls avcodec_decode_audio4.
3531 * @deprecated Use avcodec_decode_audio4 instead.
3533 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3534 * Some decoders may support multiple frames in a single AVPacket, such
3535 * decoders would then just decode the first frame. In this case,
3536 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3537 * the remaining data in order to decode the second frame etc.
3539 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3540 * decompressed frame size in bytes.
3542 * @warning You must set frame_size_ptr to the allocated size of the
3543 * output buffer before calling avcodec_decode_audio3().
3545 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3546 * the actual read bytes because some optimized bitstream readers read 32 or 64
3547 * bits at once and could read over the end.
3549 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3550 * no overreading happens for damaged MPEG streams.
3552 * @warning You must not provide a custom get_buffer() when using
3553 * avcodec_decode_audio3(). Doing so will override it with
3554 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3555 * which does allow the application to provide a custom get_buffer().
3557 * @note You might have to align the input buffer avpkt->data and output buffer
3558 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3559 * necessary at all, on others it won't work at all if not aligned and on others
3560 * it will work but it will have an impact on performance.
3562 * In practice, avpkt->data should have 4 byte alignment at minimum and
3563 * samples should be 16 byte aligned unless the CPU doesn't need it
3564 * (AltiVec and SSE do).
3566 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3567 * between input and output, these need to be fed with avpkt->data=NULL,
3568 * avpkt->size=0 at the end to return the remaining frames.
3570 * @param avctx the codec context
3571 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3572 * If the sample format is planar, each channel plane will
3573 * be the same size, with no padding between channels.
3574 * @param[in,out] frame_size_ptr the output buffer size in bytes
3575 * @param[in] avpkt The input AVPacket containing the input buffer.
3576 * You can create such packet with av_init_packet() and by then setting
3577 * data and size, some decoders might in addition need other fields.
3578 * All decoders are designed to use the least fields possible though.
3579 * @return On error a negative value is returned, otherwise the number of bytes
3580 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3582 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3583 int *frame_size_ptr,
3588 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3590 * Some decoders may support multiple frames in a single AVPacket. Such
3591 * decoders would then just decode the first frame. In this case,
3592 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3593 * the remaining data in order to decode the second frame, etc...
3594 * Even if no frames are returned, the packet needs to be fed to the decoder
3595 * with remaining data until it is completely consumed or an error occurs.
3597 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3598 * larger than the actual read bytes because some optimized bitstream
3599 * readers read 32 or 64 bits at once and could read over the end.
3601 * @note You might have to align the input buffer. The alignment requirements
3602 * depend on the CPU and the decoder.
3604 * @param avctx the codec context
3605 * @param[out] frame The AVFrame in which to store decoded audio samples.
3606 * Decoders request a buffer of a particular size by setting
3607 * AVFrame.nb_samples prior to calling get_buffer(). The
3608 * decoder may, however, only utilize part of the buffer by
3609 * setting AVFrame.nb_samples to a smaller value in the
3611 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3613 * @param[in] avpkt The input AVPacket containing the input buffer.
3614 * At least avpkt->data and avpkt->size should be set. Some
3615 * decoders might also require additional fields to be set.
3616 * @return A negative error code is returned if an error occurred during
3617 * decoding, otherwise the number of bytes consumed from the input
3618 * AVPacket is returned.
3620 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3621 int *got_frame_ptr, AVPacket *avpkt);
3624 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3625 * Some decoders may support multiple frames in a single AVPacket, such
3626 * decoders would then just decode the first frame.
3628 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3629 * the actual read bytes because some optimized bitstream readers read 32 or 64
3630 * bits at once and could read over the end.
3632 * @warning The end of the input buffer buf should be set to 0 to ensure that
3633 * no overreading happens for damaged MPEG streams.
3635 * @note You might have to align the input buffer avpkt->data.
3636 * The alignment requirements depend on the CPU: on some CPUs it isn't
3637 * necessary at all, on others it won't work at all if not aligned and on others
3638 * it will work but it will have an impact on performance.
3640 * In practice, avpkt->data should have 4 byte alignment at minimum.
3642 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3643 * between input and output, these need to be fed with avpkt->data=NULL,
3644 * avpkt->size=0 at the end to return the remaining frames.
3646 * @param avctx the codec context
3647 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3648 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3649 * allocate memory for the actual bitmap.
3650 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3651 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3652 * decodes and the decoder tells the user once it does not need the data anymore,
3653 * the user app can at this point free/reuse/keep the memory as it sees fit.
3655 * @param[in] avpkt The input AVpacket containing the input buffer.
3656 * You can create such packet with av_init_packet() and by then setting
3657 * data and size, some decoders might in addition need other fields like
3658 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3660 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3661 * @return On error a negative value is returned, otherwise the number of bytes
3662 * used or zero if no frame could be decompressed.
3664 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3665 int *got_picture_ptr,
3669 * Decode a subtitle message.
3670 * Return a negative value on error, otherwise return the number of bytes used.
3671 * If no subtitle could be decompressed, got_sub_ptr is zero.
3672 * Otherwise, the subtitle is stored in *sub.
3673 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3674 * simplicity, because the performance difference is expect to be negligible
3675 * and reusing a get_buffer written for video codecs would probably perform badly
3676 * due to a potentially very different allocation pattern.
3678 * @param avctx the codec context
3679 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3680 freed with avsubtitle_free if *got_sub_ptr is set.
3681 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3682 * @param[in] avpkt The input AVPacket containing the input buffer.
3684 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3689 * Free all allocated data in the given subtitle struct.
3691 * @param sub AVSubtitle to free.
3693 void avsubtitle_free(AVSubtitle *sub);
3695 #if FF_API_OLD_ENCODE_AUDIO
3697 * Encode an audio frame from samples into buf.
3699 * @deprecated Use avcodec_encode_audio2 instead.
3701 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3702 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3703 * will know how much space is needed because it depends on the value passed
3704 * in buf_size as described below. In that case a lower value can be used.
3706 * @param avctx the codec context
3707 * @param[out] buf the output buffer
3708 * @param[in] buf_size the output buffer size
3709 * @param[in] samples the input buffer containing the samples
3710 * The number of samples read from this buffer is frame_size*channels,
3711 * both of which are defined in avctx.
3712 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3713 * samples read from samples is equal to:
3714 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3715 * This also implies that av_get_bits_per_sample() must not return 0 for these
3717 * @return On error a negative value is returned, on success zero or the number
3718 * of bytes used to encode the data read from the input buffer.
3720 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3721 uint8_t *buf, int buf_size,
3722 const short *samples);
3726 * Encode a frame of audio.
3728 * Takes input samples from frame and writes the next output packet, if
3729 * available, to avpkt. The output packet does not necessarily contain data for
3730 * the most recent frame, as encoders can delay, split, and combine input frames
3731 * internally as needed.
3733 * @param avctx codec context
3734 * @param avpkt output AVPacket.
3735 * The user can supply an output buffer by setting
3736 * avpkt->data and avpkt->size prior to calling the
3737 * function, but if the size of the user-provided data is not
3738 * large enough, encoding will fail. All other AVPacket fields
3739 * will be reset by the encoder using av_init_packet(). If
3740 * avpkt->data is NULL, the encoder will allocate it.
3741 * The encoder will set avpkt->size to the size of the
3743 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3744 * May be NULL when flushing an encoder that has the
3745 * CODEC_CAP_DELAY capability set.
3746 * There are 2 codec capabilities that affect the allowed
3747 * values of frame->nb_samples.
3748 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
3749 * frame may be smaller than avctx->frame_size, and all other
3750 * frames must be equal to avctx->frame_size.
3751 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3752 * can have any number of samples.
3753 * If neither is set, frame->nb_samples must be equal to
3754 * avctx->frame_size for all frames.
3755 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3756 * output packet is non-empty, and to 0 if it is
3757 * empty. If the function returns an error, the
3758 * packet can be assumed to be invalid, and the
3759 * value of got_packet_ptr is undefined and should
3761 * @return 0 on success, negative error code on failure
3763 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3764 const AVFrame *frame, int *got_packet_ptr);
3767 * Fill audio frame data and linesize.
3768 * AVFrame extended_data channel pointers are allocated if necessary for
3771 * @param frame the AVFrame
3772 * frame->nb_samples must be set prior to calling the
3773 * function. This function fills in frame->data,
3774 * frame->extended_data, frame->linesize[0].
3775 * @param nb_channels channel count
3776 * @param sample_fmt sample format
3777 * @param buf buffer to use for frame data
3778 * @param buf_size size of buffer
3779 * @param align plane size sample alignment
3780 * @return 0 on success, negative error code on failure
3782 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
3783 enum AVSampleFormat sample_fmt, const uint8_t *buf,
3784 int buf_size, int align);
3786 #if FF_API_OLD_ENCODE_VIDEO
3788 * @deprecated use avcodec_encode_video2() instead.
3790 * Encode a video frame from pict into buf.
3791 * The input picture should be
3792 * stored using a specific format, namely avctx.pix_fmt.
3794 * @param avctx the codec context
3795 * @param[out] buf the output buffer for the bitstream of encoded frame
3796 * @param[in] buf_size the size of the output buffer in bytes
3797 * @param[in] pict the input picture to encode
3798 * @return On error a negative value is returned, on success zero or the number
3799 * of bytes used from the output buffer.
3801 attribute_deprecated
3802 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3803 const AVFrame *pict);
3807 * Encode a frame of video.
3809 * Takes input raw video data from frame and writes the next output packet, if
3810 * available, to avpkt. The output packet does not necessarily contain data for
3811 * the most recent frame, as encoders can delay and reorder input frames
3812 * internally as needed.
3814 * @param avctx codec context
3815 * @param avpkt output AVPacket.
3816 * The user can supply an output buffer by setting
3817 * avpkt->data and avpkt->size prior to calling the
3818 * function, but if the size of the user-provided data is not
3819 * large enough, encoding will fail. All other AVPacket fields
3820 * will be reset by the encoder using av_init_packet(). If
3821 * avpkt->data is NULL, the encoder will allocate it.
3822 * The encoder will set avpkt->size to the size of the
3823 * output packet. The returned data (if any) belongs to the
3824 * caller, he is responsible for freeing it.
3825 * @param[in] frame AVFrame containing the raw video data to be encoded.
3826 * May be NULL when flushing an encoder that has the
3827 * CODEC_CAP_DELAY capability set.
3828 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3829 * output packet is non-empty, and to 0 if it is
3830 * empty. If the function returns an error, the
3831 * packet can be assumed to be invalid, and the
3832 * value of got_packet_ptr is undefined and should
3834 * @return 0 on success, negative error code on failure
3836 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3837 const AVFrame *frame, int *got_packet_ptr);
3839 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3840 const AVSubtitle *sub);
3843 * Close a given AVCodecContext and free all the data associated with it
3844 * (but not the AVCodecContext itself).
3846 * Calling this function on an AVCodecContext that hasn't been opened will free
3847 * the codec-specific data allocated in avcodec_alloc_context3() /
3848 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3851 int avcodec_close(AVCodecContext *avctx);
3854 * Register all the codecs, parsers and bitstream filters which were enabled at
3855 * configuration time. If you do not call this function you can select exactly
3856 * which formats you want to support, by using the individual registration
3859 * @see avcodec_register
3860 * @see av_register_codec_parser
3861 * @see av_register_bitstream_filter
3863 void avcodec_register_all(void);
3866 * Flush buffers, should be called when seeking or when switching to a different stream.
3868 void avcodec_flush_buffers(AVCodecContext *avctx);
3870 void avcodec_default_free_buffers(AVCodecContext *s);
3872 /* misc useful functions */
3875 * Return codec bits per sample.
3877 * @param[in] codec_id the codec
3878 * @return Number of bits per sample or zero if unknown for the given codec.
3880 int av_get_bits_per_sample(enum CodecID codec_id);
3883 typedef struct AVCodecParserContext {
3885 struct AVCodecParser *parser;
3886 int64_t frame_offset; /* offset of the current frame */
3887 int64_t cur_offset; /* current offset
3888 (incremented by each av_parser_parse()) */
3889 int64_t next_frame_offset; /* offset of the next frame */
3891 int pict_type; /* XXX: Put it back in AVCodecContext. */
3893 * This field is used for proper frame duration computation in lavf.
3894 * It signals, how much longer the frame duration of the current frame
3895 * is compared to normal frame duration.
3897 * frame_duration = (1 + repeat_pict) * time_base
3899 * It is used by codecs like H.264 to display telecined material.
3901 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3902 int64_t pts; /* pts of the current frame */
3903 int64_t dts; /* dts of the current frame */
3908 int fetch_timestamp;
3910 #define AV_PARSER_PTS_NB 4
3911 int cur_frame_start_index;
3912 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3913 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3914 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3917 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3918 #define PARSER_FLAG_ONCE 0x0002
3919 /// Set if the parser has a valid file offset
3920 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3922 int64_t offset; ///< byte offset from starting packet start
3923 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3926 * Set by parser to 1 for key frames and 0 for non-key frames.
3927 * It is initialized to -1, so if the parser doesn't set this flag,
3928 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3934 * Time difference in stream time base units from the pts of this
3935 * packet to the point at which the output from the decoder has converged
3936 * independent from the availability of previous frames. That is, the
3937 * frames are virtually identical no matter if decoding started from
3938 * the very first frame or from this keyframe.
3939 * Is AV_NOPTS_VALUE if unknown.
3940 * This field is not the display duration of the current frame.
3941 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3944 * The purpose of this field is to allow seeking in streams that have no
3945 * keyframes in the conventional sense. It corresponds to the
3946 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3947 * essential for some types of subtitle streams to ensure that all
3948 * subtitles are correctly displayed after seeking.
3950 int64_t convergence_duration;
3952 // Timestamp generation support:
3954 * Synchronization point for start of timestamp generation.
3956 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3959 * For example, this corresponds to presence of H.264 buffering period
3965 * Offset of the current timestamp against last timestamp sync point in
3966 * units of AVCodecContext.time_base.
3968 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3969 * contain a valid timestamp offset.
3971 * Note that the timestamp of sync point has usually a nonzero
3972 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3973 * the next frame after timestamp sync point will be usually 1.
3975 * For example, this corresponds to H.264 cpb_removal_delay.
3977 int dts_ref_dts_delta;
3980 * Presentation delay of current frame in units of AVCodecContext.time_base.
3982 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3983 * contain valid non-negative timestamp delta (presentation time of a frame
3984 * must not lie in the past).
3986 * This delay represents the difference between decoding and presentation
3987 * time of the frame.
3989 * For example, this corresponds to H.264 dpb_output_delay.
3994 * Position of the packet in file.
3996 * Analogous to cur_frame_pts/dts
3998 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4001 * Byte position of currently parsed frame in stream.
4006 * Previous frame byte position.
4011 * Duration of the current frame.
4012 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4013 * For all other types, this is in units of AVCodecContext.time_base.
4016 } AVCodecParserContext;
4018 typedef struct AVCodecParser {
4019 int codec_ids[5]; /* several codec IDs are permitted */
4021 int (*parser_init)(AVCodecParserContext *s);
4022 int (*parser_parse)(AVCodecParserContext *s,
4023 AVCodecContext *avctx,
4024 const uint8_t **poutbuf, int *poutbuf_size,
4025 const uint8_t *buf, int buf_size);
4026 void (*parser_close)(AVCodecParserContext *s);
4027 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4028 struct AVCodecParser *next;
4031 AVCodecParser *av_parser_next(AVCodecParser *c);
4033 void av_register_codec_parser(AVCodecParser *parser);
4034 AVCodecParserContext *av_parser_init(int codec_id);
4039 * @param s parser context.
4040 * @param avctx codec context.
4041 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4042 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4043 * @param buf input buffer.
4044 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4045 * @param pts input presentation timestamp.
4046 * @param dts input decoding timestamp.
4047 * @param pos input byte position in stream.
4048 * @return the number of bytes of the input bitstream used.
4053 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4060 * decode_frame(data, size);
4064 int av_parser_parse2(AVCodecParserContext *s,
4065 AVCodecContext *avctx,
4066 uint8_t **poutbuf, int *poutbuf_size,
4067 const uint8_t *buf, int buf_size,
4068 int64_t pts, int64_t dts,
4071 int av_parser_change(AVCodecParserContext *s,
4072 AVCodecContext *avctx,
4073 uint8_t **poutbuf, int *poutbuf_size,
4074 const uint8_t *buf, int buf_size, int keyframe);
4075 void av_parser_close(AVCodecParserContext *s);
4078 typedef struct AVBitStreamFilterContext {
4080 struct AVBitStreamFilter *filter;
4081 AVCodecParserContext *parser;
4082 struct AVBitStreamFilterContext *next;
4083 } AVBitStreamFilterContext;
4086 typedef struct AVBitStreamFilter {
4089 int (*filter)(AVBitStreamFilterContext *bsfc,
4090 AVCodecContext *avctx, const char *args,
4091 uint8_t **poutbuf, int *poutbuf_size,
4092 const uint8_t *buf, int buf_size, int keyframe);
4093 void (*close)(AVBitStreamFilterContext *bsfc);
4094 struct AVBitStreamFilter *next;
4095 } AVBitStreamFilter;
4097 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4098 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4099 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4100 AVCodecContext *avctx, const char *args,
4101 uint8_t **poutbuf, int *poutbuf_size,
4102 const uint8_t *buf, int buf_size, int keyframe);
4103 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4105 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4110 * Reallocate the given block if it is not large enough, otherwise do nothing.
4114 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4117 * Allocate a buffer, reusing the given one if large enough.
4119 * Contrary to av_fast_realloc the current buffer contents might not be
4120 * preserved and on error the old buffer is freed, thus no special
4121 * handling to avoid memleaks is necessary.
4123 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4124 * @param size size of the buffer *ptr points to
4125 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4126 * *size 0 if an error occurred.
4128 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4131 * Allocate a buffer with padding, reusing the given one if large enough.
4133 * Same behaviour av_fast_malloc but the buffer has additional
4134 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4137 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4140 * Copy image src to dst. Wraps av_picture_data_copy() above.
4142 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4143 enum PixelFormat pix_fmt, int width, int height);
4146 * Crop image top and left side.
4148 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4149 enum PixelFormat pix_fmt, int top_band, int left_band);
4154 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4155 int padtop, int padbottom, int padleft, int padright, int *color);
4158 * Encode extradata length to a buffer. Used by xiph codecs.
4160 * @param s buffer to write to; must be at least (v/255+1) bytes long
4161 * @param v size of extradata in bytes
4162 * @return number of bytes written to the buffer.
4164 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4167 * Log a generic warning message about a missing feature. This function is
4168 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4169 * only, and would normally not be used by applications.
4170 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4171 * a pointer to an AVClass struct
4172 * @param[in] feature string containing the name of the missing feature
4173 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4174 * If want_sample is non-zero, additional verbage will be added to the log
4175 * message which tells the user how to report samples to the development
4178 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4181 * Log a generic warning message asking for a sample. This function is
4182 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4183 * only, and would normally not be used by applications.
4184 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4185 * a pointer to an AVClass struct
4186 * @param[in] msg string containing an optional message, or NULL if no message
4188 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4191 * Register the hardware accelerator hwaccel.
4193 void av_register_hwaccel(AVHWAccel *hwaccel);
4196 * If hwaccel is NULL, returns the first registered hardware accelerator,
4197 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4198 * after hwaccel, or NULL if hwaccel is the last one.
4200 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4204 * Lock operation used by lockmgr
4207 AV_LOCK_CREATE, ///< Create a mutex
4208 AV_LOCK_OBTAIN, ///< Lock the mutex
4209 AV_LOCK_RELEASE, ///< Unlock the mutex
4210 AV_LOCK_DESTROY, ///< Free mutex resources
4214 * Register a user provided lock manager supporting the operations
4215 * specified by AVLockOp. mutex points to a (void *) where the
4216 * lockmgr should store/get a pointer to a user allocated mutex. It's
4217 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4219 * @param cb User defined callback. Note: Libav may invoke calls to this
4220 * callback during the call to av_lockmgr_register().
4221 * Thus, the application must be prepared to handle that.
4222 * If cb is set to NULL the lockmgr will be unregistered.
4223 * Also note that during unregistration the previously registered
4224 * lockmgr callback may also be invoked.
4226 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4229 * Get the type of the given codec.
4231 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4234 * Get the AVClass for AVCodecContext. It can be used in combination with
4235 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4237 * @see av_opt_find().
4239 const AVClass *avcodec_get_class(void);
4242 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4243 * with no corresponding avcodec_close()), 0 otherwise.
4245 int avcodec_is_open(AVCodecContext *s);
4247 #endif /* AVCODEC_AVCODEC_H */