libavcodec/avcodec.h
04d7f601
 /*
  * copyright (c) 2001 Fabrice Bellard
  *
b78e7197
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
04d7f601
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
b78e7197
  * version 2.1 of the License, or (at your option) any later version.
04d7f601
  *
b78e7197
  * FFmpeg is distributed in the hope that it will be useful,
04d7f601
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
b78e7197
  * License along with FFmpeg; if not, write to the Free Software
e5a389a1
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
04d7f601
  */
 
98790382
 #ifndef AVCODEC_AVCODEC_H
 #define AVCODEC_AVCODEC_H
a96b68b7
 
36df8805
 /**
bad5537e
  * @file libavcodec/avcodec.h
f5bccd85
  * external API header
36df8805
  */
 
c60208e7
 #include <errno.h>
76a448ed
 #include "libavutil/avutil.h"
de6d9b64
 
dd1c8f3e
 #define LIBAVCODEC_VERSION_MAJOR 52
afc97d47
 #define LIBAVCODEC_VERSION_MINOR 20
4fb58ece
 #define LIBAVCODEC_VERSION_MICRO  1
e97ac1e6
 
800c289a
 #define LIBAVCODEC_VERSION_INT  AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
                                                LIBAVCODEC_VERSION_MINOR, \
                                                LIBAVCODEC_VERSION_MICRO)
 #define LIBAVCODEC_VERSION      AV_VERSION(LIBAVCODEC_VERSION_MAJOR,    \
                                            LIBAVCODEC_VERSION_MINOR,    \
                                            LIBAVCODEC_VERSION_MICRO)
bb270c08
 #define LIBAVCODEC_BUILD        LIBAVCODEC_VERSION_INT
5aa083ee
 
bb270c08
 #define LIBAVCODEC_IDENT        "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
ce2749d2
 
8da9266c
 #define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)
bb270c08
 #define AV_TIME_BASE            1000000
 #define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
9740beff
 
7ebf5927
 /**
6b0cdb6e
  * Identifies the syntax and semantics of the bitstream.
  * The principle is roughly:
  * Two decoders with the same ID can decode the same streams.
  * Two encoders with the same ID can encode compatible streams.
  * There may be slight deviations from the principle due to implementation
  * details.
7ebf5927
  *
f5bccd85
  * If you add a codec ID to this list, add it so that
  * 1. no value of a existing codec ID changes (that would break ABI),
  * 2. it is as close as possible to similar codecs.
7ebf5927
  */
de6d9b64
 enum CodecID {
115329f1
     CODEC_ID_NONE,
ba0dabbf
 
     /* video codecs */
de6d9b64
     CODEC_ID_MPEG1VIDEO,
0e373b95
     CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
fb364ada
     CODEC_ID_MPEG2VIDEO_XVMC,
c6148de2
     CODEC_ID_H261,
de6d9b64
     CODEC_ID_H263,
     CODEC_ID_RV10,
68b94c35
     CODEC_ID_RV20,
de6d9b64
     CODEC_ID_MJPEG,
b135d9fb
     CODEC_ID_MJPEGB,
b1e6b355
     CODEC_ID_LJPEG,
5e83dec4
     CODEC_ID_SP5X,
5639729b
     CODEC_ID_JPEGLS,
bf89e6b1
     CODEC_ID_MPEG4,
de6d9b64
     CODEC_ID_RAWVIDEO,
84afee34
     CODEC_ID_MSMPEG4V1,
     CODEC_ID_MSMPEG4V2,
     CODEC_ID_MSMPEG4V3,
e1a9dbff
     CODEC_ID_WMV1,
b50eef3a
     CODEC_ID_WMV2,
de6d9b64
     CODEC_ID_H263P,
     CODEC_ID_H263I,
d4f5d74a
     CODEC_ID_FLV1,
be8ffec9
     CODEC_ID_SVQ1,
8b82a956
     CODEC_ID_SVQ3,
020fcc94
     CODEC_ID_DVVIDEO,
11f18faf
     CODEC_ID_HUFFYUV,
f70f7c6d
     CODEC_ID_CYUV,
0da71265
     CODEC_ID_H264,
deabd4fd
     CODEC_ID_INDEO3,
d86053a4
     CODEC_ID_VP3,
f44ee2c3
     CODEC_ID_THEORA,
3d2e8cce
     CODEC_ID_ASV1,
9b56edf5
     CODEC_ID_ASV2,
5e20f836
     CODEC_ID_FFV1,
e2a7bb28
     CODEC_ID_4XM,
be3564ed
     CODEC_ID_VCR1,
3aff069b
     CODEC_ID_CLJR,
c3bf0288
     CODEC_ID_MDEC,
3ef8be2b
     CODEC_ID_ROQ,
     CODEC_ID_INTERPLAY_VIDEO,
9937e686
     CODEC_ID_XAN_WC3,
     CODEC_ID_XAN_WC4,
2fdf638b
     CODEC_ID_RPZA,
     CODEC_ID_CINEPAK,
     CODEC_ID_WS_VQA,
     CODEC_ID_MSRLE,
     CODEC_ID_MSVIDEO1,
4120a53a
     CODEC_ID_IDCIN,
1dc1ed99
     CODEC_ID_8BPS,
11e29a41
     CODEC_ID_SMC,
42cad81a
     CODEC_ID_FLIC,
9a4117d5
     CODEC_ID_TRUEMOTION1,
fafa0b75
     CODEC_ID_VMDVIDEO,
a273bbfb
     CODEC_ID_MSZH,
     CODEC_ID_ZLIB,
070ed1bc
     CODEC_ID_QTRLE,
791e7b83
     CODEC_ID_SNOW,
9d53d58e
     CODEC_ID_TSCC,
d0a0bbd2
     CODEC_ID_ULTI,
d08d7142
     CODEC_ID_QDRAW,
ab711b3c
     CODEC_ID_VIXL,
acfd8f0f
     CODEC_ID_QPEG,
17179d2d
     CODEC_ID_XVID,
     CODEC_ID_PNG,
     CODEC_ID_PPM,
     CODEC_ID_PBM,
     CODEC_ID_PGM,
     CODEC_ID_PGMYUV,
     CODEC_ID_PAM,
f37b9768
     CODEC_ID_FFVHUFF,
3f05305d
     CODEC_ID_RV30,
     CODEC_ID_RV40,
10b9c374
     CODEC_ID_VC1,
21aa398f
     CODEC_ID_WMV3,
9c7fb608
     CODEC_ID_LOCO,
a8a15e9d
     CODEC_ID_WNV1,
589f8220
     CODEC_ID_AASC,
856dbbff
     CODEC_ID_INDEO2,
b81f8949
     CODEC_ID_FRAPS,
64af6168
     CODEC_ID_TRUEMOTION2,
9fa62f2a
     CODEC_ID_BMP,
e0f80bd7
     CODEC_ID_CSCD,
4e114829
     CODEC_ID_MMVIDEO,
9c8d8e84
     CODEC_ID_ZMBV,
26376701
     CODEC_ID_AVS,
348efc18
     CODEC_ID_SMACKVIDEO,
dfca23e3
     CODEC_ID_NUV,
fd7b1991
     CODEC_ID_KMVC,
0919e788
     CODEC_ID_FLASHSV,
20ffddb9
     CODEC_ID_CAVS,
f31065f6
     CODEC_ID_JPEG2000,
eb57c889
     CODEC_ID_VMNC,
5ce117c3
     CODEC_ID_VP5,
     CODEC_ID_VP6,
     CODEC_ID_VP6F,
3689cf16
     CODEC_ID_TARGA,
72450e50
     CODEC_ID_DSICINVIDEO,
29f86228
     CODEC_ID_TIERTEXSEQVIDEO,
a991b1fe
     CODEC_ID_TIFF,
06d392a7
     CODEC_ID_GIF,
3edeab82
     CODEC_ID_FFH264,
33a0dd37
     CODEC_ID_DXA,
52b6bad2
     CODEC_ID_DNXHD,
efb0c399
     CODEC_ID_THP,
2d99eed1
     CODEC_ID_SGI,
9a0ddd09
     CODEC_ID_C93,
1e6c6759
     CODEC_ID_BETHSOFTVID,
b46d68c6
     CODEC_ID_PTX,
1ca779e7
     CODEC_ID_TXD,
91fc2cf1
     CODEC_ID_VP6A,
8787d837
     CODEC_ID_AMV,
66f7679c
     CODEC_ID_VB,
b4abe1d1
     CODEC_ID_PCX,
d43df959
     CODEC_ID_SUNRAST,
800b9c24
     CODEC_ID_INDEO4,
     CODEC_ID_INDEO5,
a7129de5
     CODEC_ID_MIMIC,
975cdc8f
     CODEC_ID_RL2,
cb21e0a7
     CODEC_ID_8SVX_EXP,
     CODEC_ID_8SVX_FIB,
40d26273
     CODEC_ID_ESCAPE124,
782a58ec
     CODEC_ID_DIRAC,
b64c096b
     CODEC_ID_BFI,
495900f7
     CODEC_ID_CMV,
974e0eee
     CODEC_ID_MOTIONPIXELS,
cfc78718
     CODEC_ID_TGV,
42b30357
     CODEC_ID_TGQ,
d8964f3a
     CODEC_ID_TQI,
a96b68b7
 
f5bccd85
     /* various PCM "codecs" */
17179d2d
     CODEC_ID_PCM_S16LE= 0x10000,
a96b68b7
     CODEC_ID_PCM_S16BE,
     CODEC_ID_PCM_U16LE,
     CODEC_ID_PCM_U16BE,
     CODEC_ID_PCM_S8,
     CODEC_ID_PCM_U8,
     CODEC_ID_PCM_MULAW,
     CODEC_ID_PCM_ALAW,
b461b3bc
     CODEC_ID_PCM_S32LE,
     CODEC_ID_PCM_S32BE,
     CODEC_ID_PCM_U32LE,
     CODEC_ID_PCM_U32BE,
     CODEC_ID_PCM_S24LE,
     CODEC_ID_PCM_S24BE,
     CODEC_ID_PCM_U24LE,
     CODEC_ID_PCM_U24BE,
     CODEC_ID_PCM_S24DAUD,
a11c2a2c
     CODEC_ID_PCM_ZORK,
725d86bf
     CODEC_ID_PCM_S16LE_PLANAR,
1472b7dd
     CODEC_ID_PCM_DVD,
aa29709e
     CODEC_ID_PCM_F32BE,
143a5d6f
     CODEC_ID_PCM_F32LE,
     CODEC_ID_PCM_F64BE,
     CODEC_ID_PCM_F64LE,
0147f198
 
f5bccd85
     /* various ADPCM codecs */
17179d2d
     CODEC_ID_ADPCM_IMA_QT= 0x11000,
0147f198
     CODEC_ID_ADPCM_IMA_WAV,
9937e686
     CODEC_ID_ADPCM_IMA_DK3,
     CODEC_ID_ADPCM_IMA_DK4,
2fdf638b
     CODEC_ID_ADPCM_IMA_WS,
7d8379f2
     CODEC_ID_ADPCM_IMA_SMJPEG,
0147f198
     CODEC_ID_ADPCM_MS,
e2a7bb28
     CODEC_ID_ADPCM_4XM,
fc384777
     CODEC_ID_ADPCM_XA,
     CODEC_ID_ADPCM_ADX,
7d8379f2
     CODEC_ID_ADPCM_EA,
e5966052
     CODEC_ID_ADPCM_G726,
b3bfb299
     CODEC_ID_ADPCM_CT,
659c3692
     CODEC_ID_ADPCM_SWF,
2ff4524e
     CODEC_ID_ADPCM_YAMAHA,
2433f24f
     CODEC_ID_ADPCM_SBPRO_4,
     CODEC_ID_ADPCM_SBPRO_3,
     CODEC_ID_ADPCM_SBPRO_2,
d1e0d21f
     CODEC_ID_ADPCM_THP,
3a7f5d07
     CODEC_ID_ADPCM_IMA_AMV,
e7583962
     CODEC_ID_ADPCM_EA_R1,
     CODEC_ID_ADPCM_EA_R3,
     CODEC_ID_ADPCM_EA_R2,
7bb65d89
     CODEC_ID_ADPCM_IMA_EA_SEAD,
fac84d3c
     CODEC_ID_ADPCM_IMA_EA_EACS,
271b4095
     CODEC_ID_ADPCM_EA_XAS,
861c63a2
     CODEC_ID_ADPCM_EA_MAXIS_XA,
055dc116
     CODEC_ID_ADPCM_IMA_ISS,
891f64b3
 
17179d2d
     /* AMR */
     CODEC_ID_AMR_NB= 0x12000,
d663a1fd
     CODEC_ID_AMR_WB,
 
b8414bbd
     /* RealAudio codecs*/
17179d2d
     CODEC_ID_RA_144= 0x13000,
b8414bbd
     CODEC_ID_RA_288,
3ef8be2b
 
     /* various DPCM codecs */
17179d2d
     CODEC_ID_ROQ_DPCM= 0x14000,
3ef8be2b
     CODEC_ID_INTERPLAY_DPCM,
9937e686
     CODEC_ID_XAN_DPCM,
d08d7142
     CODEC_ID_SOL_DPCM,
115329f1
 
ba0dabbf
     /* audio codecs */
17179d2d
     CODEC_ID_MP2= 0x15000,
0e373b95
     CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
17179d2d
     CODEC_ID_AAC,
     CODEC_ID_AC3,
     CODEC_ID_DTS,
     CODEC_ID_VORBIS,
     CODEC_ID_DVAUDIO,
     CODEC_ID_WMAV1,
     CODEC_ID_WMAV2,
     CODEC_ID_MACE3,
     CODEC_ID_MACE6,
     CODEC_ID_VMDAUDIO,
     CODEC_ID_SONIC,
     CODEC_ID_SONIC_LS,
ac2570a8
     CODEC_ID_FLAC,
1ede228a
     CODEC_ID_MP3ADU,
d2a7718d
     CODEC_ID_MP3ON4,
85ad5695
     CODEC_ID_SHORTEN,
5df8a0c6
     CODEC_ID_ALAC,
034eeaa1
     CODEC_ID_WESTWOOD_SND1,
0e373b95
     CODEC_ID_GSM, ///< as in Berlin toast format
d9b1c197
     CODEC_ID_QDM2,
e0f7e329
     CODEC_ID_COOK,
bf3027c8
     CODEC_ID_TRUESPEECH,
a24c4a2a
     CODEC_ID_TTA,
348efc18
     CODEC_ID_SMACKAUDIO,
6c496518
     CODEC_ID_QCELP,
730581f3
     CODEC_ID_WAVPACK,
72450e50
     CODEC_ID_DSICINAUDIO,
84ed36da
     CODEC_ID_IMC,
185c7b6b
     CODEC_ID_MUSEPACK7,
aad512b4
     CODEC_ID_MLP,
f5bccd85
     CODEC_ID_GSM_MS, /* as found in WAV */
10e26bc7
     CODEC_ID_ATRAC3,
8950f828
     CODEC_ID_VOXWARE,
bf4a1f17
     CODEC_ID_APE,
636b13c5
     CODEC_ID_NELLYMOSER,
12877faf
     CODEC_ID_MUSEPACK8,
cb4ddf77
     CODEC_ID_SPEEX,
7bb8d51c
     CODEC_ID_WMAVOICE,
     CODEC_ID_WMAPRO,
800b9c24
     CODEC_ID_WMALOSSLESS,
b339f0c6
     CODEC_ID_ATRAC3P,
2988c93d
     CODEC_ID_EAC3,
faeedbbb
     CODEC_ID_SIPR,
7f507b2d
     CODEC_ID_MP1,
115329f1
 
240c1657
     /* subtitle codecs */
115329f1
     CODEC_ID_DVD_SUBTITLE= 0x17000,
     CODEC_ID_DVB_SUBTITLE,
0e373b95
     CODEC_ID_TEXT,  ///< raw UTF-8 text
7e2643ae
     CODEC_ID_XSUB,
f9a9b350
     CODEC_ID_SSA,
cc8c2c6a
     CODEC_ID_MOV_TEXT,
115329f1
 
7ce68923
     /* other specific kind of codecs (generally used for attachments) */
f8d7c9d3
     CODEC_ID_TTF= 0x18000,
 
0bef08e5
     CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
 
0e373b95
     CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
f5bccd85
                                 * stream (only used by libavformat) */
de6d9b64
 };
dcedf586
 
de6d9b64
 enum CodecType {
4a663d80
     CODEC_TYPE_UNKNOWN = -1,
de6d9b64
     CODEC_TYPE_VIDEO,
     CODEC_TYPE_AUDIO,
985180a1
     CODEC_TYPE_DATA,
240c1657
     CODEC_TYPE_SUBTITLE,
f8d7c9d3
     CODEC_TYPE_ATTACHMENT,
9ff77d17
     CODEC_TYPE_NB
de6d9b64
 };
 
0e373b95
 /**
  * all in native-endian format
  */
a96b68b7
 enum SampleFormat {
9076fee4
     SAMPLE_FMT_NONE = -1,
1319a77b
     SAMPLE_FMT_U8,              ///< unsigned 8 bits
     SAMPLE_FMT_S16,             ///< signed 16 bits
115329f1
     SAMPLE_FMT_S32,             ///< signed 32 bits
a3a5f4d6
     SAMPLE_FMT_FLT,             ///< float
e06b00f3
     SAMPLE_FMT_DBL,             ///< double
88a07af7
     SAMPLE_FMT_NB               ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
a96b68b7
 };
 
0d72e7d0
 /* Audio channel masks */
9d9b9d32
 #define CH_FRONT_LEFT             0x00000001
 #define CH_FRONT_RIGHT            0x00000002
 #define CH_FRONT_CENTER           0x00000004
 #define CH_LOW_FREQUENCY          0x00000008
 #define CH_BACK_LEFT              0x00000010
 #define CH_BACK_RIGHT             0x00000020
 #define CH_FRONT_LEFT_OF_CENTER   0x00000040
 #define CH_FRONT_RIGHT_OF_CENTER  0x00000080
 #define CH_BACK_CENTER            0x00000100
 #define CH_SIDE_LEFT              0x00000200
 #define CH_SIDE_RIGHT             0x00000400
 #define CH_TOP_CENTER             0x00000800
 #define CH_TOP_FRONT_LEFT         0x00001000
 #define CH_TOP_FRONT_CENTER       0x00002000
 #define CH_TOP_FRONT_RIGHT        0x00004000
 #define CH_TOP_BACK_LEFT          0x00008000
 #define CH_TOP_BACK_CENTER        0x00010000
 #define CH_TOP_BACK_RIGHT         0x00020000
 #define CH_STEREO_LEFT            0x20000000  ///< Stereo downmix.
 #define CH_STEREO_RIGHT           0x40000000  ///< See CH_STEREO_LEFT.
0d72e7d0
 
 /* Audio channel convenience macros */
9d9b9d32
 #define CH_LAYOUT_MONO              (CH_FRONT_CENTER)
 #define CH_LAYOUT_STEREO            (CH_FRONT_LEFT|CH_FRONT_RIGHT)
 #define CH_LAYOUT_SURROUND          (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
 #define CH_LAYOUT_QUAD              (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
 #define CH_LAYOUT_5POINT0           (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
 #define CH_LAYOUT_5POINT1           (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
 #define CH_LAYOUT_7POINT1           (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
 #define CH_LAYOUT_7POINT1_WIDE      (CH_LAYOUT_SURROUND|CH_LOW_FREQUENCY|\
                                           CH_BACK_LEFT|CH_BACK_RIGHT|\
                                           CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
 #define CH_LAYOUT_STEREO_DOWNMIX    (CH_STEREO_LEFT|CH_STEREO_RIGHT)
0d72e7d0
 
de6d9b64
 /* in bytes */
8170e5fb
 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
de6d9b64
 
d7425f59
 /**
cf713bb8
  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
f5bccd85
  * This is mainly needed because some optimized bitstream readers read
  * 32 or 64 bit at once and could read over the end.<br>
  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
  * MPEG bitstreams could cause overread and segfault.
d7425f59
  */
 #define FF_INPUT_BUFFER_PADDING_SIZE 8
 
0ecca7a4
 /**
f5bccd85
  * minimum encoding buffer size
  * Used to avoid some checks during header writing.
0ecca7a4
  */
 #define FF_MIN_BUFFER_SIZE 16384
 
47146dfb
 
0e373b95
 /**
bafc102b
  * motion estimation type.
0e373b95
  */
e4986da9
 enum Motion_Est_ID {
9b4dd1b8
     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
e4986da9
     ME_FULL,
     ME_LOG,
     ME_PHODS,
9b4dd1b8
     ME_EPZS,        ///< enhanced predictive zonal search
     ME_X1,          ///< reserved for experiments
     ME_HEX,         ///< hexagon based search
     ME_UMH,         ///< uneven multi-hexagon search
     ME_ITER,        ///< iterative search
359bbdab
     ME_TESA,        ///< transformed exhaustive search algorithm
e4986da9
 };
 
8c3eba7c
 enum AVDiscard{
f5bccd85
     /* We leave some space between them for extensions (drop some
      * keyframes for intra-only or drop just some bidir frames). */
8c3eba7c
     AVDISCARD_NONE   =-16, ///< discard nothing
     AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
     AVDISCARD_NONREF =  8, ///< discard all non reference
     AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
     AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
     AVDISCARD_ALL    = 48, ///< discard all
 };
 
ce980a95
 typedef struct RcOverride{
     int start_frame;
     int end_frame;
f5bccd85
     int qscale; // If this is 0 then quality_factor will be used instead.
ce980a95
     float quality_factor;
 } RcOverride;
 
b0ec9efd
 #define FF_MAX_B_FRAMES 16
9dbcbd92
 
a949d72e
 /* encoding support
f5bccd85
    These flags can be passed in AVCodecContext.flags before initialization.
    Note: Not everything is supported yet.
a949d72e
 */
de6d9b64
 
f5bccd85
 #define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
 #define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
 #define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
 #define CODEC_FLAG_PART   0x0080  ///< Use data partitioning.
1ba8f5eb
 /**
  * The parent program guarantees that the input for B-frames containing
f5bccd85
  * streams is not written to for at least s->max_b_frames+1 frames, if
1ba8f5eb
  * this is not set the input will be copied.
  */
8b4c7dbc
 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
273b0cd3
 #define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
 #define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
 #define CODEC_FLAG_EXTERN_HUFF     0x1000   ///< Use external Huffman table (for MJPEG).
 #define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
 #define CODEC_FLAG_EMU_EDGE        0x4000   ///< Don't draw edges.
 #define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
 #define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
                                                   location instead of only at frame boundaries. */
f5bccd85
 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
 #define CODEC_FLAG_ALT_SCAN       0x00100000 ///< Use alternate scan.
 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
 #define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
21e59552
 /* Fx : Flag for h263+ extra options */
f5bccd85
 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
 #define CODEC_FLAG_H263P_UMV      0x02000000 ///< unlimited motion vector
 #define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
 #define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
 #define CODEC_FLAG_H263P_AIV      0x00000008 ///< H.263 alternative inter VLC
332f9ac4
 #define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
 #define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
bb198e19
 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
 #define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
f5bccd85
 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
f3eec1cf
 #define CODEC_FLAG_CLOSED_GOP     0x80000000
f5bccd85
 #define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
 #define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
 #define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
 #define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
 #define CODEC_FLAG2_BPYRAMID      0x00000010 ///< H.264 allow B-frames to be used as references.
 #define CODEC_FLAG2_WPRED         0x00000020 ///< H.264 weighted biprediction for B-frames
d3075ed5
 #define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
58f7833e
 #define CODEC_FLAG2_8X8DCT        0x00000080 ///< H.264 high profile 8x8 transform
 #define CODEC_FLAG2_FASTPSKIP     0x00000100 ///< H.264 fast pskip
 #define CODEC_FLAG2_AUD           0x00000200 ///< H.264 access unit delimiters
f5bccd85
 #define CODEC_FLAG2_BRDO          0x00000400 ///< B-frame rate-distortion optimization
 #define CODEC_FLAG2_INTRA_VLC     0x00000800 ///< Use MPEG-2 intra VLC table.
 #define CODEC_FLAG2_MEMC_ONLY     0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
 #define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
 #define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
f1618fd9
 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
53b90bb2
 #define CODEC_FLAG2_MBTREE        0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
6fc5b059
 
21e59552
 /* Unsupported options :
bb270c08
  *              Syntax Arithmetic coding (SAC)
  *              Reference Picture Selection
eafcac6a
  *              Independent Segment Decoding */
21e59552
 /* /Fx */
bf89e6b1
 /* codec capabilities */
 
f5bccd85
 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
6814a25c
 /**
  * Codec uses get_buffer() for allocating buffers.
  * direct rendering method 1
  */
 #define CODEC_CAP_DR1             0x0002
f5bccd85
 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
917e06c8
 #define CODEC_CAP_PARSE_ONLY      0x0004
d7425f59
 #define CODEC_CAP_TRUNCATED       0x0008
f5bccd85
 /* Codec can export data for HW decoding (XvMC). */
5e5c247a
 #define CODEC_CAP_HWACCEL         0x0010
115329f1
 /**
f5bccd85
  * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
  * If this is not set, the codec is guaranteed to never be fed with NULL data.
934982c4
  */
6f824977
 #define CODEC_CAP_DELAY           0x0020
cef7cc72
 /**
  * Codec can be fed a final frame with a smaller size.
  * This can be used to prevent truncation of the last audio samples.
  */
 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
369122dd
 /**
  * Codec can export data for HW decoding (VDPAU).
  */
 #define CODEC_CAP_HWACCEL_VDPAU    0x0080
bf89e6b1
 
f5bccd85
 //The following defines may change, don't expect compatibility if you use them.
8d7ec294
 #define MB_TYPE_INTRA4x4   0x0001
f5bccd85
 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
8d7ec294
 #define MB_TYPE_16x16      0x0008
 #define MB_TYPE_16x8       0x0010
 #define MB_TYPE_8x16       0x0020
 #define MB_TYPE_8x8        0x0040
 #define MB_TYPE_INTERLACED 0x0080
273b0cd3
 #define MB_TYPE_DIRECT2    0x0100 //FIXME
8d7ec294
 #define MB_TYPE_ACPRED     0x0200
 #define MB_TYPE_GMC        0x0400
 #define MB_TYPE_SKIP       0x0800
 #define MB_TYPE_P0L0       0x1000
 #define MB_TYPE_P1L0       0x2000
 #define MB_TYPE_P0L1       0x4000
 #define MB_TYPE_P1L1       0x8000
 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
 #define MB_TYPE_QUANT      0x00010000
 #define MB_TYPE_CBP        0x00020000
 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
 
fa384dcc
 /**
  * Pan Scan area.
f5bccd85
  * This specifies the area which should be displayed.
  * Note there may be multiple such areas for one frame.
fa384dcc
  */
 typedef struct AVPanScan{
     /**
f5bccd85
      * id
      * - encoding: Set by user.
      * - decoding: Set by libavcodec.
fa384dcc
      */
     int id;
 
     /**
      * width and height in 1/16 pel
f5bccd85
      * - encoding: Set by user.
      * - decoding: Set by libavcodec.
fa384dcc
      */
     int width;
     int height;
 
     /**
f5bccd85
      * position of the top left corner in 1/16 pel for up to 3 fields/frames
      * - encoding: Set by user.
      * - decoding: Set by libavcodec.
fa384dcc
      */
     int16_t position[3][2];
 }AVPanScan;
 
492cd3a9
 #define FF_COMMON_FRAME \
b536d0aa
     /**\
      * pointer to the picture planes.\
f5bccd85
      * This might be different from the first allocated byte\
b536d0aa
      * - encoding: \
      * - decoding: \
      */\
1e491e29
     uint8_t *data[4];\
     int linesize[4];\
     /**\
f5bccd85
      * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
      * This isn't used by libavcodec unless the default get/release_buffer() is used.\
64863965
      * - encoding: \
      * - decoding: \
1e491e29
      */\
     uint8_t *base[4];\
     /**\
      * 1 -> keyframe, 0-> not\
f5bccd85
      * - encoding: Set by libavcodec.\
      * - decoding: Set by libavcodec.\
1e491e29
      */\
     int key_frame;\
 \
     /**\
f5bccd85
      * Picture type of the frame, see ?_TYPE below.\
      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
      * - decoding: Set by libavcodec.\
1e491e29
      */\
     int pict_type;\
 \
     /**\
c0df9d75
      * presentation timestamp in time_base units (time when frame should be shown to user)\
f5bccd85
      * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
      * - encoding: MUST be set by user.\
      * - decoding: Set by libavcodec.\
1e491e29
      */\
be6784dc
     int64_t pts;\
1e491e29
 \
     /**\
f5bccd85
      * picture number in bitstream order\
64863965
      * - encoding: set by\
f5bccd85
      * - decoding: Set by libavcodec.\
1e491e29
      */\
     int coded_picture_number;\
     /**\
f5bccd85
      * picture number in display order\
64863965
      * - encoding: set by\
f5bccd85
      * - decoding: Set by libavcodec.\
1e491e29
      */\
     int display_picture_number;\
 \
     /**\
158c7f05
      * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
f5bccd85
      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
      * - decoding: Set by libavcodec.\
1e491e29
      */\
158c7f05
     int quality; \
1e491e29
 \
     /**\
      * buffer age (1->was last buffer and dint change, 2->..., ...).\
f5bccd85
      * Set to INT_MAX if the buffer has not been used yet.\
64863965
      * - encoding: unused\
f5bccd85
      * - decoding: MUST be set by get_buffer().\
1e491e29
      */\
     int age;\
 \
     /**\
      * is this picture used as reference\
8474f58e
      * The values for this are the same as the MpegEncContext.picture_structure\
      * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
5fe2a515
      * Set to 4 for delayed, non-reference frames.\
64863965
      * - encoding: unused\
f5bccd85
      * - decoding: Set by libavcodec. (before get_buffer() call)).\
1e491e29
      */\
     int reference;\
 \
     /**\
      * QP table\
64863965
      * - encoding: unused\
f5bccd85
      * - decoding: Set by libavcodec.\
1e491e29
      */\
     int8_t *qscale_table;\
     /**\
      * QP store stride\
64863965
      * - encoding: unused\
f5bccd85
      * - decoding: Set by libavcodec.\
1e491e29
      */\
     int qstride;\
 \
     /**\
f5bccd85
      * mbskip_table[mb]>=1 if MB didn't change\
1e491e29
      * stride= mb_width = (width+15)>>4\
64863965
      * - encoding: unused\
f5bccd85
      * - decoding: Set by libavcodec.\
1e491e29
      */\
     uint8_t *mbskip_table;\
 \
     /**\
f5bccd85
      * motion vector table\
61436073
      * @code\
      * example:\
      * int mv_sample_log2= 4 - motion_subsample_log2;\
      * int mb_width= (width+15)>>4;\
      * int mv_stride= (mb_width << mv_sample_log2) + 1;\
      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
      * @endcode\
f5bccd85
      * - encoding: Set by user.\
      * - decoding: Set by libavcodec.\
8d7ec294
      */\
     int16_t (*motion_val[2])[2];\
 \
     /**\
f5bccd85
      * macroblock type table\
8d7ec294
      * mb_type_base + mb_width + 2\
f5bccd85
      * - encoding: Set by user.\
      * - decoding: Set by libavcodec.\
8d7ec294
      */\
     uint32_t *mb_type;\
 \
     /**\
f0b77c69
      * log2 of the size of the block which a single vector in motion_val represents: \
      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
8d7ec294
      * - encoding: unused\
f5bccd85
      * - decoding: Set by libavcodec.\
8d7ec294
      */\
     uint8_t motion_subsample_log2;\
 \
     /**\
1e491e29
      * for some private data of the user\
64863965
      * - encoding: unused\
f5bccd85
      * - decoding: Set by user.\
1e491e29
      */\
     void *opaque;\
140cb663
 \
     /**\
      * error\
f5bccd85
      * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
64863965
      * - decoding: unused\
140cb663
      */\
     uint64_t error[4];\
4e00e76b
 \
     /**\
f5bccd85
      * type of the buffer (to keep track of who has to deallocate data[*])\
      * - encoding: Set by the one who allocates it.\
      * - decoding: Set by the one who allocates it.\
      * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
4e00e76b
      */\
     int type;\
2ec23b6d
     \
     /**\
f5bccd85
      * When decoding, this signals how much the picture must be delayed.\
2ec23b6d
      * extra_delay = repeat_pict / (2*fps)\
64863965
      * - encoding: unused\
f5bccd85
      * - decoding: Set by libavcodec.\
2ec23b6d
      */\
0426af31
     int repeat_pict;\
     \
     /**\
      * \
      */\
     int qscale_type;\
2744ca9a
     \
     /**\
      * The content of the picture is interlaced.\
f5bccd85
      * - encoding: Set by user.\
      * - decoding: Set by libavcodec. (default 0)\
2744ca9a
      */\
     int interlaced_frame;\
     \
     /**\
f5bccd85
      * If the content is interlaced, is top field displayed first.\
      * - encoding: Set by user.\
      * - decoding: Set by libavcodec.\
2744ca9a
      */\
9dad924e
     int top_field_first;\
fa384dcc
     \
     /**\
      * Pan scan.\
f5bccd85
      * - encoding: Set by user.\
      * - decoding: Set by libavcodec.\
fa384dcc
      */\
     AVPanScan *pan_scan;\
2a2bbcb0
     \
     /**\
f5bccd85
      * Tell user application that palette has changed from previous frame.\
2a2bbcb0
      * - encoding: ??? (no palette-enabled encoder yet)\
f5bccd85
      * - decoding: Set by libavcodec. (default 0).\
2a2bbcb0
      */\
     int palette_has_changed;\
074c4ca7
     \
     /**\
f5bccd85
      * codec suggestion on buffer type if != 0\
074c4ca7
      * - encoding: unused\
f5bccd85
      * - decoding: Set by libavcodec. (before get_buffer() call)).\
074c4ca7
      */\
     int buffer_hints;\
8289c6fa
 \
     /**\
f5bccd85
      * DCT coefficients\
8289c6fa
      * - encoding: unused\
f5bccd85
      * - decoding: Set by libavcodec.\
8289c6fa
      */\
     short *dct_coeff;\
a4d36c11
 \
     /**\
f5bccd85
      * motion referece frame index\
      * - encoding: Set by user.\
      * - decoding: Set by libavcodec.\
a4d36c11
      */\
79de84f2
     int8_t *ref_index[2];\
 \
     /**\
      * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
      * output in AVFrame.reordered_opaque\
      * - encoding: unused\
      * - decoding: Read by user.\
      */\
     int64_t reordered_opaque;\
 
2ec23b6d
 
bb270c08
 #define FF_QSCALE_TYPE_MPEG1 0
 #define FF_QSCALE_TYPE_MPEG2 1
 #define FF_QSCALE_TYPE_H264  2
4e00e76b
 
 #define FF_BUFFER_TYPE_INTERNAL 1
f5bccd85
 #define FF_BUFFER_TYPE_USER     2 ///< direct rendering buffers (image is (de)allocated by user)
 #define FF_BUFFER_TYPE_SHARED   4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
 #define FF_BUFFER_TYPE_COPY     8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
4e00e76b
 
1e491e29
 
dc85e859
 #define FF_I_TYPE  1 ///< Intra
 #define FF_P_TYPE  2 ///< Predicted
 #define FF_B_TYPE  3 ///< Bi-dir predicted
 #define FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
 #define FF_SI_TYPE 5 ///< Switching Intra
 #define FF_SP_TYPE 6 ///< Switching Predicted
48d533e6
 #define FF_BI_TYPE 7
1e491e29
 
f5bccd85
 #define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
074c4ca7
 
0da71265
 /**
  * Audio Video Frame.
ba66ae94
  * New fields can be added to the end of FF_COMMON_FRAME with minor version
  * bumps.
8bfb108b
  * Removal, reordering and changes to existing fields require a major
ba66ae94
  * version bump. No fields should be added into AVFrame before or after
  * FF_COMMON_FRAME!
8bfb108b
  * sizeof(AVFrame) must not be used outside libav*.
0da71265
  */
492cd3a9
 typedef struct AVFrame {
     FF_COMMON_FRAME
 } AVFrame;
1e491e29
 
d33c949c
 /**
252f17e2
  * main external API structure.
  * New fields can be added to the end with minor version bumps.
8bfb108b
  * Removal, reordering and changes to existing fields require a major
252f17e2
  * version bump.
8bfb108b
  * sizeof(AVCodecContext) must not be used outside libav*.
d33c949c
  */
de6d9b64
 typedef struct AVCodecContext {
b71901e6
     /**
f5bccd85
      * information on struct for av_log
bc874dae
      * - set by avcodec_alloc_context
      */
d42a814e
     const AVClass *av_class;
bc874dae
     /**
f5bccd85
      * the average bitrate
      * - encoding: Set by user; unused for constant quantizer encoding.
      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
b71901e6
      */
de6d9b64
     int bit_rate;
b71901e6
 
     /**
64863965
      * number of bits the bitstream is allowed to diverge from the reference.
b71901e6
      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
f5bccd85
      * - encoding: Set by user; unused for constant quantizer encoding.
64863965
      * - decoding: unused
b71901e6
      */
115329f1
     int bit_rate_tolerance;
b71901e6
 
     /**
64863965
      * CODEC_FLAG_*.
f5bccd85
      * - encoding: Set by user.
      * - decoding: Set by user.
b71901e6
      */
de6d9b64
     int flags;
b71901e6
 
     /**
f5bccd85
      * Some codecs need additional format info. It is stored here.
      * If any muxer uses this then ALL demuxers/parsers AND encoders for the
      * specific codec MUST set it correctly otherwise stream copy breaks.
      * In general use of this field by muxers is not recommanded.
      * - encoding: Set by libavcodec.
      * - decoding: Set by libavcodec. (FIXME: Is this OK?)
b71901e6
      */
     int sub_id;
 
     /**
f5bccd85
      * Motion estimation algorithm used for video coding.
58f7833e
      * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
89223ef6
      * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
64863965
      * - encoding: MUST be set by user.
      * - decoding: unused
b71901e6
      */
     int me_method;
 
     /**
f5bccd85
      * some codecs need / can use extradata like Huffman tables.
      * mjpeg: Huffman tables
b71901e6
      * rv10: additional flags
b704e742
      * mpeg4: global headers (they can be in the bitstream or here)
f5bccd85
      * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
      * than extradata_size to avoid prolems if it is read with the bitstream reader.
      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
      * - encoding: Set/allocated/freed by libavcodec.
      * - decoding: Set/allocated/freed by user.
b71901e6
      */
58f2a4b0
     uint8_t *extradata;
e84c31dc
     int extradata_size;
115329f1
 
b71901e6
     /**
f5bccd85
      * This is the fundamental unit of time (in seconds) in terms
      * of which frame timestamps are represented. For fixed-fps content,
5b28c8c3
      * timebase should be 1/framerate and timestamp increments should be
      * identically 1.
f5bccd85
      * - encoding: MUST be set by user.
      * - decoding: Set by libavcodec.
b71901e6
      */
c0df9d75
     AVRational time_base;
115329f1
 
5b28c8c3
     /* video only */
14bea432
     /**
21adafec
      * picture width / height.
115329f1
      * - encoding: MUST be set by user.
f5bccd85
      * - decoding: Set by libavcodec.
      * Note: For compatibility it is possible to set this instead of
      * coded_width/height before decoding.
b71901e6
      */
de6d9b64
     int width, height;
115329f1
 
e769f053
 #define FF_ASPECT_EXTENDED 15
b71901e6
 
     /**
f5bccd85
      * the number of pictures in a group of pictures, or 0 for intra_only
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
     int gop_size;
 
     /**
f5bccd85
      * Pixel format, see PIX_FMT_xxx.
      * - encoding: Set by user.
      * - decoding: Set by libavcodec.
b71901e6
      */
e4eadb4b
     enum PixelFormat pix_fmt;
115329f1
 
bdfcbbed
     /**
f5bccd85
      * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
bdfcbbed
      * has to read frames at native frame rate.
f5bccd85
      * - encoding: Set by user.
      * - decoding: unused
bdfcbbed
      */
     int rate_emu;
115329f1
 
b71901e6
     /**
f5bccd85
      * If non NULL, 'draw_horiz_band' is called by the libavcodec
      * decoder to draw a horizontal band. It improves cache usage. Not
b71901e6
      * all codecs can do that. You must check the codec capabilities
f5bccd85
      * beforehand.
24b1583a
      * The function is also used by hardware acceleration APIs.
      * It is called at least once during frame decoding to pass
      * the data needed for hardware render.
      * In that mode instead of pixel data, AVFrame points to
      * a structure specific to the acceleration API. The application
      * reads the structure and can change some fields to indicate progress
      * or mark state.
64863965
      * - encoding: unused
f5bccd85
      * - decoding: Set by user.
3bb07d61
      * @param height the height of the slice
      * @param y the y position of the slice
      * @param type 1->top field, 2->bottom field, 3->frame
      * @param offset offset into the AVFrame.data from which the slice should be read
b71901e6
      */
bf89e6b1
     void (*draw_horiz_band)(struct AVCodecContext *s,
da64ecc3
                             const AVFrame *src, int offset[4],
3bb07d61
                             int y, int type, int height);
bf89e6b1
 
de6d9b64
     /* audio only */
f5bccd85
     int sample_rate; ///< samples per second
5fcc4a23
     int channels;    ///< number of audio channels
a3a5f4d6
 
     /**
f5bccd85
      * audio sample format
      * - encoding: Set by user.
      * - decoding: Set by libavcodec.
a3a5f4d6
      */
f5bccd85
     enum SampleFormat sample_fmt;  ///< sample format, currently unused
de6d9b64
 
f5bccd85
     /* The following data should not be initialized. */
718b27a7
     /**
f5bccd85
      * Samples per packet, initialized when calling 'init'.
718b27a7
      */
     int frame_size;
115329f1
     int frame_number;   ///< audio or video frame number
f5bccd85
     int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
115329f1
 
b71901e6
     /**
f5bccd85
      * Number of frames the decoded output will be delayed relative to
64863965
      * the encoded input.
f5bccd85
      * - encoding: Set by libavcodec.
64863965
      * - decoding: unused
b71901e6
      */
     int delay;
115329f1
 
64863965
     /* - encoding parameters */
     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
115329f1
     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
 
b71901e6
     /**
f5bccd85
      * minimum quantizer
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
     int qmin;
 
     /**
f5bccd85
      * maximum quantizer
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
     int qmax;
 
     /**
f5bccd85
      * maximum quantizer difference between frames
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
     int max_qdiff;
 
     /**
f5bccd85
      * maximum number of B-frames between non-B-frames
      * Note: The output will be delayed by max_b_frames+1 relative to the input.
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
     int max_b_frames;
 
     /**
f5bccd85
      * qscale factor between IP and B-frames
662e5411
      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
f5bccd85
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
     float b_quant_factor;
115329f1
 
b71901e6
     /** obsolete FIXME remove */
     int rc_strategy;
64b7c5b6
 #define FF_RC_STRATEGY_XVID 1
 
8b4c7dbc
     int b_frame_strategy;
9dbcbd92
 
b71901e6
     /**
f5bccd85
      * hurry up amount
64863965
      * - encoding: unused
f5bccd85
      * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
f9ec0aa1
      * @deprecated Deprecated in favor of skip_idct and skip_frame.
b71901e6
      */
     int hurry_up;
115329f1
 
de6d9b64
     struct AVCodec *codec;
115329f1
 
de6d9b64
     void *priv_data;
 
bb628dae
     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
f5bccd85
                             /* do its best to deliver a chunk with size     */
644d98a4
                             /* below rtp_payload_size, the chunk will start */
f5bccd85
                             /* with a start code on some codecs like H.263. */
644d98a4
                             /* This doesn't take account of any particular  */
f5bccd85
                             /* headers inside the transmitted RTP payload.  */
81401c1f
 
115329f1
 
f5bccd85
     /* The RTP callback: This function is called    */
     /* every time the encoder has a packet to send. */
     /* It depends on the encoder if the data starts */
     /* with a Start Code (it should). H.263 does.   */
     /* mb_nb contains the number of macroblocks     */
     /* encoded in the RTP payload.                  */
115329f1
     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
81401c1f
 
098eefe1
     /* statistics, used for 2-pass encoding */
     int mv_bits;
     int header_bits;
     int i_tex_bits;
     int p_tex_bits;
     int i_count;
     int p_count;
     int skip_count;
b71901e6
     int misc_bits;
115329f1
 
b71901e6
     /**
f5bccd85
      * number of bits used for the previously encoded frame
      * - encoding: Set by libavcodec.
7004ffb3
      * - decoding: unused
b71901e6
      */
098eefe1
     int frame_bits;
7004ffb3
 
b71901e6
     /**
f5bccd85
      * Private data of the user, can be used to carry app specific stuff.
      * - encoding: Set by user.
      * - decoding: Set by user.
b71901e6
      */
     void *opaque;
 
de6d9b64
     char codec_name[32];
4a663d80
     enum CodecType codec_type; /* see CODEC_TYPE_xxx */
     enum CodecID codec_id; /* see CODEC_ID_xxx */
115329f1
 
7004ffb3
     /**
      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
f5bccd85
      * This is used to work around some encoder bugs.
      * A demuxer should set this to what is stored in the field used to identify the codec.
      * If there are multiple such fields in a container then the demuxer should choose the one
      * which maximizes the information about the used codec.
      * If the codec tag field in a container is larger then 32 bits then the demuxer should
      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
47bbf8a7
      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
f5bccd85
      * first.
      * - encoding: Set by user, if not then the default based on codec_id will be used.
      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
7004ffb3
      */
     unsigned int codec_tag;
115329f1
 
b71901e6
     /**
f5bccd85
      * Work around bugs in encoders which sometimes cannot be detected automatically.
      * - encoding: Set by user
      * - decoding: Set by user
b71901e6
      */
     int workaround_bugs;
64863965
 #define FF_BUG_AUTODETECT       1  ///< autodetection
4d2858de
 #define FF_BUG_OLD_MSMPEG4      2
 #define FF_BUG_XVID_ILACE       4
 #define FF_BUG_UMP4             8
 #define FF_BUG_NO_PADDING       16
3116cb14
 #define FF_BUG_AMV              32
f5bccd85
 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
03e93d35
 #define FF_BUG_QPEL_CHROMA      64
db794953
 #define FF_BUG_STD_QPEL         128
36df8805
 #define FF_BUG_QPEL_CHROMA2     256
c40c3482
 #define FF_BUG_DIRECT_BLOCKSIZE 512
1c6dcb0f
 #define FF_BUG_EDGE             1024
b44bdf7e
 #define FF_BUG_HPEL_CHROMA      2048
4ccde216
 #define FF_BUG_DC_CLIP          4096
f5bccd85
 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
115329f1
 
b71901e6
     /**
f5bccd85
      * luma single coefficient elimination threshold
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
1f6b6e50
     int luma_elim_threshold;
115329f1
 
b71901e6
     /**
f5bccd85
      * chroma single coeff elimination threshold
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
1f6b6e50
     int chroma_elim_threshold;
115329f1
 
b71901e6
     /**
f5bccd85
      * strictly follow the standard (MPEG4, ...).
      * - encoding: Set by user.
5771b2c3
      * - decoding: Set by user.
      * Setting this to STRICT or higher means the encoder and decoder will
      * generally do stupid things. While setting it to inofficial or lower
      * will mean the encoder might use things that are not supported by all
      * spec compliant decoders. Decoders make no difference between normal,
      * inofficial and experimental, that is they always try to decode things
      * when they can unless they are explicitly asked to behave stupid
      * (=strictly conform to the specs)
b71901e6
      */
     int strict_std_compliance;
f5bccd85
 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to a older more strict version of the spec or reference software.
 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
9cd81798
 #define FF_COMPLIANCE_NORMAL        0
f5bccd85
 #define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
9cd81798
 
b71901e6
     /**
f5bccd85
      * qscale offset between IP and B-frames
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
     float b_quant_offset;
115329f1
 
b71901e6
     /**
047599a4
      * Error recognization; higher values will detect more errors but may
f5bccd85
      * misdetect some more or less valid parts as errors.
64863965
      * - encoding: unused
f5bccd85
      * - decoding: Set by user.
b71901e6
      */
047599a4
     int error_recognition;
1471c6c2
 #define FF_ER_CAREFUL         1
ce3bcaed
 #define FF_ER_COMPLIANT       2
 #define FF_ER_AGGRESSIVE      3
 #define FF_ER_VERY_AGGRESSIVE 4
115329f1
 
6b72ac63
     /**
f5bccd85
      * Called at the beginning of each frame to get a buffer for it.
      * If pic.reference is set then the frame will be read later by libavcodec.
2b5296d2
      * avcodec_align_dimensions() should be used to find the required width and
f5bccd85
      * height, as they normally need to be rounded up to the next multiple of 16.
64863965
      * - encoding: unused
f5bccd85
      * - decoding: Set by libavcodec., user can override.
b71901e6
      */
492cd3a9
     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
115329f1
 
b71901e6
     /**
69b192ac
      * Called to release buffers which were allocated with get_buffer.
f5bccd85
      * A released buffer can be reused in get_buffer().
      * pic.data[*] must be set to NULL.
64863965
      * - encoding: unused
f5bccd85
      * - decoding: Set by libavcodec., user can override.
b71901e6
      */
492cd3a9
     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
0fd90455
 
b71901e6
     /**
eb8a25c8
      * Size of the frame reordering buffer in the decoder.
2d7b0560
      * For MPEG-2 it is 1 IPB or 0 low delay IP.
f5bccd85
      * - encoding: Set by libavcodec.
      * - decoding: Set by libavcodec.
b71901e6
      */
     int has_b_frames;
718b27a7
 
     /**
      * number of bytes per packet if constant and known or 0
f5bccd85
      * Used by some WAV based audio codecs.
718b27a7
      */
     int block_align;
115329f1
 
f5bccd85
     int parse_only; /* - decoding only: If true, only parsing is done
917e06c8
                        (function avcodec_parse_frame()). The frame
                        data is returned. Only MPEG codecs support this now. */
115329f1
 
b71901e6
     /**
f5bccd85
      * 0-> h263 quant 1-> mpeg quant
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
     int mpeg_quant;
115329f1
 
b71901e6
     /**
f5bccd85
      * pass1 encoding statistics output buffer
      * - encoding: Set by libavcodec.
64863965
      * - decoding: unused
b71901e6
      */
64863965
     char *stats_out;
115329f1
 
b71901e6
     /**
f5bccd85
      * pass2 encoding statistics input buffer
      * Concatenated stuff from stats_out of pass1 should be placed here.
      * - encoding: Allocated/set/freed by user.
64863965
      * - decoding: unused
b71901e6
      */
     char *stats_in;
115329f1
 
b71901e6
     /**
f5bccd85
      * ratecontrol qmin qmax limiting method
      * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
ce980a95
     float rc_qsquish;
b71901e6
 
ce980a95
     float rc_qmod_amp;
     int rc_qmod_freq;
115329f1
 
b71901e6
     /**
f5bccd85
      * ratecontrol override, see RcOverride
      * - encoding: Allocated/set/freed by user.
64863965
      * - decoding: unused
b71901e6
      */
ce980a95
     RcOverride *rc_override;
     int rc_override_count;
115329f1
 
b71901e6
     /**
f5bccd85
      * rate control equation
      * - encoding: Set by user
64863965
      * - decoding: unused
b71901e6
      */
6881b8e5
     const char *rc_eq;
115329f1
 
b71901e6
     /**
f5bccd85
      * maximum bitrate
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
ce980a95
     int rc_max_rate;
115329f1
 
b71901e6
     /**
f5bccd85
      * minimum bitrate
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
ce980a95
     int rc_min_rate;
115329f1
 
b71901e6
     /**
f5bccd85
      * decoder bitstream buffer size
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
ce980a95
     int rc_buffer_size;
     float rc_buffer_aggressivity;
b71901e6
 
     /**
f5bccd85
      * qscale factor between P and I-frames
      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
     float i_quant_factor;
115329f1
 
b71901e6
     /**
f5bccd85
      * qscale offset between P and I-frames
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
     float i_quant_offset;
115329f1
 
b71901e6
     /**
f5bccd85
      * initial complexity for pass1 ratecontrol
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
ce980a95
     float rc_initial_cplx;
917e06c8
 
b71901e6
     /**
f5bccd85
      * DCT algorithm, see FF_DCT_* below
      * - encoding: Set by user.
64863965
      * - decoding: unused
b71901e6
      */
28db7fce
     int dct_algo;
c7e07931
 #define FF_DCT_AUTO    0
28db7fce
 #define FF_DCT_FASTINT 1
c7e07931
 #define FF_DCT_INT     2
 #define FF_DCT_MMX     3
 #define FF_DCT_MLIB    4
05c4072b
 #define FF_DCT_ALTIVEC 5
65e4c8c9
 #define FF_DCT_FAAN    6
115329f1
 
c5d309f2
     /**
f5bccd85
      * luminance masking (0-> disabled)
      * - encoding: Set by user.
64863965
      * - decoding: unused
c5d309f2
      */
     float lumi_masking;
115329f1
 
c5d309f2
     /**
f5bccd85
      * temporary complexity masking (0-> disabled)
      * - encoding: Set by user.
64863965
      * - decoding: unused
c5d309f2
      */
     float temporal_cplx_masking;
115329f1
 
c5d309f2
     /**
f5bccd85
      * spatial complexity masking (0-> disabled)
      * - encoding: Set by user.
64863965
      * - decoding: unused
c5d309f2
      */
     float spatial_cplx_masking;
115329f1
 
c5d309f2
     /**
f5bccd85
      * p block masking (0-> disabled)
      * - encoding: Set by user.
64863965
      * - decoding: unused
c5d309f2
      */
     float p_masking;
15415af4
 
5e746b99
     /**
f5bccd85
      * darkness masking (0-> disabled)
      * - encoding: Set by user.
64863965
      * - decoding: unused
5e746b99
      */
     float dark_masking;
115329f1
 
0c2dd16e
     /**
f5bccd85
      * IDCT algorithm, see FF_IDCT_* below.
      * - encoding: Set by user.
      * - decoding: Set by user.
2ad1516a
      */
     int idct_algo;
273b0cd3
 #define FF_IDCT_AUTO          0
 #define FF_IDCT_INT           1
 #define FF_IDCT_SIMPLE        2
 #define FF_IDCT_SIMPLEMMX     3
 #define FF_IDCT_LIBMPEG2MMX   4
 #define FF_IDCT_PS2           5
 #define FF_IDCT_MLIB          6
 #define FF_IDCT_ARM           7
 #define FF_IDCT_ALTIVEC       8
 #define FF_IDCT_SH4           9
 #define FF_IDCT_SIMPLEARM     10
 #define FF_IDCT_H264          11
 #define FF_IDCT_VP3           12
 #define FF_IDCT_IPP           13
 #define FF_IDCT_XVIDMMX       14
 #define FF_IDCT_CAVS          15
a0403006
 #define FF_IDCT_SIMPLEARMV5TE 16
273b0cd3
 #define FF_IDCT_SIMPLEARMV6   17
d9420d4d
 #define FF_IDCT_SIMPLEVIS     18
9abc7e0f
 #define FF_IDCT_WMV2          19
6f08c541
 #define FF_IDCT_FAAN          20
42b30357
 #define FF_IDCT_EA            21
7eec4328
 #define FF_IDCT_SIMPLENEON    22
74c47463
 #define FF_IDCT_SIMPLEALPHA   23
2ad1516a
 
144f0625
     /**
f5bccd85
      * slice count
      * - encoding: Set by libavcodec.
      * - decoding: Set by user (or 0).
144f0625
      */
     int slice_count;
     /**
f5bccd85
      * slice offsets in the frame in bytes
      * - encoding: Set/allocated by libavcodec.
      * - decoding: Set/allocated by user (or NULL).
144f0625
      */
     int *slice_offset;
 
4d2858de
     /**
f5bccd85
      * error concealment flags
64863965
      * - encoding: unused
f5bccd85
      * - decoding: Set by user.
4d2858de
      */
     int error_concealment;
 #define FF_EC_GUESS_MVS   1
 #define FF_EC_DEBLOCK     2
 
6b72ac63
     /**
bec89a84
      * dsp_mask could be add used to disable unwanted CPU features
8350df97
      * CPU features (i.e. MMX, SSE. ...)
bec89a84
      *
f5bccd85
      * With the FORCE flag you may instead enable given CPU features.
      * (Dangerous: Usable in case of misdetection, improper usage however will
      * result into program crash.)
bec89a84
      */
     unsigned dsp_mask;
f5bccd85
 #define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
bec89a84
     /* lower 16 bits - CPU features */
0cd60abf
 #define FF_MM_MMX      0x0001 ///< standard MMX
 #define FF_MM_3DNOW    0x0004 ///< AMD 3DNOW
 #define FF_MM_MMXEXT   0x0002 ///< SSE integer functions or AMD MMX ext
 #define FF_MM_SSE      0x0008 ///< SSE functions
 #define FF_MM_SSE2     0x0010 ///< PIV SSE2 functions
 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
 #define FF_MM_SSE3     0x0040 ///< Prescott SSE3 functions
 #define FF_MM_SSSE3    0x0080 ///< Conroe SSSE3 functions
 #define FF_MM_IWMMXT   0x0100 ///< XScale IWMMXT
82d1605f
 #define FF_MM_ALTIVEC  0x0001 ///< standard AltiVec
11f18faf
 
     /**
64863965
      * bits per sample/pixel from the demuxer (needed for huffyuv).
f5bccd85
      * - encoding: Set by libavcodec.
      * - decoding: Set by user.
11f18faf
      */
46a73068
      int bits_per_coded_sample;
115329f1
 
11f18faf
     /**
f5bccd85
      * prediction method (needed for huffyuv)
      * - encoding: Set by user.
64863965
      * - decoding: unused
11f18faf
      */
      int prediction_method;
 #define FF_PRED_LEFT   0
 #define FF_PRED_PLANE  1
 #define FF_PRED_MEDIAN 2
115329f1
 
5d3cea3a
     /**
f5bccd85
      * sample aspect ratio (0 if unknown)
8e5af7a6
      * That is the width of a pixel divided by the height of the pixel.
f5bccd85
      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
      * - encoding: Set by user.
      * - decoding: Set by libavcodec.
5d3cea3a
      */
5ff85f1d
     AVRational sample_aspect_ratio;
1e491e29
 
     /**
f5bccd85
      * the picture in the bitstream
      * - encoding: Set by libavcodec.
      * - decoding: Set by libavcodec.
1e491e29
      */
492cd3a9
     AVFrame *coded_frame;
c8c437bc
 
     /**
f5bccd85
      * debug
      * - encoding: Set by user.
      * - decoding: Set by user.
c8c437bc
      */
     int debug;
273b0cd3
 #define FF_DEBUG_PICT_INFO   1
 #define FF_DEBUG_RC          2
 #define FF_DEBUG_BITSTREAM   4
 #define FF_DEBUG_MB_TYPE     8
 #define FF_DEBUG_QP          16
 #define FF_DEBUG_MV          32
 #define FF_DEBUG_DCT_COEFF   0x00000040
 #define FF_DEBUG_SKIP        0x00000080
 #define FF_DEBUG_STARTCODE   0x00000100
 #define FF_DEBUG_PTS         0x00000200
 #define FF_DEBUG_ER          0x00000400
 #define FF_DEBUG_MMCO        0x00000800
 #define FF_DEBUG_BUGS        0x00001000
 #define FF_DEBUG_VIS_QP      0x00002000
864119b6
 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
385c820b
 #define FF_DEBUG_BUFFERS     0x00008000
115329f1
 
140cb663
     /**
f5bccd85
      * debug
      * - encoding: Set by user.
      * - decoding: Set by user.
0c9bbaec
      */
     int debug_mv;
 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
 
     /**
f5bccd85
      * error
      * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
64863965
      * - decoding: unused
140cb663
      */
     uint64_t error[4];
115329f1
 
17a70fde
     /**
f5bccd85
      * minimum MB quantizer
6e0d8c06
      * - encoding: unused
64863965
      * - decoding: unused
17a70fde
      */
     int mb_qmin;
 
     /**
f5bccd85
      * maximum MB quantizer
6e0d8c06
      * - encoding: unused
64863965
      * - decoding: unused
17a70fde
      */
     int mb_qmax;
115329f1
 
1457ab52
     /**
f5bccd85
      * motion estimation comparison function
      * - encoding: Set by user.
64863965
      * - decoding: unused
1457ab52
      */
     int me_cmp;
     /**
f5bccd85
      * subpixel motion estimation comparison function
      * - encoding: Set by user.
64863965
      * - decoding: unused
1457ab52
      */
     int me_sub_cmp;
     /**
f5bccd85
      * macroblock comparison function (not supported yet)
      * - encoding: Set by user.
64863965
      * - decoding: unused
1457ab52
      */
     int mb_cmp;
622348f9
     /**
f5bccd85
      * interlaced DCT comparison function
      * - encoding: Set by user.
622348f9
      * - decoding: unused
      */
     int ildct_cmp;
273b0cd3
 #define FF_CMP_SAD    0
 #define FF_CMP_SSE    1
 #define FF_CMP_SATD   2
 #define FF_CMP_DCT    3
 #define FF_CMP_PSNR   4
 #define FF_CMP_BIT    5
 #define FF_CMP_RD     6
 #define FF_CMP_ZERO   7
 #define FF_CMP_VSAD   8
 #define FF_CMP_VSSE   9
 #define FF_CMP_NSSE   10
 #define FF_CMP_W53    11
 #define FF_CMP_W97    12
0fd6aea1
 #define FF_CMP_DCTMAX 13
27c61ac5
 #define FF_CMP_DCT264 14
1457ab52
 #define FF_CMP_CHROMA 256
115329f1
 
1457ab52
     /**
f5bccd85
      * ME diamond size & shape
      * - encoding: Set by user.
64863965
      * - decoding: unused
1457ab52
      */
     int dia_size;
b07a5980
 
     /**
f5bccd85
      * amount of previous MV predictors (2a+1 x 2a+1 square)
      * - encoding: Set by user.
64863965
      * - decoding: unused
b07a5980
      */
     int last_predictor_count;
70ac76c0
 
f5fb6b34
     /**
f5bccd85
      * prepass for motion estimation
      * - encoding: Set by user.
64863965
      * - decoding: unused
f5fb6b34
      */
     int pre_me;
b07a5980
 
70ac76c0
     /**
f5bccd85
      * motion estimation prepass comparison function
      * - encoding: Set by user.
64863965
      * - decoding: unused
70ac76c0
      */
     int me_pre_cmp;
826f429a
 
70ac76c0
     /**
f5bccd85
      * ME prepass diamond size & shape
      * - encoding: Set by user.
64863965
      * - decoding: unused
70ac76c0
      */
     int pre_dia_size;
 
826f429a
     /**
f5bccd85
      * subpel ME quality
      * - encoding: Set by user.
64863965
      * - decoding: unused
826f429a
      */
     int me_subpel_quality;
 
a33c7159
     /**
f5bccd85
      * callback to negotiate the pixelFormat
a33c7159
      * @param fmt is the list of formats which are supported by the codec,
f5bccd85
      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
      * The first is always the native one.
      * @return the chosen format
64863965
      * - encoding: unused
f5bccd85
      * - decoding: Set by user, if not set the native format will be chosen.
a33c7159
      */
494c56d3
     enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
e2f9490e
 
     /**
f5bccd85
      * DTG active format information (additional aspect ratio
      * information only used in DVB MPEG-2 transport streams)
      * 0 if not set.
115329f1
      *
f5bccd85
      * - encoding: unused
      * - decoding: Set by decoder.
e2f9490e
      */
     int dtg_active_format;
 #define FF_DTG_AFD_SAME         8
 #define FF_DTG_AFD_4_3          9
 #define FF_DTG_AFD_16_9         10
 #define FF_DTG_AFD_14_9         11
 #define FF_DTG_AFD_4_3_SP_14_9  13
 #define FF_DTG_AFD_16_9_SP_14_9 14
 #define FF_DTG_AFD_SP_4_3       15
 
ebbcdc9a
     /**
f5bccd85
      * maximum motion estimation search range in subpel units
      * If 0 then no limit.
115329f1
      *
f5bccd85
      * - encoding: Set by user.
      * - decoding: unused
ebbcdc9a
      */
59e0ac8e
     int me_range;
ebbcdc9a
 
65f7062d
     /**
f5bccd85
      * intra quantizer bias
      * - encoding: Set by user.
1984f635
      * - decoding: unused
      */
     int intra_quant_bias;
 #define FF_DEFAULT_QUANT_BIAS 999999
115329f1
 
1984f635
     /**
f5bccd85
      * inter quantizer bias
      * - encoding: Set by user.
1984f635
      * - decoding: unused
      */
     int inter_quant_bias;
5cd62665
 
     /**
f5bccd85
      * color table ID
      * - encoding: unused
      * - decoding: Which clrtable should be used for 8bit RGB images.
      *             Tables have to be stored somewhere. FIXME
5cd62665
      */
     int color_table_id;
115329f1
 
d90cf87b
     /**
f5bccd85
      * internal_buffer count
      * Don't touch, used by libavcodec default_get_buffer().
d90cf87b
      */
     int internal_buffer_count;
115329f1
 
d90cf87b
     /**
f5bccd85
      * internal_buffers
      * Don't touch, used by libavcodec default_get_buffer().
d90cf87b
      */
     void *internal_buffer;
158c7f05
 
 #define FF_LAMBDA_SHIFT 7
 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
 #define FF_LAMBDA_MAX (256*128-1)
 
 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
3d2e8cce
     /**
f5bccd85
      * Global quality for codecs which cannot change it per frame.
      * This should be proportional to MPEG-1/2/4 qscale.
      * - encoding: Set by user.
3d2e8cce
      * - decoding: unused
      */
     int global_quality;
115329f1
 
bd446bb1
 #define FF_CODER_TYPE_VLC       0
 #define FF_CODER_TYPE_AC        1
f87459e4
 #define FF_CODER_TYPE_RAW       2
 #define FF_CODER_TYPE_RLE       3
 #define FF_CODER_TYPE_DEFLATE   4
11e659c2
     /**
      * coder type
f5bccd85
      * - encoding: Set by user.
11e659c2
      * - decoding: unused
      */
     int coder_type;
 
     /**
      * context model
f5bccd85
      * - encoding: Set by user.
11e659c2
      * - decoding: unused
      */
     int context_model;
5639729b
 #if 0
     /**
      *
      * - encoding: unused
f5bccd85
      * - decoding: Set by user.
5639729b
      */
     uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
 #endif
115329f1
 
3bb07d61
     /**
      * slice flags
      * - encoding: unused
f5bccd85
      * - decoding: Set by user.
3bb07d61
      */
     int slice_flags;
 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
 
fb364ada
     /**
      * XVideo Motion Acceleration
      * - encoding: forbidden
      * - decoding: set by decoder
      */
     int xvmc_acceleration;
115329f1
 
7d1c3fc1
     /**
      * macroblock decision mode
f5bccd85
      * - encoding: Set by user.
7d1c3fc1
      * - decoding: unused
      */
     int mb_decision;
 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
e6dba5df
 #define FF_MB_DECISION_RD     2        ///< rate distortion
d6eb3c50
 
     /**
      * custom intra quantization matrix
f5bccd85
      * - encoding: Set by user, can be NULL.
      * - decoding: Set by libavcodec.
d6eb3c50
      */
     uint16_t *intra_matrix;
 
     /**
      * custom inter quantization matrix
f5bccd85
      * - encoding: Set by user, can be NULL.
      * - decoding: Set by libavcodec.
d6eb3c50
      */
     uint16_t *inter_matrix;
115329f1
 
541ae140
     /**
      * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
f5bccd85
      * This is used to work around some encoder bugs.
541ae140
      * - encoding: unused
f5bccd85
      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
541ae140
      */
     unsigned int stream_codec_tag;
05fbd0a2
 
     /**
f5bccd85
      * scene change detection threshold
      * 0 is default, larger means fewer detected scene changes.
      * - encoding: Set by user.
05fbd0a2
      * - decoding: unused
      */
     int scenechange_threshold;
158c7f05
 
     /**
f5bccd85
      * minimum Lagrange multipler
      * - encoding: Set by user.
158c7f05
      * - decoding: unused
      */
     int lmin;
 
     /**
f5bccd85
      * maximum Lagrange multipler
      * - encoding: Set by user.
158c7f05
      * - decoding: unused
      */
     int lmax;
2a2bbcb0
 
     /**
f5bccd85
      * palette control structure
2a2bbcb0
      * - encoding: ??? (no palette-enabled encoder yet)
f5bccd85
      * - decoding: Set by user.
2a2bbcb0
      */
     struct AVPaletteControl *palctrl;
821cb11f
 
     /**
      * noise reduction strength
f5bccd85
      * - encoding: Set by user.
821cb11f
      * - decoding: unused
      */
     int noise_reduction;
115329f1
 
074c4ca7
     /**
f5bccd85
      * Called at the beginning of a frame to get cr buffer for it.
      * Buffer type (size, hints) must be the same. libavcodec won't check it.
      * libavcodec will pass previous buffer in pic, function should return
e1c2a5a0
      * same buffer or new buffer with old frame "painted" into it.
f5bccd85
      * If pic.data[0] == NULL must behave like get_buffer().
074c4ca7
      * - encoding: unused
f5bccd85
      * - decoding: Set by libavcodec., user can override
074c4ca7
      */
e1c2a5a0
     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
ba58dabc
 
     /**
f5bccd85
      * Number of bits which should be loaded into the rc buffer before decoding starts.
      * - encoding: Set by user.
ba58dabc
      * - decoding: unused
      */
     int rc_initial_buffer_occupancy;
 
     /**
      *
f5bccd85
      * - encoding: Set by user.
ba58dabc
      * - decoding: unused
      */
     int inter_threshold;
 
     /**
f5bccd85
      * CODEC_FLAG2_*
      * - encoding: Set by user.
      * - decoding: Set by user.
ba58dabc
      */
     int flags2;
7ebfc0ea
 
     /**
f5bccd85
      * Simulates errors in the bitstream to test error concealment.
      * - encoding: Set by user.
      * - decoding: unused
7ebfc0ea
      */
     int error_rate;
115329f1
 
a1e257b2
     /**
      * MP3 antialias algorithm, see FF_AA_* below.
      * - encoding: unused
f5bccd85
      * - decoding: Set by user.
a1e257b2
      */
     int antialias_algo;
 #define FF_AA_AUTO    0
 #define FF_AA_FASTINT 1 //not implemented yet
 #define FF_AA_INT     2
 #define FF_AA_FLOAT   3
77ea0d4b
     /**
f5bccd85
      * quantizer noise shaping
      * - encoding: Set by user.
77ea0d4b
      * - decoding: unused
      */
     int quantizer_noise_shaping;
9c3d33d6
 
     /**
f5bccd85
      * thread count
eafcac6a
      * is used to decide how many independent tasks should be passed to execute()
f5bccd85
      * - encoding: Set by user.
      * - decoding: Set by user.
9c3d33d6
      */
     int thread_count;
115329f1
 
9c3d33d6
     /**
f5bccd85
      * The codec may call this to execute several independent things.
      * It will return only after finishing all tasks.
      * The user may replace this with some multithreaded implementation,
      * the default implementation will execute the parts serially.
399cec2f
      * @param count the number of things to execute
f5bccd85
      * - encoding: Set by libavcodec, user can override.
      * - decoding: Set by libavcodec, user can override.
9c3d33d6
      */
3a84713a
     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
115329f1
 
9c3d33d6
     /**
f5bccd85
      * thread opaque
      * Can be used by execute() to store some per AVCodecContext stuff.
9c3d33d6
      * - encoding: set by execute()
      * - decoding: set by execute()
      */
     void *thread_opaque;
a4d36c11
 
     /**
f5bccd85
      * Motion estimation threshold below which no motion estimation is
      * performed, but instead the user specified motion vectors are used.
115329f1
      *
f5bccd85
      * - encoding: Set by user.
f20f8a8b
      * - decoding: unused
a4d36c11
      */
2750b827
      int me_threshold;
f20f8a8b
 
     /**
f5bccd85
      * Macroblock threshold below which the user specified macroblock types will be used.
      * - encoding: Set by user.
f20f8a8b
      * - decoding: unused
      */
      int mb_threshold;
bf266e19
 
     /**
f5bccd85
      * precision of the intra DC coefficient - 8
      * - encoding: Set by user.
bf266e19
      * - decoding: unused
      */
      int intra_dc_precision;
d4c5d2ad
 
     /**
f5bccd85
      * noise vs. sse weight for the nsse comparsion function
      * - encoding: Set by user.
d4c5d2ad
      * - decoding: unused
      */
      int nsse_weight;
0dfd33c3
 
     /**
f5bccd85
      * Number of macroblock rows at the top which are skipped.
0dfd33c3
      * - encoding: unused
f5bccd85
      * - decoding: Set by user.
0dfd33c3
      */
      int skip_top;
 
     /**
f5bccd85
      * Number of macroblock rows at the bottom which are skipped.
0dfd33c3
      * - encoding: unused
f5bccd85
      * - decoding: Set by user.
0dfd33c3
      */
      int skip_bottom;
baced9f5
 
     /**
      * profile
f5bccd85
      * - encoding: Set by user.
      * - decoding: Set by libavcodec.
baced9f5
      */
      int profile;
 #define FF_PROFILE_UNKNOWN -99
4f2c36ac
 #define FF_PROFILE_AAC_MAIN 0
273b0cd3
 #define FF_PROFILE_AAC_LOW  1
 #define FF_PROFILE_AAC_SSR  2
 #define FF_PROFILE_AAC_LTP  3
baced9f5
 
     /**
      * level
f5bccd85
      * - encoding: Set by user.
      * - decoding: Set by libavcodec.
baced9f5
      */
      int level;
 #define FF_LEVEL_UNKNOWN -99
178fcca8
 
     /**
f5bccd85
      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
178fcca8
      * - encoding: unused
f5bccd85
      * - decoding: Set by user.
178fcca8
      */
      int lowres;
21adafec
 
     /**
f5bccd85
      * Bitstream width / height, may be different from width/height if lowres
      * or other things are used.
21adafec
      * - encoding: unused
f5bccd85
      * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
21adafec
      */
     int coded_width, coded_height;
bbf18b21
 
     /**
      * frame skip threshold
f5bccd85
      * - encoding: Set by user.
bbf18b21
      * - decoding: unused
      */
     int frame_skip_threshold;
 
     /**
      * frame skip factor
f5bccd85
      * - encoding: Set by user.
bbf18b21
      * - decoding: unused
      */
     int frame_skip_factor;
0fd6aea1
 
     /**
      * frame skip exponent
f5bccd85
      * - encoding: Set by user.
0fd6aea1
      * - decoding: unused
      */
     int frame_skip_exp;
 
     /**
f5bccd85
      * frame skip comparison function
      * - encoding: Set by user.
0fd6aea1
      * - decoding: unused
      */
     int frame_skip_cmp;
957c743a
 
     /**
f5bccd85
      * Border processing masking, raises the quantizer for mbs on the borders
957c743a
      * of the picture.
f5bccd85
      * - encoding: Set by user.
957c743a
      * - decoding: unused
      */
     float border_masking;
6e0d8c06
 
     /**
f5bccd85
      * minimum MB lagrange multipler
      * - encoding: Set by user.
6e0d8c06
      * - decoding: unused
      */
     int mb_lmin;
 
     /**
f5bccd85
      * maximum MB lagrange multipler
      * - encoding: Set by user.
6e0d8c06
      * - decoding: unused
      */
     int mb_lmax;
09c3e44e
 
     /**
115329f1
      *
f5bccd85
      * - encoding: Set by user.
09c3e44e
      * - decoding: unused
      */
     int me_penalty_compensation;
8c3eba7c
 
     /**
115329f1
      *
8c3eba7c
      * - encoding: unused
f5bccd85
      * - decoding: Set by user.
8c3eba7c
      */
     enum AVDiscard skip_loop_filter;
 
     /**
115329f1
      *
8c3eba7c
      * - encoding: unused
f5bccd85
      * - decoding: Set by user.
8c3eba7c
      */
     enum AVDiscard skip_idct;
 
     /**
115329f1
      *
8c3eba7c
      * - encoding: unused
f5bccd85
      * - decoding: Set by user.
8c3eba7c
      */
     enum AVDiscard skip_frame;
316a2ec8
 
     /**
      *
f5bccd85
      * - encoding: Set by user.
316a2ec8
      * - decoding: unused
      */
     int bidir_refine;
e8501c93
 
     /**
      *
f5bccd85
      * - encoding: Set by user.
e8501c93
      * - decoding: unused
      */
     int brd_scale;
58f7833e
 
     /**
      * constant rate factor - quality-based VBR - values ~correspond to qps
f5bccd85
      * - encoding: Set by user.
58f7833e
      * - decoding: unused
      */
9f1c1c99
     float crf;
58f7833e
 
     /**
      * constant quantization parameter rate control method
f5bccd85
      * - encoding: Set by user.
58f7833e
      * - decoding: unused
      */
     int cqp;
 
     /**
f5bccd85
      * minimum GOP size
      * - encoding: Set by user.
58f7833e
      * - decoding: unused
      */
     int keyint_min;
 
     /**
      * number of reference frames
f5bccd85
      * - encoding: Set by user.
53d55e9e
      * - decoding: Set by lavc.
58f7833e
      */
     int refs;
 
     /**
      * chroma qp offset from luma
f5bccd85
      * - encoding: Set by user.
58f7833e
      * - decoding: unused
      */
     int chromaoffset;
 
     /**
f5bccd85
      * Influences how often B-frames are used.
      * - encoding: Set by user.
58f7833e
      * - decoding: unused
      */
     int bframebias;
 
     /**
      * trellis RD quantization
f5bccd85
      * - encoding: Set by user.
58f7833e
      * - decoding: unused
      */
     int trellis;
 
     /**
f5bccd85
      * Reduce fluctuations in qp (before curve compression).
      * - encoding: Set by user.
58f7833e
      * - decoding: unused
      */
     float complexityblur;
 
     /**
      * in-loop deblocking filter alphac0 parameter
      * alpha is in the range -6...6
f5bccd85
      * - encoding: Set by user.
58f7833e
      * - decoding: unused
      */
     int deblockalpha;
 
     /**
      * in-loop deblocking filter beta parameter
      * beta is in the range -6...6
f5bccd85
      * - encoding: Set by user.
58f7833e
      * - decoding: unused
      */
     int deblockbeta;
 
     /**
      * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
f5bccd85
      * - encoding: Set by user.
58f7833e
      * - decoding: unused
      */
     int partitions;
56cc85a0
 #define X264_PART_I4X4 0x001  /* Analyze i4x4 */
 #define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
 #define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
 #define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
 #define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
58f7833e
 
     /**
30ab4ded
      * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
f5bccd85
      * - encoding: Set by user.
58f7833e
      * - decoding: unused
      */
     int directpred;
4f59b684
 
14f0c8e2
     /**
02c164c1
      * Audio cutoff bandwidth (0 means "automatic")
f5bccd85
      * - encoding: Set by user.
14f0c8e2
      * - decoding: unused
      */
     int cutoff;
39a64e30
 
     /**
f5bccd85
      * Multiplied by qscale for each frame and added to scene_change_score.
      * - encoding: Set by user.
39a64e30
      * - decoding: unused
      */
     int scenechange_factor;
1dd509b1
 
     /**
      *
f5bccd85
      * Note: Value depends upon the compare function used for fullpel ME.
      * - encoding: Set by user.
1dd509b1
      * - decoding: unused
      */
     int mv0_threshold;
f9243d34
 
     /**
f5bccd85
      * Adjusts sensitivity of b_frame_strategy 1.
      * - encoding: Set by user.
f9243d34
      * - decoding: unused
      */
     int b_sensitivity;
a403fc03
 
     /**
f5bccd85
      * - encoding: Set by user.
a403fc03
      * - decoding: unused
      */
     int compression_level;
 #define FF_COMPRESSION_DEFAULT -1
 
     /**
f5bccd85
      * Sets whether to use LPC mode - used by FLAC encoder.
      * - encoding: Set by user.
      * - decoding: unused
a403fc03
      */
     int use_lpc;
 
     /**
      * LPC coefficient precision - used by FLAC encoder
f5bccd85
      * - encoding: Set by user.
      * - decoding: unused
a403fc03
      */
     int lpc_coeff_precision;
 
     /**
f5bccd85
      * - encoding: Set by user.
      * - decoding: unused
a403fc03
      */
     int min_prediction_order;
 
     /**
f5bccd85
      * - encoding: Set by user.
      * - decoding: unused
a403fc03
      */
     int max_prediction_order;
 
     /**
      * search method for selecting prediction order
f5bccd85
      * - encoding: Set by user.
      * - decoding: unused
a403fc03
      */
     int prediction_order_method;
 
     /**
f5bccd85
      * - encoding: Set by user.
      * - decoding: unused
a403fc03
      */
     int min_partition_order;
 
     /**
f5bccd85
      * - encoding: Set by user.
      * - decoding: unused
a403fc03
      */
     int max_partition_order;
80d617f5
 
     /**
      * GOP timecode frame start number, in non drop frame format
f5bccd85
      * - encoding: Set by user.
      * - decoding: unused
80d617f5
      */
     int64_t timecode_frame_start;
b1ec601f
 
0d72e7d0
 #if LIBAVCODEC_VERSION_MAJOR < 53
b1ec601f
     /**
      * Decoder should decode to this many channels if it can (0 for default)
      * - encoding: unused
      * - decoding: Set by user.
0d72e7d0
      * @deprecated Deprecated in favor of request_channel_layout.
b1ec601f
      */
     int request_channels;
0d72e7d0
 #endif
1408352a
 
     /**
      * Percentage of dynamic range compression to be applied by the decoder.
      * The default value is 1.0, corresponding to full compression.
      * - encoding: unused
      * - decoding: Set by user.
      */
     float drc_scale;
79de84f2
 
     /**
      * opaque 64bit number (generally a PTS) that will be reordered and
      * output in AVFrame.reordered_opaque
      * - encoding: unused
      * - decoding: Set by user.
      */
     int64_t reordered_opaque;
312420f3
 
     /**
      * Bits per sample/pixel of internal libavcodec pixel/sample format.
      * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
      * - encoding: set by user.
      * - decoding: set by libavcodec.
      */
     int bits_per_raw_sample;
0d72e7d0
 
     /**
      * Audio channel layout.
      * - encoding: set by user.
      * - decoding: set by libavcodec.
      */
     int64_t channel_layout;
 
     /**
      * Request decoder to use this channel layout if it can (0 for default)
      * - encoding: unused
      * - decoding: Set by user.
      */
     int64_t request_channel_layout;
3bff4d8b
 
     /**
      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
      * - encoding: Set by user.
      * - decoding: unused.
      */
     float rc_max_available_vbv_use;
 
     /**
      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
      * - encoding: Set by user.
      * - decoding: unused.
      */
     float rc_min_vbv_overflow_use;
40e5d31b
 
     /**
      * Hardware accelerator in use
      * - encoding: unused.
      * - decoding: Set by libavcodec
      */
     struct AVHWAccel *hwaccel;
3797c74b
 
     /**
      * For some codecs, the time base is closer to the field rate than the frame rate.
      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
      * if no telecine is used ...
      *
      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
      */
     int ticks_per_frame;
53b90bb2
 
     /**
      * explicit P-frame weighted prediction analysis method
      * 0: off
      * 1: fast blind weighting (one reference duplicate with -1 offset)
      * 2: smart weighting (full fade detection analysis)
      * - encoding: Set by user.
      * - decoding: unused
      */
     int weighted_p_pred;
de6d9b64
 } AVCodecContext;
 
64863965
 /**
  * AVCodec.
  */
de6d9b64
 typedef struct AVCodec {
6b0cdb6e
     /**
      * Name of the codec implementation.
      * The name is globally unique among encoders and among decoders (but an
      * encoder and a decoder can share the same name).
      * This is the primary way to find a codec from the user perspective.
      */
18f77016
     const char *name;
5d234974
     enum CodecType type;
9297ddd3
     enum CodecID id;
de6d9b64
     int priv_data_size;
     int (*init)(AVCodecContext *);
0c1a9eda
     int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
de6d9b64
     int (*close)(AVCodecContext *);
0fd90455
     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
6ddaa63c
                   const uint8_t *buf, int buf_size);
a2d11246
     /**
      * Codec capabilities.
      * see CODEC_CAP_*
      */
bf89e6b1
     int capabilities;
de6d9b64
     struct AVCodec *next;
c8cf325a
     /**
      * Flush buffers.
      * Will be called when seeking
      */
7a06ff14
     void (*flush)(AVCodecContext *);
716e31ea
     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
1beb670a
     const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
fe4bf374
     /**
      * Descriptive name for the codec, meant to be more human readable than \p name.
      * You \e should use the NULL_IF_CONFIG_SMALL() macro to define it.
      */
     const char *long_name;
3ade5d56
     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
88a07af7
     const enum SampleFormat *sample_fmts;   ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
0d72e7d0
     const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
de6d9b64
 } AVCodec;
 
97d96aaa
 /**
40e5d31b
  * AVHWAccel.
  */
 typedef struct AVHWAccel {
     /**
      * Name of the hardware accelerated codec.
      * The name is globally unique among encoders and among decoders (but an
      * encoder and a decoder can share the same name).
      */
     const char *name;
 
     /**
      * Type of codec implemented by the hardware accelerator.
      *
      * See CODEC_TYPE_xxx
      */
     enum CodecType type;
 
     /**
      * Codec implemented by the hardware accelerator.
      *
      * See CODEC_ID_xxx
      */
     enum CodecID id;
 
     /**
      * Supported pixel format.
      *
      * Only hardware accelerated formats are supported here.
      */
     enum PixelFormat pix_fmt;
 
     /**
      * Hardware accelerated codec capabilities.
      * see FF_HWACCEL_CODEC_CAP_*
      */
     int capabilities;
 
     struct AVHWAccel *next;
 
     /**
      * Called at the beginning of each frame or field picture.
      *
      * Meaningful frame information (codec specific) is guaranteed to
      * be parsed at this point. This function is mandatory.
      *
      * Note that \p buf can be NULL along with \p buf_size set to 0.
      * Otherwise, this means the whole frame is available at this point.
      *
      * @param avctx the codec context
      * @param buf the frame data buffer base
      * @param buf_size the size of the frame in bytes
      * @return zero if successful, a negative value otherwise
      */
     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
 
     /**
      * Callback for each slice.
      *
      * Meaningful slice information (codec specific) is guaranteed to
      * be parsed at this point. This function is mandatory.
      *
      * @param avctx the codec context
      * @param buf the slice data buffer base
      * @param buf_size the size of the slice in bytes
      * @return zero if successful, a negative value otherwise
      */
     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
 
     /**
      * Called at the end of each frame or field picture.
      *
      * The whole picture is parsed at this point and can now be sent
      * to the hardware accelerator. This function is mandatory.
      *
      * @param avctx the codec context
      * @return zero if successful, a negative value otherwise
      */
     int (*end_frame)(AVCodecContext *avctx);
 } AVHWAccel;
 
 /**
d7425f59
  * four components are given, that's all.
  * the last component is alpha
  */
de6d9b64
 typedef struct AVPicture {
0c1a9eda
     uint8_t *data[4];
cd394651
     int linesize[4];       ///< number of bytes per line
de6d9b64
 } AVPicture;
 
ba118447
 /**
  * AVPaletteControl
  * This structure defines a method for communicating palette changes
  * between and demuxer and a decoder.
671adb17
  *
  * @deprecated Use AVPacket to send palette changes instead.
  * This is totally broken.
ba118447
  */
2e99641b
 #define AVPALETTE_SIZE 1024
432d84c3
 #define AVPALETTE_COUNT 256
ba118447
 typedef struct AVPaletteControl {
 
f5bccd85
     /* Demuxer sets this to 1 to indicate the palette has changed;
      * decoder resets to 0. */
ba118447
     int palette_changed;
 
2a2bbcb0
     /* 4-byte ARGB palette entries, stored in native byte order; note that
      * the individual palette components should be on a 8-bit scale; if
f5bccd85
      * the palette data comes from an IBM VGA native format, the component
      * data is probably 6 bits in size and needs to be scaled. */
2e99641b
     unsigned int palette[AVPALETTE_COUNT];
ba118447
 
18239edf
 } AVPaletteControl attribute_deprecated;
ba118447
 
c66216ed
 enum AVSubtitleType {
     SUBTITLE_NONE,
 
     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
 
     /**
      * Plain text, the text field must be set by the decoder and is
      * authoritative. ass and pict fields may contain approximations.
      */
     SUBTITLE_TEXT,
 
     /**
      * Formatted text, the ass field must be set by the decoder and is
      * authoritative. pict and text fields may contain approximations.
      */
     SUBTITLE_ASS,
 };
 
c6ec28b1
 typedef struct AVSubtitleRect {
ebc466bb
     int x;         ///< top left corner  of pict, undefined when pict is not set
     int y;         ///< top left corner  of pict, undefined when pict is not set
     int w;         ///< width            of pict, undefined when pict is not set
     int h;         ///< height           of pict, undefined when pict is not set
     int nb_colors; ///< number of colors in pict, undefined when pict is not set
25b4c651
 
     /**
      * data+linesize for the bitmap of this subtitle.
      * can be set for text/ass as well once they where rendered
      */
     AVPicture pict;
f656106f
     enum AVSubtitleType type;
 
     char *text;                     ///< 0 terminated plain UTF-8 text
 
     /**
      * 0 terminated ASS/SSA compatible event line.
      * The pressentation of this is unaffected by the other values in this
      * struct.
      */
     char *ass;
c6ec28b1
 } AVSubtitleRect;
 
 typedef struct AVSubtitle {
     uint16_t format; /* 0 = graphics */
     uint32_t start_display_time; /* relative to packet pts, in ms */
     uint32_t end_display_time; /* relative to packet pts, in ms */
ebc466bb
     unsigned num_rects;
db4fac64
     AVSubtitleRect **rects;
240c1657
 } AVSubtitle;
 
 
de6d9b64
 /* resample.c */
 
 struct ReSampleContext;
aaaf1635
 struct AVResampleContext;
de6d9b64
 
 typedef struct ReSampleContext ReSampleContext;
 
d1e3c6fd
 #if LIBAVCODEC_VERSION_MAJOR < 53
 /**
  * @deprecated Use av_audio_resample_init() instead.
  */
 attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
                                                           int output_rate, int input_rate);
 #endif
 /**
  *  Initializes audio resampling context
  *
  * @param output_channels  number of output channels
  * @param input_channels   number of input channels
  * @param output_rate      output sample rate
  * @param input_rate       input sample rate
  * @param sample_fmt_out   requested output sample format
  * @param sample_fmt_in    input sample format
  * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff freq
  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
  * @param linear           If 1 then the used FIR filter will be linearly interpolated
                            between the 2 closest, if 0 the closest will be used
  * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
  * @return allocated ReSampleContext, NULL if error occured
  */
 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
                                         int output_rate, int input_rate,
                                         enum SampleFormat sample_fmt_out,
                                         enum SampleFormat sample_fmt_in,
                                         int filter_length, int log2_phase_count,
                                         int linear, double cutoff);
 
de6d9b64
 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
 void audio_resample_close(ReSampleContext *s);
 
3136fcf4
 
 /**
  * Initializes an audio resampler.
  * Note, if either rate is not an integer then simply scale both rates up so they are.
990058bd
  * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
  * @param linear If 1 then the used FIR filter will be linearly interpolated
                  between the 2 closest, if 0 the closest will be used
  * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3136fcf4
  */
6e225de2
 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3136fcf4
 
 /**
  * resamples.
  * @param src an array of unconsumed samples
  * @param consumed the number of samples of src which have been consumed are returned here
  * @param src_size the number of unconsumed samples available
  * @param dst_size the amount of space in samples available in dst
  * @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.
  * @return the number of samples written in dst or -1 if an error occurred
  */
aaaf1635
 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3136fcf4
 
 
 /**
  * Compensates samplerate/timestamp drift. The compensation is done by changing
  * the resampler parameters, so no audible clicks or similar distortions occur
  * @param compensation_distance distance in output samples over which the compensation should be performed
  * @param sample_delta number of output samples which should be output less
  *
  * example: av_resample_compensate(c, 10, 500)
  * here instead of 510 samples only 500 samples would be output
  *
  * note, due to rounding the actual compensation might be slightly different,
  * especially if the compensation_distance is large and the in_rate used during init is small
  */
2d48eddd
 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
d88443ae
 void av_resample_close(struct AVResampleContext *c);
aaaf1635
 
75917b88
 /**
  * Allocate memory for a picture.  Call avpicture_free to free it.
  *
f5bccd85
  * @param picture the picture to be filled in
  * @param pix_fmt the format of the picture
  * @param width the width of the picture
  * @param height the height of the picture
  * @return zero if successful, a negative value if not
75917b88
  */
 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
 
8fc3d25c
 /**
  * Free a picture previously allocated by avpicture_alloc().
  *
f5bccd85
  * @param picture the AVPicture to be freed
8fc3d25c
  */
75917b88
 void avpicture_free(AVPicture *picture);
 
392cf77a
 /**
f5bccd85
  * Fill in the AVPicture fields.
392cf77a
  * The fields of the given AVPicture are filled in by using the 'ptr' address
  * which points to the image data buffer. Depending on the specified picture
  * format, one or multiple image data pointers and line sizes will be set.
  * If a planar format is specified, several pointers will be set pointing to
  * the different picture planes and the line sizes of the different planes
  * will be stored in the lines_sizes array.
  *
f5bccd85
  * @param picture AVPicture whose fields are to be filled in
392cf77a
  * @param ptr Buffer which will contain or contains the actual image data
f5bccd85
  * @param pix_fmt The format in which the picture data is stored.
  * @param width the width of the image in pixels
  * @param height the height of the image in pixels
  * @return size of the image data in bytes
392cf77a
  */
0c1a9eda
 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2d1a4094
                    int pix_fmt, int width, int height);
da64ecc3
 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
63167088
                      unsigned char *dest, int dest_size);
392cf77a
 
 /**
  * Calculate the size in bytes that a picture of the given width and height
  * would occupy if stored in the given picture format.
  *
f5bccd85
  * @param pix_fmt the given picture format
  * @param width the width of the image
  * @param height the height of the image
392cf77a
  * @return Image data size in bytes
  */
219b06c6
 int avpicture_get_size(int pix_fmt, int width, int height);
dab64ebc
 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
 const char *avcodec_get_pix_fmt_name(int pix_fmt);
21adafec
 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
63167088
 enum PixelFormat avcodec_get_pix_fmt(const char* name);
d07730dd
 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
219b06c6
 
81299d42
 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
fab21997
 
392cf77a
 /**
81299d42
  * Computes what kind of losses will occur when converting from one specific
  * pixel format to another.
  * When converting from one pixel format to another, information loss may occur.
  * For example, when converting from RGB24 to GRAY, the color information will
  * be lost. Similarly, other losses occur when converting from some formats to
  * other formats. These losses can involve loss of chroma, but also loss of
  * resolution, loss of color depth, loss due to the color space conversion, loss
  * of the alpha bits or loss due to color quantization.
f5bccd85
  * avcodec_get_fix_fmt_loss() informs you about the various types of losses
  * which will occur when converting from one pixel format to another.
81299d42
  *
f5bccd85
  * @param[in] dst_pix_fmt destination pixel format
  * @param[in] src_pix_fmt source pixel format
81299d42
  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
  * @return Combination of flags informing you what kind of losses will occur.
392cf77a
  */
fab21997
 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
                              int has_alpha);
392cf77a
 
 /**
81299d42
  * Finds the best pixel format to convert to given a certain source pixel
  * format.  When converting from one pixel format to another, information loss
  * may occur.  For example, when converting from RGB24 to GRAY, the color
  * information will be lost. Similarly, other losses occur when converting from
  * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
f5bccd85
  * the given pixel formats should be used to suffer the least amount of loss.
  * The pixel formats from which it chooses one, are determined by the
81299d42
  * \p pix_fmt_mask parameter.
  *
  * @code
  * src_pix_fmt = PIX_FMT_YUV420P;
  * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
  * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
  * @endcode
  *
f5bccd85
  * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
  * @param[in] src_pix_fmt source pixel format
81299d42
  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
  * @return The best pixel format to convert to or -1 if none was found.
392cf77a
  */
9d214947
 int avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, int src_pix_fmt,
fab21997
                               int has_alpha, int *loss_ptr);
 
c3b95b1d
 
 /**
  * Print in buf the string corresponding to the pixel format with
  * number pix_fmt, or an header if pix_fmt is negative.
  *
9bd51b9a
  * @param[in] buf the buffer where to write the string
  * @param[in] buf_size the size of buf
  * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
c3b95b1d
  * a negative value to print the corresponding header.
  * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
  */
 void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
 
0469baf1
 #define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
 #define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
392cf77a
 
 /**
  * Tell if an image really has transparent alpha values.
  * @return ored mask of FF_ALPHA_xxx constants
  */
da64ecc3
 int img_get_alpha_info(const AVPicture *src,
bb270c08
                        int pix_fmt, int width, int height);
0469baf1
 
219b06c6
 /* deinterlace a picture */
392cf77a
 /* deinterlace - if not supported return -1 */
da64ecc3
 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
de6d9b64
                           int pix_fmt, int width, int height);
 
 /* external high level API */
 
0334f799
 /**
  * If c is NULL, returns the first registered codec,
c1b02101
  * if c is non-NULL, returns the next registered codec after c,
0334f799
  * or NULL if c is the last one.
  */
55b9e69a
 AVCodec *av_codec_next(AVCodec *c);
de6d9b64
 
96afa6be
 /**
  * Returns the LIBAVCODEC_VERSION_INT constant.
  */
51a49663
 unsigned avcodec_version(void);
96afa6be
 
f9ec0aa1
 /**
  * Initializes libavcodec.
  *
  * @warning This function \e must be called before any other libavcodec
  * function.
  */
de6d9b64
 void avcodec_init(void);
 
9d385cfe
 #if LIBAVCODEC_VERSION_MAJOR < 53
d1ca187f
 /**
85662f49
  * @deprecated Deprecated in favor of avcodec_register().
  */
 attribute_deprecated void register_avcodec(AVCodec *codec);
9d385cfe
 #endif
85662f49
 
 /**
d1ca187f
  * Register the codec \p codec and initialize libavcodec.
  *
  * @see avcodec_init()
  */
85662f49
 void avcodec_register(AVCodec *codec);
f9ec0aa1
 
 /**
645f7879
  * Finds a registered encoder with a matching codec ID.
f9ec0aa1
  *
f5bccd85
  * @param id CodecID of the requested encoder
f9ec0aa1
  * @return An encoder if one was found, NULL otherwise.
  */
de6d9b64
 AVCodec *avcodec_find_encoder(enum CodecID id);
f9ec0aa1
 
 /**
645f7879
  * Finds a registered encoder with the specified name.
f9ec0aa1
  *
f5bccd85
  * @param name name of the requested encoder
f9ec0aa1
  * @return An encoder if one was found, NULL otherwise.
  */
98f3b098
 AVCodec *avcodec_find_encoder_by_name(const char *name);
f9ec0aa1
 
 /**
645f7879
  * Finds a registered decoder with a matching codec ID.
f9ec0aa1
  *
f5bccd85
  * @param id CodecID of the requested decoder
f9ec0aa1
  * @return A decoder if one was found, NULL otherwise.
  */
de6d9b64
 AVCodec *avcodec_find_decoder(enum CodecID id);
f9ec0aa1
 
 /**
645f7879
  * Finds a registered decoder with the specified name.
f9ec0aa1
  *
f5bccd85
  * @param name name of the requested decoder
f9ec0aa1
  * @return A decoder if one was found, NULL otherwise.
  */
de6d9b64
 AVCodec *avcodec_find_decoder_by_name(const char *name);
 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
 
f9ec0aa1
 /**
  * Sets the fields of the given AVCodecContext to default values.
  *
  * @param s The AVCodecContext of which the fields should be set to default values.
  */
1e491e29
 void avcodec_get_context_defaults(AVCodecContext *s);
f9ec0aa1
 
29301573
 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
  *  we WILL change its arguments and name a few times! */
 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
 
f9ec0aa1
 /**
  * Allocates an AVCodecContext and sets its fields to default values.  The
  * resulting struct can be deallocated by simply calling av_free().
  *
  * @return An AVCodecContext filled with default values or NULL on failure.
  * @see avcodec_get_context_defaults
  */
7ffbb60e
 AVCodecContext *avcodec_alloc_context(void);
f9ec0aa1
 
29301573
 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
  *  we WILL change its arguments and name a few times! */
 AVCodecContext *avcodec_alloc_context2(enum CodecType);
 
f9ec0aa1
 /**
  * Sets the fields of the given AVFrame to default values.
  *
  * @param pic The AVFrame of which the fields should be set to default values.
  */
7906085f
 void avcodec_get_frame_defaults(AVFrame *pic);
f9ec0aa1
 
 /**
  * Allocates an AVFrame and sets its fields to default values.  The resulting
  * struct can be deallocated by simply calling av_free().
  *
  * @return An AVFrame filled with default values or NULL on failure.
  * @see avcodec_get_frame_defaults
  */
492cd3a9
 AVFrame *avcodec_alloc_frame(void);
1e491e29
 
492cd3a9
 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3a569751
 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
f9ec0aa1
 
 /**
  * Checks if the given dimension of a picture is valid, meaning that all
  * bytes of the picture can be addressed with a signed int.
  *
  * @param[in] w Width of the picture.
  * @param[in] h Height of the picture.
  * @return Zero if valid, a negative value if invalid.
  */
0ecca7a4
 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3a569751
 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
1e491e29
 
5a815088
 int avcodec_thread_init(AVCodecContext *s, int thread_count);
 void avcodec_thread_free(AVCodecContext *s);
3a84713a
 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
9c3d33d6
 //FIXME func typedef
 
7a06ff14
 /**
f9ec0aa1
  * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
  * function the context has to be allocated.
  *
  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
  * retrieving a codec.
  *
f5bccd85
  * @warning This function is not thread safe!
f9ec0aa1
  *
  * @code
c9823f05
  * avcodec_register_all();
f9ec0aa1
  * codec = avcodec_find_decoder(CODEC_ID_H264);
  * if (!codec)
  *     exit(1);
  *
  * context = avcodec_alloc_context();
  *
  * if (avcodec_open(context, codec) < 0)
  *     exit(1);
  * @endcode
  *
f5bccd85
  * @param avctx The context which will be set up to use the given codec.
f9ec0aa1
  * @param codec The codec to use within the context.
f5bccd85
  * @return zero on success, a negative value on error
f9ec0aa1
  * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
7a06ff14
  */
de6d9b64
 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
7a06ff14
 
f9ec0aa1
 /**
  * Decodes an audio frame from \p buf into \p samples.
f5bccd85
  * The avcodec_decode_audio2() function decodes an audio frame from the input
f9ec0aa1
  * buffer \p buf of size \p buf_size. To decode it, it makes use of the
f5bccd85
  * audio codec which was coupled with \p avctx using avcodec_open(). The
f9ec0aa1
  * resulting decoded frame is stored in output buffer \p samples.  If no frame
  * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
  * decompressed frame size in \e bytes.
  *
  * @warning You \e must set \p frame_size_ptr to the allocated size of the
  * output buffer before calling avcodec_decode_audio2().
  *
  * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
  * the actual read bytes because some optimized bitstream readers read 32 or 64
  * bits at once and could read over the end.
  *
  * @warning The end of the input buffer \p buf should be set to 0 to ensure that
  * no overreading happens for damaged MPEG streams.
98145875
  *
f9ec0aa1
  * @note You might have to align the input buffer \p buf and output buffer \p
f5bccd85
  * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
f9ec0aa1
  * necessary at all, on others it won't work at all if not aligned and on others
  * it will work but it will have an impact on performance. In practice, the
  * bitstream should have 4 byte alignment at minimum and all sample data should
  * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
  * the linesize is not a multiple of 16 then there's no sense in aligning the
  * start of the buffer to 16.
  *
f5bccd85
  * @param avctx the codec context
  * @param[out] samples the output buffer
  * @param[in,out] frame_size_ptr the output buffer size in bytes
  * @param[in] buf the input buffer
  * @param[in] buf_size the input buffer size in bytes
f9ec0aa1
  * @return On error a negative value is returned, otherwise the number of bytes
  * used or zero if no frame could be decompressed.
98145875
  */
ac66834c
 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
de6d9b64
                          int *frame_size_ptr,
2efa7fd1
                          const uint8_t *buf, int buf_size);
f9ec0aa1
 
 /**
  * Decodes a video frame from \p buf into \p picture.
f5bccd85
  * The avcodec_decode_video() function decodes a video frame from the input
f9ec0aa1
  * buffer \p buf of size \p buf_size. To decode it, it makes use of the
f5bccd85
  * video codec which was coupled with \p avctx using avcodec_open(). The
f9ec0aa1
  * resulting decoded frame is stored in \p picture.
  *
  * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
  * the actual read bytes because some optimized bitstream readers read 32 or 64
  * bits at once and could read over the end.
  *
  * @warning The end of the input buffer \p buf should be set to 0 to ensure that
  * no overreading happens for damaged MPEG streams.
  *
  * @note You might have to align the input buffer \p buf and output buffer \p
  * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
  * necessary at all, on others it won't work at all if not aligned and on others
  * it will work but it will have an impact on performance. In practice, the
  * bitstream should have 4 byte alignment at minimum and all sample data should
  * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
  * the linesize is not a multiple of 16 then there's no sense in aligning the
  * start of the buffer to 16.
  *
1b9bbf86
  * @note Some codecs have a delay between input and output, these need to be
  * feeded with buf=NULL, buf_size=0 at the end to return the remaining frames.
  *
f5bccd85
  * @param avctx the codec context
f9ec0aa1
  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
f5bccd85
  * @param[in] buf the input buffer
  * @param[in] buf_size the size of the input buffer in bytes
  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
f9ec0aa1
  * @return On error a negative value is returned, otherwise the number of bytes
  * used or zero if no frame could be decompressed.
  */
115329f1
 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
de6d9b64
                          int *got_picture_ptr,
2efa7fd1
                          const uint8_t *buf, int buf_size);
8ab4861c
 
f5bccd85
 /* Decode a subtitle message. Return -1 if error, otherwise return the
  * number of bytes used. If no subtitle could be decompressed,
  * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
240c1657
 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
                             int *got_sub_ptr,
                             const uint8_t *buf, int buf_size);
115329f1
 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
917e06c8
                         int *data_size_ptr,
0c1a9eda
                         uint8_t *buf, int buf_size);
f9ec0aa1
 
 /**
  * Encodes an audio frame from \p samples into \p buf.
f5bccd85
  * The avcodec_encode_audio() function encodes an audio frame from the input
  * buffer \p samples. To encode it, it makes use of the audio codec which was
f9ec0aa1
  * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
  * stored in output buffer \p buf.
  *
  * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
  *
f5bccd85
  * @param avctx the codec context
  * @param[out] buf the output buffer
  * @param[in] buf_size the output buffer size
  * @param[in] samples the input buffer containing the samples
0fe93f07
  * The number of samples read from this buffer is frame_size*channels,
  * both of which are defined in \p avctx.
5231f101
  * For PCM audio the number of samples read from \p samples is equal to
  * \p buf_size * input_sample_size / output_sample_size.
7338d368
  * @return On error a negative value is returned, on success zero or the number
0fe93f07
  * of bytes used to encode the data read from the input buffer.
f9ec0aa1
  */
115329f1
 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
de6d9b64
                          const short *samples);
f9ec0aa1
 
 /**
  * Encodes a video frame from \p pict into \p buf.
f5bccd85
  * The avcodec_encode_video() function encodes a video frame from the input
  * \p pict. To encode it, it makes use of the video codec which was coupled with
f9ec0aa1
  * \p avctx using avcodec_open(). The resulting encoded bytes representing the
  * frame are stored in the output buffer \p buf. The input picture should be
  * stored using a specific format, namely \c avctx.pix_fmt.
  *
f5bccd85
  * @param avctx the codec context
  * @param[out] buf the output buffer for the bitstream of encoded frame
  * @param[in] buf_size the size of the output buffer in bytes
  * @param[in] pict the input picture to encode
f9ec0aa1
  * @return On error a negative value is returned, on success zero or the number
99b38122
  * of bytes used from the output buffer.
f9ec0aa1
  */
115329f1
 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
492cd3a9
                          const AVFrame *pict);
115329f1
 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
240c1657
                             const AVSubtitle *sub);
de6d9b64
 
 int avcodec_close(AVCodecContext *avctx);
 
d0a01fe8
 /**
  * Register all the codecs, parsers and bitstream filters which were enabled at
  * configuration time. If you do not call this function you can select exactly
  * which formats you want to support, by using the individual registration
  * functions.
  *
9be26823
  * @see avcodec_register
d0a01fe8
  * @see av_register_codec_parser
  * @see av_register_bitstream_filter
  */
de6d9b64
 void avcodec_register_all(void);
a96b68b7
 
8ab4861c
 /**
  * Flush buffers, should be called when seeking or when switching to a different stream.
  */
1c2a8c7f
 void avcodec_flush_buffers(AVCodecContext *avctx);
 
88730be6
 void avcodec_default_free_buffers(AVCodecContext *s);
 
85975aa9
 /* misc useful functions */
d8085ea7
 
 /**
8f6260af
  * Returns a single letter to describe the given picture type \p pict_type.
  *
f5bccd85
  * @param[in] pict_type the picture type
8f6260af
  * @return A single character representing the picture type.
d8085ea7
  */
 char av_get_pict_type_char(int pict_type);
 
ac3e1834
 /**
2fa378a7
  * Returns codec bits per sample.
  *
f5bccd85
  * @param[in] codec_id the codec
2fa378a7
  * @return Number of bits per sample or zero if unknown for the given codec.
ac3e1834
  */
 int av_get_bits_per_sample(enum CodecID codec_id);
2e8f2c20
 
42c71907
 /**
  * Returns sample format bits per sample.
  *
  * @param[in] sample_fmt the sample format
  * @return Number of bits per sample or zero if unknown for the given sample format.
  */
 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
 
8424cf50
 /* frame parsing */
 typedef struct AVCodecParserContext {
     void *priv_data;
     struct AVCodecParser *parser;
     int64_t frame_offset; /* offset of the current frame */
115329f1
     int64_t cur_offset; /* current offset
8424cf50
                            (incremented by each av_parser_parse()) */
26f23725
     int64_t next_frame_offset; /* offset of the next frame */
8424cf50
     /* video info */
f5bccd85
     int pict_type; /* XXX: Put it back in AVCodecContext. */
346db3ef
     /**
      * This field is used for proper frame duration computation in lavf.
      * It signals, how much longer the frame duration of the current frame
      * is compared to normal frame duration.
      *
810c451b
      * frame_duration = (1 + repeat_pict) * time_base
346db3ef
      *
      * It is used by codecs like H.264 to display telecined material.
      */
f5bccd85
     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
b84f2a35
     int64_t pts;     /* pts of the current frame */
     int64_t dts;     /* dts of the current frame */
 
     /* private data */
     int64_t last_pts;
     int64_t last_dts;
a62aecce
     int fetch_timestamp;
b84f2a35
 
 #define AV_PARSER_PTS_NB 4
     int cur_frame_start_index;
     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
115329f1
 
7cbaa7ba
     int flags;
 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
a74008a4
 
     int64_t offset;      ///< byte offset from starting packet start
5c027f88
     int64_t cur_frame_end[AV_PARSER_PTS_NB];
6363af44
 
     /*!
      * Set by parser to 1 for key frames and 0 for non-key frames.
      * It is initialized to -1, so if the parser doesn't set this flag,
      * old-style fallback using FF_I_TYPE picture type as key frames
      * will be used.
      */
     int key_frame;
b1fa4942
 
     /**
      * Time difference in stream time base units from the pts of this
      * packet to the point at which the output from the decoder has converged
      * independent from the availability of previous frames. That is, the
      * frames are virtually identical no matter if decoding started from
      * the very first frame or from this keyframe.
      * Is AV_NOPTS_VALUE if unknown.
      * This field is not the display duration of the current frame.
      *
      * The purpose of this field is to allow seeking in streams that have no
      * keyframes in the conventional sense. It corresponds to the
      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
      * essential for some types of subtitle streams to ensure that all
      * subtitles are correctly displayed after seeking.
      */
     int64_t convergence_duration;
27ca0a79
 
     // Timestamp generation support:
     /**
      * Synchronization point for start of timestamp generation.
      *
      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
      * (default).
      *
      * For example, this corresponds to presence of H.264 buffering period
      * SEI message.
      */
     int dts_sync_point;
 
     /**
      * Offset of the current timestamp against last timestamp sync point in
      * units of AVCodecContext.time_base.
      *
      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
      * contain a valid timestamp offset.
      *
      * Note that the timestamp of sync point has usually a nonzero
      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
      * the next frame after timestamp sync point will be usually 1.
      *
      * For example, this corresponds to H.264 cpb_removal_delay.
      */
     int dts_ref_dts_delta;
 
     /**
      * Presentation delay of current frame in units of AVCodecContext.time_base.
      *
      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
      * contain valid non-negative timestamp delta (presentation time of a frame
      * must not lie in the past).
      *
      * This delay represents the difference between decoding and presentation
      * time of the frame.
      *
      * For example, this corresponds to H.264 dpb_output_delay.
      */
     int pts_dts_delta;
8424cf50
 } AVCodecParserContext;
 
 typedef struct AVCodecParser {
99f06236
     int codec_ids[5]; /* several codec IDs are permitted */
8424cf50
     int priv_data_size;
     int (*parser_init)(AVCodecParserContext *s);
115329f1
     int (*parser_parse)(AVCodecParserContext *s,
8424cf50
                         AVCodecContext *avctx,
c53d2d90
                         const uint8_t **poutbuf, int *poutbuf_size,
8424cf50
                         const uint8_t *buf, int buf_size);
     void (*parser_close)(AVCodecParserContext *s);
90ad92b3
     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
8424cf50
     struct AVCodecParser *next;
 } AVCodecParser;
 
55b9e69a
 AVCodecParser *av_parser_next(AVCodecParser *c);
8424cf50
 
 void av_register_codec_parser(AVCodecParser *parser);
 AVCodecParserContext *av_parser_init(int codec_id);
115329f1
 int av_parser_parse(AVCodecParserContext *s,
8424cf50
                     AVCodecContext *avctx,
115329f1
                     uint8_t **poutbuf, int *poutbuf_size,
b84f2a35
                     const uint8_t *buf, int buf_size,
                     int64_t pts, int64_t dts);
90ad92b3
 int av_parser_change(AVCodecParserContext *s,
                      AVCodecContext *avctx,
115329f1
                      uint8_t **poutbuf, int *poutbuf_size,
90ad92b3
                      const uint8_t *buf, int buf_size, int keyframe);
8424cf50
 void av_parser_close(AVCodecParserContext *s);
 
748c2fca
 
 typedef struct AVBitStreamFilterContext {
514e0831
     void *priv_data;
748c2fca
     struct AVBitStreamFilter *filter;
     AVCodecParserContext *parser;
     struct AVBitStreamFilterContext *next;
 } AVBitStreamFilterContext;
 
 
 typedef struct AVBitStreamFilter {
     const char *name;
514e0831
     int priv_data_size;
748c2fca
     int (*filter)(AVBitStreamFilterContext *bsfc,
                   AVCodecContext *avctx, const char *args,
                   uint8_t **poutbuf, int *poutbuf_size,
                   const uint8_t *buf, int buf_size, int keyframe);
0a1a0a80
     void (*close)(AVBitStreamFilterContext *bsfc);
748c2fca
     struct AVBitStreamFilter *next;
 } AVBitStreamFilter;
 
 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
                                AVCodecContext *avctx, const char *args,
                                uint8_t **poutbuf, int *poutbuf_size,
                                const uint8_t *buf, int buf_size, int keyframe);
 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
 
55b9e69a
 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
748c2fca
 
544eb99c
 /* memory */
8ab4861c
 
 /**
4267e90d
  * Reallocates the given block if it is not large enough, otherwise it
  * does nothing.
  *
  * @see av_realloc
8ab4861c
  */
97d96aaa
 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
8ab4861c
 
392cf77a
 /**
  * Copy image 'src' to 'dst'.
  */
636d6a4a
 void av_picture_copy(AVPicture *dst, const AVPicture *src,
e1c2a5a0
               int pix_fmt, int width, int height);
 
392cf77a
 /**
f5bccd85
  * Crop image top and left side.
392cf77a
  */
636d6a4a
 int av_picture_crop(AVPicture *dst, const AVPicture *src,
f2651e7a
              int pix_fmt, int top_band, int left_band);
 
392cf77a
 /**
f5bccd85
  * Pad image.
392cf77a
  */
636d6a4a
 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
5341c209
             int padtop, int padbottom, int padleft, int padright, int *color);
 
9686df2b
 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
ad2b531d
 
26ef3220
 /**
  * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
  *
755bfeab
  * @return 0 in case of a successful parsing, a negative value otherwise
26ef3220
  * @param[in] str the string to parse: it has to be a string in the format
  * <width>x<height> or a valid video frame size abbreviation.
  * @param[in,out] width_ptr pointer to the variable which will contain the detected
  * frame width value
  * @param[in,out] height_ptr pointer to the variable which will contain the detected
  * frame height value
  */
 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
 
 /**
  * Parses \p str and put in \p frame_rate the detected values.
  *
755bfeab
  * @return 0 in case of a successful parsing, a negative value otherwise
26ef3220
  * @param[in] str the string to parse: it has to be a string in the format
2d7b0560
  * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
26ef3220
  * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
  * frame rate
  */
 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
 
8fa36ae0
 /* error handling */
 #if EINVAL > 0
f5bccd85
 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
8fa36ae0
 #else
f5bccd85
 /* Some platforms have E* and errno already negated. */
8fa36ae0
 #define AVERROR(e) (e)
 #define AVUNERROR(e) (e)
 #endif
 #define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
f5bccd85
 #define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
 #define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
8fa36ae0
 #define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
 #define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
 #define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
f5bccd85
 #define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
35e7f087
 #define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
9bf1b724
 #define AVERROR_EOF         AVERROR(EPIPE)   /**< End of file. */
f3a3c72e
 #define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
8fa36ae0
 
40e5d31b
 /**
  * Registers the hardware accelerator \p hwaccel.
  */
 void av_register_hwaccel(AVHWAccel *hwaccel);
 
 /**
  * If hwaccel is NULL, returns the first registered hardware accelerator,
  * if hwaccel is non-NULL, returns the next registered hardware accelerator
  * after hwaccel, or NULL if hwaccel is the last one.
  */
 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
 
e5bea45d
 
 /**
  * Lock operation used by lockmgr
  */
 enum AVLockOp {
   AV_LOCK_CREATE,  ///< Create a mutex
   AV_LOCK_OBTAIN,  ///< Lock the mutex
   AV_LOCK_RELEASE, ///< Unlock the mutex
   AV_LOCK_DESTROY, ///< Free mutex resources
 };
 
 /**
  * Register a user provided lock manager supporting the operations
  * specified by AVLockOp. \p mutex points to a (void *) where the
  * lockmgr should store/get a pointer to a user allocated mutex. It's
  * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
  *
  * @param cb User defined callback. Note: FFmpeg may invoke calls to this
  *           callback during the call to av_lockmgr_register().
  *           Thus, the application must be prepared to handle that.
  *           If cb is set to NULL the lockmgr will be unregistered.
  *           Also note that during unregistration the previously registered
  *           lockmgr callback may also be invoked.
  */
 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
 
98790382
 #endif /* AVCODEC_AVCODEC_H */