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,
250 /* various PCM "codecs" */
251 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
252 CODEC_ID_PCM_S16LE = 0x10000,
268 CODEC_ID_PCM_S24DAUD,
270 CODEC_ID_PCM_S16LE_PLANAR,
279 CODEC_ID_PCM_S8_PLANAR,
281 /* various ADPCM codecs */
282 CODEC_ID_ADPCM_IMA_QT = 0x11000,
283 CODEC_ID_ADPCM_IMA_WAV,
284 CODEC_ID_ADPCM_IMA_DK3,
285 CODEC_ID_ADPCM_IMA_DK4,
286 CODEC_ID_ADPCM_IMA_WS,
287 CODEC_ID_ADPCM_IMA_SMJPEG,
296 CODEC_ID_ADPCM_YAMAHA,
297 CODEC_ID_ADPCM_SBPRO_4,
298 CODEC_ID_ADPCM_SBPRO_3,
299 CODEC_ID_ADPCM_SBPRO_2,
301 CODEC_ID_ADPCM_IMA_AMV,
302 CODEC_ID_ADPCM_EA_R1,
303 CODEC_ID_ADPCM_EA_R3,
304 CODEC_ID_ADPCM_EA_R2,
305 CODEC_ID_ADPCM_IMA_EA_SEAD,
306 CODEC_ID_ADPCM_IMA_EA_EACS,
307 CODEC_ID_ADPCM_EA_XAS,
308 CODEC_ID_ADPCM_EA_MAXIS_XA,
309 CODEC_ID_ADPCM_IMA_ISS,
311 CODEC_ID_ADPCM_IMA_APC,
314 CODEC_ID_AMR_NB = 0x12000,
317 /* RealAudio codecs*/
318 CODEC_ID_RA_144 = 0x13000,
321 /* various DPCM codecs */
322 CODEC_ID_ROQ_DPCM = 0x14000,
323 CODEC_ID_INTERPLAY_DPCM,
328 CODEC_ID_MP2 = 0x15000,
329 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
345 CODEC_ID_WESTWOOD_SND1,
346 CODEC_ID_GSM, ///< as in Berlin toast format
354 CODEC_ID_DSICINAUDIO,
358 CODEC_ID_GSM_MS, /* as found in WAV */
367 CODEC_ID_WMALOSSLESS,
376 CODEC_ID_BINKAUDIO_RDFT,
377 CODEC_ID_BINKAUDIO_DCT,
388 /* subtitle codecs */
389 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
390 CODEC_ID_DVD_SUBTITLE = 0x17000,
391 CODEC_ID_DVB_SUBTITLE,
392 CODEC_ID_TEXT, ///< raw UTF-8 text
396 CODEC_ID_HDMV_PGS_SUBTITLE,
397 CODEC_ID_DVB_TELETEXT,
400 /* other specific kind of codecs (generally used for attachments) */
401 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
402 CODEC_ID_TTF = 0x18000,
404 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
406 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
407 * stream (only used by libavformat) */
408 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
409 * stream (only used by libavformat) */
410 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
413 #if FF_API_OLD_DECODE_AUDIO
415 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
419 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
420 * This is mainly needed because some optimized bitstream readers read
421 * 32 or 64 bit at once and could read over the end.<br>
422 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
423 * MPEG bitstreams could cause overread and segfault.
425 #define FF_INPUT_BUFFER_PADDING_SIZE 8
428 * minimum encoding buffer size
429 * Used to avoid some checks during header writing.
431 #define FF_MIN_BUFFER_SIZE 16384
435 * motion estimation type.
438 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
442 ME_EPZS, ///< enhanced predictive zonal search
443 ME_X1, ///< reserved for experiments
444 ME_HEX, ///< hexagon based search
445 ME_UMH, ///< uneven multi-hexagon search
446 ME_ITER, ///< iterative search
447 ME_TESA, ///< transformed exhaustive search algorithm
451 /* We leave some space between them for extensions (drop some
452 * keyframes for intra-only or drop just some bidir frames). */
453 AVDISCARD_NONE =-16, ///< discard nothing
454 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
455 AVDISCARD_NONREF = 8, ///< discard all non reference
456 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
457 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
458 AVDISCARD_ALL = 48, ///< discard all
461 enum AVColorPrimaries{
462 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
463 AVCOL_PRI_UNSPECIFIED=2,
465 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
466 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
467 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
469 AVCOL_PRI_NB , ///< Not part of ABI
472 enum AVColorTransferCharacteristic{
473 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
474 AVCOL_TRC_UNSPECIFIED=2,
475 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
476 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
477 AVCOL_TRC_NB , ///< Not part of ABI
482 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
483 AVCOL_SPC_UNSPECIFIED=2,
485 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
486 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
487 AVCOL_SPC_SMPTE240M =7,
488 AVCOL_SPC_NB , ///< Not part of ABI
492 AVCOL_RANGE_UNSPECIFIED=0,
493 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
494 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
495 AVCOL_RANGE_NB , ///< Not part of ABI
499 * X X 3 4 X X are luma samples,
500 * 1 2 1-6 are possible chroma positions
501 * X X 5 6 X 0 is undefined/unknown position
503 enum AVChromaLocation{
504 AVCHROMA_LOC_UNSPECIFIED=0,
505 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
506 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
507 AVCHROMA_LOC_TOPLEFT =3, ///< DV
509 AVCHROMA_LOC_BOTTOMLEFT =5,
510 AVCHROMA_LOC_BOTTOM =6,
511 AVCHROMA_LOC_NB , ///< Not part of ABI
514 enum AVAudioServiceType {
515 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
516 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
517 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
518 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
519 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
520 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
521 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
522 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
523 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
524 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
527 typedef struct RcOverride{
530 int qscale; // If this is 0 then quality_factor will be used instead.
531 float quality_factor;
534 #define FF_MAX_B_FRAMES 16
537 These flags can be passed in AVCodecContext.flags before initialization.
538 Note: Not everything is supported yet.
541 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
542 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
543 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
544 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
545 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
547 * The parent program guarantees that the input for B-frames containing
548 * streams is not written to for at least s->max_b_frames+1 frames, if
549 * this is not set the input will be copied.
551 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
552 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
553 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
554 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
555 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
556 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
557 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
558 location instead of only at frame boundaries. */
559 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
560 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
561 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
562 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
563 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
564 /* Fx : Flag for h263+ extra options */
565 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
566 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
567 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
568 #define CODEC_FLAG_CLOSED_GOP 0x80000000
569 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
570 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
571 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
572 #if FF_API_MPV_GLOBAL_OPTS
573 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
574 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
575 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
576 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
578 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
580 /* Unsupported options :
581 * Syntax Arithmetic coding (SAC)
582 * Reference Picture Selection
583 * Independent Segment Decoding */
585 /* codec capabilities */
587 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
589 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
590 * If not set, it might not use get_buffer() at all or use operations that
591 * assume the buffer was allocated by avcodec_default_get_buffer.
593 #define CODEC_CAP_DR1 0x0002
594 #define CODEC_CAP_TRUNCATED 0x0008
595 /* Codec can export data for HW decoding (XvMC). */
596 #define CODEC_CAP_HWACCEL 0x0010
598 * Encoder or decoder requires flushing with NULL input at the end in order to
599 * give the complete and correct output.
601 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
602 * with NULL data. The user can still send NULL data to the public encode
603 * or decode function, but libavcodec will not pass it along to the codec
604 * unless this flag is set.
607 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
608 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
612 * The encoder needs to be fed with NULL data at the end of encoding until the
613 * encoder no longer returns data.
615 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
616 * flag also means that the encoder must set the pts and duration for
617 * each output packet. If this flag is not set, the pts and duration will
618 * be determined by libavcodec from the input frame.
620 #define CODEC_CAP_DELAY 0x0020
622 * Codec can be fed a final frame with a smaller size.
623 * This can be used to prevent truncation of the last audio samples.
625 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
627 * Codec can export data for HW decoding (VDPAU).
629 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
631 * Codec can output multiple frames per AVPacket
632 * Normally demuxers return one frame at a time, demuxers which do not do
633 * are connected to a parser to split what they return into proper frames.
634 * This flag is reserved to the very rare category of codecs which have a
635 * bitstream that cannot be split into frames without timeconsuming
636 * operations like full decoding. Demuxers carring such bitstreams thus
637 * may return multiple frames in a packet. This has many disadvantages like
638 * prohibiting stream copy in many cases thus it should only be considered
641 #define CODEC_CAP_SUBFRAMES 0x0100
643 * Codec is experimental and is thus avoided in favor of non experimental
646 #define CODEC_CAP_EXPERIMENTAL 0x0200
648 * Codec should fill in channel configuration and samplerate instead of container
650 #define CODEC_CAP_CHANNEL_CONF 0x0400
652 * Codec is able to deal with negative linesizes
654 #define CODEC_CAP_NEG_LINESIZES 0x0800
656 * Codec supports frame-level multithreading.
658 #define CODEC_CAP_FRAME_THREADS 0x1000
660 * Codec supports slice-based (or partition-based) multithreading.
662 #define CODEC_CAP_SLICE_THREADS 0x2000
664 * Codec supports changed parameters at any point.
666 #define CODEC_CAP_PARAM_CHANGE 0x4000
668 * Codec supports avctx->thread_count == 0 (auto).
670 #define CODEC_CAP_AUTO_THREADS 0x8000
672 * Audio encoder supports receiving a different number of samples in each call.
674 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
676 //The following defines may change, don't expect compatibility if you use them.
677 #define MB_TYPE_INTRA4x4 0x0001
678 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
679 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
680 #define MB_TYPE_16x16 0x0008
681 #define MB_TYPE_16x8 0x0010
682 #define MB_TYPE_8x16 0x0020
683 #define MB_TYPE_8x8 0x0040
684 #define MB_TYPE_INTERLACED 0x0080
685 #define MB_TYPE_DIRECT2 0x0100 //FIXME
686 #define MB_TYPE_ACPRED 0x0200
687 #define MB_TYPE_GMC 0x0400
688 #define MB_TYPE_SKIP 0x0800
689 #define MB_TYPE_P0L0 0x1000
690 #define MB_TYPE_P1L0 0x2000
691 #define MB_TYPE_P0L1 0x4000
692 #define MB_TYPE_P1L1 0x8000
693 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
694 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
695 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
696 #define MB_TYPE_QUANT 0x00010000
697 #define MB_TYPE_CBP 0x00020000
698 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
702 * This specifies the area which should be displayed.
703 * Note there may be multiple such areas for one frame.
705 typedef struct AVPanScan{
708 * - encoding: Set by user.
709 * - decoding: Set by libavcodec.
714 * width and height in 1/16 pel
715 * - encoding: Set by user.
716 * - decoding: Set by libavcodec.
722 * position of the top left corner in 1/16 pel for up to 3 fields/frames
723 * - encoding: Set by user.
724 * - decoding: Set by libavcodec.
726 int16_t position[3][2];
729 #define FF_QSCALE_TYPE_MPEG1 0
730 #define FF_QSCALE_TYPE_MPEG2 1
731 #define FF_QSCALE_TYPE_H264 2
732 #define FF_QSCALE_TYPE_VP56 3
734 #define FF_BUFFER_TYPE_INTERNAL 1
735 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
736 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
737 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
739 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
740 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
741 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
742 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
744 enum AVPacketSideDataType {
746 AV_PKT_DATA_NEW_EXTRADATA,
747 AV_PKT_DATA_PARAM_CHANGE,
748 AV_PKT_DATA_H263_MB_INFO,
751 typedef struct AVPacket {
753 * Presentation timestamp in AVStream->time_base units; the time at which
754 * the decompressed packet will be presented to the user.
755 * Can be AV_NOPTS_VALUE if it is not stored in the file.
756 * pts MUST be larger or equal to dts as presentation cannot happen before
757 * decompression, unless one wants to view hex dumps. Some formats misuse
758 * the terms dts and pts/cts to mean something different. Such timestamps
759 * must be converted to true pts/dts before they are stored in AVPacket.
763 * Decompression timestamp in AVStream->time_base units; the time at which
764 * the packet is decompressed.
765 * Can be AV_NOPTS_VALUE if it is not stored in the file.
772 * A combination of AV_PKT_FLAG values
776 * Additional packet data that can be provided by the container.
777 * Packet can contain several types of side information.
782 enum AVPacketSideDataType type;
787 * Duration of this packet in AVStream->time_base units, 0 if unknown.
788 * Equals next_pts - this_pts in presentation order.
791 void (*destruct)(struct AVPacket *);
793 int64_t pos; ///< byte position in stream, -1 if unknown
796 * Time difference in AVStream->time_base units from the pts of this
797 * packet to the point at which the output from the decoder has converged
798 * independent from the availability of previous frames. That is, the
799 * frames are virtually identical no matter if decoding started from
800 * the very first frame or from this keyframe.
801 * Is AV_NOPTS_VALUE if unknown.
802 * This field is not the display duration of the current packet.
803 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
806 * The purpose of this field is to allow seeking in streams that have no
807 * keyframes in the conventional sense. It corresponds to the
808 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
809 * essential for some types of subtitle streams to ensure that all
810 * subtitles are correctly displayed after seeking.
812 int64_t convergence_duration;
814 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
815 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
818 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
820 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
821 * s32le channel_count
822 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
823 * u64le channel_layout
824 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
826 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
832 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
833 * structures with info about macroblocks relevant to splitting the
834 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
835 * That is, it does not necessarily contain info about all macroblocks,
836 * as long as the distance between macroblocks in the info is smaller
837 * than the target payload size.
838 * Each MB info structure is 12 bytes, and is laid out as follows:
839 * u32le bit offset from the start of the packet
840 * u8 current quantizer at the start of the macroblock
842 * u16le macroblock address within the GOB
843 * u8 horizontal MV predictor
844 * u8 vertical MV predictor
845 * u8 horizontal MV predictor for block number 3
846 * u8 vertical MV predictor for block number 3
849 enum AVSideDataParamChangeFlags {
850 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
851 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
852 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
853 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
858 * New fields can be added to the end of AVFRAME with minor version
859 * bumps. Removal, reordering and changes to existing fields require
860 * a major version bump.
861 * sizeof(AVFrame) must not be used outside libav*.
863 typedef struct AVFrame {
864 #define AV_NUM_DATA_POINTERS 8
866 * pointer to the picture/channel planes.
867 * This might be different from the first allocated byte
868 * - encoding: Set by user
869 * - decoding: set by AVCodecContext.get_buffer()
871 uint8_t *data[AV_NUM_DATA_POINTERS];
874 * Size, in bytes, of the data for each picture/channel plane.
876 * For audio, only linesize[0] may be set. For planar audio, each channel
877 * plane must be the same size.
879 * - encoding: Set by user
880 * - decoding: set by AVCodecContext.get_buffer()
882 int linesize[AV_NUM_DATA_POINTERS];
885 * pointers to the data planes/channels.
887 * For video, this should simply point to data[].
889 * For planar audio, each channel has a separate data pointer, and
890 * linesize[0] contains the size of each channel buffer.
891 * For packed audio, there is just one data pointer, and linesize[0]
892 * contains the total size of the buffer for all channels.
894 * Note: Both data and extended_data will always be set by get_buffer(),
895 * but for planar audio with more channels that can fit in data,
896 * extended_data must be used by the decoder in order to access all
900 * decoding: set by AVCodecContext.get_buffer()
902 uint8_t **extended_data;
905 * width and height of the video frame
907 * - decoding: Read by user.
912 * number of audio samples (per channel) described by this frame
913 * - encoding: Set by user
914 * - decoding: Set by libavcodec
919 * format of the frame, -1 if unknown or unset
920 * Values correspond to enum PixelFormat for video frames,
921 * enum AVSampleFormat for audio)
923 * - decoding: Read by user.
928 * 1 -> keyframe, 0-> not
929 * - encoding: Set by libavcodec.
930 * - decoding: Set by libavcodec.
935 * Picture type of the frame, see ?_TYPE below.
936 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
937 * - decoding: Set by libavcodec.
939 enum AVPictureType pict_type;
942 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
943 * This isn't used by libavcodec unless the default get/release_buffer() is used.
947 uint8_t *base[AV_NUM_DATA_POINTERS];
950 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
952 * - decoding: Read by user.
954 AVRational sample_aspect_ratio;
957 * presentation timestamp in time_base units (time when frame should be shown to user)
958 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
959 * - encoding: MUST be set by user.
960 * - decoding: Set by libavcodec.
965 * reordered pts from the last AVPacket that has been input into the decoder
967 * - decoding: Read by user.
972 * dts from the last AVPacket that has been input into the decoder
974 * - decoding: Read by user.
979 * picture number in bitstream order
981 * - decoding: Set by libavcodec.
983 int coded_picture_number;
985 * picture number in display order
987 * - decoding: Set by libavcodec.
989 int display_picture_number;
992 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
993 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
994 * - decoding: Set by libavcodec.
999 * is this picture used as reference
1000 * The values for this are the same as the MpegEncContext.picture_structure
1001 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1002 * Set to 4 for delayed, non-reference frames.
1003 * - encoding: unused
1004 * - decoding: Set by libavcodec. (before get_buffer() call)).
1010 * - encoding: unused
1011 * - decoding: Set by libavcodec.
1013 int8_t *qscale_table;
1016 * - encoding: unused
1017 * - decoding: Set by libavcodec.
1027 * mbskip_table[mb]>=1 if MB didn't change
1028 * stride= mb_width = (width+15)>>4
1029 * - encoding: unused
1030 * - decoding: Set by libavcodec.
1032 uint8_t *mbskip_table;
1035 * motion vector table
1038 * int mv_sample_log2= 4 - motion_subsample_log2;
1039 * int mb_width= (width+15)>>4;
1040 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1041 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1043 * - encoding: Set by user.
1044 * - decoding: Set by libavcodec.
1046 int16_t (*motion_val[2])[2];
1049 * macroblock type table
1050 * mb_type_base + mb_width + 2
1051 * - encoding: Set by user.
1052 * - decoding: Set by libavcodec.
1058 * - encoding: unused
1059 * - decoding: Set by libavcodec.
1064 * motion reference frame index
1065 * the order in which these are stored can depend on the codec.
1066 * - encoding: Set by user.
1067 * - decoding: Set by libavcodec.
1069 int8_t *ref_index[2];
1072 * for some private data of the user
1073 * - encoding: unused
1074 * - decoding: Set by user.
1080 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1081 * - decoding: unused
1083 uint64_t error[AV_NUM_DATA_POINTERS];
1086 * type of the buffer (to keep track of who has to deallocate data[*])
1087 * - encoding: Set by the one who allocates it.
1088 * - decoding: Set by the one who allocates it.
1089 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1094 * When decoding, this signals how much the picture must be delayed.
1095 * extra_delay = repeat_pict / (2*fps)
1096 * - encoding: unused
1097 * - decoding: Set by libavcodec.
1102 * The content of the picture is interlaced.
1103 * - encoding: Set by user.
1104 * - decoding: Set by libavcodec. (default 0)
1106 int interlaced_frame;
1109 * If the content is interlaced, is top field displayed first.
1110 * - encoding: Set by user.
1111 * - decoding: Set by libavcodec.
1113 int top_field_first;
1116 * Tell user application that palette has changed from previous frame.
1117 * - encoding: ??? (no palette-enabled encoder yet)
1118 * - decoding: Set by libavcodec. (default 0).
1120 int palette_has_changed;
1123 * codec suggestion on buffer type if != 0
1124 * - encoding: unused
1125 * - decoding: Set by libavcodec. (before get_buffer() call)).
1131 * - encoding: Set by user.
1132 * - decoding: Set by libavcodec.
1134 AVPanScan *pan_scan;
1137 * reordered opaque 64bit (generally an integer or a double precision float
1138 * PTS but can be anything).
1139 * The user sets AVCodecContext.reordered_opaque to represent the input at
1141 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1142 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1143 * @deprecated in favor of pkt_pts
1144 * - encoding: unused
1145 * - decoding: Read by user.
1147 int64_t reordered_opaque;
1150 * hardware accelerator private data (Libav-allocated)
1151 * - encoding: unused
1152 * - decoding: Set by libavcodec
1154 void *hwaccel_picture_private;
1157 * the AVCodecContext which ff_thread_get_buffer() was last called on
1158 * - encoding: Set by libavcodec.
1159 * - decoding: Set by libavcodec.
1161 struct AVCodecContext *owner;
1164 * used by multithreading to store frame-specific info
1165 * - encoding: Set by libavcodec.
1166 * - decoding: Set by libavcodec.
1168 void *thread_opaque;
1171 * log2 of the size of the block which a single vector in motion_val represents:
1172 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1173 * - encoding: unused
1174 * - decoding: Set by libavcodec.
1176 uint8_t motion_subsample_log2;
1179 struct AVCodecInternal;
1183 AV_FIELD_PROGRESSIVE,
1184 AV_FIELD_TT, //< Top coded_first, top displayed first
1185 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1186 AV_FIELD_TB, //< Top coded first, bottom displayed first
1187 AV_FIELD_BT, //< Bottom coded first, top displayed first
1191 * main external API structure.
1192 * New fields can be added to the end with minor version bumps.
1193 * Removal, reordering and changes to existing fields require a major
1195 * sizeof(AVCodecContext) must not be used outside libav*.
1197 typedef struct AVCodecContext {
1199 * information on struct for av_log
1200 * - set by avcodec_alloc_context3
1202 const AVClass *av_class;
1203 int log_level_offset;
1205 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1206 struct AVCodec *codec;
1207 char codec_name[32];
1208 enum CodecID codec_id; /* see CODEC_ID_xxx */
1211 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1212 * This is used to work around some encoder bugs.
1213 * A demuxer should set this to what is stored in the field used to identify the codec.
1214 * If there are multiple such fields in a container then the demuxer should choose the one
1215 * which maximizes the information about the used codec.
1216 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1217 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1218 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1220 * - encoding: Set by user, if not then the default based on codec_id will be used.
1221 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1223 unsigned int codec_tag;
1226 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1227 * This is used to work around some encoder bugs.
1228 * - encoding: unused
1229 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1231 unsigned int stream_codec_tag;
1235 * @deprecated this field is unused
1237 attribute_deprecated int sub_id;
1243 * Private context used for internal data.
1245 * Unlike priv_data, this is not codec-specific. It is used in general
1246 * libavcodec functions.
1248 struct AVCodecInternal *internal;
1251 * Private data of the user, can be used to carry app specific stuff.
1252 * - encoding: Set by user.
1253 * - decoding: Set by user.
1258 * the average bitrate
1259 * - encoding: Set by user; unused for constant quantizer encoding.
1260 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1265 * number of bits the bitstream is allowed to diverge from the reference.
1266 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1267 * - encoding: Set by user; unused for constant quantizer encoding.
1268 * - decoding: unused
1270 int bit_rate_tolerance;
1273 * Global quality for codecs which cannot change it per frame.
1274 * This should be proportional to MPEG-1/2/4 qscale.
1275 * - encoding: Set by user.
1276 * - decoding: unused
1281 * - encoding: Set by user.
1282 * - decoding: unused
1284 int compression_level;
1285 #define FF_COMPRESSION_DEFAULT -1
1289 * - encoding: Set by user.
1290 * - decoding: Set by user.
1296 * - encoding: Set by user.
1297 * - decoding: Set by user.
1302 * some codecs need / can use extradata like Huffman tables.
1303 * mjpeg: Huffman tables
1304 * rv10: additional flags
1305 * mpeg4: global headers (they can be in the bitstream or here)
1306 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1307 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1308 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1309 * - encoding: Set/allocated/freed by libavcodec.
1310 * - decoding: Set/allocated/freed by user.
1316 * This is the fundamental unit of time (in seconds) in terms
1317 * of which frame timestamps are represented. For fixed-fps content,
1318 * timebase should be 1/framerate and timestamp increments should be
1320 * - encoding: MUST be set by user.
1321 * - decoding: Set by libavcodec.
1323 AVRational time_base;
1326 * For some codecs, the time base is closer to the field rate than the frame rate.
1327 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1328 * if no telecine is used ...
1330 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1332 int ticks_per_frame;
1338 * Number of frames the decoded output will be delayed relative to the
1342 * Number of "priming" samples added to the beginning of the stream
1343 * during encoding. The decoded output will be delayed by this many
1344 * samples relative to the input to the encoder. Note that this field is
1345 * purely informational and does not directly affect the pts output by
1346 * the encoder, which should always be based on the actual presentation
1347 * time, including any delay.
1349 * - encoding: Set by libavcodec.
1350 * - decoding: unused
1357 * picture width / height.
1358 * - encoding: MUST be set by user.
1359 * - decoding: Set by libavcodec.
1360 * Note: For compatibility it is possible to set this instead of
1361 * coded_width/height before decoding.
1366 * Bitstream width / height, may be different from width/height if lowres enabled.
1367 * - encoding: unused
1368 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1370 int coded_width, coded_height;
1372 #define FF_ASPECT_EXTENDED 15
1375 * the number of pictures in a group of pictures, or 0 for intra_only
1376 * - encoding: Set by user.
1377 * - decoding: unused
1382 * Pixel format, see PIX_FMT_xxx.
1383 * May be set by the demuxer if known from headers.
1384 * May be overriden by the decoder if it knows better.
1385 * - encoding: Set by user.
1386 * - decoding: Set by user if known, overridden by libavcodec if known
1388 enum PixelFormat pix_fmt;
1391 * Motion estimation algorithm used for video coding.
1392 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1393 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1394 * - encoding: MUST be set by user.
1395 * - decoding: unused
1400 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1401 * decoder to draw a horizontal band. It improves cache usage. Not
1402 * all codecs can do that. You must check the codec capabilities
1404 * When multithreading is used, it may be called from multiple threads
1405 * at the same time; threads might draw different parts of the same AVFrame,
1406 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1408 * The function is also used by hardware acceleration APIs.
1409 * It is called at least once during frame decoding to pass
1410 * the data needed for hardware render.
1411 * In that mode instead of pixel data, AVFrame points to
1412 * a structure specific to the acceleration API. The application
1413 * reads the structure and can change some fields to indicate progress
1415 * - encoding: unused
1416 * - decoding: Set by user.
1417 * @param height the height of the slice
1418 * @param y the y position of the slice
1419 * @param type 1->top field, 2->bottom field, 3->frame
1420 * @param offset offset into the AVFrame.data from which the slice should be read
1422 void (*draw_horiz_band)(struct AVCodecContext *s,
1423 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1424 int y, int type, int height);
1427 * callback to negotiate the pixelFormat
1428 * @param fmt is the list of formats which are supported by the codec,
1429 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1430 * The first is always the native one.
1431 * @return the chosen format
1432 * - encoding: unused
1433 * - decoding: Set by user, if not set the native format will be chosen.
1435 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1438 * maximum number of B-frames between non-B-frames
1439 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1440 * - encoding: Set by user.
1441 * - decoding: unused
1446 * qscale factor between IP and B-frames
1447 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1448 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1449 * - encoding: Set by user.
1450 * - decoding: unused
1452 float b_quant_factor;
1454 /** obsolete FIXME remove */
1456 #define FF_RC_STRATEGY_XVID 1
1458 int b_frame_strategy;
1460 #if FF_API_MPV_GLOBAL_OPTS
1462 * luma single coefficient elimination threshold
1463 * - encoding: Set by user.
1464 * - decoding: unused
1466 attribute_deprecated int luma_elim_threshold;
1469 * chroma single coeff elimination threshold
1470 * - encoding: Set by user.
1471 * - decoding: unused
1473 attribute_deprecated int chroma_elim_threshold;
1477 * qscale offset between IP and B-frames
1478 * - encoding: Set by user.
1479 * - decoding: unused
1481 float b_quant_offset;
1484 * Size of the frame reordering buffer in the decoder.
1485 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1486 * - encoding: Set by libavcodec.
1487 * - decoding: Set by libavcodec.
1492 * 0-> h263 quant 1-> mpeg quant
1493 * - encoding: Set by user.
1494 * - decoding: unused
1499 * qscale factor between P and I-frames
1500 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1501 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1502 * - encoding: Set by user.
1503 * - decoding: unused
1505 float i_quant_factor;
1508 * qscale offset between P and I-frames
1509 * - encoding: Set by user.
1510 * - decoding: unused
1512 float i_quant_offset;
1515 * luminance masking (0-> disabled)
1516 * - encoding: Set by user.
1517 * - decoding: unused
1522 * temporary complexity masking (0-> disabled)
1523 * - encoding: Set by user.
1524 * - decoding: unused
1526 float temporal_cplx_masking;
1529 * spatial complexity masking (0-> disabled)
1530 * - encoding: Set by user.
1531 * - decoding: unused
1533 float spatial_cplx_masking;
1536 * p block masking (0-> disabled)
1537 * - encoding: Set by user.
1538 * - decoding: unused
1543 * darkness masking (0-> disabled)
1544 * - encoding: Set by user.
1545 * - decoding: unused
1551 * - encoding: Set by libavcodec.
1552 * - decoding: Set by user (or 0).
1556 * prediction method (needed for huffyuv)
1557 * - encoding: Set by user.
1558 * - decoding: unused
1560 int prediction_method;
1561 #define FF_PRED_LEFT 0
1562 #define FF_PRED_PLANE 1
1563 #define FF_PRED_MEDIAN 2
1566 * slice offsets in the frame in bytes
1567 * - encoding: Set/allocated by libavcodec.
1568 * - decoding: Set/allocated by user (or NULL).
1573 * sample aspect ratio (0 if unknown)
1574 * That is the width of a pixel divided by the height of the pixel.
1575 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1576 * - encoding: Set by user.
1577 * - decoding: Set by libavcodec.
1579 AVRational sample_aspect_ratio;
1582 * motion estimation comparison function
1583 * - encoding: Set by user.
1584 * - decoding: unused
1588 * subpixel motion estimation comparison function
1589 * - encoding: Set by user.
1590 * - decoding: unused
1594 * macroblock comparison function (not supported yet)
1595 * - encoding: Set by user.
1596 * - decoding: unused
1600 * interlaced DCT comparison function
1601 * - encoding: Set by user.
1602 * - decoding: unused
1605 #define FF_CMP_SAD 0
1606 #define FF_CMP_SSE 1
1607 #define FF_CMP_SATD 2
1608 #define FF_CMP_DCT 3
1609 #define FF_CMP_PSNR 4
1610 #define FF_CMP_BIT 5
1612 #define FF_CMP_ZERO 7
1613 #define FF_CMP_VSAD 8
1614 #define FF_CMP_VSSE 9
1615 #define FF_CMP_NSSE 10
1616 #define FF_CMP_W53 11
1617 #define FF_CMP_W97 12
1618 #define FF_CMP_DCTMAX 13
1619 #define FF_CMP_DCT264 14
1620 #define FF_CMP_CHROMA 256
1623 * ME diamond size & shape
1624 * - encoding: Set by user.
1625 * - decoding: unused
1630 * amount of previous MV predictors (2a+1 x 2a+1 square)
1631 * - encoding: Set by user.
1632 * - decoding: unused
1634 int last_predictor_count;
1637 * prepass for motion estimation
1638 * - encoding: Set by user.
1639 * - decoding: unused
1644 * motion estimation prepass comparison function
1645 * - encoding: Set by user.
1646 * - decoding: unused
1651 * ME prepass diamond size & shape
1652 * - encoding: Set by user.
1653 * - decoding: unused
1659 * - encoding: Set by user.
1660 * - decoding: unused
1662 int me_subpel_quality;
1665 * DTG active format information (additional aspect ratio
1666 * information only used in DVB MPEG-2 transport streams)
1669 * - encoding: unused
1670 * - decoding: Set by decoder.
1672 int dtg_active_format;
1673 #define FF_DTG_AFD_SAME 8
1674 #define FF_DTG_AFD_4_3 9
1675 #define FF_DTG_AFD_16_9 10
1676 #define FF_DTG_AFD_14_9 11
1677 #define FF_DTG_AFD_4_3_SP_14_9 13
1678 #define FF_DTG_AFD_16_9_SP_14_9 14
1679 #define FF_DTG_AFD_SP_4_3 15
1682 * maximum motion estimation search range in subpel units
1683 * If 0 then no limit.
1685 * - encoding: Set by user.
1686 * - decoding: unused
1691 * intra quantizer bias
1692 * - encoding: Set by user.
1693 * - decoding: unused
1695 int intra_quant_bias;
1696 #define FF_DEFAULT_QUANT_BIAS 999999
1699 * inter quantizer bias
1700 * - encoding: Set by user.
1701 * - decoding: unused
1703 int inter_quant_bias;
1705 #if FF_API_COLOR_TABLE_ID
1708 * - encoding: unused
1709 * - decoding: Which clrtable should be used for 8bit RGB images.
1710 * Tables have to be stored somewhere. FIXME
1712 attribute_deprecated int color_table_id;
1717 * - encoding: unused
1718 * - decoding: Set by user.
1721 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1722 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1723 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1726 * XVideo Motion Acceleration
1727 * - encoding: forbidden
1728 * - decoding: set by decoder
1730 int xvmc_acceleration;
1733 * macroblock decision mode
1734 * - encoding: Set by user.
1735 * - decoding: unused
1738 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1739 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1740 #define FF_MB_DECISION_RD 2 ///< rate distortion
1743 * custom intra quantization matrix
1744 * - encoding: Set by user, can be NULL.
1745 * - decoding: Set by libavcodec.
1747 uint16_t *intra_matrix;
1750 * custom inter quantization matrix
1751 * - encoding: Set by user, can be NULL.
1752 * - decoding: Set by libavcodec.
1754 uint16_t *inter_matrix;
1757 * scene change detection threshold
1758 * 0 is default, larger means fewer detected scene changes.
1759 * - encoding: Set by user.
1760 * - decoding: unused
1762 int scenechange_threshold;
1765 * noise reduction strength
1766 * - encoding: Set by user.
1767 * - decoding: unused
1769 int noise_reduction;
1771 #if FF_API_INTER_THRESHOLD
1773 * @deprecated this field is unused
1775 attribute_deprecated int inter_threshold;
1778 #if FF_API_MPV_GLOBAL_OPTS
1780 * @deprecated use mpegvideo private options instead
1782 attribute_deprecated int quantizer_noise_shaping;
1786 * Motion estimation threshold below which no motion estimation is
1787 * performed, but instead the user specified motion vectors are used.
1789 * - encoding: Set by user.
1790 * - decoding: unused
1795 * Macroblock threshold below which the user specified macroblock types will be used.
1796 * - encoding: Set by user.
1797 * - decoding: unused
1802 * precision of the intra DC coefficient - 8
1803 * - encoding: Set by user.
1804 * - decoding: unused
1806 int intra_dc_precision;
1809 * Number of macroblock rows at the top which are skipped.
1810 * - encoding: unused
1811 * - decoding: Set by user.
1816 * Number of macroblock rows at the bottom which are skipped.
1817 * - encoding: unused
1818 * - decoding: Set by user.
1823 * Border processing masking, raises the quantizer for mbs on the borders
1825 * - encoding: Set by user.
1826 * - decoding: unused
1828 float border_masking;
1831 * minimum MB lagrange multipler
1832 * - encoding: Set by user.
1833 * - decoding: unused
1838 * maximum MB lagrange multipler
1839 * - encoding: Set by user.
1840 * - decoding: unused
1846 * - encoding: Set by user.
1847 * - decoding: unused
1849 int me_penalty_compensation;
1853 * - encoding: Set by user.
1854 * - decoding: unused
1860 * - encoding: Set by user.
1861 * - decoding: unused
1867 * - encoding: Set by user.
1868 * - decoding: unused
1873 * number of reference frames
1874 * - encoding: Set by user.
1875 * - decoding: Set by lavc.
1880 * chroma qp offset from luma
1881 * - encoding: Set by user.
1882 * - decoding: unused
1887 * Multiplied by qscale for each frame and added to scene_change_score.
1888 * - encoding: Set by user.
1889 * - decoding: unused
1891 int scenechange_factor;
1895 * Note: Value depends upon the compare function used for fullpel ME.
1896 * - encoding: Set by user.
1897 * - decoding: unused
1902 * Adjust sensitivity of b_frame_strategy 1.
1903 * - encoding: Set by user.
1904 * - decoding: unused
1909 * Chromaticity coordinates of the source primaries.
1910 * - encoding: Set by user
1911 * - decoding: Set by libavcodec
1913 enum AVColorPrimaries color_primaries;
1916 * Color Transfer Characteristic.
1917 * - encoding: Set by user
1918 * - decoding: Set by libavcodec
1920 enum AVColorTransferCharacteristic color_trc;
1923 * YUV colorspace type.
1924 * - encoding: Set by user
1925 * - decoding: Set by libavcodec
1927 enum AVColorSpace colorspace;
1930 * MPEG vs JPEG YUV range.
1931 * - encoding: Set by user
1932 * - decoding: Set by libavcodec
1934 enum AVColorRange color_range;
1937 * This defines the location of chroma samples.
1938 * - encoding: Set by user
1939 * - decoding: Set by libavcodec
1941 enum AVChromaLocation chroma_sample_location;
1945 * Indicates number of picture subdivisions. Used for parallelized
1947 * - encoding: Set by user
1948 * - decoding: unused
1953 * - encoding: set by libavcodec
1954 * - decoding: Set by libavcodec
1956 enum AVFieldOrder field_order;
1959 int sample_rate; ///< samples per second
1960 int channels; ///< number of audio channels
1963 * audio sample format
1964 * - encoding: Set by user.
1965 * - decoding: Set by libavcodec.
1967 enum AVSampleFormat sample_fmt; ///< sample format
1969 /* The following data should not be initialized. */
1971 * Samples per packet, initialized when calling 'init'.
1976 * Frame counter, set by libavcodec.
1978 * - decoding: total number of frames returned from the decoder so far.
1979 * - encoding: total number of frames passed to the encoder so far.
1981 * @note the counter is not incremented if encoding/decoding resulted in
1987 * number of bytes per packet if constant and known or 0
1988 * Used by some WAV based audio codecs.
1993 * Audio cutoff bandwidth (0 means "automatic")
1994 * - encoding: Set by user.
1995 * - decoding: unused
1999 #if FF_API_REQUEST_CHANNELS
2001 * Decoder should decode to this many channels if it can (0 for default)
2002 * - encoding: unused
2003 * - decoding: Set by user.
2004 * @deprecated Deprecated in favor of request_channel_layout.
2006 int request_channels;
2010 * Audio channel layout.
2011 * - encoding: set by user.
2012 * - decoding: set by libavcodec.
2014 uint64_t channel_layout;
2017 * Request decoder to use this channel layout if it can (0 for default)
2018 * - encoding: unused
2019 * - decoding: Set by user.
2021 uint64_t request_channel_layout;
2024 * Type of service that the audio stream conveys.
2025 * - encoding: Set by user.
2026 * - decoding: Set by libavcodec.
2028 enum AVAudioServiceType audio_service_type;
2031 * Used to request a sample format from the decoder.
2032 * - encoding: unused.
2033 * - decoding: Set by user.
2035 enum AVSampleFormat request_sample_fmt;
2038 * Called at the beginning of each frame to get a buffer for it.
2040 * The function will set AVFrame.data[], AVFrame.linesize[].
2041 * AVFrame.extended_data[] must also be set, but it should be the same as
2042 * AVFrame.data[] except for planar audio with more channels than can fit
2043 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2044 * many data pointers as it can hold.
2046 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2047 * avcodec_default_get_buffer() instead of providing buffers allocated by
2050 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2051 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2052 * but if get_buffer() is overridden then alignment considerations should
2053 * be taken into account.
2055 * @see avcodec_default_get_buffer()
2059 * If pic.reference is set then the frame will be read later by libavcodec.
2060 * avcodec_align_dimensions2() should be used to find the required width and
2061 * height, as they normally need to be rounded up to the next multiple of 16.
2063 * If frame multithreading is used and thread_safe_callbacks is set,
2064 * it may be called from a different thread, but not from more than one at
2065 * once. Does not need to be reentrant.
2067 * @see release_buffer(), reget_buffer()
2068 * @see avcodec_align_dimensions2()
2072 * Decoders request a buffer of a particular size by setting
2073 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2074 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2075 * to a smaller value in the output frame.
2077 * Decoders cannot use the buffer after returning from
2078 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2079 * is assumed to be released immediately upon return.
2081 * As a convenience, av_samples_get_buffer_size() and
2082 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2083 * functions to find the required data size and to fill data pointers and
2084 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2085 * since all planes must be the same size.
2087 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2089 * - encoding: unused
2090 * - decoding: Set by libavcodec, user can override.
2092 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2095 * Called to release buffers which were allocated with get_buffer.
2096 * A released buffer can be reused in get_buffer().
2097 * pic.data[*] must be set to NULL.
2098 * May be called from a different thread if frame multithreading is used,
2099 * but not by more than one thread at once, so does not need to be reentrant.
2100 * - encoding: unused
2101 * - decoding: Set by libavcodec, user can override.
2103 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2106 * Called at the beginning of a frame to get cr buffer for it.
2107 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2108 * libavcodec will pass previous buffer in pic, function should return
2109 * same buffer or new buffer with old frame "painted" into it.
2110 * If pic.data[0] == NULL must behave like get_buffer().
2111 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2112 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2114 * - encoding: unused
2115 * - decoding: Set by libavcodec, user can override.
2117 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2120 /* - encoding parameters */
2121 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2122 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2126 * - encoding: Set by user.
2127 * - decoding: unused
2133 * - encoding: Set by user.
2134 * - decoding: unused
2139 * maximum quantizer difference between frames
2140 * - encoding: Set by user.
2141 * - decoding: unused
2146 * ratecontrol qmin qmax limiting method
2147 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2148 * - encoding: Set by user.
2149 * - decoding: unused
2157 * decoder bitstream buffer size
2158 * - encoding: Set by user.
2159 * - decoding: unused
2164 * ratecontrol override, see RcOverride
2165 * - encoding: Allocated/set/freed by user.
2166 * - decoding: unused
2168 int rc_override_count;
2169 RcOverride *rc_override;
2172 * rate control equation
2173 * - encoding: Set by user
2174 * - decoding: unused
2180 * - encoding: Set by user.
2181 * - decoding: unused
2187 * - encoding: Set by user.
2188 * - decoding: unused
2192 float rc_buffer_aggressivity;
2195 * initial complexity for pass1 ratecontrol
2196 * - encoding: Set by user.
2197 * - decoding: unused
2199 float rc_initial_cplx;
2202 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2203 * - encoding: Set by user.
2204 * - decoding: unused.
2206 float rc_max_available_vbv_use;
2209 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2210 * - encoding: Set by user.
2211 * - decoding: unused.
2213 float rc_min_vbv_overflow_use;
2216 * Number of bits which should be loaded into the rc buffer before decoding starts.
2217 * - encoding: Set by user.
2218 * - decoding: unused
2220 int rc_initial_buffer_occupancy;
2222 #define FF_CODER_TYPE_VLC 0
2223 #define FF_CODER_TYPE_AC 1
2224 #define FF_CODER_TYPE_RAW 2
2225 #define FF_CODER_TYPE_RLE 3
2226 #define FF_CODER_TYPE_DEFLATE 4
2229 * - encoding: Set by user.
2230 * - decoding: unused
2236 * - encoding: Set by user.
2237 * - decoding: unused
2242 * minimum Lagrange multipler
2243 * - encoding: Set by user.
2244 * - decoding: unused
2249 * maximum Lagrange multipler
2250 * - encoding: Set by user.
2251 * - decoding: unused
2256 * frame skip threshold
2257 * - encoding: Set by user.
2258 * - decoding: unused
2260 int frame_skip_threshold;
2264 * - encoding: Set by user.
2265 * - decoding: unused
2267 int frame_skip_factor;
2270 * frame skip exponent
2271 * - encoding: Set by user.
2272 * - decoding: unused
2277 * frame skip comparison function
2278 * - encoding: Set by user.
2279 * - decoding: unused
2284 * trellis RD quantization
2285 * - encoding: Set by user.
2286 * - decoding: unused
2291 * - encoding: Set by user.
2292 * - decoding: unused
2294 int min_prediction_order;
2297 * - encoding: Set by user.
2298 * - decoding: unused
2300 int max_prediction_order;
2303 * GOP timecode frame start number, in non drop frame format
2304 * - encoding: Set by user.
2305 * - decoding: unused
2307 int64_t timecode_frame_start;
2309 /* The RTP callback: This function is called */
2310 /* every time the encoder has a packet to send. */
2311 /* It depends on the encoder if the data starts */
2312 /* with a Start Code (it should). H.263 does. */
2313 /* mb_nb contains the number of macroblocks */
2314 /* encoded in the RTP payload. */
2315 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2317 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2318 /* do its best to deliver a chunk with size */
2319 /* below rtp_payload_size, the chunk will start */
2320 /* with a start code on some codecs like H.263. */
2321 /* This doesn't take account of any particular */
2322 /* headers inside the transmitted RTP payload. */
2324 /* statistics, used for 2-pass encoding */
2335 * number of bits used for the previously encoded frame
2336 * - encoding: Set by libavcodec.
2337 * - decoding: unused
2342 * pass1 encoding statistics output buffer
2343 * - encoding: Set by libavcodec.
2344 * - decoding: unused
2349 * pass2 encoding statistics input buffer
2350 * Concatenated stuff from stats_out of pass1 should be placed here.
2351 * - encoding: Allocated/set/freed by user.
2352 * - decoding: unused
2357 * Work around bugs in encoders which sometimes cannot be detected automatically.
2358 * - encoding: Set by user
2359 * - decoding: Set by user
2361 int workaround_bugs;
2362 #define FF_BUG_AUTODETECT 1 ///< autodetection
2363 #define FF_BUG_OLD_MSMPEG4 2
2364 #define FF_BUG_XVID_ILACE 4
2365 #define FF_BUG_UMP4 8
2366 #define FF_BUG_NO_PADDING 16
2367 #define FF_BUG_AMV 32
2368 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2369 #define FF_BUG_QPEL_CHROMA 64
2370 #define FF_BUG_STD_QPEL 128
2371 #define FF_BUG_QPEL_CHROMA2 256
2372 #define FF_BUG_DIRECT_BLOCKSIZE 512
2373 #define FF_BUG_EDGE 1024
2374 #define FF_BUG_HPEL_CHROMA 2048
2375 #define FF_BUG_DC_CLIP 4096
2376 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2377 #define FF_BUG_TRUNCATED 16384
2380 * strictly follow the standard (MPEG4, ...).
2381 * - encoding: Set by user.
2382 * - decoding: Set by user.
2383 * Setting this to STRICT or higher means the encoder and decoder will
2384 * generally do stupid things, whereas setting it to unofficial or lower
2385 * will mean the encoder might produce output that is not supported by all
2386 * spec-compliant decoders. Decoders don't differentiate between normal,
2387 * unofficial and experimental (that is, they always try to decode things
2388 * when they can) unless they are explicitly asked to behave stupidly
2389 * (=strictly conform to the specs)
2391 int strict_std_compliance;
2392 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2393 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2394 #define FF_COMPLIANCE_NORMAL 0
2395 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2396 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2399 * error concealment flags
2400 * - encoding: unused
2401 * - decoding: Set by user.
2403 int error_concealment;
2404 #define FF_EC_GUESS_MVS 1
2405 #define FF_EC_DEBLOCK 2
2409 * - encoding: Set by user.
2410 * - decoding: Set by user.
2413 #define FF_DEBUG_PICT_INFO 1
2414 #define FF_DEBUG_RC 2
2415 #define FF_DEBUG_BITSTREAM 4
2416 #define FF_DEBUG_MB_TYPE 8
2417 #define FF_DEBUG_QP 16
2418 #define FF_DEBUG_MV 32
2419 #define FF_DEBUG_DCT_COEFF 0x00000040
2420 #define FF_DEBUG_SKIP 0x00000080
2421 #define FF_DEBUG_STARTCODE 0x00000100
2422 #define FF_DEBUG_PTS 0x00000200
2423 #define FF_DEBUG_ER 0x00000400
2424 #define FF_DEBUG_MMCO 0x00000800
2425 #define FF_DEBUG_BUGS 0x00001000
2426 #define FF_DEBUG_VIS_QP 0x00002000
2427 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2428 #define FF_DEBUG_BUFFERS 0x00008000
2429 #define FF_DEBUG_THREADS 0x00010000
2433 * - encoding: Set by user.
2434 * - decoding: Set by user.
2437 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2438 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2439 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2442 * Error recognition; may misdetect some more or less valid parts as errors.
2443 * - encoding: unused
2444 * - decoding: Set by user.
2446 int err_recognition;
2447 #define AV_EF_CRCCHECK (1<<0)
2448 #define AV_EF_BITSTREAM (1<<1)
2449 #define AV_EF_BUFFER (1<<2)
2450 #define AV_EF_EXPLODE (1<<3)
2453 * opaque 64bit number (generally a PTS) that will be reordered and
2454 * output in AVFrame.reordered_opaque
2455 * @deprecated in favor of pkt_pts
2456 * - encoding: unused
2457 * - decoding: Set by user.
2459 int64_t reordered_opaque;
2462 * Hardware accelerator in use
2463 * - encoding: unused.
2464 * - decoding: Set by libavcodec
2466 struct AVHWAccel *hwaccel;
2469 * Hardware accelerator context.
2470 * For some hardware accelerators, a global context needs to be
2471 * provided by the user. In that case, this holds display-dependent
2472 * data Libav cannot instantiate itself. Please refer to the
2473 * Libav HW accelerator documentation to know how to fill this
2474 * is. e.g. for VA API, this is a struct vaapi_context.
2475 * - encoding: unused
2476 * - decoding: Set by user
2478 void *hwaccel_context;
2482 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2483 * - decoding: unused
2485 uint64_t error[AV_NUM_DATA_POINTERS];
2488 * DCT algorithm, see FF_DCT_* below
2489 * - encoding: Set by user.
2490 * - decoding: unused
2493 #define FF_DCT_AUTO 0
2494 #define FF_DCT_FASTINT 1
2495 #define FF_DCT_INT 2
2496 #define FF_DCT_MMX 3
2497 #define FF_DCT_ALTIVEC 5
2498 #define FF_DCT_FAAN 6
2501 * IDCT algorithm, see FF_IDCT_* below.
2502 * - encoding: Set by user.
2503 * - decoding: Set by user.
2506 #define FF_IDCT_AUTO 0
2507 #define FF_IDCT_INT 1
2508 #define FF_IDCT_SIMPLE 2
2509 #define FF_IDCT_SIMPLEMMX 3
2510 #define FF_IDCT_LIBMPEG2MMX 4
2511 #define FF_IDCT_MMI 5
2512 #define FF_IDCT_ARM 7
2513 #define FF_IDCT_ALTIVEC 8
2514 #define FF_IDCT_SH4 9
2515 #define FF_IDCT_SIMPLEARM 10
2516 #define FF_IDCT_H264 11
2517 #define FF_IDCT_VP3 12
2518 #define FF_IDCT_IPP 13
2519 #define FF_IDCT_XVIDMMX 14
2520 #define FF_IDCT_CAVS 15
2521 #define FF_IDCT_SIMPLEARMV5TE 16
2522 #define FF_IDCT_SIMPLEARMV6 17
2523 #define FF_IDCT_SIMPLEVIS 18
2524 #define FF_IDCT_WMV2 19
2525 #define FF_IDCT_FAAN 20
2526 #define FF_IDCT_EA 21
2527 #define FF_IDCT_SIMPLENEON 22
2528 #define FF_IDCT_SIMPLEALPHA 23
2529 #define FF_IDCT_BINK 24
2532 * dsp_mask could be add used to disable unwanted CPU features
2533 * CPU features (i.e. MMX, SSE. ...)
2535 * With the FORCE flag you may instead enable given CPU features.
2536 * (Dangerous: Usable in case of misdetection, improper usage however will
2537 * result into program crash.)
2542 * bits per sample/pixel from the demuxer (needed for huffyuv).
2543 * - encoding: Set by libavcodec.
2544 * - decoding: Set by user.
2546 int bits_per_coded_sample;
2549 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2550 * - encoding: set by user.
2551 * - decoding: set by libavcodec.
2553 int bits_per_raw_sample;
2556 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2557 * - encoding: unused
2558 * - decoding: Set by user.
2563 * the picture in the bitstream
2564 * - encoding: Set by libavcodec.
2565 * - decoding: Set by libavcodec.
2567 AVFrame *coded_frame;
2571 * is used to decide how many independent tasks should be passed to execute()
2572 * - encoding: Set by user.
2573 * - decoding: Set by user.
2578 * Which multithreading methods to use.
2579 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2580 * so clients which cannot provide future frames should not use it.
2582 * - encoding: Set by user, otherwise the default is used.
2583 * - decoding: Set by user, otherwise the default is used.
2586 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2587 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2590 * Which multithreading methods are in use by the codec.
2591 * - encoding: Set by libavcodec.
2592 * - decoding: Set by libavcodec.
2594 int active_thread_type;
2597 * Set by the client if its custom get_buffer() callback can be called
2598 * from another thread, which allows faster multithreaded decoding.
2599 * draw_horiz_band() will be called from other threads regardless of this setting.
2600 * Ignored if the default get_buffer() is used.
2601 * - encoding: Set by user.
2602 * - decoding: Set by user.
2604 int thread_safe_callbacks;
2607 * The codec may call this to execute several independent things.
2608 * It will return only after finishing all tasks.
2609 * The user may replace this with some multithreaded implementation,
2610 * the default implementation will execute the parts serially.
2611 * @param count the number of things to execute
2612 * - encoding: Set by libavcodec, user can override.
2613 * - decoding: Set by libavcodec, user can override.
2615 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2618 * The codec may call this to execute several independent things.
2619 * It will return only after finishing all tasks.
2620 * The user may replace this with some multithreaded implementation,
2621 * the default implementation will execute the parts serially.
2622 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2623 * @param c context passed also to func
2624 * @param count the number of things to execute
2625 * @param arg2 argument passed unchanged to func
2626 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2627 * @param func function that will be called count times, with jobnr from 0 to count-1.
2628 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2629 * two instances of func executing at the same time will have the same threadnr.
2630 * @return always 0 currently, but code should handle a future improvement where when any call to func
2631 * returns < 0 no further calls to func may be done and < 0 is returned.
2632 * - encoding: Set by libavcodec, user can override.
2633 * - decoding: Set by libavcodec, user can override.
2635 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2639 * Can be used by execute() to store some per AVCodecContext stuff.
2640 * - encoding: set by execute()
2641 * - decoding: set by execute()
2643 void *thread_opaque;
2646 * noise vs. sse weight for the nsse comparsion function
2647 * - encoding: Set by user.
2648 * - decoding: unused
2654 * - encoding: Set by user.
2655 * - decoding: Set by libavcodec.
2658 #define FF_PROFILE_UNKNOWN -99
2659 #define FF_PROFILE_RESERVED -100
2661 #define FF_PROFILE_AAC_MAIN 0
2662 #define FF_PROFILE_AAC_LOW 1
2663 #define FF_PROFILE_AAC_SSR 2
2664 #define FF_PROFILE_AAC_LTP 3
2666 #define FF_PROFILE_DTS 20
2667 #define FF_PROFILE_DTS_ES 30
2668 #define FF_PROFILE_DTS_96_24 40
2669 #define FF_PROFILE_DTS_HD_HRA 50
2670 #define FF_PROFILE_DTS_HD_MA 60
2672 #define FF_PROFILE_MPEG2_422 0
2673 #define FF_PROFILE_MPEG2_HIGH 1
2674 #define FF_PROFILE_MPEG2_SS 2
2675 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2676 #define FF_PROFILE_MPEG2_MAIN 4
2677 #define FF_PROFILE_MPEG2_SIMPLE 5
2679 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2680 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2682 #define FF_PROFILE_H264_BASELINE 66
2683 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2684 #define FF_PROFILE_H264_MAIN 77
2685 #define FF_PROFILE_H264_EXTENDED 88
2686 #define FF_PROFILE_H264_HIGH 100
2687 #define FF_PROFILE_H264_HIGH_10 110
2688 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2689 #define FF_PROFILE_H264_HIGH_422 122
2690 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2691 #define FF_PROFILE_H264_HIGH_444 144
2692 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2693 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2694 #define FF_PROFILE_H264_CAVLC_444 44
2696 #define FF_PROFILE_VC1_SIMPLE 0
2697 #define FF_PROFILE_VC1_MAIN 1
2698 #define FF_PROFILE_VC1_COMPLEX 2
2699 #define FF_PROFILE_VC1_ADVANCED 3
2701 #define FF_PROFILE_MPEG4_SIMPLE 0
2702 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2703 #define FF_PROFILE_MPEG4_CORE 2
2704 #define FF_PROFILE_MPEG4_MAIN 3
2705 #define FF_PROFILE_MPEG4_N_BIT 4
2706 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2707 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2708 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2709 #define FF_PROFILE_MPEG4_HYBRID 8
2710 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2711 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2712 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2713 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2714 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2715 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2716 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2720 * - encoding: Set by user.
2721 * - decoding: Set by libavcodec.
2724 #define FF_LEVEL_UNKNOWN -99
2728 * - encoding: unused
2729 * - decoding: Set by user.
2731 enum AVDiscard skip_loop_filter;
2735 * - encoding: unused
2736 * - decoding: Set by user.
2738 enum AVDiscard skip_idct;
2742 * - encoding: unused
2743 * - decoding: Set by user.
2745 enum AVDiscard skip_frame;
2748 * Header containing style information for text subtitles.
2749 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2750 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2751 * the Format line following. It shouldn't include any Dialogue line.
2752 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2753 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2755 uint8_t *subtitle_header;
2756 int subtitle_header_size;
2759 * Simulates errors in the bitstream to test error concealment.
2760 * - encoding: Set by user.
2761 * - decoding: unused
2766 * Current packet as passed into the decoder, to avoid having
2767 * to pass the packet into every function. Currently only valid
2768 * inside lavc and get/release_buffer callbacks.
2769 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2770 * - encoding: unused
2775 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2776 * Used for compliant TS muxing.
2777 * - encoding: Set by libavcodec.
2778 * - decoding: unused.
2786 typedef struct AVProfile {
2788 const char *name; ///< short name for the profile
2791 typedef struct AVCodecDefault AVCodecDefault;
2796 typedef struct AVCodec {
2798 * Name of the codec implementation.
2799 * The name is globally unique among encoders and among decoders (but an
2800 * encoder and a decoder can share the same name).
2801 * This is the primary way to find a codec from the user perspective.
2805 * Descriptive name for the codec, meant to be more human readable than name.
2806 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2808 const char *long_name;
2809 enum AVMediaType type;
2812 * Codec capabilities.
2816 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2817 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2818 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2819 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2820 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2821 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2822 const AVClass *priv_class; ///< AVClass for the private context
2823 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2825 /*****************************************************************
2826 * No fields below this line are part of the public API. They
2827 * may not be used outside of libavcodec and can be changed and
2829 * New public fields should be added right above.
2830 *****************************************************************
2833 struct AVCodec *next;
2835 * @name Frame-level threading support functions
2839 * If defined, called on thread contexts when they are created.
2840 * If the codec allocates writable tables in init(), re-allocate them here.
2841 * priv_data will be set to a copy of the original.
2843 int (*init_thread_copy)(AVCodecContext *);
2845 * Copy necessary context variables from a previous thread context to the current one.
2846 * If not defined, the next thread will start automatically; otherwise, the codec
2847 * must call ff_thread_finish_setup().
2849 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2851 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2855 * Private codec-specific defaults.
2857 const AVCodecDefault *defaults;
2860 * Initialize codec static data, called from avcodec_register().
2862 void (*init_static_data)(struct AVCodec *codec);
2864 int (*init)(AVCodecContext *);
2865 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2867 * Encode data to an AVPacket.
2869 * @param avctx codec context
2870 * @param avpkt output AVPacket (may contain a user-provided buffer)
2871 * @param[in] frame AVFrame containing the raw data to be encoded
2872 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2873 * non-empty packet was returned in avpkt.
2874 * @return 0 on success, negative error code on failure
2876 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2877 int *got_packet_ptr);
2878 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2879 int (*close)(AVCodecContext *);
2882 * Will be called when seeking
2884 void (*flush)(AVCodecContext *);
2890 typedef struct AVHWAccel {
2892 * Name of the hardware accelerated codec.
2893 * The name is globally unique among encoders and among decoders (but an
2894 * encoder and a decoder can share the same name).
2899 * Type of codec implemented by the hardware accelerator.
2901 * See AVMEDIA_TYPE_xxx
2903 enum AVMediaType type;
2906 * Codec implemented by the hardware accelerator.
2913 * Supported pixel format.
2915 * Only hardware accelerated formats are supported here.
2917 enum PixelFormat pix_fmt;
2920 * Hardware accelerated codec capabilities.
2921 * see FF_HWACCEL_CODEC_CAP_*
2925 struct AVHWAccel *next;
2928 * Called at the beginning of each frame or field picture.
2930 * Meaningful frame information (codec specific) is guaranteed to
2931 * be parsed at this point. This function is mandatory.
2933 * Note that buf can be NULL along with buf_size set to 0.
2934 * Otherwise, this means the whole frame is available at this point.
2936 * @param avctx the codec context
2937 * @param buf the frame data buffer base
2938 * @param buf_size the size of the frame in bytes
2939 * @return zero if successful, a negative value otherwise
2941 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2944 * Callback for each slice.
2946 * Meaningful slice information (codec specific) is guaranteed to
2947 * be parsed at this point. This function is mandatory.
2949 * @param avctx the codec context
2950 * @param buf the slice data buffer base
2951 * @param buf_size the size of the slice in bytes
2952 * @return zero if successful, a negative value otherwise
2954 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2957 * Called at the end of each frame or field picture.
2959 * The whole picture is parsed at this point and can now be sent
2960 * to the hardware accelerator. This function is mandatory.
2962 * @param avctx the codec context
2963 * @return zero if successful, a negative value otherwise
2965 int (*end_frame)(AVCodecContext *avctx);
2968 * Size of HW accelerator private data.
2970 * Private data is allocated with av_mallocz() before
2971 * AVCodecContext.get_buffer() and deallocated after
2972 * AVCodecContext.release_buffer().
2978 * four components are given, that's all.
2979 * the last component is alpha
2981 typedef struct AVPicture {
2982 uint8_t *data[AV_NUM_DATA_POINTERS];
2983 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
2986 #define AVPALETTE_SIZE 1024
2987 #define AVPALETTE_COUNT 256
2989 enum AVSubtitleType {
2992 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2995 * Plain text, the text field must be set by the decoder and is
2996 * authoritative. ass and pict fields may contain approximations.
3001 * Formatted text, the ass field must be set by the decoder and is
3002 * authoritative. pict and text fields may contain approximations.
3007 typedef struct AVSubtitleRect {
3008 int x; ///< top left corner of pict, undefined when pict is not set
3009 int y; ///< top left corner of pict, undefined when pict is not set
3010 int w; ///< width of pict, undefined when pict is not set
3011 int h; ///< height of pict, undefined when pict is not set
3012 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3015 * data+linesize for the bitmap of this subtitle.
3016 * can be set for text/ass as well once they where rendered
3019 enum AVSubtitleType type;
3021 char *text; ///< 0 terminated plain UTF-8 text
3024 * 0 terminated ASS/SSA compatible event line.
3025 * The pressentation of this is unaffected by the other values in this
3031 typedef struct AVSubtitle {
3032 uint16_t format; /* 0 = graphics */
3033 uint32_t start_display_time; /* relative to packet pts, in ms */
3034 uint32_t end_display_time; /* relative to packet pts, in ms */
3036 AVSubtitleRect **rects;
3037 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3040 /* packet functions */
3043 * @deprecated use NULL instead
3045 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3048 * Default packet destructor.
3050 void av_destruct_packet(AVPacket *pkt);
3053 * Initialize optional fields of a packet with default values.
3057 void av_init_packet(AVPacket *pkt);
3060 * Allocate the payload of a packet and initialize its fields with
3064 * @param size wanted payload size
3065 * @return 0 if OK, AVERROR_xxx otherwise
3067 int av_new_packet(AVPacket *pkt, int size);
3070 * Reduce packet size, correctly zeroing padding
3073 * @param size new size
3075 void av_shrink_packet(AVPacket *pkt, int size);
3078 * Increase packet size, correctly zeroing padding
3081 * @param grow_by number of bytes by which to increase the size of the packet
3083 int av_grow_packet(AVPacket *pkt, int grow_by);
3086 * @warning This is a hack - the packet memory allocation stuff is broken. The
3087 * packet is allocated if it was not really allocated.
3089 int av_dup_packet(AVPacket *pkt);
3094 * @param pkt packet to free
3096 void av_free_packet(AVPacket *pkt);
3099 * Allocate new information of a packet.
3102 * @param type side information type
3103 * @param size side information size
3104 * @return pointer to fresh allocated data or NULL otherwise
3106 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3110 * Shrink the already allocated side data buffer
3113 * @param type side information type
3114 * @param size new side information size
3115 * @return 0 on success, < 0 on failure
3117 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3121 * Get side information from packet.
3124 * @param type desired side information type
3125 * @param size pointer for side information size to store (optional)
3126 * @return pointer to data if present or NULL otherwise
3128 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3133 struct ReSampleContext;
3134 struct AVResampleContext;
3136 typedef struct ReSampleContext ReSampleContext;
3139 * Initialize audio resampling context.
3141 * @param output_channels number of output channels
3142 * @param input_channels number of input channels
3143 * @param output_rate output sample rate
3144 * @param input_rate input sample rate
3145 * @param sample_fmt_out requested output sample format
3146 * @param sample_fmt_in input sample format
3147 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3148 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3149 * @param linear if 1 then the used FIR filter will be linearly interpolated
3150 between the 2 closest, if 0 the closest will be used
3151 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3152 * @return allocated ReSampleContext, NULL if error occurred
3154 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3155 int output_rate, int input_rate,
3156 enum AVSampleFormat sample_fmt_out,
3157 enum AVSampleFormat sample_fmt_in,
3158 int filter_length, int log2_phase_count,
3159 int linear, double cutoff);
3161 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3164 * Free resample context.
3166 * @param s a non-NULL pointer to a resample context previously
3167 * created with av_audio_resample_init()
3169 void audio_resample_close(ReSampleContext *s);
3173 * Initialize an audio resampler.
3174 * Note, if either rate is not an integer then simply scale both rates up so they are.
3175 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3176 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3177 * @param linear If 1 then the used FIR filter will be linearly interpolated
3178 between the 2 closest, if 0 the closest will be used
3179 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3181 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3184 * Resample an array of samples using a previously configured context.
3185 * @param src an array of unconsumed samples
3186 * @param consumed the number of samples of src which have been consumed are returned here
3187 * @param src_size the number of unconsumed samples available
3188 * @param dst_size the amount of space in samples available in dst
3189 * @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.
3190 * @return the number of samples written in dst or -1 if an error occurred
3192 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3196 * Compensate samplerate/timestamp drift. The compensation is done by changing
3197 * the resampler parameters, so no audible clicks or similar distortions occur
3198 * @param compensation_distance distance in output samples over which the compensation should be performed
3199 * @param sample_delta number of output samples which should be output less
3201 * example: av_resample_compensate(c, 10, 500)
3202 * here instead of 510 samples only 500 samples would be output
3204 * note, due to rounding the actual compensation might be slightly different,
3205 * especially if the compensation_distance is large and the in_rate used during init is small
3207 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3208 void av_resample_close(struct AVResampleContext *c);
3211 * Allocate memory for a picture. Call avpicture_free() to free it.
3213 * @see avpicture_fill()
3215 * @param picture the picture to be filled in
3216 * @param pix_fmt the format of the picture
3217 * @param width the width of the picture
3218 * @param height the height of the picture
3219 * @return zero if successful, a negative value if not
3221 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3224 * Free a picture previously allocated by avpicture_alloc().
3225 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3228 * @param picture the AVPicture to be freed
3230 void avpicture_free(AVPicture *picture);
3233 * Fill in the AVPicture fields.
3234 * The fields of the given AVPicture are filled in by using the 'ptr' address
3235 * which points to the image data buffer. Depending on the specified picture
3236 * format, one or multiple image data pointers and line sizes will be set.
3237 * If a planar format is specified, several pointers will be set pointing to
3238 * the different picture planes and the line sizes of the different planes
3239 * will be stored in the lines_sizes array.
3240 * Call with ptr == NULL to get the required size for the ptr buffer.
3242 * To allocate the buffer and fill in the AVPicture fields in one call,
3243 * use avpicture_alloc().
3245 * @param picture AVPicture whose fields are to be filled in
3246 * @param ptr Buffer which will contain or contains the actual image data
3247 * @param pix_fmt The format in which the picture data is stored.
3248 * @param width the width of the image in pixels
3249 * @param height the height of the image in pixels
3250 * @return size of the image data in bytes
3252 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3253 enum PixelFormat pix_fmt, int width, int height);
3256 * Copy pixel data from an AVPicture into a buffer.
3257 * The data is stored compactly, without any gaps for alignment or padding
3258 * which may be applied by avpicture_fill().
3260 * @see avpicture_get_size()
3262 * @param[in] src AVPicture containing image data
3263 * @param[in] pix_fmt The format in which the picture data is stored.
3264 * @param[in] width the width of the image in pixels.
3265 * @param[in] height the height of the image in pixels.
3266 * @param[out] dest A buffer into which picture data will be copied.
3267 * @param[in] dest_size The size of 'dest'.
3268 * @return The number of bytes written to dest, or a negative value (error code) on error.
3270 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3271 unsigned char *dest, int dest_size);
3274 * Calculate the size in bytes that a picture of the given width and height
3275 * would occupy if stored in the given picture format.
3276 * Note that this returns the size of a compact representation as generated
3277 * by avpicture_layout(), which can be smaller than the size required for e.g.
3280 * @param pix_fmt the given picture format
3281 * @param width the width of the image
3282 * @param height the height of the image
3283 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3285 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3286 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3288 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3291 * Return a value representing the fourCC code associated to the
3292 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3295 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3298 * Put a string representing the codec tag codec_tag in buf.
3300 * @param buf_size size in bytes of buf
3301 * @return the length of the string that would have been generated if
3302 * enough space had been available, excluding the trailing null
3304 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3306 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3307 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3308 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3309 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3310 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3311 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3314 * Compute what kind of losses will occur when converting from one specific
3315 * pixel format to another.
3316 * When converting from one pixel format to another, information loss may occur.
3317 * For example, when converting from RGB24 to GRAY, the color information will
3318 * be lost. Similarly, other losses occur when converting from some formats to
3319 * other formats. These losses can involve loss of chroma, but also loss of
3320 * resolution, loss of color depth, loss due to the color space conversion, loss
3321 * of the alpha bits or loss due to color quantization.
3322 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3323 * which will occur when converting from one pixel format to another.
3325 * @param[in] dst_pix_fmt destination pixel format
3326 * @param[in] src_pix_fmt source pixel format
3327 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3328 * @return Combination of flags informing you what kind of losses will occur.
3330 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3334 * Find the best pixel format to convert to given a certain source pixel
3335 * format. When converting from one pixel format to another, information loss
3336 * may occur. For example, when converting from RGB24 to GRAY, the color
3337 * information will be lost. Similarly, other losses occur when converting from
3338 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3339 * the given pixel formats should be used to suffer the least amount of loss.
3340 * The pixel formats from which it chooses one, are determined by the
3341 * pix_fmt_mask parameter.
3344 * src_pix_fmt = PIX_FMT_YUV420P;
3345 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3346 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3349 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3350 * @param[in] src_pix_fmt source pixel format
3351 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3352 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3353 * @return The best pixel format to convert to or -1 if none was found.
3355 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3356 int has_alpha, int *loss_ptr);
3358 /* deinterlace a picture */
3359 /* deinterlace - if not supported return -1 */
3360 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3361 enum PixelFormat pix_fmt, int width, int height);
3363 /* external high level API */
3366 * If c is NULL, returns the first registered codec,
3367 * if c is non-NULL, returns the next registered codec after c,
3368 * or NULL if c is the last one.
3370 AVCodec *av_codec_next(AVCodec *c);
3373 * Return the LIBAVCODEC_VERSION_INT constant.
3375 unsigned avcodec_version(void);
3378 * Return the libavcodec build-time configuration.
3380 const char *avcodec_configuration(void);
3383 * Return the libavcodec license.
3385 const char *avcodec_license(void);
3388 * Register the codec codec and initialize libavcodec.
3390 * @warning either this function or avcodec_register_all() must be called
3391 * before any other libavcodec functions.
3393 * @see avcodec_register_all()
3395 void avcodec_register(AVCodec *codec);
3398 * Find a registered encoder with a matching codec ID.
3400 * @param id CodecID of the requested encoder
3401 * @return An encoder if one was found, NULL otherwise.
3403 AVCodec *avcodec_find_encoder(enum CodecID id);
3406 * Find a registered encoder with the specified name.
3408 * @param name name of the requested encoder
3409 * @return An encoder if one was found, NULL otherwise.
3411 AVCodec *avcodec_find_encoder_by_name(const char *name);
3414 * Find a registered decoder with a matching codec ID.
3416 * @param id CodecID of the requested decoder
3417 * @return A decoder if one was found, NULL otherwise.
3419 AVCodec *avcodec_find_decoder(enum CodecID id);
3422 * Find a registered decoder with the specified name.
3424 * @param name name of the requested decoder
3425 * @return A decoder if one was found, NULL otherwise.
3427 AVCodec *avcodec_find_decoder_by_name(const char *name);
3428 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3431 * Return a name for the specified profile, if available.
3433 * @param codec the codec that is searched for the given profile
3434 * @param profile the profile value for which a name is requested
3435 * @return A name for the profile if found, NULL otherwise.
3437 const char *av_get_profile_name(const AVCodec *codec, int profile);
3440 * Set the fields of the given AVCodecContext to default values corresponding
3441 * to the given codec (defaults may be codec-dependent).
3443 * Do not call this function if a non-NULL codec has been passed
3444 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3445 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3446 * different codec on this AVCodecContext.
3448 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3451 * Allocate an AVCodecContext and set its fields to default values. The
3452 * resulting struct can be deallocated by calling avcodec_close() on it followed
3455 * @param codec if non-NULL, allocate private data and initialize defaults
3456 * for the given codec. It is illegal to then call avcodec_open2()
3457 * with a different codec.
3458 * If NULL, then the codec-specific defaults won't be initialized,
3459 * which may result in suboptimal default settings (this is
3460 * important mainly for encoders, e.g. libx264).
3462 * @return An AVCodecContext filled with default values or NULL on failure.
3463 * @see avcodec_get_context_defaults
3465 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3468 * Copy the settings of the source AVCodecContext into the destination
3469 * AVCodecContext. The resulting destination codec context will be
3470 * unopened, i.e. you are required to call avcodec_open2() before you
3471 * can use this AVCodecContext to decode/encode video/audio data.
3473 * @param dest target codec context, should be initialized with
3474 * avcodec_alloc_context3(), but otherwise uninitialized
3475 * @param src source codec context
3476 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3478 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3481 * Set the fields of the given AVFrame to default values.
3483 * @param pic The AVFrame of which the fields should be set to default values.
3485 void avcodec_get_frame_defaults(AVFrame *pic);
3488 * Allocate an AVFrame and set its fields to default values. The resulting
3489 * struct can be deallocated by simply calling av_free().
3491 * @return An AVFrame filled with default values or NULL on failure.
3492 * @see avcodec_get_frame_defaults
3494 AVFrame *avcodec_alloc_frame(void);
3496 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3497 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3498 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3501 * Return the amount of padding in pixels which the get_buffer callback must
3502 * provide around the edge of the image for codecs which do not have the
3503 * CODEC_FLAG_EMU_EDGE flag.
3505 * @return Required padding in pixels.
3507 unsigned avcodec_get_edge_width(void);
3509 * Modify width and height values so that they will result in a memory
3510 * buffer that is acceptable for the codec if you do not use any horizontal
3513 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3514 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3515 * according to avcodec_get_edge_width() before.
3517 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3519 * Modify width and height values so that they will result in a memory
3520 * buffer that is acceptable for the codec if you also ensure that all
3521 * line sizes are a multiple of the respective linesize_align[i].
3523 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3524 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3525 * according to avcodec_get_edge_width() before.
3527 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3528 int linesize_align[AV_NUM_DATA_POINTERS]);
3530 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3532 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3533 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3534 //FIXME func typedef
3537 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3538 * function the context has to be allocated with avcodec_alloc_context3().
3540 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3541 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3542 * retrieving a codec.
3544 * @warning This function is not thread safe!
3547 * avcodec_register_all();
3548 * av_dict_set(&opts, "b", "2.5M", 0);
3549 * codec = avcodec_find_decoder(CODEC_ID_H264);
3553 * context = avcodec_alloc_context3(codec);
3555 * if (avcodec_open2(context, codec, opts) < 0)
3559 * @param avctx The context to initialize.
3560 * @param codec The codec to open this context for. If a non-NULL codec has been
3561 * previously passed to avcodec_alloc_context3() or
3562 * avcodec_get_context_defaults3() for this context, then this
3563 * parameter MUST be either NULL or equal to the previously passed
3565 * @param options A dictionary filled with AVCodecContext and codec-private options.
3566 * On return this object will be filled with options that were not found.
3568 * @return zero on success, a negative value on error
3569 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3570 * av_dict_set(), av_opt_find().
3572 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3574 #if FF_API_OLD_DECODE_AUDIO
3576 * Wrapper function which calls avcodec_decode_audio4.
3578 * @deprecated Use avcodec_decode_audio4 instead.
3580 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3581 * Some decoders may support multiple frames in a single AVPacket, such
3582 * decoders would then just decode the first frame. In this case,
3583 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3584 * the remaining data in order to decode the second frame etc.
3586 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3587 * decompressed frame size in bytes.
3589 * @warning You must set frame_size_ptr to the allocated size of the
3590 * output buffer before calling avcodec_decode_audio3().
3592 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3593 * the actual read bytes because some optimized bitstream readers read 32 or 64
3594 * bits at once and could read over the end.
3596 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3597 * no overreading happens for damaged MPEG streams.
3599 * @warning You must not provide a custom get_buffer() when using
3600 * avcodec_decode_audio3(). Doing so will override it with
3601 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3602 * which does allow the application to provide a custom get_buffer().
3604 * @note You might have to align the input buffer avpkt->data and output buffer
3605 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3606 * necessary at all, on others it won't work at all if not aligned and on others
3607 * it will work but it will have an impact on performance.
3609 * In practice, avpkt->data should have 4 byte alignment at minimum and
3610 * samples should be 16 byte aligned unless the CPU doesn't need it
3611 * (AltiVec and SSE do).
3613 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3614 * between input and output, these need to be fed with avpkt->data=NULL,
3615 * avpkt->size=0 at the end to return the remaining frames.
3617 * @param avctx the codec context
3618 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3619 * If the sample format is planar, each channel plane will
3620 * be the same size, with no padding between channels.
3621 * @param[in,out] frame_size_ptr the output buffer size in bytes
3622 * @param[in] avpkt The input AVPacket containing the input buffer.
3623 * You can create such packet with av_init_packet() and by then setting
3624 * data and size, some decoders might in addition need other fields.
3625 * All decoders are designed to use the least fields possible though.
3626 * @return On error a negative value is returned, otherwise the number of bytes
3627 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3629 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3630 int *frame_size_ptr,
3635 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3637 * Some decoders may support multiple frames in a single AVPacket. Such
3638 * decoders would then just decode the first frame. In this case,
3639 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3640 * the remaining data in order to decode the second frame, etc...
3641 * Even if no frames are returned, the packet needs to be fed to the decoder
3642 * with remaining data until it is completely consumed or an error occurs.
3644 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3645 * larger than the actual read bytes because some optimized bitstream
3646 * readers read 32 or 64 bits at once and could read over the end.
3648 * @note You might have to align the input buffer. The alignment requirements
3649 * depend on the CPU and the decoder.
3651 * @param avctx the codec context
3652 * @param[out] frame The AVFrame in which to store decoded audio samples.
3653 * Decoders request a buffer of a particular size by setting
3654 * AVFrame.nb_samples prior to calling get_buffer(). The
3655 * decoder may, however, only utilize part of the buffer by
3656 * setting AVFrame.nb_samples to a smaller value in the
3658 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3660 * @param[in] avpkt The input AVPacket containing the input buffer.
3661 * At least avpkt->data and avpkt->size should be set. Some
3662 * decoders might also require additional fields to be set.
3663 * @return A negative error code is returned if an error occurred during
3664 * decoding, otherwise the number of bytes consumed from the input
3665 * AVPacket is returned.
3667 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3668 int *got_frame_ptr, AVPacket *avpkt);
3671 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3672 * Some decoders may support multiple frames in a single AVPacket, such
3673 * decoders would then just decode the first frame.
3675 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3676 * the actual read bytes because some optimized bitstream readers read 32 or 64
3677 * bits at once and could read over the end.
3679 * @warning The end of the input buffer buf should be set to 0 to ensure that
3680 * no overreading happens for damaged MPEG streams.
3682 * @note You might have to align the input buffer avpkt->data.
3683 * The alignment requirements depend on the CPU: on some CPUs it isn't
3684 * necessary at all, on others it won't work at all if not aligned and on others
3685 * it will work but it will have an impact on performance.
3687 * In practice, avpkt->data should have 4 byte alignment at minimum.
3689 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3690 * between input and output, these need to be fed with avpkt->data=NULL,
3691 * avpkt->size=0 at the end to return the remaining frames.
3693 * @param avctx the codec context
3694 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3695 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3696 * allocate memory for the actual bitmap.
3697 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3698 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3699 * decodes and the decoder tells the user once it does not need the data anymore,
3700 * the user app can at this point free/reuse/keep the memory as it sees fit.
3702 * @param[in] avpkt The input AVpacket containing the input buffer.
3703 * You can create such packet with av_init_packet() and by then setting
3704 * data and size, some decoders might in addition need other fields like
3705 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3707 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3708 * @return On error a negative value is returned, otherwise the number of bytes
3709 * used or zero if no frame could be decompressed.
3711 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3712 int *got_picture_ptr,
3716 * Decode a subtitle message.
3717 * Return a negative value on error, otherwise return the number of bytes used.
3718 * If no subtitle could be decompressed, got_sub_ptr is zero.
3719 * Otherwise, the subtitle is stored in *sub.
3720 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3721 * simplicity, because the performance difference is expect to be negligible
3722 * and reusing a get_buffer written for video codecs would probably perform badly
3723 * due to a potentially very different allocation pattern.
3725 * @param avctx the codec context
3726 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3727 freed with avsubtitle_free if *got_sub_ptr is set.
3728 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3729 * @param[in] avpkt The input AVPacket containing the input buffer.
3731 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3736 * Free all allocated data in the given subtitle struct.
3738 * @param sub AVSubtitle to free.
3740 void avsubtitle_free(AVSubtitle *sub);
3742 #if FF_API_OLD_ENCODE_AUDIO
3744 * Encode an audio frame from samples into buf.
3746 * @deprecated Use avcodec_encode_audio2 instead.
3748 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3749 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3750 * will know how much space is needed because it depends on the value passed
3751 * in buf_size as described below. In that case a lower value can be used.
3753 * @param avctx the codec context
3754 * @param[out] buf the output buffer
3755 * @param[in] buf_size the output buffer size
3756 * @param[in] samples the input buffer containing the samples
3757 * The number of samples read from this buffer is frame_size*channels,
3758 * both of which are defined in avctx.
3759 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3760 * samples read from samples is equal to:
3761 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3762 * This also implies that av_get_bits_per_sample() must not return 0 for these
3764 * @return On error a negative value is returned, on success zero or the number
3765 * of bytes used to encode the data read from the input buffer.
3767 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3768 uint8_t *buf, int buf_size,
3769 const short *samples);
3773 * Encode a frame of audio.
3775 * Takes input samples from frame and writes the next output packet, if
3776 * available, to avpkt. The output packet does not necessarily contain data for
3777 * the most recent frame, as encoders can delay, split, and combine input frames
3778 * internally as needed.
3780 * @param avctx codec context
3781 * @param avpkt output AVPacket.
3782 * The user can supply an output buffer by setting
3783 * avpkt->data and avpkt->size prior to calling the
3784 * function, but if the size of the user-provided data is not
3785 * large enough, encoding will fail. All other AVPacket fields
3786 * will be reset by the encoder using av_init_packet(). If
3787 * avpkt->data is NULL, the encoder will allocate it.
3788 * The encoder will set avpkt->size to the size of the
3791 * If this function fails or produces no output, avpkt will be
3792 * freed using av_free_packet() (i.e. avpkt->destruct will be
3793 * called to free the user supplied buffer).
3794 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3795 * May be NULL when flushing an encoder that has the
3796 * CODEC_CAP_DELAY capability set.
3797 * There are 2 codec capabilities that affect the allowed
3798 * values of frame->nb_samples.
3799 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
3800 * frame may be smaller than avctx->frame_size, and all other
3801 * frames must be equal to avctx->frame_size.
3802 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3803 * can have any number of samples.
3804 * If neither is set, frame->nb_samples must be equal to
3805 * avctx->frame_size for all frames.
3806 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3807 * output packet is non-empty, and to 0 if it is
3808 * empty. If the function returns an error, the
3809 * packet can be assumed to be invalid, and the
3810 * value of got_packet_ptr is undefined and should
3812 * @return 0 on success, negative error code on failure
3814 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3815 const AVFrame *frame, int *got_packet_ptr);
3818 * Fill audio frame data and linesize.
3819 * AVFrame extended_data channel pointers are allocated if necessary for
3822 * @param frame the AVFrame
3823 * frame->nb_samples must be set prior to calling the
3824 * function. This function fills in frame->data,
3825 * frame->extended_data, frame->linesize[0].
3826 * @param nb_channels channel count
3827 * @param sample_fmt sample format
3828 * @param buf buffer to use for frame data
3829 * @param buf_size size of buffer
3830 * @param align plane size sample alignment
3831 * @return 0 on success, negative error code on failure
3833 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
3834 enum AVSampleFormat sample_fmt, const uint8_t *buf,
3835 int buf_size, int align);
3837 #if FF_API_OLD_ENCODE_VIDEO
3839 * @deprecated use avcodec_encode_video2() instead.
3841 * Encode a video frame from pict into buf.
3842 * The input picture should be
3843 * stored using a specific format, namely avctx.pix_fmt.
3845 * @param avctx the codec context
3846 * @param[out] buf the output buffer for the bitstream of encoded frame
3847 * @param[in] buf_size the size of the output buffer in bytes
3848 * @param[in] pict the input picture to encode
3849 * @return On error a negative value is returned, on success zero or the number
3850 * of bytes used from the output buffer.
3852 attribute_deprecated
3853 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3854 const AVFrame *pict);
3858 * Encode a frame of video.
3860 * Takes input raw video data from frame and writes the next output packet, if
3861 * available, to avpkt. The output packet does not necessarily contain data for
3862 * the most recent frame, as encoders can delay and reorder input frames
3863 * internally as needed.
3865 * @param avctx codec context
3866 * @param avpkt output AVPacket.
3867 * The user can supply an output buffer by setting
3868 * avpkt->data and avpkt->size prior to calling the
3869 * function, but if the size of the user-provided data is not
3870 * large enough, encoding will fail. All other AVPacket fields
3871 * will be reset by the encoder using av_init_packet(). If
3872 * avpkt->data is NULL, the encoder will allocate it.
3873 * The encoder will set avpkt->size to the size of the
3874 * output packet. The returned data (if any) belongs to the
3875 * caller, he is responsible for freeing it.
3877 * If this function fails or produces no output, avpkt will be
3878 * freed using av_free_packet() (i.e. avpkt->destruct will be
3879 * called to free the user supplied buffer).
3880 * @param[in] frame AVFrame containing the raw video data to be encoded.
3881 * May be NULL when flushing an encoder that has the
3882 * CODEC_CAP_DELAY capability set.
3883 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3884 * output packet is non-empty, and to 0 if it is
3885 * empty. If the function returns an error, the
3886 * packet can be assumed to be invalid, and the
3887 * value of got_packet_ptr is undefined and should
3889 * @return 0 on success, negative error code on failure
3891 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3892 const AVFrame *frame, int *got_packet_ptr);
3894 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3895 const AVSubtitle *sub);
3898 * Close a given AVCodecContext and free all the data associated with it
3899 * (but not the AVCodecContext itself).
3901 * Calling this function on an AVCodecContext that hasn't been opened will free
3902 * the codec-specific data allocated in avcodec_alloc_context3() /
3903 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3906 int avcodec_close(AVCodecContext *avctx);
3909 * Register all the codecs, parsers and bitstream filters which were enabled at
3910 * configuration time. If you do not call this function you can select exactly
3911 * which formats you want to support, by using the individual registration
3914 * @see avcodec_register
3915 * @see av_register_codec_parser
3916 * @see av_register_bitstream_filter
3918 void avcodec_register_all(void);
3921 * Flush buffers, should be called when seeking or when switching to a different stream.
3923 void avcodec_flush_buffers(AVCodecContext *avctx);
3925 void avcodec_default_free_buffers(AVCodecContext *s);
3927 /* misc useful functions */
3930 * Return codec bits per sample.
3932 * @param[in] codec_id the codec
3933 * @return Number of bits per sample or zero if unknown for the given codec.
3935 int av_get_bits_per_sample(enum CodecID codec_id);
3938 * Return codec bits per sample.
3939 * Only return non-zero if the bits per sample is exactly correct, not an
3942 * @param[in] codec_id the codec
3943 * @return Number of bits per sample or zero if unknown for the given codec.
3945 int av_get_exact_bits_per_sample(enum CodecID codec_id);
3948 * Return audio frame duration.
3950 * @param avctx codec context
3951 * @param frame_bytes size of the frame, or 0 if unknown
3952 * @return frame duration, in samples, if known. 0 if not able to
3955 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
3958 typedef struct AVCodecParserContext {
3960 struct AVCodecParser *parser;
3961 int64_t frame_offset; /* offset of the current frame */
3962 int64_t cur_offset; /* current offset
3963 (incremented by each av_parser_parse()) */
3964 int64_t next_frame_offset; /* offset of the next frame */
3966 int pict_type; /* XXX: Put it back in AVCodecContext. */
3968 * This field is used for proper frame duration computation in lavf.
3969 * It signals, how much longer the frame duration of the current frame
3970 * is compared to normal frame duration.
3972 * frame_duration = (1 + repeat_pict) * time_base
3974 * It is used by codecs like H.264 to display telecined material.
3976 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3977 int64_t pts; /* pts of the current frame */
3978 int64_t dts; /* dts of the current frame */
3983 int fetch_timestamp;
3985 #define AV_PARSER_PTS_NB 4
3986 int cur_frame_start_index;
3987 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3988 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3989 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3992 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3993 #define PARSER_FLAG_ONCE 0x0002
3994 /// Set if the parser has a valid file offset
3995 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3997 int64_t offset; ///< byte offset from starting packet start
3998 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4001 * Set by parser to 1 for key frames and 0 for non-key frames.
4002 * It is initialized to -1, so if the parser doesn't set this flag,
4003 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4009 * Time difference in stream time base units from the pts of this
4010 * packet to the point at which the output from the decoder has converged
4011 * independent from the availability of previous frames. That is, the
4012 * frames are virtually identical no matter if decoding started from
4013 * the very first frame or from this keyframe.
4014 * Is AV_NOPTS_VALUE if unknown.
4015 * This field is not the display duration of the current frame.
4016 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4019 * The purpose of this field is to allow seeking in streams that have no
4020 * keyframes in the conventional sense. It corresponds to the
4021 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4022 * essential for some types of subtitle streams to ensure that all
4023 * subtitles are correctly displayed after seeking.
4025 int64_t convergence_duration;
4027 // Timestamp generation support:
4029 * Synchronization point for start of timestamp generation.
4031 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4034 * For example, this corresponds to presence of H.264 buffering period
4040 * Offset of the current timestamp against last timestamp sync point in
4041 * units of AVCodecContext.time_base.
4043 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4044 * contain a valid timestamp offset.
4046 * Note that the timestamp of sync point has usually a nonzero
4047 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4048 * the next frame after timestamp sync point will be usually 1.
4050 * For example, this corresponds to H.264 cpb_removal_delay.
4052 int dts_ref_dts_delta;
4055 * Presentation delay of current frame in units of AVCodecContext.time_base.
4057 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4058 * contain valid non-negative timestamp delta (presentation time of a frame
4059 * must not lie in the past).
4061 * This delay represents the difference between decoding and presentation
4062 * time of the frame.
4064 * For example, this corresponds to H.264 dpb_output_delay.
4069 * Position of the packet in file.
4071 * Analogous to cur_frame_pts/dts
4073 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4076 * Byte position of currently parsed frame in stream.
4081 * Previous frame byte position.
4086 * Duration of the current frame.
4087 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4088 * For all other types, this is in units of AVCodecContext.time_base.
4091 } AVCodecParserContext;
4093 typedef struct AVCodecParser {
4094 int codec_ids[5]; /* several codec IDs are permitted */
4096 int (*parser_init)(AVCodecParserContext *s);
4097 int (*parser_parse)(AVCodecParserContext *s,
4098 AVCodecContext *avctx,
4099 const uint8_t **poutbuf, int *poutbuf_size,
4100 const uint8_t *buf, int buf_size);
4101 void (*parser_close)(AVCodecParserContext *s);
4102 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4103 struct AVCodecParser *next;
4106 AVCodecParser *av_parser_next(AVCodecParser *c);
4108 void av_register_codec_parser(AVCodecParser *parser);
4109 AVCodecParserContext *av_parser_init(int codec_id);
4114 * @param s parser context.
4115 * @param avctx codec context.
4116 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4117 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4118 * @param buf input buffer.
4119 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4120 * @param pts input presentation timestamp.
4121 * @param dts input decoding timestamp.
4122 * @param pos input byte position in stream.
4123 * @return the number of bytes of the input bitstream used.
4128 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4135 * decode_frame(data, size);
4139 int av_parser_parse2(AVCodecParserContext *s,
4140 AVCodecContext *avctx,
4141 uint8_t **poutbuf, int *poutbuf_size,
4142 const uint8_t *buf, int buf_size,
4143 int64_t pts, int64_t dts,
4146 int av_parser_change(AVCodecParserContext *s,
4147 AVCodecContext *avctx,
4148 uint8_t **poutbuf, int *poutbuf_size,
4149 const uint8_t *buf, int buf_size, int keyframe);
4150 void av_parser_close(AVCodecParserContext *s);
4153 typedef struct AVBitStreamFilterContext {
4155 struct AVBitStreamFilter *filter;
4156 AVCodecParserContext *parser;
4157 struct AVBitStreamFilterContext *next;
4158 } AVBitStreamFilterContext;
4161 typedef struct AVBitStreamFilter {
4164 int (*filter)(AVBitStreamFilterContext *bsfc,
4165 AVCodecContext *avctx, const char *args,
4166 uint8_t **poutbuf, int *poutbuf_size,
4167 const uint8_t *buf, int buf_size, int keyframe);
4168 void (*close)(AVBitStreamFilterContext *bsfc);
4169 struct AVBitStreamFilter *next;
4170 } AVBitStreamFilter;
4172 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4173 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4174 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4175 AVCodecContext *avctx, const char *args,
4176 uint8_t **poutbuf, int *poutbuf_size,
4177 const uint8_t *buf, int buf_size, int keyframe);
4178 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4180 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4185 * Reallocate the given block if it is not large enough, otherwise do nothing.
4189 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4192 * Allocate a buffer, reusing the given one if large enough.
4194 * Contrary to av_fast_realloc the current buffer contents might not be
4195 * preserved and on error the old buffer is freed, thus no special
4196 * handling to avoid memleaks is necessary.
4198 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4199 * @param size size of the buffer *ptr points to
4200 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4201 * *size 0 if an error occurred.
4203 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4206 * Allocate a buffer with padding, reusing the given one if large enough.
4208 * Same behaviour av_fast_malloc but the buffer has additional
4209 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4212 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4215 * Copy image src to dst. Wraps av_picture_data_copy() above.
4217 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4218 enum PixelFormat pix_fmt, int width, int height);
4221 * Crop image top and left side.
4223 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4224 enum PixelFormat pix_fmt, int top_band, int left_band);
4229 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4230 int padtop, int padbottom, int padleft, int padright, int *color);
4233 * Encode extradata length to a buffer. Used by xiph codecs.
4235 * @param s buffer to write to; must be at least (v/255+1) bytes long
4236 * @param v size of extradata in bytes
4237 * @return number of bytes written to the buffer.
4239 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4242 * Log a generic warning message about a missing feature. This function is
4243 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4244 * only, and would normally not be used by applications.
4245 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4246 * a pointer to an AVClass struct
4247 * @param[in] feature string containing the name of the missing feature
4248 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4249 * If want_sample is non-zero, additional verbage will be added to the log
4250 * message which tells the user how to report samples to the development
4253 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4256 * Log a generic warning message asking for a sample. This function is
4257 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4258 * only, and would normally not be used by applications.
4259 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4260 * a pointer to an AVClass struct
4261 * @param[in] msg string containing an optional message, or NULL if no message
4263 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4266 * Register the hardware accelerator hwaccel.
4268 void av_register_hwaccel(AVHWAccel *hwaccel);
4271 * If hwaccel is NULL, returns the first registered hardware accelerator,
4272 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4273 * after hwaccel, or NULL if hwaccel is the last one.
4275 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4279 * Lock operation used by lockmgr
4282 AV_LOCK_CREATE, ///< Create a mutex
4283 AV_LOCK_OBTAIN, ///< Lock the mutex
4284 AV_LOCK_RELEASE, ///< Unlock the mutex
4285 AV_LOCK_DESTROY, ///< Free mutex resources
4289 * Register a user provided lock manager supporting the operations
4290 * specified by AVLockOp. mutex points to a (void *) where the
4291 * lockmgr should store/get a pointer to a user allocated mutex. It's
4292 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4294 * @param cb User defined callback. Note: Libav may invoke calls to this
4295 * callback during the call to av_lockmgr_register().
4296 * Thus, the application must be prepared to handle that.
4297 * If cb is set to NULL the lockmgr will be unregistered.
4298 * Also note that during unregistration the previously registered
4299 * lockmgr callback may also be invoked.
4301 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4304 * Get the type of the given codec.
4306 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4309 * Get the AVClass for AVCodecContext. It can be used in combination with
4310 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4312 * @see av_opt_find().
4314 const AVClass *avcodec_get_class(void);
4317 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4318 * with no corresponding avcodec_close()), 0 otherwise.
4320 int avcodec_is_open(AVCodecContext *s);
4323 * @return a non-zero number if codec is an encoder, zero otherwise
4325 int av_codec_is_encoder(AVCodec *codec);
4328 * @return a non-zero number if codec is a decoder, zero otherwise
4330 int av_codec_is_decoder(AVCodec *codec);
4332 #endif /* AVCODEC_AVCODEC_H */