2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * Libav is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
40 * @defgroup libavc Encoding/Decoding Library
43 * @defgroup lavc_decoding Decoding
47 * @defgroup lavc_encoding Encoding
51 * @defgroup lavc_codec Codecs
53 * @defgroup lavc_codec_native Native Codecs
56 * @defgroup lavc_codec_wrappers External library wrappers
59 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
63 * @defgroup lavc_internal Internal
72 * Identify the syntax and semantics of the bitstream.
73 * The principle is roughly:
74 * Two decoders with the same ID can decode the same streams.
75 * Two encoders with the same ID can encode compatible streams.
76 * There may be slight deviations from the principle due to implementation
79 * If you add a codec ID to this list, add it so that
80 * 1. no value of a existing codec ID changes (that would break ABI),
81 * 2. it is as close as possible to similar codecs.
88 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
89 CODEC_ID_MPEG2VIDEO_XVMC,
126 CODEC_ID_INTERPLAY_VIDEO,
138 CODEC_ID_TRUEMOTION1,
165 CODEC_ID_TRUEMOTION2,
182 CODEC_ID_DSICINVIDEO,
183 CODEC_ID_TIERTEXSEQVIDEO,
191 CODEC_ID_BETHSOFTVID,
207 CODEC_ID_MOTIONPIXELS,
225 CODEC_ID_IFF_BYTERUN1,
248 /* various PCM "codecs" */
249 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
250 CODEC_ID_PCM_S16LE = 0x10000,
266 CODEC_ID_PCM_S24DAUD,
268 CODEC_ID_PCM_S16LE_PLANAR,
277 CODEC_ID_PCM_S8_PLANAR,
279 /* various ADPCM codecs */
280 CODEC_ID_ADPCM_IMA_QT = 0x11000,
281 CODEC_ID_ADPCM_IMA_WAV,
282 CODEC_ID_ADPCM_IMA_DK3,
283 CODEC_ID_ADPCM_IMA_DK4,
284 CODEC_ID_ADPCM_IMA_WS,
285 CODEC_ID_ADPCM_IMA_SMJPEG,
294 CODEC_ID_ADPCM_YAMAHA,
295 CODEC_ID_ADPCM_SBPRO_4,
296 CODEC_ID_ADPCM_SBPRO_3,
297 CODEC_ID_ADPCM_SBPRO_2,
299 CODEC_ID_ADPCM_IMA_AMV,
300 CODEC_ID_ADPCM_EA_R1,
301 CODEC_ID_ADPCM_EA_R3,
302 CODEC_ID_ADPCM_EA_R2,
303 CODEC_ID_ADPCM_IMA_EA_SEAD,
304 CODEC_ID_ADPCM_IMA_EA_EACS,
305 CODEC_ID_ADPCM_EA_XAS,
306 CODEC_ID_ADPCM_EA_MAXIS_XA,
307 CODEC_ID_ADPCM_IMA_ISS,
309 CODEC_ID_ADPCM_IMA_APC,
312 CODEC_ID_AMR_NB = 0x12000,
315 /* RealAudio codecs*/
316 CODEC_ID_RA_144 = 0x13000,
319 /* various DPCM codecs */
320 CODEC_ID_ROQ_DPCM = 0x14000,
321 CODEC_ID_INTERPLAY_DPCM,
326 CODEC_ID_MP2 = 0x15000,
327 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
343 CODEC_ID_WESTWOOD_SND1,
344 CODEC_ID_GSM, ///< as in Berlin toast format
352 CODEC_ID_DSICINAUDIO,
356 CODEC_ID_GSM_MS, /* as found in WAV */
365 CODEC_ID_WMALOSSLESS,
374 CODEC_ID_BINKAUDIO_RDFT,
375 CODEC_ID_BINKAUDIO_DCT,
385 /* subtitle codecs */
386 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
387 CODEC_ID_DVD_SUBTITLE = 0x17000,
388 CODEC_ID_DVB_SUBTITLE,
389 CODEC_ID_TEXT, ///< raw UTF-8 text
393 CODEC_ID_HDMV_PGS_SUBTITLE,
394 CODEC_ID_DVB_TELETEXT,
397 /* other specific kind of codecs (generally used for attachments) */
398 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
399 CODEC_ID_TTF = 0x18000,
401 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
403 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
404 * stream (only used by libavformat) */
405 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
406 * stream (only used by libavformat) */
407 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
410 #if FF_API_OLD_DECODE_AUDIO
412 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
416 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
417 * This is mainly needed because some optimized bitstream readers read
418 * 32 or 64 bit at once and could read over the end.<br>
419 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
420 * MPEG bitstreams could cause overread and segfault.
422 #define FF_INPUT_BUFFER_PADDING_SIZE 8
425 * minimum encoding buffer size
426 * Used to avoid some checks during header writing.
428 #define FF_MIN_BUFFER_SIZE 16384
432 * motion estimation type.
435 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
439 ME_EPZS, ///< enhanced predictive zonal search
440 ME_X1, ///< reserved for experiments
441 ME_HEX, ///< hexagon based search
442 ME_UMH, ///< uneven multi-hexagon search
443 ME_ITER, ///< iterative search
444 ME_TESA, ///< transformed exhaustive search algorithm
448 /* We leave some space between them for extensions (drop some
449 * keyframes for intra-only or drop just some bidir frames). */
450 AVDISCARD_NONE =-16, ///< discard nothing
451 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
452 AVDISCARD_NONREF = 8, ///< discard all non reference
453 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
454 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
455 AVDISCARD_ALL = 48, ///< discard all
458 enum AVColorPrimaries{
459 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
460 AVCOL_PRI_UNSPECIFIED=2,
462 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
463 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
464 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
466 AVCOL_PRI_NB , ///< Not part of ABI
469 enum AVColorTransferCharacteristic{
470 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
471 AVCOL_TRC_UNSPECIFIED=2,
472 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
473 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
474 AVCOL_TRC_NB , ///< Not part of ABI
479 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
480 AVCOL_SPC_UNSPECIFIED=2,
482 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
483 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
484 AVCOL_SPC_SMPTE240M =7,
485 AVCOL_SPC_NB , ///< Not part of ABI
489 AVCOL_RANGE_UNSPECIFIED=0,
490 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
491 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
492 AVCOL_RANGE_NB , ///< Not part of ABI
496 * X X 3 4 X X are luma samples,
497 * 1 2 1-6 are possible chroma positions
498 * X X 5 6 X 0 is undefined/unknown position
500 enum AVChromaLocation{
501 AVCHROMA_LOC_UNSPECIFIED=0,
502 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
503 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
504 AVCHROMA_LOC_TOPLEFT =3, ///< DV
506 AVCHROMA_LOC_BOTTOMLEFT =5,
507 AVCHROMA_LOC_BOTTOM =6,
508 AVCHROMA_LOC_NB , ///< Not part of ABI
511 enum AVAudioServiceType {
512 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
513 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
514 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
515 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
516 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
517 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
518 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
519 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
520 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
521 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
524 typedef struct RcOverride{
527 int qscale; // If this is 0 then quality_factor will be used instead.
528 float quality_factor;
531 #define FF_MAX_B_FRAMES 16
534 These flags can be passed in AVCodecContext.flags before initialization.
535 Note: Not everything is supported yet.
538 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
539 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
540 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
541 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
542 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
544 * The parent program guarantees that the input for B-frames containing
545 * streams is not written to for at least s->max_b_frames+1 frames, if
546 * this is not set the input will be copied.
548 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
549 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
550 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
551 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
552 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
553 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
554 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
555 location instead of only at frame boundaries. */
556 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
557 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
558 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
559 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
560 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
561 /* Fx : Flag for h263+ extra options */
562 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
563 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
564 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
565 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
566 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
567 #define CODEC_FLAG_CLOSED_GOP 0x80000000
568 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
569 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
570 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
571 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
572 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
573 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
575 /* Unsupported options :
576 * Syntax Arithmetic coding (SAC)
577 * Reference Picture Selection
578 * Independent Segment Decoding */
580 /* codec capabilities */
582 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
584 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
585 * If not set, it might not use get_buffer() at all or use operations that
586 * assume the buffer was allocated by avcodec_default_get_buffer.
588 #define CODEC_CAP_DR1 0x0002
589 #define CODEC_CAP_TRUNCATED 0x0008
590 /* Codec can export data for HW decoding (XvMC). */
591 #define CODEC_CAP_HWACCEL 0x0010
593 * Encoder or decoder requires flushing with NULL input at the end in order to
594 * give the complete and correct output.
596 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
597 * with NULL data. The user can still send NULL data to the public encode
598 * or decode function, but libavcodec will not pass it along to the codec
599 * unless this flag is set.
602 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
603 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
607 * The encoder needs to be fed with NULL data at the end of encoding until the
608 * encoder no longer returns data.
610 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
611 * flag also means that the encoder must set the pts and duration for
612 * each output packet. If this flag is not set, the pts and duration will
613 * be determined by libavcodec from the input frame.
615 #define CODEC_CAP_DELAY 0x0020
617 * Codec can be fed a final frame with a smaller size.
618 * This can be used to prevent truncation of the last audio samples.
620 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
622 * Codec can export data for HW decoding (VDPAU).
624 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
626 * Codec can output multiple frames per AVPacket
627 * Normally demuxers return one frame at a time, demuxers which do not do
628 * are connected to a parser to split what they return into proper frames.
629 * This flag is reserved to the very rare category of codecs which have a
630 * bitstream that cannot be split into frames without timeconsuming
631 * operations like full decoding. Demuxers carring such bitstreams thus
632 * may return multiple frames in a packet. This has many disadvantages like
633 * prohibiting stream copy in many cases thus it should only be considered
636 #define CODEC_CAP_SUBFRAMES 0x0100
638 * Codec is experimental and is thus avoided in favor of non experimental
641 #define CODEC_CAP_EXPERIMENTAL 0x0200
643 * Codec should fill in channel configuration and samplerate instead of container
645 #define CODEC_CAP_CHANNEL_CONF 0x0400
647 * Codec is able to deal with negative linesizes
649 #define CODEC_CAP_NEG_LINESIZES 0x0800
651 * Codec supports frame-level multithreading.
653 #define CODEC_CAP_FRAME_THREADS 0x1000
655 * Codec supports slice-based (or partition-based) multithreading.
657 #define CODEC_CAP_SLICE_THREADS 0x2000
659 * Codec supports changed parameters at any point.
661 #define CODEC_CAP_PARAM_CHANGE 0x4000
663 * Codec supports avctx->thread_count == 0 (auto).
665 #define CODEC_CAP_AUTO_THREADS 0x8000
667 * Audio encoder supports receiving a different number of samples in each call.
669 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
671 //The following defines may change, don't expect compatibility if you use them.
672 #define MB_TYPE_INTRA4x4 0x0001
673 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
674 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
675 #define MB_TYPE_16x16 0x0008
676 #define MB_TYPE_16x8 0x0010
677 #define MB_TYPE_8x16 0x0020
678 #define MB_TYPE_8x8 0x0040
679 #define MB_TYPE_INTERLACED 0x0080
680 #define MB_TYPE_DIRECT2 0x0100 //FIXME
681 #define MB_TYPE_ACPRED 0x0200
682 #define MB_TYPE_GMC 0x0400
683 #define MB_TYPE_SKIP 0x0800
684 #define MB_TYPE_P0L0 0x1000
685 #define MB_TYPE_P1L0 0x2000
686 #define MB_TYPE_P0L1 0x4000
687 #define MB_TYPE_P1L1 0x8000
688 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
689 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
690 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
691 #define MB_TYPE_QUANT 0x00010000
692 #define MB_TYPE_CBP 0x00020000
693 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
697 * This specifies the area which should be displayed.
698 * Note there may be multiple such areas for one frame.
700 typedef struct AVPanScan{
703 * - encoding: Set by user.
704 * - decoding: Set by libavcodec.
709 * width and height in 1/16 pel
710 * - encoding: Set by user.
711 * - decoding: Set by libavcodec.
717 * position of the top left corner in 1/16 pel for up to 3 fields/frames
718 * - encoding: Set by user.
719 * - decoding: Set by libavcodec.
721 int16_t position[3][2];
724 #define FF_QSCALE_TYPE_MPEG1 0
725 #define FF_QSCALE_TYPE_MPEG2 1
726 #define FF_QSCALE_TYPE_H264 2
727 #define FF_QSCALE_TYPE_VP56 3
729 #define FF_BUFFER_TYPE_INTERNAL 1
730 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
731 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
732 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
734 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
735 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
736 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
737 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
739 enum AVPacketSideDataType {
741 AV_PKT_DATA_NEW_EXTRADATA,
742 AV_PKT_DATA_PARAM_CHANGE,
745 typedef struct AVPacket {
747 * Presentation timestamp in AVStream->time_base units; the time at which
748 * the decompressed packet will be presented to the user.
749 * Can be AV_NOPTS_VALUE if it is not stored in the file.
750 * pts MUST be larger or equal to dts as presentation cannot happen before
751 * decompression, unless one wants to view hex dumps. Some formats misuse
752 * the terms dts and pts/cts to mean something different. Such timestamps
753 * must be converted to true pts/dts before they are stored in AVPacket.
757 * Decompression timestamp in AVStream->time_base units; the time at which
758 * the packet is decompressed.
759 * Can be AV_NOPTS_VALUE if it is not stored in the file.
766 * A combination of AV_PKT_FLAG values
770 * Additional packet data that can be provided by the container.
771 * Packet can contain several types of side information.
776 enum AVPacketSideDataType type;
781 * Duration of this packet in AVStream->time_base units, 0 if unknown.
782 * Equals next_pts - this_pts in presentation order.
785 void (*destruct)(struct AVPacket *);
787 int64_t pos; ///< byte position in stream, -1 if unknown
790 * Time difference in AVStream->time_base units from the pts of this
791 * packet to the point at which the output from the decoder has converged
792 * independent from the availability of previous frames. That is, the
793 * frames are virtually identical no matter if decoding started from
794 * the very first frame or from this keyframe.
795 * Is AV_NOPTS_VALUE if unknown.
796 * This field is not the display duration of the current packet.
797 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
800 * The purpose of this field is to allow seeking in streams that have no
801 * keyframes in the conventional sense. It corresponds to the
802 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
803 * essential for some types of subtitle streams to ensure that all
804 * subtitles are correctly displayed after seeking.
806 int64_t convergence_duration;
808 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
809 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
812 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
814 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
815 * s32le channel_count
816 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
817 * u64le channel_layout
818 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
820 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
825 enum AVSideDataParamChangeFlags {
826 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
827 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
828 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
829 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
834 * New fields can be added to the end of AVFRAME with minor version
835 * bumps. Removal, reordering and changes to existing fields require
836 * a major version bump.
837 * sizeof(AVFrame) must not be used outside libav*.
839 typedef struct AVFrame {
840 #define AV_NUM_DATA_POINTERS 8
842 * pointer to the picture/channel planes.
843 * This might be different from the first allocated byte
844 * - encoding: Set by user
845 * - decoding: set by AVCodecContext.get_buffer()
847 uint8_t *data[AV_NUM_DATA_POINTERS];
850 * Size, in bytes, of the data for each picture/channel plane.
852 * For audio, only linesize[0] may be set. For planar audio, each channel
853 * plane must be the same size.
855 * - encoding: Set by user (video only)
856 * - decoding: set by AVCodecContext.get_buffer()
858 int linesize[AV_NUM_DATA_POINTERS];
861 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
862 * This isn't used by libavcodec unless the default get/release_buffer() is used.
866 uint8_t *base[AV_NUM_DATA_POINTERS];
868 * 1 -> keyframe, 0-> not
869 * - encoding: Set by libavcodec.
870 * - decoding: Set by libavcodec.
875 * Picture type of the frame, see ?_TYPE below.
876 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
877 * - decoding: Set by libavcodec.
879 enum AVPictureType pict_type;
882 * presentation timestamp in time_base units (time when frame should be shown to user)
883 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
884 * - encoding: MUST be set by user.
885 * - decoding: Set by libavcodec.
890 * picture number in bitstream order
892 * - decoding: Set by libavcodec.
894 int coded_picture_number;
896 * picture number in display order
898 * - decoding: Set by libavcodec.
900 int display_picture_number;
903 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
904 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
905 * - decoding: Set by libavcodec.
910 * is this picture used as reference
911 * The values for this are the same as the MpegEncContext.picture_structure
912 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
913 * Set to 4 for delayed, non-reference frames.
915 * - decoding: Set by libavcodec. (before get_buffer() call)).
922 * - decoding: Set by libavcodec.
924 int8_t *qscale_table;
928 * - decoding: Set by libavcodec.
933 * mbskip_table[mb]>=1 if MB didn't change
934 * stride= mb_width = (width+15)>>4
936 * - decoding: Set by libavcodec.
938 uint8_t *mbskip_table;
941 * motion vector table
944 * int mv_sample_log2= 4 - motion_subsample_log2;
945 * int mb_width= (width+15)>>4;
946 * int mv_stride= (mb_width << mv_sample_log2) + 1;
947 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
949 * - encoding: Set by user.
950 * - decoding: Set by libavcodec.
952 int16_t (*motion_val[2])[2];
955 * macroblock type table
956 * mb_type_base + mb_width + 2
957 * - encoding: Set by user.
958 * - decoding: Set by libavcodec.
963 * log2 of the size of the block which a single vector in motion_val represents:
964 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
966 * - decoding: Set by libavcodec.
968 uint8_t motion_subsample_log2;
971 * for some private data of the user
973 * - decoding: Set by user.
979 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
982 uint64_t error[AV_NUM_DATA_POINTERS];
985 * type of the buffer (to keep track of who has to deallocate data[*])
986 * - encoding: Set by the one who allocates it.
987 * - decoding: Set by the one who allocates it.
988 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
993 * When decoding, this signals how much the picture must be delayed.
994 * extra_delay = repeat_pict / (2*fps)
996 * - decoding: Set by libavcodec.
1006 * The content of the picture is interlaced.
1007 * - encoding: Set by user.
1008 * - decoding: Set by libavcodec. (default 0)
1010 int interlaced_frame;
1013 * If the content is interlaced, is top field displayed first.
1014 * - encoding: Set by user.
1015 * - decoding: Set by libavcodec.
1017 int top_field_first;
1021 * - encoding: Set by user.
1022 * - decoding: Set by libavcodec.
1024 AVPanScan *pan_scan;
1027 * Tell user application that palette has changed from previous frame.
1028 * - encoding: ??? (no palette-enabled encoder yet)
1029 * - decoding: Set by libavcodec. (default 0).
1031 int palette_has_changed;
1034 * codec suggestion on buffer type if != 0
1035 * - encoding: unused
1036 * - decoding: Set by libavcodec. (before get_buffer() call)).
1042 * - encoding: unused
1043 * - decoding: Set by libavcodec.
1048 * motion reference frame index
1049 * the order in which these are stored can depend on the codec.
1050 * - encoding: Set by user.
1051 * - decoding: Set by libavcodec.
1053 int8_t *ref_index[2];
1056 * reordered opaque 64bit (generally an integer or a double precision float
1057 * PTS but can be anything).
1058 * The user sets AVCodecContext.reordered_opaque to represent the input at
1060 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1061 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1062 * @deprecated in favor of pkt_pts
1063 * - encoding: unused
1064 * - decoding: Read by user.
1066 int64_t reordered_opaque;
1069 * hardware accelerator private data (Libav-allocated)
1070 * - encoding: unused
1071 * - decoding: Set by libavcodec
1073 void *hwaccel_picture_private;
1076 * reordered pts from the last AVPacket that has been input into the decoder
1077 * - encoding: unused
1078 * - decoding: Read by user.
1083 * dts from the last AVPacket that has been input into the decoder
1084 * - encoding: unused
1085 * - decoding: Read by user.
1090 * the AVCodecContext which ff_thread_get_buffer() was last called on
1091 * - encoding: Set by libavcodec.
1092 * - decoding: Set by libavcodec.
1094 struct AVCodecContext *owner;
1097 * used by multithreading to store frame-specific info
1098 * - encoding: Set by libavcodec.
1099 * - decoding: Set by libavcodec.
1101 void *thread_opaque;
1104 * number of audio samples (per channel) described by this frame
1105 * - encoding: unused
1106 * - decoding: Set by libavcodec
1111 * pointers to the data planes/channels.
1113 * For video, this should simply point to data[].
1115 * For planar audio, each channel has a separate data pointer, and
1116 * linesize[0] contains the size of each channel buffer.
1117 * For packed audio, there is just one data pointer, and linesize[0]
1118 * contains the total size of the buffer for all channels.
1120 * Note: Both data and extended_data will always be set by get_buffer(),
1121 * but for planar audio with more channels that can fit in data,
1122 * extended_data must be used by the decoder in order to access all
1126 * decoding: set by AVCodecContext.get_buffer()
1128 uint8_t **extended_data;
1131 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1132 * - encoding: unused
1133 * - decoding: Read by user.
1135 AVRational sample_aspect_ratio;
1138 * width and height of the video frame
1139 * - encoding: unused
1140 * - decoding: Read by user.
1145 * format of the frame, -1 if unknown or unset
1146 * Values correspond to enum PixelFormat for video frames,
1147 * enum AVSampleFormat for audio)
1148 * - encoding: unused
1149 * - decoding: Read by user.
1154 struct AVCodecInternal;
1158 AV_FIELD_PROGRESSIVE,
1159 AV_FIELD_TT, //< Top coded_first, top displayed first
1160 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1161 AV_FIELD_TB, //< Top coded first, bottom displayed first
1162 AV_FIELD_BT, //< Bottom coded first, top displayed first
1166 * main external API structure.
1167 * New fields can be added to the end with minor version bumps.
1168 * Removal, reordering and changes to existing fields require a major
1170 * sizeof(AVCodecContext) must not be used outside libav*.
1172 typedef struct AVCodecContext {
1174 * information on struct for av_log
1175 * - set by avcodec_alloc_context3
1177 const AVClass *av_class;
1179 * the average bitrate
1180 * - encoding: Set by user; unused for constant quantizer encoding.
1181 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1186 * number of bits the bitstream is allowed to diverge from the reference.
1187 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1188 * - encoding: Set by user; unused for constant quantizer encoding.
1189 * - decoding: unused
1191 int bit_rate_tolerance;
1195 * - encoding: Set by user.
1196 * - decoding: Set by user.
1201 * Some codecs need additional format info. It is stored here.
1202 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1203 * specific codec MUST set it correctly otherwise stream copy breaks.
1204 * In general use of this field by muxers is not recommended.
1205 * - encoding: Set by libavcodec.
1206 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1211 * Motion estimation algorithm used for video coding.
1212 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1213 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1214 * - encoding: MUST be set by user.
1215 * - decoding: unused
1220 * some codecs need / can use extradata like Huffman tables.
1221 * mjpeg: Huffman tables
1222 * rv10: additional flags
1223 * mpeg4: global headers (they can be in the bitstream or here)
1224 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1225 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1226 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1227 * - encoding: Set/allocated/freed by libavcodec.
1228 * - decoding: Set/allocated/freed by user.
1234 * This is the fundamental unit of time (in seconds) in terms
1235 * of which frame timestamps are represented. For fixed-fps content,
1236 * timebase should be 1/framerate and timestamp increments should be
1238 * - encoding: MUST be set by user.
1239 * - decoding: Set by libavcodec.
1241 AVRational time_base;
1245 * picture width / height.
1246 * - encoding: MUST be set by user.
1247 * - decoding: Set by libavcodec.
1248 * Note: For compatibility it is possible to set this instead of
1249 * coded_width/height before decoding.
1253 #define FF_ASPECT_EXTENDED 15
1256 * the number of pictures in a group of pictures, or 0 for intra_only
1257 * - encoding: Set by user.
1258 * - decoding: unused
1263 * Pixel format, see PIX_FMT_xxx.
1264 * May be set by the demuxer if known from headers.
1265 * May be overriden by the decoder if it knows better.
1266 * - encoding: Set by user.
1267 * - decoding: Set by user if known, overridden by libavcodec if known
1269 enum PixelFormat pix_fmt;
1272 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1273 * decoder to draw a horizontal band. It improves cache usage. Not
1274 * all codecs can do that. You must check the codec capabilities
1276 * When multithreading is used, it may be called from multiple threads
1277 * at the same time; threads might draw different parts of the same AVFrame,
1278 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1280 * The function is also used by hardware acceleration APIs.
1281 * It is called at least once during frame decoding to pass
1282 * the data needed for hardware render.
1283 * In that mode instead of pixel data, AVFrame points to
1284 * a structure specific to the acceleration API. The application
1285 * reads the structure and can change some fields to indicate progress
1287 * - encoding: unused
1288 * - decoding: Set by user.
1289 * @param height the height of the slice
1290 * @param y the y position of the slice
1291 * @param type 1->top field, 2->bottom field, 3->frame
1292 * @param offset offset into the AVFrame.data from which the slice should be read
1294 void (*draw_horiz_band)(struct AVCodecContext *s,
1295 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1296 int y, int type, int height);
1299 int sample_rate; ///< samples per second
1300 int channels; ///< number of audio channels
1303 * audio sample format
1304 * - encoding: Set by user.
1305 * - decoding: Set by libavcodec.
1307 enum AVSampleFormat sample_fmt; ///< sample format
1309 /* The following data should not be initialized. */
1311 * Samples per packet, initialized when calling 'init'.
1314 int frame_number; ///< audio or video frame number
1317 * Number of frames the decoded output will be delayed relative to
1318 * the encoded input.
1319 * - encoding: Set by libavcodec.
1320 * - decoding: unused
1324 /* - encoding parameters */
1325 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1326 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1330 * - encoding: Set by user.
1331 * - decoding: unused
1337 * - encoding: Set by user.
1338 * - decoding: unused
1343 * maximum quantizer difference between frames
1344 * - encoding: Set by user.
1345 * - decoding: unused
1350 * maximum number of B-frames between non-B-frames
1351 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1352 * - encoding: Set by user.
1353 * - decoding: unused
1358 * qscale factor between IP and B-frames
1359 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1360 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1361 * - encoding: Set by user.
1362 * - decoding: unused
1364 float b_quant_factor;
1366 /** obsolete FIXME remove */
1368 #define FF_RC_STRATEGY_XVID 1
1370 int b_frame_strategy;
1372 struct AVCodec *codec;
1376 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1377 /* do its best to deliver a chunk with size */
1378 /* below rtp_payload_size, the chunk will start */
1379 /* with a start code on some codecs like H.263. */
1380 /* This doesn't take account of any particular */
1381 /* headers inside the transmitted RTP payload. */
1384 /* The RTP callback: This function is called */
1385 /* every time the encoder has a packet to send. */
1386 /* It depends on the encoder if the data starts */
1387 /* with a Start Code (it should). H.263 does. */
1388 /* mb_nb contains the number of macroblocks */
1389 /* encoded in the RTP payload. */
1390 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1392 /* statistics, used for 2-pass encoding */
1403 * number of bits used for the previously encoded frame
1404 * - encoding: Set by libavcodec.
1405 * - decoding: unused
1410 * Private data of the user, can be used to carry app specific stuff.
1411 * - encoding: Set by user.
1412 * - decoding: Set by user.
1416 char codec_name[32];
1417 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1418 enum CodecID codec_id; /* see CODEC_ID_xxx */
1421 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1422 * This is used to work around some encoder bugs.
1423 * A demuxer should set this to what is stored in the field used to identify the codec.
1424 * If there are multiple such fields in a container then the demuxer should choose the one
1425 * which maximizes the information about the used codec.
1426 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1427 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1428 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1430 * - encoding: Set by user, if not then the default based on codec_id will be used.
1431 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1433 unsigned int codec_tag;
1436 * Work around bugs in encoders which sometimes cannot be detected automatically.
1437 * - encoding: Set by user
1438 * - decoding: Set by user
1440 int workaround_bugs;
1441 #define FF_BUG_AUTODETECT 1 ///< autodetection
1442 #define FF_BUG_OLD_MSMPEG4 2
1443 #define FF_BUG_XVID_ILACE 4
1444 #define FF_BUG_UMP4 8
1445 #define FF_BUG_NO_PADDING 16
1446 #define FF_BUG_AMV 32
1447 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1448 #define FF_BUG_QPEL_CHROMA 64
1449 #define FF_BUG_STD_QPEL 128
1450 #define FF_BUG_QPEL_CHROMA2 256
1451 #define FF_BUG_DIRECT_BLOCKSIZE 512
1452 #define FF_BUG_EDGE 1024
1453 #define FF_BUG_HPEL_CHROMA 2048
1454 #define FF_BUG_DC_CLIP 4096
1455 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1456 #define FF_BUG_TRUNCATED 16384
1459 * luma single coefficient elimination threshold
1460 * - encoding: Set by user.
1461 * - decoding: unused
1463 int luma_elim_threshold;
1466 * chroma single coeff elimination threshold
1467 * - encoding: Set by user.
1468 * - decoding: unused
1470 int chroma_elim_threshold;
1473 * strictly follow the standard (MPEG4, ...).
1474 * - encoding: Set by user.
1475 * - decoding: Set by user.
1476 * Setting this to STRICT or higher means the encoder and decoder will
1477 * generally do stupid things, whereas setting it to unofficial or lower
1478 * will mean the encoder might produce output that is not supported by all
1479 * spec-compliant decoders. Decoders don't differentiate between normal,
1480 * unofficial and experimental (that is, they always try to decode things
1481 * when they can) unless they are explicitly asked to behave stupidly
1482 * (=strictly conform to the specs)
1484 int strict_std_compliance;
1485 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1486 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1487 #define FF_COMPLIANCE_NORMAL 0
1488 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1489 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1492 * qscale offset between IP and B-frames
1493 * - encoding: Set by user.
1494 * - decoding: unused
1496 float b_quant_offset;
1499 * Called at the beginning of each frame to get a buffer for it.
1501 * The function will set AVFrame.data[], AVFrame.linesize[].
1502 * AVFrame.extended_data[] must also be set, but it should be the same as
1503 * AVFrame.data[] except for planar audio with more channels than can fit
1504 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1505 * many data pointers as it can hold.
1507 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1508 * avcodec_default_get_buffer() instead of providing buffers allocated by
1511 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1512 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1513 * but if get_buffer() is overridden then alignment considerations should
1514 * be taken into account.
1516 * @see avcodec_default_get_buffer()
1520 * If pic.reference is set then the frame will be read later by libavcodec.
1521 * avcodec_align_dimensions2() should be used to find the required width and
1522 * height, as they normally need to be rounded up to the next multiple of 16.
1524 * If frame multithreading is used and thread_safe_callbacks is set,
1525 * it may be called from a different thread, but not from more than one at
1526 * once. Does not need to be reentrant.
1528 * @see release_buffer(), reget_buffer()
1529 * @see avcodec_align_dimensions2()
1533 * Decoders request a buffer of a particular size by setting
1534 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1535 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1536 * to a smaller value in the output frame.
1538 * Decoders cannot use the buffer after returning from
1539 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1540 * is assumed to be released immediately upon return.
1542 * As a convenience, av_samples_get_buffer_size() and
1543 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1544 * functions to find the required data size and to fill data pointers and
1545 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1546 * since all planes must be the same size.
1548 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1550 * - encoding: unused
1551 * - decoding: Set by libavcodec, user can override.
1553 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1556 * Called to release buffers which were allocated with get_buffer.
1557 * A released buffer can be reused in get_buffer().
1558 * pic.data[*] must be set to NULL.
1559 * May be called from a different thread if frame multithreading is used,
1560 * but not by more than one thread at once, so does not need to be reentrant.
1561 * - encoding: unused
1562 * - decoding: Set by libavcodec, user can override.
1564 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1567 * Size of the frame reordering buffer in the decoder.
1568 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1569 * - encoding: Set by libavcodec.
1570 * - decoding: Set by libavcodec.
1575 * number of bytes per packet if constant and known or 0
1576 * Used by some WAV based audio codecs.
1581 * 0-> h263 quant 1-> mpeg quant
1582 * - encoding: Set by user.
1583 * - decoding: unused
1588 * pass1 encoding statistics output buffer
1589 * - encoding: Set by libavcodec.
1590 * - decoding: unused
1595 * pass2 encoding statistics input buffer
1596 * Concatenated stuff from stats_out of pass1 should be placed here.
1597 * - encoding: Allocated/set/freed by user.
1598 * - decoding: unused
1603 * ratecontrol qmin qmax limiting method
1604 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1605 * - encoding: Set by user.
1606 * - decoding: unused
1614 * ratecontrol override, see RcOverride
1615 * - encoding: Allocated/set/freed by user.
1616 * - decoding: unused
1618 RcOverride *rc_override;
1619 int rc_override_count;
1622 * rate control equation
1623 * - encoding: Set by user
1624 * - decoding: unused
1630 * - encoding: Set by user.
1631 * - decoding: unused
1637 * - encoding: Set by user.
1638 * - decoding: unused
1643 * decoder bitstream buffer size
1644 * - encoding: Set by user.
1645 * - decoding: unused
1648 float rc_buffer_aggressivity;
1651 * qscale factor between P and I-frames
1652 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1653 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1654 * - encoding: Set by user.
1655 * - decoding: unused
1657 float i_quant_factor;
1660 * qscale offset between P and I-frames
1661 * - encoding: Set by user.
1662 * - decoding: unused
1664 float i_quant_offset;
1667 * initial complexity for pass1 ratecontrol
1668 * - encoding: Set by user.
1669 * - decoding: unused
1671 float rc_initial_cplx;
1674 * DCT algorithm, see FF_DCT_* below
1675 * - encoding: Set by user.
1676 * - decoding: unused
1679 #define FF_DCT_AUTO 0
1680 #define FF_DCT_FASTINT 1
1681 #define FF_DCT_INT 2
1682 #define FF_DCT_MMX 3
1683 #define FF_DCT_MLIB 4
1684 #define FF_DCT_ALTIVEC 5
1685 #define FF_DCT_FAAN 6
1688 * luminance masking (0-> disabled)
1689 * - encoding: Set by user.
1690 * - decoding: unused
1695 * temporary complexity masking (0-> disabled)
1696 * - encoding: Set by user.
1697 * - decoding: unused
1699 float temporal_cplx_masking;
1702 * spatial complexity masking (0-> disabled)
1703 * - encoding: Set by user.
1704 * - decoding: unused
1706 float spatial_cplx_masking;
1709 * p block masking (0-> disabled)
1710 * - encoding: Set by user.
1711 * - decoding: unused
1716 * darkness masking (0-> disabled)
1717 * - encoding: Set by user.
1718 * - decoding: unused
1723 * IDCT algorithm, see FF_IDCT_* below.
1724 * - encoding: Set by user.
1725 * - decoding: Set by user.
1728 #define FF_IDCT_AUTO 0
1729 #define FF_IDCT_INT 1
1730 #define FF_IDCT_SIMPLE 2
1731 #define FF_IDCT_SIMPLEMMX 3
1732 #define FF_IDCT_LIBMPEG2MMX 4
1733 #define FF_IDCT_PS2 5
1734 #define FF_IDCT_MLIB 6
1735 #define FF_IDCT_ARM 7
1736 #define FF_IDCT_ALTIVEC 8
1737 #define FF_IDCT_SH4 9
1738 #define FF_IDCT_SIMPLEARM 10
1739 #define FF_IDCT_H264 11
1740 #define FF_IDCT_VP3 12
1741 #define FF_IDCT_IPP 13
1742 #define FF_IDCT_XVIDMMX 14
1743 #define FF_IDCT_CAVS 15
1744 #define FF_IDCT_SIMPLEARMV5TE 16
1745 #define FF_IDCT_SIMPLEARMV6 17
1746 #define FF_IDCT_SIMPLEVIS 18
1747 #define FF_IDCT_WMV2 19
1748 #define FF_IDCT_FAAN 20
1749 #define FF_IDCT_EA 21
1750 #define FF_IDCT_SIMPLENEON 22
1751 #define FF_IDCT_SIMPLEALPHA 23
1752 #define FF_IDCT_BINK 24
1756 * - encoding: Set by libavcodec.
1757 * - decoding: Set by user (or 0).
1761 * slice offsets in the frame in bytes
1762 * - encoding: Set/allocated by libavcodec.
1763 * - decoding: Set/allocated by user (or NULL).
1768 * error concealment flags
1769 * - encoding: unused
1770 * - decoding: Set by user.
1772 int error_concealment;
1773 #define FF_EC_GUESS_MVS 1
1774 #define FF_EC_DEBLOCK 2
1777 * dsp_mask could be add used to disable unwanted CPU features
1778 * CPU features (i.e. MMX, SSE. ...)
1780 * With the FORCE flag you may instead enable given CPU features.
1781 * (Dangerous: Usable in case of misdetection, improper usage however will
1782 * result into program crash.)
1787 * bits per sample/pixel from the demuxer (needed for huffyuv).
1788 * - encoding: Set by libavcodec.
1789 * - decoding: Set by user.
1791 int bits_per_coded_sample;
1794 * prediction method (needed for huffyuv)
1795 * - encoding: Set by user.
1796 * - decoding: unused
1798 int prediction_method;
1799 #define FF_PRED_LEFT 0
1800 #define FF_PRED_PLANE 1
1801 #define FF_PRED_MEDIAN 2
1804 * sample aspect ratio (0 if unknown)
1805 * That is the width of a pixel divided by the height of the pixel.
1806 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1807 * - encoding: Set by user.
1808 * - decoding: Set by libavcodec.
1810 AVRational sample_aspect_ratio;
1813 * the picture in the bitstream
1814 * - encoding: Set by libavcodec.
1815 * - decoding: Set by libavcodec.
1817 AVFrame *coded_frame;
1821 * - encoding: Set by user.
1822 * - decoding: Set by user.
1825 #define FF_DEBUG_PICT_INFO 1
1826 #define FF_DEBUG_RC 2
1827 #define FF_DEBUG_BITSTREAM 4
1828 #define FF_DEBUG_MB_TYPE 8
1829 #define FF_DEBUG_QP 16
1830 #define FF_DEBUG_MV 32
1831 #define FF_DEBUG_DCT_COEFF 0x00000040
1832 #define FF_DEBUG_SKIP 0x00000080
1833 #define FF_DEBUG_STARTCODE 0x00000100
1834 #define FF_DEBUG_PTS 0x00000200
1835 #define FF_DEBUG_ER 0x00000400
1836 #define FF_DEBUG_MMCO 0x00000800
1837 #define FF_DEBUG_BUGS 0x00001000
1838 #define FF_DEBUG_VIS_QP 0x00002000
1839 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1840 #define FF_DEBUG_BUFFERS 0x00008000
1841 #define FF_DEBUG_THREADS 0x00010000
1845 * - encoding: Set by user.
1846 * - decoding: Set by user.
1849 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1850 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1851 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1855 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1856 * - decoding: unused
1858 uint64_t error[AV_NUM_DATA_POINTERS];
1861 * motion estimation comparison function
1862 * - encoding: Set by user.
1863 * - decoding: unused
1867 * subpixel motion estimation comparison function
1868 * - encoding: Set by user.
1869 * - decoding: unused
1873 * macroblock comparison function (not supported yet)
1874 * - encoding: Set by user.
1875 * - decoding: unused
1879 * interlaced DCT comparison function
1880 * - encoding: Set by user.
1881 * - decoding: unused
1884 #define FF_CMP_SAD 0
1885 #define FF_CMP_SSE 1
1886 #define FF_CMP_SATD 2
1887 #define FF_CMP_DCT 3
1888 #define FF_CMP_PSNR 4
1889 #define FF_CMP_BIT 5
1891 #define FF_CMP_ZERO 7
1892 #define FF_CMP_VSAD 8
1893 #define FF_CMP_VSSE 9
1894 #define FF_CMP_NSSE 10
1895 #define FF_CMP_W53 11
1896 #define FF_CMP_W97 12
1897 #define FF_CMP_DCTMAX 13
1898 #define FF_CMP_DCT264 14
1899 #define FF_CMP_CHROMA 256
1902 * ME diamond size & shape
1903 * - encoding: Set by user.
1904 * - decoding: unused
1909 * amount of previous MV predictors (2a+1 x 2a+1 square)
1910 * - encoding: Set by user.
1911 * - decoding: unused
1913 int last_predictor_count;
1916 * prepass for motion estimation
1917 * - encoding: Set by user.
1918 * - decoding: unused
1923 * motion estimation prepass comparison function
1924 * - encoding: Set by user.
1925 * - decoding: unused
1930 * ME prepass diamond size & shape
1931 * - encoding: Set by user.
1932 * - decoding: unused
1938 * - encoding: Set by user.
1939 * - decoding: unused
1941 int me_subpel_quality;
1944 * callback to negotiate the pixelFormat
1945 * @param fmt is the list of formats which are supported by the codec,
1946 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1947 * The first is always the native one.
1948 * @return the chosen format
1949 * - encoding: unused
1950 * - decoding: Set by user, if not set the native format will be chosen.
1952 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1955 * DTG active format information (additional aspect ratio
1956 * information only used in DVB MPEG-2 transport streams)
1959 * - encoding: unused
1960 * - decoding: Set by decoder.
1962 int dtg_active_format;
1963 #define FF_DTG_AFD_SAME 8
1964 #define FF_DTG_AFD_4_3 9
1965 #define FF_DTG_AFD_16_9 10
1966 #define FF_DTG_AFD_14_9 11
1967 #define FF_DTG_AFD_4_3_SP_14_9 13
1968 #define FF_DTG_AFD_16_9_SP_14_9 14
1969 #define FF_DTG_AFD_SP_4_3 15
1972 * maximum motion estimation search range in subpel units
1973 * If 0 then no limit.
1975 * - encoding: Set by user.
1976 * - decoding: unused
1981 * intra quantizer bias
1982 * - encoding: Set by user.
1983 * - decoding: unused
1985 int intra_quant_bias;
1986 #define FF_DEFAULT_QUANT_BIAS 999999
1989 * inter quantizer bias
1990 * - encoding: Set by user.
1991 * - decoding: unused
1993 int inter_quant_bias;
1997 * - encoding: unused
1998 * - decoding: Which clrtable should be used for 8bit RGB images.
1999 * Tables have to be stored somewhere. FIXME
2004 * Global quality for codecs which cannot change it per frame.
2005 * This should be proportional to MPEG-1/2/4 qscale.
2006 * - encoding: Set by user.
2007 * - decoding: unused
2011 #define FF_CODER_TYPE_VLC 0
2012 #define FF_CODER_TYPE_AC 1
2013 #define FF_CODER_TYPE_RAW 2
2014 #define FF_CODER_TYPE_RLE 3
2015 #define FF_CODER_TYPE_DEFLATE 4
2018 * - encoding: Set by user.
2019 * - decoding: unused
2025 * - encoding: Set by user.
2026 * - decoding: unused
2032 * - encoding: unused
2033 * - decoding: Set by user.
2036 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2037 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2038 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2041 * XVideo Motion Acceleration
2042 * - encoding: forbidden
2043 * - decoding: set by decoder
2045 int xvmc_acceleration;
2048 * macroblock decision mode
2049 * - encoding: Set by user.
2050 * - decoding: unused
2053 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2054 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2055 #define FF_MB_DECISION_RD 2 ///< rate distortion
2058 * custom intra quantization matrix
2059 * - encoding: Set by user, can be NULL.
2060 * - decoding: Set by libavcodec.
2062 uint16_t *intra_matrix;
2065 * custom inter quantization matrix
2066 * - encoding: Set by user, can be NULL.
2067 * - decoding: Set by libavcodec.
2069 uint16_t *inter_matrix;
2072 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2073 * This is used to work around some encoder bugs.
2074 * - encoding: unused
2075 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2077 unsigned int stream_codec_tag;
2080 * scene change detection threshold
2081 * 0 is default, larger means fewer detected scene changes.
2082 * - encoding: Set by user.
2083 * - decoding: unused
2085 int scenechange_threshold;
2088 * minimum Lagrange multipler
2089 * - encoding: Set by user.
2090 * - decoding: unused
2095 * maximum Lagrange multipler
2096 * - encoding: Set by user.
2097 * - decoding: unused
2102 * noise reduction strength
2103 * - encoding: Set by user.
2104 * - decoding: unused
2106 int noise_reduction;
2109 * Called at the beginning of a frame to get cr buffer for it.
2110 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2111 * libavcodec will pass previous buffer in pic, function should return
2112 * same buffer or new buffer with old frame "painted" into it.
2113 * If pic.data[0] == NULL must behave like get_buffer().
2114 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2115 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2117 * - encoding: unused
2118 * - decoding: Set by libavcodec, user can override.
2120 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2123 * Number of bits which should be loaded into the rc buffer before decoding starts.
2124 * - encoding: Set by user.
2125 * - decoding: unused
2127 int rc_initial_buffer_occupancy;
2131 * - encoding: Set by user.
2132 * - decoding: unused
2134 int inter_threshold;
2138 * - encoding: Set by user.
2139 * - decoding: Set by user.
2144 * Simulates errors in the bitstream to test error concealment.
2145 * - encoding: Set by user.
2146 * - decoding: unused
2151 * quantizer noise shaping
2152 * - encoding: Set by user.
2153 * - decoding: unused
2155 int quantizer_noise_shaping;
2159 * is used to decide how many independent tasks should be passed to execute()
2160 * - encoding: Set by user.
2161 * - decoding: Set by user.
2166 * The codec may call this to execute several independent things.
2167 * It will return only after finishing all tasks.
2168 * The user may replace this with some multithreaded implementation,
2169 * the default implementation will execute the parts serially.
2170 * @param count the number of things to execute
2171 * - encoding: Set by libavcodec, user can override.
2172 * - decoding: Set by libavcodec, user can override.
2174 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2178 * Can be used by execute() to store some per AVCodecContext stuff.
2179 * - encoding: set by execute()
2180 * - decoding: set by execute()
2182 void *thread_opaque;
2185 * Motion estimation threshold below which no motion estimation is
2186 * performed, but instead the user specified motion vectors are used.
2188 * - encoding: Set by user.
2189 * - decoding: unused
2194 * Macroblock threshold below which the user specified macroblock types will be used.
2195 * - encoding: Set by user.
2196 * - decoding: unused
2201 * precision of the intra DC coefficient - 8
2202 * - encoding: Set by user.
2203 * - decoding: unused
2205 int intra_dc_precision;
2208 * noise vs. sse weight for the nsse comparsion function
2209 * - encoding: Set by user.
2210 * - decoding: unused
2215 * Number of macroblock rows at the top which are skipped.
2216 * - encoding: unused
2217 * - decoding: Set by user.
2222 * Number of macroblock rows at the bottom which are skipped.
2223 * - encoding: unused
2224 * - decoding: Set by user.
2230 * - encoding: Set by user.
2231 * - decoding: Set by libavcodec.
2234 #define FF_PROFILE_UNKNOWN -99
2235 #define FF_PROFILE_RESERVED -100
2237 #define FF_PROFILE_AAC_MAIN 0
2238 #define FF_PROFILE_AAC_LOW 1
2239 #define FF_PROFILE_AAC_SSR 2
2240 #define FF_PROFILE_AAC_LTP 3
2242 #define FF_PROFILE_DTS 20
2243 #define FF_PROFILE_DTS_ES 30
2244 #define FF_PROFILE_DTS_96_24 40
2245 #define FF_PROFILE_DTS_HD_HRA 50
2246 #define FF_PROFILE_DTS_HD_MA 60
2248 #define FF_PROFILE_MPEG2_422 0
2249 #define FF_PROFILE_MPEG2_HIGH 1
2250 #define FF_PROFILE_MPEG2_SS 2
2251 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2252 #define FF_PROFILE_MPEG2_MAIN 4
2253 #define FF_PROFILE_MPEG2_SIMPLE 5
2255 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2256 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2258 #define FF_PROFILE_H264_BASELINE 66
2259 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2260 #define FF_PROFILE_H264_MAIN 77
2261 #define FF_PROFILE_H264_EXTENDED 88
2262 #define FF_PROFILE_H264_HIGH 100
2263 #define FF_PROFILE_H264_HIGH_10 110
2264 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2265 #define FF_PROFILE_H264_HIGH_422 122
2266 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2267 #define FF_PROFILE_H264_HIGH_444 144
2268 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2269 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2270 #define FF_PROFILE_H264_CAVLC_444 44
2272 #define FF_PROFILE_VC1_SIMPLE 0
2273 #define FF_PROFILE_VC1_MAIN 1
2274 #define FF_PROFILE_VC1_COMPLEX 2
2275 #define FF_PROFILE_VC1_ADVANCED 3
2277 #define FF_PROFILE_MPEG4_SIMPLE 0
2278 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2279 #define FF_PROFILE_MPEG4_CORE 2
2280 #define FF_PROFILE_MPEG4_MAIN 3
2281 #define FF_PROFILE_MPEG4_N_BIT 4
2282 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2283 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2284 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2285 #define FF_PROFILE_MPEG4_HYBRID 8
2286 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2287 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2288 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2289 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2290 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2291 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2292 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2296 * - encoding: Set by user.
2297 * - decoding: Set by libavcodec.
2300 #define FF_LEVEL_UNKNOWN -99
2303 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2304 * - encoding: unused
2305 * - decoding: Set by user.
2310 * Bitstream width / height, may be different from width/height if lowres enabled.
2311 * - encoding: unused
2312 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2314 int coded_width, coded_height;
2317 * frame skip threshold
2318 * - encoding: Set by user.
2319 * - decoding: unused
2321 int frame_skip_threshold;
2325 * - encoding: Set by user.
2326 * - decoding: unused
2328 int frame_skip_factor;
2331 * frame skip exponent
2332 * - encoding: Set by user.
2333 * - decoding: unused
2338 * frame skip comparison function
2339 * - encoding: Set by user.
2340 * - decoding: unused
2345 * Border processing masking, raises the quantizer for mbs on the borders
2347 * - encoding: Set by user.
2348 * - decoding: unused
2350 float border_masking;
2353 * minimum MB lagrange multipler
2354 * - encoding: Set by user.
2355 * - decoding: unused
2360 * maximum MB lagrange multipler
2361 * - encoding: Set by user.
2362 * - decoding: unused
2368 * - encoding: Set by user.
2369 * - decoding: unused
2371 int me_penalty_compensation;
2375 * - encoding: unused
2376 * - decoding: Set by user.
2378 enum AVDiscard skip_loop_filter;
2382 * - encoding: unused
2383 * - decoding: Set by user.
2385 enum AVDiscard skip_idct;
2389 * - encoding: unused
2390 * - decoding: Set by user.
2392 enum AVDiscard skip_frame;
2396 * - encoding: Set by user.
2397 * - decoding: unused
2403 * - encoding: Set by user.
2404 * - decoding: unused
2410 * - encoding: Set by user.
2411 * - decoding: unused
2416 * number of reference frames
2417 * - encoding: Set by user.
2418 * - decoding: Set by lavc.
2423 * chroma qp offset from luma
2424 * - encoding: Set by user.
2425 * - decoding: unused
2430 * trellis RD quantization
2431 * - encoding: Set by user.
2432 * - decoding: unused
2437 * Audio cutoff bandwidth (0 means "automatic")
2438 * - encoding: Set by user.
2439 * - decoding: unused
2444 * Multiplied by qscale for each frame and added to scene_change_score.
2445 * - encoding: Set by user.
2446 * - decoding: unused
2448 int scenechange_factor;
2452 * Note: Value depends upon the compare function used for fullpel ME.
2453 * - encoding: Set by user.
2454 * - decoding: unused
2459 * Adjust sensitivity of b_frame_strategy 1.
2460 * - encoding: Set by user.
2461 * - decoding: unused
2466 * - encoding: Set by user.
2467 * - decoding: unused
2469 int compression_level;
2470 #define FF_COMPRESSION_DEFAULT -1
2473 * - encoding: Set by user.
2474 * - decoding: unused
2476 int min_prediction_order;
2479 * - encoding: Set by user.
2480 * - decoding: unused
2482 int max_prediction_order;
2485 * GOP timecode frame start number, in non drop frame format
2486 * - encoding: Set by user.
2487 * - decoding: unused
2489 int64_t timecode_frame_start;
2491 #if FF_API_REQUEST_CHANNELS
2493 * Decoder should decode to this many channels if it can (0 for default)
2494 * - encoding: unused
2495 * - decoding: Set by user.
2496 * @deprecated Deprecated in favor of request_channel_layout.
2498 int request_channels;
2502 * opaque 64bit number (generally a PTS) that will be reordered and
2503 * output in AVFrame.reordered_opaque
2504 * @deprecated in favor of pkt_pts
2505 * - encoding: unused
2506 * - decoding: Set by user.
2508 int64_t reordered_opaque;
2511 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2512 * - encoding: set by user.
2513 * - decoding: set by libavcodec.
2515 int bits_per_raw_sample;
2518 * Audio channel layout.
2519 * - encoding: set by user.
2520 * - decoding: set by libavcodec.
2522 uint64_t channel_layout;
2525 * Request decoder to use this channel layout if it can (0 for default)
2526 * - encoding: unused
2527 * - decoding: Set by user.
2529 uint64_t request_channel_layout;
2532 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2533 * - encoding: Set by user.
2534 * - decoding: unused.
2536 float rc_max_available_vbv_use;
2539 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2540 * - encoding: Set by user.
2541 * - decoding: unused.
2543 float rc_min_vbv_overflow_use;
2546 * Hardware accelerator in use
2547 * - encoding: unused.
2548 * - decoding: Set by libavcodec
2550 struct AVHWAccel *hwaccel;
2553 * For some codecs, the time base is closer to the field rate than the frame rate.
2554 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2555 * if no telecine is used ...
2557 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2559 int ticks_per_frame;
2562 * Hardware accelerator context.
2563 * For some hardware accelerators, a global context needs to be
2564 * provided by the user. In that case, this holds display-dependent
2565 * data Libav cannot instantiate itself. Please refer to the
2566 * Libav HW accelerator documentation to know how to fill this
2567 * is. e.g. for VA API, this is a struct vaapi_context.
2568 * - encoding: unused
2569 * - decoding: Set by user
2571 void *hwaccel_context;
2574 * Chromaticity coordinates of the source primaries.
2575 * - encoding: Set by user
2576 * - decoding: Set by libavcodec
2578 enum AVColorPrimaries color_primaries;
2581 * Color Transfer Characteristic.
2582 * - encoding: Set by user
2583 * - decoding: Set by libavcodec
2585 enum AVColorTransferCharacteristic color_trc;
2588 * YUV colorspace type.
2589 * - encoding: Set by user
2590 * - decoding: Set by libavcodec
2592 enum AVColorSpace colorspace;
2595 * MPEG vs JPEG YUV range.
2596 * - encoding: Set by user
2597 * - decoding: Set by libavcodec
2599 enum AVColorRange color_range;
2602 * This defines the location of chroma samples.
2603 * - encoding: Set by user
2604 * - decoding: Set by libavcodec
2606 enum AVChromaLocation chroma_sample_location;
2609 * The codec may call this to execute several independent things.
2610 * It will return only after finishing all tasks.
2611 * The user may replace this with some multithreaded implementation,
2612 * the default implementation will execute the parts serially.
2613 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2614 * @param c context passed also to func
2615 * @param count the number of things to execute
2616 * @param arg2 argument passed unchanged to func
2617 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2618 * @param func function that will be called count times, with jobnr from 0 to count-1.
2619 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2620 * two instances of func executing at the same time will have the same threadnr.
2621 * @return always 0 currently, but code should handle a future improvement where when any call to func
2622 * returns < 0 no further calls to func may be done and < 0 is returned.
2623 * - encoding: Set by libavcodec, user can override.
2624 * - decoding: Set by libavcodec, user can override.
2626 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2628 int log_level_offset;
2632 * Indicates number of picture subdivisions. Used for parallelized
2634 * - encoding: Set by user
2635 * - decoding: unused
2640 * Header containing style information for text subtitles.
2641 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2642 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2643 * the Format line following. It shouldn't include any Dialogue line.
2644 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2645 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2647 uint8_t *subtitle_header;
2648 int subtitle_header_size;
2651 * Current packet as passed into the decoder, to avoid having
2652 * to pass the packet into every function. Currently only valid
2653 * inside lavc and get/release_buffer callbacks.
2654 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2655 * - encoding: unused
2660 * Which multithreading methods to use.
2661 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2662 * so clients which cannot provide future frames should not use it.
2664 * - encoding: Set by user, otherwise the default is used.
2665 * - decoding: Set by user, otherwise the default is used.
2668 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2669 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2672 * Which multithreading methods are in use by the codec.
2673 * - encoding: Set by libavcodec.
2674 * - decoding: Set by libavcodec.
2676 int active_thread_type;
2679 * Set by the client if its custom get_buffer() callback can be called
2680 * from another thread, which allows faster multithreaded decoding.
2681 * draw_horiz_band() will be called from other threads regardless of this setting.
2682 * Ignored if the default get_buffer() is used.
2683 * - encoding: Set by user.
2684 * - decoding: Set by user.
2686 int thread_safe_callbacks;
2689 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2690 * Used for compliant TS muxing.
2691 * - encoding: Set by libavcodec.
2692 * - decoding: unused.
2697 * Type of service that the audio stream conveys.
2698 * - encoding: Set by user.
2699 * - decoding: Set by libavcodec.
2701 enum AVAudioServiceType audio_service_type;
2704 * Used to request a sample format from the decoder.
2705 * - encoding: unused.
2706 * - decoding: Set by user.
2708 enum AVSampleFormat request_sample_fmt;
2711 * Error recognition; may misdetect some more or less valid parts as errors.
2712 * - encoding: unused
2713 * - decoding: Set by user.
2715 int err_recognition;
2716 #define AV_EF_CRCCHECK (1<<0)
2717 #define AV_EF_BITSTREAM (1<<1)
2718 #define AV_EF_BUFFER (1<<2)
2719 #define AV_EF_EXPLODE (1<<3)
2722 * Private context used for internal data.
2724 * Unlike priv_data, this is not codec-specific. It is used in general
2725 * libavcodec functions.
2727 struct AVCodecInternal *internal;
2730 * - encoding: set by libavcodec
2731 * - decoding: Set by libavcodec
2733 enum AVFieldOrder field_order;
2739 typedef struct AVProfile {
2741 const char *name; ///< short name for the profile
2744 typedef struct AVCodecDefault AVCodecDefault;
2749 typedef struct AVCodec {
2751 * Name of the codec implementation.
2752 * The name is globally unique among encoders and among decoders (but an
2753 * encoder and a decoder can share the same name).
2754 * This is the primary way to find a codec from the user perspective.
2758 * Descriptive name for the codec, meant to be more human readable than name.
2759 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2761 const char *long_name;
2762 enum AVMediaType type;
2765 * Codec capabilities.
2769 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2770 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2771 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2772 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2773 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2774 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2775 const AVClass *priv_class; ///< AVClass for the private context
2776 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2778 /*****************************************************************
2779 * No fields below this line are part of the public API. They
2780 * may not be used outside of libavcodec and can be changed and
2782 * New public fields should be added right above.
2783 *****************************************************************
2786 struct AVCodec *next;
2788 * @name Frame-level threading support functions
2792 * If defined, called on thread contexts when they are created.
2793 * If the codec allocates writable tables in init(), re-allocate them here.
2794 * priv_data will be set to a copy of the original.
2796 int (*init_thread_copy)(AVCodecContext *);
2798 * Copy necessary context variables from a previous thread context to the current one.
2799 * If not defined, the next thread will start automatically; otherwise, the codec
2800 * must call ff_thread_finish_setup().
2802 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2804 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2808 * Private codec-specific defaults.
2810 const AVCodecDefault *defaults;
2813 * Initialize codec static data, called from avcodec_register().
2815 void (*init_static_data)(struct AVCodec *codec);
2817 int (*init)(AVCodecContext *);
2818 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2820 * Encode data to an AVPacket.
2822 * @param avctx codec context
2823 * @param avpkt output AVPacket (may contain a user-provided buffer)
2824 * @param[in] frame AVFrame containing the raw data to be encoded
2825 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2826 * non-empty packet was returned in avpkt.
2827 * @return 0 on success, negative error code on failure
2829 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2830 int *got_packet_ptr);
2831 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2832 int (*close)(AVCodecContext *);
2835 * Will be called when seeking
2837 void (*flush)(AVCodecContext *);
2843 typedef struct AVHWAccel {
2845 * Name of the hardware accelerated codec.
2846 * The name is globally unique among encoders and among decoders (but an
2847 * encoder and a decoder can share the same name).
2852 * Type of codec implemented by the hardware accelerator.
2854 * See AVMEDIA_TYPE_xxx
2856 enum AVMediaType type;
2859 * Codec implemented by the hardware accelerator.
2866 * Supported pixel format.
2868 * Only hardware accelerated formats are supported here.
2870 enum PixelFormat pix_fmt;
2873 * Hardware accelerated codec capabilities.
2874 * see FF_HWACCEL_CODEC_CAP_*
2878 struct AVHWAccel *next;
2881 * Called at the beginning of each frame or field picture.
2883 * Meaningful frame information (codec specific) is guaranteed to
2884 * be parsed at this point. This function is mandatory.
2886 * Note that buf can be NULL along with buf_size set to 0.
2887 * Otherwise, this means the whole frame is available at this point.
2889 * @param avctx the codec context
2890 * @param buf the frame data buffer base
2891 * @param buf_size the size of the frame in bytes
2892 * @return zero if successful, a negative value otherwise
2894 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2897 * Callback for each slice.
2899 * Meaningful slice information (codec specific) is guaranteed to
2900 * be parsed at this point. This function is mandatory.
2902 * @param avctx the codec context
2903 * @param buf the slice data buffer base
2904 * @param buf_size the size of the slice in bytes
2905 * @return zero if successful, a negative value otherwise
2907 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2910 * Called at the end of each frame or field picture.
2912 * The whole picture is parsed at this point and can now be sent
2913 * to the hardware accelerator. This function is mandatory.
2915 * @param avctx the codec context
2916 * @return zero if successful, a negative value otherwise
2918 int (*end_frame)(AVCodecContext *avctx);
2921 * Size of HW accelerator private data.
2923 * Private data is allocated with av_mallocz() before
2924 * AVCodecContext.get_buffer() and deallocated after
2925 * AVCodecContext.release_buffer().
2931 * four components are given, that's all.
2932 * the last component is alpha
2934 typedef struct AVPicture {
2935 uint8_t *data[AV_NUM_DATA_POINTERS];
2936 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
2939 #define AVPALETTE_SIZE 1024
2940 #define AVPALETTE_COUNT 256
2942 enum AVSubtitleType {
2945 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2948 * Plain text, the text field must be set by the decoder and is
2949 * authoritative. ass and pict fields may contain approximations.
2954 * Formatted text, the ass field must be set by the decoder and is
2955 * authoritative. pict and text fields may contain approximations.
2960 typedef struct AVSubtitleRect {
2961 int x; ///< top left corner of pict, undefined when pict is not set
2962 int y; ///< top left corner of pict, undefined when pict is not set
2963 int w; ///< width of pict, undefined when pict is not set
2964 int h; ///< height of pict, undefined when pict is not set
2965 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2968 * data+linesize for the bitmap of this subtitle.
2969 * can be set for text/ass as well once they where rendered
2972 enum AVSubtitleType type;
2974 char *text; ///< 0 terminated plain UTF-8 text
2977 * 0 terminated ASS/SSA compatible event line.
2978 * The pressentation of this is unaffected by the other values in this
2984 typedef struct AVSubtitle {
2985 uint16_t format; /* 0 = graphics */
2986 uint32_t start_display_time; /* relative to packet pts, in ms */
2987 uint32_t end_display_time; /* relative to packet pts, in ms */
2989 AVSubtitleRect **rects;
2990 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
2993 /* packet functions */
2996 * @deprecated use NULL instead
2998 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3001 * Default packet destructor.
3003 void av_destruct_packet(AVPacket *pkt);
3006 * Initialize optional fields of a packet with default values.
3010 void av_init_packet(AVPacket *pkt);
3013 * Allocate the payload of a packet and initialize its fields with
3017 * @param size wanted payload size
3018 * @return 0 if OK, AVERROR_xxx otherwise
3020 int av_new_packet(AVPacket *pkt, int size);
3023 * Reduce packet size, correctly zeroing padding
3026 * @param size new size
3028 void av_shrink_packet(AVPacket *pkt, int size);
3031 * Increase packet size, correctly zeroing padding
3034 * @param grow_by number of bytes by which to increase the size of the packet
3036 int av_grow_packet(AVPacket *pkt, int grow_by);
3039 * @warning This is a hack - the packet memory allocation stuff is broken. The
3040 * packet is allocated if it was not really allocated.
3042 int av_dup_packet(AVPacket *pkt);
3047 * @param pkt packet to free
3049 void av_free_packet(AVPacket *pkt);
3052 * Allocate new information of a packet.
3055 * @param type side information type
3056 * @param size side information size
3057 * @return pointer to fresh allocated data or NULL otherwise
3059 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3063 * Get side information from packet.
3066 * @param type desired side information type
3067 * @param size pointer for side information size to store (optional)
3068 * @return pointer to data if present or NULL otherwise
3070 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3075 struct ReSampleContext;
3076 struct AVResampleContext;
3078 typedef struct ReSampleContext ReSampleContext;
3081 * Initialize audio resampling context.
3083 * @param output_channels number of output channels
3084 * @param input_channels number of input channels
3085 * @param output_rate output sample rate
3086 * @param input_rate input sample rate
3087 * @param sample_fmt_out requested output sample format
3088 * @param sample_fmt_in input sample format
3089 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3090 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3091 * @param linear if 1 then the used FIR filter will be linearly interpolated
3092 between the 2 closest, if 0 the closest will be used
3093 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3094 * @return allocated ReSampleContext, NULL if error occurred
3096 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3097 int output_rate, int input_rate,
3098 enum AVSampleFormat sample_fmt_out,
3099 enum AVSampleFormat sample_fmt_in,
3100 int filter_length, int log2_phase_count,
3101 int linear, double cutoff);
3103 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3106 * Free resample context.
3108 * @param s a non-NULL pointer to a resample context previously
3109 * created with av_audio_resample_init()
3111 void audio_resample_close(ReSampleContext *s);
3115 * Initialize an audio resampler.
3116 * Note, if either rate is not an integer then simply scale both rates up so they are.
3117 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3118 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3119 * @param linear If 1 then the used FIR filter will be linearly interpolated
3120 between the 2 closest, if 0 the closest will be used
3121 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3123 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3126 * Resample an array of samples using a previously configured context.
3127 * @param src an array of unconsumed samples
3128 * @param consumed the number of samples of src which have been consumed are returned here
3129 * @param src_size the number of unconsumed samples available
3130 * @param dst_size the amount of space in samples available in dst
3131 * @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.
3132 * @return the number of samples written in dst or -1 if an error occurred
3134 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3138 * Compensate samplerate/timestamp drift. The compensation is done by changing
3139 * the resampler parameters, so no audible clicks or similar distortions occur
3140 * @param compensation_distance distance in output samples over which the compensation should be performed
3141 * @param sample_delta number of output samples which should be output less
3143 * example: av_resample_compensate(c, 10, 500)
3144 * here instead of 510 samples only 500 samples would be output
3146 * note, due to rounding the actual compensation might be slightly different,
3147 * especially if the compensation_distance is large and the in_rate used during init is small
3149 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3150 void av_resample_close(struct AVResampleContext *c);
3153 * Allocate memory for a picture. Call avpicture_free() to free it.
3155 * @see avpicture_fill()
3157 * @param picture the picture to be filled in
3158 * @param pix_fmt the format of the picture
3159 * @param width the width of the picture
3160 * @param height the height of the picture
3161 * @return zero if successful, a negative value if not
3163 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3166 * Free a picture previously allocated by avpicture_alloc().
3167 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3170 * @param picture the AVPicture to be freed
3172 void avpicture_free(AVPicture *picture);
3175 * Fill in the AVPicture fields.
3176 * The fields of the given AVPicture are filled in by using the 'ptr' address
3177 * which points to the image data buffer. Depending on the specified picture
3178 * format, one or multiple image data pointers and line sizes will be set.
3179 * If a planar format is specified, several pointers will be set pointing to
3180 * the different picture planes and the line sizes of the different planes
3181 * will be stored in the lines_sizes array.
3182 * Call with ptr == NULL to get the required size for the ptr buffer.
3184 * To allocate the buffer and fill in the AVPicture fields in one call,
3185 * use avpicture_alloc().
3187 * @param picture AVPicture whose fields are to be filled in
3188 * @param ptr Buffer which will contain or contains the actual image data
3189 * @param pix_fmt The format in which the picture data is stored.
3190 * @param width the width of the image in pixels
3191 * @param height the height of the image in pixels
3192 * @return size of the image data in bytes
3194 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3195 enum PixelFormat pix_fmt, int width, int height);
3198 * Copy pixel data from an AVPicture into a buffer.
3199 * The data is stored compactly, without any gaps for alignment or padding
3200 * which may be applied by avpicture_fill().
3202 * @see avpicture_get_size()
3204 * @param[in] src AVPicture containing image data
3205 * @param[in] pix_fmt The format in which the picture data is stored.
3206 * @param[in] width the width of the image in pixels.
3207 * @param[in] height the height of the image in pixels.
3208 * @param[out] dest A buffer into which picture data will be copied.
3209 * @param[in] dest_size The size of 'dest'.
3210 * @return The number of bytes written to dest, or a negative value (error code) on error.
3212 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3213 unsigned char *dest, int dest_size);
3216 * Calculate the size in bytes that a picture of the given width and height
3217 * would occupy if stored in the given picture format.
3218 * Note that this returns the size of a compact representation as generated
3219 * by avpicture_layout(), which can be smaller than the size required for e.g.
3222 * @param pix_fmt the given picture format
3223 * @param width the width of the image
3224 * @param height the height of the image
3225 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3227 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3228 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3230 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3233 * Return a value representing the fourCC code associated to the
3234 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3237 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3240 * Put a string representing the codec tag codec_tag in buf.
3242 * @param buf_size size in bytes of buf
3243 * @return the length of the string that would have been generated if
3244 * enough space had been available, excluding the trailing null
3246 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3248 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3249 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3250 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3251 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3252 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3253 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3256 * Compute what kind of losses will occur when converting from one specific
3257 * pixel format to another.
3258 * When converting from one pixel format to another, information loss may occur.
3259 * For example, when converting from RGB24 to GRAY, the color information will
3260 * be lost. Similarly, other losses occur when converting from some formats to
3261 * other formats. These losses can involve loss of chroma, but also loss of
3262 * resolution, loss of color depth, loss due to the color space conversion, loss
3263 * of the alpha bits or loss due to color quantization.
3264 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3265 * which will occur when converting from one pixel format to another.
3267 * @param[in] dst_pix_fmt destination pixel format
3268 * @param[in] src_pix_fmt source pixel format
3269 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3270 * @return Combination of flags informing you what kind of losses will occur.
3272 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3276 * Find the best pixel format to convert to given a certain source pixel
3277 * format. When converting from one pixel format to another, information loss
3278 * may occur. For example, when converting from RGB24 to GRAY, the color
3279 * information will be lost. Similarly, other losses occur when converting from
3280 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3281 * the given pixel formats should be used to suffer the least amount of loss.
3282 * The pixel formats from which it chooses one, are determined by the
3283 * pix_fmt_mask parameter.
3286 * src_pix_fmt = PIX_FMT_YUV420P;
3287 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3288 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3291 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3292 * @param[in] src_pix_fmt source pixel format
3293 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3294 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3295 * @return The best pixel format to convert to or -1 if none was found.
3297 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3298 int has_alpha, int *loss_ptr);
3300 /* deinterlace a picture */
3301 /* deinterlace - if not supported return -1 */
3302 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3303 enum PixelFormat pix_fmt, int width, int height);
3305 /* external high level API */
3308 * If c is NULL, returns the first registered codec,
3309 * if c is non-NULL, returns the next registered codec after c,
3310 * or NULL if c is the last one.
3312 AVCodec *av_codec_next(AVCodec *c);
3315 * Return the LIBAVCODEC_VERSION_INT constant.
3317 unsigned avcodec_version(void);
3320 * Return the libavcodec build-time configuration.
3322 const char *avcodec_configuration(void);
3325 * Return the libavcodec license.
3327 const char *avcodec_license(void);
3330 * Register the codec codec and initialize libavcodec.
3332 * @warning either this function or avcodec_register_all() must be called
3333 * before any other libavcodec functions.
3335 * @see avcodec_register_all()
3337 void avcodec_register(AVCodec *codec);
3340 * Find a registered encoder with a matching codec ID.
3342 * @param id CodecID of the requested encoder
3343 * @return An encoder if one was found, NULL otherwise.
3345 AVCodec *avcodec_find_encoder(enum CodecID id);
3348 * Find a registered encoder with the specified name.
3350 * @param name name of the requested encoder
3351 * @return An encoder if one was found, NULL otherwise.
3353 AVCodec *avcodec_find_encoder_by_name(const char *name);
3356 * Find a registered decoder with a matching codec ID.
3358 * @param id CodecID of the requested decoder
3359 * @return A decoder if one was found, NULL otherwise.
3361 AVCodec *avcodec_find_decoder(enum CodecID id);
3364 * Find a registered decoder with the specified name.
3366 * @param name name of the requested decoder
3367 * @return A decoder if one was found, NULL otherwise.
3369 AVCodec *avcodec_find_decoder_by_name(const char *name);
3370 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3373 * Return a name for the specified profile, if available.
3375 * @param codec the codec that is searched for the given profile
3376 * @param profile the profile value for which a name is requested
3377 * @return A name for the profile if found, NULL otherwise.
3379 const char *av_get_profile_name(const AVCodec *codec, int profile);
3382 * Set the fields of the given AVCodecContext to default values corresponding
3383 * to the given codec (defaults may be codec-dependent).
3385 * Do not call this function if a non-NULL codec has been passed
3386 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3387 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3388 * different codec on this AVCodecContext.
3390 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3393 * Allocate an AVCodecContext and set its fields to default values. The
3394 * resulting struct can be deallocated by calling avcodec_close() on it followed
3397 * @param codec if non-NULL, allocate private data and initialize defaults
3398 * for the given codec. It is illegal to then call avcodec_open2()
3399 * with a different codec.
3400 * If NULL, then the codec-specific defaults won't be initialized,
3401 * which may result in suboptimal default settings (this is
3402 * important mainly for encoders, e.g. libx264).
3404 * @return An AVCodecContext filled with default values or NULL on failure.
3405 * @see avcodec_get_context_defaults
3407 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3410 * Copy the settings of the source AVCodecContext into the destination
3411 * AVCodecContext. The resulting destination codec context will be
3412 * unopened, i.e. you are required to call avcodec_open2() before you
3413 * can use this AVCodecContext to decode/encode video/audio data.
3415 * @param dest target codec context, should be initialized with
3416 * avcodec_alloc_context3(), but otherwise uninitialized
3417 * @param src source codec context
3418 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3420 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3423 * Set the fields of the given AVFrame to default values.
3425 * @param pic The AVFrame of which the fields should be set to default values.
3427 void avcodec_get_frame_defaults(AVFrame *pic);
3430 * Allocate an AVFrame and set its fields to default values. The resulting
3431 * struct can be deallocated by simply calling av_free().
3433 * @return An AVFrame filled with default values or NULL on failure.
3434 * @see avcodec_get_frame_defaults
3436 AVFrame *avcodec_alloc_frame(void);
3438 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3439 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3440 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3443 * Return the amount of padding in pixels which the get_buffer callback must
3444 * provide around the edge of the image for codecs which do not have the
3445 * CODEC_FLAG_EMU_EDGE flag.
3447 * @return Required padding in pixels.
3449 unsigned avcodec_get_edge_width(void);
3451 * Modify width and height values so that they will result in a memory
3452 * buffer that is acceptable for the codec if you do not use any horizontal
3455 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3456 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3457 * according to avcodec_get_edge_width() before.
3459 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3461 * Modify width and height values so that they will result in a memory
3462 * buffer that is acceptable for the codec if you also ensure that all
3463 * line sizes are a multiple of the respective linesize_align[i].
3465 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3466 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3467 * according to avcodec_get_edge_width() before.
3469 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3470 int linesize_align[AV_NUM_DATA_POINTERS]);
3472 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3474 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3475 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3476 //FIXME func typedef
3479 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3480 * function the context has to be allocated with avcodec_alloc_context3().
3482 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3483 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3484 * retrieving a codec.
3486 * @warning This function is not thread safe!
3489 * avcodec_register_all();
3490 * av_dict_set(&opts, "b", "2.5M", 0);
3491 * codec = avcodec_find_decoder(CODEC_ID_H264);
3495 * context = avcodec_alloc_context3(codec);
3497 * if (avcodec_open2(context, codec, opts) < 0)
3501 * @param avctx The context to initialize.
3502 * @param codec The codec to open this context for. If a non-NULL codec has been
3503 * previously passed to avcodec_alloc_context3() or
3504 * avcodec_get_context_defaults3() for this context, then this
3505 * parameter MUST be either NULL or equal to the previously passed
3507 * @param options A dictionary filled with AVCodecContext and codec-private options.
3508 * On return this object will be filled with options that were not found.
3510 * @return zero on success, a negative value on error
3511 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3512 * av_dict_set(), av_opt_find().
3514 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3516 #if FF_API_OLD_DECODE_AUDIO
3518 * Wrapper function which calls avcodec_decode_audio4.
3520 * @deprecated Use avcodec_decode_audio4 instead.
3522 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3523 * Some decoders may support multiple frames in a single AVPacket, such
3524 * decoders would then just decode the first frame. In this case,
3525 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3526 * the remaining data in order to decode the second frame etc.
3528 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3529 * decompressed frame size in bytes.
3531 * @warning You must set frame_size_ptr to the allocated size of the
3532 * output buffer before calling avcodec_decode_audio3().
3534 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3535 * the actual read bytes because some optimized bitstream readers read 32 or 64
3536 * bits at once and could read over the end.
3538 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3539 * no overreading happens for damaged MPEG streams.
3541 * @warning You must not provide a custom get_buffer() when using
3542 * avcodec_decode_audio3(). Doing so will override it with
3543 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3544 * which does allow the application to provide a custom get_buffer().
3546 * @note You might have to align the input buffer avpkt->data and output buffer
3547 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3548 * necessary at all, on others it won't work at all if not aligned and on others
3549 * it will work but it will have an impact on performance.
3551 * In practice, avpkt->data should have 4 byte alignment at minimum and
3552 * samples should be 16 byte aligned unless the CPU doesn't need it
3553 * (AltiVec and SSE do).
3555 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3556 * between input and output, these need to be fed with avpkt->data=NULL,
3557 * avpkt->size=0 at the end to return the remaining frames.
3559 * @param avctx the codec context
3560 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3561 * If the sample format is planar, each channel plane will
3562 * be the same size, with no padding between channels.
3563 * @param[in,out] frame_size_ptr the output buffer size in bytes
3564 * @param[in] avpkt The input AVPacket containing the input buffer.
3565 * You can create such packet with av_init_packet() and by then setting
3566 * data and size, some decoders might in addition need other fields.
3567 * All decoders are designed to use the least fields possible though.
3568 * @return On error a negative value is returned, otherwise the number of bytes
3569 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3571 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3572 int *frame_size_ptr,
3577 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3579 * Some decoders may support multiple frames in a single AVPacket. Such
3580 * decoders would then just decode the first frame. In this case,
3581 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3582 * the remaining data in order to decode the second frame, etc...
3583 * Even if no frames are returned, the packet needs to be fed to the decoder
3584 * with remaining data until it is completely consumed or an error occurs.
3586 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3587 * larger than the actual read bytes because some optimized bitstream
3588 * readers read 32 or 64 bits at once and could read over the end.
3590 * @note You might have to align the input buffer. The alignment requirements
3591 * depend on the CPU and the decoder.
3593 * @param avctx the codec context
3594 * @param[out] frame The AVFrame in which to store decoded audio samples.
3595 * Decoders request a buffer of a particular size by setting
3596 * AVFrame.nb_samples prior to calling get_buffer(). The
3597 * decoder may, however, only utilize part of the buffer by
3598 * setting AVFrame.nb_samples to a smaller value in the
3600 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3602 * @param[in] avpkt The input AVPacket containing the input buffer.
3603 * At least avpkt->data and avpkt->size should be set. Some
3604 * decoders might also require additional fields to be set.
3605 * @return A negative error code is returned if an error occurred during
3606 * decoding, otherwise the number of bytes consumed from the input
3607 * AVPacket is returned.
3609 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3610 int *got_frame_ptr, AVPacket *avpkt);
3613 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3614 * Some decoders may support multiple frames in a single AVPacket, such
3615 * decoders would then just decode the first frame.
3617 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3618 * the actual read bytes because some optimized bitstream readers read 32 or 64
3619 * bits at once and could read over the end.
3621 * @warning The end of the input buffer buf should be set to 0 to ensure that
3622 * no overreading happens for damaged MPEG streams.
3624 * @note You might have to align the input buffer avpkt->data.
3625 * The alignment requirements depend on the CPU: on some CPUs it isn't
3626 * necessary at all, on others it won't work at all if not aligned and on others
3627 * it will work but it will have an impact on performance.
3629 * In practice, avpkt->data should have 4 byte alignment at minimum.
3631 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3632 * between input and output, these need to be fed with avpkt->data=NULL,
3633 * avpkt->size=0 at the end to return the remaining frames.
3635 * @param avctx the codec context
3636 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3637 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3638 * allocate memory for the actual bitmap.
3639 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3640 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3641 * decodes and the decoder tells the user once it does not need the data anymore,
3642 * the user app can at this point free/reuse/keep the memory as it sees fit.
3644 * @param[in] avpkt The input AVpacket containing the input buffer.
3645 * You can create such packet with av_init_packet() and by then setting
3646 * data and size, some decoders might in addition need other fields like
3647 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3649 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3650 * @return On error a negative value is returned, otherwise the number of bytes
3651 * used or zero if no frame could be decompressed.
3653 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3654 int *got_picture_ptr,
3658 * Decode a subtitle message.
3659 * Return a negative value on error, otherwise return the number of bytes used.
3660 * If no subtitle could be decompressed, got_sub_ptr is zero.
3661 * Otherwise, the subtitle is stored in *sub.
3662 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3663 * simplicity, because the performance difference is expect to be negligible
3664 * and reusing a get_buffer written for video codecs would probably perform badly
3665 * due to a potentially very different allocation pattern.
3667 * @param avctx the codec context
3668 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3669 freed with avsubtitle_free if *got_sub_ptr is set.
3670 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3671 * @param[in] avpkt The input AVPacket containing the input buffer.
3673 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3678 * Free all allocated data in the given subtitle struct.
3680 * @param sub AVSubtitle to free.
3682 void avsubtitle_free(AVSubtitle *sub);
3684 #if FF_API_OLD_ENCODE_AUDIO
3686 * Encode an audio frame from samples into buf.
3688 * @deprecated Use avcodec_encode_audio2 instead.
3690 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3691 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3692 * will know how much space is needed because it depends on the value passed
3693 * in buf_size as described below. In that case a lower value can be used.
3695 * @param avctx the codec context
3696 * @param[out] buf the output buffer
3697 * @param[in] buf_size the output buffer size
3698 * @param[in] samples the input buffer containing the samples
3699 * The number of samples read from this buffer is frame_size*channels,
3700 * both of which are defined in avctx.
3701 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3702 * samples read from samples is equal to:
3703 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3704 * This also implies that av_get_bits_per_sample() must not return 0 for these
3706 * @return On error a negative value is returned, on success zero or the number
3707 * of bytes used to encode the data read from the input buffer.
3709 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3710 uint8_t *buf, int buf_size,
3711 const short *samples);
3715 * Encode a frame of audio.
3717 * Takes input samples from frame and writes the next output packet, if
3718 * available, to avpkt. The output packet does not necessarily contain data for
3719 * the most recent frame, as encoders can delay, split, and combine input frames
3720 * internally as needed.
3722 * @param avctx codec context
3723 * @param avpkt output AVPacket.
3724 * The user can supply an output buffer by setting
3725 * avpkt->data and avpkt->size prior to calling the
3726 * function, but if the size of the user-provided data is not
3727 * large enough, encoding will fail. All other AVPacket fields
3728 * will be reset by the encoder using av_init_packet(). If
3729 * avpkt->data is NULL, the encoder will allocate it.
3730 * The encoder will set avpkt->size to the size of the
3732 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3733 * May be NULL when flushing an encoder that has the
3734 * CODEC_CAP_DELAY capability set.
3735 * There are 2 codec capabilities that affect the allowed
3736 * values of frame->nb_samples.
3737 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
3738 * frame may be smaller than avctx->frame_size, and all other
3739 * frames must be equal to avctx->frame_size.
3740 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3741 * can have any number of samples.
3742 * If neither is set, frame->nb_samples must be equal to
3743 * avctx->frame_size for all frames.
3744 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3745 * output packet is non-empty, and to 0 if it is
3746 * empty. If the function returns an error, the
3747 * packet can be assumed to be invalid, and the
3748 * value of got_packet_ptr is undefined and should
3750 * @return 0 on success, negative error code on failure
3752 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3753 const AVFrame *frame, int *got_packet_ptr);
3756 * Fill audio frame data and linesize.
3757 * AVFrame extended_data channel pointers are allocated if necessary for
3760 * @param frame the AVFrame
3761 * frame->nb_samples must be set prior to calling the
3762 * function. This function fills in frame->data,
3763 * frame->extended_data, frame->linesize[0].
3764 * @param nb_channels channel count
3765 * @param sample_fmt sample format
3766 * @param buf buffer to use for frame data
3767 * @param buf_size size of buffer
3768 * @param align plane size sample alignment
3769 * @return 0 on success, negative error code on failure
3771 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
3772 enum AVSampleFormat sample_fmt, const uint8_t *buf,
3773 int buf_size, int align);
3776 * Encode a video frame from pict into buf.
3777 * The input picture should be
3778 * stored using a specific format, namely avctx.pix_fmt.
3780 * @param avctx the codec context
3781 * @param[out] buf the output buffer for the bitstream of encoded frame
3782 * @param[in] buf_size the size of the output buffer in bytes
3783 * @param[in] pict the input picture to encode
3784 * @return On error a negative value is returned, on success zero or the number
3785 * of bytes used from the output buffer.
3787 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3788 const AVFrame *pict);
3789 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3790 const AVSubtitle *sub);
3793 * Close a given AVCodecContext and free all the data associated with it
3794 * (but not the AVCodecContext itself).
3796 * Calling this function on an AVCodecContext that hasn't been opened will free
3797 * the codec-specific data allocated in avcodec_alloc_context3() /
3798 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3801 int avcodec_close(AVCodecContext *avctx);
3804 * Register all the codecs, parsers and bitstream filters which were enabled at
3805 * configuration time. If you do not call this function you can select exactly
3806 * which formats you want to support, by using the individual registration
3809 * @see avcodec_register
3810 * @see av_register_codec_parser
3811 * @see av_register_bitstream_filter
3813 void avcodec_register_all(void);
3816 * Flush buffers, should be called when seeking or when switching to a different stream.
3818 void avcodec_flush_buffers(AVCodecContext *avctx);
3820 void avcodec_default_free_buffers(AVCodecContext *s);
3822 /* misc useful functions */
3825 * Return codec bits per sample.
3827 * @param[in] codec_id the codec
3828 * @return Number of bits per sample or zero if unknown for the given codec.
3830 int av_get_bits_per_sample(enum CodecID codec_id);
3833 typedef struct AVCodecParserContext {
3835 struct AVCodecParser *parser;
3836 int64_t frame_offset; /* offset of the current frame */
3837 int64_t cur_offset; /* current offset
3838 (incremented by each av_parser_parse()) */
3839 int64_t next_frame_offset; /* offset of the next frame */
3841 int pict_type; /* XXX: Put it back in AVCodecContext. */
3843 * This field is used for proper frame duration computation in lavf.
3844 * It signals, how much longer the frame duration of the current frame
3845 * is compared to normal frame duration.
3847 * frame_duration = (1 + repeat_pict) * time_base
3849 * It is used by codecs like H.264 to display telecined material.
3851 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3852 int64_t pts; /* pts of the current frame */
3853 int64_t dts; /* dts of the current frame */
3858 int fetch_timestamp;
3860 #define AV_PARSER_PTS_NB 4
3861 int cur_frame_start_index;
3862 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3863 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3864 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3867 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3868 #define PARSER_FLAG_ONCE 0x0002
3869 /// Set if the parser has a valid file offset
3870 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3872 int64_t offset; ///< byte offset from starting packet start
3873 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3876 * Set by parser to 1 for key frames and 0 for non-key frames.
3877 * It is initialized to -1, so if the parser doesn't set this flag,
3878 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3884 * Time difference in stream time base units from the pts of this
3885 * packet to the point at which the output from the decoder has converged
3886 * independent from the availability of previous frames. That is, the
3887 * frames are virtually identical no matter if decoding started from
3888 * the very first frame or from this keyframe.
3889 * Is AV_NOPTS_VALUE if unknown.
3890 * This field is not the display duration of the current frame.
3891 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3894 * The purpose of this field is to allow seeking in streams that have no
3895 * keyframes in the conventional sense. It corresponds to the
3896 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3897 * essential for some types of subtitle streams to ensure that all
3898 * subtitles are correctly displayed after seeking.
3900 int64_t convergence_duration;
3902 // Timestamp generation support:
3904 * Synchronization point for start of timestamp generation.
3906 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3909 * For example, this corresponds to presence of H.264 buffering period
3915 * Offset of the current timestamp against last timestamp sync point in
3916 * units of AVCodecContext.time_base.
3918 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3919 * contain a valid timestamp offset.
3921 * Note that the timestamp of sync point has usually a nonzero
3922 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3923 * the next frame after timestamp sync point will be usually 1.
3925 * For example, this corresponds to H.264 cpb_removal_delay.
3927 int dts_ref_dts_delta;
3930 * Presentation delay of current frame in units of AVCodecContext.time_base.
3932 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3933 * contain valid non-negative timestamp delta (presentation time of a frame
3934 * must not lie in the past).
3936 * This delay represents the difference between decoding and presentation
3937 * time of the frame.
3939 * For example, this corresponds to H.264 dpb_output_delay.
3944 * Position of the packet in file.
3946 * Analogous to cur_frame_pts/dts
3948 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3951 * Byte position of currently parsed frame in stream.
3956 * Previous frame byte position.
3959 } AVCodecParserContext;
3961 typedef struct AVCodecParser {
3962 int codec_ids[5]; /* several codec IDs are permitted */
3964 int (*parser_init)(AVCodecParserContext *s);
3965 int (*parser_parse)(AVCodecParserContext *s,
3966 AVCodecContext *avctx,
3967 const uint8_t **poutbuf, int *poutbuf_size,
3968 const uint8_t *buf, int buf_size);
3969 void (*parser_close)(AVCodecParserContext *s);
3970 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3971 struct AVCodecParser *next;
3974 AVCodecParser *av_parser_next(AVCodecParser *c);
3976 void av_register_codec_parser(AVCodecParser *parser);
3977 AVCodecParserContext *av_parser_init(int codec_id);
3982 * @param s parser context.
3983 * @param avctx codec context.
3984 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3985 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3986 * @param buf input buffer.
3987 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3988 * @param pts input presentation timestamp.
3989 * @param dts input decoding timestamp.
3990 * @param pos input byte position in stream.
3991 * @return the number of bytes of the input bitstream used.
3996 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4003 * decode_frame(data, size);
4007 int av_parser_parse2(AVCodecParserContext *s,
4008 AVCodecContext *avctx,
4009 uint8_t **poutbuf, int *poutbuf_size,
4010 const uint8_t *buf, int buf_size,
4011 int64_t pts, int64_t dts,
4014 int av_parser_change(AVCodecParserContext *s,
4015 AVCodecContext *avctx,
4016 uint8_t **poutbuf, int *poutbuf_size,
4017 const uint8_t *buf, int buf_size, int keyframe);
4018 void av_parser_close(AVCodecParserContext *s);
4021 typedef struct AVBitStreamFilterContext {
4023 struct AVBitStreamFilter *filter;
4024 AVCodecParserContext *parser;
4025 struct AVBitStreamFilterContext *next;
4026 } AVBitStreamFilterContext;
4029 typedef struct AVBitStreamFilter {
4032 int (*filter)(AVBitStreamFilterContext *bsfc,
4033 AVCodecContext *avctx, const char *args,
4034 uint8_t **poutbuf, int *poutbuf_size,
4035 const uint8_t *buf, int buf_size, int keyframe);
4036 void (*close)(AVBitStreamFilterContext *bsfc);
4037 struct AVBitStreamFilter *next;
4038 } AVBitStreamFilter;
4040 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4041 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4042 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4043 AVCodecContext *avctx, const char *args,
4044 uint8_t **poutbuf, int *poutbuf_size,
4045 const uint8_t *buf, int buf_size, int keyframe);
4046 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4048 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4053 * Reallocate the given block if it is not large enough, otherwise do nothing.
4057 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4060 * Allocate a buffer, reusing the given one if large enough.
4062 * Contrary to av_fast_realloc the current buffer contents might not be
4063 * preserved and on error the old buffer is freed, thus no special
4064 * handling to avoid memleaks is necessary.
4066 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4067 * @param size size of the buffer *ptr points to
4068 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4069 * *size 0 if an error occurred.
4071 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4074 * Allocate a buffer with padding, reusing the given one if large enough.
4076 * Same behaviour av_fast_malloc but the buffer has additional
4077 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4080 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4083 * Copy image src to dst. Wraps av_picture_data_copy() above.
4085 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4086 enum PixelFormat pix_fmt, int width, int height);
4089 * Crop image top and left side.
4091 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4092 enum PixelFormat pix_fmt, int top_band, int left_band);
4097 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4098 int padtop, int padbottom, int padleft, int padright, int *color);
4101 * Encode extradata length to a buffer. Used by xiph codecs.
4103 * @param s buffer to write to; must be at least (v/255+1) bytes long
4104 * @param v size of extradata in bytes
4105 * @return number of bytes written to the buffer.
4107 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4110 * Log a generic warning message about a missing feature. This function is
4111 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4112 * only, and would normally not be used by applications.
4113 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4114 * a pointer to an AVClass struct
4115 * @param[in] feature string containing the name of the missing feature
4116 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4117 * If want_sample is non-zero, additional verbage will be added to the log
4118 * message which tells the user how to report samples to the development
4121 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4124 * Log a generic warning message asking for a sample. This function is
4125 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4126 * only, and would normally not be used by applications.
4127 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4128 * a pointer to an AVClass struct
4129 * @param[in] msg string containing an optional message, or NULL if no message
4131 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4134 * Register the hardware accelerator hwaccel.
4136 void av_register_hwaccel(AVHWAccel *hwaccel);
4139 * If hwaccel is NULL, returns the first registered hardware accelerator,
4140 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4141 * after hwaccel, or NULL if hwaccel is the last one.
4143 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4147 * Lock operation used by lockmgr
4150 AV_LOCK_CREATE, ///< Create a mutex
4151 AV_LOCK_OBTAIN, ///< Lock the mutex
4152 AV_LOCK_RELEASE, ///< Unlock the mutex
4153 AV_LOCK_DESTROY, ///< Free mutex resources
4157 * Register a user provided lock manager supporting the operations
4158 * specified by AVLockOp. mutex points to a (void *) where the
4159 * lockmgr should store/get a pointer to a user allocated mutex. It's
4160 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4162 * @param cb User defined callback. Note: Libav may invoke calls to this
4163 * callback during the call to av_lockmgr_register().
4164 * Thus, the application must be prepared to handle that.
4165 * If cb is set to NULL the lockmgr will be unregistered.
4166 * Also note that during unregistration the previously registered
4167 * lockmgr callback may also be invoked.
4169 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4172 * Get the type of the given codec.
4174 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4177 * Get the AVClass for AVCodecContext. It can be used in combination with
4178 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4180 * @see av_opt_find().
4182 const AVClass *avcodec_get_class(void);
4185 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4186 * with no corresponding avcodec_close()), 0 otherwise.
4188 int avcodec_is_open(AVCodecContext *s);
4190 #endif /* AVCODEC_AVCODEC_H */