2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * Libav is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
40 * @defgroup libavc Encoding/Decoding Library
43 * @defgroup lavc_decoding Decoding
47 * @defgroup lavc_encoding Encoding
51 * @defgroup lavc_codec Codecs
53 * @defgroup lavc_codec_native Native Codecs
56 * @defgroup lavc_codec_wrappers External library wrappers
59 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
63 * @defgroup lavc_internal Internal
72 * Identify the syntax and semantics of the bitstream.
73 * The principle is roughly:
74 * Two decoders with the same ID can decode the same streams.
75 * Two encoders with the same ID can encode compatible streams.
76 * There may be slight deviations from the principle due to implementation
79 * If you add a codec ID to this list, add it so that
80 * 1. no value of a existing codec ID changes (that would break ABI),
81 * 2. it is as close as possible to similar codecs.
88 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
89 CODEC_ID_MPEG2VIDEO_XVMC,
126 CODEC_ID_INTERPLAY_VIDEO,
138 CODEC_ID_TRUEMOTION1,
165 CODEC_ID_TRUEMOTION2,
182 CODEC_ID_DSICINVIDEO,
183 CODEC_ID_TIERTEXSEQVIDEO,
186 #if LIBAVCODEC_VERSION_MAJOR == 53
194 CODEC_ID_BETHSOFTVID,
206 #if LIBAVCODEC_VERSION_MAJOR == 53
214 CODEC_ID_MOTIONPIXELS,
232 CODEC_ID_IFF_BYTERUN1,
248 #if LIBAVCODEC_VERSION_MAJOR == 53
259 /* various PCM "codecs" */
260 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
261 CODEC_ID_PCM_S16LE = 0x10000,
277 CODEC_ID_PCM_S24DAUD,
279 CODEC_ID_PCM_S16LE_PLANAR,
288 CODEC_ID_PCM_S8_PLANAR,
290 /* various ADPCM codecs */
291 CODEC_ID_ADPCM_IMA_QT = 0x11000,
292 CODEC_ID_ADPCM_IMA_WAV,
293 CODEC_ID_ADPCM_IMA_DK3,
294 CODEC_ID_ADPCM_IMA_DK4,
295 CODEC_ID_ADPCM_IMA_WS,
296 CODEC_ID_ADPCM_IMA_SMJPEG,
305 CODEC_ID_ADPCM_YAMAHA,
306 CODEC_ID_ADPCM_SBPRO_4,
307 CODEC_ID_ADPCM_SBPRO_3,
308 CODEC_ID_ADPCM_SBPRO_2,
310 CODEC_ID_ADPCM_IMA_AMV,
311 CODEC_ID_ADPCM_EA_R1,
312 CODEC_ID_ADPCM_EA_R3,
313 CODEC_ID_ADPCM_EA_R2,
314 CODEC_ID_ADPCM_IMA_EA_SEAD,
315 CODEC_ID_ADPCM_IMA_EA_EACS,
316 CODEC_ID_ADPCM_EA_XAS,
317 CODEC_ID_ADPCM_EA_MAXIS_XA,
318 CODEC_ID_ADPCM_IMA_ISS,
320 CODEC_ID_ADPCM_IMA_APC,
323 CODEC_ID_AMR_NB = 0x12000,
326 /* RealAudio codecs*/
327 CODEC_ID_RA_144 = 0x13000,
330 /* various DPCM codecs */
331 CODEC_ID_ROQ_DPCM = 0x14000,
332 CODEC_ID_INTERPLAY_DPCM,
337 CODEC_ID_MP2 = 0x15000,
338 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
349 #if LIBAVCODEC_VERSION_MAJOR == 53
358 CODEC_ID_WESTWOOD_SND1,
359 CODEC_ID_GSM, ///< as in Berlin toast format
367 CODEC_ID_DSICINAUDIO,
371 CODEC_ID_GSM_MS, /* as found in WAV */
380 CODEC_ID_WMALOSSLESS,
389 CODEC_ID_BINKAUDIO_RDFT,
390 CODEC_ID_BINKAUDIO_DCT,
394 #if LIBAVCODEC_VERSION_MAJOR > 53
402 /* subtitle codecs */
403 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
404 CODEC_ID_DVD_SUBTITLE = 0x17000,
405 CODEC_ID_DVB_SUBTITLE,
406 CODEC_ID_TEXT, ///< raw UTF-8 text
410 CODEC_ID_HDMV_PGS_SUBTITLE,
411 CODEC_ID_DVB_TELETEXT,
414 /* other specific kind of codecs (generally used for attachments) */
415 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
416 CODEC_ID_TTF = 0x18000,
418 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
420 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
421 * stream (only used by libavformat) */
422 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
423 * stream (only used by libavformat) */
424 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
427 #if FF_API_OLD_DECODE_AUDIO
429 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
433 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
434 * This is mainly needed because some optimized bitstream readers read
435 * 32 or 64 bit at once and could read over the end.<br>
436 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
437 * MPEG bitstreams could cause overread and segfault.
439 #define FF_INPUT_BUFFER_PADDING_SIZE 8
442 * minimum encoding buffer size
443 * Used to avoid some checks during header writing.
445 #define FF_MIN_BUFFER_SIZE 16384
449 * motion estimation type.
452 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
456 ME_EPZS, ///< enhanced predictive zonal search
457 ME_X1, ///< reserved for experiments
458 ME_HEX, ///< hexagon based search
459 ME_UMH, ///< uneven multi-hexagon search
460 ME_ITER, ///< iterative search
461 ME_TESA, ///< transformed exhaustive search algorithm
465 /* We leave some space between them for extensions (drop some
466 * keyframes for intra-only or drop just some bidir frames). */
467 AVDISCARD_NONE =-16, ///< discard nothing
468 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
469 AVDISCARD_NONREF = 8, ///< discard all non reference
470 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
471 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
472 AVDISCARD_ALL = 48, ///< discard all
475 enum AVColorPrimaries{
476 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
477 AVCOL_PRI_UNSPECIFIED=2,
479 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
480 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
481 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
483 AVCOL_PRI_NB , ///< Not part of ABI
486 enum AVColorTransferCharacteristic{
487 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
488 AVCOL_TRC_UNSPECIFIED=2,
489 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
490 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
491 AVCOL_TRC_NB , ///< Not part of ABI
496 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
497 AVCOL_SPC_UNSPECIFIED=2,
499 AVCOL_SPC_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
500 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
501 AVCOL_SPC_SMPTE240M =7,
502 AVCOL_SPC_NB , ///< Not part of ABI
506 AVCOL_RANGE_UNSPECIFIED=0,
507 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
508 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
509 AVCOL_RANGE_NB , ///< Not part of ABI
513 * X X 3 4 X X are luma samples,
514 * 1 2 1-6 are possible chroma positions
515 * X X 5 6 X 0 is undefined/unknown position
517 enum AVChromaLocation{
518 AVCHROMA_LOC_UNSPECIFIED=0,
519 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
520 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
521 AVCHROMA_LOC_TOPLEFT =3, ///< DV
523 AVCHROMA_LOC_BOTTOMLEFT =5,
524 AVCHROMA_LOC_BOTTOM =6,
525 AVCHROMA_LOC_NB , ///< Not part of ABI
528 enum AVAudioServiceType {
529 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
530 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
531 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
532 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
533 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
534 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
535 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
536 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
537 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
538 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
541 typedef struct RcOverride{
544 int qscale; // If this is 0 then quality_factor will be used instead.
545 float quality_factor;
548 #define FF_MAX_B_FRAMES 16
551 These flags can be passed in AVCodecContext.flags before initialization.
552 Note: Not everything is supported yet.
555 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
556 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
557 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
558 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
559 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
561 * The parent program guarantees that the input for B-frames containing
562 * streams is not written to for at least s->max_b_frames+1 frames, if
563 * this is not set the input will be copied.
565 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
566 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
567 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
568 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
569 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
570 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
571 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
572 location instead of only at frame boundaries. */
573 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
574 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
575 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
576 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
577 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
578 /* Fx : Flag for h263+ extra options */
579 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
580 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
581 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
582 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
583 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
584 #define CODEC_FLAG_CLOSED_GOP 0x80000000
585 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
586 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
587 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
588 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
589 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
590 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
592 /* Unsupported options :
593 * Syntax Arithmetic coding (SAC)
594 * Reference Picture Selection
595 * Independent Segment Decoding */
597 /* codec capabilities */
599 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
601 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
602 * If not set, it might not use get_buffer() at all or use operations that
603 * assume the buffer was allocated by avcodec_default_get_buffer.
605 #define CODEC_CAP_DR1 0x0002
606 #define CODEC_CAP_TRUNCATED 0x0008
607 /* Codec can export data for HW decoding (XvMC). */
608 #define CODEC_CAP_HWACCEL 0x0010
610 * Encoder or decoder requires flushing with NULL input at the end in order to
611 * give the complete and correct output.
613 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
614 * with NULL data. The user can still send NULL data to the public encode
615 * or decode function, but libavcodec will not pass it along to the codec
616 * unless this flag is set.
619 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
620 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
624 * The encoder needs to be fed with NULL data at the end of encoding until the
625 * encoder no longer returns data.
627 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
628 * flag also means that the encoder must set the pts and duration for
629 * each output packet. If this flag is not set, the pts and duration will
630 * be determined by libavcodec from the input frame.
632 #define CODEC_CAP_DELAY 0x0020
634 * Codec can be fed a final frame with a smaller size.
635 * This can be used to prevent truncation of the last audio samples.
637 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
639 * Codec can export data for HW decoding (VDPAU).
641 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
643 * Codec can output multiple frames per AVPacket
644 * Normally demuxers return one frame at a time, demuxers which do not do
645 * are connected to a parser to split what they return into proper frames.
646 * This flag is reserved to the very rare category of codecs which have a
647 * bitstream that cannot be split into frames without timeconsuming
648 * operations like full decoding. Demuxers carring such bitstreams thus
649 * may return multiple frames in a packet. This has many disadvantages like
650 * prohibiting stream copy in many cases thus it should only be considered
653 #define CODEC_CAP_SUBFRAMES 0x0100
655 * Codec is experimental and is thus avoided in favor of non experimental
658 #define CODEC_CAP_EXPERIMENTAL 0x0200
660 * Codec should fill in channel configuration and samplerate instead of container
662 #define CODEC_CAP_CHANNEL_CONF 0x0400
664 * Codec is able to deal with negative linesizes
666 #define CODEC_CAP_NEG_LINESIZES 0x0800
668 * Codec supports frame-level multithreading.
670 #define CODEC_CAP_FRAME_THREADS 0x1000
672 * Codec supports slice-based (or partition-based) multithreading.
674 #define CODEC_CAP_SLICE_THREADS 0x2000
676 * Codec supports changed parameters at any point.
678 #define CODEC_CAP_PARAM_CHANGE 0x4000
680 * Codec supports avctx->thread_count == 0 (auto).
682 #define CODEC_CAP_AUTO_THREADS 0x8000
684 * Audio encoder supports receiving a different number of samples in each call.
686 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
688 //The following defines may change, don't expect compatibility if you use them.
689 #define MB_TYPE_INTRA4x4 0x0001
690 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
691 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
692 #define MB_TYPE_16x16 0x0008
693 #define MB_TYPE_16x8 0x0010
694 #define MB_TYPE_8x16 0x0020
695 #define MB_TYPE_8x8 0x0040
696 #define MB_TYPE_INTERLACED 0x0080
697 #define MB_TYPE_DIRECT2 0x0100 //FIXME
698 #define MB_TYPE_ACPRED 0x0200
699 #define MB_TYPE_GMC 0x0400
700 #define MB_TYPE_SKIP 0x0800
701 #define MB_TYPE_P0L0 0x1000
702 #define MB_TYPE_P1L0 0x2000
703 #define MB_TYPE_P0L1 0x4000
704 #define MB_TYPE_P1L1 0x8000
705 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
706 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
707 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
708 #define MB_TYPE_QUANT 0x00010000
709 #define MB_TYPE_CBP 0x00020000
710 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
714 * This specifies the area which should be displayed.
715 * Note there may be multiple such areas for one frame.
717 typedef struct AVPanScan{
720 * - encoding: Set by user.
721 * - decoding: Set by libavcodec.
726 * width and height in 1/16 pel
727 * - encoding: Set by user.
728 * - decoding: Set by libavcodec.
734 * position of the top left corner in 1/16 pel for up to 3 fields/frames
735 * - encoding: Set by user.
736 * - decoding: Set by libavcodec.
738 int16_t position[3][2];
741 #define FF_QSCALE_TYPE_MPEG1 0
742 #define FF_QSCALE_TYPE_MPEG2 1
743 #define FF_QSCALE_TYPE_H264 2
744 #define FF_QSCALE_TYPE_VP56 3
746 #define FF_BUFFER_TYPE_INTERNAL 1
747 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
748 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
749 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
751 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
752 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
753 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
754 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
756 enum AVPacketSideDataType {
758 AV_PKT_DATA_NEW_EXTRADATA,
759 AV_PKT_DATA_PARAM_CHANGE,
762 typedef struct AVPacket {
764 * Presentation timestamp in AVStream->time_base units; the time at which
765 * the decompressed packet will be presented to the user.
766 * Can be AV_NOPTS_VALUE if it is not stored in the file.
767 * pts MUST be larger or equal to dts as presentation cannot happen before
768 * decompression, unless one wants to view hex dumps. Some formats misuse
769 * the terms dts and pts/cts to mean something different. Such timestamps
770 * must be converted to true pts/dts before they are stored in AVPacket.
774 * Decompression timestamp in AVStream->time_base units; the time at which
775 * the packet is decompressed.
776 * Can be AV_NOPTS_VALUE if it is not stored in the file.
783 * A combination of AV_PKT_FLAG values
787 * Additional packet data that can be provided by the container.
788 * Packet can contain several types of side information.
793 enum AVPacketSideDataType type;
798 * Duration of this packet in AVStream->time_base units, 0 if unknown.
799 * Equals next_pts - this_pts in presentation order.
802 void (*destruct)(struct AVPacket *);
804 int64_t pos; ///< byte position in stream, -1 if unknown
807 * Time difference in AVStream->time_base units from the pts of this
808 * packet to the point at which the output from the decoder has converged
809 * independent from the availability of previous frames. That is, the
810 * frames are virtually identical no matter if decoding started from
811 * the very first frame or from this keyframe.
812 * Is AV_NOPTS_VALUE if unknown.
813 * This field is not the display duration of the current packet.
814 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
817 * The purpose of this field is to allow seeking in streams that have no
818 * keyframes in the conventional sense. It corresponds to the
819 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
820 * essential for some types of subtitle streams to ensure that all
821 * subtitles are correctly displayed after seeking.
823 int64_t convergence_duration;
825 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
826 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
829 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
831 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
832 * s32le channel_count
833 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
834 * u64le channel_layout
835 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
837 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
842 enum AVSideDataParamChangeFlags {
843 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
844 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
845 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
846 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
851 * New fields can be added to the end of AVFRAME with minor version
852 * bumps. Removal, reordering and changes to existing fields require
853 * a major version bump.
854 * sizeof(AVFrame) must not be used outside libav*.
856 typedef struct AVFrame {
857 #if FF_API_DATA_POINTERS
858 #define AV_NUM_DATA_POINTERS 4
860 #define AV_NUM_DATA_POINTERS 8
863 * pointer to the picture/channel planes.
864 * This might be different from the first allocated byte
865 * - encoding: Set by user
866 * - decoding: set by AVCodecContext.get_buffer()
868 uint8_t *data[AV_NUM_DATA_POINTERS];
871 * Size, in bytes, of the data for each picture/channel plane.
873 * For audio, only linesize[0] may be set. For planar audio, each channel
874 * plane must be the same size.
876 * - encoding: Set by user (video only)
877 * - decoding: set by AVCodecContext.get_buffer()
879 int linesize[AV_NUM_DATA_POINTERS];
882 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
883 * This isn't used by libavcodec unless the default get/release_buffer() is used.
887 uint8_t *base[AV_NUM_DATA_POINTERS];
889 * 1 -> keyframe, 0-> not
890 * - encoding: Set by libavcodec.
891 * - decoding: Set by libavcodec.
896 * Picture type of the frame, see ?_TYPE below.
897 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
898 * - decoding: Set by libavcodec.
900 enum AVPictureType pict_type;
903 * presentation timestamp in time_base units (time when frame should be shown to user)
904 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
905 * - encoding: MUST be set by user.
906 * - decoding: Set by libavcodec.
911 * picture number in bitstream order
913 * - decoding: Set by libavcodec.
915 int coded_picture_number;
917 * picture number in display order
919 * - decoding: Set by libavcodec.
921 int display_picture_number;
924 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
925 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
926 * - decoding: Set by libavcodec.
930 #if FF_API_AVFRAME_AGE
934 attribute_deprecated int age;
938 * is this picture used as reference
939 * The values for this are the same as the MpegEncContext.picture_structure
940 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
941 * Set to 4 for delayed, non-reference frames.
943 * - decoding: Set by libavcodec. (before get_buffer() call)).
950 * - decoding: Set by libavcodec.
952 int8_t *qscale_table;
956 * - decoding: Set by libavcodec.
961 * mbskip_table[mb]>=1 if MB didn't change
962 * stride= mb_width = (width+15)>>4
964 * - decoding: Set by libavcodec.
966 uint8_t *mbskip_table;
969 * motion vector table
972 * int mv_sample_log2= 4 - motion_subsample_log2;
973 * int mb_width= (width+15)>>4;
974 * int mv_stride= (mb_width << mv_sample_log2) + 1;
975 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
977 * - encoding: Set by user.
978 * - decoding: Set by libavcodec.
980 int16_t (*motion_val[2])[2];
983 * macroblock type table
984 * mb_type_base + mb_width + 2
985 * - encoding: Set by user.
986 * - decoding: Set by libavcodec.
991 * log2 of the size of the block which a single vector in motion_val represents:
992 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
994 * - decoding: Set by libavcodec.
996 uint8_t motion_subsample_log2;
999 * for some private data of the user
1000 * - encoding: unused
1001 * - decoding: Set by user.
1007 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1008 * - decoding: unused
1010 uint64_t error[AV_NUM_DATA_POINTERS];
1013 * type of the buffer (to keep track of who has to deallocate data[*])
1014 * - encoding: Set by the one who allocates it.
1015 * - decoding: Set by the one who allocates it.
1016 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1021 * When decoding, this signals how much the picture must be delayed.
1022 * extra_delay = repeat_pict / (2*fps)
1023 * - encoding: unused
1024 * - decoding: Set by libavcodec.
1034 * The content of the picture is interlaced.
1035 * - encoding: Set by user.
1036 * - decoding: Set by libavcodec. (default 0)
1038 int interlaced_frame;
1041 * If the content is interlaced, is top field displayed first.
1042 * - encoding: Set by user.
1043 * - decoding: Set by libavcodec.
1045 int top_field_first;
1049 * - encoding: Set by user.
1050 * - decoding: Set by libavcodec.
1052 AVPanScan *pan_scan;
1055 * Tell user application that palette has changed from previous frame.
1056 * - encoding: ??? (no palette-enabled encoder yet)
1057 * - decoding: Set by libavcodec. (default 0).
1059 int palette_has_changed;
1062 * codec suggestion on buffer type if != 0
1063 * - encoding: unused
1064 * - decoding: Set by libavcodec. (before get_buffer() call)).
1070 * - encoding: unused
1071 * - decoding: Set by libavcodec.
1076 * motion reference frame index
1077 * the order in which these are stored can depend on the codec.
1078 * - encoding: Set by user.
1079 * - decoding: Set by libavcodec.
1081 int8_t *ref_index[2];
1084 * reordered opaque 64bit (generally an integer or a double precision float
1085 * PTS but can be anything).
1086 * The user sets AVCodecContext.reordered_opaque to represent the input at
1088 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1089 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1090 * @deprecated in favor of pkt_pts
1091 * - encoding: unused
1092 * - decoding: Read by user.
1094 int64_t reordered_opaque;
1097 * hardware accelerator private data (Libav-allocated)
1098 * - encoding: unused
1099 * - decoding: Set by libavcodec
1101 void *hwaccel_picture_private;
1104 * reordered pts from the last AVPacket that has been input into the decoder
1105 * - encoding: unused
1106 * - decoding: Read by user.
1111 * dts from the last AVPacket that has been input into the decoder
1112 * - encoding: unused
1113 * - decoding: Read by user.
1118 * the AVCodecContext which ff_thread_get_buffer() was last called on
1119 * - encoding: Set by libavcodec.
1120 * - decoding: Set by libavcodec.
1122 struct AVCodecContext *owner;
1125 * used by multithreading to store frame-specific info
1126 * - encoding: Set by libavcodec.
1127 * - decoding: Set by libavcodec.
1129 void *thread_opaque;
1132 * number of audio samples (per channel) described by this frame
1133 * - encoding: unused
1134 * - decoding: Set by libavcodec
1139 * pointers to the data planes/channels.
1141 * For video, this should simply point to data[].
1143 * For planar audio, each channel has a separate data pointer, and
1144 * linesize[0] contains the size of each channel buffer.
1145 * For packed audio, there is just one data pointer, and linesize[0]
1146 * contains the total size of the buffer for all channels.
1148 * Note: Both data and extended_data will always be set by get_buffer(),
1149 * but for planar audio with more channels that can fit in data,
1150 * extended_data must be used by the decoder in order to access all
1154 * decoding: set by AVCodecContext.get_buffer()
1156 uint8_t **extended_data;
1159 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1160 * - encoding: unused
1161 * - decoding: Read by user.
1163 AVRational sample_aspect_ratio;
1166 * width and height of the video frame
1167 * - encoding: unused
1168 * - decoding: Read by user.
1173 * format of the frame, -1 if unknown or unset
1174 * Values correspond to enum PixelFormat for video frames,
1175 * enum AVSampleFormat for audio)
1176 * - encoding: unused
1177 * - decoding: Read by user.
1182 struct AVCodecInternal;
1186 AV_FIELD_PROGRESSIVE,
1187 AV_FIELD_TT, //< Top coded_first, top displayed first
1188 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1189 AV_FIELD_TB, //< Top coded first, bottom displayed first
1190 AV_FIELD_BT, //< Bottom coded first, top displayed first
1194 * main external API structure.
1195 * New fields can be added to the end with minor version bumps.
1196 * Removal, reordering and changes to existing fields require a major
1198 * sizeof(AVCodecContext) must not be used outside libav*.
1200 typedef struct AVCodecContext {
1202 * information on struct for av_log
1203 * - set by avcodec_alloc_context3
1205 const AVClass *av_class;
1207 * the average bitrate
1208 * - encoding: Set by user; unused for constant quantizer encoding.
1209 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1214 * number of bits the bitstream is allowed to diverge from the reference.
1215 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1216 * - encoding: Set by user; unused for constant quantizer encoding.
1217 * - decoding: unused
1219 int bit_rate_tolerance;
1223 * - encoding: Set by user.
1224 * - decoding: Set by user.
1229 * Some codecs need additional format info. It is stored here.
1230 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1231 * specific codec MUST set it correctly otherwise stream copy breaks.
1232 * In general use of this field by muxers is not recommended.
1233 * - encoding: Set by libavcodec.
1234 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1239 * Motion estimation algorithm used for video coding.
1240 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1241 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1242 * - encoding: MUST be set by user.
1243 * - decoding: unused
1248 * some codecs need / can use extradata like Huffman tables.
1249 * mjpeg: Huffman tables
1250 * rv10: additional flags
1251 * mpeg4: global headers (they can be in the bitstream or here)
1252 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1253 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1254 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1255 * - encoding: Set/allocated/freed by libavcodec.
1256 * - decoding: Set/allocated/freed by user.
1262 * This is the fundamental unit of time (in seconds) in terms
1263 * of which frame timestamps are represented. For fixed-fps content,
1264 * timebase should be 1/framerate and timestamp increments should be
1266 * - encoding: MUST be set by user.
1267 * - decoding: Set by libavcodec.
1269 AVRational time_base;
1273 * picture width / height.
1274 * - encoding: MUST be set by user.
1275 * - decoding: Set by libavcodec.
1276 * Note: For compatibility it is possible to set this instead of
1277 * coded_width/height before decoding.
1281 #define FF_ASPECT_EXTENDED 15
1284 * the number of pictures in a group of pictures, or 0 for intra_only
1285 * - encoding: Set by user.
1286 * - decoding: unused
1291 * Pixel format, see PIX_FMT_xxx.
1292 * May be set by the demuxer if known from headers.
1293 * May be overriden by the decoder if it knows better.
1294 * - encoding: Set by user.
1295 * - decoding: Set by user if known, overridden by libavcodec if known
1297 enum PixelFormat pix_fmt;
1300 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1301 * decoder to draw a horizontal band. It improves cache usage. Not
1302 * all codecs can do that. You must check the codec capabilities
1304 * When multithreading is used, it may be called from multiple threads
1305 * at the same time; threads might draw different parts of the same AVFrame,
1306 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1308 * The function is also used by hardware acceleration APIs.
1309 * It is called at least once during frame decoding to pass
1310 * the data needed for hardware render.
1311 * In that mode instead of pixel data, AVFrame points to
1312 * a structure specific to the acceleration API. The application
1313 * reads the structure and can change some fields to indicate progress
1315 * - encoding: unused
1316 * - decoding: Set by user.
1317 * @param height the height of the slice
1318 * @param y the y position of the slice
1319 * @param type 1->top field, 2->bottom field, 3->frame
1320 * @param offset offset into the AVFrame.data from which the slice should be read
1322 void (*draw_horiz_band)(struct AVCodecContext *s,
1323 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1324 int y, int type, int height);
1327 int sample_rate; ///< samples per second
1328 int channels; ///< number of audio channels
1331 * audio sample format
1332 * - encoding: Set by user.
1333 * - decoding: Set by libavcodec.
1335 enum AVSampleFormat sample_fmt; ///< sample format
1337 /* The following data should not be initialized. */
1339 * Samples per packet, initialized when calling 'init'.
1342 int frame_number; ///< audio or video frame number
1345 * Number of frames the decoded output will be delayed relative to
1346 * the encoded input.
1347 * - encoding: Set by libavcodec.
1348 * - decoding: unused
1352 /* - encoding parameters */
1353 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1354 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1358 * - encoding: Set by user.
1359 * - decoding: unused
1365 * - encoding: Set by user.
1366 * - decoding: unused
1371 * maximum quantizer difference between frames
1372 * - encoding: Set by user.
1373 * - decoding: unused
1378 * maximum number of B-frames between non-B-frames
1379 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1380 * - encoding: Set by user.
1381 * - decoding: unused
1386 * qscale factor between IP and B-frames
1387 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1388 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1389 * - encoding: Set by user.
1390 * - decoding: unused
1392 float b_quant_factor;
1394 /** obsolete FIXME remove */
1396 #define FF_RC_STRATEGY_XVID 1
1398 int b_frame_strategy;
1400 struct AVCodec *codec;
1404 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1405 /* do its best to deliver a chunk with size */
1406 /* below rtp_payload_size, the chunk will start */
1407 /* with a start code on some codecs like H.263. */
1408 /* This doesn't take account of any particular */
1409 /* headers inside the transmitted RTP payload. */
1412 /* The RTP callback: This function is called */
1413 /* every time the encoder has a packet to send. */
1414 /* It depends on the encoder if the data starts */
1415 /* with a Start Code (it should). H.263 does. */
1416 /* mb_nb contains the number of macroblocks */
1417 /* encoded in the RTP payload. */
1418 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1420 /* statistics, used for 2-pass encoding */
1431 * number of bits used for the previously encoded frame
1432 * - encoding: Set by libavcodec.
1433 * - decoding: unused
1438 * Private data of the user, can be used to carry app specific stuff.
1439 * - encoding: Set by user.
1440 * - decoding: Set by user.
1444 char codec_name[32];
1445 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1446 enum CodecID codec_id; /* see CODEC_ID_xxx */
1449 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1450 * This is used to work around some encoder bugs.
1451 * A demuxer should set this to what is stored in the field used to identify the codec.
1452 * If there are multiple such fields in a container then the demuxer should choose the one
1453 * which maximizes the information about the used codec.
1454 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1455 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1456 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1458 * - encoding: Set by user, if not then the default based on codec_id will be used.
1459 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1461 unsigned int codec_tag;
1464 * Work around bugs in encoders which sometimes cannot be detected automatically.
1465 * - encoding: Set by user
1466 * - decoding: Set by user
1468 int workaround_bugs;
1469 #define FF_BUG_AUTODETECT 1 ///< autodetection
1470 #define FF_BUG_OLD_MSMPEG4 2
1471 #define FF_BUG_XVID_ILACE 4
1472 #define FF_BUG_UMP4 8
1473 #define FF_BUG_NO_PADDING 16
1474 #define FF_BUG_AMV 32
1475 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1476 #define FF_BUG_QPEL_CHROMA 64
1477 #define FF_BUG_STD_QPEL 128
1478 #define FF_BUG_QPEL_CHROMA2 256
1479 #define FF_BUG_DIRECT_BLOCKSIZE 512
1480 #define FF_BUG_EDGE 1024
1481 #define FF_BUG_HPEL_CHROMA 2048
1482 #define FF_BUG_DC_CLIP 4096
1483 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1484 #define FF_BUG_TRUNCATED 16384
1485 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1488 * luma single coefficient elimination threshold
1489 * - encoding: Set by user.
1490 * - decoding: unused
1492 int luma_elim_threshold;
1495 * chroma single coeff elimination threshold
1496 * - encoding: Set by user.
1497 * - decoding: unused
1499 int chroma_elim_threshold;
1502 * strictly follow the standard (MPEG4, ...).
1503 * - encoding: Set by user.
1504 * - decoding: Set by user.
1505 * Setting this to STRICT or higher means the encoder and decoder will
1506 * generally do stupid things, whereas setting it to unofficial or lower
1507 * will mean the encoder might produce output that is not supported by all
1508 * spec-compliant decoders. Decoders don't differentiate between normal,
1509 * unofficial and experimental (that is, they always try to decode things
1510 * when they can) unless they are explicitly asked to behave stupidly
1511 * (=strictly conform to the specs)
1513 int strict_std_compliance;
1514 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1515 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1516 #define FF_COMPLIANCE_NORMAL 0
1517 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1518 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1521 * qscale offset between IP and B-frames
1522 * - encoding: Set by user.
1523 * - decoding: unused
1525 float b_quant_offset;
1528 * Called at the beginning of each frame to get a buffer for it.
1530 * The function will set AVFrame.data[], AVFrame.linesize[].
1531 * AVFrame.extended_data[] must also be set, but it should be the same as
1532 * AVFrame.data[] except for planar audio with more channels than can fit
1533 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1534 * many data pointers as it can hold.
1536 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1537 * avcodec_default_get_buffer() instead of providing buffers allocated by
1540 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1541 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1542 * but if get_buffer() is overridden then alignment considerations should
1543 * be taken into account.
1545 * @see avcodec_default_get_buffer()
1549 * If pic.reference is set then the frame will be read later by libavcodec.
1550 * avcodec_align_dimensions2() should be used to find the required width and
1551 * height, as they normally need to be rounded up to the next multiple of 16.
1553 * If frame multithreading is used and thread_safe_callbacks is set,
1554 * it may be called from a different thread, but not from more than one at
1555 * once. Does not need to be reentrant.
1557 * @see release_buffer(), reget_buffer()
1558 * @see avcodec_align_dimensions2()
1562 * Decoders request a buffer of a particular size by setting
1563 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1564 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1565 * to a smaller value in the output frame.
1567 * Decoders cannot use the buffer after returning from
1568 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1569 * is assumed to be released immediately upon return.
1571 * As a convenience, av_samples_get_buffer_size() and
1572 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1573 * functions to find the required data size and to fill data pointers and
1574 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1575 * since all planes must be the same size.
1577 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1579 * - encoding: unused
1580 * - decoding: Set by libavcodec, user can override.
1582 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1585 * Called to release buffers which were allocated with get_buffer.
1586 * A released buffer can be reused in get_buffer().
1587 * pic.data[*] must be set to NULL.
1588 * May be called from a different thread if frame multithreading is used,
1589 * but not by more than one thread at once, so does not need to be reentrant.
1590 * - encoding: unused
1591 * - decoding: Set by libavcodec, user can override.
1593 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1596 * Size of the frame reordering buffer in the decoder.
1597 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1598 * - encoding: Set by libavcodec.
1599 * - decoding: Set by libavcodec.
1604 * number of bytes per packet if constant and known or 0
1605 * Used by some WAV based audio codecs.
1610 * 0-> h263 quant 1-> mpeg quant
1611 * - encoding: Set by user.
1612 * - decoding: unused
1617 * pass1 encoding statistics output buffer
1618 * - encoding: Set by libavcodec.
1619 * - decoding: unused
1624 * pass2 encoding statistics input buffer
1625 * Concatenated stuff from stats_out of pass1 should be placed here.
1626 * - encoding: Allocated/set/freed by user.
1627 * - decoding: unused
1632 * ratecontrol qmin qmax limiting method
1633 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1634 * - encoding: Set by user.
1635 * - decoding: unused
1643 * ratecontrol override, see RcOverride
1644 * - encoding: Allocated/set/freed by user.
1645 * - decoding: unused
1647 RcOverride *rc_override;
1648 int rc_override_count;
1651 * rate control equation
1652 * - encoding: Set by user
1653 * - decoding: unused
1659 * - encoding: Set by user.
1660 * - decoding: unused
1666 * - encoding: Set by user.
1667 * - decoding: unused
1672 * decoder bitstream buffer size
1673 * - encoding: Set by user.
1674 * - decoding: unused
1677 float rc_buffer_aggressivity;
1680 * qscale factor between P and I-frames
1681 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1682 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1683 * - encoding: Set by user.
1684 * - decoding: unused
1686 float i_quant_factor;
1689 * qscale offset between P and I-frames
1690 * - encoding: Set by user.
1691 * - decoding: unused
1693 float i_quant_offset;
1696 * initial complexity for pass1 ratecontrol
1697 * - encoding: Set by user.
1698 * - decoding: unused
1700 float rc_initial_cplx;
1703 * DCT algorithm, see FF_DCT_* below
1704 * - encoding: Set by user.
1705 * - decoding: unused
1708 #define FF_DCT_AUTO 0
1709 #define FF_DCT_FASTINT 1
1710 #define FF_DCT_INT 2
1711 #define FF_DCT_MMX 3
1712 #define FF_DCT_MLIB 4
1713 #define FF_DCT_ALTIVEC 5
1714 #define FF_DCT_FAAN 6
1717 * luminance masking (0-> disabled)
1718 * - encoding: Set by user.
1719 * - decoding: unused
1724 * temporary complexity masking (0-> disabled)
1725 * - encoding: Set by user.
1726 * - decoding: unused
1728 float temporal_cplx_masking;
1731 * spatial complexity masking (0-> disabled)
1732 * - encoding: Set by user.
1733 * - decoding: unused
1735 float spatial_cplx_masking;
1738 * p block masking (0-> disabled)
1739 * - encoding: Set by user.
1740 * - decoding: unused
1745 * darkness masking (0-> disabled)
1746 * - encoding: Set by user.
1747 * - decoding: unused
1752 * IDCT algorithm, see FF_IDCT_* below.
1753 * - encoding: Set by user.
1754 * - decoding: Set by user.
1757 #define FF_IDCT_AUTO 0
1758 #define FF_IDCT_INT 1
1759 #define FF_IDCT_SIMPLE 2
1760 #define FF_IDCT_SIMPLEMMX 3
1761 #define FF_IDCT_LIBMPEG2MMX 4
1762 #define FF_IDCT_PS2 5
1763 #define FF_IDCT_MLIB 6
1764 #define FF_IDCT_ARM 7
1765 #define FF_IDCT_ALTIVEC 8
1766 #define FF_IDCT_SH4 9
1767 #define FF_IDCT_SIMPLEARM 10
1768 #define FF_IDCT_H264 11
1769 #define FF_IDCT_VP3 12
1770 #define FF_IDCT_IPP 13
1771 #define FF_IDCT_XVIDMMX 14
1772 #define FF_IDCT_CAVS 15
1773 #define FF_IDCT_SIMPLEARMV5TE 16
1774 #define FF_IDCT_SIMPLEARMV6 17
1775 #define FF_IDCT_SIMPLEVIS 18
1776 #define FF_IDCT_WMV2 19
1777 #define FF_IDCT_FAAN 20
1778 #define FF_IDCT_EA 21
1779 #define FF_IDCT_SIMPLENEON 22
1780 #define FF_IDCT_SIMPLEALPHA 23
1781 #define FF_IDCT_BINK 24
1785 * - encoding: Set by libavcodec.
1786 * - decoding: Set by user (or 0).
1790 * slice offsets in the frame in bytes
1791 * - encoding: Set/allocated by libavcodec.
1792 * - decoding: Set/allocated by user (or NULL).
1797 * error concealment flags
1798 * - encoding: unused
1799 * - decoding: Set by user.
1801 int error_concealment;
1802 #define FF_EC_GUESS_MVS 1
1803 #define FF_EC_DEBLOCK 2
1806 * dsp_mask could be add used to disable unwanted CPU features
1807 * CPU features (i.e. MMX, SSE. ...)
1809 * With the FORCE flag you may instead enable given CPU features.
1810 * (Dangerous: Usable in case of misdetection, improper usage however will
1811 * result into program crash.)
1816 * bits per sample/pixel from the demuxer (needed for huffyuv).
1817 * - encoding: Set by libavcodec.
1818 * - decoding: Set by user.
1820 int bits_per_coded_sample;
1823 * prediction method (needed for huffyuv)
1824 * - encoding: Set by user.
1825 * - decoding: unused
1827 int prediction_method;
1828 #define FF_PRED_LEFT 0
1829 #define FF_PRED_PLANE 1
1830 #define FF_PRED_MEDIAN 2
1833 * sample aspect ratio (0 if unknown)
1834 * That is the width of a pixel divided by the height of the pixel.
1835 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1836 * - encoding: Set by user.
1837 * - decoding: Set by libavcodec.
1839 AVRational sample_aspect_ratio;
1842 * the picture in the bitstream
1843 * - encoding: Set by libavcodec.
1844 * - decoding: Set by libavcodec.
1846 AVFrame *coded_frame;
1850 * - encoding: Set by user.
1851 * - decoding: Set by user.
1854 #define FF_DEBUG_PICT_INFO 1
1855 #define FF_DEBUG_RC 2
1856 #define FF_DEBUG_BITSTREAM 4
1857 #define FF_DEBUG_MB_TYPE 8
1858 #define FF_DEBUG_QP 16
1859 #define FF_DEBUG_MV 32
1860 #define FF_DEBUG_DCT_COEFF 0x00000040
1861 #define FF_DEBUG_SKIP 0x00000080
1862 #define FF_DEBUG_STARTCODE 0x00000100
1863 #define FF_DEBUG_PTS 0x00000200
1864 #define FF_DEBUG_ER 0x00000400
1865 #define FF_DEBUG_MMCO 0x00000800
1866 #define FF_DEBUG_BUGS 0x00001000
1867 #define FF_DEBUG_VIS_QP 0x00002000
1868 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1869 #define FF_DEBUG_BUFFERS 0x00008000
1870 #define FF_DEBUG_THREADS 0x00010000
1874 * - encoding: Set by user.
1875 * - decoding: Set by user.
1878 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1879 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1880 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1884 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1885 * - decoding: unused
1887 uint64_t error[AV_NUM_DATA_POINTERS];
1890 * motion estimation comparison function
1891 * - encoding: Set by user.
1892 * - decoding: unused
1896 * subpixel motion estimation comparison function
1897 * - encoding: Set by user.
1898 * - decoding: unused
1902 * macroblock comparison function (not supported yet)
1903 * - encoding: Set by user.
1904 * - decoding: unused
1908 * interlaced DCT comparison function
1909 * - encoding: Set by user.
1910 * - decoding: unused
1913 #define FF_CMP_SAD 0
1914 #define FF_CMP_SSE 1
1915 #define FF_CMP_SATD 2
1916 #define FF_CMP_DCT 3
1917 #define FF_CMP_PSNR 4
1918 #define FF_CMP_BIT 5
1920 #define FF_CMP_ZERO 7
1921 #define FF_CMP_VSAD 8
1922 #define FF_CMP_VSSE 9
1923 #define FF_CMP_NSSE 10
1924 #define FF_CMP_W53 11
1925 #define FF_CMP_W97 12
1926 #define FF_CMP_DCTMAX 13
1927 #define FF_CMP_DCT264 14
1928 #define FF_CMP_CHROMA 256
1931 * ME diamond size & shape
1932 * - encoding: Set by user.
1933 * - decoding: unused
1938 * amount of previous MV predictors (2a+1 x 2a+1 square)
1939 * - encoding: Set by user.
1940 * - decoding: unused
1942 int last_predictor_count;
1945 * prepass for motion estimation
1946 * - encoding: Set by user.
1947 * - decoding: unused
1952 * motion estimation prepass comparison function
1953 * - encoding: Set by user.
1954 * - decoding: unused
1959 * ME prepass diamond size & shape
1960 * - encoding: Set by user.
1961 * - decoding: unused
1967 * - encoding: Set by user.
1968 * - decoding: unused
1970 int me_subpel_quality;
1973 * callback to negotiate the pixelFormat
1974 * @param fmt is the list of formats which are supported by the codec,
1975 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1976 * The first is always the native one.
1977 * @return the chosen format
1978 * - encoding: unused
1979 * - decoding: Set by user, if not set the native format will be chosen.
1981 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1984 * DTG active format information (additional aspect ratio
1985 * information only used in DVB MPEG-2 transport streams)
1988 * - encoding: unused
1989 * - decoding: Set by decoder.
1991 int dtg_active_format;
1992 #define FF_DTG_AFD_SAME 8
1993 #define FF_DTG_AFD_4_3 9
1994 #define FF_DTG_AFD_16_9 10
1995 #define FF_DTG_AFD_14_9 11
1996 #define FF_DTG_AFD_4_3_SP_14_9 13
1997 #define FF_DTG_AFD_16_9_SP_14_9 14
1998 #define FF_DTG_AFD_SP_4_3 15
2001 * maximum motion estimation search range in subpel units
2002 * If 0 then no limit.
2004 * - encoding: Set by user.
2005 * - decoding: unused
2010 * intra quantizer bias
2011 * - encoding: Set by user.
2012 * - decoding: unused
2014 int intra_quant_bias;
2015 #define FF_DEFAULT_QUANT_BIAS 999999
2018 * inter quantizer bias
2019 * - encoding: Set by user.
2020 * - decoding: unused
2022 int inter_quant_bias;
2026 * - encoding: unused
2027 * - decoding: Which clrtable should be used for 8bit RGB images.
2028 * Tables have to be stored somewhere. FIXME
2032 #if FF_API_INTERNAL_CONTEXT
2034 * internal_buffer count
2035 * Don't touch, used by libavcodec default_get_buffer().
2036 * @deprecated this field was moved to an internal context
2038 attribute_deprecated int internal_buffer_count;
2042 * Don't touch, used by libavcodec default_get_buffer().
2043 * @deprecated this field was moved to an internal context
2045 attribute_deprecated void *internal_buffer;
2049 * Global quality for codecs which cannot change it per frame.
2050 * This should be proportional to MPEG-1/2/4 qscale.
2051 * - encoding: Set by user.
2052 * - decoding: unused
2056 #define FF_CODER_TYPE_VLC 0
2057 #define FF_CODER_TYPE_AC 1
2058 #define FF_CODER_TYPE_RAW 2
2059 #define FF_CODER_TYPE_RLE 3
2060 #define FF_CODER_TYPE_DEFLATE 4
2063 * - encoding: Set by user.
2064 * - decoding: unused
2070 * - encoding: Set by user.
2071 * - decoding: unused
2077 * - encoding: unused
2078 * - decoding: Set by user.
2080 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2085 * - encoding: unused
2086 * - decoding: Set by user.
2089 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2090 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2091 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2094 * XVideo Motion Acceleration
2095 * - encoding: forbidden
2096 * - decoding: set by decoder
2098 int xvmc_acceleration;
2101 * macroblock decision mode
2102 * - encoding: Set by user.
2103 * - decoding: unused
2106 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2107 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2108 #define FF_MB_DECISION_RD 2 ///< rate distortion
2111 * custom intra quantization matrix
2112 * - encoding: Set by user, can be NULL.
2113 * - decoding: Set by libavcodec.
2115 uint16_t *intra_matrix;
2118 * custom inter quantization matrix
2119 * - encoding: Set by user, can be NULL.
2120 * - decoding: Set by libavcodec.
2122 uint16_t *inter_matrix;
2125 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2126 * This is used to work around some encoder bugs.
2127 * - encoding: unused
2128 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2130 unsigned int stream_codec_tag;
2133 * scene change detection threshold
2134 * 0 is default, larger means fewer detected scene changes.
2135 * - encoding: Set by user.
2136 * - decoding: unused
2138 int scenechange_threshold;
2141 * minimum Lagrange multipler
2142 * - encoding: Set by user.
2143 * - decoding: unused
2148 * maximum Lagrange multipler
2149 * - encoding: Set by user.
2150 * - decoding: unused
2155 * noise reduction strength
2156 * - encoding: Set by user.
2157 * - decoding: unused
2159 int noise_reduction;
2162 * Called at the beginning of a frame to get cr buffer for it.
2163 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2164 * libavcodec will pass previous buffer in pic, function should return
2165 * same buffer or new buffer with old frame "painted" into it.
2166 * If pic.data[0] == NULL must behave like get_buffer().
2167 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2168 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2170 * - encoding: unused
2171 * - decoding: Set by libavcodec, user can override.
2173 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2176 * Number of bits which should be loaded into the rc buffer before decoding starts.
2177 * - encoding: Set by user.
2178 * - decoding: unused
2180 int rc_initial_buffer_occupancy;
2184 * - encoding: Set by user.
2185 * - decoding: unused
2187 int inter_threshold;
2191 * - encoding: Set by user.
2192 * - decoding: Set by user.
2197 * Simulates errors in the bitstream to test error concealment.
2198 * - encoding: Set by user.
2199 * - decoding: unused
2204 * quantizer noise shaping
2205 * - encoding: Set by user.
2206 * - decoding: unused
2208 int quantizer_noise_shaping;
2212 * is used to decide how many independent tasks should be passed to execute()
2213 * - encoding: Set by user.
2214 * - decoding: Set by user.
2219 * The codec may call this to execute several independent things.
2220 * It will return only after finishing all tasks.
2221 * The user may replace this with some multithreaded implementation,
2222 * the default implementation will execute the parts serially.
2223 * @param count the number of things to execute
2224 * - encoding: Set by libavcodec, user can override.
2225 * - decoding: Set by libavcodec, user can override.
2227 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2231 * Can be used by execute() to store some per AVCodecContext stuff.
2232 * - encoding: set by execute()
2233 * - decoding: set by execute()
2235 void *thread_opaque;
2238 * Motion estimation threshold below which no motion estimation is
2239 * performed, but instead the user specified motion vectors are used.
2241 * - encoding: Set by user.
2242 * - decoding: unused
2247 * Macroblock threshold below which the user specified macroblock types will be used.
2248 * - encoding: Set by user.
2249 * - decoding: unused
2254 * precision of the intra DC coefficient - 8
2255 * - encoding: Set by user.
2256 * - decoding: unused
2258 int intra_dc_precision;
2261 * noise vs. sse weight for the nsse comparsion function
2262 * - encoding: Set by user.
2263 * - decoding: unused
2268 * Number of macroblock rows at the top which are skipped.
2269 * - encoding: unused
2270 * - decoding: Set by user.
2275 * Number of macroblock rows at the bottom which are skipped.
2276 * - encoding: unused
2277 * - decoding: Set by user.
2283 * - encoding: Set by user.
2284 * - decoding: Set by libavcodec.
2287 #define FF_PROFILE_UNKNOWN -99
2288 #define FF_PROFILE_RESERVED -100
2290 #define FF_PROFILE_AAC_MAIN 0
2291 #define FF_PROFILE_AAC_LOW 1
2292 #define FF_PROFILE_AAC_SSR 2
2293 #define FF_PROFILE_AAC_LTP 3
2295 #define FF_PROFILE_DTS 20
2296 #define FF_PROFILE_DTS_ES 30
2297 #define FF_PROFILE_DTS_96_24 40
2298 #define FF_PROFILE_DTS_HD_HRA 50
2299 #define FF_PROFILE_DTS_HD_MA 60
2301 #define FF_PROFILE_MPEG2_422 0
2302 #define FF_PROFILE_MPEG2_HIGH 1
2303 #define FF_PROFILE_MPEG2_SS 2
2304 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2305 #define FF_PROFILE_MPEG2_MAIN 4
2306 #define FF_PROFILE_MPEG2_SIMPLE 5
2308 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2309 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2311 #define FF_PROFILE_H264_BASELINE 66
2312 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2313 #define FF_PROFILE_H264_MAIN 77
2314 #define FF_PROFILE_H264_EXTENDED 88
2315 #define FF_PROFILE_H264_HIGH 100
2316 #define FF_PROFILE_H264_HIGH_10 110
2317 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2318 #define FF_PROFILE_H264_HIGH_422 122
2319 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2320 #define FF_PROFILE_H264_HIGH_444 144
2321 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2322 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2323 #define FF_PROFILE_H264_CAVLC_444 44
2325 #define FF_PROFILE_VC1_SIMPLE 0
2326 #define FF_PROFILE_VC1_MAIN 1
2327 #define FF_PROFILE_VC1_COMPLEX 2
2328 #define FF_PROFILE_VC1_ADVANCED 3
2330 #define FF_PROFILE_MPEG4_SIMPLE 0
2331 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2332 #define FF_PROFILE_MPEG4_CORE 2
2333 #define FF_PROFILE_MPEG4_MAIN 3
2334 #define FF_PROFILE_MPEG4_N_BIT 4
2335 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2336 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2337 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2338 #define FF_PROFILE_MPEG4_HYBRID 8
2339 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2340 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2341 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2342 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2343 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2344 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2345 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2349 * - encoding: Set by user.
2350 * - decoding: Set by libavcodec.
2353 #define FF_LEVEL_UNKNOWN -99
2356 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2357 * - encoding: unused
2358 * - decoding: Set by user.
2363 * Bitstream width / height, may be different from width/height if lowres enabled.
2364 * - encoding: unused
2365 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2367 int coded_width, coded_height;
2370 * frame skip threshold
2371 * - encoding: Set by user.
2372 * - decoding: unused
2374 int frame_skip_threshold;
2378 * - encoding: Set by user.
2379 * - decoding: unused
2381 int frame_skip_factor;
2384 * frame skip exponent
2385 * - encoding: Set by user.
2386 * - decoding: unused
2391 * frame skip comparison function
2392 * - encoding: Set by user.
2393 * - decoding: unused
2398 * Border processing masking, raises the quantizer for mbs on the borders
2400 * - encoding: Set by user.
2401 * - decoding: unused
2403 float border_masking;
2406 * minimum MB lagrange multipler
2407 * - encoding: Set by user.
2408 * - decoding: unused
2413 * maximum MB lagrange multipler
2414 * - encoding: Set by user.
2415 * - decoding: unused
2421 * - encoding: Set by user.
2422 * - decoding: unused
2424 int me_penalty_compensation;
2428 * - encoding: unused
2429 * - decoding: Set by user.
2431 enum AVDiscard skip_loop_filter;
2435 * - encoding: unused
2436 * - decoding: Set by user.
2438 enum AVDiscard skip_idct;
2442 * - encoding: unused
2443 * - decoding: Set by user.
2445 enum AVDiscard skip_frame;
2449 * - encoding: Set by user.
2450 * - decoding: unused
2456 * - encoding: Set by user.
2457 * - decoding: unused
2463 * - encoding: Set by user.
2464 * - decoding: unused
2469 * number of reference frames
2470 * - encoding: Set by user.
2471 * - decoding: Set by lavc.
2476 * chroma qp offset from luma
2477 * - encoding: Set by user.
2478 * - decoding: unused
2483 * trellis RD quantization
2484 * - encoding: Set by user.
2485 * - decoding: unused
2490 * Audio cutoff bandwidth (0 means "automatic")
2491 * - encoding: Set by user.
2492 * - decoding: unused
2497 * Multiplied by qscale for each frame and added to scene_change_score.
2498 * - encoding: Set by user.
2499 * - decoding: unused
2501 int scenechange_factor;
2505 * Note: Value depends upon the compare function used for fullpel ME.
2506 * - encoding: Set by user.
2507 * - decoding: unused
2512 * Adjust sensitivity of b_frame_strategy 1.
2513 * - encoding: Set by user.
2514 * - decoding: unused
2519 * - encoding: Set by user.
2520 * - decoding: unused
2522 int compression_level;
2523 #define FF_COMPRESSION_DEFAULT -1
2526 * - encoding: Set by user.
2527 * - decoding: unused
2529 int min_prediction_order;
2532 * - encoding: Set by user.
2533 * - decoding: unused
2535 int max_prediction_order;
2538 * GOP timecode frame start number, in non drop frame format
2539 * - encoding: Set by user.
2540 * - decoding: unused
2542 int64_t timecode_frame_start;
2544 #if FF_API_REQUEST_CHANNELS
2546 * Decoder should decode to this many channels if it can (0 for default)
2547 * - encoding: unused
2548 * - decoding: Set by user.
2549 * @deprecated Deprecated in favor of request_channel_layout.
2551 int request_channels;
2555 * opaque 64bit number (generally a PTS) that will be reordered and
2556 * output in AVFrame.reordered_opaque
2557 * @deprecated in favor of pkt_pts
2558 * - encoding: unused
2559 * - decoding: Set by user.
2561 int64_t reordered_opaque;
2564 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2565 * - encoding: set by user.
2566 * - decoding: set by libavcodec.
2568 int bits_per_raw_sample;
2571 * Audio channel layout.
2572 * - encoding: set by user.
2573 * - decoding: set by libavcodec.
2575 uint64_t channel_layout;
2578 * Request decoder to use this channel layout if it can (0 for default)
2579 * - encoding: unused
2580 * - decoding: Set by user.
2582 uint64_t request_channel_layout;
2585 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2586 * - encoding: Set by user.
2587 * - decoding: unused.
2589 float rc_max_available_vbv_use;
2592 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2593 * - encoding: Set by user.
2594 * - decoding: unused.
2596 float rc_min_vbv_overflow_use;
2599 * Hardware accelerator in use
2600 * - encoding: unused.
2601 * - decoding: Set by libavcodec
2603 struct AVHWAccel *hwaccel;
2606 * For some codecs, the time base is closer to the field rate than the frame rate.
2607 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2608 * if no telecine is used ...
2610 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2612 int ticks_per_frame;
2615 * Hardware accelerator context.
2616 * For some hardware accelerators, a global context needs to be
2617 * provided by the user. In that case, this holds display-dependent
2618 * data Libav cannot instantiate itself. Please refer to the
2619 * Libav HW accelerator documentation to know how to fill this
2620 * is. e.g. for VA API, this is a struct vaapi_context.
2621 * - encoding: unused
2622 * - decoding: Set by user
2624 void *hwaccel_context;
2627 * Chromaticity coordinates of the source primaries.
2628 * - encoding: Set by user
2629 * - decoding: Set by libavcodec
2631 enum AVColorPrimaries color_primaries;
2634 * Color Transfer Characteristic.
2635 * - encoding: Set by user
2636 * - decoding: Set by libavcodec
2638 enum AVColorTransferCharacteristic color_trc;
2641 * YUV colorspace type.
2642 * - encoding: Set by user
2643 * - decoding: Set by libavcodec
2645 enum AVColorSpace colorspace;
2648 * MPEG vs JPEG YUV range.
2649 * - encoding: Set by user
2650 * - decoding: Set by libavcodec
2652 enum AVColorRange color_range;
2655 * This defines the location of chroma samples.
2656 * - encoding: Set by user
2657 * - decoding: Set by libavcodec
2659 enum AVChromaLocation chroma_sample_location;
2662 * The codec may call this to execute several independent things.
2663 * It will return only after finishing all tasks.
2664 * The user may replace this with some multithreaded implementation,
2665 * the default implementation will execute the parts serially.
2666 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2667 * @param c context passed also to func
2668 * @param count the number of things to execute
2669 * @param arg2 argument passed unchanged to func
2670 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2671 * @param func function that will be called count times, with jobnr from 0 to count-1.
2672 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2673 * two instances of func executing at the same time will have the same threadnr.
2674 * @return always 0 currently, but code should handle a future improvement where when any call to func
2675 * returns < 0 no further calls to func may be done and < 0 is returned.
2676 * - encoding: Set by libavcodec, user can override.
2677 * - decoding: Set by libavcodec, user can override.
2679 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2681 int log_level_offset;
2685 * Indicates number of picture subdivisions. Used for parallelized
2687 * - encoding: Set by user
2688 * - decoding: unused
2693 * Header containing style information for text subtitles.
2694 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2695 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2696 * the Format line following. It shouldn't include any Dialogue line.
2697 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2698 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2700 uint8_t *subtitle_header;
2701 int subtitle_header_size;
2704 * Current packet as passed into the decoder, to avoid having
2705 * to pass the packet into every function. Currently only valid
2706 * inside lavc and get/release_buffer callbacks.
2707 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2708 * - encoding: unused
2712 #if FF_API_INTERNAL_CONTEXT
2714 * Whether this is a copy of the context which had init() called on it.
2715 * This is used by multithreading - shared tables and picture pointers
2716 * should be freed from the original context only.
2717 * - encoding: Set by libavcodec.
2718 * - decoding: Set by libavcodec.
2720 * @deprecated this field has been moved to an internal context
2722 attribute_deprecated int is_copy;
2726 * Which multithreading methods to use.
2727 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2728 * so clients which cannot provide future frames should not use it.
2730 * - encoding: Set by user, otherwise the default is used.
2731 * - decoding: Set by user, otherwise the default is used.
2734 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2735 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2738 * Which multithreading methods are in use by the codec.
2739 * - encoding: Set by libavcodec.
2740 * - decoding: Set by libavcodec.
2742 int active_thread_type;
2745 * Set by the client if its custom get_buffer() callback can be called
2746 * from another thread, which allows faster multithreaded decoding.
2747 * draw_horiz_band() will be called from other threads regardless of this setting.
2748 * Ignored if the default get_buffer() is used.
2749 * - encoding: Set by user.
2750 * - decoding: Set by user.
2752 int thread_safe_callbacks;
2755 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2756 * Used for compliant TS muxing.
2757 * - encoding: Set by libavcodec.
2758 * - decoding: unused.
2763 * Type of service that the audio stream conveys.
2764 * - encoding: Set by user.
2765 * - decoding: Set by libavcodec.
2767 enum AVAudioServiceType audio_service_type;
2770 * Used to request a sample format from the decoder.
2771 * - encoding: unused.
2772 * - decoding: Set by user.
2774 enum AVSampleFormat request_sample_fmt;
2777 * Error recognition; may misdetect some more or less valid parts as errors.
2778 * - encoding: unused
2779 * - decoding: Set by user.
2781 int err_recognition;
2782 #define AV_EF_CRCCHECK (1<<0)
2783 #define AV_EF_BITSTREAM (1<<1)
2784 #define AV_EF_BUFFER (1<<2)
2785 #define AV_EF_EXPLODE (1<<3)
2788 * Private context used for internal data.
2790 * Unlike priv_data, this is not codec-specific. It is used in general
2791 * libavcodec functions.
2793 struct AVCodecInternal *internal;
2796 * - encoding: set by libavcodec
2797 * - decoding: Set by libavcodec
2799 enum AVFieldOrder field_order;
2805 typedef struct AVProfile {
2807 const char *name; ///< short name for the profile
2810 typedef struct AVCodecDefault AVCodecDefault;
2815 typedef struct AVCodec {
2817 * Name of the codec implementation.
2818 * The name is globally unique among encoders and among decoders (but an
2819 * encoder and a decoder can share the same name).
2820 * This is the primary way to find a codec from the user perspective.
2823 enum AVMediaType type;
2826 int (*init)(AVCodecContext *);
2827 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2828 int (*close)(AVCodecContext *);
2829 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2831 * Codec capabilities.
2835 struct AVCodec *next;
2838 * Will be called when seeking
2840 void (*flush)(AVCodecContext *);
2841 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2842 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2844 * Descriptive name for the codec, meant to be more human readable than name.
2845 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2847 const char *long_name;
2848 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2849 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2850 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2851 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2852 const AVClass *priv_class; ///< AVClass for the private context
2853 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2856 * @name Frame-level threading support functions
2860 * If defined, called on thread contexts when they are created.
2861 * If the codec allocates writable tables in init(), re-allocate them here.
2862 * priv_data will be set to a copy of the original.
2864 int (*init_thread_copy)(AVCodecContext *);
2866 * Copy necessary context variables from a previous thread context to the current one.
2867 * If not defined, the next thread will start automatically; otherwise, the codec
2868 * must call ff_thread_finish_setup().
2870 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2872 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2876 * Private codec-specific defaults.
2878 const AVCodecDefault *defaults;
2881 * Initialize codec static data, called from avcodec_register().
2883 void (*init_static_data)(struct AVCodec *codec);
2886 * Encode data to an AVPacket.
2888 * @param avctx codec context
2889 * @param avpkt output AVPacket (may contain a user-provided buffer)
2890 * @param[in] frame AVFrame containing the raw data to be encoded
2891 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2892 * non-empty packet was returned in avpkt.
2893 * @return 0 on success, negative error code on failure
2895 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2896 int *got_packet_ptr);
2902 typedef struct AVHWAccel {
2904 * Name of the hardware accelerated codec.
2905 * The name is globally unique among encoders and among decoders (but an
2906 * encoder and a decoder can share the same name).
2911 * Type of codec implemented by the hardware accelerator.
2913 * See AVMEDIA_TYPE_xxx
2915 enum AVMediaType type;
2918 * Codec implemented by the hardware accelerator.
2925 * Supported pixel format.
2927 * Only hardware accelerated formats are supported here.
2929 enum PixelFormat pix_fmt;
2932 * Hardware accelerated codec capabilities.
2933 * see FF_HWACCEL_CODEC_CAP_*
2937 struct AVHWAccel *next;
2940 * Called at the beginning of each frame or field picture.
2942 * Meaningful frame information (codec specific) is guaranteed to
2943 * be parsed at this point. This function is mandatory.
2945 * Note that buf can be NULL along with buf_size set to 0.
2946 * Otherwise, this means the whole frame is available at this point.
2948 * @param avctx the codec context
2949 * @param buf the frame data buffer base
2950 * @param buf_size the size of the frame in bytes
2951 * @return zero if successful, a negative value otherwise
2953 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2956 * Callback for each slice.
2958 * Meaningful slice information (codec specific) is guaranteed to
2959 * be parsed at this point. This function is mandatory.
2961 * @param avctx the codec context
2962 * @param buf the slice data buffer base
2963 * @param buf_size the size of the slice in bytes
2964 * @return zero if successful, a negative value otherwise
2966 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2969 * Called at the end of each frame or field picture.
2971 * The whole picture is parsed at this point and can now be sent
2972 * to the hardware accelerator. This function is mandatory.
2974 * @param avctx the codec context
2975 * @return zero if successful, a negative value otherwise
2977 int (*end_frame)(AVCodecContext *avctx);
2980 * Size of HW accelerator private data.
2982 * Private data is allocated with av_mallocz() before
2983 * AVCodecContext.get_buffer() and deallocated after
2984 * AVCodecContext.release_buffer().
2990 * four components are given, that's all.
2991 * the last component is alpha
2993 typedef struct AVPicture {
2994 uint8_t *data[AV_NUM_DATA_POINTERS];
2995 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
2998 #define AVPALETTE_SIZE 1024
2999 #define AVPALETTE_COUNT 256
3001 enum AVSubtitleType {
3004 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3007 * Plain text, the text field must be set by the decoder and is
3008 * authoritative. ass and pict fields may contain approximations.
3013 * Formatted text, the ass field must be set by the decoder and is
3014 * authoritative. pict and text fields may contain approximations.
3019 typedef struct AVSubtitleRect {
3020 int x; ///< top left corner of pict, undefined when pict is not set
3021 int y; ///< top left corner of pict, undefined when pict is not set
3022 int w; ///< width of pict, undefined when pict is not set
3023 int h; ///< height of pict, undefined when pict is not set
3024 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3027 * data+linesize for the bitmap of this subtitle.
3028 * can be set for text/ass as well once they where rendered
3031 enum AVSubtitleType type;
3033 char *text; ///< 0 terminated plain UTF-8 text
3036 * 0 terminated ASS/SSA compatible event line.
3037 * The pressentation of this is unaffected by the other values in this
3043 typedef struct AVSubtitle {
3044 uint16_t format; /* 0 = graphics */
3045 uint32_t start_display_time; /* relative to packet pts, in ms */
3046 uint32_t end_display_time; /* relative to packet pts, in ms */
3048 AVSubtitleRect **rects;
3049 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3052 /* packet functions */
3055 * @deprecated use NULL instead
3057 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3060 * Default packet destructor.
3062 void av_destruct_packet(AVPacket *pkt);
3065 * Initialize optional fields of a packet with default values.
3069 void av_init_packet(AVPacket *pkt);
3072 * Allocate the payload of a packet and initialize its fields with
3076 * @param size wanted payload size
3077 * @return 0 if OK, AVERROR_xxx otherwise
3079 int av_new_packet(AVPacket *pkt, int size);
3082 * Reduce packet size, correctly zeroing padding
3085 * @param size new size
3087 void av_shrink_packet(AVPacket *pkt, int size);
3090 * Increase packet size, correctly zeroing padding
3093 * @param grow_by number of bytes by which to increase the size of the packet
3095 int av_grow_packet(AVPacket *pkt, int grow_by);
3098 * @warning This is a hack - the packet memory allocation stuff is broken. The
3099 * packet is allocated if it was not really allocated.
3101 int av_dup_packet(AVPacket *pkt);
3106 * @param pkt packet to free
3108 void av_free_packet(AVPacket *pkt);
3111 * Allocate new information of a packet.
3114 * @param type side information type
3115 * @param size side information size
3116 * @return pointer to fresh allocated data or NULL otherwise
3118 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3122 * Get side information from packet.
3125 * @param type desired side information type
3126 * @param size pointer for side information size to store (optional)
3127 * @return pointer to data if present or NULL otherwise
3129 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3134 struct ReSampleContext;
3135 struct AVResampleContext;
3137 typedef struct ReSampleContext ReSampleContext;
3140 * Initialize audio resampling context.
3142 * @param output_channels number of output channels
3143 * @param input_channels number of input channels
3144 * @param output_rate output sample rate
3145 * @param input_rate input sample rate
3146 * @param sample_fmt_out requested output sample format
3147 * @param sample_fmt_in input sample format
3148 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3149 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3150 * @param linear if 1 then the used FIR filter will be linearly interpolated
3151 between the 2 closest, if 0 the closest will be used
3152 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3153 * @return allocated ReSampleContext, NULL if error occurred
3155 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3156 int output_rate, int input_rate,
3157 enum AVSampleFormat sample_fmt_out,
3158 enum AVSampleFormat sample_fmt_in,
3159 int filter_length, int log2_phase_count,
3160 int linear, double cutoff);
3162 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3165 * Free resample context.
3167 * @param s a non-NULL pointer to a resample context previously
3168 * created with av_audio_resample_init()
3170 void audio_resample_close(ReSampleContext *s);
3174 * Initialize an audio resampler.
3175 * Note, if either rate is not an integer then simply scale both rates up so they are.
3176 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3177 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3178 * @param linear If 1 then the used FIR filter will be linearly interpolated
3179 between the 2 closest, if 0 the closest will be used
3180 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3182 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3185 * Resample an array of samples using a previously configured context.
3186 * @param src an array of unconsumed samples
3187 * @param consumed the number of samples of src which have been consumed are returned here
3188 * @param src_size the number of unconsumed samples available
3189 * @param dst_size the amount of space in samples available in dst
3190 * @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.
3191 * @return the number of samples written in dst or -1 if an error occurred
3193 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3197 * Compensate samplerate/timestamp drift. The compensation is done by changing
3198 * the resampler parameters, so no audible clicks or similar distortions occur
3199 * @param compensation_distance distance in output samples over which the compensation should be performed
3200 * @param sample_delta number of output samples which should be output less
3202 * example: av_resample_compensate(c, 10, 500)
3203 * here instead of 510 samples only 500 samples would be output
3205 * note, due to rounding the actual compensation might be slightly different,
3206 * especially if the compensation_distance is large and the in_rate used during init is small
3208 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3209 void av_resample_close(struct AVResampleContext *c);
3212 * Allocate memory for a picture. Call avpicture_free() to free it.
3214 * @see avpicture_fill()
3216 * @param picture the picture to be filled in
3217 * @param pix_fmt the format of the picture
3218 * @param width the width of the picture
3219 * @param height the height of the picture
3220 * @return zero if successful, a negative value if not
3222 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3225 * Free a picture previously allocated by avpicture_alloc().
3226 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3229 * @param picture the AVPicture to be freed
3231 void avpicture_free(AVPicture *picture);
3234 * Fill in the AVPicture fields.
3235 * The fields of the given AVPicture are filled in by using the 'ptr' address
3236 * which points to the image data buffer. Depending on the specified picture
3237 * format, one or multiple image data pointers and line sizes will be set.
3238 * If a planar format is specified, several pointers will be set pointing to
3239 * the different picture planes and the line sizes of the different planes
3240 * will be stored in the lines_sizes array.
3241 * Call with ptr == NULL to get the required size for the ptr buffer.
3243 * To allocate the buffer and fill in the AVPicture fields in one call,
3244 * use avpicture_alloc().
3246 * @param picture AVPicture whose fields are to be filled in
3247 * @param ptr Buffer which will contain or contains the actual image data
3248 * @param pix_fmt The format in which the picture data is stored.
3249 * @param width the width of the image in pixels
3250 * @param height the height of the image in pixels
3251 * @return size of the image data in bytes
3253 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3254 enum PixelFormat pix_fmt, int width, int height);
3257 * Copy pixel data from an AVPicture into a buffer.
3258 * The data is stored compactly, without any gaps for alignment or padding
3259 * which may be applied by avpicture_fill().
3261 * @see avpicture_get_size()
3263 * @param[in] src AVPicture containing image data
3264 * @param[in] pix_fmt The format in which the picture data is stored.
3265 * @param[in] width the width of the image in pixels.
3266 * @param[in] height the height of the image in pixels.
3267 * @param[out] dest A buffer into which picture data will be copied.
3268 * @param[in] dest_size The size of 'dest'.
3269 * @return The number of bytes written to dest, or a negative value (error code) on error.
3271 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3272 unsigned char *dest, int dest_size);
3275 * Calculate the size in bytes that a picture of the given width and height
3276 * would occupy if stored in the given picture format.
3277 * Note that this returns the size of a compact representation as generated
3278 * by avpicture_layout(), which can be smaller than the size required for e.g.
3281 * @param pix_fmt the given picture format
3282 * @param width the width of the image
3283 * @param height the height of the image
3284 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3286 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3287 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3289 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3292 * Return a value representing the fourCC code associated to the
3293 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3296 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3299 * Put a string representing the codec tag codec_tag in buf.
3301 * @param buf_size size in bytes of buf
3302 * @return the length of the string that would have been generated if
3303 * enough space had been available, excluding the trailing null
3305 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3307 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3308 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3309 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3310 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3311 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3312 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3315 * Compute what kind of losses will occur when converting from one specific
3316 * pixel format to another.
3317 * When converting from one pixel format to another, information loss may occur.
3318 * For example, when converting from RGB24 to GRAY, the color information will
3319 * be lost. Similarly, other losses occur when converting from some formats to
3320 * other formats. These losses can involve loss of chroma, but also loss of
3321 * resolution, loss of color depth, loss due to the color space conversion, loss
3322 * of the alpha bits or loss due to color quantization.
3323 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3324 * which will occur when converting from one pixel format to another.
3326 * @param[in] dst_pix_fmt destination pixel format
3327 * @param[in] src_pix_fmt source pixel format
3328 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3329 * @return Combination of flags informing you what kind of losses will occur.
3331 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3335 * Find the best pixel format to convert to given a certain source pixel
3336 * format. When converting from one pixel format to another, information loss
3337 * may occur. For example, when converting from RGB24 to GRAY, the color
3338 * information will be lost. Similarly, other losses occur when converting from
3339 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3340 * the given pixel formats should be used to suffer the least amount of loss.
3341 * The pixel formats from which it chooses one, are determined by the
3342 * pix_fmt_mask parameter.
3345 * src_pix_fmt = PIX_FMT_YUV420P;
3346 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3347 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3350 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3351 * @param[in] src_pix_fmt source pixel format
3352 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3353 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3354 * @return The best pixel format to convert to or -1 if none was found.
3356 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3357 int has_alpha, int *loss_ptr);
3359 /* deinterlace a picture */
3360 /* deinterlace - if not supported return -1 */
3361 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3362 enum PixelFormat pix_fmt, int width, int height);
3364 /* external high level API */
3367 * If c is NULL, returns the first registered codec,
3368 * if c is non-NULL, returns the next registered codec after c,
3369 * or NULL if c is the last one.
3371 AVCodec *av_codec_next(AVCodec *c);
3374 * Return the LIBAVCODEC_VERSION_INT constant.
3376 unsigned avcodec_version(void);
3379 * Return the libavcodec build-time configuration.
3381 const char *avcodec_configuration(void);
3384 * Return the libavcodec license.
3386 const char *avcodec_license(void);
3389 * Register the codec codec and initialize libavcodec.
3391 * @warning either this function or avcodec_register_all() must be called
3392 * before any other libavcodec functions.
3394 * @see avcodec_register_all()
3396 void avcodec_register(AVCodec *codec);
3399 * Find a registered encoder with a matching codec ID.
3401 * @param id CodecID of the requested encoder
3402 * @return An encoder if one was found, NULL otherwise.
3404 AVCodec *avcodec_find_encoder(enum CodecID id);
3407 * Find a registered encoder with the specified name.
3409 * @param name name of the requested encoder
3410 * @return An encoder if one was found, NULL otherwise.
3412 AVCodec *avcodec_find_encoder_by_name(const char *name);
3415 * Find a registered decoder with a matching codec ID.
3417 * @param id CodecID of the requested decoder
3418 * @return A decoder if one was found, NULL otherwise.
3420 AVCodec *avcodec_find_decoder(enum CodecID id);
3423 * Find a registered decoder with the specified name.
3425 * @param name name of the requested decoder
3426 * @return A decoder if one was found, NULL otherwise.
3428 AVCodec *avcodec_find_decoder_by_name(const char *name);
3429 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3432 * Return a name for the specified profile, if available.
3434 * @param codec the codec that is searched for the given profile
3435 * @param profile the profile value for which a name is requested
3436 * @return A name for the profile if found, NULL otherwise.
3438 const char *av_get_profile_name(const AVCodec *codec, int profile);
3441 * Set the fields of the given AVCodecContext to default values corresponding
3442 * to the given codec (defaults may be codec-dependent).
3444 * Do not call this function if a non-NULL codec has been passed
3445 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3446 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3447 * different codec on this AVCodecContext.
3449 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3452 * Allocate an AVCodecContext and set its fields to default values. The
3453 * resulting struct can be deallocated by simply calling av_free().
3455 * @param codec if non-NULL, allocate private data and initialize defaults
3456 * for the given codec. It is illegal to then call avcodec_open2()
3457 * with a different codec.
3459 * @return An AVCodecContext filled with default values or NULL on failure.
3460 * @see avcodec_get_context_defaults
3462 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3465 * Copy the settings of the source AVCodecContext into the destination
3466 * AVCodecContext. The resulting destination codec context will be
3467 * unopened, i.e. you are required to call avcodec_open2() before you
3468 * can use this AVCodecContext to decode/encode video/audio data.
3470 * @param dest target codec context, should be initialized with
3471 * avcodec_alloc_context3(), but otherwise uninitialized
3472 * @param src source codec context
3473 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3475 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3478 * Set the fields of the given AVFrame to default values.
3480 * @param pic The AVFrame of which the fields should be set to default values.
3482 void avcodec_get_frame_defaults(AVFrame *pic);
3485 * Allocate an AVFrame and set its fields to default values. The resulting
3486 * struct can be deallocated by simply calling av_free().
3488 * @return An AVFrame filled with default values or NULL on failure.
3489 * @see avcodec_get_frame_defaults
3491 AVFrame *avcodec_alloc_frame(void);
3493 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3494 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3495 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3498 * Return the amount of padding in pixels which the get_buffer callback must
3499 * provide around the edge of the image for codecs which do not have the
3500 * CODEC_FLAG_EMU_EDGE flag.
3502 * @return Required padding in pixels.
3504 unsigned avcodec_get_edge_width(void);
3506 * Modify width and height values so that they will result in a memory
3507 * buffer that is acceptable for the codec if you do not use any horizontal
3510 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3511 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3512 * according to avcodec_get_edge_width() before.
3514 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3516 * Modify width and height values so that they will result in a memory
3517 * buffer that is acceptable for the codec if you also ensure that all
3518 * line sizes are a multiple of the respective linesize_align[i].
3520 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3521 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3522 * according to avcodec_get_edge_width() before.
3524 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3525 int linesize_align[AV_NUM_DATA_POINTERS]);
3527 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3529 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3530 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3531 //FIXME func typedef
3534 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3535 * function the context has to be allocated with avcodec_alloc_context3().
3537 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3538 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3539 * retrieving a codec.
3541 * @warning This function is not thread safe!
3544 * avcodec_register_all();
3545 * av_dict_set(&opts, "b", "2.5M", 0);
3546 * codec = avcodec_find_decoder(CODEC_ID_H264);
3550 * context = avcodec_alloc_context3(codec);
3552 * if (avcodec_open2(context, codec, opts) < 0)
3556 * @param avctx The context to initialize.
3557 * @param options A dictionary filled with AVCodecContext and codec-private options.
3558 * On return this object will be filled with options that were not found.
3560 * @return zero on success, a negative value on error
3561 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3562 * av_dict_set(), av_opt_find().
3564 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3566 #if FF_API_OLD_DECODE_AUDIO
3568 * Wrapper function which calls avcodec_decode_audio4.
3570 * @deprecated Use avcodec_decode_audio4 instead.
3572 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3573 * Some decoders may support multiple frames in a single AVPacket, such
3574 * decoders would then just decode the first frame. In this case,
3575 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3576 * the remaining data in order to decode the second frame etc.
3578 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3579 * decompressed frame size in bytes.
3581 * @warning You must set frame_size_ptr to the allocated size of the
3582 * output buffer before calling avcodec_decode_audio3().
3584 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3585 * the actual read bytes because some optimized bitstream readers read 32 or 64
3586 * bits at once and could read over the end.
3588 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3589 * no overreading happens for damaged MPEG streams.
3591 * @warning You must not provide a custom get_buffer() when using
3592 * avcodec_decode_audio3(). Doing so will override it with
3593 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3594 * which does allow the application to provide a custom get_buffer().
3596 * @note You might have to align the input buffer avpkt->data and output buffer
3597 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3598 * necessary at all, on others it won't work at all if not aligned and on others
3599 * it will work but it will have an impact on performance.
3601 * In practice, avpkt->data should have 4 byte alignment at minimum and
3602 * samples should be 16 byte aligned unless the CPU doesn't need it
3603 * (AltiVec and SSE do).
3605 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3606 * between input and output, these need to be fed with avpkt->data=NULL,
3607 * avpkt->size=0 at the end to return the remaining frames.
3609 * @param avctx the codec context
3610 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3611 * If the sample format is planar, each channel plane will
3612 * be the same size, with no padding between channels.
3613 * @param[in,out] frame_size_ptr the output buffer size in bytes
3614 * @param[in] avpkt The input AVPacket containing the input buffer.
3615 * You can create such packet with av_init_packet() and by then setting
3616 * data and size, some decoders might in addition need other fields.
3617 * All decoders are designed to use the least fields possible though.
3618 * @return On error a negative value is returned, otherwise the number of bytes
3619 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3621 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3622 int *frame_size_ptr,
3627 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3629 * Some decoders may support multiple frames in a single AVPacket. Such
3630 * decoders would then just decode the first frame. In this case,
3631 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3632 * the remaining data in order to decode the second frame, etc...
3633 * Even if no frames are returned, the packet needs to be fed to the decoder
3634 * with remaining data until it is completely consumed or an error occurs.
3636 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3637 * larger than the actual read bytes because some optimized bitstream
3638 * readers read 32 or 64 bits at once and could read over the end.
3640 * @note You might have to align the input buffer. The alignment requirements
3641 * depend on the CPU and the decoder.
3643 * @param avctx the codec context
3644 * @param[out] frame The AVFrame in which to store decoded audio samples.
3645 * Decoders request a buffer of a particular size by setting
3646 * AVFrame.nb_samples prior to calling get_buffer(). The
3647 * decoder may, however, only utilize part of the buffer by
3648 * setting AVFrame.nb_samples to a smaller value in the
3650 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3652 * @param[in] avpkt The input AVPacket containing the input buffer.
3653 * At least avpkt->data and avpkt->size should be set. Some
3654 * decoders might also require additional fields to be set.
3655 * @return A negative error code is returned if an error occurred during
3656 * decoding, otherwise the number of bytes consumed from the input
3657 * AVPacket is returned.
3659 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3660 int *got_frame_ptr, AVPacket *avpkt);
3663 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3664 * Some decoders may support multiple frames in a single AVPacket, such
3665 * decoders would then just decode the first frame.
3667 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3668 * the actual read bytes because some optimized bitstream readers read 32 or 64
3669 * bits at once and could read over the end.
3671 * @warning The end of the input buffer buf should be set to 0 to ensure that
3672 * no overreading happens for damaged MPEG streams.
3674 * @note You might have to align the input buffer avpkt->data.
3675 * The alignment requirements depend on the CPU: on some CPUs it isn't
3676 * necessary at all, on others it won't work at all if not aligned and on others
3677 * it will work but it will have an impact on performance.
3679 * In practice, avpkt->data should have 4 byte alignment at minimum.
3681 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3682 * between input and output, these need to be fed with avpkt->data=NULL,
3683 * avpkt->size=0 at the end to return the remaining frames.
3685 * @param avctx the codec context
3686 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3687 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3688 * allocate memory for the actual bitmap.
3689 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3690 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3691 * decodes and the decoder tells the user once it does not need the data anymore,
3692 * the user app can at this point free/reuse/keep the memory as it sees fit.
3694 * @param[in] avpkt The input AVpacket containing the input buffer.
3695 * You can create such packet with av_init_packet() and by then setting
3696 * data and size, some decoders might in addition need other fields like
3697 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3699 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3700 * @return On error a negative value is returned, otherwise the number of bytes
3701 * used or zero if no frame could be decompressed.
3703 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3704 int *got_picture_ptr,
3708 * Decode a subtitle message.
3709 * Return a negative value on error, otherwise return the number of bytes used.
3710 * If no subtitle could be decompressed, got_sub_ptr is zero.
3711 * Otherwise, the subtitle is stored in *sub.
3712 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3713 * simplicity, because the performance difference is expect to be negligible
3714 * and reusing a get_buffer written for video codecs would probably perform badly
3715 * due to a potentially very different allocation pattern.
3717 * @param avctx the codec context
3718 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3719 freed with avsubtitle_free if *got_sub_ptr is set.
3720 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3721 * @param[in] avpkt The input AVPacket containing the input buffer.
3723 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3728 * Free all allocated data in the given subtitle struct.
3730 * @param sub AVSubtitle to free.
3732 void avsubtitle_free(AVSubtitle *sub);
3734 #if FF_API_OLD_ENCODE_AUDIO
3736 * Encode an audio frame from samples into buf.
3738 * @deprecated Use avcodec_encode_audio2 instead.
3740 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3741 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3742 * will know how much space is needed because it depends on the value passed
3743 * in buf_size as described below. In that case a lower value can be used.
3745 * @param avctx the codec context
3746 * @param[out] buf the output buffer
3747 * @param[in] buf_size the output buffer size
3748 * @param[in] samples the input buffer containing the samples
3749 * The number of samples read from this buffer is frame_size*channels,
3750 * both of which are defined in avctx.
3751 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3752 * samples read from samples is equal to:
3753 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3754 * This also implies that av_get_bits_per_sample() must not return 0 for these
3756 * @return On error a negative value is returned, on success zero or the number
3757 * of bytes used to encode the data read from the input buffer.
3759 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3760 uint8_t *buf, int buf_size,
3761 const short *samples);
3765 * Encode a frame of audio.
3767 * Takes input samples from frame and writes the next output packet, if
3768 * available, to avpkt. The output packet does not necessarily contain data for
3769 * the most recent frame, as encoders can delay, split, and combine input frames
3770 * internally as needed.
3772 * @param avctx codec context
3773 * @param avpkt output AVPacket.
3774 * The user can supply an output buffer by setting
3775 * avpkt->data and avpkt->size prior to calling the
3776 * function, but if the size of the user-provided data is not
3777 * large enough, encoding will fail. All other AVPacket fields
3778 * will be reset by the encoder using av_init_packet(). If
3779 * avpkt->data is NULL, the encoder will allocate it.
3780 * The encoder will set avpkt->size to the size of the
3782 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3783 * May be NULL when flushing an encoder that has the
3784 * CODEC_CAP_DELAY capability set.
3785 * There are 2 codec capabilities that affect the allowed
3786 * values of frame->nb_samples.
3787 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
3788 * frame may be smaller than avctx->frame_size, and all other
3789 * frames must be equal to avctx->frame_size.
3790 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3791 * can have any number of samples.
3792 * If neither is set, frame->nb_samples must be equal to
3793 * avctx->frame_size for all frames.
3794 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3795 * output packet is non-empty, and to 0 if it is
3796 * empty. If the function returns an error, the
3797 * packet can be assumed to be invalid, and the
3798 * value of got_packet_ptr is undefined and should
3800 * @return 0 on success, negative error code on failure
3802 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3803 const AVFrame *frame, int *got_packet_ptr);
3806 * Fill audio frame data and linesize.
3807 * AVFrame extended_data channel pointers are allocated if necessary for
3810 * @param frame the AVFrame
3811 * frame->nb_samples must be set prior to calling the
3812 * function. This function fills in frame->data,
3813 * frame->extended_data, frame->linesize[0].
3814 * @param nb_channels channel count
3815 * @param sample_fmt sample format
3816 * @param buf buffer to use for frame data
3817 * @param buf_size size of buffer
3818 * @param align plane size sample alignment
3819 * @return 0 on success, negative error code on failure
3821 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
3822 enum AVSampleFormat sample_fmt, const uint8_t *buf,
3823 int buf_size, int align);
3826 * Encode a video frame from pict into buf.
3827 * The input picture should be
3828 * stored using a specific format, namely avctx.pix_fmt.
3830 * @param avctx the codec context
3831 * @param[out] buf the output buffer for the bitstream of encoded frame
3832 * @param[in] buf_size the size of the output buffer in bytes
3833 * @param[in] pict the input picture to encode
3834 * @return On error a negative value is returned, on success zero or the number
3835 * of bytes used from the output buffer.
3837 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3838 const AVFrame *pict);
3839 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3840 const AVSubtitle *sub);
3842 int avcodec_close(AVCodecContext *avctx);
3845 * Register all the codecs, parsers and bitstream filters which were enabled at
3846 * configuration time. If you do not call this function you can select exactly
3847 * which formats you want to support, by using the individual registration
3850 * @see avcodec_register
3851 * @see av_register_codec_parser
3852 * @see av_register_bitstream_filter
3854 void avcodec_register_all(void);
3857 * Flush buffers, should be called when seeking or when switching to a different stream.
3859 void avcodec_flush_buffers(AVCodecContext *avctx);
3861 void avcodec_default_free_buffers(AVCodecContext *s);
3863 /* misc useful functions */
3866 * Return codec bits per sample.
3868 * @param[in] codec_id the codec
3869 * @return Number of bits per sample or zero if unknown for the given codec.
3871 int av_get_bits_per_sample(enum CodecID codec_id);
3874 typedef struct AVCodecParserContext {
3876 struct AVCodecParser *parser;
3877 int64_t frame_offset; /* offset of the current frame */
3878 int64_t cur_offset; /* current offset
3879 (incremented by each av_parser_parse()) */
3880 int64_t next_frame_offset; /* offset of the next frame */
3882 int pict_type; /* XXX: Put it back in AVCodecContext. */
3884 * This field is used for proper frame duration computation in lavf.
3885 * It signals, how much longer the frame duration of the current frame
3886 * is compared to normal frame duration.
3888 * frame_duration = (1 + repeat_pict) * time_base
3890 * It is used by codecs like H.264 to display telecined material.
3892 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3893 int64_t pts; /* pts of the current frame */
3894 int64_t dts; /* dts of the current frame */
3899 int fetch_timestamp;
3901 #define AV_PARSER_PTS_NB 4
3902 int cur_frame_start_index;
3903 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3904 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3905 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3908 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3909 #define PARSER_FLAG_ONCE 0x0002
3910 /// Set if the parser has a valid file offset
3911 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3913 int64_t offset; ///< byte offset from starting packet start
3914 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3917 * Set by parser to 1 for key frames and 0 for non-key frames.
3918 * It is initialized to -1, so if the parser doesn't set this flag,
3919 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3925 * Time difference in stream time base units from the pts of this
3926 * packet to the point at which the output from the decoder has converged
3927 * independent from the availability of previous frames. That is, the
3928 * frames are virtually identical no matter if decoding started from
3929 * the very first frame or from this keyframe.
3930 * Is AV_NOPTS_VALUE if unknown.
3931 * This field is not the display duration of the current frame.
3932 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3935 * The purpose of this field is to allow seeking in streams that have no
3936 * keyframes in the conventional sense. It corresponds to the
3937 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3938 * essential for some types of subtitle streams to ensure that all
3939 * subtitles are correctly displayed after seeking.
3941 int64_t convergence_duration;
3943 // Timestamp generation support:
3945 * Synchronization point for start of timestamp generation.
3947 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3950 * For example, this corresponds to presence of H.264 buffering period
3956 * Offset of the current timestamp against last timestamp sync point in
3957 * units of AVCodecContext.time_base.
3959 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3960 * contain a valid timestamp offset.
3962 * Note that the timestamp of sync point has usually a nonzero
3963 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3964 * the next frame after timestamp sync point will be usually 1.
3966 * For example, this corresponds to H.264 cpb_removal_delay.
3968 int dts_ref_dts_delta;
3971 * Presentation delay of current frame in units of AVCodecContext.time_base.
3973 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3974 * contain valid non-negative timestamp delta (presentation time of a frame
3975 * must not lie in the past).
3977 * This delay represents the difference between decoding and presentation
3978 * time of the frame.
3980 * For example, this corresponds to H.264 dpb_output_delay.
3985 * Position of the packet in file.
3987 * Analogous to cur_frame_pts/dts
3989 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3992 * Byte position of currently parsed frame in stream.
3997 * Previous frame byte position.
4000 } AVCodecParserContext;
4002 typedef struct AVCodecParser {
4003 int codec_ids[5]; /* several codec IDs are permitted */
4005 int (*parser_init)(AVCodecParserContext *s);
4006 int (*parser_parse)(AVCodecParserContext *s,
4007 AVCodecContext *avctx,
4008 const uint8_t **poutbuf, int *poutbuf_size,
4009 const uint8_t *buf, int buf_size);
4010 void (*parser_close)(AVCodecParserContext *s);
4011 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4012 struct AVCodecParser *next;
4015 AVCodecParser *av_parser_next(AVCodecParser *c);
4017 void av_register_codec_parser(AVCodecParser *parser);
4018 AVCodecParserContext *av_parser_init(int codec_id);
4023 * @param s parser context.
4024 * @param avctx codec context.
4025 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4026 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4027 * @param buf input buffer.
4028 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4029 * @param pts input presentation timestamp.
4030 * @param dts input decoding timestamp.
4031 * @param pos input byte position in stream.
4032 * @return the number of bytes of the input bitstream used.
4037 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4044 * decode_frame(data, size);
4048 int av_parser_parse2(AVCodecParserContext *s,
4049 AVCodecContext *avctx,
4050 uint8_t **poutbuf, int *poutbuf_size,
4051 const uint8_t *buf, int buf_size,
4052 int64_t pts, int64_t dts,
4055 int av_parser_change(AVCodecParserContext *s,
4056 AVCodecContext *avctx,
4057 uint8_t **poutbuf, int *poutbuf_size,
4058 const uint8_t *buf, int buf_size, int keyframe);
4059 void av_parser_close(AVCodecParserContext *s);
4062 typedef struct AVBitStreamFilterContext {
4064 struct AVBitStreamFilter *filter;
4065 AVCodecParserContext *parser;
4066 struct AVBitStreamFilterContext *next;
4067 } AVBitStreamFilterContext;
4070 typedef struct AVBitStreamFilter {
4073 int (*filter)(AVBitStreamFilterContext *bsfc,
4074 AVCodecContext *avctx, const char *args,
4075 uint8_t **poutbuf, int *poutbuf_size,
4076 const uint8_t *buf, int buf_size, int keyframe);
4077 void (*close)(AVBitStreamFilterContext *bsfc);
4078 struct AVBitStreamFilter *next;
4079 } AVBitStreamFilter;
4081 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4082 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4083 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4084 AVCodecContext *avctx, const char *args,
4085 uint8_t **poutbuf, int *poutbuf_size,
4086 const uint8_t *buf, int buf_size, int keyframe);
4087 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4089 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4094 * Reallocate the given block if it is not large enough, otherwise do nothing.
4098 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4101 * Allocate a buffer, reusing the given one if large enough.
4103 * Contrary to av_fast_realloc the current buffer contents might not be
4104 * preserved and on error the old buffer is freed, thus no special
4105 * handling to avoid memleaks is necessary.
4107 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4108 * @param size size of the buffer *ptr points to
4109 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4110 * *size 0 if an error occurred.
4112 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4115 * Copy image src to dst. Wraps av_picture_data_copy() above.
4117 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4118 enum PixelFormat pix_fmt, int width, int height);
4121 * Crop image top and left side.
4123 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4124 enum PixelFormat pix_fmt, int top_band, int left_band);
4129 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4130 int padtop, int padbottom, int padleft, int padright, int *color);
4133 * Encode extradata length to a buffer. Used by xiph codecs.
4135 * @param s buffer to write to; must be at least (v/255+1) bytes long
4136 * @param v size of extradata in bytes
4137 * @return number of bytes written to the buffer.
4139 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4142 * Log a generic warning message about a missing feature. This function is
4143 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4144 * only, and would normally not be used by applications.
4145 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4146 * a pointer to an AVClass struct
4147 * @param[in] feature string containing the name of the missing feature
4148 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4149 * If want_sample is non-zero, additional verbage will be added to the log
4150 * message which tells the user how to report samples to the development
4153 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4156 * Log a generic warning message asking for a sample. This function is
4157 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4158 * only, and would normally not be used by applications.
4159 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4160 * a pointer to an AVClass struct
4161 * @param[in] msg string containing an optional message, or NULL if no message
4163 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4166 * Register the hardware accelerator hwaccel.
4168 void av_register_hwaccel(AVHWAccel *hwaccel);
4171 * If hwaccel is NULL, returns the first registered hardware accelerator,
4172 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4173 * after hwaccel, or NULL if hwaccel is the last one.
4175 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4179 * Lock operation used by lockmgr
4182 AV_LOCK_CREATE, ///< Create a mutex
4183 AV_LOCK_OBTAIN, ///< Lock the mutex
4184 AV_LOCK_RELEASE, ///< Unlock the mutex
4185 AV_LOCK_DESTROY, ///< Free mutex resources
4189 * Register a user provided lock manager supporting the operations
4190 * specified by AVLockOp. mutex points to a (void *) where the
4191 * lockmgr should store/get a pointer to a user allocated mutex. It's
4192 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4194 * @param cb User defined callback. Note: Libav may invoke calls to this
4195 * callback during the call to av_lockmgr_register().
4196 * Thus, the application must be prepared to handle that.
4197 * If cb is set to NULL the lockmgr will be unregistered.
4198 * Also note that during unregistration the previously registered
4199 * lockmgr callback may also be invoked.
4201 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4204 * Get the type of the given codec.
4206 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4209 * Get the AVClass for AVCodecContext. It can be used in combination with
4210 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4212 * @see av_opt_find().
4214 const AVClass *avcodec_get_class(void);
4216 #endif /* AVCODEC_AVCODEC_H */