2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * Libav is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
40 * @defgroup libavc Encoding/Decoding Library
43 * @defgroup lavc_decoding Decoding
47 * @defgroup lavc_encoding Encoding
51 * @defgroup lavc_codec Codecs
53 * @defgroup lavc_codec_native Native Codecs
56 * @defgroup lavc_codec_wrappers External library wrappers
59 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
63 * @defgroup lavc_internal Internal
72 * Identify the syntax and semantics of the bitstream.
73 * The principle is roughly:
74 * Two decoders with the same ID can decode the same streams.
75 * Two encoders with the same ID can encode compatible streams.
76 * There may be slight deviations from the principle due to implementation
79 * If you add a codec ID to this list, add it so that
80 * 1. no value of a existing codec ID changes (that would break ABI),
81 * 2. it is as close as possible to similar codecs.
88 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
89 CODEC_ID_MPEG2VIDEO_XVMC,
126 CODEC_ID_INTERPLAY_VIDEO,
138 CODEC_ID_TRUEMOTION1,
165 CODEC_ID_TRUEMOTION2,
182 CODEC_ID_DSICINVIDEO,
183 CODEC_ID_TIERTEXSEQVIDEO,
186 #if LIBAVCODEC_VERSION_MAJOR == 53
194 CODEC_ID_BETHSOFTVID,
206 #if LIBAVCODEC_VERSION_MAJOR == 53
214 CODEC_ID_MOTIONPIXELS,
232 CODEC_ID_IFF_BYTERUN1,
248 #if LIBAVCODEC_VERSION_MAJOR == 53
259 /* various PCM "codecs" */
260 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
261 CODEC_ID_PCM_S16LE = 0x10000,
277 CODEC_ID_PCM_S24DAUD,
279 CODEC_ID_PCM_S16LE_PLANAR,
288 CODEC_ID_PCM_S8_PLANAR,
290 /* various ADPCM codecs */
291 CODEC_ID_ADPCM_IMA_QT = 0x11000,
292 CODEC_ID_ADPCM_IMA_WAV,
293 CODEC_ID_ADPCM_IMA_DK3,
294 CODEC_ID_ADPCM_IMA_DK4,
295 CODEC_ID_ADPCM_IMA_WS,
296 CODEC_ID_ADPCM_IMA_SMJPEG,
305 CODEC_ID_ADPCM_YAMAHA,
306 CODEC_ID_ADPCM_SBPRO_4,
307 CODEC_ID_ADPCM_SBPRO_3,
308 CODEC_ID_ADPCM_SBPRO_2,
310 CODEC_ID_ADPCM_IMA_AMV,
311 CODEC_ID_ADPCM_EA_R1,
312 CODEC_ID_ADPCM_EA_R3,
313 CODEC_ID_ADPCM_EA_R2,
314 CODEC_ID_ADPCM_IMA_EA_SEAD,
315 CODEC_ID_ADPCM_IMA_EA_EACS,
316 CODEC_ID_ADPCM_EA_XAS,
317 CODEC_ID_ADPCM_EA_MAXIS_XA,
318 CODEC_ID_ADPCM_IMA_ISS,
320 CODEC_ID_ADPCM_IMA_APC,
323 CODEC_ID_AMR_NB = 0x12000,
326 /* RealAudio codecs*/
327 CODEC_ID_RA_144 = 0x13000,
330 /* various DPCM codecs */
331 CODEC_ID_ROQ_DPCM = 0x14000,
332 CODEC_ID_INTERPLAY_DPCM,
337 CODEC_ID_MP2 = 0x15000,
338 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
349 #if LIBAVCODEC_VERSION_MAJOR == 53
358 CODEC_ID_WESTWOOD_SND1,
359 CODEC_ID_GSM, ///< as in Berlin toast format
367 CODEC_ID_DSICINAUDIO,
371 CODEC_ID_GSM_MS, /* as found in WAV */
380 CODEC_ID_WMALOSSLESS,
389 CODEC_ID_BINKAUDIO_RDFT,
390 CODEC_ID_BINKAUDIO_DCT,
394 #if LIBAVCODEC_VERSION_MAJOR > 53
402 /* subtitle codecs */
403 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
404 CODEC_ID_DVD_SUBTITLE = 0x17000,
405 CODEC_ID_DVB_SUBTITLE,
406 CODEC_ID_TEXT, ///< raw UTF-8 text
410 CODEC_ID_HDMV_PGS_SUBTITLE,
411 CODEC_ID_DVB_TELETEXT,
414 /* other specific kind of codecs (generally used for attachments) */
415 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
416 CODEC_ID_TTF = 0x18000,
418 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
420 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
421 * stream (only used by libavformat) */
422 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
423 * stream (only used by libavformat) */
424 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
427 #if FF_API_OLD_AUDIOCONVERT
428 #include "libavutil/audioconvert.h"
430 /* Audio channel masks */
431 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
432 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
433 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
434 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
435 #define CH_BACK_LEFT AV_CH_BACK_LEFT
436 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
437 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
438 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
439 #define CH_BACK_CENTER AV_CH_BACK_CENTER
440 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
441 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
442 #define CH_TOP_CENTER AV_CH_TOP_CENTER
443 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
444 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
445 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
446 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
447 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
448 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
449 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
450 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
452 /** Channel mask value used for AVCodecContext.request_channel_layout
453 to indicate that the user requests the channel order of the decoder output
454 to be the native codec channel order. */
455 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
457 /* Audio channel convenience macros */
458 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
459 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
460 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
461 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
462 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
463 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
464 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
465 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
466 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
467 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
468 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
469 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
470 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
471 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
472 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
475 #if FF_API_OLD_DECODE_AUDIO
477 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
481 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
482 * This is mainly needed because some optimized bitstream readers read
483 * 32 or 64 bit at once and could read over the end.<br>
484 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
485 * MPEG bitstreams could cause overread and segfault.
487 #define FF_INPUT_BUFFER_PADDING_SIZE 8
490 * minimum encoding buffer size
491 * Used to avoid some checks during header writing.
493 #define FF_MIN_BUFFER_SIZE 16384
497 * motion estimation type.
500 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
504 ME_EPZS, ///< enhanced predictive zonal search
505 ME_X1, ///< reserved for experiments
506 ME_HEX, ///< hexagon based search
507 ME_UMH, ///< uneven multi-hexagon search
508 ME_ITER, ///< iterative search
509 ME_TESA, ///< transformed exhaustive search algorithm
513 /* We leave some space between them for extensions (drop some
514 * keyframes for intra-only or drop just some bidir frames). */
515 AVDISCARD_NONE =-16, ///< discard nothing
516 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
517 AVDISCARD_NONREF = 8, ///< discard all non reference
518 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
519 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
520 AVDISCARD_ALL = 48, ///< discard all
523 enum AVColorPrimaries{
524 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
525 AVCOL_PRI_UNSPECIFIED=2,
527 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
528 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
529 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
531 AVCOL_PRI_NB , ///< Not part of ABI
534 enum AVColorTransferCharacteristic{
535 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
536 AVCOL_TRC_UNSPECIFIED=2,
537 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
538 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
539 AVCOL_TRC_NB , ///< Not part of ABI
544 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
545 AVCOL_SPC_UNSPECIFIED=2,
547 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
548 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
549 AVCOL_SPC_SMPTE240M =7,
550 AVCOL_SPC_NB , ///< Not part of ABI
554 AVCOL_RANGE_UNSPECIFIED=0,
555 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
556 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
557 AVCOL_RANGE_NB , ///< Not part of ABI
561 * X X 3 4 X X are luma samples,
562 * 1 2 1-6 are possible chroma positions
563 * X X 5 6 X 0 is undefined/unknown position
565 enum AVChromaLocation{
566 AVCHROMA_LOC_UNSPECIFIED=0,
567 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
568 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
569 AVCHROMA_LOC_TOPLEFT =3, ///< DV
571 AVCHROMA_LOC_BOTTOMLEFT =5,
572 AVCHROMA_LOC_BOTTOM =6,
573 AVCHROMA_LOC_NB , ///< Not part of ABI
576 #if FF_API_FLAC_GLOBAL_OPTS
581 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
582 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
583 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
584 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
585 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
586 AV_LPC_TYPE_NB , ///< Not part of ABI
590 enum AVAudioServiceType {
591 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
592 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
593 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
594 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
595 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
596 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
597 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
598 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
599 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
600 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
603 typedef struct RcOverride{
606 int qscale; // If this is 0 then quality_factor will be used instead.
607 float quality_factor;
610 #define FF_MAX_B_FRAMES 16
613 These flags can be passed in AVCodecContext.flags before initialization.
614 Note: Not everything is supported yet.
617 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
618 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
619 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
620 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
621 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
623 * The parent program guarantees that the input for B-frames containing
624 * streams is not written to for at least s->max_b_frames+1 frames, if
625 * this is not set the input will be copied.
627 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
628 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
629 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
630 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
631 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
632 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
633 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
634 location instead of only at frame boundaries. */
635 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
636 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
637 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
638 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
639 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
640 /* Fx : Flag for h263+ extra options */
641 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
642 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
643 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
644 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
645 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
646 #define CODEC_FLAG_CLOSED_GOP 0x80000000
647 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
648 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
649 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
650 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
651 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
652 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
654 * @defgroup deprecated_flags Deprecated codec flags
655 * Use corresponding private codec options instead.
658 #if FF_API_MJPEG_GLOBAL_OPTS
659 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
661 #if FF_API_SNOW_GLOBAL_OPTS
662 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
664 #if FF_API_LAME_GLOBAL_OPTS
665 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
671 /* Unsupported options :
672 * Syntax Arithmetic coding (SAC)
673 * Reference Picture Selection
674 * Independent Segment Decoding */
676 /* codec capabilities */
678 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
680 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
681 * If not set, it might not use get_buffer() at all or use operations that
682 * assume the buffer was allocated by avcodec_default_get_buffer.
684 #define CODEC_CAP_DR1 0x0002
685 #if FF_API_PARSE_FRAME
686 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
687 #define CODEC_CAP_PARSE_ONLY 0x0004
689 #define CODEC_CAP_TRUNCATED 0x0008
690 /* Codec can export data for HW decoding (XvMC). */
691 #define CODEC_CAP_HWACCEL 0x0010
693 * Encoder or decoder requires flushing with NULL input at the end in order to
694 * give the complete and correct output.
696 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
697 * with NULL data. The user can still send NULL data to the public encode
698 * or decode function, but libavcodec will not pass it along to the codec
699 * unless this flag is set.
702 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
703 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
707 * The encoder needs to be fed with NULL data at the end of encoding until the
708 * encoder no longer returns data.
710 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
711 * flag also means that the encoder must set the pts and duration for
712 * each output packet. If this flag is not set, the pts and duration will
713 * be determined by libavcodec from the input frame.
715 #define CODEC_CAP_DELAY 0x0020
717 * Codec can be fed a final frame with a smaller size.
718 * This can be used to prevent truncation of the last audio samples.
720 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
722 * Codec can export data for HW decoding (VDPAU).
724 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
726 * Codec can output multiple frames per AVPacket
727 * Normally demuxers return one frame at a time, demuxers which do not do
728 * are connected to a parser to split what they return into proper frames.
729 * This flag is reserved to the very rare category of codecs which have a
730 * bitstream that cannot be split into frames without timeconsuming
731 * operations like full decoding. Demuxers carring such bitstreams thus
732 * may return multiple frames in a packet. This has many disadvantages like
733 * prohibiting stream copy in many cases thus it should only be considered
736 #define CODEC_CAP_SUBFRAMES 0x0100
738 * Codec is experimental and is thus avoided in favor of non experimental
741 #define CODEC_CAP_EXPERIMENTAL 0x0200
743 * Codec should fill in channel configuration and samplerate instead of container
745 #define CODEC_CAP_CHANNEL_CONF 0x0400
747 * Codec is able to deal with negative linesizes
749 #define CODEC_CAP_NEG_LINESIZES 0x0800
751 * Codec supports frame-level multithreading.
753 #define CODEC_CAP_FRAME_THREADS 0x1000
755 * Codec supports slice-based (or partition-based) multithreading.
757 #define CODEC_CAP_SLICE_THREADS 0x2000
759 * Codec supports changed parameters at any point.
761 #define CODEC_CAP_PARAM_CHANGE 0x4000
763 * Codec supports avctx->thread_count == 0 (auto).
765 #define CODEC_CAP_AUTO_THREADS 0x8000
767 * Audio encoder supports receiving a different number of samples in each call.
769 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
771 //The following defines may change, don't expect compatibility if you use them.
772 #define MB_TYPE_INTRA4x4 0x0001
773 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
774 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
775 #define MB_TYPE_16x16 0x0008
776 #define MB_TYPE_16x8 0x0010
777 #define MB_TYPE_8x16 0x0020
778 #define MB_TYPE_8x8 0x0040
779 #define MB_TYPE_INTERLACED 0x0080
780 #define MB_TYPE_DIRECT2 0x0100 //FIXME
781 #define MB_TYPE_ACPRED 0x0200
782 #define MB_TYPE_GMC 0x0400
783 #define MB_TYPE_SKIP 0x0800
784 #define MB_TYPE_P0L0 0x1000
785 #define MB_TYPE_P1L0 0x2000
786 #define MB_TYPE_P0L1 0x4000
787 #define MB_TYPE_P1L1 0x8000
788 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
789 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
790 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
791 #define MB_TYPE_QUANT 0x00010000
792 #define MB_TYPE_CBP 0x00020000
793 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
797 * This specifies the area which should be displayed.
798 * Note there may be multiple such areas for one frame.
800 typedef struct AVPanScan{
803 * - encoding: Set by user.
804 * - decoding: Set by libavcodec.
809 * width and height in 1/16 pel
810 * - encoding: Set by user.
811 * - decoding: Set by libavcodec.
817 * position of the top left corner in 1/16 pel for up to 3 fields/frames
818 * - encoding: Set by user.
819 * - decoding: Set by libavcodec.
821 int16_t position[3][2];
824 #define FF_QSCALE_TYPE_MPEG1 0
825 #define FF_QSCALE_TYPE_MPEG2 1
826 #define FF_QSCALE_TYPE_H264 2
827 #define FF_QSCALE_TYPE_VP56 3
829 #define FF_BUFFER_TYPE_INTERNAL 1
830 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
831 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
832 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
834 #if FF_API_OLD_FF_PICT_TYPES
835 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
836 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
837 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
838 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
839 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
840 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
841 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
842 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
845 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
846 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
847 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
848 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
850 enum AVPacketSideDataType {
852 AV_PKT_DATA_NEW_EXTRADATA,
853 AV_PKT_DATA_PARAM_CHANGE,
856 typedef struct AVPacket {
858 * Presentation timestamp in AVStream->time_base units; the time at which
859 * the decompressed packet will be presented to the user.
860 * Can be AV_NOPTS_VALUE if it is not stored in the file.
861 * pts MUST be larger or equal to dts as presentation cannot happen before
862 * decompression, unless one wants to view hex dumps. Some formats misuse
863 * the terms dts and pts/cts to mean something different. Such timestamps
864 * must be converted to true pts/dts before they are stored in AVPacket.
868 * Decompression timestamp in AVStream->time_base units; the time at which
869 * the packet is decompressed.
870 * Can be AV_NOPTS_VALUE if it is not stored in the file.
877 * A combination of AV_PKT_FLAG values
881 * Additional packet data that can be provided by the container.
882 * Packet can contain several types of side information.
887 enum AVPacketSideDataType type;
892 * Duration of this packet in AVStream->time_base units, 0 if unknown.
893 * Equals next_pts - this_pts in presentation order.
896 void (*destruct)(struct AVPacket *);
898 int64_t pos; ///< byte position in stream, -1 if unknown
901 * Time difference in AVStream->time_base units from the pts of this
902 * packet to the point at which the output from the decoder has converged
903 * independent from the availability of previous frames. That is, the
904 * frames are virtually identical no matter if decoding started from
905 * the very first frame or from this keyframe.
906 * Is AV_NOPTS_VALUE if unknown.
907 * This field is not the display duration of the current packet.
908 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
911 * The purpose of this field is to allow seeking in streams that have no
912 * keyframes in the conventional sense. It corresponds to the
913 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
914 * essential for some types of subtitle streams to ensure that all
915 * subtitles are correctly displayed after seeking.
917 int64_t convergence_duration;
919 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
920 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
923 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
925 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
926 * s32le channel_count
927 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
928 * u64le channel_layout
929 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
931 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
936 enum AVSideDataParamChangeFlags {
937 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
938 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
939 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
940 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
945 * New fields can be added to the end of AVFRAME with minor version
946 * bumps. Removal, reordering and changes to existing fields require
947 * a major version bump.
948 * sizeof(AVFrame) must not be used outside libav*.
950 typedef struct AVFrame {
951 #if FF_API_DATA_POINTERS
952 #define AV_NUM_DATA_POINTERS 4
954 #define AV_NUM_DATA_POINTERS 8
957 * pointer to the picture/channel planes.
958 * This might be different from the first allocated byte
959 * - encoding: Set by user
960 * - decoding: set by AVCodecContext.get_buffer()
962 uint8_t *data[AV_NUM_DATA_POINTERS];
965 * Size, in bytes, of the data for each picture/channel plane.
967 * For audio, only linesize[0] may be set. For planar audio, each channel
968 * plane must be the same size.
970 * - encoding: Set by user (video only)
971 * - decoding: set by AVCodecContext.get_buffer()
973 int linesize[AV_NUM_DATA_POINTERS];
976 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
977 * This isn't used by libavcodec unless the default get/release_buffer() is used.
981 uint8_t *base[AV_NUM_DATA_POINTERS];
983 * 1 -> keyframe, 0-> not
984 * - encoding: Set by libavcodec.
985 * - decoding: Set by libavcodec.
990 * Picture type of the frame, see ?_TYPE below.
991 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
992 * - decoding: Set by libavcodec.
994 enum AVPictureType pict_type;
997 * presentation timestamp in time_base units (time when frame should be shown to user)
998 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
999 * - encoding: MUST be set by user.
1000 * - decoding: Set by libavcodec.
1005 * picture number in bitstream order
1006 * - encoding: set by
1007 * - decoding: Set by libavcodec.
1009 int coded_picture_number;
1011 * picture number in display order
1012 * - encoding: set by
1013 * - decoding: Set by libavcodec.
1015 int display_picture_number;
1018 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1019 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1020 * - decoding: Set by libavcodec.
1024 #if FF_API_AVFRAME_AGE
1026 * @deprecated unused
1028 attribute_deprecated int age;
1032 * is this picture used as reference
1033 * The values for this are the same as the MpegEncContext.picture_structure
1034 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1035 * Set to 4 for delayed, non-reference frames.
1036 * - encoding: unused
1037 * - decoding: Set by libavcodec. (before get_buffer() call)).
1043 * - encoding: unused
1044 * - decoding: Set by libavcodec.
1046 int8_t *qscale_table;
1049 * - encoding: unused
1050 * - decoding: Set by libavcodec.
1055 * mbskip_table[mb]>=1 if MB didn't change
1056 * stride= mb_width = (width+15)>>4
1057 * - encoding: unused
1058 * - decoding: Set by libavcodec.
1060 uint8_t *mbskip_table;
1063 * motion vector table
1066 * int mv_sample_log2= 4 - motion_subsample_log2;
1067 * int mb_width= (width+15)>>4;
1068 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1069 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1071 * - encoding: Set by user.
1072 * - decoding: Set by libavcodec.
1074 int16_t (*motion_val[2])[2];
1077 * macroblock type table
1078 * mb_type_base + mb_width + 2
1079 * - encoding: Set by user.
1080 * - decoding: Set by libavcodec.
1085 * log2 of the size of the block which a single vector in motion_val represents:
1086 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1087 * - encoding: unused
1088 * - decoding: Set by libavcodec.
1090 uint8_t motion_subsample_log2;
1093 * for some private data of the user
1094 * - encoding: unused
1095 * - decoding: Set by user.
1101 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1102 * - decoding: unused
1104 uint64_t error[AV_NUM_DATA_POINTERS];
1107 * type of the buffer (to keep track of who has to deallocate data[*])
1108 * - encoding: Set by the one who allocates it.
1109 * - decoding: Set by the one who allocates it.
1110 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1115 * When decoding, this signals how much the picture must be delayed.
1116 * extra_delay = repeat_pict / (2*fps)
1117 * - encoding: unused
1118 * - decoding: Set by libavcodec.
1128 * The content of the picture is interlaced.
1129 * - encoding: Set by user.
1130 * - decoding: Set by libavcodec. (default 0)
1132 int interlaced_frame;
1135 * If the content is interlaced, is top field displayed first.
1136 * - encoding: Set by user.
1137 * - decoding: Set by libavcodec.
1139 int top_field_first;
1143 * - encoding: Set by user.
1144 * - decoding: Set by libavcodec.
1146 AVPanScan *pan_scan;
1149 * Tell user application that palette has changed from previous frame.
1150 * - encoding: ??? (no palette-enabled encoder yet)
1151 * - decoding: Set by libavcodec. (default 0).
1153 int palette_has_changed;
1156 * codec suggestion on buffer type if != 0
1157 * - encoding: unused
1158 * - decoding: Set by libavcodec. (before get_buffer() call)).
1164 * - encoding: unused
1165 * - decoding: Set by libavcodec.
1170 * motion reference frame index
1171 * the order in which these are stored can depend on the codec.
1172 * - encoding: Set by user.
1173 * - decoding: Set by libavcodec.
1175 int8_t *ref_index[2];
1178 * reordered opaque 64bit (generally an integer or a double precision float
1179 * PTS but can be anything).
1180 * The user sets AVCodecContext.reordered_opaque to represent the input at
1182 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1183 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1184 * @deprecated in favor of pkt_pts
1185 * - encoding: unused
1186 * - decoding: Read by user.
1188 int64_t reordered_opaque;
1191 * hardware accelerator private data (Libav-allocated)
1192 * - encoding: unused
1193 * - decoding: Set by libavcodec
1195 void *hwaccel_picture_private;
1198 * reordered pts from the last AVPacket that has been input into the decoder
1199 * - encoding: unused
1200 * - decoding: Read by user.
1205 * dts from the last AVPacket that has been input into the decoder
1206 * - encoding: unused
1207 * - decoding: Read by user.
1212 * the AVCodecContext which ff_thread_get_buffer() was last called on
1213 * - encoding: Set by libavcodec.
1214 * - decoding: Set by libavcodec.
1216 struct AVCodecContext *owner;
1219 * used by multithreading to store frame-specific info
1220 * - encoding: Set by libavcodec.
1221 * - decoding: Set by libavcodec.
1223 void *thread_opaque;
1226 * number of audio samples (per channel) described by this frame
1227 * - encoding: unused
1228 * - decoding: Set by libavcodec
1233 * pointers to the data planes/channels.
1235 * For video, this should simply point to data[].
1237 * For planar audio, each channel has a separate data pointer, and
1238 * linesize[0] contains the size of each channel buffer.
1239 * For packed audio, there is just one data pointer, and linesize[0]
1240 * contains the total size of the buffer for all channels.
1242 * Note: Both data and extended_data will always be set by get_buffer(),
1243 * but for planar audio with more channels that can fit in data,
1244 * extended_data must be used by the decoder in order to access all
1248 * decoding: set by AVCodecContext.get_buffer()
1250 uint8_t **extended_data;
1253 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1254 * - encoding: unused
1255 * - decoding: Read by user.
1257 AVRational sample_aspect_ratio;
1260 * width and height of the video frame
1261 * - encoding: unused
1262 * - decoding: Read by user.
1267 * format of the frame, -1 if unknown or unset
1268 * Values correspond to enum PixelFormat for video frames,
1269 * enum AVSampleFormat for audio)
1270 * - encoding: unused
1271 * - decoding: Read by user.
1276 struct AVCodecInternal;
1280 AV_FIELD_PROGRESSIVE,
1281 AV_FIELD_TT, //< Top coded_first, top displayed first
1282 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1283 AV_FIELD_TB, //< Top coded first, bottom displayed first
1284 AV_FIELD_BT, //< Bottom coded first, top displayed first
1288 * main external API structure.
1289 * New fields can be added to the end with minor version bumps.
1290 * Removal, reordering and changes to existing fields require a major
1292 * sizeof(AVCodecContext) must not be used outside libav*.
1294 typedef struct AVCodecContext {
1296 * information on struct for av_log
1297 * - set by avcodec_alloc_context3
1299 const AVClass *av_class;
1301 * the average bitrate
1302 * - encoding: Set by user; unused for constant quantizer encoding.
1303 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1308 * number of bits the bitstream is allowed to diverge from the reference.
1309 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1310 * - encoding: Set by user; unused for constant quantizer encoding.
1311 * - decoding: unused
1313 int bit_rate_tolerance;
1317 * - encoding: Set by user.
1318 * - decoding: Set by user.
1323 * Some codecs need additional format info. It is stored here.
1324 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1325 * specific codec MUST set it correctly otherwise stream copy breaks.
1326 * In general use of this field by muxers is not recommended.
1327 * - encoding: Set by libavcodec.
1328 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1333 * Motion estimation algorithm used for video coding.
1334 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1335 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1336 * - encoding: MUST be set by user.
1337 * - decoding: unused
1342 * some codecs need / can use extradata like Huffman tables.
1343 * mjpeg: Huffman tables
1344 * rv10: additional flags
1345 * mpeg4: global headers (they can be in the bitstream or here)
1346 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1347 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1348 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1349 * - encoding: Set/allocated/freed by libavcodec.
1350 * - decoding: Set/allocated/freed by user.
1356 * This is the fundamental unit of time (in seconds) in terms
1357 * of which frame timestamps are represented. For fixed-fps content,
1358 * timebase should be 1/framerate and timestamp increments should be
1360 * - encoding: MUST be set by user.
1361 * - decoding: Set by libavcodec.
1363 AVRational time_base;
1367 * picture width / height.
1368 * - encoding: MUST be set by user.
1369 * - decoding: Set by libavcodec.
1370 * Note: For compatibility it is possible to set this instead of
1371 * coded_width/height before decoding.
1375 #define FF_ASPECT_EXTENDED 15
1378 * the number of pictures in a group of pictures, or 0 for intra_only
1379 * - encoding: Set by user.
1380 * - decoding: unused
1385 * Pixel format, see PIX_FMT_xxx.
1386 * May be set by the demuxer if known from headers.
1387 * May be overriden by the decoder if it knows better.
1388 * - encoding: Set by user.
1389 * - decoding: Set by user if known, overridden by libavcodec if known
1391 enum PixelFormat pix_fmt;
1394 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1395 * decoder to draw a horizontal band. It improves cache usage. Not
1396 * all codecs can do that. You must check the codec capabilities
1398 * When multithreading is used, it may be called from multiple threads
1399 * at the same time; threads might draw different parts of the same AVFrame,
1400 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1402 * The function is also used by hardware acceleration APIs.
1403 * It is called at least once during frame decoding to pass
1404 * the data needed for hardware render.
1405 * In that mode instead of pixel data, AVFrame points to
1406 * a structure specific to the acceleration API. The application
1407 * reads the structure and can change some fields to indicate progress
1409 * - encoding: unused
1410 * - decoding: Set by user.
1411 * @param height the height of the slice
1412 * @param y the y position of the slice
1413 * @param type 1->top field, 2->bottom field, 3->frame
1414 * @param offset offset into the AVFrame.data from which the slice should be read
1416 void (*draw_horiz_band)(struct AVCodecContext *s,
1417 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1418 int y, int type, int height);
1421 int sample_rate; ///< samples per second
1422 int channels; ///< number of audio channels
1425 * audio sample format
1426 * - encoding: Set by user.
1427 * - decoding: Set by libavcodec.
1429 enum AVSampleFormat sample_fmt; ///< sample format
1431 /* The following data should not be initialized. */
1433 * Samples per packet, initialized when calling 'init'.
1436 int frame_number; ///< audio or video frame number
1439 * Number of frames the decoded output will be delayed relative to
1440 * the encoded input.
1441 * - encoding: Set by libavcodec.
1442 * - decoding: unused
1446 /* - encoding parameters */
1447 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1448 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1452 * - encoding: Set by user.
1453 * - decoding: unused
1459 * - encoding: Set by user.
1460 * - decoding: unused
1465 * maximum quantizer difference between frames
1466 * - encoding: Set by user.
1467 * - decoding: unused
1472 * maximum number of B-frames between non-B-frames
1473 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1474 * - encoding: Set by user.
1475 * - decoding: unused
1480 * qscale factor between IP and B-frames
1481 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1482 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1483 * - encoding: Set by user.
1484 * - decoding: unused
1486 float b_quant_factor;
1488 /** obsolete FIXME remove */
1490 #define FF_RC_STRATEGY_XVID 1
1492 int b_frame_strategy;
1494 struct AVCodec *codec;
1498 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1499 /* do its best to deliver a chunk with size */
1500 /* below rtp_payload_size, the chunk will start */
1501 /* with a start code on some codecs like H.263. */
1502 /* This doesn't take account of any particular */
1503 /* headers inside the transmitted RTP payload. */
1506 /* The RTP callback: This function is called */
1507 /* every time the encoder has a packet to send. */
1508 /* It depends on the encoder if the data starts */
1509 /* with a Start Code (it should). H.263 does. */
1510 /* mb_nb contains the number of macroblocks */
1511 /* encoded in the RTP payload. */
1512 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1514 /* statistics, used for 2-pass encoding */
1525 * number of bits used for the previously encoded frame
1526 * - encoding: Set by libavcodec.
1527 * - decoding: unused
1532 * Private data of the user, can be used to carry app specific stuff.
1533 * - encoding: Set by user.
1534 * - decoding: Set by user.
1538 char codec_name[32];
1539 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1540 enum CodecID codec_id; /* see CODEC_ID_xxx */
1543 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1544 * This is used to work around some encoder bugs.
1545 * A demuxer should set this to what is stored in the field used to identify the codec.
1546 * If there are multiple such fields in a container then the demuxer should choose the one
1547 * which maximizes the information about the used codec.
1548 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1549 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1550 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1552 * - encoding: Set by user, if not then the default based on codec_id will be used.
1553 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1555 unsigned int codec_tag;
1558 * Work around bugs in encoders which sometimes cannot be detected automatically.
1559 * - encoding: Set by user
1560 * - decoding: Set by user
1562 int workaround_bugs;
1563 #define FF_BUG_AUTODETECT 1 ///< autodetection
1564 #define FF_BUG_OLD_MSMPEG4 2
1565 #define FF_BUG_XVID_ILACE 4
1566 #define FF_BUG_UMP4 8
1567 #define FF_BUG_NO_PADDING 16
1568 #define FF_BUG_AMV 32
1569 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1570 #define FF_BUG_QPEL_CHROMA 64
1571 #define FF_BUG_STD_QPEL 128
1572 #define FF_BUG_QPEL_CHROMA2 256
1573 #define FF_BUG_DIRECT_BLOCKSIZE 512
1574 #define FF_BUG_EDGE 1024
1575 #define FF_BUG_HPEL_CHROMA 2048
1576 #define FF_BUG_DC_CLIP 4096
1577 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1578 #define FF_BUG_TRUNCATED 16384
1579 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1582 * luma single coefficient elimination threshold
1583 * - encoding: Set by user.
1584 * - decoding: unused
1586 int luma_elim_threshold;
1589 * chroma single coeff elimination threshold
1590 * - encoding: Set by user.
1591 * - decoding: unused
1593 int chroma_elim_threshold;
1596 * strictly follow the standard (MPEG4, ...).
1597 * - encoding: Set by user.
1598 * - decoding: Set by user.
1599 * Setting this to STRICT or higher means the encoder and decoder will
1600 * generally do stupid things, whereas setting it to unofficial or lower
1601 * will mean the encoder might produce output that is not supported by all
1602 * spec-compliant decoders. Decoders don't differentiate between normal,
1603 * unofficial and experimental (that is, they always try to decode things
1604 * when they can) unless they are explicitly asked to behave stupidly
1605 * (=strictly conform to the specs)
1607 int strict_std_compliance;
1608 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1609 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1610 #define FF_COMPLIANCE_NORMAL 0
1611 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1612 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1615 * qscale offset between IP and B-frames
1616 * - encoding: Set by user.
1617 * - decoding: unused
1619 float b_quant_offset;
1623 * Error recognition; higher values will detect more errors but may
1624 * misdetect some more or less valid parts as errors.
1625 * - encoding: unused
1626 * - decoding: Set by user.
1628 attribute_deprecated int error_recognition;
1629 #define FF_ER_CAREFUL 1
1630 #define FF_ER_COMPLIANT 2
1631 #define FF_ER_AGGRESSIVE 3
1632 #define FF_ER_VERY_AGGRESSIVE 4
1633 #define FF_ER_EXPLODE 5
1634 #endif /* FF_API_ER */
1637 * Called at the beginning of each frame to get a buffer for it.
1639 * The function will set AVFrame.data[], AVFrame.linesize[].
1640 * AVFrame.extended_data[] must also be set, but it should be the same as
1641 * AVFrame.data[] except for planar audio with more channels than can fit
1642 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1643 * many data pointers as it can hold.
1645 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1646 * avcodec_default_get_buffer() instead of providing buffers allocated by
1649 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1650 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1651 * but if get_buffer() is overridden then alignment considerations should
1652 * be taken into account.
1654 * @see avcodec_default_get_buffer()
1658 * If pic.reference is set then the frame will be read later by libavcodec.
1659 * avcodec_align_dimensions2() should be used to find the required width and
1660 * height, as they normally need to be rounded up to the next multiple of 16.
1662 * If frame multithreading is used and thread_safe_callbacks is set,
1663 * it may be called from a different thread, but not from more than one at
1664 * once. Does not need to be reentrant.
1666 * @see release_buffer(), reget_buffer()
1667 * @see avcodec_align_dimensions2()
1671 * Decoders request a buffer of a particular size by setting
1672 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1673 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1674 * to a smaller value in the output frame.
1676 * Decoders cannot use the buffer after returning from
1677 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1678 * is assumed to be released immediately upon return.
1680 * As a convenience, av_samples_get_buffer_size() and
1681 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1682 * functions to find the required data size and to fill data pointers and
1683 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1684 * since all planes must be the same size.
1686 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1688 * - encoding: unused
1689 * - decoding: Set by libavcodec, user can override.
1691 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1694 * Called to release buffers which were allocated with get_buffer.
1695 * A released buffer can be reused in get_buffer().
1696 * pic.data[*] must be set to NULL.
1697 * May be called from a different thread if frame multithreading is used,
1698 * but not by more than one thread at once, so does not need to be reentrant.
1699 * - encoding: unused
1700 * - decoding: Set by libavcodec, user can override.
1702 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1705 * Size of the frame reordering buffer in the decoder.
1706 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1707 * - encoding: Set by libavcodec.
1708 * - decoding: Set by libavcodec.
1713 * number of bytes per packet if constant and known or 0
1714 * Used by some WAV based audio codecs.
1718 #if FF_API_PARSE_FRAME
1720 * If true, only parsing is done. The frame data is returned.
1721 * Only MPEG audio decoders support this now.
1722 * - encoding: unused
1723 * - decoding: Set by user
1725 attribute_deprecated int parse_only;
1729 * 0-> h263 quant 1-> mpeg quant
1730 * - encoding: Set by user.
1731 * - decoding: unused
1736 * pass1 encoding statistics output buffer
1737 * - encoding: Set by libavcodec.
1738 * - decoding: unused
1743 * pass2 encoding statistics input buffer
1744 * Concatenated stuff from stats_out of pass1 should be placed here.
1745 * - encoding: Allocated/set/freed by user.
1746 * - decoding: unused
1751 * ratecontrol qmin qmax limiting method
1752 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1753 * - encoding: Set by user.
1754 * - decoding: unused
1762 * ratecontrol override, see RcOverride
1763 * - encoding: Allocated/set/freed by user.
1764 * - decoding: unused
1766 RcOverride *rc_override;
1767 int rc_override_count;
1770 * rate control equation
1771 * - encoding: Set by user
1772 * - decoding: unused
1778 * - encoding: Set by user.
1779 * - decoding: unused
1785 * - encoding: Set by user.
1786 * - decoding: unused
1791 * decoder bitstream buffer size
1792 * - encoding: Set by user.
1793 * - decoding: unused
1796 float rc_buffer_aggressivity;
1799 * qscale factor between P and I-frames
1800 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1801 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1802 * - encoding: Set by user.
1803 * - decoding: unused
1805 float i_quant_factor;
1808 * qscale offset between P and I-frames
1809 * - encoding: Set by user.
1810 * - decoding: unused
1812 float i_quant_offset;
1815 * initial complexity for pass1 ratecontrol
1816 * - encoding: Set by user.
1817 * - decoding: unused
1819 float rc_initial_cplx;
1822 * DCT algorithm, see FF_DCT_* below
1823 * - encoding: Set by user.
1824 * - decoding: unused
1827 #define FF_DCT_AUTO 0
1828 #define FF_DCT_FASTINT 1
1829 #define FF_DCT_INT 2
1830 #define FF_DCT_MMX 3
1831 #define FF_DCT_MLIB 4
1832 #define FF_DCT_ALTIVEC 5
1833 #define FF_DCT_FAAN 6
1836 * luminance masking (0-> disabled)
1837 * - encoding: Set by user.
1838 * - decoding: unused
1843 * temporary complexity masking (0-> disabled)
1844 * - encoding: Set by user.
1845 * - decoding: unused
1847 float temporal_cplx_masking;
1850 * spatial complexity masking (0-> disabled)
1851 * - encoding: Set by user.
1852 * - decoding: unused
1854 float spatial_cplx_masking;
1857 * p block masking (0-> disabled)
1858 * - encoding: Set by user.
1859 * - decoding: unused
1864 * darkness masking (0-> disabled)
1865 * - encoding: Set by user.
1866 * - decoding: unused
1871 * IDCT algorithm, see FF_IDCT_* below.
1872 * - encoding: Set by user.
1873 * - decoding: Set by user.
1876 #define FF_IDCT_AUTO 0
1877 #define FF_IDCT_INT 1
1878 #define FF_IDCT_SIMPLE 2
1879 #define FF_IDCT_SIMPLEMMX 3
1880 #define FF_IDCT_LIBMPEG2MMX 4
1881 #define FF_IDCT_PS2 5
1882 #define FF_IDCT_MLIB 6
1883 #define FF_IDCT_ARM 7
1884 #define FF_IDCT_ALTIVEC 8
1885 #define FF_IDCT_SH4 9
1886 #define FF_IDCT_SIMPLEARM 10
1887 #define FF_IDCT_H264 11
1888 #define FF_IDCT_VP3 12
1889 #define FF_IDCT_IPP 13
1890 #define FF_IDCT_XVIDMMX 14
1891 #define FF_IDCT_CAVS 15
1892 #define FF_IDCT_SIMPLEARMV5TE 16
1893 #define FF_IDCT_SIMPLEARMV6 17
1894 #define FF_IDCT_SIMPLEVIS 18
1895 #define FF_IDCT_WMV2 19
1896 #define FF_IDCT_FAAN 20
1897 #define FF_IDCT_EA 21
1898 #define FF_IDCT_SIMPLENEON 22
1899 #define FF_IDCT_SIMPLEALPHA 23
1900 #define FF_IDCT_BINK 24
1904 * - encoding: Set by libavcodec.
1905 * - decoding: Set by user (or 0).
1909 * slice offsets in the frame in bytes
1910 * - encoding: Set/allocated by libavcodec.
1911 * - decoding: Set/allocated by user (or NULL).
1916 * error concealment flags
1917 * - encoding: unused
1918 * - decoding: Set by user.
1920 int error_concealment;
1921 #define FF_EC_GUESS_MVS 1
1922 #define FF_EC_DEBLOCK 2
1925 * dsp_mask could be add used to disable unwanted CPU features
1926 * CPU features (i.e. MMX, SSE. ...)
1928 * With the FORCE flag you may instead enable given CPU features.
1929 * (Dangerous: Usable in case of misdetection, improper usage however will
1930 * result into program crash.)
1935 * bits per sample/pixel from the demuxer (needed for huffyuv).
1936 * - encoding: Set by libavcodec.
1937 * - decoding: Set by user.
1939 int bits_per_coded_sample;
1942 * prediction method (needed for huffyuv)
1943 * - encoding: Set by user.
1944 * - decoding: unused
1946 int prediction_method;
1947 #define FF_PRED_LEFT 0
1948 #define FF_PRED_PLANE 1
1949 #define FF_PRED_MEDIAN 2
1952 * sample aspect ratio (0 if unknown)
1953 * That is the width of a pixel divided by the height of the pixel.
1954 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1955 * - encoding: Set by user.
1956 * - decoding: Set by libavcodec.
1958 AVRational sample_aspect_ratio;
1961 * the picture in the bitstream
1962 * - encoding: Set by libavcodec.
1963 * - decoding: Set by libavcodec.
1965 AVFrame *coded_frame;
1969 * - encoding: Set by user.
1970 * - decoding: Set by user.
1973 #define FF_DEBUG_PICT_INFO 1
1974 #define FF_DEBUG_RC 2
1975 #define FF_DEBUG_BITSTREAM 4
1976 #define FF_DEBUG_MB_TYPE 8
1977 #define FF_DEBUG_QP 16
1978 #define FF_DEBUG_MV 32
1979 #define FF_DEBUG_DCT_COEFF 0x00000040
1980 #define FF_DEBUG_SKIP 0x00000080
1981 #define FF_DEBUG_STARTCODE 0x00000100
1982 #define FF_DEBUG_PTS 0x00000200
1983 #define FF_DEBUG_ER 0x00000400
1984 #define FF_DEBUG_MMCO 0x00000800
1985 #define FF_DEBUG_BUGS 0x00001000
1986 #define FF_DEBUG_VIS_QP 0x00002000
1987 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1988 #define FF_DEBUG_BUFFERS 0x00008000
1989 #define FF_DEBUG_THREADS 0x00010000
1993 * - encoding: Set by user.
1994 * - decoding: Set by user.
1997 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1998 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1999 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2003 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2004 * - decoding: unused
2006 uint64_t error[AV_NUM_DATA_POINTERS];
2009 * motion estimation comparison function
2010 * - encoding: Set by user.
2011 * - decoding: unused
2015 * subpixel motion estimation comparison function
2016 * - encoding: Set by user.
2017 * - decoding: unused
2021 * macroblock comparison function (not supported yet)
2022 * - encoding: Set by user.
2023 * - decoding: unused
2027 * interlaced DCT comparison function
2028 * - encoding: Set by user.
2029 * - decoding: unused
2032 #define FF_CMP_SAD 0
2033 #define FF_CMP_SSE 1
2034 #define FF_CMP_SATD 2
2035 #define FF_CMP_DCT 3
2036 #define FF_CMP_PSNR 4
2037 #define FF_CMP_BIT 5
2039 #define FF_CMP_ZERO 7
2040 #define FF_CMP_VSAD 8
2041 #define FF_CMP_VSSE 9
2042 #define FF_CMP_NSSE 10
2043 #define FF_CMP_W53 11
2044 #define FF_CMP_W97 12
2045 #define FF_CMP_DCTMAX 13
2046 #define FF_CMP_DCT264 14
2047 #define FF_CMP_CHROMA 256
2050 * ME diamond size & shape
2051 * - encoding: Set by user.
2052 * - decoding: unused
2057 * amount of previous MV predictors (2a+1 x 2a+1 square)
2058 * - encoding: Set by user.
2059 * - decoding: unused
2061 int last_predictor_count;
2064 * prepass for motion estimation
2065 * - encoding: Set by user.
2066 * - decoding: unused
2071 * motion estimation prepass comparison function
2072 * - encoding: Set by user.
2073 * - decoding: unused
2078 * ME prepass diamond size & shape
2079 * - encoding: Set by user.
2080 * - decoding: unused
2086 * - encoding: Set by user.
2087 * - decoding: unused
2089 int me_subpel_quality;
2092 * callback to negotiate the pixelFormat
2093 * @param fmt is the list of formats which are supported by the codec,
2094 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2095 * The first is always the native one.
2096 * @return the chosen format
2097 * - encoding: unused
2098 * - decoding: Set by user, if not set the native format will be chosen.
2100 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
2103 * DTG active format information (additional aspect ratio
2104 * information only used in DVB MPEG-2 transport streams)
2107 * - encoding: unused
2108 * - decoding: Set by decoder.
2110 int dtg_active_format;
2111 #define FF_DTG_AFD_SAME 8
2112 #define FF_DTG_AFD_4_3 9
2113 #define FF_DTG_AFD_16_9 10
2114 #define FF_DTG_AFD_14_9 11
2115 #define FF_DTG_AFD_4_3_SP_14_9 13
2116 #define FF_DTG_AFD_16_9_SP_14_9 14
2117 #define FF_DTG_AFD_SP_4_3 15
2120 * maximum motion estimation search range in subpel units
2121 * If 0 then no limit.
2123 * - encoding: Set by user.
2124 * - decoding: unused
2129 * intra quantizer bias
2130 * - encoding: Set by user.
2131 * - decoding: unused
2133 int intra_quant_bias;
2134 #define FF_DEFAULT_QUANT_BIAS 999999
2137 * inter quantizer bias
2138 * - encoding: Set by user.
2139 * - decoding: unused
2141 int inter_quant_bias;
2145 * - encoding: unused
2146 * - decoding: Which clrtable should be used for 8bit RGB images.
2147 * Tables have to be stored somewhere. FIXME
2151 #if FF_API_INTERNAL_CONTEXT
2153 * internal_buffer count
2154 * Don't touch, used by libavcodec default_get_buffer().
2155 * @deprecated this field was moved to an internal context
2157 attribute_deprecated int internal_buffer_count;
2161 * Don't touch, used by libavcodec default_get_buffer().
2162 * @deprecated this field was moved to an internal context
2164 attribute_deprecated void *internal_buffer;
2168 * Global quality for codecs which cannot change it per frame.
2169 * This should be proportional to MPEG-1/2/4 qscale.
2170 * - encoding: Set by user.
2171 * - decoding: unused
2175 #define FF_CODER_TYPE_VLC 0
2176 #define FF_CODER_TYPE_AC 1
2177 #define FF_CODER_TYPE_RAW 2
2178 #define FF_CODER_TYPE_RLE 3
2179 #define FF_CODER_TYPE_DEFLATE 4
2182 * - encoding: Set by user.
2183 * - decoding: unused
2189 * - encoding: Set by user.
2190 * - decoding: unused
2196 * - encoding: unused
2197 * - decoding: Set by user.
2199 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2204 * - encoding: unused
2205 * - decoding: Set by user.
2208 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2209 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2210 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2213 * XVideo Motion Acceleration
2214 * - encoding: forbidden
2215 * - decoding: set by decoder
2217 int xvmc_acceleration;
2220 * macroblock decision mode
2221 * - encoding: Set by user.
2222 * - decoding: unused
2225 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2226 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2227 #define FF_MB_DECISION_RD 2 ///< rate distortion
2230 * custom intra quantization matrix
2231 * - encoding: Set by user, can be NULL.
2232 * - decoding: Set by libavcodec.
2234 uint16_t *intra_matrix;
2237 * custom inter quantization matrix
2238 * - encoding: Set by user, can be NULL.
2239 * - decoding: Set by libavcodec.
2241 uint16_t *inter_matrix;
2244 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2245 * This is used to work around some encoder bugs.
2246 * - encoding: unused
2247 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2249 unsigned int stream_codec_tag;
2252 * scene change detection threshold
2253 * 0 is default, larger means fewer detected scene changes.
2254 * - encoding: Set by user.
2255 * - decoding: unused
2257 int scenechange_threshold;
2260 * minimum Lagrange multipler
2261 * - encoding: Set by user.
2262 * - decoding: unused
2267 * maximum Lagrange multipler
2268 * - encoding: Set by user.
2269 * - decoding: unused
2274 * noise reduction strength
2275 * - encoding: Set by user.
2276 * - decoding: unused
2278 int noise_reduction;
2281 * Called at the beginning of a frame to get cr buffer for it.
2282 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2283 * libavcodec will pass previous buffer in pic, function should return
2284 * same buffer or new buffer with old frame "painted" into it.
2285 * If pic.data[0] == NULL must behave like get_buffer().
2286 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2287 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2289 * - encoding: unused
2290 * - decoding: Set by libavcodec, user can override.
2292 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2295 * Number of bits which should be loaded into the rc buffer before decoding starts.
2296 * - encoding: Set by user.
2297 * - decoding: unused
2299 int rc_initial_buffer_occupancy;
2303 * - encoding: Set by user.
2304 * - decoding: unused
2306 int inter_threshold;
2310 * - encoding: Set by user.
2311 * - decoding: Set by user.
2316 * Simulates errors in the bitstream to test error concealment.
2317 * - encoding: Set by user.
2318 * - decoding: unused
2322 #if FF_API_ANTIALIAS_ALGO
2324 * MP3 antialias algorithm, see FF_AA_* below.
2325 * - encoding: unused
2326 * - decoding: Set by user.
2328 attribute_deprecated int antialias_algo;
2329 #define FF_AA_AUTO 0
2330 #define FF_AA_FASTINT 1 //not implemented yet
2332 #define FF_AA_FLOAT 3
2336 * quantizer noise shaping
2337 * - encoding: Set by user.
2338 * - decoding: unused
2340 int quantizer_noise_shaping;
2344 * is used to decide how many independent tasks should be passed to execute()
2345 * - encoding: Set by user.
2346 * - decoding: Set by user.
2351 * The codec may call this to execute several independent things.
2352 * It will return only after finishing all tasks.
2353 * The user may replace this with some multithreaded implementation,
2354 * the default implementation will execute the parts serially.
2355 * @param count the number of things to execute
2356 * - encoding: Set by libavcodec, user can override.
2357 * - decoding: Set by libavcodec, user can override.
2359 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2363 * Can be used by execute() to store some per AVCodecContext stuff.
2364 * - encoding: set by execute()
2365 * - decoding: set by execute()
2367 void *thread_opaque;
2370 * Motion estimation threshold below which no motion estimation is
2371 * performed, but instead the user specified motion vectors are used.
2373 * - encoding: Set by user.
2374 * - decoding: unused
2379 * Macroblock threshold below which the user specified macroblock types will be used.
2380 * - encoding: Set by user.
2381 * - decoding: unused
2386 * precision of the intra DC coefficient - 8
2387 * - encoding: Set by user.
2388 * - decoding: unused
2390 int intra_dc_precision;
2393 * noise vs. sse weight for the nsse comparsion function
2394 * - encoding: Set by user.
2395 * - decoding: unused
2400 * Number of macroblock rows at the top which are skipped.
2401 * - encoding: unused
2402 * - decoding: Set by user.
2407 * Number of macroblock rows at the bottom which are skipped.
2408 * - encoding: unused
2409 * - decoding: Set by user.
2415 * - encoding: Set by user.
2416 * - decoding: Set by libavcodec.
2419 #define FF_PROFILE_UNKNOWN -99
2420 #define FF_PROFILE_RESERVED -100
2422 #define FF_PROFILE_AAC_MAIN 0
2423 #define FF_PROFILE_AAC_LOW 1
2424 #define FF_PROFILE_AAC_SSR 2
2425 #define FF_PROFILE_AAC_LTP 3
2427 #define FF_PROFILE_DTS 20
2428 #define FF_PROFILE_DTS_ES 30
2429 #define FF_PROFILE_DTS_96_24 40
2430 #define FF_PROFILE_DTS_HD_HRA 50
2431 #define FF_PROFILE_DTS_HD_MA 60
2433 #define FF_PROFILE_MPEG2_422 0
2434 #define FF_PROFILE_MPEG2_HIGH 1
2435 #define FF_PROFILE_MPEG2_SS 2
2436 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2437 #define FF_PROFILE_MPEG2_MAIN 4
2438 #define FF_PROFILE_MPEG2_SIMPLE 5
2440 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2441 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2443 #define FF_PROFILE_H264_BASELINE 66
2444 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2445 #define FF_PROFILE_H264_MAIN 77
2446 #define FF_PROFILE_H264_EXTENDED 88
2447 #define FF_PROFILE_H264_HIGH 100
2448 #define FF_PROFILE_H264_HIGH_10 110
2449 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2450 #define FF_PROFILE_H264_HIGH_422 122
2451 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2452 #define FF_PROFILE_H264_HIGH_444 144
2453 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2454 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2455 #define FF_PROFILE_H264_CAVLC_444 44
2457 #define FF_PROFILE_VC1_SIMPLE 0
2458 #define FF_PROFILE_VC1_MAIN 1
2459 #define FF_PROFILE_VC1_COMPLEX 2
2460 #define FF_PROFILE_VC1_ADVANCED 3
2462 #define FF_PROFILE_MPEG4_SIMPLE 0
2463 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2464 #define FF_PROFILE_MPEG4_CORE 2
2465 #define FF_PROFILE_MPEG4_MAIN 3
2466 #define FF_PROFILE_MPEG4_N_BIT 4
2467 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2468 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2469 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2470 #define FF_PROFILE_MPEG4_HYBRID 8
2471 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2472 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2473 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2474 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2475 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2476 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2477 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2481 * - encoding: Set by user.
2482 * - decoding: Set by libavcodec.
2485 #define FF_LEVEL_UNKNOWN -99
2488 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2489 * - encoding: unused
2490 * - decoding: Set by user.
2495 * Bitstream width / height, may be different from width/height if lowres enabled.
2496 * - encoding: unused
2497 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2499 int coded_width, coded_height;
2502 * frame skip threshold
2503 * - encoding: Set by user.
2504 * - decoding: unused
2506 int frame_skip_threshold;
2510 * - encoding: Set by user.
2511 * - decoding: unused
2513 int frame_skip_factor;
2516 * frame skip exponent
2517 * - encoding: Set by user.
2518 * - decoding: unused
2523 * frame skip comparison function
2524 * - encoding: Set by user.
2525 * - decoding: unused
2530 * Border processing masking, raises the quantizer for mbs on the borders
2532 * - encoding: Set by user.
2533 * - decoding: unused
2535 float border_masking;
2538 * minimum MB lagrange multipler
2539 * - encoding: Set by user.
2540 * - decoding: unused
2545 * maximum MB lagrange multipler
2546 * - encoding: Set by user.
2547 * - decoding: unused
2553 * - encoding: Set by user.
2554 * - decoding: unused
2556 int me_penalty_compensation;
2560 * - encoding: unused
2561 * - decoding: Set by user.
2563 enum AVDiscard skip_loop_filter;
2567 * - encoding: unused
2568 * - decoding: Set by user.
2570 enum AVDiscard skip_idct;
2574 * - encoding: unused
2575 * - decoding: Set by user.
2577 enum AVDiscard skip_frame;
2581 * - encoding: Set by user.
2582 * - decoding: unused
2588 * - encoding: Set by user.
2589 * - decoding: unused
2595 * - encoding: Set by user.
2596 * - decoding: unused
2601 * number of reference frames
2602 * - encoding: Set by user.
2603 * - decoding: Set by lavc.
2608 * chroma qp offset from luma
2609 * - encoding: Set by user.
2610 * - decoding: unused
2615 * trellis RD quantization
2616 * - encoding: Set by user.
2617 * - decoding: unused
2622 * Audio cutoff bandwidth (0 means "automatic")
2623 * - encoding: Set by user.
2624 * - decoding: unused
2629 * Multiplied by qscale for each frame and added to scene_change_score.
2630 * - encoding: Set by user.
2631 * - decoding: unused
2633 int scenechange_factor;
2637 * Note: Value depends upon the compare function used for fullpel ME.
2638 * - encoding: Set by user.
2639 * - decoding: unused
2644 * Adjust sensitivity of b_frame_strategy 1.
2645 * - encoding: Set by user.
2646 * - decoding: unused
2651 * - encoding: Set by user.
2652 * - decoding: unused
2654 int compression_level;
2655 #define FF_COMPRESSION_DEFAULT -1
2658 * - encoding: Set by user.
2659 * - decoding: unused
2661 int min_prediction_order;
2664 * - encoding: Set by user.
2665 * - decoding: unused
2667 int max_prediction_order;
2669 #if FF_API_FLAC_GLOBAL_OPTS
2671 * @name FLAC options
2672 * @deprecated Use FLAC encoder private options instead.
2677 * LPC coefficient precision - used by FLAC encoder
2678 * - encoding: Set by user.
2679 * - decoding: unused
2681 attribute_deprecated int lpc_coeff_precision;
2684 * search method for selecting prediction order
2685 * - encoding: Set by user.
2686 * - decoding: unused
2688 attribute_deprecated int prediction_order_method;
2691 * - encoding: Set by user.
2692 * - decoding: unused
2694 attribute_deprecated int min_partition_order;
2697 * - encoding: Set by user.
2698 * - decoding: unused
2700 attribute_deprecated int max_partition_order;
2707 * GOP timecode frame start number, in non drop frame format
2708 * - encoding: Set by user.
2709 * - decoding: unused
2711 int64_t timecode_frame_start;
2713 #if FF_API_REQUEST_CHANNELS
2715 * Decoder should decode to this many channels if it can (0 for default)
2716 * - encoding: unused
2717 * - decoding: Set by user.
2718 * @deprecated Deprecated in favor of request_channel_layout.
2720 int request_channels;
2723 #if FF_API_DRC_SCALE
2725 * Percentage of dynamic range compression to be applied by the decoder.
2726 * The default value is 1.0, corresponding to full compression.
2727 * - encoding: unused
2728 * - decoding: Set by user.
2729 * @deprecated use AC3 decoder private option instead.
2731 attribute_deprecated float drc_scale;
2735 * opaque 64bit number (generally a PTS) that will be reordered and
2736 * output in AVFrame.reordered_opaque
2737 * @deprecated in favor of pkt_pts
2738 * - encoding: unused
2739 * - decoding: Set by user.
2741 int64_t reordered_opaque;
2744 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2745 * - encoding: set by user.
2746 * - decoding: set by libavcodec.
2748 int bits_per_raw_sample;
2751 * Audio channel layout.
2752 * - encoding: set by user.
2753 * - decoding: set by libavcodec.
2755 uint64_t channel_layout;
2758 * Request decoder to use this channel layout if it can (0 for default)
2759 * - encoding: unused
2760 * - decoding: Set by user.
2762 uint64_t request_channel_layout;
2765 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2766 * - encoding: Set by user.
2767 * - decoding: unused.
2769 float rc_max_available_vbv_use;
2772 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2773 * - encoding: Set by user.
2774 * - decoding: unused.
2776 float rc_min_vbv_overflow_use;
2779 * Hardware accelerator in use
2780 * - encoding: unused.
2781 * - decoding: Set by libavcodec
2783 struct AVHWAccel *hwaccel;
2786 * For some codecs, the time base is closer to the field rate than the frame rate.
2787 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2788 * if no telecine is used ...
2790 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2792 int ticks_per_frame;
2795 * Hardware accelerator context.
2796 * For some hardware accelerators, a global context needs to be
2797 * provided by the user. In that case, this holds display-dependent
2798 * data Libav cannot instantiate itself. Please refer to the
2799 * Libav HW accelerator documentation to know how to fill this
2800 * is. e.g. for VA API, this is a struct vaapi_context.
2801 * - encoding: unused
2802 * - decoding: Set by user
2804 void *hwaccel_context;
2807 * Chromaticity coordinates of the source primaries.
2808 * - encoding: Set by user
2809 * - decoding: Set by libavcodec
2811 enum AVColorPrimaries color_primaries;
2814 * Color Transfer Characteristic.
2815 * - encoding: Set by user
2816 * - decoding: Set by libavcodec
2818 enum AVColorTransferCharacteristic color_trc;
2821 * YUV colorspace type.
2822 * - encoding: Set by user
2823 * - decoding: Set by libavcodec
2825 enum AVColorSpace colorspace;
2828 * MPEG vs JPEG YUV range.
2829 * - encoding: Set by user
2830 * - decoding: Set by libavcodec
2832 enum AVColorRange color_range;
2835 * This defines the location of chroma samples.
2836 * - encoding: Set by user
2837 * - decoding: Set by libavcodec
2839 enum AVChromaLocation chroma_sample_location;
2842 * The codec may call this to execute several independent things.
2843 * It will return only after finishing all tasks.
2844 * The user may replace this with some multithreaded implementation,
2845 * the default implementation will execute the parts serially.
2846 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2847 * @param c context passed also to func
2848 * @param count the number of things to execute
2849 * @param arg2 argument passed unchanged to func
2850 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2851 * @param func function that will be called count times, with jobnr from 0 to count-1.
2852 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2853 * two instances of func executing at the same time will have the same threadnr.
2854 * @return always 0 currently, but code should handle a future improvement where when any call to func
2855 * returns < 0 no further calls to func may be done and < 0 is returned.
2856 * - encoding: Set by libavcodec, user can override.
2857 * - decoding: Set by libavcodec, user can override.
2859 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2861 int log_level_offset;
2863 #if FF_API_FLAC_GLOBAL_OPTS
2865 * Determine which LPC analysis algorithm to use.
2866 * - encoding: Set by user
2867 * - decoding: unused
2869 attribute_deprecated enum AVLPCType lpc_type;
2872 * Number of passes to use for Cholesky factorization during LPC analysis
2873 * - encoding: Set by user
2874 * - decoding: unused
2876 attribute_deprecated int lpc_passes;
2881 * Indicates number of picture subdivisions. Used for parallelized
2883 * - encoding: Set by user
2884 * - decoding: unused
2889 * Header containing style information for text subtitles.
2890 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2891 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2892 * the Format line following. It shouldn't include any Dialogue line.
2893 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2894 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2896 uint8_t *subtitle_header;
2897 int subtitle_header_size;
2900 * Current packet as passed into the decoder, to avoid having
2901 * to pass the packet into every function. Currently only valid
2902 * inside lavc and get/release_buffer callbacks.
2903 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2904 * - encoding: unused
2908 #if FF_API_INTERNAL_CONTEXT
2910 * Whether this is a copy of the context which had init() called on it.
2911 * This is used by multithreading - shared tables and picture pointers
2912 * should be freed from the original context only.
2913 * - encoding: Set by libavcodec.
2914 * - decoding: Set by libavcodec.
2916 * @deprecated this field has been moved to an internal context
2918 attribute_deprecated int is_copy;
2922 * Which multithreading methods to use.
2923 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2924 * so clients which cannot provide future frames should not use it.
2926 * - encoding: Set by user, otherwise the default is used.
2927 * - decoding: Set by user, otherwise the default is used.
2930 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2931 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2934 * Which multithreading methods are in use by the codec.
2935 * - encoding: Set by libavcodec.
2936 * - decoding: Set by libavcodec.
2938 int active_thread_type;
2941 * Set by the client if its custom get_buffer() callback can be called
2942 * from another thread, which allows faster multithreaded decoding.
2943 * draw_horiz_band() will be called from other threads regardless of this setting.
2944 * Ignored if the default get_buffer() is used.
2945 * - encoding: Set by user.
2946 * - decoding: Set by user.
2948 int thread_safe_callbacks;
2951 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2952 * Used for compliant TS muxing.
2953 * - encoding: Set by libavcodec.
2954 * - decoding: unused.
2959 * Type of service that the audio stream conveys.
2960 * - encoding: Set by user.
2961 * - decoding: Set by libavcodec.
2963 enum AVAudioServiceType audio_service_type;
2966 * Used to request a sample format from the decoder.
2967 * - encoding: unused.
2968 * - decoding: Set by user.
2970 enum AVSampleFormat request_sample_fmt;
2973 * Error recognition; may misdetect some more or less valid parts as errors.
2974 * - encoding: unused
2975 * - decoding: Set by user.
2977 int err_recognition;
2978 #define AV_EF_CRCCHECK (1<<0)
2979 #define AV_EF_BITSTREAM (1<<1)
2980 #define AV_EF_BUFFER (1<<2)
2981 #define AV_EF_EXPLODE (1<<3)
2984 * Private context used for internal data.
2986 * Unlike priv_data, this is not codec-specific. It is used in general
2987 * libavcodec functions.
2989 struct AVCodecInternal *internal;
2992 * - encoding: set by libavcodec
2993 * - decoding: Set by libavcodec
2995 enum AVFieldOrder field_order;
3001 typedef struct AVProfile {
3003 const char *name; ///< short name for the profile
3006 typedef struct AVCodecDefault AVCodecDefault;
3011 typedef struct AVCodec {
3013 * Name of the codec implementation.
3014 * The name is globally unique among encoders and among decoders (but an
3015 * encoder and a decoder can share the same name).
3016 * This is the primary way to find a codec from the user perspective.
3019 enum AVMediaType type;
3022 int (*init)(AVCodecContext *);
3023 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
3024 int (*close)(AVCodecContext *);
3025 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3027 * Codec capabilities.
3031 struct AVCodec *next;
3034 * Will be called when seeking
3036 void (*flush)(AVCodecContext *);
3037 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3038 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3040 * Descriptive name for the codec, meant to be more human readable than name.
3041 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3043 const char *long_name;
3044 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3045 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3046 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3047 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3048 const AVClass *priv_class; ///< AVClass for the private context
3049 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3052 * @name Frame-level threading support functions
3056 * If defined, called on thread contexts when they are created.
3057 * If the codec allocates writable tables in init(), re-allocate them here.
3058 * priv_data will be set to a copy of the original.
3060 int (*init_thread_copy)(AVCodecContext *);
3062 * Copy necessary context variables from a previous thread context to the current one.
3063 * If not defined, the next thread will start automatically; otherwise, the codec
3064 * must call ff_thread_finish_setup().
3066 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3068 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3072 * Private codec-specific defaults.
3074 const AVCodecDefault *defaults;
3077 * Initialize codec static data, called from avcodec_register().
3079 void (*init_static_data)(struct AVCodec *codec);
3082 * Encode data to an AVPacket.
3084 * @param avctx codec context
3085 * @param avpkt output AVPacket (may contain a user-provided buffer)
3086 * @param[in] frame AVFrame containing the raw data to be encoded
3087 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3088 * non-empty packet was returned in avpkt.
3089 * @return 0 on success, negative error code on failure
3091 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3092 int *got_packet_ptr);
3098 typedef struct AVHWAccel {
3100 * Name of the hardware accelerated codec.
3101 * The name is globally unique among encoders and among decoders (but an
3102 * encoder and a decoder can share the same name).
3107 * Type of codec implemented by the hardware accelerator.
3109 * See AVMEDIA_TYPE_xxx
3111 enum AVMediaType type;
3114 * Codec implemented by the hardware accelerator.
3121 * Supported pixel format.
3123 * Only hardware accelerated formats are supported here.
3125 enum PixelFormat pix_fmt;
3128 * Hardware accelerated codec capabilities.
3129 * see FF_HWACCEL_CODEC_CAP_*
3133 struct AVHWAccel *next;
3136 * Called at the beginning of each frame or field picture.
3138 * Meaningful frame information (codec specific) is guaranteed to
3139 * be parsed at this point. This function is mandatory.
3141 * Note that buf can be NULL along with buf_size set to 0.
3142 * Otherwise, this means the whole frame is available at this point.
3144 * @param avctx the codec context
3145 * @param buf the frame data buffer base
3146 * @param buf_size the size of the frame in bytes
3147 * @return zero if successful, a negative value otherwise
3149 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3152 * Callback for each slice.
3154 * Meaningful slice information (codec specific) is guaranteed to
3155 * be parsed at this point. This function is mandatory.
3157 * @param avctx the codec context
3158 * @param buf the slice data buffer base
3159 * @param buf_size the size of the slice in bytes
3160 * @return zero if successful, a negative value otherwise
3162 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3165 * Called at the end of each frame or field picture.
3167 * The whole picture is parsed at this point and can now be sent
3168 * to the hardware accelerator. This function is mandatory.
3170 * @param avctx the codec context
3171 * @return zero if successful, a negative value otherwise
3173 int (*end_frame)(AVCodecContext *avctx);
3176 * Size of HW accelerator private data.
3178 * Private data is allocated with av_mallocz() before
3179 * AVCodecContext.get_buffer() and deallocated after
3180 * AVCodecContext.release_buffer().
3186 * four components are given, that's all.
3187 * the last component is alpha
3189 typedef struct AVPicture {
3190 uint8_t *data[AV_NUM_DATA_POINTERS];
3191 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3194 #define AVPALETTE_SIZE 1024
3195 #define AVPALETTE_COUNT 256
3197 enum AVSubtitleType {
3200 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3203 * Plain text, the text field must be set by the decoder and is
3204 * authoritative. ass and pict fields may contain approximations.
3209 * Formatted text, the ass field must be set by the decoder and is
3210 * authoritative. pict and text fields may contain approximations.
3215 typedef struct AVSubtitleRect {
3216 int x; ///< top left corner of pict, undefined when pict is not set
3217 int y; ///< top left corner of pict, undefined when pict is not set
3218 int w; ///< width of pict, undefined when pict is not set
3219 int h; ///< height of pict, undefined when pict is not set
3220 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3223 * data+linesize for the bitmap of this subtitle.
3224 * can be set for text/ass as well once they where rendered
3227 enum AVSubtitleType type;
3229 char *text; ///< 0 terminated plain UTF-8 text
3232 * 0 terminated ASS/SSA compatible event line.
3233 * The pressentation of this is unaffected by the other values in this
3239 typedef struct AVSubtitle {
3240 uint16_t format; /* 0 = graphics */
3241 uint32_t start_display_time; /* relative to packet pts, in ms */
3242 uint32_t end_display_time; /* relative to packet pts, in ms */
3244 AVSubtitleRect **rects;
3245 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3248 /* packet functions */
3251 * @deprecated use NULL instead
3253 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3256 * Default packet destructor.
3258 void av_destruct_packet(AVPacket *pkt);
3261 * Initialize optional fields of a packet with default values.
3265 void av_init_packet(AVPacket *pkt);
3268 * Allocate the payload of a packet and initialize its fields with
3272 * @param size wanted payload size
3273 * @return 0 if OK, AVERROR_xxx otherwise
3275 int av_new_packet(AVPacket *pkt, int size);
3278 * Reduce packet size, correctly zeroing padding
3281 * @param size new size
3283 void av_shrink_packet(AVPacket *pkt, int size);
3286 * Increase packet size, correctly zeroing padding
3289 * @param grow_by number of bytes by which to increase the size of the packet
3291 int av_grow_packet(AVPacket *pkt, int grow_by);
3294 * @warning This is a hack - the packet memory allocation stuff is broken. The
3295 * packet is allocated if it was not really allocated.
3297 int av_dup_packet(AVPacket *pkt);
3302 * @param pkt packet to free
3304 void av_free_packet(AVPacket *pkt);
3307 * Allocate new information of a packet.
3310 * @param type side information type
3311 * @param size side information size
3312 * @return pointer to fresh allocated data or NULL otherwise
3314 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3318 * Get side information from packet.
3321 * @param type desired side information type
3322 * @param size pointer for side information size to store (optional)
3323 * @return pointer to data if present or NULL otherwise
3325 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3330 struct ReSampleContext;
3331 struct AVResampleContext;
3333 typedef struct ReSampleContext ReSampleContext;
3336 * Initialize audio resampling context.
3338 * @param output_channels number of output channels
3339 * @param input_channels number of input channels
3340 * @param output_rate output sample rate
3341 * @param input_rate input sample rate
3342 * @param sample_fmt_out requested output sample format
3343 * @param sample_fmt_in input sample format
3344 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3345 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3346 * @param linear if 1 then the used FIR filter will be linearly interpolated
3347 between the 2 closest, if 0 the closest will be used
3348 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3349 * @return allocated ReSampleContext, NULL if error occurred
3351 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3352 int output_rate, int input_rate,
3353 enum AVSampleFormat sample_fmt_out,
3354 enum AVSampleFormat sample_fmt_in,
3355 int filter_length, int log2_phase_count,
3356 int linear, double cutoff);
3358 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3361 * Free resample context.
3363 * @param s a non-NULL pointer to a resample context previously
3364 * created with av_audio_resample_init()
3366 void audio_resample_close(ReSampleContext *s);
3370 * Initialize an audio resampler.
3371 * Note, if either rate is not an integer then simply scale both rates up so they are.
3372 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3373 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3374 * @param linear If 1 then the used FIR filter will be linearly interpolated
3375 between the 2 closest, if 0 the closest will be used
3376 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3378 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3381 * Resample an array of samples using a previously configured context.
3382 * @param src an array of unconsumed samples
3383 * @param consumed the number of samples of src which have been consumed are returned here
3384 * @param src_size the number of unconsumed samples available
3385 * @param dst_size the amount of space in samples available in dst
3386 * @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.
3387 * @return the number of samples written in dst or -1 if an error occurred
3389 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3393 * Compensate samplerate/timestamp drift. The compensation is done by changing
3394 * the resampler parameters, so no audible clicks or similar distortions occur
3395 * @param compensation_distance distance in output samples over which the compensation should be performed
3396 * @param sample_delta number of output samples which should be output less
3398 * example: av_resample_compensate(c, 10, 500)
3399 * here instead of 510 samples only 500 samples would be output
3401 * note, due to rounding the actual compensation might be slightly different,
3402 * especially if the compensation_distance is large and the in_rate used during init is small
3404 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3405 void av_resample_close(struct AVResampleContext *c);
3408 * Allocate memory for a picture. Call avpicture_free() to free it.
3410 * @see avpicture_fill()
3412 * @param picture the picture to be filled in
3413 * @param pix_fmt the format of the picture
3414 * @param width the width of the picture
3415 * @param height the height of the picture
3416 * @return zero if successful, a negative value if not
3418 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3421 * Free a picture previously allocated by avpicture_alloc().
3422 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3425 * @param picture the AVPicture to be freed
3427 void avpicture_free(AVPicture *picture);
3430 * Fill in the AVPicture fields.
3431 * The fields of the given AVPicture are filled in by using the 'ptr' address
3432 * which points to the image data buffer. Depending on the specified picture
3433 * format, one or multiple image data pointers and line sizes will be set.
3434 * If a planar format is specified, several pointers will be set pointing to
3435 * the different picture planes and the line sizes of the different planes
3436 * will be stored in the lines_sizes array.
3437 * Call with ptr == NULL to get the required size for the ptr buffer.
3439 * To allocate the buffer and fill in the AVPicture fields in one call,
3440 * use avpicture_alloc().
3442 * @param picture AVPicture whose fields are to be filled in
3443 * @param ptr Buffer which will contain or contains the actual image data
3444 * @param pix_fmt The format in which the picture data is stored.
3445 * @param width the width of the image in pixels
3446 * @param height the height of the image in pixels
3447 * @return size of the image data in bytes
3449 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3450 enum PixelFormat pix_fmt, int width, int height);
3453 * Copy pixel data from an AVPicture into a buffer.
3454 * The data is stored compactly, without any gaps for alignment or padding
3455 * which may be applied by avpicture_fill().
3457 * @see avpicture_get_size()
3459 * @param[in] src AVPicture containing image data
3460 * @param[in] pix_fmt The format in which the picture data is stored.
3461 * @param[in] width the width of the image in pixels.
3462 * @param[in] height the height of the image in pixels.
3463 * @param[out] dest A buffer into which picture data will be copied.
3464 * @param[in] dest_size The size of 'dest'.
3465 * @return The number of bytes written to dest, or a negative value (error code) on error.
3467 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3468 unsigned char *dest, int dest_size);
3471 * Calculate the size in bytes that a picture of the given width and height
3472 * would occupy if stored in the given picture format.
3473 * Note that this returns the size of a compact representation as generated
3474 * by avpicture_layout(), which can be smaller than the size required for e.g.
3477 * @param pix_fmt the given picture format
3478 * @param width the width of the image
3479 * @param height the height of the image
3480 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3482 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3483 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3485 #if FF_API_GET_PIX_FMT_NAME
3487 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3489 attribute_deprecated
3490 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3493 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3496 * Return a value representing the fourCC code associated to the
3497 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3500 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3503 * Put a string representing the codec tag codec_tag in buf.
3505 * @param buf_size size in bytes of buf
3506 * @return the length of the string that would have been generated if
3507 * enough space had been available, excluding the trailing null
3509 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3511 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3512 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3513 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3514 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3515 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3516 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3519 * Compute what kind of losses will occur when converting from one specific
3520 * pixel format to another.
3521 * When converting from one pixel format to another, information loss may occur.
3522 * For example, when converting from RGB24 to GRAY, the color information will
3523 * be lost. Similarly, other losses occur when converting from some formats to
3524 * other formats. These losses can involve loss of chroma, but also loss of
3525 * resolution, loss of color depth, loss due to the color space conversion, loss
3526 * of the alpha bits or loss due to color quantization.
3527 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3528 * which will occur when converting from one pixel format to another.
3530 * @param[in] dst_pix_fmt destination pixel format
3531 * @param[in] src_pix_fmt source pixel format
3532 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3533 * @return Combination of flags informing you what kind of losses will occur.
3535 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3539 * Find the best pixel format to convert to given a certain source pixel
3540 * format. When converting from one pixel format to another, information loss
3541 * may occur. For example, when converting from RGB24 to GRAY, the color
3542 * information will be lost. Similarly, other losses occur when converting from
3543 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3544 * the given pixel formats should be used to suffer the least amount of loss.
3545 * The pixel formats from which it chooses one, are determined by the
3546 * pix_fmt_mask parameter.
3549 * src_pix_fmt = PIX_FMT_YUV420P;
3550 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3551 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3554 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3555 * @param[in] src_pix_fmt source pixel format
3556 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3557 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3558 * @return The best pixel format to convert to or -1 if none was found.
3560 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3561 int has_alpha, int *loss_ptr);
3563 #if FF_API_GET_ALPHA_INFO
3564 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3565 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3568 * Tell if an image really has transparent alpha values.
3569 * @return ored mask of FF_ALPHA_xxx constants
3571 attribute_deprecated
3572 int img_get_alpha_info(const AVPicture *src,
3573 enum PixelFormat pix_fmt, int width, int height);
3576 /* deinterlace a picture */
3577 /* deinterlace - if not supported return -1 */
3578 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3579 enum PixelFormat pix_fmt, int width, int height);
3581 /* external high level API */
3584 * If c is NULL, returns the first registered codec,
3585 * if c is non-NULL, returns the next registered codec after c,
3586 * or NULL if c is the last one.
3588 AVCodec *av_codec_next(AVCodec *c);
3591 * Return the LIBAVCODEC_VERSION_INT constant.
3593 unsigned avcodec_version(void);
3596 * Return the libavcodec build-time configuration.
3598 const char *avcodec_configuration(void);
3601 * Return the libavcodec license.
3603 const char *avcodec_license(void);
3605 #if FF_API_AVCODEC_INIT
3607 * @deprecated this function is called automatically from avcodec_register()
3608 * and avcodec_register_all(), there is no need to call it manually
3610 attribute_deprecated
3611 void avcodec_init(void);
3615 * Register the codec codec and initialize libavcodec.
3617 * @warning either this function or avcodec_register_all() must be called
3618 * before any other libavcodec functions.
3620 * @see avcodec_register_all()
3622 void avcodec_register(AVCodec *codec);
3625 * Find a registered encoder with a matching codec ID.
3627 * @param id CodecID of the requested encoder
3628 * @return An encoder if one was found, NULL otherwise.
3630 AVCodec *avcodec_find_encoder(enum CodecID id);
3633 * Find a registered encoder with the specified name.
3635 * @param name name of the requested encoder
3636 * @return An encoder if one was found, NULL otherwise.
3638 AVCodec *avcodec_find_encoder_by_name(const char *name);
3641 * Find a registered decoder with a matching codec ID.
3643 * @param id CodecID of the requested decoder
3644 * @return A decoder if one was found, NULL otherwise.
3646 AVCodec *avcodec_find_decoder(enum CodecID id);
3649 * Find a registered decoder with the specified name.
3651 * @param name name of the requested decoder
3652 * @return A decoder if one was found, NULL otherwise.
3654 AVCodec *avcodec_find_decoder_by_name(const char *name);
3655 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3658 * Return a name for the specified profile, if available.
3660 * @param codec the codec that is searched for the given profile
3661 * @param profile the profile value for which a name is requested
3662 * @return A name for the profile if found, NULL otherwise.
3664 const char *av_get_profile_name(const AVCodec *codec, int profile);
3666 #if FF_API_ALLOC_CONTEXT
3668 * Set the fields of the given AVCodecContext to default values.
3670 * @param s The AVCodecContext of which the fields should be set to default values.
3671 * @deprecated use avcodec_get_context_defaults3
3673 attribute_deprecated
3674 void avcodec_get_context_defaults(AVCodecContext *s);
3676 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3677 * we WILL change its arguments and name a few times! */
3678 attribute_deprecated
3679 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3683 * Set the fields of the given AVCodecContext to default values corresponding
3684 * to the given codec (defaults may be codec-dependent).
3686 * Do not call this function if a non-NULL codec has been passed
3687 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3688 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3689 * different codec on this AVCodecContext.
3691 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3693 #if FF_API_ALLOC_CONTEXT
3695 * Allocate an AVCodecContext and set its fields to default values. The
3696 * resulting struct can be deallocated by simply calling av_free().
3698 * @return An AVCodecContext filled with default values or NULL on failure.
3699 * @see avcodec_get_context_defaults
3701 * @deprecated use avcodec_alloc_context3()
3703 attribute_deprecated
3704 AVCodecContext *avcodec_alloc_context(void);
3706 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3707 * we WILL change its arguments and name a few times! */
3708 attribute_deprecated
3709 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3713 * Allocate an AVCodecContext and set its fields to default values. The
3714 * resulting struct can be deallocated by simply calling av_free().
3716 * @param codec if non-NULL, allocate private data and initialize defaults
3717 * for the given codec. It is illegal to then call avcodec_open2()
3718 * with a different codec.
3720 * @return An AVCodecContext filled with default values or NULL on failure.
3721 * @see avcodec_get_context_defaults
3723 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3726 * Copy the settings of the source AVCodecContext into the destination
3727 * AVCodecContext. The resulting destination codec context will be
3728 * unopened, i.e. you are required to call avcodec_open2() before you
3729 * can use this AVCodecContext to decode/encode video/audio data.
3731 * @param dest target codec context, should be initialized with
3732 * avcodec_alloc_context3(), but otherwise uninitialized
3733 * @param src source codec context
3734 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3736 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3739 * Set the fields of the given AVFrame to default values.
3741 * @param pic The AVFrame of which the fields should be set to default values.
3743 void avcodec_get_frame_defaults(AVFrame *pic);
3746 * Allocate an AVFrame and set its fields to default values. The resulting
3747 * struct can be deallocated by simply calling av_free().
3749 * @return An AVFrame filled with default values or NULL on failure.
3750 * @see avcodec_get_frame_defaults
3752 AVFrame *avcodec_alloc_frame(void);
3754 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3755 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3756 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3759 * Return the amount of padding in pixels which the get_buffer callback must
3760 * provide around the edge of the image for codecs which do not have the
3761 * CODEC_FLAG_EMU_EDGE flag.
3763 * @return Required padding in pixels.
3765 unsigned avcodec_get_edge_width(void);
3767 * Modify width and height values so that they will result in a memory
3768 * buffer that is acceptable for the codec if you do not use any horizontal
3771 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3772 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3773 * according to avcodec_get_edge_width() before.
3775 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3777 * Modify width and height values so that they will result in a memory
3778 * buffer that is acceptable for the codec if you also ensure that all
3779 * line sizes are a multiple of the respective linesize_align[i].
3781 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3782 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3783 * according to avcodec_get_edge_width() before.
3785 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3786 int linesize_align[AV_NUM_DATA_POINTERS]);
3788 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3790 #if FF_API_THREAD_INIT
3792 * @deprecated Set s->thread_count before calling avcodec_open2() instead of calling this.
3794 attribute_deprecated
3795 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3798 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3799 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3800 //FIXME func typedef
3802 #if FF_API_AVCODEC_OPEN
3804 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3805 * function the context has to be allocated.
3807 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3808 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3809 * retrieving a codec.
3811 * @warning This function is not thread safe!
3814 * avcodec_register_all();
3815 * codec = avcodec_find_decoder(CODEC_ID_H264);
3819 * context = avcodec_alloc_context3(codec);
3821 * if (avcodec_open(context, codec) < 0)
3825 * @param avctx The context which will be set up to use the given codec.
3826 * @param codec The codec to use within the context.
3827 * @return zero on success, a negative value on error
3828 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3830 * @deprecated use avcodec_open2
3832 attribute_deprecated
3833 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3837 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3838 * function the context has to be allocated with avcodec_alloc_context3().
3840 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3841 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3842 * retrieving a codec.
3844 * @warning This function is not thread safe!
3847 * avcodec_register_all();
3848 * av_dict_set(&opts, "b", "2.5M", 0);
3849 * codec = avcodec_find_decoder(CODEC_ID_H264);
3853 * context = avcodec_alloc_context3(codec);
3855 * if (avcodec_open2(context, codec, opts) < 0)
3859 * @param avctx The context to initialize.
3860 * @param options A dictionary filled with AVCodecContext and codec-private options.
3861 * On return this object will be filled with options that were not found.
3863 * @return zero on success, a negative value on error
3864 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3865 * av_dict_set(), av_opt_find().
3867 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3869 #if FF_API_OLD_DECODE_AUDIO
3871 * Wrapper function which calls avcodec_decode_audio4.
3873 * @deprecated Use avcodec_decode_audio4 instead.
3875 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3876 * Some decoders may support multiple frames in a single AVPacket, such
3877 * decoders would then just decode the first frame. In this case,
3878 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3879 * the remaining data in order to decode the second frame etc.
3881 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3882 * decompressed frame size in bytes.
3884 * @warning You must set frame_size_ptr to the allocated size of the
3885 * output buffer before calling avcodec_decode_audio3().
3887 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3888 * the actual read bytes because some optimized bitstream readers read 32 or 64
3889 * bits at once and could read over the end.
3891 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3892 * no overreading happens for damaged MPEG streams.
3894 * @warning You must not provide a custom get_buffer() when using
3895 * avcodec_decode_audio3(). Doing so will override it with
3896 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3897 * which does allow the application to provide a custom get_buffer().
3899 * @note You might have to align the input buffer avpkt->data and output buffer
3900 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3901 * necessary at all, on others it won't work at all if not aligned and on others
3902 * it will work but it will have an impact on performance.
3904 * In practice, avpkt->data should have 4 byte alignment at minimum and
3905 * samples should be 16 byte aligned unless the CPU doesn't need it
3906 * (AltiVec and SSE do).
3908 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3909 * between input and output, these need to be fed with avpkt->data=NULL,
3910 * avpkt->size=0 at the end to return the remaining frames.
3912 * @param avctx the codec context
3913 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3914 * If the sample format is planar, each channel plane will
3915 * be the same size, with no padding between channels.
3916 * @param[in,out] frame_size_ptr the output buffer size in bytes
3917 * @param[in] avpkt The input AVPacket containing the input buffer.
3918 * You can create such packet with av_init_packet() and by then setting
3919 * data and size, some decoders might in addition need other fields.
3920 * All decoders are designed to use the least fields possible though.
3921 * @return On error a negative value is returned, otherwise the number of bytes
3922 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3924 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3925 int *frame_size_ptr,
3930 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3932 * Some decoders may support multiple frames in a single AVPacket. Such
3933 * decoders would then just decode the first frame. In this case,
3934 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3935 * the remaining data in order to decode the second frame, etc...
3936 * Even if no frames are returned, the packet needs to be fed to the decoder
3937 * with remaining data until it is completely consumed or an error occurs.
3939 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3940 * larger than the actual read bytes because some optimized bitstream
3941 * readers read 32 or 64 bits at once and could read over the end.
3943 * @note You might have to align the input buffer. The alignment requirements
3944 * depend on the CPU and the decoder.
3946 * @param avctx the codec context
3947 * @param[out] frame The AVFrame in which to store decoded audio samples.
3948 * Decoders request a buffer of a particular size by setting
3949 * AVFrame.nb_samples prior to calling get_buffer(). The
3950 * decoder may, however, only utilize part of the buffer by
3951 * setting AVFrame.nb_samples to a smaller value in the
3953 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3955 * @param[in] avpkt The input AVPacket containing the input buffer.
3956 * At least avpkt->data and avpkt->size should be set. Some
3957 * decoders might also require additional fields to be set.
3958 * @return A negative error code is returned if an error occurred during
3959 * decoding, otherwise the number of bytes consumed from the input
3960 * AVPacket is returned.
3962 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3963 int *got_frame_ptr, AVPacket *avpkt);
3966 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3967 * Some decoders may support multiple frames in a single AVPacket, such
3968 * decoders would then just decode the first frame.
3970 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3971 * the actual read bytes because some optimized bitstream readers read 32 or 64
3972 * bits at once and could read over the end.
3974 * @warning The end of the input buffer buf should be set to 0 to ensure that
3975 * no overreading happens for damaged MPEG streams.
3977 * @note You might have to align the input buffer avpkt->data.
3978 * The alignment requirements depend on the CPU: on some CPUs it isn't
3979 * necessary at all, on others it won't work at all if not aligned and on others
3980 * it will work but it will have an impact on performance.
3982 * In practice, avpkt->data should have 4 byte alignment at minimum.
3984 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3985 * between input and output, these need to be fed with avpkt->data=NULL,
3986 * avpkt->size=0 at the end to return the remaining frames.
3988 * @param avctx the codec context
3989 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3990 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3991 * allocate memory for the actual bitmap.
3992 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3993 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3994 * decodes and the decoder tells the user once it does not need the data anymore,
3995 * the user app can at this point free/reuse/keep the memory as it sees fit.
3997 * @param[in] avpkt The input AVpacket containing the input buffer.
3998 * You can create such packet with av_init_packet() and by then setting
3999 * data and size, some decoders might in addition need other fields like
4000 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4002 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4003 * @return On error a negative value is returned, otherwise the number of bytes
4004 * used or zero if no frame could be decompressed.
4006 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4007 int *got_picture_ptr,
4011 * Decode a subtitle message.
4012 * Return a negative value on error, otherwise return the number of bytes used.
4013 * If no subtitle could be decompressed, got_sub_ptr is zero.
4014 * Otherwise, the subtitle is stored in *sub.
4015 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4016 * simplicity, because the performance difference is expect to be negligible
4017 * and reusing a get_buffer written for video codecs would probably perform badly
4018 * due to a potentially very different allocation pattern.
4020 * @param avctx the codec context
4021 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4022 freed with avsubtitle_free if *got_sub_ptr is set.
4023 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4024 * @param[in] avpkt The input AVPacket containing the input buffer.
4026 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4031 * Free all allocated data in the given subtitle struct.
4033 * @param sub AVSubtitle to free.
4035 void avsubtitle_free(AVSubtitle *sub);
4037 #if FF_API_OLD_ENCODE_AUDIO
4039 * Encode an audio frame from samples into buf.
4041 * @deprecated Use avcodec_encode_audio2 instead.
4043 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4044 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4045 * will know how much space is needed because it depends on the value passed
4046 * in buf_size as described below. In that case a lower value can be used.
4048 * @param avctx the codec context
4049 * @param[out] buf the output buffer
4050 * @param[in] buf_size the output buffer size
4051 * @param[in] samples the input buffer containing the samples
4052 * The number of samples read from this buffer is frame_size*channels,
4053 * both of which are defined in avctx.
4054 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4055 * samples read from samples is equal to:
4056 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4057 * This also implies that av_get_bits_per_sample() must not return 0 for these
4059 * @return On error a negative value is returned, on success zero or the number
4060 * of bytes used to encode the data read from the input buffer.
4062 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4063 uint8_t *buf, int buf_size,
4064 const short *samples);
4068 * Encode a frame of audio.
4070 * Takes input samples from frame and writes the next output packet, if
4071 * available, to avpkt. The output packet does not necessarily contain data for
4072 * the most recent frame, as encoders can delay, split, and combine input frames
4073 * internally as needed.
4075 * @param avctx codec context
4076 * @param avpkt output AVPacket.
4077 * The user can supply an output buffer by setting
4078 * avpkt->data and avpkt->size prior to calling the
4079 * function, but if the size of the user-provided data is not
4080 * large enough, encoding will fail. All other AVPacket fields
4081 * will be reset by the encoder using av_init_packet(). If
4082 * avpkt->data is NULL, the encoder will allocate it.
4083 * The encoder will set avpkt->size to the size of the
4085 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4086 * May be NULL when flushing an encoder that has the
4087 * CODEC_CAP_DELAY capability set.
4088 * There are 2 codec capabilities that affect the allowed
4089 * values of frame->nb_samples.
4090 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
4091 * frame may be smaller than avctx->frame_size, and all other
4092 * frames must be equal to avctx->frame_size.
4093 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4094 * can have any number of samples.
4095 * If neither is set, frame->nb_samples must be equal to
4096 * avctx->frame_size for all frames.
4097 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4098 * output packet is non-empty, and to 0 if it is
4099 * empty. If the function returns an error, the
4100 * packet can be assumed to be invalid, and the
4101 * value of got_packet_ptr is undefined and should
4103 * @return 0 on success, negative error code on failure
4105 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4106 const AVFrame *frame, int *got_packet_ptr);
4109 * Fill audio frame data and linesize.
4110 * AVFrame extended_data channel pointers are allocated if necessary for
4113 * @param frame the AVFrame
4114 * frame->nb_samples must be set prior to calling the
4115 * function. This function fills in frame->data,
4116 * frame->extended_data, frame->linesize[0].
4117 * @param nb_channels channel count
4118 * @param sample_fmt sample format
4119 * @param buf buffer to use for frame data
4120 * @param buf_size size of buffer
4121 * @param align plane size sample alignment
4122 * @return 0 on success, negative error code on failure
4124 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4125 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4126 int buf_size, int align);
4129 * Encode a video frame from pict into buf.
4130 * The input picture should be
4131 * stored using a specific format, namely avctx.pix_fmt.
4133 * @param avctx the codec context
4134 * @param[out] buf the output buffer for the bitstream of encoded frame
4135 * @param[in] buf_size the size of the output buffer in bytes
4136 * @param[in] pict the input picture to encode
4137 * @return On error a negative value is returned, on success zero or the number
4138 * of bytes used from the output buffer.
4140 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4141 const AVFrame *pict);
4142 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4143 const AVSubtitle *sub);
4145 int avcodec_close(AVCodecContext *avctx);
4148 * Register all the codecs, parsers and bitstream filters which were enabled at
4149 * configuration time. If you do not call this function you can select exactly
4150 * which formats you want to support, by using the individual registration
4153 * @see avcodec_register
4154 * @see av_register_codec_parser
4155 * @see av_register_bitstream_filter
4157 void avcodec_register_all(void);
4160 * Flush buffers, should be called when seeking or when switching to a different stream.
4162 void avcodec_flush_buffers(AVCodecContext *avctx);
4164 void avcodec_default_free_buffers(AVCodecContext *s);
4166 /* misc useful functions */
4168 #if FF_API_OLD_FF_PICT_TYPES
4170 * Return a single letter to describe the given picture type pict_type.
4172 * @param[in] pict_type the picture type
4173 * @return A single character representing the picture type.
4174 * @deprecated Use av_get_picture_type_char() instead.
4176 attribute_deprecated
4177 char av_get_pict_type_char(int pict_type);
4181 * Return codec bits per sample.
4183 * @param[in] codec_id the codec
4184 * @return Number of bits per sample or zero if unknown for the given codec.
4186 int av_get_bits_per_sample(enum CodecID codec_id);
4189 typedef struct AVCodecParserContext {
4191 struct AVCodecParser *parser;
4192 int64_t frame_offset; /* offset of the current frame */
4193 int64_t cur_offset; /* current offset
4194 (incremented by each av_parser_parse()) */
4195 int64_t next_frame_offset; /* offset of the next frame */
4197 int pict_type; /* XXX: Put it back in AVCodecContext. */
4199 * This field is used for proper frame duration computation in lavf.
4200 * It signals, how much longer the frame duration of the current frame
4201 * is compared to normal frame duration.
4203 * frame_duration = (1 + repeat_pict) * time_base
4205 * It is used by codecs like H.264 to display telecined material.
4207 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4208 int64_t pts; /* pts of the current frame */
4209 int64_t dts; /* dts of the current frame */
4214 int fetch_timestamp;
4216 #define AV_PARSER_PTS_NB 4
4217 int cur_frame_start_index;
4218 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4219 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4220 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4223 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4224 #define PARSER_FLAG_ONCE 0x0002
4225 /// Set if the parser has a valid file offset
4226 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4228 int64_t offset; ///< byte offset from starting packet start
4229 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4232 * Set by parser to 1 for key frames and 0 for non-key frames.
4233 * It is initialized to -1, so if the parser doesn't set this flag,
4234 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4240 * Time difference in stream time base units from the pts of this
4241 * packet to the point at which the output from the decoder has converged
4242 * independent from the availability of previous frames. That is, the
4243 * frames are virtually identical no matter if decoding started from
4244 * the very first frame or from this keyframe.
4245 * Is AV_NOPTS_VALUE if unknown.
4246 * This field is not the display duration of the current frame.
4247 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4250 * The purpose of this field is to allow seeking in streams that have no
4251 * keyframes in the conventional sense. It corresponds to the
4252 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4253 * essential for some types of subtitle streams to ensure that all
4254 * subtitles are correctly displayed after seeking.
4256 int64_t convergence_duration;
4258 // Timestamp generation support:
4260 * Synchronization point for start of timestamp generation.
4262 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4265 * For example, this corresponds to presence of H.264 buffering period
4271 * Offset of the current timestamp against last timestamp sync point in
4272 * units of AVCodecContext.time_base.
4274 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4275 * contain a valid timestamp offset.
4277 * Note that the timestamp of sync point has usually a nonzero
4278 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4279 * the next frame after timestamp sync point will be usually 1.
4281 * For example, this corresponds to H.264 cpb_removal_delay.
4283 int dts_ref_dts_delta;
4286 * Presentation delay of current frame in units of AVCodecContext.time_base.
4288 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4289 * contain valid non-negative timestamp delta (presentation time of a frame
4290 * must not lie in the past).
4292 * This delay represents the difference between decoding and presentation
4293 * time of the frame.
4295 * For example, this corresponds to H.264 dpb_output_delay.
4300 * Position of the packet in file.
4302 * Analogous to cur_frame_pts/dts
4304 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4307 * Byte position of currently parsed frame in stream.
4312 * Previous frame byte position.
4315 } AVCodecParserContext;
4317 typedef struct AVCodecParser {
4318 int codec_ids[5]; /* several codec IDs are permitted */
4320 int (*parser_init)(AVCodecParserContext *s);
4321 int (*parser_parse)(AVCodecParserContext *s,
4322 AVCodecContext *avctx,
4323 const uint8_t **poutbuf, int *poutbuf_size,
4324 const uint8_t *buf, int buf_size);
4325 void (*parser_close)(AVCodecParserContext *s);
4326 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4327 struct AVCodecParser *next;
4330 AVCodecParser *av_parser_next(AVCodecParser *c);
4332 void av_register_codec_parser(AVCodecParser *parser);
4333 AVCodecParserContext *av_parser_init(int codec_id);
4338 * @param s parser context.
4339 * @param avctx codec context.
4340 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4341 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4342 * @param buf input buffer.
4343 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4344 * @param pts input presentation timestamp.
4345 * @param dts input decoding timestamp.
4346 * @param pos input byte position in stream.
4347 * @return the number of bytes of the input bitstream used.
4352 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4359 * decode_frame(data, size);
4363 int av_parser_parse2(AVCodecParserContext *s,
4364 AVCodecContext *avctx,
4365 uint8_t **poutbuf, int *poutbuf_size,
4366 const uint8_t *buf, int buf_size,
4367 int64_t pts, int64_t dts,
4370 int av_parser_change(AVCodecParserContext *s,
4371 AVCodecContext *avctx,
4372 uint8_t **poutbuf, int *poutbuf_size,
4373 const uint8_t *buf, int buf_size, int keyframe);
4374 void av_parser_close(AVCodecParserContext *s);
4377 typedef struct AVBitStreamFilterContext {
4379 struct AVBitStreamFilter *filter;
4380 AVCodecParserContext *parser;
4381 struct AVBitStreamFilterContext *next;
4382 } AVBitStreamFilterContext;
4385 typedef struct AVBitStreamFilter {
4388 int (*filter)(AVBitStreamFilterContext *bsfc,
4389 AVCodecContext *avctx, const char *args,
4390 uint8_t **poutbuf, int *poutbuf_size,
4391 const uint8_t *buf, int buf_size, int keyframe);
4392 void (*close)(AVBitStreamFilterContext *bsfc);
4393 struct AVBitStreamFilter *next;
4394 } AVBitStreamFilter;
4396 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4397 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4398 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4399 AVCodecContext *avctx, const char *args,
4400 uint8_t **poutbuf, int *poutbuf_size,
4401 const uint8_t *buf, int buf_size, int keyframe);
4402 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4404 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4409 * Reallocate the given block if it is not large enough, otherwise do nothing.
4413 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4416 * Allocate a buffer, reusing the given one if large enough.
4418 * Contrary to av_fast_realloc the current buffer contents might not be
4419 * preserved and on error the old buffer is freed, thus no special
4420 * handling to avoid memleaks is necessary.
4422 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4423 * @param size size of the buffer *ptr points to
4424 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4425 * *size 0 if an error occurred.
4427 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4430 * Copy image src to dst. Wraps av_picture_data_copy() above.
4432 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4433 enum PixelFormat pix_fmt, int width, int height);
4436 * Crop image top and left side.
4438 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4439 enum PixelFormat pix_fmt, int top_band, int left_band);
4444 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4445 int padtop, int padbottom, int padleft, int padright, int *color);
4448 * Encode extradata length to a buffer. Used by xiph codecs.
4450 * @param s buffer to write to; must be at least (v/255+1) bytes long
4451 * @param v size of extradata in bytes
4452 * @return number of bytes written to the buffer.
4454 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4457 * Log a generic warning message about a missing feature. This function is
4458 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4459 * only, and would normally not be used by applications.
4460 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4461 * a pointer to an AVClass struct
4462 * @param[in] feature string containing the name of the missing feature
4463 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4464 * If want_sample is non-zero, additional verbage will be added to the log
4465 * message which tells the user how to report samples to the development
4468 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4471 * Log a generic warning message asking for a sample. This function is
4472 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4473 * only, and would normally not be used by applications.
4474 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4475 * a pointer to an AVClass struct
4476 * @param[in] msg string containing an optional message, or NULL if no message
4478 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4481 * Register the hardware accelerator hwaccel.
4483 void av_register_hwaccel(AVHWAccel *hwaccel);
4486 * If hwaccel is NULL, returns the first registered hardware accelerator,
4487 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4488 * after hwaccel, or NULL if hwaccel is the last one.
4490 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4494 * Lock operation used by lockmgr
4497 AV_LOCK_CREATE, ///< Create a mutex
4498 AV_LOCK_OBTAIN, ///< Lock the mutex
4499 AV_LOCK_RELEASE, ///< Unlock the mutex
4500 AV_LOCK_DESTROY, ///< Free mutex resources
4504 * Register a user provided lock manager supporting the operations
4505 * specified by AVLockOp. mutex points to a (void *) where the
4506 * lockmgr should store/get a pointer to a user allocated mutex. It's
4507 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4509 * @param cb User defined callback. Note: Libav may invoke calls to this
4510 * callback during the call to av_lockmgr_register().
4511 * Thus, the application must be prepared to handle that.
4512 * If cb is set to NULL the lockmgr will be unregistered.
4513 * Also note that during unregistration the previously registered
4514 * lockmgr callback may also be invoked.
4516 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4519 * Get the type of the given codec.
4521 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4524 * Get the AVClass for AVCodecContext. It can be used in combination with
4525 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4527 * @see av_opt_find().
4529 const AVClass *avcodec_get_class(void);
4531 #endif /* AVCODEC_AVCODEC_H */