2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * Libav is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
40 * @defgroup libavc Encoding/Decoding Library
43 * @defgroup lavc_decoding Decoding
47 * @defgroup lavc_encoding Encoding
51 * @defgroup lavc_codec Codecs
53 * @defgroup lavc_codec_native Native Codecs
56 * @defgroup lavc_codec_wrappers External library wrappers
59 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
63 * @defgroup lavc_internal Internal
72 * Identify the syntax and semantics of the bitstream.
73 * The principle is roughly:
74 * Two decoders with the same ID can decode the same streams.
75 * Two encoders with the same ID can encode compatible streams.
76 * There may be slight deviations from the principle due to implementation
79 * If you add a codec ID to this list, add it so that
80 * 1. no value of a existing codec ID changes (that would break ABI),
81 * 2. it is as close as possible to similar codecs.
88 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
89 CODEC_ID_MPEG2VIDEO_XVMC,
126 CODEC_ID_INTERPLAY_VIDEO,
138 CODEC_ID_TRUEMOTION1,
165 CODEC_ID_TRUEMOTION2,
182 CODEC_ID_DSICINVIDEO,
183 CODEC_ID_TIERTEXSEQVIDEO,
186 #if LIBAVCODEC_VERSION_MAJOR == 53
194 CODEC_ID_BETHSOFTVID,
206 #if LIBAVCODEC_VERSION_MAJOR == 53
214 CODEC_ID_MOTIONPIXELS,
232 CODEC_ID_IFF_BYTERUN1,
248 #if LIBAVCODEC_VERSION_MAJOR == 53
259 /* various PCM "codecs" */
260 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
261 CODEC_ID_PCM_S16LE = 0x10000,
277 CODEC_ID_PCM_S24DAUD,
279 CODEC_ID_PCM_S16LE_PLANAR,
288 CODEC_ID_PCM_S8_PLANAR,
290 /* various ADPCM codecs */
291 CODEC_ID_ADPCM_IMA_QT = 0x11000,
292 CODEC_ID_ADPCM_IMA_WAV,
293 CODEC_ID_ADPCM_IMA_DK3,
294 CODEC_ID_ADPCM_IMA_DK4,
295 CODEC_ID_ADPCM_IMA_WS,
296 CODEC_ID_ADPCM_IMA_SMJPEG,
305 CODEC_ID_ADPCM_YAMAHA,
306 CODEC_ID_ADPCM_SBPRO_4,
307 CODEC_ID_ADPCM_SBPRO_3,
308 CODEC_ID_ADPCM_SBPRO_2,
310 CODEC_ID_ADPCM_IMA_AMV,
311 CODEC_ID_ADPCM_EA_R1,
312 CODEC_ID_ADPCM_EA_R3,
313 CODEC_ID_ADPCM_EA_R2,
314 CODEC_ID_ADPCM_IMA_EA_SEAD,
315 CODEC_ID_ADPCM_IMA_EA_EACS,
316 CODEC_ID_ADPCM_EA_XAS,
317 CODEC_ID_ADPCM_EA_MAXIS_XA,
318 CODEC_ID_ADPCM_IMA_ISS,
320 CODEC_ID_ADPCM_IMA_APC,
323 CODEC_ID_AMR_NB = 0x12000,
326 /* RealAudio codecs*/
327 CODEC_ID_RA_144 = 0x13000,
330 /* various DPCM codecs */
331 CODEC_ID_ROQ_DPCM = 0x14000,
332 CODEC_ID_INTERPLAY_DPCM,
337 CODEC_ID_MP2 = 0x15000,
338 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
349 #if LIBAVCODEC_VERSION_MAJOR == 53
358 CODEC_ID_WESTWOOD_SND1,
359 CODEC_ID_GSM, ///< as in Berlin toast format
367 CODEC_ID_DSICINAUDIO,
371 CODEC_ID_GSM_MS, /* as found in WAV */
380 CODEC_ID_WMALOSSLESS,
389 CODEC_ID_BINKAUDIO_RDFT,
390 CODEC_ID_BINKAUDIO_DCT,
394 #if LIBAVCODEC_VERSION_MAJOR > 53
402 /* subtitle codecs */
403 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
404 CODEC_ID_DVD_SUBTITLE = 0x17000,
405 CODEC_ID_DVB_SUBTITLE,
406 CODEC_ID_TEXT, ///< raw UTF-8 text
410 CODEC_ID_HDMV_PGS_SUBTITLE,
411 CODEC_ID_DVB_TELETEXT,
414 /* other specific kind of codecs (generally used for attachments) */
415 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
416 CODEC_ID_TTF = 0x18000,
418 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
420 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
421 * stream (only used by libavformat) */
422 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
423 * stream (only used by libavformat) */
424 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
427 #if FF_API_OLD_DECODE_AUDIO
429 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
433 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
434 * This is mainly needed because some optimized bitstream readers read
435 * 32 or 64 bit at once and could read over the end.<br>
436 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
437 * MPEG bitstreams could cause overread and segfault.
439 #define FF_INPUT_BUFFER_PADDING_SIZE 8
442 * minimum encoding buffer size
443 * Used to avoid some checks during header writing.
445 #define FF_MIN_BUFFER_SIZE 16384
449 * motion estimation type.
452 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
456 ME_EPZS, ///< enhanced predictive zonal search
457 ME_X1, ///< reserved for experiments
458 ME_HEX, ///< hexagon based search
459 ME_UMH, ///< uneven multi-hexagon search
460 ME_ITER, ///< iterative search
461 ME_TESA, ///< transformed exhaustive search algorithm
465 /* We leave some space between them for extensions (drop some
466 * keyframes for intra-only or drop just some bidir frames). */
467 AVDISCARD_NONE =-16, ///< discard nothing
468 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
469 AVDISCARD_NONREF = 8, ///< discard all non reference
470 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
471 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
472 AVDISCARD_ALL = 48, ///< discard all
475 enum AVColorPrimaries{
476 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
477 AVCOL_PRI_UNSPECIFIED=2,
479 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
480 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
481 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
483 AVCOL_PRI_NB , ///< Not part of ABI
486 enum AVColorTransferCharacteristic{
487 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
488 AVCOL_TRC_UNSPECIFIED=2,
489 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
490 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
491 AVCOL_TRC_NB , ///< Not part of ABI
496 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
497 AVCOL_SPC_UNSPECIFIED=2,
499 AVCOL_SPC_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
500 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
501 AVCOL_SPC_SMPTE240M =7,
502 AVCOL_SPC_NB , ///< Not part of ABI
506 AVCOL_RANGE_UNSPECIFIED=0,
507 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
508 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
509 AVCOL_RANGE_NB , ///< Not part of ABI
513 * X X 3 4 X X are luma samples,
514 * 1 2 1-6 are possible chroma positions
515 * X X 5 6 X 0 is undefined/unknown position
517 enum AVChromaLocation{
518 AVCHROMA_LOC_UNSPECIFIED=0,
519 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
520 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
521 AVCHROMA_LOC_TOPLEFT =3, ///< DV
523 AVCHROMA_LOC_BOTTOMLEFT =5,
524 AVCHROMA_LOC_BOTTOM =6,
525 AVCHROMA_LOC_NB , ///< Not part of ABI
528 enum AVAudioServiceType {
529 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
530 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
531 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
532 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
533 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
534 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
535 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
536 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
537 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
538 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
541 typedef struct RcOverride{
544 int qscale; // If this is 0 then quality_factor will be used instead.
545 float quality_factor;
548 #define FF_MAX_B_FRAMES 16
551 These flags can be passed in AVCodecContext.flags before initialization.
552 Note: Not everything is supported yet.
555 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
556 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
557 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
558 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
559 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
561 * The parent program guarantees that the input for B-frames containing
562 * streams is not written to for at least s->max_b_frames+1 frames, if
563 * this is not set the input will be copied.
565 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
566 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
567 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
568 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
569 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
570 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
571 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
572 location instead of only at frame boundaries. */
573 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
574 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
575 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
576 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
577 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
578 /* Fx : Flag for h263+ extra options */
579 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
580 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
581 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
582 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
583 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
584 #define CODEC_FLAG_CLOSED_GOP 0x80000000
585 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
586 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
587 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
588 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
589 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
590 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
592 * @defgroup deprecated_flags Deprecated codec flags
593 * Use corresponding private codec options instead.
596 #if FF_API_MJPEG_GLOBAL_OPTS
597 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
603 /* Unsupported options :
604 * Syntax Arithmetic coding (SAC)
605 * Reference Picture Selection
606 * Independent Segment Decoding */
608 /* codec capabilities */
610 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
612 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
613 * If not set, it might not use get_buffer() at all or use operations that
614 * assume the buffer was allocated by avcodec_default_get_buffer.
616 #define CODEC_CAP_DR1 0x0002
617 #if FF_API_PARSE_FRAME
618 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
619 #define CODEC_CAP_PARSE_ONLY 0x0004
621 #define CODEC_CAP_TRUNCATED 0x0008
622 /* Codec can export data for HW decoding (XvMC). */
623 #define CODEC_CAP_HWACCEL 0x0010
625 * Encoder or decoder requires flushing with NULL input at the end in order to
626 * give the complete and correct output.
628 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
629 * with NULL data. The user can still send NULL data to the public encode
630 * or decode function, but libavcodec will not pass it along to the codec
631 * unless this flag is set.
634 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
635 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
639 * The encoder needs to be fed with NULL data at the end of encoding until the
640 * encoder no longer returns data.
642 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
643 * flag also means that the encoder must set the pts and duration for
644 * each output packet. If this flag is not set, the pts and duration will
645 * be determined by libavcodec from the input frame.
647 #define CODEC_CAP_DELAY 0x0020
649 * Codec can be fed a final frame with a smaller size.
650 * This can be used to prevent truncation of the last audio samples.
652 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
654 * Codec can export data for HW decoding (VDPAU).
656 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
658 * Codec can output multiple frames per AVPacket
659 * Normally demuxers return one frame at a time, demuxers which do not do
660 * are connected to a parser to split what they return into proper frames.
661 * This flag is reserved to the very rare category of codecs which have a
662 * bitstream that cannot be split into frames without timeconsuming
663 * operations like full decoding. Demuxers carring such bitstreams thus
664 * may return multiple frames in a packet. This has many disadvantages like
665 * prohibiting stream copy in many cases thus it should only be considered
668 #define CODEC_CAP_SUBFRAMES 0x0100
670 * Codec is experimental and is thus avoided in favor of non experimental
673 #define CODEC_CAP_EXPERIMENTAL 0x0200
675 * Codec should fill in channel configuration and samplerate instead of container
677 #define CODEC_CAP_CHANNEL_CONF 0x0400
679 * Codec is able to deal with negative linesizes
681 #define CODEC_CAP_NEG_LINESIZES 0x0800
683 * Codec supports frame-level multithreading.
685 #define CODEC_CAP_FRAME_THREADS 0x1000
687 * Codec supports slice-based (or partition-based) multithreading.
689 #define CODEC_CAP_SLICE_THREADS 0x2000
691 * Codec supports changed parameters at any point.
693 #define CODEC_CAP_PARAM_CHANGE 0x4000
695 * Codec supports avctx->thread_count == 0 (auto).
697 #define CODEC_CAP_AUTO_THREADS 0x8000
699 * Audio encoder supports receiving a different number of samples in each call.
701 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
703 //The following defines may change, don't expect compatibility if you use them.
704 #define MB_TYPE_INTRA4x4 0x0001
705 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
706 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
707 #define MB_TYPE_16x16 0x0008
708 #define MB_TYPE_16x8 0x0010
709 #define MB_TYPE_8x16 0x0020
710 #define MB_TYPE_8x8 0x0040
711 #define MB_TYPE_INTERLACED 0x0080
712 #define MB_TYPE_DIRECT2 0x0100 //FIXME
713 #define MB_TYPE_ACPRED 0x0200
714 #define MB_TYPE_GMC 0x0400
715 #define MB_TYPE_SKIP 0x0800
716 #define MB_TYPE_P0L0 0x1000
717 #define MB_TYPE_P1L0 0x2000
718 #define MB_TYPE_P0L1 0x4000
719 #define MB_TYPE_P1L1 0x8000
720 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
721 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
722 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
723 #define MB_TYPE_QUANT 0x00010000
724 #define MB_TYPE_CBP 0x00020000
725 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
729 * This specifies the area which should be displayed.
730 * Note there may be multiple such areas for one frame.
732 typedef struct AVPanScan{
735 * - encoding: Set by user.
736 * - decoding: Set by libavcodec.
741 * width and height in 1/16 pel
742 * - encoding: Set by user.
743 * - decoding: Set by libavcodec.
749 * position of the top left corner in 1/16 pel for up to 3 fields/frames
750 * - encoding: Set by user.
751 * - decoding: Set by libavcodec.
753 int16_t position[3][2];
756 #define FF_QSCALE_TYPE_MPEG1 0
757 #define FF_QSCALE_TYPE_MPEG2 1
758 #define FF_QSCALE_TYPE_H264 2
759 #define FF_QSCALE_TYPE_VP56 3
761 #define FF_BUFFER_TYPE_INTERNAL 1
762 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
763 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
764 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
766 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
767 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
768 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
769 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
771 enum AVPacketSideDataType {
773 AV_PKT_DATA_NEW_EXTRADATA,
774 AV_PKT_DATA_PARAM_CHANGE,
777 typedef struct AVPacket {
779 * Presentation timestamp in AVStream->time_base units; the time at which
780 * the decompressed packet will be presented to the user.
781 * Can be AV_NOPTS_VALUE if it is not stored in the file.
782 * pts MUST be larger or equal to dts as presentation cannot happen before
783 * decompression, unless one wants to view hex dumps. Some formats misuse
784 * the terms dts and pts/cts to mean something different. Such timestamps
785 * must be converted to true pts/dts before they are stored in AVPacket.
789 * Decompression timestamp in AVStream->time_base units; the time at which
790 * the packet is decompressed.
791 * Can be AV_NOPTS_VALUE if it is not stored in the file.
798 * A combination of AV_PKT_FLAG values
802 * Additional packet data that can be provided by the container.
803 * Packet can contain several types of side information.
808 enum AVPacketSideDataType type;
813 * Duration of this packet in AVStream->time_base units, 0 if unknown.
814 * Equals next_pts - this_pts in presentation order.
817 void (*destruct)(struct AVPacket *);
819 int64_t pos; ///< byte position in stream, -1 if unknown
822 * Time difference in AVStream->time_base units from the pts of this
823 * packet to the point at which the output from the decoder has converged
824 * independent from the availability of previous frames. That is, the
825 * frames are virtually identical no matter if decoding started from
826 * the very first frame or from this keyframe.
827 * Is AV_NOPTS_VALUE if unknown.
828 * This field is not the display duration of the current packet.
829 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
832 * The purpose of this field is to allow seeking in streams that have no
833 * keyframes in the conventional sense. It corresponds to the
834 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
835 * essential for some types of subtitle streams to ensure that all
836 * subtitles are correctly displayed after seeking.
838 int64_t convergence_duration;
840 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
841 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
844 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
846 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
847 * s32le channel_count
848 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
849 * u64le channel_layout
850 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
852 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
857 enum AVSideDataParamChangeFlags {
858 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
859 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
860 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
861 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
866 * New fields can be added to the end of AVFRAME with minor version
867 * bumps. Removal, reordering and changes to existing fields require
868 * a major version bump.
869 * sizeof(AVFrame) must not be used outside libav*.
871 typedef struct AVFrame {
872 #if FF_API_DATA_POINTERS
873 #define AV_NUM_DATA_POINTERS 4
875 #define AV_NUM_DATA_POINTERS 8
878 * pointer to the picture/channel planes.
879 * This might be different from the first allocated byte
880 * - encoding: Set by user
881 * - decoding: set by AVCodecContext.get_buffer()
883 uint8_t *data[AV_NUM_DATA_POINTERS];
886 * Size, in bytes, of the data for each picture/channel plane.
888 * For audio, only linesize[0] may be set. For planar audio, each channel
889 * plane must be the same size.
891 * - encoding: Set by user (video only)
892 * - decoding: set by AVCodecContext.get_buffer()
894 int linesize[AV_NUM_DATA_POINTERS];
897 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
898 * This isn't used by libavcodec unless the default get/release_buffer() is used.
902 uint8_t *base[AV_NUM_DATA_POINTERS];
904 * 1 -> keyframe, 0-> not
905 * - encoding: Set by libavcodec.
906 * - decoding: Set by libavcodec.
911 * Picture type of the frame, see ?_TYPE below.
912 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
913 * - decoding: Set by libavcodec.
915 enum AVPictureType pict_type;
918 * presentation timestamp in time_base units (time when frame should be shown to user)
919 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
920 * - encoding: MUST be set by user.
921 * - decoding: Set by libavcodec.
926 * picture number in bitstream order
928 * - decoding: Set by libavcodec.
930 int coded_picture_number;
932 * picture number in display order
934 * - decoding: Set by libavcodec.
936 int display_picture_number;
939 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
940 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
941 * - decoding: Set by libavcodec.
945 #if FF_API_AVFRAME_AGE
949 attribute_deprecated int age;
953 * is this picture used as reference
954 * The values for this are the same as the MpegEncContext.picture_structure
955 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
956 * Set to 4 for delayed, non-reference frames.
958 * - decoding: Set by libavcodec. (before get_buffer() call)).
965 * - decoding: Set by libavcodec.
967 int8_t *qscale_table;
971 * - decoding: Set by libavcodec.
976 * mbskip_table[mb]>=1 if MB didn't change
977 * stride= mb_width = (width+15)>>4
979 * - decoding: Set by libavcodec.
981 uint8_t *mbskip_table;
984 * motion vector table
987 * int mv_sample_log2= 4 - motion_subsample_log2;
988 * int mb_width= (width+15)>>4;
989 * int mv_stride= (mb_width << mv_sample_log2) + 1;
990 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
992 * - encoding: Set by user.
993 * - decoding: Set by libavcodec.
995 int16_t (*motion_val[2])[2];
998 * macroblock type table
999 * mb_type_base + mb_width + 2
1000 * - encoding: Set by user.
1001 * - decoding: Set by libavcodec.
1006 * log2 of the size of the block which a single vector in motion_val represents:
1007 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1008 * - encoding: unused
1009 * - decoding: Set by libavcodec.
1011 uint8_t motion_subsample_log2;
1014 * for some private data of the user
1015 * - encoding: unused
1016 * - decoding: Set by user.
1022 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1023 * - decoding: unused
1025 uint64_t error[AV_NUM_DATA_POINTERS];
1028 * type of the buffer (to keep track of who has to deallocate data[*])
1029 * - encoding: Set by the one who allocates it.
1030 * - decoding: Set by the one who allocates it.
1031 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1036 * When decoding, this signals how much the picture must be delayed.
1037 * extra_delay = repeat_pict / (2*fps)
1038 * - encoding: unused
1039 * - decoding: Set by libavcodec.
1049 * The content of the picture is interlaced.
1050 * - encoding: Set by user.
1051 * - decoding: Set by libavcodec. (default 0)
1053 int interlaced_frame;
1056 * If the content is interlaced, is top field displayed first.
1057 * - encoding: Set by user.
1058 * - decoding: Set by libavcodec.
1060 int top_field_first;
1064 * - encoding: Set by user.
1065 * - decoding: Set by libavcodec.
1067 AVPanScan *pan_scan;
1070 * Tell user application that palette has changed from previous frame.
1071 * - encoding: ??? (no palette-enabled encoder yet)
1072 * - decoding: Set by libavcodec. (default 0).
1074 int palette_has_changed;
1077 * codec suggestion on buffer type if != 0
1078 * - encoding: unused
1079 * - decoding: Set by libavcodec. (before get_buffer() call)).
1085 * - encoding: unused
1086 * - decoding: Set by libavcodec.
1091 * motion reference frame index
1092 * the order in which these are stored can depend on the codec.
1093 * - encoding: Set by user.
1094 * - decoding: Set by libavcodec.
1096 int8_t *ref_index[2];
1099 * reordered opaque 64bit (generally an integer or a double precision float
1100 * PTS but can be anything).
1101 * The user sets AVCodecContext.reordered_opaque to represent the input at
1103 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1104 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1105 * @deprecated in favor of pkt_pts
1106 * - encoding: unused
1107 * - decoding: Read by user.
1109 int64_t reordered_opaque;
1112 * hardware accelerator private data (Libav-allocated)
1113 * - encoding: unused
1114 * - decoding: Set by libavcodec
1116 void *hwaccel_picture_private;
1119 * reordered pts from the last AVPacket that has been input into the decoder
1120 * - encoding: unused
1121 * - decoding: Read by user.
1126 * dts from the last AVPacket that has been input into the decoder
1127 * - encoding: unused
1128 * - decoding: Read by user.
1133 * the AVCodecContext which ff_thread_get_buffer() was last called on
1134 * - encoding: Set by libavcodec.
1135 * - decoding: Set by libavcodec.
1137 struct AVCodecContext *owner;
1140 * used by multithreading to store frame-specific info
1141 * - encoding: Set by libavcodec.
1142 * - decoding: Set by libavcodec.
1144 void *thread_opaque;
1147 * number of audio samples (per channel) described by this frame
1148 * - encoding: unused
1149 * - decoding: Set by libavcodec
1154 * pointers to the data planes/channels.
1156 * For video, this should simply point to data[].
1158 * For planar audio, each channel has a separate data pointer, and
1159 * linesize[0] contains the size of each channel buffer.
1160 * For packed audio, there is just one data pointer, and linesize[0]
1161 * contains the total size of the buffer for all channels.
1163 * Note: Both data and extended_data will always be set by get_buffer(),
1164 * but for planar audio with more channels that can fit in data,
1165 * extended_data must be used by the decoder in order to access all
1169 * decoding: set by AVCodecContext.get_buffer()
1171 uint8_t **extended_data;
1174 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1175 * - encoding: unused
1176 * - decoding: Read by user.
1178 AVRational sample_aspect_ratio;
1181 * width and height of the video frame
1182 * - encoding: unused
1183 * - decoding: Read by user.
1188 * format of the frame, -1 if unknown or unset
1189 * Values correspond to enum PixelFormat for video frames,
1190 * enum AVSampleFormat for audio)
1191 * - encoding: unused
1192 * - decoding: Read by user.
1197 struct AVCodecInternal;
1201 AV_FIELD_PROGRESSIVE,
1202 AV_FIELD_TT, //< Top coded_first, top displayed first
1203 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1204 AV_FIELD_TB, //< Top coded first, bottom displayed first
1205 AV_FIELD_BT, //< Bottom coded first, top displayed first
1209 * main external API structure.
1210 * New fields can be added to the end with minor version bumps.
1211 * Removal, reordering and changes to existing fields require a major
1213 * sizeof(AVCodecContext) must not be used outside libav*.
1215 typedef struct AVCodecContext {
1217 * information on struct for av_log
1218 * - set by avcodec_alloc_context3
1220 const AVClass *av_class;
1222 * the average bitrate
1223 * - encoding: Set by user; unused for constant quantizer encoding.
1224 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1229 * number of bits the bitstream is allowed to diverge from the reference.
1230 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1231 * - encoding: Set by user; unused for constant quantizer encoding.
1232 * - decoding: unused
1234 int bit_rate_tolerance;
1238 * - encoding: Set by user.
1239 * - decoding: Set by user.
1244 * Some codecs need additional format info. It is stored here.
1245 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1246 * specific codec MUST set it correctly otherwise stream copy breaks.
1247 * In general use of this field by muxers is not recommended.
1248 * - encoding: Set by libavcodec.
1249 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1254 * Motion estimation algorithm used for video coding.
1255 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1256 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1257 * - encoding: MUST be set by user.
1258 * - decoding: unused
1263 * some codecs need / can use extradata like Huffman tables.
1264 * mjpeg: Huffman tables
1265 * rv10: additional flags
1266 * mpeg4: global headers (they can be in the bitstream or here)
1267 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1268 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1269 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1270 * - encoding: Set/allocated/freed by libavcodec.
1271 * - decoding: Set/allocated/freed by user.
1277 * This is the fundamental unit of time (in seconds) in terms
1278 * of which frame timestamps are represented. For fixed-fps content,
1279 * timebase should be 1/framerate and timestamp increments should be
1281 * - encoding: MUST be set by user.
1282 * - decoding: Set by libavcodec.
1284 AVRational time_base;
1288 * picture width / height.
1289 * - encoding: MUST be set by user.
1290 * - decoding: Set by libavcodec.
1291 * Note: For compatibility it is possible to set this instead of
1292 * coded_width/height before decoding.
1296 #define FF_ASPECT_EXTENDED 15
1299 * the number of pictures in a group of pictures, or 0 for intra_only
1300 * - encoding: Set by user.
1301 * - decoding: unused
1306 * Pixel format, see PIX_FMT_xxx.
1307 * May be set by the demuxer if known from headers.
1308 * May be overriden by the decoder if it knows better.
1309 * - encoding: Set by user.
1310 * - decoding: Set by user if known, overridden by libavcodec if known
1312 enum PixelFormat pix_fmt;
1315 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1316 * decoder to draw a horizontal band. It improves cache usage. Not
1317 * all codecs can do that. You must check the codec capabilities
1319 * When multithreading is used, it may be called from multiple threads
1320 * at the same time; threads might draw different parts of the same AVFrame,
1321 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1323 * The function is also used by hardware acceleration APIs.
1324 * It is called at least once during frame decoding to pass
1325 * the data needed for hardware render.
1326 * In that mode instead of pixel data, AVFrame points to
1327 * a structure specific to the acceleration API. The application
1328 * reads the structure and can change some fields to indicate progress
1330 * - encoding: unused
1331 * - decoding: Set by user.
1332 * @param height the height of the slice
1333 * @param y the y position of the slice
1334 * @param type 1->top field, 2->bottom field, 3->frame
1335 * @param offset offset into the AVFrame.data from which the slice should be read
1337 void (*draw_horiz_band)(struct AVCodecContext *s,
1338 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1339 int y, int type, int height);
1342 int sample_rate; ///< samples per second
1343 int channels; ///< number of audio channels
1346 * audio sample format
1347 * - encoding: Set by user.
1348 * - decoding: Set by libavcodec.
1350 enum AVSampleFormat sample_fmt; ///< sample format
1352 /* The following data should not be initialized. */
1354 * Samples per packet, initialized when calling 'init'.
1357 int frame_number; ///< audio or video frame number
1360 * Number of frames the decoded output will be delayed relative to
1361 * the encoded input.
1362 * - encoding: Set by libavcodec.
1363 * - decoding: unused
1367 /* - encoding parameters */
1368 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1369 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1373 * - encoding: Set by user.
1374 * - decoding: unused
1380 * - encoding: Set by user.
1381 * - decoding: unused
1386 * maximum quantizer difference between frames
1387 * - encoding: Set by user.
1388 * - decoding: unused
1393 * maximum number of B-frames between non-B-frames
1394 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1395 * - encoding: Set by user.
1396 * - decoding: unused
1401 * qscale factor between IP and B-frames
1402 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1403 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1404 * - encoding: Set by user.
1405 * - decoding: unused
1407 float b_quant_factor;
1409 /** obsolete FIXME remove */
1411 #define FF_RC_STRATEGY_XVID 1
1413 int b_frame_strategy;
1415 struct AVCodec *codec;
1419 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1420 /* do its best to deliver a chunk with size */
1421 /* below rtp_payload_size, the chunk will start */
1422 /* with a start code on some codecs like H.263. */
1423 /* This doesn't take account of any particular */
1424 /* headers inside the transmitted RTP payload. */
1427 /* The RTP callback: This function is called */
1428 /* every time the encoder has a packet to send. */
1429 /* It depends on the encoder if the data starts */
1430 /* with a Start Code (it should). H.263 does. */
1431 /* mb_nb contains the number of macroblocks */
1432 /* encoded in the RTP payload. */
1433 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1435 /* statistics, used for 2-pass encoding */
1446 * number of bits used for the previously encoded frame
1447 * - encoding: Set by libavcodec.
1448 * - decoding: unused
1453 * Private data of the user, can be used to carry app specific stuff.
1454 * - encoding: Set by user.
1455 * - decoding: Set by user.
1459 char codec_name[32];
1460 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1461 enum CodecID codec_id; /* see CODEC_ID_xxx */
1464 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1465 * This is used to work around some encoder bugs.
1466 * A demuxer should set this to what is stored in the field used to identify the codec.
1467 * If there are multiple such fields in a container then the demuxer should choose the one
1468 * which maximizes the information about the used codec.
1469 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1470 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1471 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1473 * - encoding: Set by user, if not then the default based on codec_id will be used.
1474 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1476 unsigned int codec_tag;
1479 * Work around bugs in encoders which sometimes cannot be detected automatically.
1480 * - encoding: Set by user
1481 * - decoding: Set by user
1483 int workaround_bugs;
1484 #define FF_BUG_AUTODETECT 1 ///< autodetection
1485 #define FF_BUG_OLD_MSMPEG4 2
1486 #define FF_BUG_XVID_ILACE 4
1487 #define FF_BUG_UMP4 8
1488 #define FF_BUG_NO_PADDING 16
1489 #define FF_BUG_AMV 32
1490 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1491 #define FF_BUG_QPEL_CHROMA 64
1492 #define FF_BUG_STD_QPEL 128
1493 #define FF_BUG_QPEL_CHROMA2 256
1494 #define FF_BUG_DIRECT_BLOCKSIZE 512
1495 #define FF_BUG_EDGE 1024
1496 #define FF_BUG_HPEL_CHROMA 2048
1497 #define FF_BUG_DC_CLIP 4096
1498 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1499 #define FF_BUG_TRUNCATED 16384
1500 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1503 * luma single coefficient elimination threshold
1504 * - encoding: Set by user.
1505 * - decoding: unused
1507 int luma_elim_threshold;
1510 * chroma single coeff elimination threshold
1511 * - encoding: Set by user.
1512 * - decoding: unused
1514 int chroma_elim_threshold;
1517 * strictly follow the standard (MPEG4, ...).
1518 * - encoding: Set by user.
1519 * - decoding: Set by user.
1520 * Setting this to STRICT or higher means the encoder and decoder will
1521 * generally do stupid things, whereas setting it to unofficial or lower
1522 * will mean the encoder might produce output that is not supported by all
1523 * spec-compliant decoders. Decoders don't differentiate between normal,
1524 * unofficial and experimental (that is, they always try to decode things
1525 * when they can) unless they are explicitly asked to behave stupidly
1526 * (=strictly conform to the specs)
1528 int strict_std_compliance;
1529 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1530 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1531 #define FF_COMPLIANCE_NORMAL 0
1532 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1533 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1536 * qscale offset between IP and B-frames
1537 * - encoding: Set by user.
1538 * - decoding: unused
1540 float b_quant_offset;
1543 * Called at the beginning of each frame to get a buffer for it.
1545 * The function will set AVFrame.data[], AVFrame.linesize[].
1546 * AVFrame.extended_data[] must also be set, but it should be the same as
1547 * AVFrame.data[] except for planar audio with more channels than can fit
1548 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1549 * many data pointers as it can hold.
1551 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1552 * avcodec_default_get_buffer() instead of providing buffers allocated by
1555 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1556 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1557 * but if get_buffer() is overridden then alignment considerations should
1558 * be taken into account.
1560 * @see avcodec_default_get_buffer()
1564 * If pic.reference is set then the frame will be read later by libavcodec.
1565 * avcodec_align_dimensions2() should be used to find the required width and
1566 * height, as they normally need to be rounded up to the next multiple of 16.
1568 * If frame multithreading is used and thread_safe_callbacks is set,
1569 * it may be called from a different thread, but not from more than one at
1570 * once. Does not need to be reentrant.
1572 * @see release_buffer(), reget_buffer()
1573 * @see avcodec_align_dimensions2()
1577 * Decoders request a buffer of a particular size by setting
1578 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1579 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1580 * to a smaller value in the output frame.
1582 * Decoders cannot use the buffer after returning from
1583 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1584 * is assumed to be released immediately upon return.
1586 * As a convenience, av_samples_get_buffer_size() and
1587 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1588 * functions to find the required data size and to fill data pointers and
1589 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1590 * since all planes must be the same size.
1592 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1594 * - encoding: unused
1595 * - decoding: Set by libavcodec, user can override.
1597 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1600 * Called to release buffers which were allocated with get_buffer.
1601 * A released buffer can be reused in get_buffer().
1602 * pic.data[*] must be set to NULL.
1603 * May be called from a different thread if frame multithreading is used,
1604 * but not by more than one thread at once, so does not need to be reentrant.
1605 * - encoding: unused
1606 * - decoding: Set by libavcodec, user can override.
1608 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1611 * Size of the frame reordering buffer in the decoder.
1612 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1613 * - encoding: Set by libavcodec.
1614 * - decoding: Set by libavcodec.
1619 * number of bytes per packet if constant and known or 0
1620 * Used by some WAV based audio codecs.
1624 #if FF_API_PARSE_FRAME
1626 * If true, only parsing is done. The frame data is returned.
1627 * Only MPEG audio decoders support this now.
1628 * - encoding: unused
1629 * - decoding: Set by user
1631 attribute_deprecated int parse_only;
1635 * 0-> h263 quant 1-> mpeg quant
1636 * - encoding: Set by user.
1637 * - decoding: unused
1642 * pass1 encoding statistics output buffer
1643 * - encoding: Set by libavcodec.
1644 * - decoding: unused
1649 * pass2 encoding statistics input buffer
1650 * Concatenated stuff from stats_out of pass1 should be placed here.
1651 * - encoding: Allocated/set/freed by user.
1652 * - decoding: unused
1657 * ratecontrol qmin qmax limiting method
1658 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1659 * - encoding: Set by user.
1660 * - decoding: unused
1668 * ratecontrol override, see RcOverride
1669 * - encoding: Allocated/set/freed by user.
1670 * - decoding: unused
1672 RcOverride *rc_override;
1673 int rc_override_count;
1676 * rate control equation
1677 * - encoding: Set by user
1678 * - decoding: unused
1684 * - encoding: Set by user.
1685 * - decoding: unused
1691 * - encoding: Set by user.
1692 * - decoding: unused
1697 * decoder bitstream buffer size
1698 * - encoding: Set by user.
1699 * - decoding: unused
1702 float rc_buffer_aggressivity;
1705 * qscale factor between P and I-frames
1706 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1707 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1708 * - encoding: Set by user.
1709 * - decoding: unused
1711 float i_quant_factor;
1714 * qscale offset between P and I-frames
1715 * - encoding: Set by user.
1716 * - decoding: unused
1718 float i_quant_offset;
1721 * initial complexity for pass1 ratecontrol
1722 * - encoding: Set by user.
1723 * - decoding: unused
1725 float rc_initial_cplx;
1728 * DCT algorithm, see FF_DCT_* below
1729 * - encoding: Set by user.
1730 * - decoding: unused
1733 #define FF_DCT_AUTO 0
1734 #define FF_DCT_FASTINT 1
1735 #define FF_DCT_INT 2
1736 #define FF_DCT_MMX 3
1737 #define FF_DCT_MLIB 4
1738 #define FF_DCT_ALTIVEC 5
1739 #define FF_DCT_FAAN 6
1742 * luminance masking (0-> disabled)
1743 * - encoding: Set by user.
1744 * - decoding: unused
1749 * temporary complexity masking (0-> disabled)
1750 * - encoding: Set by user.
1751 * - decoding: unused
1753 float temporal_cplx_masking;
1756 * spatial complexity masking (0-> disabled)
1757 * - encoding: Set by user.
1758 * - decoding: unused
1760 float spatial_cplx_masking;
1763 * p block masking (0-> disabled)
1764 * - encoding: Set by user.
1765 * - decoding: unused
1770 * darkness masking (0-> disabled)
1771 * - encoding: Set by user.
1772 * - decoding: unused
1777 * IDCT algorithm, see FF_IDCT_* below.
1778 * - encoding: Set by user.
1779 * - decoding: Set by user.
1782 #define FF_IDCT_AUTO 0
1783 #define FF_IDCT_INT 1
1784 #define FF_IDCT_SIMPLE 2
1785 #define FF_IDCT_SIMPLEMMX 3
1786 #define FF_IDCT_LIBMPEG2MMX 4
1787 #define FF_IDCT_PS2 5
1788 #define FF_IDCT_MLIB 6
1789 #define FF_IDCT_ARM 7
1790 #define FF_IDCT_ALTIVEC 8
1791 #define FF_IDCT_SH4 9
1792 #define FF_IDCT_SIMPLEARM 10
1793 #define FF_IDCT_H264 11
1794 #define FF_IDCT_VP3 12
1795 #define FF_IDCT_IPP 13
1796 #define FF_IDCT_XVIDMMX 14
1797 #define FF_IDCT_CAVS 15
1798 #define FF_IDCT_SIMPLEARMV5TE 16
1799 #define FF_IDCT_SIMPLEARMV6 17
1800 #define FF_IDCT_SIMPLEVIS 18
1801 #define FF_IDCT_WMV2 19
1802 #define FF_IDCT_FAAN 20
1803 #define FF_IDCT_EA 21
1804 #define FF_IDCT_SIMPLENEON 22
1805 #define FF_IDCT_SIMPLEALPHA 23
1806 #define FF_IDCT_BINK 24
1810 * - encoding: Set by libavcodec.
1811 * - decoding: Set by user (or 0).
1815 * slice offsets in the frame in bytes
1816 * - encoding: Set/allocated by libavcodec.
1817 * - decoding: Set/allocated by user (or NULL).
1822 * error concealment flags
1823 * - encoding: unused
1824 * - decoding: Set by user.
1826 int error_concealment;
1827 #define FF_EC_GUESS_MVS 1
1828 #define FF_EC_DEBLOCK 2
1831 * dsp_mask could be add used to disable unwanted CPU features
1832 * CPU features (i.e. MMX, SSE. ...)
1834 * With the FORCE flag you may instead enable given CPU features.
1835 * (Dangerous: Usable in case of misdetection, improper usage however will
1836 * result into program crash.)
1841 * bits per sample/pixel from the demuxer (needed for huffyuv).
1842 * - encoding: Set by libavcodec.
1843 * - decoding: Set by user.
1845 int bits_per_coded_sample;
1848 * prediction method (needed for huffyuv)
1849 * - encoding: Set by user.
1850 * - decoding: unused
1852 int prediction_method;
1853 #define FF_PRED_LEFT 0
1854 #define FF_PRED_PLANE 1
1855 #define FF_PRED_MEDIAN 2
1858 * sample aspect ratio (0 if unknown)
1859 * That is the width of a pixel divided by the height of the pixel.
1860 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1861 * - encoding: Set by user.
1862 * - decoding: Set by libavcodec.
1864 AVRational sample_aspect_ratio;
1867 * the picture in the bitstream
1868 * - encoding: Set by libavcodec.
1869 * - decoding: Set by libavcodec.
1871 AVFrame *coded_frame;
1875 * - encoding: Set by user.
1876 * - decoding: Set by user.
1879 #define FF_DEBUG_PICT_INFO 1
1880 #define FF_DEBUG_RC 2
1881 #define FF_DEBUG_BITSTREAM 4
1882 #define FF_DEBUG_MB_TYPE 8
1883 #define FF_DEBUG_QP 16
1884 #define FF_DEBUG_MV 32
1885 #define FF_DEBUG_DCT_COEFF 0x00000040
1886 #define FF_DEBUG_SKIP 0x00000080
1887 #define FF_DEBUG_STARTCODE 0x00000100
1888 #define FF_DEBUG_PTS 0x00000200
1889 #define FF_DEBUG_ER 0x00000400
1890 #define FF_DEBUG_MMCO 0x00000800
1891 #define FF_DEBUG_BUGS 0x00001000
1892 #define FF_DEBUG_VIS_QP 0x00002000
1893 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1894 #define FF_DEBUG_BUFFERS 0x00008000
1895 #define FF_DEBUG_THREADS 0x00010000
1899 * - encoding: Set by user.
1900 * - decoding: Set by user.
1903 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1904 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1905 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1909 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1910 * - decoding: unused
1912 uint64_t error[AV_NUM_DATA_POINTERS];
1915 * motion estimation comparison function
1916 * - encoding: Set by user.
1917 * - decoding: unused
1921 * subpixel motion estimation comparison function
1922 * - encoding: Set by user.
1923 * - decoding: unused
1927 * macroblock comparison function (not supported yet)
1928 * - encoding: Set by user.
1929 * - decoding: unused
1933 * interlaced DCT comparison function
1934 * - encoding: Set by user.
1935 * - decoding: unused
1938 #define FF_CMP_SAD 0
1939 #define FF_CMP_SSE 1
1940 #define FF_CMP_SATD 2
1941 #define FF_CMP_DCT 3
1942 #define FF_CMP_PSNR 4
1943 #define FF_CMP_BIT 5
1945 #define FF_CMP_ZERO 7
1946 #define FF_CMP_VSAD 8
1947 #define FF_CMP_VSSE 9
1948 #define FF_CMP_NSSE 10
1949 #define FF_CMP_W53 11
1950 #define FF_CMP_W97 12
1951 #define FF_CMP_DCTMAX 13
1952 #define FF_CMP_DCT264 14
1953 #define FF_CMP_CHROMA 256
1956 * ME diamond size & shape
1957 * - encoding: Set by user.
1958 * - decoding: unused
1963 * amount of previous MV predictors (2a+1 x 2a+1 square)
1964 * - encoding: Set by user.
1965 * - decoding: unused
1967 int last_predictor_count;
1970 * prepass for motion estimation
1971 * - encoding: Set by user.
1972 * - decoding: unused
1977 * motion estimation prepass comparison function
1978 * - encoding: Set by user.
1979 * - decoding: unused
1984 * ME prepass diamond size & shape
1985 * - encoding: Set by user.
1986 * - decoding: unused
1992 * - encoding: Set by user.
1993 * - decoding: unused
1995 int me_subpel_quality;
1998 * callback to negotiate the pixelFormat
1999 * @param fmt is the list of formats which are supported by the codec,
2000 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2001 * The first is always the native one.
2002 * @return the chosen format
2003 * - encoding: unused
2004 * - decoding: Set by user, if not set the native format will be chosen.
2006 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
2009 * DTG active format information (additional aspect ratio
2010 * information only used in DVB MPEG-2 transport streams)
2013 * - encoding: unused
2014 * - decoding: Set by decoder.
2016 int dtg_active_format;
2017 #define FF_DTG_AFD_SAME 8
2018 #define FF_DTG_AFD_4_3 9
2019 #define FF_DTG_AFD_16_9 10
2020 #define FF_DTG_AFD_14_9 11
2021 #define FF_DTG_AFD_4_3_SP_14_9 13
2022 #define FF_DTG_AFD_16_9_SP_14_9 14
2023 #define FF_DTG_AFD_SP_4_3 15
2026 * maximum motion estimation search range in subpel units
2027 * If 0 then no limit.
2029 * - encoding: Set by user.
2030 * - decoding: unused
2035 * intra quantizer bias
2036 * - encoding: Set by user.
2037 * - decoding: unused
2039 int intra_quant_bias;
2040 #define FF_DEFAULT_QUANT_BIAS 999999
2043 * inter quantizer bias
2044 * - encoding: Set by user.
2045 * - decoding: unused
2047 int inter_quant_bias;
2051 * - encoding: unused
2052 * - decoding: Which clrtable should be used for 8bit RGB images.
2053 * Tables have to be stored somewhere. FIXME
2057 #if FF_API_INTERNAL_CONTEXT
2059 * internal_buffer count
2060 * Don't touch, used by libavcodec default_get_buffer().
2061 * @deprecated this field was moved to an internal context
2063 attribute_deprecated int internal_buffer_count;
2067 * Don't touch, used by libavcodec default_get_buffer().
2068 * @deprecated this field was moved to an internal context
2070 attribute_deprecated void *internal_buffer;
2074 * Global quality for codecs which cannot change it per frame.
2075 * This should be proportional to MPEG-1/2/4 qscale.
2076 * - encoding: Set by user.
2077 * - decoding: unused
2081 #define FF_CODER_TYPE_VLC 0
2082 #define FF_CODER_TYPE_AC 1
2083 #define FF_CODER_TYPE_RAW 2
2084 #define FF_CODER_TYPE_RLE 3
2085 #define FF_CODER_TYPE_DEFLATE 4
2088 * - encoding: Set by user.
2089 * - decoding: unused
2095 * - encoding: Set by user.
2096 * - decoding: unused
2102 * - encoding: unused
2103 * - decoding: Set by user.
2105 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2110 * - encoding: unused
2111 * - decoding: Set by user.
2114 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2115 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2116 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2119 * XVideo Motion Acceleration
2120 * - encoding: forbidden
2121 * - decoding: set by decoder
2123 int xvmc_acceleration;
2126 * macroblock decision mode
2127 * - encoding: Set by user.
2128 * - decoding: unused
2131 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2132 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2133 #define FF_MB_DECISION_RD 2 ///< rate distortion
2136 * custom intra quantization matrix
2137 * - encoding: Set by user, can be NULL.
2138 * - decoding: Set by libavcodec.
2140 uint16_t *intra_matrix;
2143 * custom inter quantization matrix
2144 * - encoding: Set by user, can be NULL.
2145 * - decoding: Set by libavcodec.
2147 uint16_t *inter_matrix;
2150 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2151 * This is used to work around some encoder bugs.
2152 * - encoding: unused
2153 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2155 unsigned int stream_codec_tag;
2158 * scene change detection threshold
2159 * 0 is default, larger means fewer detected scene changes.
2160 * - encoding: Set by user.
2161 * - decoding: unused
2163 int scenechange_threshold;
2166 * minimum Lagrange multipler
2167 * - encoding: Set by user.
2168 * - decoding: unused
2173 * maximum Lagrange multipler
2174 * - encoding: Set by user.
2175 * - decoding: unused
2180 * noise reduction strength
2181 * - encoding: Set by user.
2182 * - decoding: unused
2184 int noise_reduction;
2187 * Called at the beginning of a frame to get cr buffer for it.
2188 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2189 * libavcodec will pass previous buffer in pic, function should return
2190 * same buffer or new buffer with old frame "painted" into it.
2191 * If pic.data[0] == NULL must behave like get_buffer().
2192 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2193 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2195 * - encoding: unused
2196 * - decoding: Set by libavcodec, user can override.
2198 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2201 * Number of bits which should be loaded into the rc buffer before decoding starts.
2202 * - encoding: Set by user.
2203 * - decoding: unused
2205 int rc_initial_buffer_occupancy;
2209 * - encoding: Set by user.
2210 * - decoding: unused
2212 int inter_threshold;
2216 * - encoding: Set by user.
2217 * - decoding: Set by user.
2222 * Simulates errors in the bitstream to test error concealment.
2223 * - encoding: Set by user.
2224 * - decoding: unused
2229 * quantizer noise shaping
2230 * - encoding: Set by user.
2231 * - decoding: unused
2233 int quantizer_noise_shaping;
2237 * is used to decide how many independent tasks should be passed to execute()
2238 * - encoding: Set by user.
2239 * - decoding: Set by user.
2244 * The codec may call this to execute several independent things.
2245 * It will return only after finishing all tasks.
2246 * The user may replace this with some multithreaded implementation,
2247 * the default implementation will execute the parts serially.
2248 * @param count the number of things to execute
2249 * - encoding: Set by libavcodec, user can override.
2250 * - decoding: Set by libavcodec, user can override.
2252 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2256 * Can be used by execute() to store some per AVCodecContext stuff.
2257 * - encoding: set by execute()
2258 * - decoding: set by execute()
2260 void *thread_opaque;
2263 * Motion estimation threshold below which no motion estimation is
2264 * performed, but instead the user specified motion vectors are used.
2266 * - encoding: Set by user.
2267 * - decoding: unused
2272 * Macroblock threshold below which the user specified macroblock types will be used.
2273 * - encoding: Set by user.
2274 * - decoding: unused
2279 * precision of the intra DC coefficient - 8
2280 * - encoding: Set by user.
2281 * - decoding: unused
2283 int intra_dc_precision;
2286 * noise vs. sse weight for the nsse comparsion function
2287 * - encoding: Set by user.
2288 * - decoding: unused
2293 * Number of macroblock rows at the top which are skipped.
2294 * - encoding: unused
2295 * - decoding: Set by user.
2300 * Number of macroblock rows at the bottom which are skipped.
2301 * - encoding: unused
2302 * - decoding: Set by user.
2308 * - encoding: Set by user.
2309 * - decoding: Set by libavcodec.
2312 #define FF_PROFILE_UNKNOWN -99
2313 #define FF_PROFILE_RESERVED -100
2315 #define FF_PROFILE_AAC_MAIN 0
2316 #define FF_PROFILE_AAC_LOW 1
2317 #define FF_PROFILE_AAC_SSR 2
2318 #define FF_PROFILE_AAC_LTP 3
2320 #define FF_PROFILE_DTS 20
2321 #define FF_PROFILE_DTS_ES 30
2322 #define FF_PROFILE_DTS_96_24 40
2323 #define FF_PROFILE_DTS_HD_HRA 50
2324 #define FF_PROFILE_DTS_HD_MA 60
2326 #define FF_PROFILE_MPEG2_422 0
2327 #define FF_PROFILE_MPEG2_HIGH 1
2328 #define FF_PROFILE_MPEG2_SS 2
2329 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2330 #define FF_PROFILE_MPEG2_MAIN 4
2331 #define FF_PROFILE_MPEG2_SIMPLE 5
2333 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2334 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2336 #define FF_PROFILE_H264_BASELINE 66
2337 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2338 #define FF_PROFILE_H264_MAIN 77
2339 #define FF_PROFILE_H264_EXTENDED 88
2340 #define FF_PROFILE_H264_HIGH 100
2341 #define FF_PROFILE_H264_HIGH_10 110
2342 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2343 #define FF_PROFILE_H264_HIGH_422 122
2344 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2345 #define FF_PROFILE_H264_HIGH_444 144
2346 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2347 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2348 #define FF_PROFILE_H264_CAVLC_444 44
2350 #define FF_PROFILE_VC1_SIMPLE 0
2351 #define FF_PROFILE_VC1_MAIN 1
2352 #define FF_PROFILE_VC1_COMPLEX 2
2353 #define FF_PROFILE_VC1_ADVANCED 3
2355 #define FF_PROFILE_MPEG4_SIMPLE 0
2356 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2357 #define FF_PROFILE_MPEG4_CORE 2
2358 #define FF_PROFILE_MPEG4_MAIN 3
2359 #define FF_PROFILE_MPEG4_N_BIT 4
2360 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2361 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2362 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2363 #define FF_PROFILE_MPEG4_HYBRID 8
2364 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2365 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2366 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2367 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2368 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2369 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2370 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2374 * - encoding: Set by user.
2375 * - decoding: Set by libavcodec.
2378 #define FF_LEVEL_UNKNOWN -99
2381 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2382 * - encoding: unused
2383 * - decoding: Set by user.
2388 * Bitstream width / height, may be different from width/height if lowres enabled.
2389 * - encoding: unused
2390 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2392 int coded_width, coded_height;
2395 * frame skip threshold
2396 * - encoding: Set by user.
2397 * - decoding: unused
2399 int frame_skip_threshold;
2403 * - encoding: Set by user.
2404 * - decoding: unused
2406 int frame_skip_factor;
2409 * frame skip exponent
2410 * - encoding: Set by user.
2411 * - decoding: unused
2416 * frame skip comparison function
2417 * - encoding: Set by user.
2418 * - decoding: unused
2423 * Border processing masking, raises the quantizer for mbs on the borders
2425 * - encoding: Set by user.
2426 * - decoding: unused
2428 float border_masking;
2431 * minimum MB lagrange multipler
2432 * - encoding: Set by user.
2433 * - decoding: unused
2438 * maximum MB lagrange multipler
2439 * - encoding: Set by user.
2440 * - decoding: unused
2446 * - encoding: Set by user.
2447 * - decoding: unused
2449 int me_penalty_compensation;
2453 * - encoding: unused
2454 * - decoding: Set by user.
2456 enum AVDiscard skip_loop_filter;
2460 * - encoding: unused
2461 * - decoding: Set by user.
2463 enum AVDiscard skip_idct;
2467 * - encoding: unused
2468 * - decoding: Set by user.
2470 enum AVDiscard skip_frame;
2474 * - encoding: Set by user.
2475 * - decoding: unused
2481 * - encoding: Set by user.
2482 * - decoding: unused
2488 * - encoding: Set by user.
2489 * - decoding: unused
2494 * number of reference frames
2495 * - encoding: Set by user.
2496 * - decoding: Set by lavc.
2501 * chroma qp offset from luma
2502 * - encoding: Set by user.
2503 * - decoding: unused
2508 * trellis RD quantization
2509 * - encoding: Set by user.
2510 * - decoding: unused
2515 * Audio cutoff bandwidth (0 means "automatic")
2516 * - encoding: Set by user.
2517 * - decoding: unused
2522 * Multiplied by qscale for each frame and added to scene_change_score.
2523 * - encoding: Set by user.
2524 * - decoding: unused
2526 int scenechange_factor;
2530 * Note: Value depends upon the compare function used for fullpel ME.
2531 * - encoding: Set by user.
2532 * - decoding: unused
2537 * Adjust sensitivity of b_frame_strategy 1.
2538 * - encoding: Set by user.
2539 * - decoding: unused
2544 * - encoding: Set by user.
2545 * - decoding: unused
2547 int compression_level;
2548 #define FF_COMPRESSION_DEFAULT -1
2551 * - encoding: Set by user.
2552 * - decoding: unused
2554 int min_prediction_order;
2557 * - encoding: Set by user.
2558 * - decoding: unused
2560 int max_prediction_order;
2563 * GOP timecode frame start number, in non drop frame format
2564 * - encoding: Set by user.
2565 * - decoding: unused
2567 int64_t timecode_frame_start;
2569 #if FF_API_REQUEST_CHANNELS
2571 * Decoder should decode to this many channels if it can (0 for default)
2572 * - encoding: unused
2573 * - decoding: Set by user.
2574 * @deprecated Deprecated in favor of request_channel_layout.
2576 int request_channels;
2580 * opaque 64bit number (generally a PTS) that will be reordered and
2581 * output in AVFrame.reordered_opaque
2582 * @deprecated in favor of pkt_pts
2583 * - encoding: unused
2584 * - decoding: Set by user.
2586 int64_t reordered_opaque;
2589 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2590 * - encoding: set by user.
2591 * - decoding: set by libavcodec.
2593 int bits_per_raw_sample;
2596 * Audio channel layout.
2597 * - encoding: set by user.
2598 * - decoding: set by libavcodec.
2600 uint64_t channel_layout;
2603 * Request decoder to use this channel layout if it can (0 for default)
2604 * - encoding: unused
2605 * - decoding: Set by user.
2607 uint64_t request_channel_layout;
2610 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2611 * - encoding: Set by user.
2612 * - decoding: unused.
2614 float rc_max_available_vbv_use;
2617 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2618 * - encoding: Set by user.
2619 * - decoding: unused.
2621 float rc_min_vbv_overflow_use;
2624 * Hardware accelerator in use
2625 * - encoding: unused.
2626 * - decoding: Set by libavcodec
2628 struct AVHWAccel *hwaccel;
2631 * For some codecs, the time base is closer to the field rate than the frame rate.
2632 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2633 * if no telecine is used ...
2635 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2637 int ticks_per_frame;
2640 * Hardware accelerator context.
2641 * For some hardware accelerators, a global context needs to be
2642 * provided by the user. In that case, this holds display-dependent
2643 * data Libav cannot instantiate itself. Please refer to the
2644 * Libav HW accelerator documentation to know how to fill this
2645 * is. e.g. for VA API, this is a struct vaapi_context.
2646 * - encoding: unused
2647 * - decoding: Set by user
2649 void *hwaccel_context;
2652 * Chromaticity coordinates of the source primaries.
2653 * - encoding: Set by user
2654 * - decoding: Set by libavcodec
2656 enum AVColorPrimaries color_primaries;
2659 * Color Transfer Characteristic.
2660 * - encoding: Set by user
2661 * - decoding: Set by libavcodec
2663 enum AVColorTransferCharacteristic color_trc;
2666 * YUV colorspace type.
2667 * - encoding: Set by user
2668 * - decoding: Set by libavcodec
2670 enum AVColorSpace colorspace;
2673 * MPEG vs JPEG YUV range.
2674 * - encoding: Set by user
2675 * - decoding: Set by libavcodec
2677 enum AVColorRange color_range;
2680 * This defines the location of chroma samples.
2681 * - encoding: Set by user
2682 * - decoding: Set by libavcodec
2684 enum AVChromaLocation chroma_sample_location;
2687 * The codec may call this to execute several independent things.
2688 * It will return only after finishing all tasks.
2689 * The user may replace this with some multithreaded implementation,
2690 * the default implementation will execute the parts serially.
2691 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2692 * @param c context passed also to func
2693 * @param count the number of things to execute
2694 * @param arg2 argument passed unchanged to func
2695 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2696 * @param func function that will be called count times, with jobnr from 0 to count-1.
2697 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2698 * two instances of func executing at the same time will have the same threadnr.
2699 * @return always 0 currently, but code should handle a future improvement where when any call to func
2700 * returns < 0 no further calls to func may be done and < 0 is returned.
2701 * - encoding: Set by libavcodec, user can override.
2702 * - decoding: Set by libavcodec, user can override.
2704 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2706 int log_level_offset;
2710 * Indicates number of picture subdivisions. Used for parallelized
2712 * - encoding: Set by user
2713 * - decoding: unused
2718 * Header containing style information for text subtitles.
2719 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2720 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2721 * the Format line following. It shouldn't include any Dialogue line.
2722 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2723 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2725 uint8_t *subtitle_header;
2726 int subtitle_header_size;
2729 * Current packet as passed into the decoder, to avoid having
2730 * to pass the packet into every function. Currently only valid
2731 * inside lavc and get/release_buffer callbacks.
2732 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2733 * - encoding: unused
2737 #if FF_API_INTERNAL_CONTEXT
2739 * Whether this is a copy of the context which had init() called on it.
2740 * This is used by multithreading - shared tables and picture pointers
2741 * should be freed from the original context only.
2742 * - encoding: Set by libavcodec.
2743 * - decoding: Set by libavcodec.
2745 * @deprecated this field has been moved to an internal context
2747 attribute_deprecated int is_copy;
2751 * Which multithreading methods to use.
2752 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2753 * so clients which cannot provide future frames should not use it.
2755 * - encoding: Set by user, otherwise the default is used.
2756 * - decoding: Set by user, otherwise the default is used.
2759 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2760 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2763 * Which multithreading methods are in use by the codec.
2764 * - encoding: Set by libavcodec.
2765 * - decoding: Set by libavcodec.
2767 int active_thread_type;
2770 * Set by the client if its custom get_buffer() callback can be called
2771 * from another thread, which allows faster multithreaded decoding.
2772 * draw_horiz_band() will be called from other threads regardless of this setting.
2773 * Ignored if the default get_buffer() is used.
2774 * - encoding: Set by user.
2775 * - decoding: Set by user.
2777 int thread_safe_callbacks;
2780 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2781 * Used for compliant TS muxing.
2782 * - encoding: Set by libavcodec.
2783 * - decoding: unused.
2788 * Type of service that the audio stream conveys.
2789 * - encoding: Set by user.
2790 * - decoding: Set by libavcodec.
2792 enum AVAudioServiceType audio_service_type;
2795 * Used to request a sample format from the decoder.
2796 * - encoding: unused.
2797 * - decoding: Set by user.
2799 enum AVSampleFormat request_sample_fmt;
2802 * Error recognition; may misdetect some more or less valid parts as errors.
2803 * - encoding: unused
2804 * - decoding: Set by user.
2806 int err_recognition;
2807 #define AV_EF_CRCCHECK (1<<0)
2808 #define AV_EF_BITSTREAM (1<<1)
2809 #define AV_EF_BUFFER (1<<2)
2810 #define AV_EF_EXPLODE (1<<3)
2813 * Private context used for internal data.
2815 * Unlike priv_data, this is not codec-specific. It is used in general
2816 * libavcodec functions.
2818 struct AVCodecInternal *internal;
2821 * - encoding: set by libavcodec
2822 * - decoding: Set by libavcodec
2824 enum AVFieldOrder field_order;
2830 typedef struct AVProfile {
2832 const char *name; ///< short name for the profile
2835 typedef struct AVCodecDefault AVCodecDefault;
2840 typedef struct AVCodec {
2842 * Name of the codec implementation.
2843 * The name is globally unique among encoders and among decoders (but an
2844 * encoder and a decoder can share the same name).
2845 * This is the primary way to find a codec from the user perspective.
2848 enum AVMediaType type;
2851 int (*init)(AVCodecContext *);
2852 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2853 int (*close)(AVCodecContext *);
2854 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2856 * Codec capabilities.
2860 struct AVCodec *next;
2863 * Will be called when seeking
2865 void (*flush)(AVCodecContext *);
2866 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2867 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2869 * Descriptive name for the codec, meant to be more human readable than name.
2870 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2872 const char *long_name;
2873 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2874 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2875 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2876 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2877 const AVClass *priv_class; ///< AVClass for the private context
2878 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2881 * @name Frame-level threading support functions
2885 * If defined, called on thread contexts when they are created.
2886 * If the codec allocates writable tables in init(), re-allocate them here.
2887 * priv_data will be set to a copy of the original.
2889 int (*init_thread_copy)(AVCodecContext *);
2891 * Copy necessary context variables from a previous thread context to the current one.
2892 * If not defined, the next thread will start automatically; otherwise, the codec
2893 * must call ff_thread_finish_setup().
2895 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2897 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2901 * Private codec-specific defaults.
2903 const AVCodecDefault *defaults;
2906 * Initialize codec static data, called from avcodec_register().
2908 void (*init_static_data)(struct AVCodec *codec);
2911 * Encode data to an AVPacket.
2913 * @param avctx codec context
2914 * @param avpkt output AVPacket (may contain a user-provided buffer)
2915 * @param[in] frame AVFrame containing the raw data to be encoded
2916 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2917 * non-empty packet was returned in avpkt.
2918 * @return 0 on success, negative error code on failure
2920 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2921 int *got_packet_ptr);
2927 typedef struct AVHWAccel {
2929 * Name of the hardware accelerated codec.
2930 * The name is globally unique among encoders and among decoders (but an
2931 * encoder and a decoder can share the same name).
2936 * Type of codec implemented by the hardware accelerator.
2938 * See AVMEDIA_TYPE_xxx
2940 enum AVMediaType type;
2943 * Codec implemented by the hardware accelerator.
2950 * Supported pixel format.
2952 * Only hardware accelerated formats are supported here.
2954 enum PixelFormat pix_fmt;
2957 * Hardware accelerated codec capabilities.
2958 * see FF_HWACCEL_CODEC_CAP_*
2962 struct AVHWAccel *next;
2965 * Called at the beginning of each frame or field picture.
2967 * Meaningful frame information (codec specific) is guaranteed to
2968 * be parsed at this point. This function is mandatory.
2970 * Note that buf can be NULL along with buf_size set to 0.
2971 * Otherwise, this means the whole frame is available at this point.
2973 * @param avctx the codec context
2974 * @param buf the frame data buffer base
2975 * @param buf_size the size of the frame in bytes
2976 * @return zero if successful, a negative value otherwise
2978 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2981 * Callback for each slice.
2983 * Meaningful slice information (codec specific) is guaranteed to
2984 * be parsed at this point. This function is mandatory.
2986 * @param avctx the codec context
2987 * @param buf the slice data buffer base
2988 * @param buf_size the size of the slice in bytes
2989 * @return zero if successful, a negative value otherwise
2991 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2994 * Called at the end of each frame or field picture.
2996 * The whole picture is parsed at this point and can now be sent
2997 * to the hardware accelerator. This function is mandatory.
2999 * @param avctx the codec context
3000 * @return zero if successful, a negative value otherwise
3002 int (*end_frame)(AVCodecContext *avctx);
3005 * Size of HW accelerator private data.
3007 * Private data is allocated with av_mallocz() before
3008 * AVCodecContext.get_buffer() and deallocated after
3009 * AVCodecContext.release_buffer().
3015 * four components are given, that's all.
3016 * the last component is alpha
3018 typedef struct AVPicture {
3019 uint8_t *data[AV_NUM_DATA_POINTERS];
3020 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3023 #define AVPALETTE_SIZE 1024
3024 #define AVPALETTE_COUNT 256
3026 enum AVSubtitleType {
3029 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3032 * Plain text, the text field must be set by the decoder and is
3033 * authoritative. ass and pict fields may contain approximations.
3038 * Formatted text, the ass field must be set by the decoder and is
3039 * authoritative. pict and text fields may contain approximations.
3044 typedef struct AVSubtitleRect {
3045 int x; ///< top left corner of pict, undefined when pict is not set
3046 int y; ///< top left corner of pict, undefined when pict is not set
3047 int w; ///< width of pict, undefined when pict is not set
3048 int h; ///< height of pict, undefined when pict is not set
3049 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3052 * data+linesize for the bitmap of this subtitle.
3053 * can be set for text/ass as well once they where rendered
3056 enum AVSubtitleType type;
3058 char *text; ///< 0 terminated plain UTF-8 text
3061 * 0 terminated ASS/SSA compatible event line.
3062 * The pressentation of this is unaffected by the other values in this
3068 typedef struct AVSubtitle {
3069 uint16_t format; /* 0 = graphics */
3070 uint32_t start_display_time; /* relative to packet pts, in ms */
3071 uint32_t end_display_time; /* relative to packet pts, in ms */
3073 AVSubtitleRect **rects;
3074 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3077 /* packet functions */
3080 * @deprecated use NULL instead
3082 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3085 * Default packet destructor.
3087 void av_destruct_packet(AVPacket *pkt);
3090 * Initialize optional fields of a packet with default values.
3094 void av_init_packet(AVPacket *pkt);
3097 * Allocate the payload of a packet and initialize its fields with
3101 * @param size wanted payload size
3102 * @return 0 if OK, AVERROR_xxx otherwise
3104 int av_new_packet(AVPacket *pkt, int size);
3107 * Reduce packet size, correctly zeroing padding
3110 * @param size new size
3112 void av_shrink_packet(AVPacket *pkt, int size);
3115 * Increase packet size, correctly zeroing padding
3118 * @param grow_by number of bytes by which to increase the size of the packet
3120 int av_grow_packet(AVPacket *pkt, int grow_by);
3123 * @warning This is a hack - the packet memory allocation stuff is broken. The
3124 * packet is allocated if it was not really allocated.
3126 int av_dup_packet(AVPacket *pkt);
3131 * @param pkt packet to free
3133 void av_free_packet(AVPacket *pkt);
3136 * Allocate new information of a packet.
3139 * @param type side information type
3140 * @param size side information size
3141 * @return pointer to fresh allocated data or NULL otherwise
3143 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3147 * Get side information from packet.
3150 * @param type desired side information type
3151 * @param size pointer for side information size to store (optional)
3152 * @return pointer to data if present or NULL otherwise
3154 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3159 struct ReSampleContext;
3160 struct AVResampleContext;
3162 typedef struct ReSampleContext ReSampleContext;
3165 * Initialize audio resampling context.
3167 * @param output_channels number of output channels
3168 * @param input_channels number of input channels
3169 * @param output_rate output sample rate
3170 * @param input_rate input sample rate
3171 * @param sample_fmt_out requested output sample format
3172 * @param sample_fmt_in input sample format
3173 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3174 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3175 * @param linear if 1 then the used FIR filter will be linearly interpolated
3176 between the 2 closest, if 0 the closest will be used
3177 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3178 * @return allocated ReSampleContext, NULL if error occurred
3180 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3181 int output_rate, int input_rate,
3182 enum AVSampleFormat sample_fmt_out,
3183 enum AVSampleFormat sample_fmt_in,
3184 int filter_length, int log2_phase_count,
3185 int linear, double cutoff);
3187 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3190 * Free resample context.
3192 * @param s a non-NULL pointer to a resample context previously
3193 * created with av_audio_resample_init()
3195 void audio_resample_close(ReSampleContext *s);
3199 * Initialize an audio resampler.
3200 * Note, if either rate is not an integer then simply scale both rates up so they are.
3201 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3202 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3203 * @param linear If 1 then the used FIR filter will be linearly interpolated
3204 between the 2 closest, if 0 the closest will be used
3205 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3207 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3210 * Resample an array of samples using a previously configured context.
3211 * @param src an array of unconsumed samples
3212 * @param consumed the number of samples of src which have been consumed are returned here
3213 * @param src_size the number of unconsumed samples available
3214 * @param dst_size the amount of space in samples available in dst
3215 * @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.
3216 * @return the number of samples written in dst or -1 if an error occurred
3218 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3222 * Compensate samplerate/timestamp drift. The compensation is done by changing
3223 * the resampler parameters, so no audible clicks or similar distortions occur
3224 * @param compensation_distance distance in output samples over which the compensation should be performed
3225 * @param sample_delta number of output samples which should be output less
3227 * example: av_resample_compensate(c, 10, 500)
3228 * here instead of 510 samples only 500 samples would be output
3230 * note, due to rounding the actual compensation might be slightly different,
3231 * especially if the compensation_distance is large and the in_rate used during init is small
3233 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3234 void av_resample_close(struct AVResampleContext *c);
3237 * Allocate memory for a picture. Call avpicture_free() to free it.
3239 * @see avpicture_fill()
3241 * @param picture the picture to be filled in
3242 * @param pix_fmt the format of the picture
3243 * @param width the width of the picture
3244 * @param height the height of the picture
3245 * @return zero if successful, a negative value if not
3247 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3250 * Free a picture previously allocated by avpicture_alloc().
3251 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3254 * @param picture the AVPicture to be freed
3256 void avpicture_free(AVPicture *picture);
3259 * Fill in the AVPicture fields.
3260 * The fields of the given AVPicture are filled in by using the 'ptr' address
3261 * which points to the image data buffer. Depending on the specified picture
3262 * format, one or multiple image data pointers and line sizes will be set.
3263 * If a planar format is specified, several pointers will be set pointing to
3264 * the different picture planes and the line sizes of the different planes
3265 * will be stored in the lines_sizes array.
3266 * Call with ptr == NULL to get the required size for the ptr buffer.
3268 * To allocate the buffer and fill in the AVPicture fields in one call,
3269 * use avpicture_alloc().
3271 * @param picture AVPicture whose fields are to be filled in
3272 * @param ptr Buffer which will contain or contains the actual image data
3273 * @param pix_fmt The format in which the picture data is stored.
3274 * @param width the width of the image in pixels
3275 * @param height the height of the image in pixels
3276 * @return size of the image data in bytes
3278 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3279 enum PixelFormat pix_fmt, int width, int height);
3282 * Copy pixel data from an AVPicture into a buffer.
3283 * The data is stored compactly, without any gaps for alignment or padding
3284 * which may be applied by avpicture_fill().
3286 * @see avpicture_get_size()
3288 * @param[in] src AVPicture containing image data
3289 * @param[in] pix_fmt The format in which the picture data is stored.
3290 * @param[in] width the width of the image in pixels.
3291 * @param[in] height the height of the image in pixels.
3292 * @param[out] dest A buffer into which picture data will be copied.
3293 * @param[in] dest_size The size of 'dest'.
3294 * @return The number of bytes written to dest, or a negative value (error code) on error.
3296 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3297 unsigned char *dest, int dest_size);
3300 * Calculate the size in bytes that a picture of the given width and height
3301 * would occupy if stored in the given picture format.
3302 * Note that this returns the size of a compact representation as generated
3303 * by avpicture_layout(), which can be smaller than the size required for e.g.
3306 * @param pix_fmt the given picture format
3307 * @param width the width of the image
3308 * @param height the height of the image
3309 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3311 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3312 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3314 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3317 * Return a value representing the fourCC code associated to the
3318 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3321 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3324 * Put a string representing the codec tag codec_tag in buf.
3326 * @param buf_size size in bytes of buf
3327 * @return the length of the string that would have been generated if
3328 * enough space had been available, excluding the trailing null
3330 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3332 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3333 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3334 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3335 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3336 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3337 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3340 * Compute what kind of losses will occur when converting from one specific
3341 * pixel format to another.
3342 * When converting from one pixel format to another, information loss may occur.
3343 * For example, when converting from RGB24 to GRAY, the color information will
3344 * be lost. Similarly, other losses occur when converting from some formats to
3345 * other formats. These losses can involve loss of chroma, but also loss of
3346 * resolution, loss of color depth, loss due to the color space conversion, loss
3347 * of the alpha bits or loss due to color quantization.
3348 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3349 * which will occur when converting from one pixel format to another.
3351 * @param[in] dst_pix_fmt destination pixel format
3352 * @param[in] src_pix_fmt source pixel format
3353 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3354 * @return Combination of flags informing you what kind of losses will occur.
3356 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3360 * Find the best pixel format to convert to given a certain source pixel
3361 * format. When converting from one pixel format to another, information loss
3362 * may occur. For example, when converting from RGB24 to GRAY, the color
3363 * information will be lost. Similarly, other losses occur when converting from
3364 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3365 * the given pixel formats should be used to suffer the least amount of loss.
3366 * The pixel formats from which it chooses one, are determined by the
3367 * pix_fmt_mask parameter.
3370 * src_pix_fmt = PIX_FMT_YUV420P;
3371 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3372 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3375 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3376 * @param[in] src_pix_fmt source pixel format
3377 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3378 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3379 * @return The best pixel format to convert to or -1 if none was found.
3381 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3382 int has_alpha, int *loss_ptr);
3384 #if FF_API_GET_ALPHA_INFO
3385 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3386 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3389 * Tell if an image really has transparent alpha values.
3390 * @return ored mask of FF_ALPHA_xxx constants
3392 attribute_deprecated
3393 int img_get_alpha_info(const AVPicture *src,
3394 enum PixelFormat pix_fmt, int width, int height);
3397 /* deinterlace a picture */
3398 /* deinterlace - if not supported return -1 */
3399 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3400 enum PixelFormat pix_fmt, int width, int height);
3402 /* external high level API */
3405 * If c is NULL, returns the first registered codec,
3406 * if c is non-NULL, returns the next registered codec after c,
3407 * or NULL if c is the last one.
3409 AVCodec *av_codec_next(AVCodec *c);
3412 * Return the LIBAVCODEC_VERSION_INT constant.
3414 unsigned avcodec_version(void);
3417 * Return the libavcodec build-time configuration.
3419 const char *avcodec_configuration(void);
3422 * Return the libavcodec license.
3424 const char *avcodec_license(void);
3427 * Register the codec codec and initialize libavcodec.
3429 * @warning either this function or avcodec_register_all() must be called
3430 * before any other libavcodec functions.
3432 * @see avcodec_register_all()
3434 void avcodec_register(AVCodec *codec);
3437 * Find a registered encoder with a matching codec ID.
3439 * @param id CodecID of the requested encoder
3440 * @return An encoder if one was found, NULL otherwise.
3442 AVCodec *avcodec_find_encoder(enum CodecID id);
3445 * Find a registered encoder with the specified name.
3447 * @param name name of the requested encoder
3448 * @return An encoder if one was found, NULL otherwise.
3450 AVCodec *avcodec_find_encoder_by_name(const char *name);
3453 * Find a registered decoder with a matching codec ID.
3455 * @param id CodecID of the requested decoder
3456 * @return A decoder if one was found, NULL otherwise.
3458 AVCodec *avcodec_find_decoder(enum CodecID id);
3461 * Find a registered decoder with the specified name.
3463 * @param name name of the requested decoder
3464 * @return A decoder if one was found, NULL otherwise.
3466 AVCodec *avcodec_find_decoder_by_name(const char *name);
3467 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3470 * Return a name for the specified profile, if available.
3472 * @param codec the codec that is searched for the given profile
3473 * @param profile the profile value for which a name is requested
3474 * @return A name for the profile if found, NULL otherwise.
3476 const char *av_get_profile_name(const AVCodec *codec, int profile);
3479 * Set the fields of the given AVCodecContext to default values corresponding
3480 * to the given codec (defaults may be codec-dependent).
3482 * Do not call this function if a non-NULL codec has been passed
3483 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3484 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3485 * different codec on this AVCodecContext.
3487 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3490 * Allocate an AVCodecContext and set its fields to default values. The
3491 * resulting struct can be deallocated by simply calling av_free().
3493 * @param codec if non-NULL, allocate private data and initialize defaults
3494 * for the given codec. It is illegal to then call avcodec_open2()
3495 * with a different codec.
3497 * @return An AVCodecContext filled with default values or NULL on failure.
3498 * @see avcodec_get_context_defaults
3500 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3503 * Copy the settings of the source AVCodecContext into the destination
3504 * AVCodecContext. The resulting destination codec context will be
3505 * unopened, i.e. you are required to call avcodec_open2() before you
3506 * can use this AVCodecContext to decode/encode video/audio data.
3508 * @param dest target codec context, should be initialized with
3509 * avcodec_alloc_context3(), but otherwise uninitialized
3510 * @param src source codec context
3511 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3513 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3516 * Set the fields of the given AVFrame to default values.
3518 * @param pic The AVFrame of which the fields should be set to default values.
3520 void avcodec_get_frame_defaults(AVFrame *pic);
3523 * Allocate an AVFrame and set its fields to default values. The resulting
3524 * struct can be deallocated by simply calling av_free().
3526 * @return An AVFrame filled with default values or NULL on failure.
3527 * @see avcodec_get_frame_defaults
3529 AVFrame *avcodec_alloc_frame(void);
3531 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3532 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3533 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3536 * Return the amount of padding in pixels which the get_buffer callback must
3537 * provide around the edge of the image for codecs which do not have the
3538 * CODEC_FLAG_EMU_EDGE flag.
3540 * @return Required padding in pixels.
3542 unsigned avcodec_get_edge_width(void);
3544 * Modify width and height values so that they will result in a memory
3545 * buffer that is acceptable for the codec if you do not use any horizontal
3548 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3549 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3550 * according to avcodec_get_edge_width() before.
3552 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3554 * Modify width and height values so that they will result in a memory
3555 * buffer that is acceptable for the codec if you also ensure that all
3556 * line sizes are a multiple of the respective linesize_align[i].
3558 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3559 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3560 * according to avcodec_get_edge_width() before.
3562 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3563 int linesize_align[AV_NUM_DATA_POINTERS]);
3565 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3567 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3568 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3569 //FIXME func typedef
3572 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3573 * function the context has to be allocated with avcodec_alloc_context3().
3575 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3576 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3577 * retrieving a codec.
3579 * @warning This function is not thread safe!
3582 * avcodec_register_all();
3583 * av_dict_set(&opts, "b", "2.5M", 0);
3584 * codec = avcodec_find_decoder(CODEC_ID_H264);
3588 * context = avcodec_alloc_context3(codec);
3590 * if (avcodec_open2(context, codec, opts) < 0)
3594 * @param avctx The context to initialize.
3595 * @param options A dictionary filled with AVCodecContext and codec-private options.
3596 * On return this object will be filled with options that were not found.
3598 * @return zero on success, a negative value on error
3599 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3600 * av_dict_set(), av_opt_find().
3602 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3604 #if FF_API_OLD_DECODE_AUDIO
3606 * Wrapper function which calls avcodec_decode_audio4.
3608 * @deprecated Use avcodec_decode_audio4 instead.
3610 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3611 * Some decoders may support multiple frames in a single AVPacket, such
3612 * decoders would then just decode the first frame. In this case,
3613 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3614 * the remaining data in order to decode the second frame etc.
3616 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3617 * decompressed frame size in bytes.
3619 * @warning You must set frame_size_ptr to the allocated size of the
3620 * output buffer before calling avcodec_decode_audio3().
3622 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3623 * the actual read bytes because some optimized bitstream readers read 32 or 64
3624 * bits at once and could read over the end.
3626 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3627 * no overreading happens for damaged MPEG streams.
3629 * @warning You must not provide a custom get_buffer() when using
3630 * avcodec_decode_audio3(). Doing so will override it with
3631 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3632 * which does allow the application to provide a custom get_buffer().
3634 * @note You might have to align the input buffer avpkt->data and output buffer
3635 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3636 * necessary at all, on others it won't work at all if not aligned and on others
3637 * it will work but it will have an impact on performance.
3639 * In practice, avpkt->data should have 4 byte alignment at minimum and
3640 * samples should be 16 byte aligned unless the CPU doesn't need it
3641 * (AltiVec and SSE do).
3643 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3644 * between input and output, these need to be fed with avpkt->data=NULL,
3645 * avpkt->size=0 at the end to return the remaining frames.
3647 * @param avctx the codec context
3648 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3649 * If the sample format is planar, each channel plane will
3650 * be the same size, with no padding between channels.
3651 * @param[in,out] frame_size_ptr the output buffer size in bytes
3652 * @param[in] avpkt The input AVPacket containing the input buffer.
3653 * You can create such packet with av_init_packet() and by then setting
3654 * data and size, some decoders might in addition need other fields.
3655 * All decoders are designed to use the least fields possible though.
3656 * @return On error a negative value is returned, otherwise the number of bytes
3657 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3659 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3660 int *frame_size_ptr,
3665 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3667 * Some decoders may support multiple frames in a single AVPacket. Such
3668 * decoders would then just decode the first frame. In this case,
3669 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3670 * the remaining data in order to decode the second frame, etc...
3671 * Even if no frames are returned, the packet needs to be fed to the decoder
3672 * with remaining data until it is completely consumed or an error occurs.
3674 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3675 * larger than the actual read bytes because some optimized bitstream
3676 * readers read 32 or 64 bits at once and could read over the end.
3678 * @note You might have to align the input buffer. The alignment requirements
3679 * depend on the CPU and the decoder.
3681 * @param avctx the codec context
3682 * @param[out] frame The AVFrame in which to store decoded audio samples.
3683 * Decoders request a buffer of a particular size by setting
3684 * AVFrame.nb_samples prior to calling get_buffer(). The
3685 * decoder may, however, only utilize part of the buffer by
3686 * setting AVFrame.nb_samples to a smaller value in the
3688 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3690 * @param[in] avpkt The input AVPacket containing the input buffer.
3691 * At least avpkt->data and avpkt->size should be set. Some
3692 * decoders might also require additional fields to be set.
3693 * @return A negative error code is returned if an error occurred during
3694 * decoding, otherwise the number of bytes consumed from the input
3695 * AVPacket is returned.
3697 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3698 int *got_frame_ptr, AVPacket *avpkt);
3701 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3702 * Some decoders may support multiple frames in a single AVPacket, such
3703 * decoders would then just decode the first frame.
3705 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3706 * the actual read bytes because some optimized bitstream readers read 32 or 64
3707 * bits at once and could read over the end.
3709 * @warning The end of the input buffer buf should be set to 0 to ensure that
3710 * no overreading happens for damaged MPEG streams.
3712 * @note You might have to align the input buffer avpkt->data.
3713 * The alignment requirements depend on the CPU: on some CPUs it isn't
3714 * necessary at all, on others it won't work at all if not aligned and on others
3715 * it will work but it will have an impact on performance.
3717 * In practice, avpkt->data should have 4 byte alignment at minimum.
3719 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3720 * between input and output, these need to be fed with avpkt->data=NULL,
3721 * avpkt->size=0 at the end to return the remaining frames.
3723 * @param avctx the codec context
3724 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3725 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3726 * allocate memory for the actual bitmap.
3727 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3728 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3729 * decodes and the decoder tells the user once it does not need the data anymore,
3730 * the user app can at this point free/reuse/keep the memory as it sees fit.
3732 * @param[in] avpkt The input AVpacket containing the input buffer.
3733 * You can create such packet with av_init_packet() and by then setting
3734 * data and size, some decoders might in addition need other fields like
3735 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3737 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3738 * @return On error a negative value is returned, otherwise the number of bytes
3739 * used or zero if no frame could be decompressed.
3741 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3742 int *got_picture_ptr,
3746 * Decode a subtitle message.
3747 * Return a negative value on error, otherwise return the number of bytes used.
3748 * If no subtitle could be decompressed, got_sub_ptr is zero.
3749 * Otherwise, the subtitle is stored in *sub.
3750 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3751 * simplicity, because the performance difference is expect to be negligible
3752 * and reusing a get_buffer written for video codecs would probably perform badly
3753 * due to a potentially very different allocation pattern.
3755 * @param avctx the codec context
3756 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3757 freed with avsubtitle_free if *got_sub_ptr is set.
3758 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3759 * @param[in] avpkt The input AVPacket containing the input buffer.
3761 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3766 * Free all allocated data in the given subtitle struct.
3768 * @param sub AVSubtitle to free.
3770 void avsubtitle_free(AVSubtitle *sub);
3772 #if FF_API_OLD_ENCODE_AUDIO
3774 * Encode an audio frame from samples into buf.
3776 * @deprecated Use avcodec_encode_audio2 instead.
3778 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3779 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3780 * will know how much space is needed because it depends on the value passed
3781 * in buf_size as described below. In that case a lower value can be used.
3783 * @param avctx the codec context
3784 * @param[out] buf the output buffer
3785 * @param[in] buf_size the output buffer size
3786 * @param[in] samples the input buffer containing the samples
3787 * The number of samples read from this buffer is frame_size*channels,
3788 * both of which are defined in avctx.
3789 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3790 * samples read from samples is equal to:
3791 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3792 * This also implies that av_get_bits_per_sample() must not return 0 for these
3794 * @return On error a negative value is returned, on success zero or the number
3795 * of bytes used to encode the data read from the input buffer.
3797 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3798 uint8_t *buf, int buf_size,
3799 const short *samples);
3803 * Encode a frame of audio.
3805 * Takes input samples from frame and writes the next output packet, if
3806 * available, to avpkt. The output packet does not necessarily contain data for
3807 * the most recent frame, as encoders can delay, split, and combine input frames
3808 * internally as needed.
3810 * @param avctx codec context
3811 * @param avpkt output AVPacket.
3812 * The user can supply an output buffer by setting
3813 * avpkt->data and avpkt->size prior to calling the
3814 * function, but if the size of the user-provided data is not
3815 * large enough, encoding will fail. All other AVPacket fields
3816 * will be reset by the encoder using av_init_packet(). If
3817 * avpkt->data is NULL, the encoder will allocate it.
3818 * The encoder will set avpkt->size to the size of the
3820 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3821 * May be NULL when flushing an encoder that has the
3822 * CODEC_CAP_DELAY capability set.
3823 * There are 2 codec capabilities that affect the allowed
3824 * values of frame->nb_samples.
3825 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
3826 * frame may be smaller than avctx->frame_size, and all other
3827 * frames must be equal to avctx->frame_size.
3828 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3829 * can have any number of samples.
3830 * If neither is set, frame->nb_samples must be equal to
3831 * avctx->frame_size for all frames.
3832 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3833 * output packet is non-empty, and to 0 if it is
3834 * empty. If the function returns an error, the
3835 * packet can be assumed to be invalid, and the
3836 * value of got_packet_ptr is undefined and should
3838 * @return 0 on success, negative error code on failure
3840 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3841 const AVFrame *frame, int *got_packet_ptr);
3844 * Fill audio frame data and linesize.
3845 * AVFrame extended_data channel pointers are allocated if necessary for
3848 * @param frame the AVFrame
3849 * frame->nb_samples must be set prior to calling the
3850 * function. This function fills in frame->data,
3851 * frame->extended_data, frame->linesize[0].
3852 * @param nb_channels channel count
3853 * @param sample_fmt sample format
3854 * @param buf buffer to use for frame data
3855 * @param buf_size size of buffer
3856 * @param align plane size sample alignment
3857 * @return 0 on success, negative error code on failure
3859 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
3860 enum AVSampleFormat sample_fmt, const uint8_t *buf,
3861 int buf_size, int align);
3864 * Encode a video frame from pict into buf.
3865 * The input picture should be
3866 * stored using a specific format, namely avctx.pix_fmt.
3868 * @param avctx the codec context
3869 * @param[out] buf the output buffer for the bitstream of encoded frame
3870 * @param[in] buf_size the size of the output buffer in bytes
3871 * @param[in] pict the input picture to encode
3872 * @return On error a negative value is returned, on success zero or the number
3873 * of bytes used from the output buffer.
3875 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3876 const AVFrame *pict);
3877 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3878 const AVSubtitle *sub);
3880 int avcodec_close(AVCodecContext *avctx);
3883 * Register all the codecs, parsers and bitstream filters which were enabled at
3884 * configuration time. If you do not call this function you can select exactly
3885 * which formats you want to support, by using the individual registration
3888 * @see avcodec_register
3889 * @see av_register_codec_parser
3890 * @see av_register_bitstream_filter
3892 void avcodec_register_all(void);
3895 * Flush buffers, should be called when seeking or when switching to a different stream.
3897 void avcodec_flush_buffers(AVCodecContext *avctx);
3899 void avcodec_default_free_buffers(AVCodecContext *s);
3901 /* misc useful functions */
3904 * Return codec bits per sample.
3906 * @param[in] codec_id the codec
3907 * @return Number of bits per sample or zero if unknown for the given codec.
3909 int av_get_bits_per_sample(enum CodecID codec_id);
3912 typedef struct AVCodecParserContext {
3914 struct AVCodecParser *parser;
3915 int64_t frame_offset; /* offset of the current frame */
3916 int64_t cur_offset; /* current offset
3917 (incremented by each av_parser_parse()) */
3918 int64_t next_frame_offset; /* offset of the next frame */
3920 int pict_type; /* XXX: Put it back in AVCodecContext. */
3922 * This field is used for proper frame duration computation in lavf.
3923 * It signals, how much longer the frame duration of the current frame
3924 * is compared to normal frame duration.
3926 * frame_duration = (1 + repeat_pict) * time_base
3928 * It is used by codecs like H.264 to display telecined material.
3930 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3931 int64_t pts; /* pts of the current frame */
3932 int64_t dts; /* dts of the current frame */
3937 int fetch_timestamp;
3939 #define AV_PARSER_PTS_NB 4
3940 int cur_frame_start_index;
3941 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3942 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3943 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3946 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3947 #define PARSER_FLAG_ONCE 0x0002
3948 /// Set if the parser has a valid file offset
3949 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3951 int64_t offset; ///< byte offset from starting packet start
3952 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3955 * Set by parser to 1 for key frames and 0 for non-key frames.
3956 * It is initialized to -1, so if the parser doesn't set this flag,
3957 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3963 * Time difference in stream time base units from the pts of this
3964 * packet to the point at which the output from the decoder has converged
3965 * independent from the availability of previous frames. That is, the
3966 * frames are virtually identical no matter if decoding started from
3967 * the very first frame or from this keyframe.
3968 * Is AV_NOPTS_VALUE if unknown.
3969 * This field is not the display duration of the current frame.
3970 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3973 * The purpose of this field is to allow seeking in streams that have no
3974 * keyframes in the conventional sense. It corresponds to the
3975 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3976 * essential for some types of subtitle streams to ensure that all
3977 * subtitles are correctly displayed after seeking.
3979 int64_t convergence_duration;
3981 // Timestamp generation support:
3983 * Synchronization point for start of timestamp generation.
3985 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3988 * For example, this corresponds to presence of H.264 buffering period
3994 * Offset of the current timestamp against last timestamp sync point in
3995 * units of AVCodecContext.time_base.
3997 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3998 * contain a valid timestamp offset.
4000 * Note that the timestamp of sync point has usually a nonzero
4001 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4002 * the next frame after timestamp sync point will be usually 1.
4004 * For example, this corresponds to H.264 cpb_removal_delay.
4006 int dts_ref_dts_delta;
4009 * Presentation delay of current frame in units of AVCodecContext.time_base.
4011 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4012 * contain valid non-negative timestamp delta (presentation time of a frame
4013 * must not lie in the past).
4015 * This delay represents the difference between decoding and presentation
4016 * time of the frame.
4018 * For example, this corresponds to H.264 dpb_output_delay.
4023 * Position of the packet in file.
4025 * Analogous to cur_frame_pts/dts
4027 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4030 * Byte position of currently parsed frame in stream.
4035 * Previous frame byte position.
4038 } AVCodecParserContext;
4040 typedef struct AVCodecParser {
4041 int codec_ids[5]; /* several codec IDs are permitted */
4043 int (*parser_init)(AVCodecParserContext *s);
4044 int (*parser_parse)(AVCodecParserContext *s,
4045 AVCodecContext *avctx,
4046 const uint8_t **poutbuf, int *poutbuf_size,
4047 const uint8_t *buf, int buf_size);
4048 void (*parser_close)(AVCodecParserContext *s);
4049 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4050 struct AVCodecParser *next;
4053 AVCodecParser *av_parser_next(AVCodecParser *c);
4055 void av_register_codec_parser(AVCodecParser *parser);
4056 AVCodecParserContext *av_parser_init(int codec_id);
4061 * @param s parser context.
4062 * @param avctx codec context.
4063 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4064 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4065 * @param buf input buffer.
4066 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4067 * @param pts input presentation timestamp.
4068 * @param dts input decoding timestamp.
4069 * @param pos input byte position in stream.
4070 * @return the number of bytes of the input bitstream used.
4075 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4082 * decode_frame(data, size);
4086 int av_parser_parse2(AVCodecParserContext *s,
4087 AVCodecContext *avctx,
4088 uint8_t **poutbuf, int *poutbuf_size,
4089 const uint8_t *buf, int buf_size,
4090 int64_t pts, int64_t dts,
4093 int av_parser_change(AVCodecParserContext *s,
4094 AVCodecContext *avctx,
4095 uint8_t **poutbuf, int *poutbuf_size,
4096 const uint8_t *buf, int buf_size, int keyframe);
4097 void av_parser_close(AVCodecParserContext *s);
4100 typedef struct AVBitStreamFilterContext {
4102 struct AVBitStreamFilter *filter;
4103 AVCodecParserContext *parser;
4104 struct AVBitStreamFilterContext *next;
4105 } AVBitStreamFilterContext;
4108 typedef struct AVBitStreamFilter {
4111 int (*filter)(AVBitStreamFilterContext *bsfc,
4112 AVCodecContext *avctx, const char *args,
4113 uint8_t **poutbuf, int *poutbuf_size,
4114 const uint8_t *buf, int buf_size, int keyframe);
4115 void (*close)(AVBitStreamFilterContext *bsfc);
4116 struct AVBitStreamFilter *next;
4117 } AVBitStreamFilter;
4119 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4120 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4121 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4122 AVCodecContext *avctx, const char *args,
4123 uint8_t **poutbuf, int *poutbuf_size,
4124 const uint8_t *buf, int buf_size, int keyframe);
4125 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4127 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4132 * Reallocate the given block if it is not large enough, otherwise do nothing.
4136 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4139 * Allocate a buffer, reusing the given one if large enough.
4141 * Contrary to av_fast_realloc the current buffer contents might not be
4142 * preserved and on error the old buffer is freed, thus no special
4143 * handling to avoid memleaks is necessary.
4145 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4146 * @param size size of the buffer *ptr points to
4147 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4148 * *size 0 if an error occurred.
4150 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4153 * Copy image src to dst. Wraps av_picture_data_copy() above.
4155 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4156 enum PixelFormat pix_fmt, int width, int height);
4159 * Crop image top and left side.
4161 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4162 enum PixelFormat pix_fmt, int top_band, int left_band);
4167 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4168 int padtop, int padbottom, int padleft, int padright, int *color);
4171 * Encode extradata length to a buffer. Used by xiph codecs.
4173 * @param s buffer to write to; must be at least (v/255+1) bytes long
4174 * @param v size of extradata in bytes
4175 * @return number of bytes written to the buffer.
4177 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4180 * Log a generic warning message about a missing feature. This function is
4181 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4182 * only, and would normally not be used by applications.
4183 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4184 * a pointer to an AVClass struct
4185 * @param[in] feature string containing the name of the missing feature
4186 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4187 * If want_sample is non-zero, additional verbage will be added to the log
4188 * message which tells the user how to report samples to the development
4191 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4194 * Log a generic warning message asking for a sample. This function is
4195 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4196 * only, and would normally not be used by applications.
4197 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4198 * a pointer to an AVClass struct
4199 * @param[in] msg string containing an optional message, or NULL if no message
4201 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4204 * Register the hardware accelerator hwaccel.
4206 void av_register_hwaccel(AVHWAccel *hwaccel);
4209 * If hwaccel is NULL, returns the first registered hardware accelerator,
4210 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4211 * after hwaccel, or NULL if hwaccel is the last one.
4213 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4217 * Lock operation used by lockmgr
4220 AV_LOCK_CREATE, ///< Create a mutex
4221 AV_LOCK_OBTAIN, ///< Lock the mutex
4222 AV_LOCK_RELEASE, ///< Unlock the mutex
4223 AV_LOCK_DESTROY, ///< Free mutex resources
4227 * Register a user provided lock manager supporting the operations
4228 * specified by AVLockOp. mutex points to a (void *) where the
4229 * lockmgr should store/get a pointer to a user allocated mutex. It's
4230 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4232 * @param cb User defined callback. Note: Libav may invoke calls to this
4233 * callback during the call to av_lockmgr_register().
4234 * Thus, the application must be prepared to handle that.
4235 * If cb is set to NULL the lockmgr will be unregistered.
4236 * Also note that during unregistration the previously registered
4237 * lockmgr callback may also be invoked.
4239 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4242 * Get the type of the given codec.
4244 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4247 * Get the AVClass for AVCodecContext. It can be used in combination with
4248 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4250 * @see av_opt_find().
4252 const AVClass *avcodec_get_class(void);
4254 #endif /* AVCODEC_AVCODEC_H */