2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * Libav is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
40 * @defgroup libavc Encoding/Decoding Library
43 * @defgroup lavc_decoding Decoding
47 * @defgroup lavc_encoding Encoding
51 * @defgroup lavc_codec Codecs
53 * @defgroup lavc_codec_native Native Codecs
56 * @defgroup lavc_codec_wrappers External library wrappers
59 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
63 * @defgroup lavc_internal Internal
72 * Identify the syntax and semantics of the bitstream.
73 * The principle is roughly:
74 * Two decoders with the same ID can decode the same streams.
75 * Two encoders with the same ID can encode compatible streams.
76 * There may be slight deviations from the principle due to implementation
79 * If you add a codec ID to this list, add it so that
80 * 1. no value of a existing codec ID changes (that would break ABI),
81 * 2. it is as close as possible to similar codecs.
88 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
89 CODEC_ID_MPEG2VIDEO_XVMC,
126 CODEC_ID_INTERPLAY_VIDEO,
138 CODEC_ID_TRUEMOTION1,
165 CODEC_ID_TRUEMOTION2,
182 CODEC_ID_DSICINVIDEO,
183 CODEC_ID_TIERTEXSEQVIDEO,
191 CODEC_ID_BETHSOFTVID,
207 CODEC_ID_MOTIONPIXELS,
225 CODEC_ID_IFF_BYTERUN1,
249 /* various PCM "codecs" */
250 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
251 CODEC_ID_PCM_S16LE = 0x10000,
267 CODEC_ID_PCM_S24DAUD,
269 CODEC_ID_PCM_S16LE_PLANAR,
278 CODEC_ID_PCM_S8_PLANAR,
280 /* various ADPCM codecs */
281 CODEC_ID_ADPCM_IMA_QT = 0x11000,
282 CODEC_ID_ADPCM_IMA_WAV,
283 CODEC_ID_ADPCM_IMA_DK3,
284 CODEC_ID_ADPCM_IMA_DK4,
285 CODEC_ID_ADPCM_IMA_WS,
286 CODEC_ID_ADPCM_IMA_SMJPEG,
295 CODEC_ID_ADPCM_YAMAHA,
296 CODEC_ID_ADPCM_SBPRO_4,
297 CODEC_ID_ADPCM_SBPRO_3,
298 CODEC_ID_ADPCM_SBPRO_2,
300 CODEC_ID_ADPCM_IMA_AMV,
301 CODEC_ID_ADPCM_EA_R1,
302 CODEC_ID_ADPCM_EA_R3,
303 CODEC_ID_ADPCM_EA_R2,
304 CODEC_ID_ADPCM_IMA_EA_SEAD,
305 CODEC_ID_ADPCM_IMA_EA_EACS,
306 CODEC_ID_ADPCM_EA_XAS,
307 CODEC_ID_ADPCM_EA_MAXIS_XA,
308 CODEC_ID_ADPCM_IMA_ISS,
310 CODEC_ID_ADPCM_IMA_APC,
313 CODEC_ID_AMR_NB = 0x12000,
316 /* RealAudio codecs*/
317 CODEC_ID_RA_144 = 0x13000,
320 /* various DPCM codecs */
321 CODEC_ID_ROQ_DPCM = 0x14000,
322 CODEC_ID_INTERPLAY_DPCM,
327 CODEC_ID_MP2 = 0x15000,
328 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
344 CODEC_ID_WESTWOOD_SND1,
345 CODEC_ID_GSM, ///< as in Berlin toast format
353 CODEC_ID_DSICINAUDIO,
357 CODEC_ID_GSM_MS, /* as found in WAV */
366 CODEC_ID_WMALOSSLESS,
375 CODEC_ID_BINKAUDIO_RDFT,
376 CODEC_ID_BINKAUDIO_DCT,
386 /* subtitle codecs */
387 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
388 CODEC_ID_DVD_SUBTITLE = 0x17000,
389 CODEC_ID_DVB_SUBTITLE,
390 CODEC_ID_TEXT, ///< raw UTF-8 text
394 CODEC_ID_HDMV_PGS_SUBTITLE,
395 CODEC_ID_DVB_TELETEXT,
398 /* other specific kind of codecs (generally used for attachments) */
399 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
400 CODEC_ID_TTF = 0x18000,
402 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
404 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
405 * stream (only used by libavformat) */
406 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
407 * stream (only used by libavformat) */
408 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
411 #if FF_API_OLD_DECODE_AUDIO
413 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
417 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
418 * This is mainly needed because some optimized bitstream readers read
419 * 32 or 64 bit at once and could read over the end.<br>
420 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
421 * MPEG bitstreams could cause overread and segfault.
423 #define FF_INPUT_BUFFER_PADDING_SIZE 8
426 * minimum encoding buffer size
427 * Used to avoid some checks during header writing.
429 #define FF_MIN_BUFFER_SIZE 16384
433 * motion estimation type.
436 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
440 ME_EPZS, ///< enhanced predictive zonal search
441 ME_X1, ///< reserved for experiments
442 ME_HEX, ///< hexagon based search
443 ME_UMH, ///< uneven multi-hexagon search
444 ME_ITER, ///< iterative search
445 ME_TESA, ///< transformed exhaustive search algorithm
449 /* We leave some space between them for extensions (drop some
450 * keyframes for intra-only or drop just some bidir frames). */
451 AVDISCARD_NONE =-16, ///< discard nothing
452 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
453 AVDISCARD_NONREF = 8, ///< discard all non reference
454 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
455 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
456 AVDISCARD_ALL = 48, ///< discard all
459 enum AVColorPrimaries{
460 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
461 AVCOL_PRI_UNSPECIFIED=2,
463 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
464 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
465 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
467 AVCOL_PRI_NB , ///< Not part of ABI
470 enum AVColorTransferCharacteristic{
471 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
472 AVCOL_TRC_UNSPECIFIED=2,
473 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
474 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
475 AVCOL_TRC_NB , ///< Not part of ABI
480 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
481 AVCOL_SPC_UNSPECIFIED=2,
483 AVCOL_SPC_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
484 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
485 AVCOL_SPC_SMPTE240M =7,
486 AVCOL_SPC_NB , ///< Not part of ABI
490 AVCOL_RANGE_UNSPECIFIED=0,
491 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
492 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
493 AVCOL_RANGE_NB , ///< Not part of ABI
497 * X X 3 4 X X are luma samples,
498 * 1 2 1-6 are possible chroma positions
499 * X X 5 6 X 0 is undefined/unknown position
501 enum AVChromaLocation{
502 AVCHROMA_LOC_UNSPECIFIED=0,
503 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
504 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
505 AVCHROMA_LOC_TOPLEFT =3, ///< DV
507 AVCHROMA_LOC_BOTTOMLEFT =5,
508 AVCHROMA_LOC_BOTTOM =6,
509 AVCHROMA_LOC_NB , ///< Not part of ABI
512 enum AVAudioServiceType {
513 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
514 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
515 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
516 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
517 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
518 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
519 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
520 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
521 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
522 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
525 typedef struct RcOverride{
528 int qscale; // If this is 0 then quality_factor will be used instead.
529 float quality_factor;
532 #define FF_MAX_B_FRAMES 16
535 These flags can be passed in AVCodecContext.flags before initialization.
536 Note: Not everything is supported yet.
539 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
540 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
541 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
542 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
543 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
545 * The parent program guarantees that the input for B-frames containing
546 * streams is not written to for at least s->max_b_frames+1 frames, if
547 * this is not set the input will be copied.
549 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
550 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
551 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
552 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
553 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
554 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
555 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
556 location instead of only at frame boundaries. */
557 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
558 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
559 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
560 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
561 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
562 /* Fx : Flag for h263+ extra options */
563 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
564 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
565 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
566 #define CODEC_FLAG_CLOSED_GOP 0x80000000
567 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
568 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
569 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
570 #if FF_API_MPV_GLOBAL_OPTS
571 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
572 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
573 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
574 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
576 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
578 /* Unsupported options :
579 * Syntax Arithmetic coding (SAC)
580 * Reference Picture Selection
581 * Independent Segment Decoding */
583 /* codec capabilities */
585 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
587 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
588 * If not set, it might not use get_buffer() at all or use operations that
589 * assume the buffer was allocated by avcodec_default_get_buffer.
591 #define CODEC_CAP_DR1 0x0002
592 #define CODEC_CAP_TRUNCATED 0x0008
593 /* Codec can export data for HW decoding (XvMC). */
594 #define CODEC_CAP_HWACCEL 0x0010
596 * Encoder or decoder requires flushing with NULL input at the end in order to
597 * give the complete and correct output.
599 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
600 * with NULL data. The user can still send NULL data to the public encode
601 * or decode function, but libavcodec will not pass it along to the codec
602 * unless this flag is set.
605 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
606 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
610 * The encoder needs to be fed with NULL data at the end of encoding until the
611 * encoder no longer returns data.
613 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
614 * flag also means that the encoder must set the pts and duration for
615 * each output packet. If this flag is not set, the pts and duration will
616 * be determined by libavcodec from the input frame.
618 #define CODEC_CAP_DELAY 0x0020
620 * Codec can be fed a final frame with a smaller size.
621 * This can be used to prevent truncation of the last audio samples.
623 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
625 * Codec can export data for HW decoding (VDPAU).
627 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
629 * Codec can output multiple frames per AVPacket
630 * Normally demuxers return one frame at a time, demuxers which do not do
631 * are connected to a parser to split what they return into proper frames.
632 * This flag is reserved to the very rare category of codecs which have a
633 * bitstream that cannot be split into frames without timeconsuming
634 * operations like full decoding. Demuxers carring such bitstreams thus
635 * may return multiple frames in a packet. This has many disadvantages like
636 * prohibiting stream copy in many cases thus it should only be considered
639 #define CODEC_CAP_SUBFRAMES 0x0100
641 * Codec is experimental and is thus avoided in favor of non experimental
644 #define CODEC_CAP_EXPERIMENTAL 0x0200
646 * Codec should fill in channel configuration and samplerate instead of container
648 #define CODEC_CAP_CHANNEL_CONF 0x0400
650 * Codec is able to deal with negative linesizes
652 #define CODEC_CAP_NEG_LINESIZES 0x0800
654 * Codec supports frame-level multithreading.
656 #define CODEC_CAP_FRAME_THREADS 0x1000
658 * Codec supports slice-based (or partition-based) multithreading.
660 #define CODEC_CAP_SLICE_THREADS 0x2000
662 * Codec supports changed parameters at any point.
664 #define CODEC_CAP_PARAM_CHANGE 0x4000
666 * Codec supports avctx->thread_count == 0 (auto).
668 #define CODEC_CAP_AUTO_THREADS 0x8000
670 * Audio encoder supports receiving a different number of samples in each call.
672 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
674 //The following defines may change, don't expect compatibility if you use them.
675 #define MB_TYPE_INTRA4x4 0x0001
676 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
677 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
678 #define MB_TYPE_16x16 0x0008
679 #define MB_TYPE_16x8 0x0010
680 #define MB_TYPE_8x16 0x0020
681 #define MB_TYPE_8x8 0x0040
682 #define MB_TYPE_INTERLACED 0x0080
683 #define MB_TYPE_DIRECT2 0x0100 //FIXME
684 #define MB_TYPE_ACPRED 0x0200
685 #define MB_TYPE_GMC 0x0400
686 #define MB_TYPE_SKIP 0x0800
687 #define MB_TYPE_P0L0 0x1000
688 #define MB_TYPE_P1L0 0x2000
689 #define MB_TYPE_P0L1 0x4000
690 #define MB_TYPE_P1L1 0x8000
691 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
692 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
693 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
694 #define MB_TYPE_QUANT 0x00010000
695 #define MB_TYPE_CBP 0x00020000
696 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
700 * This specifies the area which should be displayed.
701 * Note there may be multiple such areas for one frame.
703 typedef struct AVPanScan{
706 * - encoding: Set by user.
707 * - decoding: Set by libavcodec.
712 * width and height in 1/16 pel
713 * - encoding: Set by user.
714 * - decoding: Set by libavcodec.
720 * position of the top left corner in 1/16 pel for up to 3 fields/frames
721 * - encoding: Set by user.
722 * - decoding: Set by libavcodec.
724 int16_t position[3][2];
727 #define FF_QSCALE_TYPE_MPEG1 0
728 #define FF_QSCALE_TYPE_MPEG2 1
729 #define FF_QSCALE_TYPE_H264 2
730 #define FF_QSCALE_TYPE_VP56 3
732 #define FF_BUFFER_TYPE_INTERNAL 1
733 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
734 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
735 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
737 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
738 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
739 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
740 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
742 enum AVPacketSideDataType {
744 AV_PKT_DATA_NEW_EXTRADATA,
745 AV_PKT_DATA_PARAM_CHANGE,
746 AV_PKT_DATA_H263_MB_INFO,
749 typedef struct AVPacket {
751 * Presentation timestamp in AVStream->time_base units; the time at which
752 * the decompressed packet will be presented to the user.
753 * Can be AV_NOPTS_VALUE if it is not stored in the file.
754 * pts MUST be larger or equal to dts as presentation cannot happen before
755 * decompression, unless one wants to view hex dumps. Some formats misuse
756 * the terms dts and pts/cts to mean something different. Such timestamps
757 * must be converted to true pts/dts before they are stored in AVPacket.
761 * Decompression timestamp in AVStream->time_base units; the time at which
762 * the packet is decompressed.
763 * Can be AV_NOPTS_VALUE if it is not stored in the file.
770 * A combination of AV_PKT_FLAG values
774 * Additional packet data that can be provided by the container.
775 * Packet can contain several types of side information.
780 enum AVPacketSideDataType type;
785 * Duration of this packet in AVStream->time_base units, 0 if unknown.
786 * Equals next_pts - this_pts in presentation order.
789 void (*destruct)(struct AVPacket *);
791 int64_t pos; ///< byte position in stream, -1 if unknown
794 * Time difference in AVStream->time_base units from the pts of this
795 * packet to the point at which the output from the decoder has converged
796 * independent from the availability of previous frames. That is, the
797 * frames are virtually identical no matter if decoding started from
798 * the very first frame or from this keyframe.
799 * Is AV_NOPTS_VALUE if unknown.
800 * This field is not the display duration of the current packet.
801 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
804 * The purpose of this field is to allow seeking in streams that have no
805 * keyframes in the conventional sense. It corresponds to the
806 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
807 * essential for some types of subtitle streams to ensure that all
808 * subtitles are correctly displayed after seeking.
810 int64_t convergence_duration;
812 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
813 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
816 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
818 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
819 * s32le channel_count
820 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
821 * u64le channel_layout
822 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
824 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
830 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
831 * structures with info about macroblocks relevant to splitting the
832 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
833 * That is, it does not necessarily contain info about all macroblocks,
834 * as long as the distance between macroblocks in the info is smaller
835 * than the target payload size.
836 * Each MB info structure is 12 bytes, and is laid out as follows:
837 * u32le bit offset from the start of the packet
838 * u8 current quantizer at the start of the macroblock
840 * u16le macroblock address within the GOB
841 * u8 horizontal MV predictor
842 * u8 vertical MV predictor
843 * u8 horizontal MV predictor for block number 3
844 * u8 vertical MV predictor for block number 3
847 enum AVSideDataParamChangeFlags {
848 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
849 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
850 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
851 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
856 * New fields can be added to the end of AVFRAME with minor version
857 * bumps. Removal, reordering and changes to existing fields require
858 * a major version bump.
859 * sizeof(AVFrame) must not be used outside libav*.
861 typedef struct AVFrame {
862 #define AV_NUM_DATA_POINTERS 8
864 * pointer to the picture/channel planes.
865 * This might be different from the first allocated byte
866 * - encoding: Set by user
867 * - decoding: set by AVCodecContext.get_buffer()
869 uint8_t *data[AV_NUM_DATA_POINTERS];
872 * Size, in bytes, of the data for each picture/channel plane.
874 * For audio, only linesize[0] may be set. For planar audio, each channel
875 * plane must be the same size.
877 * - encoding: Set by user
878 * - decoding: set by AVCodecContext.get_buffer()
880 int linesize[AV_NUM_DATA_POINTERS];
883 * pointers to the data planes/channels.
885 * For video, this should simply point to data[].
887 * For planar audio, each channel has a separate data pointer, and
888 * linesize[0] contains the size of each channel buffer.
889 * For packed audio, there is just one data pointer, and linesize[0]
890 * contains the total size of the buffer for all channels.
892 * Note: Both data and extended_data will always be set by get_buffer(),
893 * but for planar audio with more channels that can fit in data,
894 * extended_data must be used by the decoder in order to access all
898 * decoding: set by AVCodecContext.get_buffer()
900 uint8_t **extended_data;
903 * width and height of the video frame
905 * - decoding: Read by user.
910 * number of audio samples (per channel) described by this frame
911 * - encoding: Set by user
912 * - decoding: Set by libavcodec
917 * format of the frame, -1 if unknown or unset
918 * Values correspond to enum PixelFormat for video frames,
919 * enum AVSampleFormat for audio)
921 * - decoding: Read by user.
926 * 1 -> keyframe, 0-> not
927 * - encoding: Set by libavcodec.
928 * - decoding: Set by libavcodec.
933 * Picture type of the frame, see ?_TYPE below.
934 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
935 * - decoding: Set by libavcodec.
937 enum AVPictureType pict_type;
940 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
941 * This isn't used by libavcodec unless the default get/release_buffer() is used.
945 uint8_t *base[AV_NUM_DATA_POINTERS];
948 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
950 * - decoding: Read by user.
952 AVRational sample_aspect_ratio;
955 * presentation timestamp in time_base units (time when frame should be shown to user)
956 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
957 * - encoding: MUST be set by user.
958 * - decoding: Set by libavcodec.
963 * reordered pts from the last AVPacket that has been input into the decoder
965 * - decoding: Read by user.
970 * dts from the last AVPacket that has been input into the decoder
972 * - decoding: Read by user.
977 * picture number in bitstream order
979 * - decoding: Set by libavcodec.
981 int coded_picture_number;
983 * picture number in display order
985 * - decoding: Set by libavcodec.
987 int display_picture_number;
990 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
991 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
992 * - decoding: Set by libavcodec.
997 * is this picture used as reference
998 * The values for this are the same as the MpegEncContext.picture_structure
999 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1000 * Set to 4 for delayed, non-reference frames.
1001 * - encoding: unused
1002 * - decoding: Set by libavcodec. (before get_buffer() call)).
1008 * - encoding: unused
1009 * - decoding: Set by libavcodec.
1011 int8_t *qscale_table;
1014 * - encoding: unused
1015 * - decoding: Set by libavcodec.
1025 * mbskip_table[mb]>=1 if MB didn't change
1026 * stride= mb_width = (width+15)>>4
1027 * - encoding: unused
1028 * - decoding: Set by libavcodec.
1030 uint8_t *mbskip_table;
1033 * motion vector table
1036 * int mv_sample_log2= 4 - motion_subsample_log2;
1037 * int mb_width= (width+15)>>4;
1038 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1039 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1041 * - encoding: Set by user.
1042 * - decoding: Set by libavcodec.
1044 int16_t (*motion_val[2])[2];
1047 * macroblock type table
1048 * mb_type_base + mb_width + 2
1049 * - encoding: Set by user.
1050 * - decoding: Set by libavcodec.
1056 * - encoding: unused
1057 * - decoding: Set by libavcodec.
1062 * motion reference frame index
1063 * the order in which these are stored can depend on the codec.
1064 * - encoding: Set by user.
1065 * - decoding: Set by libavcodec.
1067 int8_t *ref_index[2];
1070 * for some private data of the user
1071 * - encoding: unused
1072 * - decoding: Set by user.
1078 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1079 * - decoding: unused
1081 uint64_t error[AV_NUM_DATA_POINTERS];
1084 * type of the buffer (to keep track of who has to deallocate data[*])
1085 * - encoding: Set by the one who allocates it.
1086 * - decoding: Set by the one who allocates it.
1087 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1092 * When decoding, this signals how much the picture must be delayed.
1093 * extra_delay = repeat_pict / (2*fps)
1094 * - encoding: unused
1095 * - decoding: Set by libavcodec.
1100 * The content of the picture is interlaced.
1101 * - encoding: Set by user.
1102 * - decoding: Set by libavcodec. (default 0)
1104 int interlaced_frame;
1107 * If the content is interlaced, is top field displayed first.
1108 * - encoding: Set by user.
1109 * - decoding: Set by libavcodec.
1111 int top_field_first;
1114 * Tell user application that palette has changed from previous frame.
1115 * - encoding: ??? (no palette-enabled encoder yet)
1116 * - decoding: Set by libavcodec. (default 0).
1118 int palette_has_changed;
1121 * codec suggestion on buffer type if != 0
1122 * - encoding: unused
1123 * - decoding: Set by libavcodec. (before get_buffer() call)).
1129 * - encoding: Set by user.
1130 * - decoding: Set by libavcodec.
1132 AVPanScan *pan_scan;
1135 * reordered opaque 64bit (generally an integer or a double precision float
1136 * PTS but can be anything).
1137 * The user sets AVCodecContext.reordered_opaque to represent the input at
1139 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1140 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1141 * @deprecated in favor of pkt_pts
1142 * - encoding: unused
1143 * - decoding: Read by user.
1145 int64_t reordered_opaque;
1148 * hardware accelerator private data (Libav-allocated)
1149 * - encoding: unused
1150 * - decoding: Set by libavcodec
1152 void *hwaccel_picture_private;
1155 * the AVCodecContext which ff_thread_get_buffer() was last called on
1156 * - encoding: Set by libavcodec.
1157 * - decoding: Set by libavcodec.
1159 struct AVCodecContext *owner;
1162 * used by multithreading to store frame-specific info
1163 * - encoding: Set by libavcodec.
1164 * - decoding: Set by libavcodec.
1166 void *thread_opaque;
1169 * log2 of the size of the block which a single vector in motion_val represents:
1170 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1171 * - encoding: unused
1172 * - decoding: Set by libavcodec.
1174 uint8_t motion_subsample_log2;
1177 struct AVCodecInternal;
1181 AV_FIELD_PROGRESSIVE,
1182 AV_FIELD_TT, //< Top coded_first, top displayed first
1183 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1184 AV_FIELD_TB, //< Top coded first, bottom displayed first
1185 AV_FIELD_BT, //< Bottom coded first, top displayed first
1189 * main external API structure.
1190 * New fields can be added to the end with minor version bumps.
1191 * Removal, reordering and changes to existing fields require a major
1193 * sizeof(AVCodecContext) must not be used outside libav*.
1195 typedef struct AVCodecContext {
1197 * information on struct for av_log
1198 * - set by avcodec_alloc_context3
1200 const AVClass *av_class;
1201 int log_level_offset;
1203 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1204 struct AVCodec *codec;
1205 char codec_name[32];
1206 enum CodecID codec_id; /* see CODEC_ID_xxx */
1209 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1210 * This is used to work around some encoder bugs.
1211 * A demuxer should set this to what is stored in the field used to identify the codec.
1212 * If there are multiple such fields in a container then the demuxer should choose the one
1213 * which maximizes the information about the used codec.
1214 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1215 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1216 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1218 * - encoding: Set by user, if not then the default based on codec_id will be used.
1219 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1221 unsigned int codec_tag;
1224 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1225 * This is used to work around some encoder bugs.
1226 * - encoding: unused
1227 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1229 unsigned int stream_codec_tag;
1233 * @deprecated this field is unused
1235 attribute_deprecated int sub_id;
1241 * Private context used for internal data.
1243 * Unlike priv_data, this is not codec-specific. It is used in general
1244 * libavcodec functions.
1246 struct AVCodecInternal *internal;
1249 * Private data of the user, can be used to carry app specific stuff.
1250 * - encoding: Set by user.
1251 * - decoding: Set by user.
1256 * the average bitrate
1257 * - encoding: Set by user; unused for constant quantizer encoding.
1258 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1263 * number of bits the bitstream is allowed to diverge from the reference.
1264 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1265 * - encoding: Set by user; unused for constant quantizer encoding.
1266 * - decoding: unused
1268 int bit_rate_tolerance;
1271 * Global quality for codecs which cannot change it per frame.
1272 * This should be proportional to MPEG-1/2/4 qscale.
1273 * - encoding: Set by user.
1274 * - decoding: unused
1279 * - encoding: Set by user.
1280 * - decoding: unused
1282 int compression_level;
1283 #define FF_COMPRESSION_DEFAULT -1
1287 * - encoding: Set by user.
1288 * - decoding: Set by user.
1294 * - encoding: Set by user.
1295 * - decoding: Set by user.
1300 * some codecs need / can use extradata like Huffman tables.
1301 * mjpeg: Huffman tables
1302 * rv10: additional flags
1303 * mpeg4: global headers (they can be in the bitstream or here)
1304 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1305 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1306 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1307 * - encoding: Set/allocated/freed by libavcodec.
1308 * - decoding: Set/allocated/freed by user.
1314 * This is the fundamental unit of time (in seconds) in terms
1315 * of which frame timestamps are represented. For fixed-fps content,
1316 * timebase should be 1/framerate and timestamp increments should be
1318 * - encoding: MUST be set by user.
1319 * - decoding: Set by libavcodec.
1321 AVRational time_base;
1324 * For some codecs, the time base is closer to the field rate than the frame rate.
1325 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1326 * if no telecine is used ...
1328 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1330 int ticks_per_frame;
1336 * Number of frames the decoded output will be delayed relative to the
1340 * Number of "priming" samples added to the beginning of the stream
1341 * during encoding. The decoded output will be delayed by this many
1342 * samples relative to the input to the encoder. Note that this field is
1343 * purely informational and does not directly affect the pts output by
1344 * the encoder, which should always be based on the actual presentation
1345 * time, including any delay.
1347 * - encoding: Set by libavcodec.
1348 * - decoding: unused
1355 * picture width / height.
1356 * - encoding: MUST be set by user.
1357 * - decoding: Set by libavcodec.
1358 * Note: For compatibility it is possible to set this instead of
1359 * coded_width/height before decoding.
1364 * Bitstream width / height, may be different from width/height if lowres enabled.
1365 * - encoding: unused
1366 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1368 int coded_width, coded_height;
1370 #define FF_ASPECT_EXTENDED 15
1373 * the number of pictures in a group of pictures, or 0 for intra_only
1374 * - encoding: Set by user.
1375 * - decoding: unused
1380 * Pixel format, see PIX_FMT_xxx.
1381 * May be set by the demuxer if known from headers.
1382 * May be overriden by the decoder if it knows better.
1383 * - encoding: Set by user.
1384 * - decoding: Set by user if known, overridden by libavcodec if known
1386 enum PixelFormat pix_fmt;
1389 * Motion estimation algorithm used for video coding.
1390 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1391 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1392 * - encoding: MUST be set by user.
1393 * - decoding: unused
1398 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1399 * decoder to draw a horizontal band. It improves cache usage. Not
1400 * all codecs can do that. You must check the codec capabilities
1402 * When multithreading is used, it may be called from multiple threads
1403 * at the same time; threads might draw different parts of the same AVFrame,
1404 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1406 * The function is also used by hardware acceleration APIs.
1407 * It is called at least once during frame decoding to pass
1408 * the data needed for hardware render.
1409 * In that mode instead of pixel data, AVFrame points to
1410 * a structure specific to the acceleration API. The application
1411 * reads the structure and can change some fields to indicate progress
1413 * - encoding: unused
1414 * - decoding: Set by user.
1415 * @param height the height of the slice
1416 * @param y the y position of the slice
1417 * @param type 1->top field, 2->bottom field, 3->frame
1418 * @param offset offset into the AVFrame.data from which the slice should be read
1420 void (*draw_horiz_band)(struct AVCodecContext *s,
1421 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1422 int y, int type, int height);
1425 * callback to negotiate the pixelFormat
1426 * @param fmt is the list of formats which are supported by the codec,
1427 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1428 * The first is always the native one.
1429 * @return the chosen format
1430 * - encoding: unused
1431 * - decoding: Set by user, if not set the native format will be chosen.
1433 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1436 * maximum number of B-frames between non-B-frames
1437 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1438 * - encoding: Set by user.
1439 * - decoding: unused
1444 * qscale factor between IP and B-frames
1445 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1446 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1447 * - encoding: Set by user.
1448 * - decoding: unused
1450 float b_quant_factor;
1452 /** obsolete FIXME remove */
1454 #define FF_RC_STRATEGY_XVID 1
1456 int b_frame_strategy;
1458 #if FF_API_MPV_GLOBAL_OPTS
1460 * luma single coefficient elimination threshold
1461 * - encoding: Set by user.
1462 * - decoding: unused
1464 attribute_deprecated int luma_elim_threshold;
1467 * chroma single coeff elimination threshold
1468 * - encoding: Set by user.
1469 * - decoding: unused
1471 attribute_deprecated int chroma_elim_threshold;
1475 * qscale offset between IP and B-frames
1476 * - encoding: Set by user.
1477 * - decoding: unused
1479 float b_quant_offset;
1482 * Size of the frame reordering buffer in the decoder.
1483 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1484 * - encoding: Set by libavcodec.
1485 * - decoding: Set by libavcodec.
1490 * 0-> h263 quant 1-> mpeg quant
1491 * - encoding: Set by user.
1492 * - decoding: unused
1497 * qscale factor between P and I-frames
1498 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1499 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1500 * - encoding: Set by user.
1501 * - decoding: unused
1503 float i_quant_factor;
1506 * qscale offset between P and I-frames
1507 * - encoding: Set by user.
1508 * - decoding: unused
1510 float i_quant_offset;
1513 * luminance masking (0-> disabled)
1514 * - encoding: Set by user.
1515 * - decoding: unused
1520 * temporary complexity masking (0-> disabled)
1521 * - encoding: Set by user.
1522 * - decoding: unused
1524 float temporal_cplx_masking;
1527 * spatial complexity masking (0-> disabled)
1528 * - encoding: Set by user.
1529 * - decoding: unused
1531 float spatial_cplx_masking;
1534 * p block masking (0-> disabled)
1535 * - encoding: Set by user.
1536 * - decoding: unused
1541 * darkness masking (0-> disabled)
1542 * - encoding: Set by user.
1543 * - decoding: unused
1549 * - encoding: Set by libavcodec.
1550 * - decoding: Set by user (or 0).
1554 * prediction method (needed for huffyuv)
1555 * - encoding: Set by user.
1556 * - decoding: unused
1558 int prediction_method;
1559 #define FF_PRED_LEFT 0
1560 #define FF_PRED_PLANE 1
1561 #define FF_PRED_MEDIAN 2
1564 * slice offsets in the frame in bytes
1565 * - encoding: Set/allocated by libavcodec.
1566 * - decoding: Set/allocated by user (or NULL).
1571 * sample aspect ratio (0 if unknown)
1572 * That is the width of a pixel divided by the height of the pixel.
1573 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1574 * - encoding: Set by user.
1575 * - decoding: Set by libavcodec.
1577 AVRational sample_aspect_ratio;
1580 * motion estimation comparison function
1581 * - encoding: Set by user.
1582 * - decoding: unused
1586 * subpixel motion estimation comparison function
1587 * - encoding: Set by user.
1588 * - decoding: unused
1592 * macroblock comparison function (not supported yet)
1593 * - encoding: Set by user.
1594 * - decoding: unused
1598 * interlaced DCT comparison function
1599 * - encoding: Set by user.
1600 * - decoding: unused
1603 #define FF_CMP_SAD 0
1604 #define FF_CMP_SSE 1
1605 #define FF_CMP_SATD 2
1606 #define FF_CMP_DCT 3
1607 #define FF_CMP_PSNR 4
1608 #define FF_CMP_BIT 5
1610 #define FF_CMP_ZERO 7
1611 #define FF_CMP_VSAD 8
1612 #define FF_CMP_VSSE 9
1613 #define FF_CMP_NSSE 10
1614 #define FF_CMP_W53 11
1615 #define FF_CMP_W97 12
1616 #define FF_CMP_DCTMAX 13
1617 #define FF_CMP_DCT264 14
1618 #define FF_CMP_CHROMA 256
1621 * ME diamond size & shape
1622 * - encoding: Set by user.
1623 * - decoding: unused
1628 * amount of previous MV predictors (2a+1 x 2a+1 square)
1629 * - encoding: Set by user.
1630 * - decoding: unused
1632 int last_predictor_count;
1635 * prepass for motion estimation
1636 * - encoding: Set by user.
1637 * - decoding: unused
1642 * motion estimation prepass comparison function
1643 * - encoding: Set by user.
1644 * - decoding: unused
1649 * ME prepass diamond size & shape
1650 * - encoding: Set by user.
1651 * - decoding: unused
1657 * - encoding: Set by user.
1658 * - decoding: unused
1660 int me_subpel_quality;
1663 * DTG active format information (additional aspect ratio
1664 * information only used in DVB MPEG-2 transport streams)
1667 * - encoding: unused
1668 * - decoding: Set by decoder.
1670 int dtg_active_format;
1671 #define FF_DTG_AFD_SAME 8
1672 #define FF_DTG_AFD_4_3 9
1673 #define FF_DTG_AFD_16_9 10
1674 #define FF_DTG_AFD_14_9 11
1675 #define FF_DTG_AFD_4_3_SP_14_9 13
1676 #define FF_DTG_AFD_16_9_SP_14_9 14
1677 #define FF_DTG_AFD_SP_4_3 15
1680 * maximum motion estimation search range in subpel units
1681 * If 0 then no limit.
1683 * - encoding: Set by user.
1684 * - decoding: unused
1689 * intra quantizer bias
1690 * - encoding: Set by user.
1691 * - decoding: unused
1693 int intra_quant_bias;
1694 #define FF_DEFAULT_QUANT_BIAS 999999
1697 * inter quantizer bias
1698 * - encoding: Set by user.
1699 * - decoding: unused
1701 int inter_quant_bias;
1703 #if FF_API_COLOR_TABLE_ID
1706 * - encoding: unused
1707 * - decoding: Which clrtable should be used for 8bit RGB images.
1708 * Tables have to be stored somewhere. FIXME
1710 attribute_deprecated int color_table_id;
1715 * - encoding: unused
1716 * - decoding: Set by user.
1719 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1720 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1721 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1724 * XVideo Motion Acceleration
1725 * - encoding: forbidden
1726 * - decoding: set by decoder
1728 int xvmc_acceleration;
1731 * macroblock decision mode
1732 * - encoding: Set by user.
1733 * - decoding: unused
1736 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1737 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1738 #define FF_MB_DECISION_RD 2 ///< rate distortion
1741 * custom intra quantization matrix
1742 * - encoding: Set by user, can be NULL.
1743 * - decoding: Set by libavcodec.
1745 uint16_t *intra_matrix;
1748 * custom inter quantization matrix
1749 * - encoding: Set by user, can be NULL.
1750 * - decoding: Set by libavcodec.
1752 uint16_t *inter_matrix;
1755 * scene change detection threshold
1756 * 0 is default, larger means fewer detected scene changes.
1757 * - encoding: Set by user.
1758 * - decoding: unused
1760 int scenechange_threshold;
1763 * noise reduction strength
1764 * - encoding: Set by user.
1765 * - decoding: unused
1767 int noise_reduction;
1769 #if FF_API_INTER_THRESHOLD
1771 * @deprecated this field is unused
1773 attribute_deprecated int inter_threshold;
1776 #if FF_API_MPV_GLOBAL_OPTS
1778 * @deprecated use mpegvideo private options instead
1780 attribute_deprecated int quantizer_noise_shaping;
1784 * Motion estimation threshold below which no motion estimation is
1785 * performed, but instead the user specified motion vectors are used.
1787 * - encoding: Set by user.
1788 * - decoding: unused
1793 * Macroblock threshold below which the user specified macroblock types will be used.
1794 * - encoding: Set by user.
1795 * - decoding: unused
1800 * precision of the intra DC coefficient - 8
1801 * - encoding: Set by user.
1802 * - decoding: unused
1804 int intra_dc_precision;
1807 * Number of macroblock rows at the top which are skipped.
1808 * - encoding: unused
1809 * - decoding: Set by user.
1814 * Number of macroblock rows at the bottom which are skipped.
1815 * - encoding: unused
1816 * - decoding: Set by user.
1821 * Border processing masking, raises the quantizer for mbs on the borders
1823 * - encoding: Set by user.
1824 * - decoding: unused
1826 float border_masking;
1829 * minimum MB lagrange multipler
1830 * - encoding: Set by user.
1831 * - decoding: unused
1836 * maximum MB lagrange multipler
1837 * - encoding: Set by user.
1838 * - decoding: unused
1844 * - encoding: Set by user.
1845 * - decoding: unused
1847 int me_penalty_compensation;
1851 * - encoding: Set by user.
1852 * - decoding: unused
1858 * - encoding: Set by user.
1859 * - decoding: unused
1865 * - encoding: Set by user.
1866 * - decoding: unused
1871 * number of reference frames
1872 * - encoding: Set by user.
1873 * - decoding: Set by lavc.
1878 * chroma qp offset from luma
1879 * - encoding: Set by user.
1880 * - decoding: unused
1885 * Multiplied by qscale for each frame and added to scene_change_score.
1886 * - encoding: Set by user.
1887 * - decoding: unused
1889 int scenechange_factor;
1893 * Note: Value depends upon the compare function used for fullpel ME.
1894 * - encoding: Set by user.
1895 * - decoding: unused
1900 * Adjust sensitivity of b_frame_strategy 1.
1901 * - encoding: Set by user.
1902 * - decoding: unused
1907 * Chromaticity coordinates of the source primaries.
1908 * - encoding: Set by user
1909 * - decoding: Set by libavcodec
1911 enum AVColorPrimaries color_primaries;
1914 * Color Transfer Characteristic.
1915 * - encoding: Set by user
1916 * - decoding: Set by libavcodec
1918 enum AVColorTransferCharacteristic color_trc;
1921 * YUV colorspace type.
1922 * - encoding: Set by user
1923 * - decoding: Set by libavcodec
1925 enum AVColorSpace colorspace;
1928 * MPEG vs JPEG YUV range.
1929 * - encoding: Set by user
1930 * - decoding: Set by libavcodec
1932 enum AVColorRange color_range;
1935 * This defines the location of chroma samples.
1936 * - encoding: Set by user
1937 * - decoding: Set by libavcodec
1939 enum AVChromaLocation chroma_sample_location;
1943 * Indicates number of picture subdivisions. Used for parallelized
1945 * - encoding: Set by user
1946 * - decoding: unused
1951 * - encoding: set by libavcodec
1952 * - decoding: Set by libavcodec
1954 enum AVFieldOrder field_order;
1957 int sample_rate; ///< samples per second
1958 int channels; ///< number of audio channels
1961 * audio sample format
1962 * - encoding: Set by user.
1963 * - decoding: Set by libavcodec.
1965 enum AVSampleFormat sample_fmt; ///< sample format
1967 /* The following data should not be initialized. */
1969 * Samples per packet, initialized when calling 'init'.
1974 * Frame counter, set by libavcodec.
1976 * - decoding: total number of frames returned from the decoder so far.
1977 * - encoding: total number of frames passed to the encoder so far.
1979 * @note the counter is not incremented if encoding/decoding resulted in
1985 * number of bytes per packet if constant and known or 0
1986 * Used by some WAV based audio codecs.
1991 * Audio cutoff bandwidth (0 means "automatic")
1992 * - encoding: Set by user.
1993 * - decoding: unused
1997 #if FF_API_REQUEST_CHANNELS
1999 * Decoder should decode to this many channels if it can (0 for default)
2000 * - encoding: unused
2001 * - decoding: Set by user.
2002 * @deprecated Deprecated in favor of request_channel_layout.
2004 int request_channels;
2008 * Audio channel layout.
2009 * - encoding: set by user.
2010 * - decoding: set by libavcodec.
2012 uint64_t channel_layout;
2015 * Request decoder to use this channel layout if it can (0 for default)
2016 * - encoding: unused
2017 * - decoding: Set by user.
2019 uint64_t request_channel_layout;
2022 * Type of service that the audio stream conveys.
2023 * - encoding: Set by user.
2024 * - decoding: Set by libavcodec.
2026 enum AVAudioServiceType audio_service_type;
2029 * Used to request a sample format from the decoder.
2030 * - encoding: unused.
2031 * - decoding: Set by user.
2033 enum AVSampleFormat request_sample_fmt;
2036 * Called at the beginning of each frame to get a buffer for it.
2038 * The function will set AVFrame.data[], AVFrame.linesize[].
2039 * AVFrame.extended_data[] must also be set, but it should be the same as
2040 * AVFrame.data[] except for planar audio with more channels than can fit
2041 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2042 * many data pointers as it can hold.
2044 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2045 * avcodec_default_get_buffer() instead of providing buffers allocated by
2048 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2049 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2050 * but if get_buffer() is overridden then alignment considerations should
2051 * be taken into account.
2053 * @see avcodec_default_get_buffer()
2057 * If pic.reference is set then the frame will be read later by libavcodec.
2058 * avcodec_align_dimensions2() should be used to find the required width and
2059 * height, as they normally need to be rounded up to the next multiple of 16.
2061 * If frame multithreading is used and thread_safe_callbacks is set,
2062 * it may be called from a different thread, but not from more than one at
2063 * once. Does not need to be reentrant.
2065 * @see release_buffer(), reget_buffer()
2066 * @see avcodec_align_dimensions2()
2070 * Decoders request a buffer of a particular size by setting
2071 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2072 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2073 * to a smaller value in the output frame.
2075 * Decoders cannot use the buffer after returning from
2076 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2077 * is assumed to be released immediately upon return.
2079 * As a convenience, av_samples_get_buffer_size() and
2080 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2081 * functions to find the required data size and to fill data pointers and
2082 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2083 * since all planes must be the same size.
2085 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2087 * - encoding: unused
2088 * - decoding: Set by libavcodec, user can override.
2090 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2093 * Called to release buffers which were allocated with get_buffer.
2094 * A released buffer can be reused in get_buffer().
2095 * pic.data[*] must be set to NULL.
2096 * May be called from a different thread if frame multithreading is used,
2097 * but not by more than one thread at once, so does not need to be reentrant.
2098 * - encoding: unused
2099 * - decoding: Set by libavcodec, user can override.
2101 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2104 * Called at the beginning of a frame to get cr buffer for it.
2105 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2106 * libavcodec will pass previous buffer in pic, function should return
2107 * same buffer or new buffer with old frame "painted" into it.
2108 * If pic.data[0] == NULL must behave like get_buffer().
2109 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2110 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2112 * - encoding: unused
2113 * - decoding: Set by libavcodec, user can override.
2115 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2118 /* - encoding parameters */
2119 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2120 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2124 * - encoding: Set by user.
2125 * - decoding: unused
2131 * - encoding: Set by user.
2132 * - decoding: unused
2137 * maximum quantizer difference between frames
2138 * - encoding: Set by user.
2139 * - decoding: unused
2144 * ratecontrol qmin qmax limiting method
2145 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2146 * - encoding: Set by user.
2147 * - decoding: unused
2155 * decoder bitstream buffer size
2156 * - encoding: Set by user.
2157 * - decoding: unused
2162 * ratecontrol override, see RcOverride
2163 * - encoding: Allocated/set/freed by user.
2164 * - decoding: unused
2166 int rc_override_count;
2167 RcOverride *rc_override;
2170 * rate control equation
2171 * - encoding: Set by user
2172 * - decoding: unused
2178 * - encoding: Set by user.
2179 * - decoding: unused
2185 * - encoding: Set by user.
2186 * - decoding: unused
2190 float rc_buffer_aggressivity;
2193 * initial complexity for pass1 ratecontrol
2194 * - encoding: Set by user.
2195 * - decoding: unused
2197 float rc_initial_cplx;
2200 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2201 * - encoding: Set by user.
2202 * - decoding: unused.
2204 float rc_max_available_vbv_use;
2207 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2208 * - encoding: Set by user.
2209 * - decoding: unused.
2211 float rc_min_vbv_overflow_use;
2214 * Number of bits which should be loaded into the rc buffer before decoding starts.
2215 * - encoding: Set by user.
2216 * - decoding: unused
2218 int rc_initial_buffer_occupancy;
2220 #define FF_CODER_TYPE_VLC 0
2221 #define FF_CODER_TYPE_AC 1
2222 #define FF_CODER_TYPE_RAW 2
2223 #define FF_CODER_TYPE_RLE 3
2224 #define FF_CODER_TYPE_DEFLATE 4
2227 * - encoding: Set by user.
2228 * - decoding: unused
2234 * - encoding: Set by user.
2235 * - decoding: unused
2240 * minimum Lagrange multipler
2241 * - encoding: Set by user.
2242 * - decoding: unused
2247 * maximum Lagrange multipler
2248 * - encoding: Set by user.
2249 * - decoding: unused
2254 * frame skip threshold
2255 * - encoding: Set by user.
2256 * - decoding: unused
2258 int frame_skip_threshold;
2262 * - encoding: Set by user.
2263 * - decoding: unused
2265 int frame_skip_factor;
2268 * frame skip exponent
2269 * - encoding: Set by user.
2270 * - decoding: unused
2275 * frame skip comparison function
2276 * - encoding: Set by user.
2277 * - decoding: unused
2282 * trellis RD quantization
2283 * - encoding: Set by user.
2284 * - decoding: unused
2289 * - encoding: Set by user.
2290 * - decoding: unused
2292 int min_prediction_order;
2295 * - encoding: Set by user.
2296 * - decoding: unused
2298 int max_prediction_order;
2301 * GOP timecode frame start number, in non drop frame format
2302 * - encoding: Set by user.
2303 * - decoding: unused
2305 int64_t timecode_frame_start;
2307 /* The RTP callback: This function is called */
2308 /* every time the encoder has a packet to send. */
2309 /* It depends on the encoder if the data starts */
2310 /* with a Start Code (it should). H.263 does. */
2311 /* mb_nb contains the number of macroblocks */
2312 /* encoded in the RTP payload. */
2313 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2315 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2316 /* do its best to deliver a chunk with size */
2317 /* below rtp_payload_size, the chunk will start */
2318 /* with a start code on some codecs like H.263. */
2319 /* This doesn't take account of any particular */
2320 /* headers inside the transmitted RTP payload. */
2322 /* statistics, used for 2-pass encoding */
2333 * number of bits used for the previously encoded frame
2334 * - encoding: Set by libavcodec.
2335 * - decoding: unused
2340 * pass1 encoding statistics output buffer
2341 * - encoding: Set by libavcodec.
2342 * - decoding: unused
2347 * pass2 encoding statistics input buffer
2348 * Concatenated stuff from stats_out of pass1 should be placed here.
2349 * - encoding: Allocated/set/freed by user.
2350 * - decoding: unused
2355 * Work around bugs in encoders which sometimes cannot be detected automatically.
2356 * - encoding: Set by user
2357 * - decoding: Set by user
2359 int workaround_bugs;
2360 #define FF_BUG_AUTODETECT 1 ///< autodetection
2361 #define FF_BUG_OLD_MSMPEG4 2
2362 #define FF_BUG_XVID_ILACE 4
2363 #define FF_BUG_UMP4 8
2364 #define FF_BUG_NO_PADDING 16
2365 #define FF_BUG_AMV 32
2366 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2367 #define FF_BUG_QPEL_CHROMA 64
2368 #define FF_BUG_STD_QPEL 128
2369 #define FF_BUG_QPEL_CHROMA2 256
2370 #define FF_BUG_DIRECT_BLOCKSIZE 512
2371 #define FF_BUG_EDGE 1024
2372 #define FF_BUG_HPEL_CHROMA 2048
2373 #define FF_BUG_DC_CLIP 4096
2374 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2375 #define FF_BUG_TRUNCATED 16384
2378 * strictly follow the standard (MPEG4, ...).
2379 * - encoding: Set by user.
2380 * - decoding: Set by user.
2381 * Setting this to STRICT or higher means the encoder and decoder will
2382 * generally do stupid things, whereas setting it to unofficial or lower
2383 * will mean the encoder might produce output that is not supported by all
2384 * spec-compliant decoders. Decoders don't differentiate between normal,
2385 * unofficial and experimental (that is, they always try to decode things
2386 * when they can) unless they are explicitly asked to behave stupidly
2387 * (=strictly conform to the specs)
2389 int strict_std_compliance;
2390 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2391 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2392 #define FF_COMPLIANCE_NORMAL 0
2393 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2394 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2397 * error concealment flags
2398 * - encoding: unused
2399 * - decoding: Set by user.
2401 int error_concealment;
2402 #define FF_EC_GUESS_MVS 1
2403 #define FF_EC_DEBLOCK 2
2407 * - encoding: Set by user.
2408 * - decoding: Set by user.
2411 #define FF_DEBUG_PICT_INFO 1
2412 #define FF_DEBUG_RC 2
2413 #define FF_DEBUG_BITSTREAM 4
2414 #define FF_DEBUG_MB_TYPE 8
2415 #define FF_DEBUG_QP 16
2416 #define FF_DEBUG_MV 32
2417 #define FF_DEBUG_DCT_COEFF 0x00000040
2418 #define FF_DEBUG_SKIP 0x00000080
2419 #define FF_DEBUG_STARTCODE 0x00000100
2420 #define FF_DEBUG_PTS 0x00000200
2421 #define FF_DEBUG_ER 0x00000400
2422 #define FF_DEBUG_MMCO 0x00000800
2423 #define FF_DEBUG_BUGS 0x00001000
2424 #define FF_DEBUG_VIS_QP 0x00002000
2425 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2426 #define FF_DEBUG_BUFFERS 0x00008000
2427 #define FF_DEBUG_THREADS 0x00010000
2431 * - encoding: Set by user.
2432 * - decoding: Set by user.
2435 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2436 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2437 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2440 * Error recognition; may misdetect some more or less valid parts as errors.
2441 * - encoding: unused
2442 * - decoding: Set by user.
2444 int err_recognition;
2445 #define AV_EF_CRCCHECK (1<<0)
2446 #define AV_EF_BITSTREAM (1<<1)
2447 #define AV_EF_BUFFER (1<<2)
2448 #define AV_EF_EXPLODE (1<<3)
2451 * opaque 64bit number (generally a PTS) that will be reordered and
2452 * output in AVFrame.reordered_opaque
2453 * @deprecated in favor of pkt_pts
2454 * - encoding: unused
2455 * - decoding: Set by user.
2457 int64_t reordered_opaque;
2460 * Hardware accelerator in use
2461 * - encoding: unused.
2462 * - decoding: Set by libavcodec
2464 struct AVHWAccel *hwaccel;
2467 * Hardware accelerator context.
2468 * For some hardware accelerators, a global context needs to be
2469 * provided by the user. In that case, this holds display-dependent
2470 * data Libav cannot instantiate itself. Please refer to the
2471 * Libav HW accelerator documentation to know how to fill this
2472 * is. e.g. for VA API, this is a struct vaapi_context.
2473 * - encoding: unused
2474 * - decoding: Set by user
2476 void *hwaccel_context;
2480 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2481 * - decoding: unused
2483 uint64_t error[AV_NUM_DATA_POINTERS];
2486 * DCT algorithm, see FF_DCT_* below
2487 * - encoding: Set by user.
2488 * - decoding: unused
2491 #define FF_DCT_AUTO 0
2492 #define FF_DCT_FASTINT 1
2493 #define FF_DCT_INT 2
2494 #define FF_DCT_MMX 3
2495 #define FF_DCT_ALTIVEC 5
2496 #define FF_DCT_FAAN 6
2499 * IDCT algorithm, see FF_IDCT_* below.
2500 * - encoding: Set by user.
2501 * - decoding: Set by user.
2504 #define FF_IDCT_AUTO 0
2505 #define FF_IDCT_INT 1
2506 #define FF_IDCT_SIMPLE 2
2507 #define FF_IDCT_SIMPLEMMX 3
2508 #define FF_IDCT_LIBMPEG2MMX 4
2509 #define FF_IDCT_MMI 5
2510 #define FF_IDCT_ARM 7
2511 #define FF_IDCT_ALTIVEC 8
2512 #define FF_IDCT_SH4 9
2513 #define FF_IDCT_SIMPLEARM 10
2514 #define FF_IDCT_H264 11
2515 #define FF_IDCT_VP3 12
2516 #define FF_IDCT_IPP 13
2517 #define FF_IDCT_XVIDMMX 14
2518 #define FF_IDCT_CAVS 15
2519 #define FF_IDCT_SIMPLEARMV5TE 16
2520 #define FF_IDCT_SIMPLEARMV6 17
2521 #define FF_IDCT_SIMPLEVIS 18
2522 #define FF_IDCT_WMV2 19
2523 #define FF_IDCT_FAAN 20
2524 #define FF_IDCT_EA 21
2525 #define FF_IDCT_SIMPLENEON 22
2526 #define FF_IDCT_SIMPLEALPHA 23
2527 #define FF_IDCT_BINK 24
2530 * dsp_mask could be add used to disable unwanted CPU features
2531 * CPU features (i.e. MMX, SSE. ...)
2533 * With the FORCE flag you may instead enable given CPU features.
2534 * (Dangerous: Usable in case of misdetection, improper usage however will
2535 * result into program crash.)
2540 * bits per sample/pixel from the demuxer (needed for huffyuv).
2541 * - encoding: Set by libavcodec.
2542 * - decoding: Set by user.
2544 int bits_per_coded_sample;
2547 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2548 * - encoding: set by user.
2549 * - decoding: set by libavcodec.
2551 int bits_per_raw_sample;
2554 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2555 * - encoding: unused
2556 * - decoding: Set by user.
2561 * the picture in the bitstream
2562 * - encoding: Set by libavcodec.
2563 * - decoding: Set by libavcodec.
2565 AVFrame *coded_frame;
2569 * is used to decide how many independent tasks should be passed to execute()
2570 * - encoding: Set by user.
2571 * - decoding: Set by user.
2576 * Which multithreading methods to use.
2577 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2578 * so clients which cannot provide future frames should not use it.
2580 * - encoding: Set by user, otherwise the default is used.
2581 * - decoding: Set by user, otherwise the default is used.
2584 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2585 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2588 * Which multithreading methods are in use by the codec.
2589 * - encoding: Set by libavcodec.
2590 * - decoding: Set by libavcodec.
2592 int active_thread_type;
2595 * Set by the client if its custom get_buffer() callback can be called
2596 * from another thread, which allows faster multithreaded decoding.
2597 * draw_horiz_band() will be called from other threads regardless of this setting.
2598 * Ignored if the default get_buffer() is used.
2599 * - encoding: Set by user.
2600 * - decoding: Set by user.
2602 int thread_safe_callbacks;
2605 * The codec may call this to execute several independent things.
2606 * It will return only after finishing all tasks.
2607 * The user may replace this with some multithreaded implementation,
2608 * the default implementation will execute the parts serially.
2609 * @param count the number of things to execute
2610 * - encoding: Set by libavcodec, user can override.
2611 * - decoding: Set by libavcodec, user can override.
2613 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2616 * The codec may call this to execute several independent things.
2617 * It will return only after finishing all tasks.
2618 * The user may replace this with some multithreaded implementation,
2619 * the default implementation will execute the parts serially.
2620 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2621 * @param c context passed also to func
2622 * @param count the number of things to execute
2623 * @param arg2 argument passed unchanged to func
2624 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2625 * @param func function that will be called count times, with jobnr from 0 to count-1.
2626 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2627 * two instances of func executing at the same time will have the same threadnr.
2628 * @return always 0 currently, but code should handle a future improvement where when any call to func
2629 * returns < 0 no further calls to func may be done and < 0 is returned.
2630 * - encoding: Set by libavcodec, user can override.
2631 * - decoding: Set by libavcodec, user can override.
2633 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2637 * Can be used by execute() to store some per AVCodecContext stuff.
2638 * - encoding: set by execute()
2639 * - decoding: set by execute()
2641 void *thread_opaque;
2644 * noise vs. sse weight for the nsse comparsion function
2645 * - encoding: Set by user.
2646 * - decoding: unused
2652 * - encoding: Set by user.
2653 * - decoding: Set by libavcodec.
2656 #define FF_PROFILE_UNKNOWN -99
2657 #define FF_PROFILE_RESERVED -100
2659 #define FF_PROFILE_AAC_MAIN 0
2660 #define FF_PROFILE_AAC_LOW 1
2661 #define FF_PROFILE_AAC_SSR 2
2662 #define FF_PROFILE_AAC_LTP 3
2664 #define FF_PROFILE_DTS 20
2665 #define FF_PROFILE_DTS_ES 30
2666 #define FF_PROFILE_DTS_96_24 40
2667 #define FF_PROFILE_DTS_HD_HRA 50
2668 #define FF_PROFILE_DTS_HD_MA 60
2670 #define FF_PROFILE_MPEG2_422 0
2671 #define FF_PROFILE_MPEG2_HIGH 1
2672 #define FF_PROFILE_MPEG2_SS 2
2673 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2674 #define FF_PROFILE_MPEG2_MAIN 4
2675 #define FF_PROFILE_MPEG2_SIMPLE 5
2677 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2678 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2680 #define FF_PROFILE_H264_BASELINE 66
2681 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2682 #define FF_PROFILE_H264_MAIN 77
2683 #define FF_PROFILE_H264_EXTENDED 88
2684 #define FF_PROFILE_H264_HIGH 100
2685 #define FF_PROFILE_H264_HIGH_10 110
2686 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2687 #define FF_PROFILE_H264_HIGH_422 122
2688 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2689 #define FF_PROFILE_H264_HIGH_444 144
2690 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2691 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2692 #define FF_PROFILE_H264_CAVLC_444 44
2694 #define FF_PROFILE_VC1_SIMPLE 0
2695 #define FF_PROFILE_VC1_MAIN 1
2696 #define FF_PROFILE_VC1_COMPLEX 2
2697 #define FF_PROFILE_VC1_ADVANCED 3
2699 #define FF_PROFILE_MPEG4_SIMPLE 0
2700 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2701 #define FF_PROFILE_MPEG4_CORE 2
2702 #define FF_PROFILE_MPEG4_MAIN 3
2703 #define FF_PROFILE_MPEG4_N_BIT 4
2704 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2705 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2706 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2707 #define FF_PROFILE_MPEG4_HYBRID 8
2708 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2709 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2710 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2711 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2712 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2713 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2714 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2718 * - encoding: Set by user.
2719 * - decoding: Set by libavcodec.
2722 #define FF_LEVEL_UNKNOWN -99
2726 * - encoding: unused
2727 * - decoding: Set by user.
2729 enum AVDiscard skip_loop_filter;
2733 * - encoding: unused
2734 * - decoding: Set by user.
2736 enum AVDiscard skip_idct;
2740 * - encoding: unused
2741 * - decoding: Set by user.
2743 enum AVDiscard skip_frame;
2746 * Header containing style information for text subtitles.
2747 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2748 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2749 * the Format line following. It shouldn't include any Dialogue line.
2750 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2751 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2753 uint8_t *subtitle_header;
2754 int subtitle_header_size;
2757 * Simulates errors in the bitstream to test error concealment.
2758 * - encoding: Set by user.
2759 * - decoding: unused
2764 * Current packet as passed into the decoder, to avoid having
2765 * to pass the packet into every function. Currently only valid
2766 * inside lavc and get/release_buffer callbacks.
2767 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2768 * - encoding: unused
2773 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2774 * Used for compliant TS muxing.
2775 * - encoding: Set by libavcodec.
2776 * - decoding: unused.
2784 typedef struct AVProfile {
2786 const char *name; ///< short name for the profile
2789 typedef struct AVCodecDefault AVCodecDefault;
2794 typedef struct AVCodec {
2796 * Name of the codec implementation.
2797 * The name is globally unique among encoders and among decoders (but an
2798 * encoder and a decoder can share the same name).
2799 * This is the primary way to find a codec from the user perspective.
2803 * Descriptive name for the codec, meant to be more human readable than name.
2804 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2806 const char *long_name;
2807 enum AVMediaType type;
2810 * Codec capabilities.
2814 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2815 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2816 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2817 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2818 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2819 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2820 const AVClass *priv_class; ///< AVClass for the private context
2821 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2823 /*****************************************************************
2824 * No fields below this line are part of the public API. They
2825 * may not be used outside of libavcodec and can be changed and
2827 * New public fields should be added right above.
2828 *****************************************************************
2831 struct AVCodec *next;
2833 * @name Frame-level threading support functions
2837 * If defined, called on thread contexts when they are created.
2838 * If the codec allocates writable tables in init(), re-allocate them here.
2839 * priv_data will be set to a copy of the original.
2841 int (*init_thread_copy)(AVCodecContext *);
2843 * Copy necessary context variables from a previous thread context to the current one.
2844 * If not defined, the next thread will start automatically; otherwise, the codec
2845 * must call ff_thread_finish_setup().
2847 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2849 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2853 * Private codec-specific defaults.
2855 const AVCodecDefault *defaults;
2858 * Initialize codec static data, called from avcodec_register().
2860 void (*init_static_data)(struct AVCodec *codec);
2862 int (*init)(AVCodecContext *);
2863 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2865 * Encode data to an AVPacket.
2867 * @param avctx codec context
2868 * @param avpkt output AVPacket (may contain a user-provided buffer)
2869 * @param[in] frame AVFrame containing the raw data to be encoded
2870 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2871 * non-empty packet was returned in avpkt.
2872 * @return 0 on success, negative error code on failure
2874 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2875 int *got_packet_ptr);
2876 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2877 int (*close)(AVCodecContext *);
2880 * Will be called when seeking
2882 void (*flush)(AVCodecContext *);
2888 typedef struct AVHWAccel {
2890 * Name of the hardware accelerated codec.
2891 * The name is globally unique among encoders and among decoders (but an
2892 * encoder and a decoder can share the same name).
2897 * Type of codec implemented by the hardware accelerator.
2899 * See AVMEDIA_TYPE_xxx
2901 enum AVMediaType type;
2904 * Codec implemented by the hardware accelerator.
2911 * Supported pixel format.
2913 * Only hardware accelerated formats are supported here.
2915 enum PixelFormat pix_fmt;
2918 * Hardware accelerated codec capabilities.
2919 * see FF_HWACCEL_CODEC_CAP_*
2923 struct AVHWAccel *next;
2926 * Called at the beginning of each frame or field picture.
2928 * Meaningful frame information (codec specific) is guaranteed to
2929 * be parsed at this point. This function is mandatory.
2931 * Note that buf can be NULL along with buf_size set to 0.
2932 * Otherwise, this means the whole frame is available at this point.
2934 * @param avctx the codec context
2935 * @param buf the frame data buffer base
2936 * @param buf_size the size of the frame in bytes
2937 * @return zero if successful, a negative value otherwise
2939 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2942 * Callback for each slice.
2944 * Meaningful slice information (codec specific) is guaranteed to
2945 * be parsed at this point. This function is mandatory.
2947 * @param avctx the codec context
2948 * @param buf the slice data buffer base
2949 * @param buf_size the size of the slice in bytes
2950 * @return zero if successful, a negative value otherwise
2952 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2955 * Called at the end of each frame or field picture.
2957 * The whole picture is parsed at this point and can now be sent
2958 * to the hardware accelerator. This function is mandatory.
2960 * @param avctx the codec context
2961 * @return zero if successful, a negative value otherwise
2963 int (*end_frame)(AVCodecContext *avctx);
2966 * Size of HW accelerator private data.
2968 * Private data is allocated with av_mallocz() before
2969 * AVCodecContext.get_buffer() and deallocated after
2970 * AVCodecContext.release_buffer().
2976 * four components are given, that's all.
2977 * the last component is alpha
2979 typedef struct AVPicture {
2980 uint8_t *data[AV_NUM_DATA_POINTERS];
2981 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
2984 #define AVPALETTE_SIZE 1024
2985 #define AVPALETTE_COUNT 256
2987 enum AVSubtitleType {
2990 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2993 * Plain text, the text field must be set by the decoder and is
2994 * authoritative. ass and pict fields may contain approximations.
2999 * Formatted text, the ass field must be set by the decoder and is
3000 * authoritative. pict and text fields may contain approximations.
3005 typedef struct AVSubtitleRect {
3006 int x; ///< top left corner of pict, undefined when pict is not set
3007 int y; ///< top left corner of pict, undefined when pict is not set
3008 int w; ///< width of pict, undefined when pict is not set
3009 int h; ///< height of pict, undefined when pict is not set
3010 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3013 * data+linesize for the bitmap of this subtitle.
3014 * can be set for text/ass as well once they where rendered
3017 enum AVSubtitleType type;
3019 char *text; ///< 0 terminated plain UTF-8 text
3022 * 0 terminated ASS/SSA compatible event line.
3023 * The pressentation of this is unaffected by the other values in this
3029 typedef struct AVSubtitle {
3030 uint16_t format; /* 0 = graphics */
3031 uint32_t start_display_time; /* relative to packet pts, in ms */
3032 uint32_t end_display_time; /* relative to packet pts, in ms */
3034 AVSubtitleRect **rects;
3035 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3038 /* packet functions */
3041 * @deprecated use NULL instead
3043 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3046 * Default packet destructor.
3048 void av_destruct_packet(AVPacket *pkt);
3051 * Initialize optional fields of a packet with default values.
3055 void av_init_packet(AVPacket *pkt);
3058 * Allocate the payload of a packet and initialize its fields with
3062 * @param size wanted payload size
3063 * @return 0 if OK, AVERROR_xxx otherwise
3065 int av_new_packet(AVPacket *pkt, int size);
3068 * Reduce packet size, correctly zeroing padding
3071 * @param size new size
3073 void av_shrink_packet(AVPacket *pkt, int size);
3076 * Increase packet size, correctly zeroing padding
3079 * @param grow_by number of bytes by which to increase the size of the packet
3081 int av_grow_packet(AVPacket *pkt, int grow_by);
3084 * @warning This is a hack - the packet memory allocation stuff is broken. The
3085 * packet is allocated if it was not really allocated.
3087 int av_dup_packet(AVPacket *pkt);
3092 * @param pkt packet to free
3094 void av_free_packet(AVPacket *pkt);
3097 * Allocate new information of a packet.
3100 * @param type side information type
3101 * @param size side information size
3102 * @return pointer to fresh allocated data or NULL otherwise
3104 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3108 * Shrink the already allocated side data buffer
3111 * @param type side information type
3112 * @param size new side information size
3113 * @return 0 on success, < 0 on failure
3115 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3119 * Get side information from packet.
3122 * @param type desired side information type
3123 * @param size pointer for side information size to store (optional)
3124 * @return pointer to data if present or NULL otherwise
3126 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3131 struct ReSampleContext;
3132 struct AVResampleContext;
3134 typedef struct ReSampleContext ReSampleContext;
3137 * Initialize audio resampling context.
3139 * @param output_channels number of output channels
3140 * @param input_channels number of input channels
3141 * @param output_rate output sample rate
3142 * @param input_rate input sample rate
3143 * @param sample_fmt_out requested output sample format
3144 * @param sample_fmt_in input sample format
3145 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3146 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3147 * @param linear if 1 then the used FIR filter will be linearly interpolated
3148 between the 2 closest, if 0 the closest will be used
3149 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3150 * @return allocated ReSampleContext, NULL if error occurred
3152 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3153 int output_rate, int input_rate,
3154 enum AVSampleFormat sample_fmt_out,
3155 enum AVSampleFormat sample_fmt_in,
3156 int filter_length, int log2_phase_count,
3157 int linear, double cutoff);
3159 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3162 * Free resample context.
3164 * @param s a non-NULL pointer to a resample context previously
3165 * created with av_audio_resample_init()
3167 void audio_resample_close(ReSampleContext *s);
3171 * Initialize an audio resampler.
3172 * Note, if either rate is not an integer then simply scale both rates up so they are.
3173 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3174 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3175 * @param linear If 1 then the used FIR filter will be linearly interpolated
3176 between the 2 closest, if 0 the closest will be used
3177 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3179 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3182 * Resample an array of samples using a previously configured context.
3183 * @param src an array of unconsumed samples
3184 * @param consumed the number of samples of src which have been consumed are returned here
3185 * @param src_size the number of unconsumed samples available
3186 * @param dst_size the amount of space in samples available in dst
3187 * @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.
3188 * @return the number of samples written in dst or -1 if an error occurred
3190 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3194 * Compensate samplerate/timestamp drift. The compensation is done by changing
3195 * the resampler parameters, so no audible clicks or similar distortions occur
3196 * @param compensation_distance distance in output samples over which the compensation should be performed
3197 * @param sample_delta number of output samples which should be output less
3199 * example: av_resample_compensate(c, 10, 500)
3200 * here instead of 510 samples only 500 samples would be output
3202 * note, due to rounding the actual compensation might be slightly different,
3203 * especially if the compensation_distance is large and the in_rate used during init is small
3205 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3206 void av_resample_close(struct AVResampleContext *c);
3209 * Allocate memory for a picture. Call avpicture_free() to free it.
3211 * @see avpicture_fill()
3213 * @param picture the picture to be filled in
3214 * @param pix_fmt the format of the picture
3215 * @param width the width of the picture
3216 * @param height the height of the picture
3217 * @return zero if successful, a negative value if not
3219 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3222 * Free a picture previously allocated by avpicture_alloc().
3223 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3226 * @param picture the AVPicture to be freed
3228 void avpicture_free(AVPicture *picture);
3231 * Fill in the AVPicture fields.
3232 * The fields of the given AVPicture are filled in by using the 'ptr' address
3233 * which points to the image data buffer. Depending on the specified picture
3234 * format, one or multiple image data pointers and line sizes will be set.
3235 * If a planar format is specified, several pointers will be set pointing to
3236 * the different picture planes and the line sizes of the different planes
3237 * will be stored in the lines_sizes array.
3238 * Call with ptr == NULL to get the required size for the ptr buffer.
3240 * To allocate the buffer and fill in the AVPicture fields in one call,
3241 * use avpicture_alloc().
3243 * @param picture AVPicture whose fields are to be filled in
3244 * @param ptr Buffer which will contain or contains the actual image data
3245 * @param pix_fmt The format in which the picture data is stored.
3246 * @param width the width of the image in pixels
3247 * @param height the height of the image in pixels
3248 * @return size of the image data in bytes
3250 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3251 enum PixelFormat pix_fmt, int width, int height);
3254 * Copy pixel data from an AVPicture into a buffer.
3255 * The data is stored compactly, without any gaps for alignment or padding
3256 * which may be applied by avpicture_fill().
3258 * @see avpicture_get_size()
3260 * @param[in] src AVPicture containing image data
3261 * @param[in] pix_fmt The format in which the picture data is stored.
3262 * @param[in] width the width of the image in pixels.
3263 * @param[in] height the height of the image in pixels.
3264 * @param[out] dest A buffer into which picture data will be copied.
3265 * @param[in] dest_size The size of 'dest'.
3266 * @return The number of bytes written to dest, or a negative value (error code) on error.
3268 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3269 unsigned char *dest, int dest_size);
3272 * Calculate the size in bytes that a picture of the given width and height
3273 * would occupy if stored in the given picture format.
3274 * Note that this returns the size of a compact representation as generated
3275 * by avpicture_layout(), which can be smaller than the size required for e.g.
3278 * @param pix_fmt the given picture format
3279 * @param width the width of the image
3280 * @param height the height of the image
3281 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3283 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3284 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3286 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3289 * Return a value representing the fourCC code associated to the
3290 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3293 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3296 * Put a string representing the codec tag codec_tag in buf.
3298 * @param buf_size size in bytes of buf
3299 * @return the length of the string that would have been generated if
3300 * enough space had been available, excluding the trailing null
3302 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3304 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3305 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3306 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3307 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3308 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3309 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3312 * Compute what kind of losses will occur when converting from one specific
3313 * pixel format to another.
3314 * When converting from one pixel format to another, information loss may occur.
3315 * For example, when converting from RGB24 to GRAY, the color information will
3316 * be lost. Similarly, other losses occur when converting from some formats to
3317 * other formats. These losses can involve loss of chroma, but also loss of
3318 * resolution, loss of color depth, loss due to the color space conversion, loss
3319 * of the alpha bits or loss due to color quantization.
3320 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3321 * which will occur when converting from one pixel format to another.
3323 * @param[in] dst_pix_fmt destination pixel format
3324 * @param[in] src_pix_fmt source pixel format
3325 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3326 * @return Combination of flags informing you what kind of losses will occur.
3328 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3332 * Find the best pixel format to convert to given a certain source pixel
3333 * format. When converting from one pixel format to another, information loss
3334 * may occur. For example, when converting from RGB24 to GRAY, the color
3335 * information will be lost. Similarly, other losses occur when converting from
3336 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3337 * the given pixel formats should be used to suffer the least amount of loss.
3338 * The pixel formats from which it chooses one, are determined by the
3339 * pix_fmt_mask parameter.
3342 * src_pix_fmt = PIX_FMT_YUV420P;
3343 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3344 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3347 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3348 * @param[in] src_pix_fmt source pixel format
3349 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3350 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3351 * @return The best pixel format to convert to or -1 if none was found.
3353 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3354 int has_alpha, int *loss_ptr);
3356 /* deinterlace a picture */
3357 /* deinterlace - if not supported return -1 */
3358 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3359 enum PixelFormat pix_fmt, int width, int height);
3361 /* external high level API */
3364 * If c is NULL, returns the first registered codec,
3365 * if c is non-NULL, returns the next registered codec after c,
3366 * or NULL if c is the last one.
3368 AVCodec *av_codec_next(AVCodec *c);
3371 * Return the LIBAVCODEC_VERSION_INT constant.
3373 unsigned avcodec_version(void);
3376 * Return the libavcodec build-time configuration.
3378 const char *avcodec_configuration(void);
3381 * Return the libavcodec license.
3383 const char *avcodec_license(void);
3386 * Register the codec codec and initialize libavcodec.
3388 * @warning either this function or avcodec_register_all() must be called
3389 * before any other libavcodec functions.
3391 * @see avcodec_register_all()
3393 void avcodec_register(AVCodec *codec);
3396 * Find a registered encoder with a matching codec ID.
3398 * @param id CodecID of the requested encoder
3399 * @return An encoder if one was found, NULL otherwise.
3401 AVCodec *avcodec_find_encoder(enum CodecID id);
3404 * Find a registered encoder with the specified name.
3406 * @param name name of the requested encoder
3407 * @return An encoder if one was found, NULL otherwise.
3409 AVCodec *avcodec_find_encoder_by_name(const char *name);
3412 * Find a registered decoder with a matching codec ID.
3414 * @param id CodecID of the requested decoder
3415 * @return A decoder if one was found, NULL otherwise.
3417 AVCodec *avcodec_find_decoder(enum CodecID id);
3420 * Find a registered decoder with the specified name.
3422 * @param name name of the requested decoder
3423 * @return A decoder if one was found, NULL otherwise.
3425 AVCodec *avcodec_find_decoder_by_name(const char *name);
3426 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3429 * Return a name for the specified profile, if available.
3431 * @param codec the codec that is searched for the given profile
3432 * @param profile the profile value for which a name is requested
3433 * @return A name for the profile if found, NULL otherwise.
3435 const char *av_get_profile_name(const AVCodec *codec, int profile);
3438 * Set the fields of the given AVCodecContext to default values corresponding
3439 * to the given codec (defaults may be codec-dependent).
3441 * Do not call this function if a non-NULL codec has been passed
3442 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3443 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3444 * different codec on this AVCodecContext.
3446 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3449 * Allocate an AVCodecContext and set its fields to default values. The
3450 * resulting struct can be deallocated by calling avcodec_close() on it followed
3453 * @param codec if non-NULL, allocate private data and initialize defaults
3454 * for the given codec. It is illegal to then call avcodec_open2()
3455 * with a different codec.
3456 * If NULL, then the codec-specific defaults won't be initialized,
3457 * which may result in suboptimal default settings (this is
3458 * important mainly for encoders, e.g. libx264).
3460 * @return An AVCodecContext filled with default values or NULL on failure.
3461 * @see avcodec_get_context_defaults
3463 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3466 * Copy the settings of the source AVCodecContext into the destination
3467 * AVCodecContext. The resulting destination codec context will be
3468 * unopened, i.e. you are required to call avcodec_open2() before you
3469 * can use this AVCodecContext to decode/encode video/audio data.
3471 * @param dest target codec context, should be initialized with
3472 * avcodec_alloc_context3(), but otherwise uninitialized
3473 * @param src source codec context
3474 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3476 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3479 * Set the fields of the given AVFrame to default values.
3481 * @param pic The AVFrame of which the fields should be set to default values.
3483 void avcodec_get_frame_defaults(AVFrame *pic);
3486 * Allocate an AVFrame and set its fields to default values. The resulting
3487 * struct can be deallocated by simply calling av_free().
3489 * @return An AVFrame filled with default values or NULL on failure.
3490 * @see avcodec_get_frame_defaults
3492 AVFrame *avcodec_alloc_frame(void);
3494 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3495 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3496 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3499 * Return the amount of padding in pixels which the get_buffer callback must
3500 * provide around the edge of the image for codecs which do not have the
3501 * CODEC_FLAG_EMU_EDGE flag.
3503 * @return Required padding in pixels.
3505 unsigned avcodec_get_edge_width(void);
3507 * Modify width and height values so that they will result in a memory
3508 * buffer that is acceptable for the codec if you do not use any horizontal
3511 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3512 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3513 * according to avcodec_get_edge_width() before.
3515 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3517 * Modify width and height values so that they will result in a memory
3518 * buffer that is acceptable for the codec if you also ensure that all
3519 * line sizes are a multiple of the respective linesize_align[i].
3521 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3522 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3523 * according to avcodec_get_edge_width() before.
3525 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3526 int linesize_align[AV_NUM_DATA_POINTERS]);
3528 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3530 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3531 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3532 //FIXME func typedef
3535 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3536 * function the context has to be allocated with avcodec_alloc_context3().
3538 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3539 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3540 * retrieving a codec.
3542 * @warning This function is not thread safe!
3545 * avcodec_register_all();
3546 * av_dict_set(&opts, "b", "2.5M", 0);
3547 * codec = avcodec_find_decoder(CODEC_ID_H264);
3551 * context = avcodec_alloc_context3(codec);
3553 * if (avcodec_open2(context, codec, opts) < 0)
3557 * @param avctx The context to initialize.
3558 * @param codec The codec to open this context for. If a non-NULL codec has been
3559 * previously passed to avcodec_alloc_context3() or
3560 * avcodec_get_context_defaults3() for this context, then this
3561 * parameter MUST be either NULL or equal to the previously passed
3563 * @param options A dictionary filled with AVCodecContext and codec-private options.
3564 * On return this object will be filled with options that were not found.
3566 * @return zero on success, a negative value on error
3567 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3568 * av_dict_set(), av_opt_find().
3570 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3572 #if FF_API_OLD_DECODE_AUDIO
3574 * Wrapper function which calls avcodec_decode_audio4.
3576 * @deprecated Use avcodec_decode_audio4 instead.
3578 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
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_audio3 has to be called again with an AVPacket that contains
3582 * the remaining data in order to decode the second frame etc.
3584 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3585 * decompressed frame size in bytes.
3587 * @warning You must set frame_size_ptr to the allocated size of the
3588 * output buffer before calling avcodec_decode_audio3().
3590 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3591 * the actual read bytes because some optimized bitstream readers read 32 or 64
3592 * bits at once and could read over the end.
3594 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3595 * no overreading happens for damaged MPEG streams.
3597 * @warning You must not provide a custom get_buffer() when using
3598 * avcodec_decode_audio3(). Doing so will override it with
3599 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3600 * which does allow the application to provide a custom get_buffer().
3602 * @note You might have to align the input buffer avpkt->data and output buffer
3603 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3604 * necessary at all, on others it won't work at all if not aligned and on others
3605 * it will work but it will have an impact on performance.
3607 * In practice, avpkt->data should have 4 byte alignment at minimum and
3608 * samples should be 16 byte aligned unless the CPU doesn't need it
3609 * (AltiVec and SSE do).
3611 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3612 * between input and output, these need to be fed with avpkt->data=NULL,
3613 * avpkt->size=0 at the end to return the remaining frames.
3615 * @param avctx the codec context
3616 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3617 * If the sample format is planar, each channel plane will
3618 * be the same size, with no padding between channels.
3619 * @param[in,out] frame_size_ptr the output buffer size in bytes
3620 * @param[in] avpkt The input AVPacket containing the input buffer.
3621 * You can create such packet with av_init_packet() and by then setting
3622 * data and size, some decoders might in addition need other fields.
3623 * All decoders are designed to use the least fields possible though.
3624 * @return On error a negative value is returned, otherwise the number of bytes
3625 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3627 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3628 int *frame_size_ptr,
3633 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3635 * Some decoders may support multiple frames in a single AVPacket. Such
3636 * decoders would then just decode the first frame. In this case,
3637 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3638 * the remaining data in order to decode the second frame, etc...
3639 * Even if no frames are returned, the packet needs to be fed to the decoder
3640 * with remaining data until it is completely consumed or an error occurs.
3642 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3643 * larger than the actual read bytes because some optimized bitstream
3644 * readers read 32 or 64 bits at once and could read over the end.
3646 * @note You might have to align the input buffer. The alignment requirements
3647 * depend on the CPU and the decoder.
3649 * @param avctx the codec context
3650 * @param[out] frame The AVFrame in which to store decoded audio samples.
3651 * Decoders request a buffer of a particular size by setting
3652 * AVFrame.nb_samples prior to calling get_buffer(). The
3653 * decoder may, however, only utilize part of the buffer by
3654 * setting AVFrame.nb_samples to a smaller value in the
3656 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3658 * @param[in] avpkt The input AVPacket containing the input buffer.
3659 * At least avpkt->data and avpkt->size should be set. Some
3660 * decoders might also require additional fields to be set.
3661 * @return A negative error code is returned if an error occurred during
3662 * decoding, otherwise the number of bytes consumed from the input
3663 * AVPacket is returned.
3665 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3666 int *got_frame_ptr, AVPacket *avpkt);
3669 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3670 * Some decoders may support multiple frames in a single AVPacket, such
3671 * decoders would then just decode the first frame.
3673 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3674 * the actual read bytes because some optimized bitstream readers read 32 or 64
3675 * bits at once and could read over the end.
3677 * @warning The end of the input buffer buf should be set to 0 to ensure that
3678 * no overreading happens for damaged MPEG streams.
3680 * @note You might have to align the input buffer avpkt->data.
3681 * The alignment requirements depend on the CPU: on some CPUs it isn't
3682 * necessary at all, on others it won't work at all if not aligned and on others
3683 * it will work but it will have an impact on performance.
3685 * In practice, avpkt->data should have 4 byte alignment at minimum.
3687 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3688 * between input and output, these need to be fed with avpkt->data=NULL,
3689 * avpkt->size=0 at the end to return the remaining frames.
3691 * @param avctx the codec context
3692 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3693 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3694 * allocate memory for the actual bitmap.
3695 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3696 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3697 * decodes and the decoder tells the user once it does not need the data anymore,
3698 * the user app can at this point free/reuse/keep the memory as it sees fit.
3700 * @param[in] avpkt The input AVpacket containing the input buffer.
3701 * You can create such packet with av_init_packet() and by then setting
3702 * data and size, some decoders might in addition need other fields like
3703 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3705 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3706 * @return On error a negative value is returned, otherwise the number of bytes
3707 * used or zero if no frame could be decompressed.
3709 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3710 int *got_picture_ptr,
3714 * Decode a subtitle message.
3715 * Return a negative value on error, otherwise return the number of bytes used.
3716 * If no subtitle could be decompressed, got_sub_ptr is zero.
3717 * Otherwise, the subtitle is stored in *sub.
3718 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3719 * simplicity, because the performance difference is expect to be negligible
3720 * and reusing a get_buffer written for video codecs would probably perform badly
3721 * due to a potentially very different allocation pattern.
3723 * @param avctx the codec context
3724 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3725 freed with avsubtitle_free if *got_sub_ptr is set.
3726 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3727 * @param[in] avpkt The input AVPacket containing the input buffer.
3729 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3734 * Free all allocated data in the given subtitle struct.
3736 * @param sub AVSubtitle to free.
3738 void avsubtitle_free(AVSubtitle *sub);
3740 #if FF_API_OLD_ENCODE_AUDIO
3742 * Encode an audio frame from samples into buf.
3744 * @deprecated Use avcodec_encode_audio2 instead.
3746 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3747 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3748 * will know how much space is needed because it depends on the value passed
3749 * in buf_size as described below. In that case a lower value can be used.
3751 * @param avctx the codec context
3752 * @param[out] buf the output buffer
3753 * @param[in] buf_size the output buffer size
3754 * @param[in] samples the input buffer containing the samples
3755 * The number of samples read from this buffer is frame_size*channels,
3756 * both of which are defined in avctx.
3757 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3758 * samples read from samples is equal to:
3759 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3760 * This also implies that av_get_bits_per_sample() must not return 0 for these
3762 * @return On error a negative value is returned, on success zero or the number
3763 * of bytes used to encode the data read from the input buffer.
3765 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3766 uint8_t *buf, int buf_size,
3767 const short *samples);
3771 * Encode a frame of audio.
3773 * Takes input samples from frame and writes the next output packet, if
3774 * available, to avpkt. The output packet does not necessarily contain data for
3775 * the most recent frame, as encoders can delay, split, and combine input frames
3776 * internally as needed.
3778 * @param avctx codec context
3779 * @param avpkt output AVPacket.
3780 * The user can supply an output buffer by setting
3781 * avpkt->data and avpkt->size prior to calling the
3782 * function, but if the size of the user-provided data is not
3783 * large enough, encoding will fail. All other AVPacket fields
3784 * will be reset by the encoder using av_init_packet(). If
3785 * avpkt->data is NULL, the encoder will allocate it.
3786 * The encoder will set avpkt->size to the size of the
3789 * If this function fails or produces no output, avpkt will be
3790 * freed using av_free_packet() (i.e. avpkt->destruct will be
3791 * called to free the user supplied buffer).
3792 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3793 * May be NULL when flushing an encoder that has the
3794 * CODEC_CAP_DELAY capability set.
3795 * There are 2 codec capabilities that affect the allowed
3796 * values of frame->nb_samples.
3797 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
3798 * frame may be smaller than avctx->frame_size, and all other
3799 * frames must be equal to avctx->frame_size.
3800 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3801 * can have any number of samples.
3802 * If neither is set, frame->nb_samples must be equal to
3803 * avctx->frame_size for all frames.
3804 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3805 * output packet is non-empty, and to 0 if it is
3806 * empty. If the function returns an error, the
3807 * packet can be assumed to be invalid, and the
3808 * value of got_packet_ptr is undefined and should
3810 * @return 0 on success, negative error code on failure
3812 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3813 const AVFrame *frame, int *got_packet_ptr);
3816 * Fill audio frame data and linesize.
3817 * AVFrame extended_data channel pointers are allocated if necessary for
3820 * @param frame the AVFrame
3821 * frame->nb_samples must be set prior to calling the
3822 * function. This function fills in frame->data,
3823 * frame->extended_data, frame->linesize[0].
3824 * @param nb_channels channel count
3825 * @param sample_fmt sample format
3826 * @param buf buffer to use for frame data
3827 * @param buf_size size of buffer
3828 * @param align plane size sample alignment
3829 * @return 0 on success, negative error code on failure
3831 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
3832 enum AVSampleFormat sample_fmt, const uint8_t *buf,
3833 int buf_size, int align);
3835 #if FF_API_OLD_ENCODE_VIDEO
3837 * @deprecated use avcodec_encode_video2() instead.
3839 * Encode a video frame from pict into buf.
3840 * The input picture should be
3841 * stored using a specific format, namely avctx.pix_fmt.
3843 * @param avctx the codec context
3844 * @param[out] buf the output buffer for the bitstream of encoded frame
3845 * @param[in] buf_size the size of the output buffer in bytes
3846 * @param[in] pict the input picture to encode
3847 * @return On error a negative value is returned, on success zero or the number
3848 * of bytes used from the output buffer.
3850 attribute_deprecated
3851 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3852 const AVFrame *pict);
3856 * Encode a frame of video.
3858 * Takes input raw video data from frame and writes the next output packet, if
3859 * available, to avpkt. The output packet does not necessarily contain data for
3860 * the most recent frame, as encoders can delay and reorder input frames
3861 * internally as needed.
3863 * @param avctx codec context
3864 * @param avpkt output AVPacket.
3865 * The user can supply an output buffer by setting
3866 * avpkt->data and avpkt->size prior to calling the
3867 * function, but if the size of the user-provided data is not
3868 * large enough, encoding will fail. All other AVPacket fields
3869 * will be reset by the encoder using av_init_packet(). If
3870 * avpkt->data is NULL, the encoder will allocate it.
3871 * The encoder will set avpkt->size to the size of the
3872 * output packet. The returned data (if any) belongs to the
3873 * caller, he is responsible for freeing it.
3875 * If this function fails or produces no output, avpkt will be
3876 * freed using av_free_packet() (i.e. avpkt->destruct will be
3877 * called to free the user supplied buffer).
3878 * @param[in] frame AVFrame containing the raw video data to be encoded.
3879 * May be NULL when flushing an encoder that has the
3880 * CODEC_CAP_DELAY capability set.
3881 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3882 * output packet is non-empty, and to 0 if it is
3883 * empty. If the function returns an error, the
3884 * packet can be assumed to be invalid, and the
3885 * value of got_packet_ptr is undefined and should
3887 * @return 0 on success, negative error code on failure
3889 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3890 const AVFrame *frame, int *got_packet_ptr);
3892 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3893 const AVSubtitle *sub);
3896 * Close a given AVCodecContext and free all the data associated with it
3897 * (but not the AVCodecContext itself).
3899 * Calling this function on an AVCodecContext that hasn't been opened will free
3900 * the codec-specific data allocated in avcodec_alloc_context3() /
3901 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3904 int avcodec_close(AVCodecContext *avctx);
3907 * Register all the codecs, parsers and bitstream filters which were enabled at
3908 * configuration time. If you do not call this function you can select exactly
3909 * which formats you want to support, by using the individual registration
3912 * @see avcodec_register
3913 * @see av_register_codec_parser
3914 * @see av_register_bitstream_filter
3916 void avcodec_register_all(void);
3919 * Flush buffers, should be called when seeking or when switching to a different stream.
3921 void avcodec_flush_buffers(AVCodecContext *avctx);
3923 void avcodec_default_free_buffers(AVCodecContext *s);
3925 /* misc useful functions */
3928 * Return codec bits per sample.
3930 * @param[in] codec_id the codec
3931 * @return Number of bits per sample or zero if unknown for the given codec.
3933 int av_get_bits_per_sample(enum CodecID codec_id);
3936 typedef struct AVCodecParserContext {
3938 struct AVCodecParser *parser;
3939 int64_t frame_offset; /* offset of the current frame */
3940 int64_t cur_offset; /* current offset
3941 (incremented by each av_parser_parse()) */
3942 int64_t next_frame_offset; /* offset of the next frame */
3944 int pict_type; /* XXX: Put it back in AVCodecContext. */
3946 * This field is used for proper frame duration computation in lavf.
3947 * It signals, how much longer the frame duration of the current frame
3948 * is compared to normal frame duration.
3950 * frame_duration = (1 + repeat_pict) * time_base
3952 * It is used by codecs like H.264 to display telecined material.
3954 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3955 int64_t pts; /* pts of the current frame */
3956 int64_t dts; /* dts of the current frame */
3961 int fetch_timestamp;
3963 #define AV_PARSER_PTS_NB 4
3964 int cur_frame_start_index;
3965 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3966 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3967 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3970 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3971 #define PARSER_FLAG_ONCE 0x0002
3972 /// Set if the parser has a valid file offset
3973 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3975 int64_t offset; ///< byte offset from starting packet start
3976 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3979 * Set by parser to 1 for key frames and 0 for non-key frames.
3980 * It is initialized to -1, so if the parser doesn't set this flag,
3981 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3987 * Time difference in stream time base units from the pts of this
3988 * packet to the point at which the output from the decoder has converged
3989 * independent from the availability of previous frames. That is, the
3990 * frames are virtually identical no matter if decoding started from
3991 * the very first frame or from this keyframe.
3992 * Is AV_NOPTS_VALUE if unknown.
3993 * This field is not the display duration of the current frame.
3994 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3997 * The purpose of this field is to allow seeking in streams that have no
3998 * keyframes in the conventional sense. It corresponds to the
3999 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4000 * essential for some types of subtitle streams to ensure that all
4001 * subtitles are correctly displayed after seeking.
4003 int64_t convergence_duration;
4005 // Timestamp generation support:
4007 * Synchronization point for start of timestamp generation.
4009 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4012 * For example, this corresponds to presence of H.264 buffering period
4018 * Offset of the current timestamp against last timestamp sync point in
4019 * units of AVCodecContext.time_base.
4021 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4022 * contain a valid timestamp offset.
4024 * Note that the timestamp of sync point has usually a nonzero
4025 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4026 * the next frame after timestamp sync point will be usually 1.
4028 * For example, this corresponds to H.264 cpb_removal_delay.
4030 int dts_ref_dts_delta;
4033 * Presentation delay of current frame in units of AVCodecContext.time_base.
4035 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4036 * contain valid non-negative timestamp delta (presentation time of a frame
4037 * must not lie in the past).
4039 * This delay represents the difference between decoding and presentation
4040 * time of the frame.
4042 * For example, this corresponds to H.264 dpb_output_delay.
4047 * Position of the packet in file.
4049 * Analogous to cur_frame_pts/dts
4051 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4054 * Byte position of currently parsed frame in stream.
4059 * Previous frame byte position.
4064 * Duration of the current frame.
4065 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4066 * For all other types, this is in units of AVCodecContext.time_base.
4069 } AVCodecParserContext;
4071 typedef struct AVCodecParser {
4072 int codec_ids[5]; /* several codec IDs are permitted */
4074 int (*parser_init)(AVCodecParserContext *s);
4075 int (*parser_parse)(AVCodecParserContext *s,
4076 AVCodecContext *avctx,
4077 const uint8_t **poutbuf, int *poutbuf_size,
4078 const uint8_t *buf, int buf_size);
4079 void (*parser_close)(AVCodecParserContext *s);
4080 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4081 struct AVCodecParser *next;
4084 AVCodecParser *av_parser_next(AVCodecParser *c);
4086 void av_register_codec_parser(AVCodecParser *parser);
4087 AVCodecParserContext *av_parser_init(int codec_id);
4092 * @param s parser context.
4093 * @param avctx codec context.
4094 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4095 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4096 * @param buf input buffer.
4097 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4098 * @param pts input presentation timestamp.
4099 * @param dts input decoding timestamp.
4100 * @param pos input byte position in stream.
4101 * @return the number of bytes of the input bitstream used.
4106 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4113 * decode_frame(data, size);
4117 int av_parser_parse2(AVCodecParserContext *s,
4118 AVCodecContext *avctx,
4119 uint8_t **poutbuf, int *poutbuf_size,
4120 const uint8_t *buf, int buf_size,
4121 int64_t pts, int64_t dts,
4124 int av_parser_change(AVCodecParserContext *s,
4125 AVCodecContext *avctx,
4126 uint8_t **poutbuf, int *poutbuf_size,
4127 const uint8_t *buf, int buf_size, int keyframe);
4128 void av_parser_close(AVCodecParserContext *s);
4131 typedef struct AVBitStreamFilterContext {
4133 struct AVBitStreamFilter *filter;
4134 AVCodecParserContext *parser;
4135 struct AVBitStreamFilterContext *next;
4136 } AVBitStreamFilterContext;
4139 typedef struct AVBitStreamFilter {
4142 int (*filter)(AVBitStreamFilterContext *bsfc,
4143 AVCodecContext *avctx, const char *args,
4144 uint8_t **poutbuf, int *poutbuf_size,
4145 const uint8_t *buf, int buf_size, int keyframe);
4146 void (*close)(AVBitStreamFilterContext *bsfc);
4147 struct AVBitStreamFilter *next;
4148 } AVBitStreamFilter;
4150 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4151 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4152 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4153 AVCodecContext *avctx, const char *args,
4154 uint8_t **poutbuf, int *poutbuf_size,
4155 const uint8_t *buf, int buf_size, int keyframe);
4156 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4158 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4163 * Reallocate the given block if it is not large enough, otherwise do nothing.
4167 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4170 * Allocate a buffer, reusing the given one if large enough.
4172 * Contrary to av_fast_realloc the current buffer contents might not be
4173 * preserved and on error the old buffer is freed, thus no special
4174 * handling to avoid memleaks is necessary.
4176 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4177 * @param size size of the buffer *ptr points to
4178 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4179 * *size 0 if an error occurred.
4181 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4184 * Allocate a buffer with padding, reusing the given one if large enough.
4186 * Same behaviour av_fast_malloc but the buffer has additional
4187 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4190 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4193 * Copy image src to dst. Wraps av_picture_data_copy() above.
4195 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4196 enum PixelFormat pix_fmt, int width, int height);
4199 * Crop image top and left side.
4201 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4202 enum PixelFormat pix_fmt, int top_band, int left_band);
4207 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4208 int padtop, int padbottom, int padleft, int padright, int *color);
4211 * Encode extradata length to a buffer. Used by xiph codecs.
4213 * @param s buffer to write to; must be at least (v/255+1) bytes long
4214 * @param v size of extradata in bytes
4215 * @return number of bytes written to the buffer.
4217 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4220 * Log a generic warning message about a missing feature. This function is
4221 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4222 * only, and would normally not be used by applications.
4223 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4224 * a pointer to an AVClass struct
4225 * @param[in] feature string containing the name of the missing feature
4226 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4227 * If want_sample is non-zero, additional verbage will be added to the log
4228 * message which tells the user how to report samples to the development
4231 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4234 * Log a generic warning message asking for a sample. This function is
4235 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4236 * only, and would normally not be used by applications.
4237 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4238 * a pointer to an AVClass struct
4239 * @param[in] msg string containing an optional message, or NULL if no message
4241 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4244 * Register the hardware accelerator hwaccel.
4246 void av_register_hwaccel(AVHWAccel *hwaccel);
4249 * If hwaccel is NULL, returns the first registered hardware accelerator,
4250 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4251 * after hwaccel, or NULL if hwaccel is the last one.
4253 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4257 * Lock operation used by lockmgr
4260 AV_LOCK_CREATE, ///< Create a mutex
4261 AV_LOCK_OBTAIN, ///< Lock the mutex
4262 AV_LOCK_RELEASE, ///< Unlock the mutex
4263 AV_LOCK_DESTROY, ///< Free mutex resources
4267 * Register a user provided lock manager supporting the operations
4268 * specified by AVLockOp. mutex points to a (void *) where the
4269 * lockmgr should store/get a pointer to a user allocated mutex. It's
4270 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4272 * @param cb User defined callback. Note: Libav may invoke calls to this
4273 * callback during the call to av_lockmgr_register().
4274 * Thus, the application must be prepared to handle that.
4275 * If cb is set to NULL the lockmgr will be unregistered.
4276 * Also note that during unregistration the previously registered
4277 * lockmgr callback may also be invoked.
4279 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4282 * Get the type of the given codec.
4284 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4287 * Get the AVClass for AVCodecContext. It can be used in combination with
4288 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4290 * @see av_opt_find().
4292 const AVClass *avcodec_get_class(void);
4295 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4296 * with no corresponding avcodec_close()), 0 otherwise.
4298 int avcodec_is_open(AVCodecContext *s);
4300 #endif /* AVCODEC_AVCODEC_H */