git.sesse.net Git - ffmpeg/blob - libavcodec/avcodec.h

   1 /*
   2  * copyright (c) 2001 Fabrice Bellard
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef FFMPEG_AVCODEC_H
  22 #define FFMPEG_AVCODEC_H
  23
  24 /**
  25  * @file avcodec.h
  26  * external API header
  27  */
  28
  29
  30 #include "libavutil/avutil.h"
  31 #include <sys/types.h> /* size_t */
  32
  33 #define LIBAVCODEC_VERSION_MAJOR 51
  34 #define LIBAVCODEC_VERSION_MINOR 50
  35 #define LIBAVCODEC_VERSION_MICRO  1
  36
  37 #define LIBAVCODEC_VERSION_INT  AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
  38                                                LIBAVCODEC_VERSION_MINOR, \
  39                                                LIBAVCODEC_VERSION_MICRO)
  40 #define LIBAVCODEC_VERSION      AV_VERSION(LIBAVCODEC_VERSION_MAJOR,    \
  41                                            LIBAVCODEC_VERSION_MINOR,    \
  42                                            LIBAVCODEC_VERSION_MICRO)
  43 #define LIBAVCODEC_BUILD        LIBAVCODEC_VERSION_INT
  44
  45 #define LIBAVCODEC_IDENT        "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
  46
  47 #define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)
  48 #define AV_TIME_BASE            1000000
  49 #define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
  50
  51 /**
  52  * Identifies the syntax and semantics of the bitstream.
  53  * The principle is roughly:
  54  * Two decoders with the same ID can decode the same streams.
  55  * Two encoders with the same ID can encode compatible streams.
  56  * There may be slight deviations from the principle due to implementation
  57  * details.
  58  *
  59  * If you add a codec ID to this list, add it so that
  60  * 1. no value of a existing codec ID changes (that would break ABI),
  61  * 2. it is as close as possible to similar codecs.
  62  */
  63 enum CodecID {
  64     CODEC_ID_NONE,
  65     CODEC_ID_MPEG1VIDEO,
  66     CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
  67     CODEC_ID_MPEG2VIDEO_XVMC,
  68     CODEC_ID_H261,
  69     CODEC_ID_H263,
  70     CODEC_ID_RV10,
  71     CODEC_ID_RV20,
  72     CODEC_ID_MJPEG,
  73     CODEC_ID_MJPEGB,
  74     CODEC_ID_LJPEG,
  75     CODEC_ID_SP5X,
  76     CODEC_ID_JPEGLS,
  77     CODEC_ID_MPEG4,
  78     CODEC_ID_RAWVIDEO,
  79     CODEC_ID_MSMPEG4V1,
  80     CODEC_ID_MSMPEG4V2,
  81     CODEC_ID_MSMPEG4V3,
  82     CODEC_ID_WMV1,
  83     CODEC_ID_WMV2,
  84     CODEC_ID_H263P,
  85     CODEC_ID_H263I,
  86     CODEC_ID_FLV1,
  87     CODEC_ID_SVQ1,
  88     CODEC_ID_SVQ3,
  89     CODEC_ID_DVVIDEO,
  90     CODEC_ID_HUFFYUV,
  91     CODEC_ID_CYUV,
  92     CODEC_ID_H264,
  93     CODEC_ID_INDEO3,
  94     CODEC_ID_VP3,
  95     CODEC_ID_THEORA,
  96     CODEC_ID_ASV1,
  97     CODEC_ID_ASV2,
  98     CODEC_ID_FFV1,
  99     CODEC_ID_4XM,
 100     CODEC_ID_VCR1,
 101     CODEC_ID_CLJR,
 102     CODEC_ID_MDEC,
 103     CODEC_ID_ROQ,
 104     CODEC_ID_INTERPLAY_VIDEO,
 105     CODEC_ID_XAN_WC3,
 106     CODEC_ID_XAN_WC4,
 107     CODEC_ID_RPZA,
 108     CODEC_ID_CINEPAK,
 109     CODEC_ID_WS_VQA,
 110     CODEC_ID_MSRLE,
 111     CODEC_ID_MSVIDEO1,
 112     CODEC_ID_IDCIN,
 113     CODEC_ID_8BPS,
 114     CODEC_ID_SMC,
 115     CODEC_ID_FLIC,
 116     CODEC_ID_TRUEMOTION1,
 117     CODEC_ID_VMDVIDEO,
 118     CODEC_ID_MSZH,
 119     CODEC_ID_ZLIB,
 120     CODEC_ID_QTRLE,
 121     CODEC_ID_SNOW,
 122     CODEC_ID_TSCC,
 123     CODEC_ID_ULTI,
 124     CODEC_ID_QDRAW,
 125     CODEC_ID_VIXL,
 126     CODEC_ID_QPEG,
 127     CODEC_ID_XVID,
 128     CODEC_ID_PNG,
 129     CODEC_ID_PPM,
 130     CODEC_ID_PBM,
 131     CODEC_ID_PGM,
 132     CODEC_ID_PGMYUV,
 133     CODEC_ID_PAM,
 134     CODEC_ID_FFVHUFF,
 135     CODEC_ID_RV30,
 136     CODEC_ID_RV40,
 137     CODEC_ID_VC1,
 138     CODEC_ID_WMV3,
 139     CODEC_ID_LOCO,
 140     CODEC_ID_WNV1,
 141     CODEC_ID_AASC,
 142     CODEC_ID_INDEO2,
 143     CODEC_ID_FRAPS,
 144     CODEC_ID_TRUEMOTION2,
 145     CODEC_ID_BMP,
 146     CODEC_ID_CSCD,
 147     CODEC_ID_MMVIDEO,
 148     CODEC_ID_ZMBV,
 149     CODEC_ID_AVS,
 150     CODEC_ID_SMACKVIDEO,
 151     CODEC_ID_NUV,
 152     CODEC_ID_KMVC,
 153     CODEC_ID_FLASHSV,
 154     CODEC_ID_CAVS,
 155     CODEC_ID_JPEG2000,
 156     CODEC_ID_VMNC,
 157     CODEC_ID_VP5,
 158     CODEC_ID_VP6,
 159     CODEC_ID_VP6F,
 160     CODEC_ID_TARGA,
 161     CODEC_ID_DSICINVIDEO,
 162     CODEC_ID_TIERTEXSEQVIDEO,
 163     CODEC_ID_TIFF,
 164     CODEC_ID_GIF,
 165     CODEC_ID_FFH264,
 166     CODEC_ID_DXA,
 167     CODEC_ID_DNXHD,
 168     CODEC_ID_THP,
 169     CODEC_ID_SGI,
 170     CODEC_ID_C93,
 171     CODEC_ID_BETHSOFTVID,
 172     CODEC_ID_PTX,
 173     CODEC_ID_TXD,
 174     CODEC_ID_VP6A,
 175     CODEC_ID_AMV,
 176     CODEC_ID_VB,
 177     CODEC_ID_PCX,
 178     CODEC_ID_SUNRAST,
 179     CODEC_ID_INDEO4,
 180     CODEC_ID_INDEO5,
 181
 182     /* various PCM "codecs" */
 183     CODEC_ID_PCM_S16LE= 0x10000,
 184     CODEC_ID_PCM_S16BE,
 185     CODEC_ID_PCM_U16LE,
 186     CODEC_ID_PCM_U16BE,
 187     CODEC_ID_PCM_S8,
 188     CODEC_ID_PCM_U8,
 189     CODEC_ID_PCM_MULAW,
 190     CODEC_ID_PCM_ALAW,
 191     CODEC_ID_PCM_S32LE,
 192     CODEC_ID_PCM_S32BE,
 193     CODEC_ID_PCM_U32LE,
 194     CODEC_ID_PCM_U32BE,
 195     CODEC_ID_PCM_S24LE,
 196     CODEC_ID_PCM_S24BE,
 197     CODEC_ID_PCM_U24LE,
 198     CODEC_ID_PCM_U24BE,
 199     CODEC_ID_PCM_S24DAUD,
 200     CODEC_ID_PCM_ZORK,
 201     CODEC_ID_PCM_S16LE_PLANAR,
 202
 203     /* various ADPCM codecs */
 204     CODEC_ID_ADPCM_IMA_QT= 0x11000,
 205     CODEC_ID_ADPCM_IMA_WAV,
 206     CODEC_ID_ADPCM_IMA_DK3,
 207     CODEC_ID_ADPCM_IMA_DK4,
 208     CODEC_ID_ADPCM_IMA_WS,
 209     CODEC_ID_ADPCM_IMA_SMJPEG,
 210     CODEC_ID_ADPCM_MS,
 211     CODEC_ID_ADPCM_4XM,
 212     CODEC_ID_ADPCM_XA,
 213     CODEC_ID_ADPCM_ADX,
 214     CODEC_ID_ADPCM_EA,
 215     CODEC_ID_ADPCM_G726,
 216     CODEC_ID_ADPCM_CT,
 217     CODEC_ID_ADPCM_SWF,
 218     CODEC_ID_ADPCM_YAMAHA,
 219     CODEC_ID_ADPCM_SBPRO_4,
 220     CODEC_ID_ADPCM_SBPRO_3,
 221     CODEC_ID_ADPCM_SBPRO_2,
 222     CODEC_ID_ADPCM_THP,
 223     CODEC_ID_ADPCM_IMA_AMV,
 224     CODEC_ID_ADPCM_EA_R1,
 225     CODEC_ID_ADPCM_EA_R3,
 226     CODEC_ID_ADPCM_EA_R2,
 227     CODEC_ID_ADPCM_IMA_EA_SEAD,
 228     CODEC_ID_ADPCM_IMA_EA_EACS,
 229     CODEC_ID_ADPCM_EA_XAS,
 230
 231     /* AMR */
 232     CODEC_ID_AMR_NB= 0x12000,
 233     CODEC_ID_AMR_WB,
 234
 235     /* RealAudio codecs*/
 236     CODEC_ID_RA_144= 0x13000,
 237     CODEC_ID_RA_288,
 238
 239     /* various DPCM codecs */
 240     CODEC_ID_ROQ_DPCM= 0x14000,
 241     CODEC_ID_INTERPLAY_DPCM,
 242     CODEC_ID_XAN_DPCM,
 243     CODEC_ID_SOL_DPCM,
 244
 245     CODEC_ID_MP2= 0x15000,
 246     CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
 247     CODEC_ID_AAC,
 248 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
 249     CODEC_ID_MPEG4AAC,
 250 #endif
 251     CODEC_ID_AC3,
 252     CODEC_ID_DTS,
 253     CODEC_ID_VORBIS,
 254     CODEC_ID_DVAUDIO,
 255     CODEC_ID_WMAV1,
 256     CODEC_ID_WMAV2,
 257     CODEC_ID_MACE3,
 258     CODEC_ID_MACE6,
 259     CODEC_ID_VMDAUDIO,
 260     CODEC_ID_SONIC,
 261     CODEC_ID_SONIC_LS,
 262     CODEC_ID_FLAC,
 263     CODEC_ID_MP3ADU,
 264     CODEC_ID_MP3ON4,
 265     CODEC_ID_SHORTEN,
 266     CODEC_ID_ALAC,
 267     CODEC_ID_WESTWOOD_SND1,
 268     CODEC_ID_GSM, ///< as in Berlin toast format
 269     CODEC_ID_QDM2,
 270     CODEC_ID_COOK,
 271     CODEC_ID_TRUESPEECH,
 272     CODEC_ID_TTA,
 273     CODEC_ID_SMACKAUDIO,
 274     CODEC_ID_QCELP,
 275     CODEC_ID_WAVPACK,
 276     CODEC_ID_DSICINAUDIO,
 277     CODEC_ID_IMC,
 278     CODEC_ID_MUSEPACK7,
 279     CODEC_ID_MLP,
 280     CODEC_ID_GSM_MS, /* as found in WAV */
 281     CODEC_ID_ATRAC3,
 282     CODEC_ID_VOXWARE,
 283     CODEC_ID_APE,
 284     CODEC_ID_NELLYMOSER,
 285     CODEC_ID_MUSEPACK8,
 286     CODEC_ID_SPEEX,
 287     CODEC_ID_WMAVOICE,
 288     CODEC_ID_WMAPRO,
 289     CODEC_ID_WMALOSSLESS,
 290
 291     /* subtitle codecs */
 292     CODEC_ID_DVD_SUBTITLE= 0x17000,
 293     CODEC_ID_DVB_SUBTITLE,
 294     CODEC_ID_TEXT,  ///< raw UTF-8 text
 295     CODEC_ID_XSUB,
 296     CODEC_ID_SSA,
 297     CODEC_ID_MOV_TEXT,
 298
 299     /* other specific kind of codecs (generaly used for attachments) */
 300     CODEC_ID_TTF= 0x18000,
 301
 302     CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
 303                                 * stream (only used by libavformat) */
 304 };
 305
 306 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
 307 /* CODEC_ID_MP3LAME is obsolete */
 308 #define CODEC_ID_MP3LAME CODEC_ID_MP3
 309 #define CODEC_ID_MPEG4AAC CODEC_ID_AAC
 310 #endif
 311
 312 enum CodecType {
 313     CODEC_TYPE_UNKNOWN = -1,
 314     CODEC_TYPE_VIDEO,
 315     CODEC_TYPE_AUDIO,
 316     CODEC_TYPE_DATA,
 317     CODEC_TYPE_SUBTITLE,
 318     CODEC_TYPE_ATTACHMENT,
 319     CODEC_TYPE_NB
 320 };
 321
 322 /**
 323  * Currently unused, may be used if 24/32 bits samples are ever supported.
 324  * all in native-endian format
 325  */
 326 enum SampleFormat {
 327     SAMPLE_FMT_NONE = -1,
 328     SAMPLE_FMT_U8,              ///< unsigned 8 bits
 329     SAMPLE_FMT_S16,             ///< signed 16 bits
 330     SAMPLE_FMT_S24,             ///< signed 24 bits
 331     SAMPLE_FMT_S32,             ///< signed 32 bits
 332     SAMPLE_FMT_FLT,             ///< float
 333 };
 334
 335 /* in bytes */
 336 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
 337
 338 /**
 339  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
 340  * This is mainly needed because some optimized bitstream readers read
 341  * 32 or 64 bit at once and could read over the end.<br>
 342  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
 343  * MPEG bitstreams could cause overread and segfault.
 344  */
 345 #define FF_INPUT_BUFFER_PADDING_SIZE 8
 346
 347 /**
 348  * minimum encoding buffer size
 349  * Used to avoid some checks during header writing.
 350  */
 351 #define FF_MIN_BUFFER_SIZE 16384
 352
 353 /**
 354  * motion estimation type.
 355  */
 356 enum Motion_Est_ID {
 357     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
 358     ME_FULL,
 359     ME_LOG,
 360     ME_PHODS,
 361     ME_EPZS,        ///< enhanced predictive zonal search
 362     ME_X1,          ///< reserved for experiments
 363     ME_HEX,         ///< hexagon based search
 364     ME_UMH,         ///< uneven multi-hexagon search
 365     ME_ITER,        ///< iterative search
 366 };
 367
 368 enum AVDiscard{
 369     /* We leave some space between them for extensions (drop some
 370      * keyframes for intra-only or drop just some bidir frames). */
 371     AVDISCARD_NONE   =-16, ///< discard nothing
 372     AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
 373     AVDISCARD_NONREF =  8, ///< discard all non reference
 374     AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
 375     AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
 376     AVDISCARD_ALL    = 48, ///< discard all
 377 };
 378
 379 typedef struct RcOverride{
 380     int start_frame;
 381     int end_frame;
 382     int qscale; // If this is 0 then quality_factor will be used instead.
 383     float quality_factor;
 384 } RcOverride;
 385
 386 #define FF_MAX_B_FRAMES 16
 387
 388 /* encoding support
 389    These flags can be passed in AVCodecContext.flags before initialization.
 390    Note: Not everything is supported yet.
 391 */
 392
 393 #define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
 394 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
 395 #define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
 396 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
 397 #define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
 398 #define CODEC_FLAG_PART   0x0080  ///< Use data partitioning.
 399 /**
 400  * The parent program guarantees that the input for B-frames containing
 401  * streams is not written to for at least s->max_b_frames+1 frames, if
 402  * this is not set the input will be copied.
 403  */
 404 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
 405 #define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
 406 #define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
 407 #define CODEC_FLAG_EXTERN_HUFF     0x1000   ///< Use external Huffman table (for MJPEG).
 408 #define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
 409 #define CODEC_FLAG_EMU_EDGE        0x4000   ///< Don't draw edges.
 410 #define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
 411 #define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
 412                                                   location instead of only at frame boundaries. */
 413 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
 414 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
 415 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
 416 #define CODEC_FLAG_ALT_SCAN       0x00100000 ///< Use alternate scan.
 417 #define CODEC_FLAG_TRELLIS_QUANT  0x00200000 ///< Use trellis quantization.
 418 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
 419 #define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
 420 /* Fx : Flag for h263+ extra options */
 421 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
 422 #define CODEC_FLAG_H263P_AIC      0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
 423 #endif
 424 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
 425 #define CODEC_FLAG_H263P_UMV      0x02000000 ///< unlimited motion vector
 426 #define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
 427 #define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
 428 #define CODEC_FLAG_H263P_AIV      0x00000008 ///< H.263 alternative inter VLC
 429 #define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
 430 #define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
 431 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
 432 #define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
 433 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
 434 #define CODEC_FLAG_CLOSED_GOP     ((int)0x80000000)
 435 #define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
 436 #define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
 437 #define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
 438 #define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
 439 #define CODEC_FLAG2_BPYRAMID      0x00000010 ///< H.264 allow B-frames to be used as references.
 440 #define CODEC_FLAG2_WPRED         0x00000020 ///< H.264 weighted biprediction for B-frames
 441 #define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
 442 #define CODEC_FLAG2_8X8DCT        0x00000080 ///< H.264 high profile 8x8 transform
 443 #define CODEC_FLAG2_FASTPSKIP     0x00000100 ///< H.264 fast pskip
 444 #define CODEC_FLAG2_AUD           0x00000200 ///< H.264 access unit delimiters
 445 #define CODEC_FLAG2_BRDO          0x00000400 ///< B-frame rate-distortion optimization
 446 #define CODEC_FLAG2_INTRA_VLC     0x00000800 ///< Use MPEG-2 intra VLC table.
 447 #define CODEC_FLAG2_MEMC_ONLY     0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
 448 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
 449 #define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
 450 #define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
 451 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
 452 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
 453
 454 /* Unsupported options :
 455  *              Syntax Arithmetic coding (SAC)
 456  *              Reference Picture Selection
 457  *              Independent Segment Decoding */
 458 /* /Fx */
 459 /* codec capabilities */
 460
 461 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
 462 /**
 463  * Codec uses get_buffer() for allocating buffers.
 464  * direct rendering method 1
 465  */
 466 #define CODEC_CAP_DR1             0x0002
 467 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
 468 #define CODEC_CAP_PARSE_ONLY      0x0004
 469 #define CODEC_CAP_TRUNCATED       0x0008
 470 /* Codec can export data for HW decoding (XvMC). */
 471 #define CODEC_CAP_HWACCEL         0x0010
 472 /**
 473  * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
 474  * If this is not set, the codec is guaranteed to never be fed with NULL data.
 475  */
 476 #define CODEC_CAP_DELAY           0x0020
 477 /**
 478  * Codec can be fed a final frame with a smaller size.
 479  * This can be used to prevent truncation of the last audio samples.
 480  */
 481 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
 482
 483 //The following defines may change, don't expect compatibility if you use them.
 484 #define MB_TYPE_INTRA4x4   0x0001
 485 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
 486 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
 487 #define MB_TYPE_16x16      0x0008
 488 #define MB_TYPE_16x8       0x0010
 489 #define MB_TYPE_8x16       0x0020
 490 #define MB_TYPE_8x8        0x0040
 491 #define MB_TYPE_INTERLACED 0x0080
 492 #define MB_TYPE_DIRECT2    0x0100 //FIXME
 493 #define MB_TYPE_ACPRED     0x0200
 494 #define MB_TYPE_GMC        0x0400
 495 #define MB_TYPE_SKIP       0x0800
 496 #define MB_TYPE_P0L0       0x1000
 497 #define MB_TYPE_P1L0       0x2000
 498 #define MB_TYPE_P0L1       0x4000
 499 #define MB_TYPE_P1L1       0x8000
 500 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
 501 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
 502 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
 503 #define MB_TYPE_QUANT      0x00010000
 504 #define MB_TYPE_CBP        0x00020000
 505 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
 506
 507 /**
 508  * Pan Scan area.
 509  * This specifies the area which should be displayed.
 510  * Note there may be multiple such areas for one frame.
 511  */
 512 typedef struct AVPanScan{
 513     /**
 514      * id
 515      * - encoding: Set by user.
 516      * - decoding: Set by libavcodec.
 517      */
 518     int id;
 519
 520     /**
 521      * width and height in 1/16 pel
 522      * - encoding: Set by user.
 523      * - decoding: Set by libavcodec.
 524      */
 525     int width;
 526     int height;
 527
 528     /**
 529      * position of the top left corner in 1/16 pel for up to 3 fields/frames
 530      * - encoding: Set by user.
 531      * - decoding: Set by libavcodec.
 532      */
 533     int16_t position[3][2];
 534 }AVPanScan;
 535
 536 #define FF_COMMON_FRAME \
 537     /**\
 538      * pointer to the picture planes.\
 539      * This might be different from the first allocated byte\
 540      * - encoding: \
 541      * - decoding: \
 542      */\
 543     uint8_t *data[4];\
 544     int linesize[4];\
 545     /**\
 546      * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
 547      * This isn't used by libavcodec unless the default get/release_buffer() is used.\
 548      * - encoding: \
 549      * - decoding: \
 550      */\
 551     uint8_t *base[4];\
 552     /**\
 553      * 1 -> keyframe, 0-> not\
 554      * - encoding: Set by libavcodec.\
 555      * - decoding: Set by libavcodec.\
 556      */\
 557     int key_frame;\
 558 \
 559     /**\
 560      * Picture type of the frame, see ?_TYPE below.\
 561      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
 562      * - decoding: Set by libavcodec.\
 563      */\
 564     int pict_type;\
 565 \
 566     /**\
 567      * presentation timestamp in time_base units (time when frame should be shown to user)\
 568      * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
 569      * - encoding: MUST be set by user.\
 570      * - decoding: Set by libavcodec.\
 571      */\
 572     int64_t pts;\
 573 \
 574     /**\
 575      * picture number in bitstream order\
 576      * - encoding: set by\
 577      * - decoding: Set by libavcodec.\
 578      */\
 579     int coded_picture_number;\
 580     /**\
 581      * picture number in display order\
 582      * - encoding: set by\
 583      * - decoding: Set by libavcodec.\
 584      */\
 585     int display_picture_number;\
 586 \
 587     /**\
 588      * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
 589      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
 590      * - decoding: Set by libavcodec.\
 591      */\
 592     int quality; \
 593 \
 594     /**\
 595      * buffer age (1->was last buffer and dint change, 2->..., ...).\
 596      * Set to INT_MAX if the buffer has not been used yet.\
 597      * - encoding: unused\
 598      * - decoding: MUST be set by get_buffer().\
 599      */\
 600     int age;\
 601 \
 602     /**\
 603      * is this picture used as reference\
 604      * - encoding: unused\
 605      * - decoding: Set by libavcodec. (before get_buffer() call)).\
 606      */\
 607     int reference;\
 608 \
 609     /**\
 610      * QP table\
 611      * - encoding: unused\
 612      * - decoding: Set by libavcodec.\
 613      */\
 614     int8_t *qscale_table;\
 615     /**\
 616      * QP store stride\
 617      * - encoding: unused\
 618      * - decoding: Set by libavcodec.\
 619      */\
 620     int qstride;\
 621 \
 622     /**\
 623      * mbskip_table[mb]>=1 if MB didn't change\
 624      * stride= mb_width = (width+15)>>4\
 625      * - encoding: unused\
 626      * - decoding: Set by libavcodec.\
 627      */\
 628     uint8_t *mbskip_table;\
 629 \
 630     /**\
 631      * motion vector table\
 632      * @code\
 633      * example:\
 634      * int mv_sample_log2= 4 - motion_subsample_log2;\
 635      * int mb_width= (width+15)>>4;\
 636      * int mv_stride= (mb_width << mv_sample_log2) + 1;\
 637      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
 638      * @endcode\
 639      * - encoding: Set by user.\
 640      * - decoding: Set by libavcodec.\
 641      */\
 642     int16_t (*motion_val[2])[2];\
 643 \
 644     /**\
 645      * macroblock type table\
 646      * mb_type_base + mb_width + 2\
 647      * - encoding: Set by user.\
 648      * - decoding: Set by libavcodec.\
 649      */\
 650     uint32_t *mb_type;\
 651 \
 652     /**\
 653      * log2 of the size of the block which a single vector in motion_val represents: \
 654      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
 655      * - encoding: unused\
 656      * - decoding: Set by libavcodec.\
 657      */\
 658     uint8_t motion_subsample_log2;\
 659 \
 660     /**\
 661      * for some private data of the user\
 662      * - encoding: unused\
 663      * - decoding: Set by user.\
 664      */\
 665     void *opaque;\
 666 \
 667     /**\
 668      * error\
 669      * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
 670      * - decoding: unused\
 671      */\
 672     uint64_t error[4];\
 673 \
 674     /**\
 675      * type of the buffer (to keep track of who has to deallocate data[*])\
 676      * - encoding: Set by the one who allocates it.\
 677      * - decoding: Set by the one who allocates it.\
 678      * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
 679      */\
 680     int type;\
 681     \
 682     /**\
 683      * When decoding, this signals how much the picture must be delayed.\
 684      * extra_delay = repeat_pict / (2*fps)\
 685      * - encoding: unused\
 686      * - decoding: Set by libavcodec.\
 687      */\
 688     int repeat_pict;\
 689     \
 690     /**\
 691      * \
 692      */\
 693     int qscale_type;\
 694     \
 695     /**\
 696      * The content of the picture is interlaced.\
 697      * - encoding: Set by user.\
 698      * - decoding: Set by libavcodec. (default 0)\
 699      */\
 700     int interlaced_frame;\
 701     \
 702     /**\
 703      * If the content is interlaced, is top field displayed first.\
 704      * - encoding: Set by user.\
 705      * - decoding: Set by libavcodec.\
 706      */\
 707     int top_field_first;\
 708     \
 709     /**\
 710      * Pan scan.\
 711      * - encoding: Set by user.\
 712      * - decoding: Set by libavcodec.\
 713      */\
 714     AVPanScan *pan_scan;\
 715     \
 716     /**\
 717      * Tell user application that palette has changed from previous frame.\
 718      * - encoding: ??? (no palette-enabled encoder yet)\
 719      * - decoding: Set by libavcodec. (default 0).\
 720      */\
 721     int palette_has_changed;\
 722     \
 723     /**\
 724      * codec suggestion on buffer type if != 0\
 725      * - encoding: unused\
 726      * - decoding: Set by libavcodec. (before get_buffer() call)).\
 727      */\
 728     int buffer_hints;\
 729 \
 730     /**\
 731      * DCT coefficients\
 732      * - encoding: unused\
 733      * - decoding: Set by libavcodec.\
 734      */\
 735     short *dct_coeff;\
 736 \
 737     /**\
 738      * motion referece frame index\
 739      * - encoding: Set by user.\
 740      * - decoding: Set by libavcodec.\
 741      */\
 742     int8_t *ref_index[2];
 743
 744 #define FF_QSCALE_TYPE_MPEG1 0
 745 #define FF_QSCALE_TYPE_MPEG2 1
 746 #define FF_QSCALE_TYPE_H264  2
 747
 748 #define FF_BUFFER_TYPE_INTERNAL 1
 749 #define FF_BUFFER_TYPE_USER     2 ///< direct rendering buffers (image is (de)allocated by user)
 750 #define FF_BUFFER_TYPE_SHARED   4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
 751 #define FF_BUFFER_TYPE_COPY     8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
 752
 753
 754 #define FF_I_TYPE  1 // Intra
 755 #define FF_P_TYPE  2 // Predicted
 756 #define FF_B_TYPE  3 // Bi-dir predicted
 757 #define FF_S_TYPE  4 // S(GMC)-VOP MPEG4
 758 #define FF_SI_TYPE 5
 759 #define FF_SP_TYPE 6
 760
 761 #define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
 762 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
 763 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
 764 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
 765
 766 /**
 767  * Audio Video Frame.
 768  * New fields can be added to the end of FF_COMMON_FRAME with minor version
 769  * bumps.
 770  * Removal, reordering and changes to existing fields require a major
 771  * version bump. No fields should be added into AVFrame before or after
 772  * FF_COMMON_FRAME!
 773  * sizeof(AVFrame) must not be used outside libav*.
 774  */
 775 typedef struct AVFrame {
 776     FF_COMMON_FRAME
 777 } AVFrame;
 778
 779 #define DEFAULT_FRAME_RATE_BASE 1001000
 780
 781 /**
 782  * main external API structure.
 783  * New fields can be added to the end with minor version bumps.
 784  * Removal, reordering and changes to existing fields require a major
 785  * version bump.
 786  * sizeof(AVCodecContext) must not be used outside libav*.
 787  */
 788 typedef struct AVCodecContext {
 789     /**
 790      * information on struct for av_log
 791      * - set by avcodec_alloc_context
 792      */
 793     AVClass *av_class;
 794     /**
 795      * the average bitrate
 796      * - encoding: Set by user; unused for constant quantizer encoding.
 797      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
 798      */
 799     int bit_rate;
 800
 801     /**
 802      * number of bits the bitstream is allowed to diverge from the reference.
 803      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
 804      * - encoding: Set by user; unused for constant quantizer encoding.
 805      * - decoding: unused
 806      */
 807     int bit_rate_tolerance;
 808
 809     /**
 810      * CODEC_FLAG_*.
 811      * - encoding: Set by user.
 812      * - decoding: Set by user.
 813      */
 814     int flags;
 815
 816     /**
 817      * Some codecs need additional format info. It is stored here.
 818      * If any muxer uses this then ALL demuxers/parsers AND encoders for the
 819      * specific codec MUST set it correctly otherwise stream copy breaks.
 820      * In general use of this field by muxers is not recommanded.
 821      * - encoding: Set by libavcodec.
 822      * - decoding: Set by libavcodec. (FIXME: Is this OK?)
 823      */
 824     int sub_id;
 825
 826     /**
 827      * Motion estimation algorithm used for video coding.
 828      * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
 829      * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
 830      * - encoding: MUST be set by user.
 831      * - decoding: unused
 832      */
 833     int me_method;
 834
 835     /**
 836      * some codecs need / can use extradata like Huffman tables.
 837      * mjpeg: Huffman tables
 838      * rv10: additional flags
 839      * mpeg4: global headers (they can be in the bitstream or here)
 840      * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
 841      * than extradata_size to avoid prolems if it is read with the bitstream reader.
 842      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
 843      * - encoding: Set/allocated/freed by libavcodec.
 844      * - decoding: Set/allocated/freed by user.
 845      */
 846     uint8_t *extradata;
 847     int extradata_size;
 848
 849     /**
 850      * This is the fundamental unit of time (in seconds) in terms
 851      * of which frame timestamps are represented. For fixed-fps content,
 852      * timebase should be 1/framerate and timestamp increments should be
 853      * identically 1.
 854      * - encoding: MUST be set by user.
 855      * - decoding: Set by libavcodec.
 856      */
 857     AVRational time_base;
 858
 859     /* video only */
 860     /**
 861      * picture width / height.
 862      * - encoding: MUST be set by user.
 863      * - decoding: Set by libavcodec.
 864      * Note: For compatibility it is possible to set this instead of
 865      * coded_width/height before decoding.
 866      */
 867     int width, height;
 868
 869 #define FF_ASPECT_EXTENDED 15
 870
 871     /**
 872      * the number of pictures in a group of pictures, or 0 for intra_only
 873      * - encoding: Set by user.
 874      * - decoding: unused
 875      */
 876     int gop_size;
 877
 878     /**
 879      * Pixel format, see PIX_FMT_xxx.
 880      * - encoding: Set by user.
 881      * - decoding: Set by libavcodec.
 882      */
 883     enum PixelFormat pix_fmt;
 884
 885     /**
 886      * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
 887      * has to read frames at native frame rate.
 888      * - encoding: Set by user.
 889      * - decoding: unused
 890      */
 891     int rate_emu;
 892
 893     /**
 894      * If non NULL, 'draw_horiz_band' is called by the libavcodec
 895      * decoder to draw a horizontal band. It improves cache usage. Not
 896      * all codecs can do that. You must check the codec capabilities
 897      * beforehand.
 898      * - encoding: unused
 899      * - decoding: Set by user.
 900      * @param height the height of the slice
 901      * @param y the y position of the slice
 902      * @param type 1->top field, 2->bottom field, 3->frame
 903      * @param offset offset into the AVFrame.data from which the slice should be read
 904      */
 905     void (*draw_horiz_band)(struct AVCodecContext *s,
 906                             const AVFrame *src, int offset[4],
 907                             int y, int type, int height);
 908
 909     /* audio only */
 910     int sample_rate; ///< samples per second
 911     int channels;
 912
 913     /**
 914      * audio sample format
 915      * - encoding: Set by user.
 916      * - decoding: Set by libavcodec.
 917      */
 918     enum SampleFormat sample_fmt;  ///< sample format, currently unused
 919
 920     /* The following data should not be initialized. */
 921     /**
 922      * Samples per packet, initialized when calling 'init'.
 923      */
 924     int frame_size;
 925     int frame_number;   ///< audio or video frame number
 926     int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
 927
 928     /**
 929      * Number of frames the decoded output will be delayed relative to
 930      * the encoded input.
 931      * - encoding: Set by libavcodec.
 932      * - decoding: unused
 933      */
 934     int delay;
 935
 936     /* - encoding parameters */
 937     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
 938     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
 939
 940     /**
 941      * minimum quantizer
 942      * - encoding: Set by user.
 943      * - decoding: unused
 944      */
 945     int qmin;
 946
 947     /**
 948      * maximum quantizer
 949      * - encoding: Set by user.
 950      * - decoding: unused
 951      */
 952     int qmax;
 953
 954     /**
 955      * maximum quantizer difference between frames
 956      * - encoding: Set by user.
 957      * - decoding: unused
 958      */
 959     int max_qdiff;
 960
 961     /**
 962      * maximum number of B-frames between non-B-frames
 963      * Note: The output will be delayed by max_b_frames+1 relative to the input.
 964      * - encoding: Set by user.
 965      * - decoding: unused
 966      */
 967     int max_b_frames;
 968
 969     /**
 970      * qscale factor between IP and B-frames
 971      * - encoding: Set by user.
 972      * - decoding: unused
 973      */
 974     float b_quant_factor;
 975
 976     /** obsolete FIXME remove */
 977     int rc_strategy;
 978 #define FF_RC_STRATEGY_XVID 1
 979
 980     int b_frame_strategy;
 981
 982     /**
 983      * hurry up amount
 984      * - encoding: unused
 985      * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
 986      * @deprecated Deprecated in favor of skip_idct and skip_frame.
 987      */
 988     int hurry_up;
 989
 990     struct AVCodec *codec;
 991
 992     void *priv_data;
 993
 994 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
 995     /* unused, FIXME remove*/
 996     int rtp_mode;
 997 #endif
 998
 999     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1000                             /* do its best to deliver a chunk with size     */
1001                             /* below rtp_payload_size, the chunk will start */
1002                             /* with a start code on some codecs like H.263. */
1003                             /* This doesn't take account of any particular  */
1004                             /* headers inside the transmitted RTP payload.  */
1005
1006
1007     /* The RTP callback: This function is called    */
1008     /* every time the encoder has a packet to send. */
1009     /* It depends on the encoder if the data starts */
1010     /* with a Start Code (it should). H.263 does.   */
1011     /* mb_nb contains the number of macroblocks     */
1012     /* encoded in the RTP payload.                  */
1013     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1014
1015     /* statistics, used for 2-pass encoding */
1016     int mv_bits;
1017     int header_bits;
1018     int i_tex_bits;
1019     int p_tex_bits;
1020     int i_count;
1021     int p_count;
1022     int skip_count;
1023     int misc_bits;
1024
1025     /**
1026      * number of bits used for the previously encoded frame
1027      * - encoding: Set by libavcodec.
1028      * - decoding: unused
1029      */
1030     int frame_bits;
1031
1032     /**
1033      * Private data of the user, can be used to carry app specific stuff.
1034      * - encoding: Set by user.
1035      * - decoding: Set by user.
1036      */
1037     void *opaque;
1038
1039     char codec_name[32];
1040     enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1041     enum CodecID codec_id; /* see CODEC_ID_xxx */
1042
1043     /**
1044      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1045      * This is used to work around some encoder bugs.
1046      * A demuxer should set this to what is stored in the field used to identify the codec.
1047      * If there are multiple such fields in a container then the demuxer should choose the one
1048      * which maximizes the information about the used codec.
1049      * If the codec tag field in a container is larger then 32 bits then the demuxer should
1050      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1051      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1052      * first.
1053      * - encoding: Set by user, if not then the default based on codec_id will be used.
1054      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1055      */
1056     unsigned int codec_tag;
1057
1058     /**
1059      * Work around bugs in encoders which sometimes cannot be detected automatically.
1060      * - encoding: Set by user
1061      * - decoding: Set by user
1062      */
1063     int workaround_bugs;
1064 #define FF_BUG_AUTODETECT       1  ///< autodetection
1065 #define FF_BUG_OLD_MSMPEG4      2
1066 #define FF_BUG_XVID_ILACE       4
1067 #define FF_BUG_UMP4             8
1068 #define FF_BUG_NO_PADDING       16
1069 #define FF_BUG_AMV              32
1070 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1071 #define FF_BUG_QPEL_CHROMA      64
1072 #define FF_BUG_STD_QPEL         128
1073 #define FF_BUG_QPEL_CHROMA2     256
1074 #define FF_BUG_DIRECT_BLOCKSIZE 512
1075 #define FF_BUG_EDGE             1024
1076 #define FF_BUG_HPEL_CHROMA      2048
1077 #define FF_BUG_DC_CLIP          4096
1078 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1079 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1080
1081     /**
1082      * luma single coefficient elimination threshold
1083      * - encoding: Set by user.
1084      * - decoding: unused
1085      */
1086     int luma_elim_threshold;
1087
1088     /**
1089      * chroma single coeff elimination threshold
1090      * - encoding: Set by user.
1091      * - decoding: unused
1092      */
1093     int chroma_elim_threshold;
1094
1095     /**
1096      * strictly follow the standard (MPEG4, ...).
1097      * - encoding: Set by user.
1098      * - decoding: unused
1099      */
1100     int strict_std_compliance;
1101 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to a older more strict version of the spec or reference software.
1102 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1103 #define FF_COMPLIANCE_NORMAL        0
1104 #define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
1105 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1106
1107     /**
1108      * qscale offset between IP and B-frames
1109      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1110      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1111      * - encoding: Set by user.
1112      * - decoding: unused
1113      */
1114     float b_quant_offset;
1115
1116     /**
1117      * Error resilience; higher values will detect more errors but may
1118      * misdetect some more or less valid parts as errors.
1119      * - encoding: unused
1120      * - decoding: Set by user.
1121      */
1122     int error_resilience;
1123 #define FF_ER_CAREFUL         1
1124 #define FF_ER_COMPLIANT       2
1125 #define FF_ER_AGGRESSIVE      3
1126 #define FF_ER_VERY_AGGRESSIVE 4
1127
1128     /**
1129      * Called at the beginning of each frame to get a buffer for it.
1130      * If pic.reference is set then the frame will be read later by libavcodec.
1131      * avcodec_align_dimensions() should be used to find the required width and
1132      * height, as they normally need to be rounded up to the next multiple of 16.
1133      * - encoding: unused
1134      * - decoding: Set by libavcodec., user can override.
1135      */
1136     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1137
1138     /**
1139      * Called to release buffers which where allocated with get_buffer.
1140      * A released buffer can be reused in get_buffer().
1141      * pic.data[*] must be set to NULL.
1142      * - encoding: unused
1143      * - decoding: Set by libavcodec., user can override.
1144      */
1145     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1146
1147     /**
1148      * If 1 the stream has a 1 frame delay during decoding.
1149      * - encoding: Set by libavcodec.
1150      * - decoding: Set by libavcodec.
1151      */
1152     int has_b_frames;
1153
1154     /**
1155      * number of bytes per packet if constant and known or 0
1156      * Used by some WAV based audio codecs.
1157      */
1158     int block_align;
1159
1160     int parse_only; /* - decoding only: If true, only parsing is done
1161                        (function avcodec_parse_frame()). The frame
1162                        data is returned. Only MPEG codecs support this now. */
1163
1164     /**
1165      * 0-> h263 quant 1-> mpeg quant
1166      * - encoding: Set by user.
1167      * - decoding: unused
1168      */
1169     int mpeg_quant;
1170
1171     /**
1172      * pass1 encoding statistics output buffer
1173      * - encoding: Set by libavcodec.
1174      * - decoding: unused
1175      */
1176     char *stats_out;
1177
1178     /**
1179      * pass2 encoding statistics input buffer
1180      * Concatenated stuff from stats_out of pass1 should be placed here.
1181      * - encoding: Allocated/set/freed by user.
1182      * - decoding: unused
1183      */
1184     char *stats_in;
1185
1186     /**
1187      * ratecontrol qmin qmax limiting method
1188      * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1189      * - encoding: Set by user.
1190      * - decoding: unused
1191      */
1192     float rc_qsquish;
1193
1194     float rc_qmod_amp;
1195     int rc_qmod_freq;
1196
1197     /**
1198      * ratecontrol override, see RcOverride
1199      * - encoding: Allocated/set/freed by user.
1200      * - decoding: unused
1201      */
1202     RcOverride *rc_override;
1203     int rc_override_count;
1204
1205     /**
1206      * rate control equation
1207      * - encoding: Set by user
1208      * - decoding: unused
1209      */
1210     const char *rc_eq;
1211
1212     /**
1213      * maximum bitrate
1214      * - encoding: Set by user.
1215      * - decoding: unused
1216      */
1217     int rc_max_rate;
1218
1219     /**
1220      * minimum bitrate
1221      * - encoding: Set by user.
1222      * - decoding: unused
1223      */
1224     int rc_min_rate;
1225
1226     /**
1227      * decoder bitstream buffer size
1228      * - encoding: Set by user.
1229      * - decoding: unused
1230      */
1231     int rc_buffer_size;
1232     float rc_buffer_aggressivity;
1233
1234     /**
1235      * qscale factor between P and I-frames
1236      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1237      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1238      * - encoding: Set by user.
1239      * - decoding: unused
1240      */
1241     float i_quant_factor;
1242
1243     /**
1244      * qscale offset between P and I-frames
1245      * - encoding: Set by user.
1246      * - decoding: unused
1247      */
1248     float i_quant_offset;
1249
1250     /**
1251      * initial complexity for pass1 ratecontrol
1252      * - encoding: Set by user.
1253      * - decoding: unused
1254      */
1255     float rc_initial_cplx;
1256
1257     /**
1258      * DCT algorithm, see FF_DCT_* below
1259      * - encoding: Set by user.
1260      * - decoding: unused
1261      */
1262     int dct_algo;
1263 #define FF_DCT_AUTO    0
1264 #define FF_DCT_FASTINT 1
1265 #define FF_DCT_INT     2
1266 #define FF_DCT_MMX     3
1267 #define FF_DCT_MLIB    4
1268 #define FF_DCT_ALTIVEC 5
1269 #define FF_DCT_FAAN    6
1270
1271     /**
1272      * luminance masking (0-> disabled)
1273      * - encoding: Set by user.
1274      * - decoding: unused
1275      */
1276     float lumi_masking;
1277
1278     /**
1279      * temporary complexity masking (0-> disabled)
1280      * - encoding: Set by user.
1281      * - decoding: unused
1282      */
1283     float temporal_cplx_masking;
1284
1285     /**
1286      * spatial complexity masking (0-> disabled)
1287      * - encoding: Set by user.
1288      * - decoding: unused
1289      */
1290     float spatial_cplx_masking;
1291
1292     /**
1293      * p block masking (0-> disabled)
1294      * - encoding: Set by user.
1295      * - decoding: unused
1296      */
1297     float p_masking;
1298
1299     /**
1300      * darkness masking (0-> disabled)
1301      * - encoding: Set by user.
1302      * - decoding: unused
1303      */
1304     float dark_masking;
1305
1306
1307 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1308     /* for binary compatibility */
1309     int unused;
1310 #endif
1311
1312     /**
1313      * IDCT algorithm, see FF_IDCT_* below.
1314      * - encoding: Set by user.
1315      * - decoding: Set by user.
1316      */
1317     int idct_algo;
1318 #define FF_IDCT_AUTO          0
1319 #define FF_IDCT_INT           1
1320 #define FF_IDCT_SIMPLE        2
1321 #define FF_IDCT_SIMPLEMMX     3
1322 #define FF_IDCT_LIBMPEG2MMX   4
1323 #define FF_IDCT_PS2           5
1324 #define FF_IDCT_MLIB          6
1325 #define FF_IDCT_ARM           7
1326 #define FF_IDCT_ALTIVEC       8
1327 #define FF_IDCT_SH4           9
1328 #define FF_IDCT_SIMPLEARM     10
1329 #define FF_IDCT_H264          11
1330 #define FF_IDCT_VP3           12
1331 #define FF_IDCT_IPP           13
1332 #define FF_IDCT_XVIDMMX       14
1333 #define FF_IDCT_CAVS          15
1334 #define FF_IDCT_SIMPLEARMV5TE 16
1335 #define FF_IDCT_SIMPLEARMV6   17
1336 #define FF_IDCT_SIMPLEVIS     18
1337 #define FF_IDCT_WMV2          19
1338 #define FF_IDCT_FAAN          20
1339
1340     /**
1341      * slice count
1342      * - encoding: Set by libavcodec.
1343      * - decoding: Set by user (or 0).
1344      */
1345     int slice_count;
1346     /**
1347      * slice offsets in the frame in bytes
1348      * - encoding: Set/allocated by libavcodec.
1349      * - decoding: Set/allocated by user (or NULL).
1350      */
1351     int *slice_offset;
1352
1353     /**
1354      * error concealment flags
1355      * - encoding: unused
1356      * - decoding: Set by user.
1357      */
1358     int error_concealment;
1359 #define FF_EC_GUESS_MVS   1
1360 #define FF_EC_DEBLOCK     2
1361
1362     /**
1363      * dsp_mask could be add used to disable unwanted CPU features
1364      * CPU features (i.e. MMX, SSE. ...)
1365      *
1366      * With the FORCE flag you may instead enable given CPU features.
1367      * (Dangerous: Usable in case of misdetection, improper usage however will
1368      * result into program crash.)
1369      */
1370     unsigned dsp_mask;
1371 #define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
1372     /* lower 16 bits - CPU features */
1373 #define FF_MM_MMX      0x0001 ///< standard MMX
1374 #define FF_MM_3DNOW    0x0004 ///< AMD 3DNOW
1375 #define FF_MM_MMXEXT   0x0002 ///< SSE integer functions or AMD MMX ext
1376 #define FF_MM_SSE      0x0008 ///< SSE functions
1377 #define FF_MM_SSE2     0x0010 ///< PIV SSE2 functions
1378 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1379 #define FF_MM_SSE3     0x0040 ///< Prescott SSE3 functions
1380 #define FF_MM_SSSE3    0x0080 ///< Conroe SSSE3 functions
1381 #define FF_MM_IWMMXT   0x0100 ///< XScale IWMMXT
1382
1383     /**
1384      * bits per sample/pixel from the demuxer (needed for huffyuv).
1385      * - encoding: Set by libavcodec.
1386      * - decoding: Set by user.
1387      */
1388      int bits_per_sample;
1389
1390     /**
1391      * prediction method (needed for huffyuv)
1392      * - encoding: Set by user.
1393      * - decoding: unused
1394      */
1395      int prediction_method;
1396 #define FF_PRED_LEFT   0
1397 #define FF_PRED_PLANE  1
1398 #define FF_PRED_MEDIAN 2
1399
1400     /**
1401      * sample aspect ratio (0 if unknown)
1402      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1403      * - encoding: Set by user.
1404      * - decoding: Set by libavcodec.
1405      */
1406     AVRational sample_aspect_ratio;
1407
1408     /**
1409      * the picture in the bitstream
1410      * - encoding: Set by libavcodec.
1411      * - decoding: Set by libavcodec.
1412      */
1413     AVFrame *coded_frame;
1414
1415     /**
1416      * debug
1417      * - encoding: Set by user.
1418      * - decoding: Set by user.
1419      */
1420     int debug;
1421 #define FF_DEBUG_PICT_INFO   1
1422 #define FF_DEBUG_RC          2
1423 #define FF_DEBUG_BITSTREAM   4
1424 #define FF_DEBUG_MB_TYPE     8
1425 #define FF_DEBUG_QP          16
1426 #define FF_DEBUG_MV          32
1427 #define FF_DEBUG_DCT_COEFF   0x00000040
1428 #define FF_DEBUG_SKIP        0x00000080
1429 #define FF_DEBUG_STARTCODE   0x00000100
1430 #define FF_DEBUG_PTS         0x00000200
1431 #define FF_DEBUG_ER          0x00000400
1432 #define FF_DEBUG_MMCO        0x00000800
1433 #define FF_DEBUG_BUGS        0x00001000
1434 #define FF_DEBUG_VIS_QP      0x00002000
1435 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1436
1437     /**
1438      * debug
1439      * - encoding: Set by user.
1440      * - decoding: Set by user.
1441      */
1442     int debug_mv;
1443 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1444 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1445 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1446
1447     /**
1448      * error
1449      * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1450      * - decoding: unused
1451      */
1452     uint64_t error[4];
1453
1454     /**
1455      * minimum MB quantizer
1456      * - encoding: unused
1457      * - decoding: unused
1458      */
1459     int mb_qmin;
1460
1461     /**
1462      * maximum MB quantizer
1463      * - encoding: unused
1464      * - decoding: unused
1465      */
1466     int mb_qmax;
1467
1468     /**
1469      * motion estimation comparison function
1470      * - encoding: Set by user.
1471      * - decoding: unused
1472      */
1473     int me_cmp;
1474     /**
1475      * subpixel motion estimation comparison function
1476      * - encoding: Set by user.
1477      * - decoding: unused
1478      */
1479     int me_sub_cmp;
1480     /**
1481      * macroblock comparison function (not supported yet)
1482      * - encoding: Set by user.
1483      * - decoding: unused
1484      */
1485     int mb_cmp;
1486     /**
1487      * interlaced DCT comparison function
1488      * - encoding: Set by user.
1489      * - decoding: unused
1490      */
1491     int ildct_cmp;
1492 #define FF_CMP_SAD    0
1493 #define FF_CMP_SSE    1
1494 #define FF_CMP_SATD   2
1495 #define FF_CMP_DCT    3
1496 #define FF_CMP_PSNR   4
1497 #define FF_CMP_BIT    5
1498 #define FF_CMP_RD     6
1499 #define FF_CMP_ZERO   7
1500 #define FF_CMP_VSAD   8
1501 #define FF_CMP_VSSE   9
1502 #define FF_CMP_NSSE   10
1503 #define FF_CMP_W53    11
1504 #define FF_CMP_W97    12
1505 #define FF_CMP_DCTMAX 13
1506 #define FF_CMP_DCT264 14
1507 #define FF_CMP_CHROMA 256
1508
1509     /**
1510      * ME diamond size & shape
1511      * - encoding: Set by user.
1512      * - decoding: unused
1513      */
1514     int dia_size;
1515
1516     /**
1517      * amount of previous MV predictors (2a+1 x 2a+1 square)
1518      * - encoding: Set by user.
1519      * - decoding: unused
1520      */
1521     int last_predictor_count;
1522
1523     /**
1524      * prepass for motion estimation
1525      * - encoding: Set by user.
1526      * - decoding: unused
1527      */
1528     int pre_me;
1529
1530     /**
1531      * motion estimation prepass comparison function
1532      * - encoding: Set by user.
1533      * - decoding: unused
1534      */
1535     int me_pre_cmp;
1536
1537     /**
1538      * ME prepass diamond size & shape
1539      * - encoding: Set by user.
1540      * - decoding: unused
1541      */
1542     int pre_dia_size;
1543
1544     /**
1545      * subpel ME quality
1546      * - encoding: Set by user.
1547      * - decoding: unused
1548      */
1549     int me_subpel_quality;
1550
1551     /**
1552      * callback to negotiate the pixelFormat
1553      * @param fmt is the list of formats which are supported by the codec,
1554      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1555      * The first is always the native one.
1556      * @return the chosen format
1557      * - encoding: unused
1558      * - decoding: Set by user, if not set the native format will be chosen.
1559      */
1560     enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1561
1562     /**
1563      * DTG active format information (additional aspect ratio
1564      * information only used in DVB MPEG-2 transport streams)
1565      * 0 if not set.
1566      *
1567      * - encoding: unused
1568      * - decoding: Set by decoder.
1569      */
1570     int dtg_active_format;
1571 #define FF_DTG_AFD_SAME         8
1572 #define FF_DTG_AFD_4_3          9
1573 #define FF_DTG_AFD_16_9         10
1574 #define FF_DTG_AFD_14_9         11
1575 #define FF_DTG_AFD_4_3_SP_14_9  13
1576 #define FF_DTG_AFD_16_9_SP_14_9 14
1577 #define FF_DTG_AFD_SP_4_3       15
1578
1579     /**
1580      * maximum motion estimation search range in subpel units
1581      * If 0 then no limit.
1582      *
1583      * - encoding: Set by user.
1584      * - decoding: unused
1585      */
1586     int me_range;
1587
1588     /**
1589      * intra quantizer bias
1590      * - encoding: Set by user.
1591      * - decoding: unused
1592      */
1593     int intra_quant_bias;
1594 #define FF_DEFAULT_QUANT_BIAS 999999
1595
1596     /**
1597      * inter quantizer bias
1598      * - encoding: Set by user.
1599      * - decoding: unused
1600      */
1601     int inter_quant_bias;
1602
1603     /**
1604      * color table ID
1605      * - encoding: unused
1606      * - decoding: Which clrtable should be used for 8bit RGB images.
1607      *             Tables have to be stored somewhere. FIXME
1608      */
1609     int color_table_id;
1610
1611     /**
1612      * internal_buffer count
1613      * Don't touch, used by libavcodec default_get_buffer().
1614      */
1615     int internal_buffer_count;
1616
1617     /**
1618      * internal_buffers
1619      * Don't touch, used by libavcodec default_get_buffer().
1620      */
1621     void *internal_buffer;
1622
1623 #define FF_LAMBDA_SHIFT 7
1624 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1625 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1626 #define FF_LAMBDA_MAX (256*128-1)
1627
1628 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1629     /**
1630      * Global quality for codecs which cannot change it per frame.
1631      * This should be proportional to MPEG-1/2/4 qscale.
1632      * - encoding: Set by user.
1633      * - decoding: unused
1634      */
1635     int global_quality;
1636
1637 #define FF_CODER_TYPE_VLC       0
1638 #define FF_CODER_TYPE_AC        1
1639 #define FF_CODER_TYPE_RAW       2
1640 #define FF_CODER_TYPE_RLE       3
1641 #define FF_CODER_TYPE_DEFLATE   4
1642     /**
1643      * coder type
1644      * - encoding: Set by user.
1645      * - decoding: unused
1646      */
1647     int coder_type;
1648
1649     /**
1650      * context model
1651      * - encoding: Set by user.
1652      * - decoding: unused
1653      */
1654     int context_model;
1655 #if 0
1656     /**
1657      *
1658      * - encoding: unused
1659      * - decoding: Set by user.
1660      */
1661     uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1662 #endif
1663
1664     /**
1665      * slice flags
1666      * - encoding: unused
1667      * - decoding: Set by user.
1668      */
1669     int slice_flags;
1670 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1671 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1672 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1673
1674     /**
1675      * XVideo Motion Acceleration
1676      * - encoding: forbidden
1677      * - decoding: set by decoder
1678      */
1679     int xvmc_acceleration;
1680
1681     /**
1682      * macroblock decision mode
1683      * - encoding: Set by user.
1684      * - decoding: unused
1685      */
1686     int mb_decision;
1687 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1688 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1689 #define FF_MB_DECISION_RD     2        ///< rate distoration
1690
1691     /**
1692      * custom intra quantization matrix
1693      * - encoding: Set by user, can be NULL.
1694      * - decoding: Set by libavcodec.
1695      */
1696     uint16_t *intra_matrix;
1697
1698     /**
1699      * custom inter quantization matrix
1700      * - encoding: Set by user, can be NULL.
1701      * - decoding: Set by libavcodec.
1702      */
1703     uint16_t *inter_matrix;
1704
1705     /**
1706      * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1707      * This is used to work around some encoder bugs.
1708      * - encoding: unused
1709      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1710      */
1711     unsigned int stream_codec_tag;
1712
1713     /**
1714      * scene change detection threshold
1715      * 0 is default, larger means fewer detected scene changes.
1716      * - encoding: Set by user.
1717      * - decoding: unused
1718      */
1719     int scenechange_threshold;
1720
1721     /**
1722      * minimum Lagrange multipler
1723      * - encoding: Set by user.
1724      * - decoding: unused
1725      */
1726     int lmin;
1727
1728     /**
1729      * maximum Lagrange multipler
1730      * - encoding: Set by user.
1731      * - decoding: unused
1732      */
1733     int lmax;
1734
1735     /**
1736      * palette control structure
1737      * - encoding: ??? (no palette-enabled encoder yet)
1738      * - decoding: Set by user.
1739      */
1740     struct AVPaletteControl *palctrl;
1741
1742     /**
1743      * noise reduction strength
1744      * - encoding: Set by user.
1745      * - decoding: unused
1746      */
1747     int noise_reduction;
1748
1749     /**
1750      * Called at the beginning of a frame to get cr buffer for it.
1751      * Buffer type (size, hints) must be the same. libavcodec won't check it.
1752      * libavcodec will pass previous buffer in pic, function should return
1753      * same buffer or new buffer with old frame "painted" into it.
1754      * If pic.data[0] == NULL must behave like get_buffer().
1755      * - encoding: unused
1756      * - decoding: Set by libavcodec., user can override
1757      */
1758     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1759
1760     /**
1761      * Number of bits which should be loaded into the rc buffer before decoding starts.
1762      * - encoding: Set by user.
1763      * - decoding: unused
1764      */
1765     int rc_initial_buffer_occupancy;
1766
1767     /**
1768      *
1769      * - encoding: Set by user.
1770      * - decoding: unused
1771      */
1772     int inter_threshold;
1773
1774     /**
1775      * CODEC_FLAG2_*
1776      * - encoding: Set by user.
1777      * - decoding: Set by user.
1778      */
1779     int flags2;
1780
1781     /**
1782      * Simulates errors in the bitstream to test error concealment.
1783      * - encoding: Set by user.
1784      * - decoding: unused
1785      */
1786     int error_rate;
1787
1788     /**
1789      * MP3 antialias algorithm, see FF_AA_* below.
1790      * - encoding: unused
1791      * - decoding: Set by user.
1792      */
1793     int antialias_algo;
1794 #define FF_AA_AUTO    0
1795 #define FF_AA_FASTINT 1 //not implemented yet
1796 #define FF_AA_INT     2
1797 #define FF_AA_FLOAT   3
1798     /**
1799      * quantizer noise shaping
1800      * - encoding: Set by user.
1801      * - decoding: unused
1802      */
1803     int quantizer_noise_shaping;
1804
1805     /**
1806      * thread count
1807      * is used to decide how many independent tasks should be passed to execute()
1808      * - encoding: Set by user.
1809      * - decoding: Set by user.
1810      */
1811     int thread_count;
1812
1813     /**
1814      * The codec may call this to execute several independent things.
1815      * It will return only after finishing all tasks.
1816      * The user may replace this with some multithreaded implementation,
1817      * the default implementation will execute the parts serially.
1818      * @param count the number of things to execute
1819      * - encoding: Set by libavcodec, user can override.
1820      * - decoding: Set by libavcodec, user can override.
1821      */
1822     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1823
1824     /**
1825      * thread opaque
1826      * Can be used by execute() to store some per AVCodecContext stuff.
1827      * - encoding: set by execute()
1828      * - decoding: set by execute()
1829      */
1830     void *thread_opaque;
1831
1832     /**
1833      * Motion estimation threshold below which no motion estimation is
1834      * performed, but instead the user specified motion vectors are used.
1835      *
1836      * - encoding: Set by user.
1837      * - decoding: unused
1838      */
1839      int me_threshold;
1840
1841     /**
1842      * Macroblock threshold below which the user specified macroblock types will be used.
1843      * - encoding: Set by user.
1844      * - decoding: unused
1845      */
1846      int mb_threshold;
1847
1848     /**
1849      * precision of the intra DC coefficient - 8
1850      * - encoding: Set by user.
1851      * - decoding: unused
1852      */
1853      int intra_dc_precision;
1854
1855     /**
1856      * noise vs. sse weight for the nsse comparsion function
1857      * - encoding: Set by user.
1858      * - decoding: unused
1859      */
1860      int nsse_weight;
1861
1862     /**
1863      * Number of macroblock rows at the top which are skipped.
1864      * - encoding: unused
1865      * - decoding: Set by user.
1866      */
1867      int skip_top;
1868
1869     /**
1870      * Number of macroblock rows at the bottom which are skipped.
1871      * - encoding: unused
1872      * - decoding: Set by user.
1873      */
1874      int skip_bottom;
1875
1876     /**
1877      * profile
1878      * - encoding: Set by user.
1879      * - decoding: Set by libavcodec.
1880      */
1881      int profile;
1882 #define FF_PROFILE_UNKNOWN -99
1883 #define FF_PROFILE_AAC_MAIN 0
1884 #define FF_PROFILE_AAC_LOW  1
1885 #define FF_PROFILE_AAC_SSR  2
1886 #define FF_PROFILE_AAC_LTP  3
1887
1888     /**
1889      * level
1890      * - encoding: Set by user.
1891      * - decoding: Set by libavcodec.
1892      */
1893      int level;
1894 #define FF_LEVEL_UNKNOWN -99
1895
1896     /**
1897      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1898      * - encoding: unused
1899      * - decoding: Set by user.
1900      */
1901      int lowres;
1902
1903     /**
1904      * Bitstream width / height, may be different from width/height if lowres
1905      * or other things are used.
1906      * - encoding: unused
1907      * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1908      */
1909     int coded_width, coded_height;
1910
1911     /**
1912      * frame skip threshold
1913      * - encoding: Set by user.
1914      * - decoding: unused
1915      */
1916     int frame_skip_threshold;
1917
1918     /**
1919      * frame skip factor
1920      * - encoding: Set by user.
1921      * - decoding: unused
1922      */
1923     int frame_skip_factor;
1924
1925     /**
1926      * frame skip exponent
1927      * - encoding: Set by user.
1928      * - decoding: unused
1929      */
1930     int frame_skip_exp;
1931
1932     /**
1933      * frame skip comparison function
1934      * - encoding: Set by user.
1935      * - decoding: unused
1936      */
1937     int frame_skip_cmp;
1938
1939     /**
1940      * Border processing masking, raises the quantizer for mbs on the borders
1941      * of the picture.
1942      * - encoding: Set by user.
1943      * - decoding: unused
1944      */
1945     float border_masking;
1946
1947     /**
1948      * minimum MB lagrange multipler
1949      * - encoding: Set by user.
1950      * - decoding: unused
1951      */
1952     int mb_lmin;
1953
1954     /**
1955      * maximum MB lagrange multipler
1956      * - encoding: Set by user.
1957      * - decoding: unused
1958      */
1959     int mb_lmax;
1960
1961     /**
1962      *
1963      * - encoding: Set by user.
1964      * - decoding: unused
1965      */
1966     int me_penalty_compensation;
1967
1968     /**
1969      *
1970      * - encoding: unused
1971      * - decoding: Set by user.
1972      */
1973     enum AVDiscard skip_loop_filter;
1974
1975     /**
1976      *
1977      * - encoding: unused
1978      * - decoding: Set by user.
1979      */
1980     enum AVDiscard skip_idct;
1981
1982     /**
1983      *
1984      * - encoding: unused
1985      * - decoding: Set by user.
1986      */
1987     enum AVDiscard skip_frame;
1988
1989     /**
1990      *
1991      * - encoding: Set by user.
1992      * - decoding: unused
1993      */
1994     int bidir_refine;
1995
1996     /**
1997      *
1998      * - encoding: Set by user.
1999      * - decoding: unused
2000      */
2001     int brd_scale;
2002
2003     /**
2004      * constant rate factor - quality-based VBR - values ~correspond to qps
2005      * - encoding: Set by user.
2006      * - decoding: unused
2007      */
2008     float crf;
2009
2010     /**
2011      * constant quantization parameter rate control method
2012      * - encoding: Set by user.
2013      * - decoding: unused
2014      */
2015     int cqp;
2016
2017     /**
2018      * minimum GOP size
2019      * - encoding: Set by user.
2020      * - decoding: unused
2021      */
2022     int keyint_min;
2023
2024     /**
2025      * number of reference frames
2026      * - encoding: Set by user.
2027      * - decoding: unused
2028      */
2029     int refs;
2030
2031     /**
2032      * chroma qp offset from luma
2033      * - encoding: Set by user.
2034      * - decoding: unused
2035      */
2036     int chromaoffset;
2037
2038     /**
2039      * Influences how often B-frames are used.
2040      * - encoding: Set by user.
2041      * - decoding: unused
2042      */
2043     int bframebias;
2044
2045     /**
2046      * trellis RD quantization
2047      * - encoding: Set by user.
2048      * - decoding: unused
2049      */
2050     int trellis;
2051
2052     /**
2053      * Reduce fluctuations in qp (before curve compression).
2054      * - encoding: Set by user.
2055      * - decoding: unused
2056      */
2057     float complexityblur;
2058
2059     /**
2060      * in-loop deblocking filter alphac0 parameter
2061      * alpha is in the range -6...6
2062      * - encoding: Set by user.
2063      * - decoding: unused
2064      */
2065     int deblockalpha;
2066
2067     /**
2068      * in-loop deblocking filter beta parameter
2069      * beta is in the range -6...6
2070      * - encoding: Set by user.
2071      * - decoding: unused
2072      */
2073     int deblockbeta;
2074
2075     /**
2076      * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2077      * - encoding: Set by user.
2078      * - decoding: unused
2079      */
2080     int partitions;
2081 #define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2082 #define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2083 #define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2084 #define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2085 #define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2086
2087     /**
2088      * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2089      * - encoding: Set by user.
2090      * - decoding: unused
2091      */
2092     int directpred;
2093
2094     /**
2095      * Audio cutoff bandwidth (0 means "automatic")
2096      * - encoding: Set by user.
2097      * - decoding: unused
2098      */
2099     int cutoff;
2100
2101     /**
2102      * Multiplied by qscale for each frame and added to scene_change_score.
2103      * - encoding: Set by user.
2104      * - decoding: unused
2105      */
2106     int scenechange_factor;
2107
2108     /**
2109      *
2110      * Note: Value depends upon the compare function used for fullpel ME.
2111      * - encoding: Set by user.
2112      * - decoding: unused
2113      */
2114     int mv0_threshold;
2115
2116     /**
2117      * Adjusts sensitivity of b_frame_strategy 1.
2118      * - encoding: Set by user.
2119      * - decoding: unused
2120      */
2121     int b_sensitivity;
2122
2123     /**
2124      * - encoding: Set by user.
2125      * - decoding: unused
2126      */
2127     int compression_level;
2128 #define FF_COMPRESSION_DEFAULT -1
2129
2130     /**
2131      * Sets whether to use LPC mode - used by FLAC encoder.
2132      * - encoding: Set by user.
2133      * - decoding: unused
2134      */
2135     int use_lpc;
2136
2137     /**
2138      * LPC coefficient precision - used by FLAC encoder
2139      * - encoding: Set by user.
2140      * - decoding: unused
2141      */
2142     int lpc_coeff_precision;
2143
2144     /**
2145      * - encoding: Set by user.
2146      * - decoding: unused
2147      */
2148     int min_prediction_order;
2149
2150     /**
2151      * - encoding: Set by user.
2152      * - decoding: unused
2153      */
2154     int max_prediction_order;
2155
2156     /**
2157      * search method for selecting prediction order
2158      * - encoding: Set by user.
2159      * - decoding: unused
2160      */
2161     int prediction_order_method;
2162
2163     /**
2164      * - encoding: Set by user.
2165      * - decoding: unused
2166      */
2167     int min_partition_order;
2168
2169     /**
2170      * - encoding: Set by user.
2171      * - decoding: unused
2172      */
2173     int max_partition_order;
2174
2175     /**
2176      * GOP timecode frame start number, in non drop frame format
2177      * - encoding: Set by user.
2178      * - decoding: unused
2179      */
2180     int64_t timecode_frame_start;
2181
2182     /**
2183      * Decoder should decode to this many channels if it can (0 for default)
2184      * - encoding: unused
2185      * - decoding: Set by user.
2186      */
2187     int request_channels;
2188
2189     /**
2190      * Percentage of dynamic range compression to be applied by the decoder.
2191      * The default value is 1.0, corresponding to full compression.
2192      * - encoding: unused
2193      * - decoding: Set by user.
2194      */
2195     float drc_scale;
2196 } AVCodecContext;
2197
2198 /**
2199  * AVCodec.
2200  */
2201 typedef struct AVCodec {
2202     /**
2203      * Name of the codec implementation.
2204      * The name is globally unique among encoders and among decoders (but an
2205      * encoder and a decoder can share the same name).
2206      * This is the primary way to find a codec from the user perspective.
2207      */
2208     const char *name;
2209     enum CodecType type;
2210     enum CodecID id;
2211     int priv_data_size;
2212     int (*init)(AVCodecContext *);
2213     int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2214     int (*close)(AVCodecContext *);
2215     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2216                   const uint8_t *buf, int buf_size);
2217     int capabilities;
2218     struct AVCodec *next;
2219     void (*flush)(AVCodecContext *);
2220     const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
2221     const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
2222 } AVCodec;
2223
2224 /**
2225  * four components are given, that's all.
2226  * the last component is alpha
2227  */
2228 typedef struct AVPicture {
2229     uint8_t *data[4];
2230     int linesize[4];       ///< number of bytes per line
2231 } AVPicture;
2232
2233 /**
2234  * AVPaletteControl
2235  * This structure defines a method for communicating palette changes
2236  * between and demuxer and a decoder.
2237  *
2238  * @deprecated Use AVPacket to send palette changes instead.
2239  * This is totally broken.
2240  */
2241 #define AVPALETTE_SIZE 1024
2242 #define AVPALETTE_COUNT 256
2243 typedef struct AVPaletteControl {
2244
2245     /* Demuxer sets this to 1 to indicate the palette has changed;
2246      * decoder resets to 0. */
2247     int palette_changed;
2248
2249     /* 4-byte ARGB palette entries, stored in native byte order; note that
2250      * the individual palette components should be on a 8-bit scale; if
2251      * the palette data comes from an IBM VGA native format, the component
2252      * data is probably 6 bits in size and needs to be scaled. */
2253     unsigned int palette[AVPALETTE_COUNT];
2254
2255 } AVPaletteControl attribute_deprecated;
2256
2257 typedef struct AVSubtitleRect {
2258     uint16_t x;
2259     uint16_t y;
2260     uint16_t w;
2261     uint16_t h;
2262     uint16_t nb_colors;
2263     int linesize;
2264     uint32_t *rgba_palette;
2265     uint8_t *bitmap;
2266 } AVSubtitleRect;
2267
2268 typedef struct AVSubtitle {
2269     uint16_t format; /* 0 = graphics */
2270     uint32_t start_display_time; /* relative to packet pts, in ms */
2271     uint32_t end_display_time; /* relative to packet pts, in ms */
2272     uint32_t num_rects;
2273     AVSubtitleRect *rects;
2274 } AVSubtitle;
2275
2276
2277 /* resample.c */
2278
2279 struct ReSampleContext;
2280 struct AVResampleContext;
2281
2282 typedef struct ReSampleContext ReSampleContext;
2283
2284 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2285                                      int output_rate, int input_rate);
2286 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2287 void audio_resample_close(ReSampleContext *s);
2288
2289 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2290 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2291 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2292 void av_resample_close(struct AVResampleContext *c);
2293
2294 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2295 /* YUV420 format is assumed ! */
2296
2297 /**
2298  * @deprecated Use the software scaler (swscale) instead.
2299  */
2300 typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2301
2302 /**
2303  * @deprecated Use the software scaler (swscale) instead.
2304  */
2305 attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2306                                       int input_width, int input_height);
2307
2308 /**
2309  * @deprecated Use the software scaler (swscale) instead.
2310  */
2311 attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2312                                       int iwidth, int iheight,
2313                                       int topBand, int bottomBand,
2314                                       int leftBand, int rightBand,
2315                                       int padtop, int padbottom,
2316                                       int padleft, int padright);
2317
2318 /**
2319  * @deprecated Use the software scaler (swscale) instead.
2320  */
2321 attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2322                   AVPicture *output, const AVPicture *input);
2323
2324 /**
2325  * @deprecated Use the software scaler (swscale) instead.
2326  */
2327 attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2328
2329 #endif
2330
2331 /**
2332  * Allocate memory for a picture.  Call avpicture_free to free it.
2333  *
2334  * @param picture the picture to be filled in
2335  * @param pix_fmt the format of the picture
2336  * @param width the width of the picture
2337  * @param height the height of the picture
2338  * @return zero if successful, a negative value if not
2339  */
2340 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2341
2342 /**
2343  * Free a picture previously allocated by avpicture_alloc().
2344  *
2345  * @param picture the AVPicture to be freed
2346  */
2347 void avpicture_free(AVPicture *picture);
2348
2349 /**
2350  * Fill in the AVPicture fields.
2351  * The fields of the given AVPicture are filled in by using the 'ptr' address
2352  * which points to the image data buffer. Depending on the specified picture
2353  * format, one or multiple image data pointers and line sizes will be set.
2354  * If a planar format is specified, several pointers will be set pointing to
2355  * the different picture planes and the line sizes of the different planes
2356  * will be stored in the lines_sizes array.
2357  *
2358  * @param picture AVPicture whose fields are to be filled in
2359  * @param ptr Buffer which will contain or contains the actual image data
2360  * @param pix_fmt The format in which the picture data is stored.
2361  * @param width the width of the image in pixels
2362  * @param height the height of the image in pixels
2363  * @return size of the image data in bytes
2364  */
2365 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2366                    int pix_fmt, int width, int height);
2367 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2368                      unsigned char *dest, int dest_size);
2369
2370 /**
2371  * Calculate the size in bytes that a picture of the given width and height
2372  * would occupy if stored in the given picture format.
2373  *
2374  * @param pix_fmt the given picture format
2375  * @param width the width of the image
2376  * @param height the height of the image
2377  * @return Image data size in bytes
2378  */
2379 int avpicture_get_size(int pix_fmt, int width, int height);
2380 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2381 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2382 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2383 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2384 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2385
2386 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
2387 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
2388 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
2389 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
2390 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
2391 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2392
2393 /**
2394  * Computes what kind of losses will occur when converting from one specific
2395  * pixel format to another.
2396  * When converting from one pixel format to another, information loss may occur.
2397  * For example, when converting from RGB24 to GRAY, the color information will
2398  * be lost. Similarly, other losses occur when converting from some formats to
2399  * other formats. These losses can involve loss of chroma, but also loss of
2400  * resolution, loss of color depth, loss due to the color space conversion, loss
2401  * of the alpha bits or loss due to color quantization.
2402  * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2403  * which will occur when converting from one pixel format to another.
2404  *
2405  * @param[in] dst_pix_fmt destination pixel format
2406  * @param[in] src_pix_fmt source pixel format
2407  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2408  * @return Combination of flags informing you what kind of losses will occur.
2409  */
2410 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2411                              int has_alpha);
2412
2413 /**
2414  * Finds the best pixel format to convert to given a certain source pixel
2415  * format.  When converting from one pixel format to another, information loss
2416  * may occur.  For example, when converting from RGB24 to GRAY, the color
2417  * information will be lost. Similarly, other losses occur when converting from
2418  * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2419  * the given pixel formats should be used to suffer the least amount of loss.
2420  * The pixel formats from which it chooses one, are determined by the
2421  * \p pix_fmt_mask parameter.
2422  *
2423  * @code
2424  * src_pix_fmt = PIX_FMT_YUV420P;
2425  * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2426  * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2427  * @endcode
2428  *
2429  * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2430  * @param[in] src_pix_fmt source pixel format
2431  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2432  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2433  * @return The best pixel format to convert to or -1 if none was found.
2434  */
2435 int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2436                               int has_alpha, int *loss_ptr);
2437
2438
2439 /**
2440  * Print in buf the string corresponding to the pixel format with
2441  * number pix_fmt, or an header if pix_fmt is negative.
2442  *
2443  * @param[in] buf the buffer where to write the string
2444  * @param[in] buf_size the size of buf
2445  * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2446  * a negative value to print the corresponding header.
2447  * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2448  */
2449 void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2450
2451 #define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
2452 #define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2453
2454 /**
2455  * Tell if an image really has transparent alpha values.
2456  * @return ored mask of FF_ALPHA_xxx constants
2457  */
2458 int img_get_alpha_info(const AVPicture *src,
2459                        int pix_fmt, int width, int height);
2460
2461 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2462 /**
2463  * convert among pixel formats
2464  * @deprecated Use the software scaler (swscale) instead.
2465  */
2466 attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2467                 const AVPicture *src, int pix_fmt,
2468                 int width, int height);
2469 #endif
2470
2471 /* deinterlace a picture */
2472 /* deinterlace - if not supported return -1 */
2473 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2474                           int pix_fmt, int width, int height);
2475
2476 /* external high level API */
2477
2478 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2479 extern AVCodec *first_avcodec;
2480 #endif
2481 AVCodec *av_codec_next(AVCodec *c);
2482
2483 /* returns LIBAVCODEC_VERSION_INT constant */
2484 unsigned avcodec_version(void);
2485 /* returns LIBAVCODEC_BUILD constant */
2486 unsigned avcodec_build(void);
2487
2488 /**
2489  * Initializes libavcodec.
2490  *
2491  * @warning This function \e must be called before any other libavcodec
2492  * function.
2493  */
2494 void avcodec_init(void);
2495
2496 void register_avcodec(AVCodec *format);
2497
2498 /**
2499  * Finds a registered encoder with a matching codec ID.
2500  *
2501  * @param id CodecID of the requested encoder
2502  * @return An encoder if one was found, NULL otherwise.
2503  */
2504 AVCodec *avcodec_find_encoder(enum CodecID id);
2505
2506 /**
2507  * Finds a registered encoder with the specified name.
2508  *
2509  * @param name name of the requested encoder
2510  * @return An encoder if one was found, NULL otherwise.
2511  */
2512 AVCodec *avcodec_find_encoder_by_name(const char *name);
2513
2514 /**
2515  * Finds a registered decoder with a matching codec ID.
2516  *
2517  * @param id CodecID of the requested decoder
2518  * @return A decoder if one was found, NULL otherwise.
2519  */
2520 AVCodec *avcodec_find_decoder(enum CodecID id);
2521
2522 /**
2523  * Finds a registered decoder with the specified name.
2524  *
2525  * @param name name of the requested decoder
2526  * @return A decoder if one was found, NULL otherwise.
2527  */
2528 AVCodec *avcodec_find_decoder_by_name(const char *name);
2529 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2530
2531 /**
2532  * Sets the fields of the given AVCodecContext to default values.
2533  *
2534  * @param s The AVCodecContext of which the fields should be set to default values.
2535  */
2536 void avcodec_get_context_defaults(AVCodecContext *s);
2537
2538 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2539  *  we WILL change its arguments and name a few times! */
2540 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2541
2542 /**
2543  * Allocates an AVCodecContext and sets its fields to default values.  The
2544  * resulting struct can be deallocated by simply calling av_free().
2545  *
2546  * @return An AVCodecContext filled with default values or NULL on failure.
2547  * @see avcodec_get_context_defaults
2548  */
2549 AVCodecContext *avcodec_alloc_context(void);
2550
2551 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2552  *  we WILL change its arguments and name a few times! */
2553 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2554
2555 /**
2556  * Sets the fields of the given AVFrame to default values.
2557  *
2558  * @param pic The AVFrame of which the fields should be set to default values.
2559  */
2560 void avcodec_get_frame_defaults(AVFrame *pic);
2561
2562 /**
2563  * Allocates an AVFrame and sets its fields to default values.  The resulting
2564  * struct can be deallocated by simply calling av_free().
2565  *
2566  * @return An AVFrame filled with default values or NULL on failure.
2567  * @see avcodec_get_frame_defaults
2568  */
2569 AVFrame *avcodec_alloc_frame(void);
2570
2571 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2572 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2573 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2574 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2575
2576 /**
2577  * Checks if the given dimension of a picture is valid, meaning that all
2578  * bytes of the picture can be addressed with a signed int.
2579  *
2580  * @param[in] w Width of the picture.
2581  * @param[in] h Height of the picture.
2582  * @return Zero if valid, a negative value if invalid.
2583  */
2584 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2585 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2586
2587 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2588 void avcodec_thread_free(AVCodecContext *s);
2589 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2590 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2591 //FIXME func typedef
2592
2593 /**
2594  * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2595  * function the context has to be allocated.
2596  *
2597  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2598  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2599  * retrieving a codec.
2600  *
2601  * @warning This function is not thread safe!
2602  *
2603  * @code
2604  * avcodec_register_all();
2605  * codec = avcodec_find_decoder(CODEC_ID_H264);
2606  * if (!codec)
2607  *     exit(1);
2608  *
2609  * context = avcodec_alloc_context();
2610  *
2611  * if (avcodec_open(context, codec) < 0)
2612  *     exit(1);
2613  * @endcode
2614  *
2615  * @param avctx The context which will be set up to use the given codec.
2616  * @param codec The codec to use within the context.
2617  * @return zero on success, a negative value on error
2618  * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2619  */
2620 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2621
2622 /**
2623  * @deprecated Use avcodec_decode_audio2() instead.
2624  */
2625 attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2626                          int *frame_size_ptr,
2627                          const uint8_t *buf, int buf_size);
2628
2629 /**
2630  * Decodes an audio frame from \p buf into \p samples.
2631  * The avcodec_decode_audio2() function decodes an audio frame from the input
2632  * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2633  * audio codec which was coupled with \p avctx using avcodec_open(). The
2634  * resulting decoded frame is stored in output buffer \p samples.  If no frame
2635  * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2636  * decompressed frame size in \e bytes.
2637  *
2638  * @warning You \e must set \p frame_size_ptr to the allocated size of the
2639  * output buffer before calling avcodec_decode_audio2().
2640  *
2641  * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2642  * the actual read bytes because some optimized bitstream readers read 32 or 64
2643  * bits at once and could read over the end.
2644  *
2645  * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2646  * no overreading happens for damaged MPEG streams.
2647  *
2648  * @note You might have to align the input buffer \p buf and output buffer \p
2649  * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2650  * necessary at all, on others it won't work at all if not aligned and on others
2651  * it will work but it will have an impact on performance. In practice, the
2652  * bitstream should have 4 byte alignment at minimum and all sample data should
2653  * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2654  * the linesize is not a multiple of 16 then there's no sense in aligning the
2655  * start of the buffer to 16.
2656  *
2657  * @param avctx the codec context
2658  * @param[out] samples the output buffer
2659  * @param[in,out] frame_size_ptr the output buffer size in bytes
2660  * @param[in] buf the input buffer
2661  * @param[in] buf_size the input buffer size in bytes
2662  * @return On error a negative value is returned, otherwise the number of bytes
2663  * used or zero if no frame could be decompressed.
2664  */
2665 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2666                          int *frame_size_ptr,
2667                          const uint8_t *buf, int buf_size);
2668
2669 /**
2670  * Decodes a video frame from \p buf into \p picture.
2671  * The avcodec_decode_video() function decodes a video frame from the input
2672  * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2673  * video codec which was coupled with \p avctx using avcodec_open(). The
2674  * resulting decoded frame is stored in \p picture.
2675  *
2676  * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2677  * the actual read bytes because some optimized bitstream readers read 32 or 64
2678  * bits at once and could read over the end.
2679  *
2680  * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2681  * no overreading happens for damaged MPEG streams.
2682  *
2683  * @note You might have to align the input buffer \p buf and output buffer \p
2684  * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2685  * necessary at all, on others it won't work at all if not aligned and on others
2686  * it will work but it will have an impact on performance. In practice, the
2687  * bitstream should have 4 byte alignment at minimum and all sample data should
2688  * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2689  * the linesize is not a multiple of 16 then there's no sense in aligning the
2690  * start of the buffer to 16.
2691  *
2692  * @param avctx the codec context
2693  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2694  * @param[in] buf the input buffer
2695  * @param[in] buf_size the size of the input buffer in bytes
2696  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2697  * @return On error a negative value is returned, otherwise the number of bytes
2698  * used or zero if no frame could be decompressed.
2699  */
2700 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2701                          int *got_picture_ptr,
2702                          const uint8_t *buf, int buf_size);
2703
2704 /* Decode a subtitle message. Return -1 if error, otherwise return the
2705  * number of bytes used. If no subtitle could be decompressed,
2706  * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2707 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2708                             int *got_sub_ptr,
2709                             const uint8_t *buf, int buf_size);
2710 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2711                         int *data_size_ptr,
2712                         uint8_t *buf, int buf_size);
2713
2714 /**
2715  * Encodes an audio frame from \p samples into \p buf.
2716  * The avcodec_encode_audio() function encodes an audio frame from the input
2717  * buffer \p samples. To encode it, it makes use of the audio codec which was
2718  * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2719  * stored in output buffer \p buf.
2720  *
2721  * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2722  *
2723  * @param avctx the codec context
2724  * @param[out] buf the output buffer
2725  * @param[in] buf_size the output buffer size
2726  * @param[in] samples the input buffer containing the samples
2727  * The number of samples read from this buffer is frame_size*channels,
2728  * both of which are defined in \p avctx.
2729  * @return On error a negative value is returned, on success zero or the number
2730  * of bytes used to encode the data read from the input buffer.
2731  */
2732 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2733                          const short *samples);
2734
2735 /**
2736  * Encodes a video frame from \p pict into \p buf.
2737  * The avcodec_encode_video() function encodes a video frame from the input
2738  * \p pict. To encode it, it makes use of the video codec which was coupled with
2739  * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2740  * frame are stored in the output buffer \p buf. The input picture should be
2741  * stored using a specific format, namely \c avctx.pix_fmt.
2742  *
2743  * @param avctx the codec context
2744  * @param[out] buf the output buffer for the bitstream of encoded frame
2745  * @param[in] buf_size the size of the output buffer in bytes
2746  * @param[in] pict the input picture to encode
2747  * @return On error a negative value is returned, on success zero or the number
2748  * of bytes used from the input buffer.
2749  */
2750 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2751                          const AVFrame *pict);
2752 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2753                             const AVSubtitle *sub);
2754
2755 int avcodec_close(AVCodecContext *avctx);
2756
2757 void avcodec_register_all(void);
2758
2759 /**
2760  * Flush buffers, should be called when seeking or when switching to a different stream.
2761  */
2762 void avcodec_flush_buffers(AVCodecContext *avctx);
2763
2764 void avcodec_default_free_buffers(AVCodecContext *s);
2765
2766 /* misc useful functions */
2767
2768 /**
2769  * Returns a single letter to describe the given picture type \p pict_type.
2770  *
2771  * @param[in] pict_type the picture type
2772  * @return A single character representing the picture type.
2773  */
2774 char av_get_pict_type_char(int pict_type);
2775
2776 /**
2777  * Returns codec bits per sample.
2778  *
2779  * @param[in] codec_id the codec
2780  * @return Number of bits per sample or zero if unknown for the given codec.
2781  */
2782 int av_get_bits_per_sample(enum CodecID codec_id);
2783
2784 /**
2785  * Returns sample format bits per sample.
2786  *
2787  * @param[in] sample_fmt the sample format
2788  * @return Number of bits per sample or zero if unknown for the given sample format.
2789  */
2790 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2791
2792 /* frame parsing */
2793 typedef struct AVCodecParserContext {
2794     void *priv_data;
2795     struct AVCodecParser *parser;
2796     int64_t frame_offset; /* offset of the current frame */
2797     int64_t cur_offset; /* current offset
2798                            (incremented by each av_parser_parse()) */
2799     int64_t last_frame_offset; /* offset of the last frame */
2800     /* video info */
2801     int pict_type; /* XXX: Put it back in AVCodecContext. */
2802     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2803     int64_t pts;     /* pts of the current frame */
2804     int64_t dts;     /* dts of the current frame */
2805
2806     /* private data */
2807     int64_t last_pts;
2808     int64_t last_dts;
2809     int fetch_timestamp;
2810
2811 #define AV_PARSER_PTS_NB 4
2812     int cur_frame_start_index;
2813     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2814     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2815     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2816
2817     int flags;
2818 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
2819
2820     int64_t offset;      ///< byte offset from starting packet start
2821     int64_t last_offset;
2822 } AVCodecParserContext;
2823
2824 typedef struct AVCodecParser {
2825     int codec_ids[5]; /* several codec IDs are permitted */
2826     int priv_data_size;
2827     int (*parser_init)(AVCodecParserContext *s);
2828     int (*parser_parse)(AVCodecParserContext *s,
2829                         AVCodecContext *avctx,
2830                         const uint8_t **poutbuf, int *poutbuf_size,
2831                         const uint8_t *buf, int buf_size);
2832     void (*parser_close)(AVCodecParserContext *s);
2833     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2834     struct AVCodecParser *next;
2835 } AVCodecParser;
2836
2837 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2838 extern AVCodecParser *av_first_parser;
2839 #endif
2840 AVCodecParser *av_parser_next(AVCodecParser *c);
2841
2842 void av_register_codec_parser(AVCodecParser *parser);
2843 AVCodecParserContext *av_parser_init(int codec_id);
2844 int av_parser_parse(AVCodecParserContext *s,
2845                     AVCodecContext *avctx,
2846                     uint8_t **poutbuf, int *poutbuf_size,
2847                     const uint8_t *buf, int buf_size,
2848                     int64_t pts, int64_t dts);
2849 int av_parser_change(AVCodecParserContext *s,
2850                      AVCodecContext *avctx,
2851                      uint8_t **poutbuf, int *poutbuf_size,
2852                      const uint8_t *buf, int buf_size, int keyframe);
2853 void av_parser_close(AVCodecParserContext *s);
2854
2855
2856 typedef struct AVBitStreamFilterContext {
2857     void *priv_data;
2858     struct AVBitStreamFilter *filter;
2859     AVCodecParserContext *parser;
2860     struct AVBitStreamFilterContext *next;
2861 } AVBitStreamFilterContext;
2862
2863
2864 typedef struct AVBitStreamFilter {
2865     const char *name;
2866     int priv_data_size;
2867     int (*filter)(AVBitStreamFilterContext *bsfc,
2868                   AVCodecContext *avctx, const char *args,
2869                   uint8_t **poutbuf, int *poutbuf_size,
2870                   const uint8_t *buf, int buf_size, int keyframe);
2871     void (*close)(AVBitStreamFilterContext *bsfc);
2872     struct AVBitStreamFilter *next;
2873 } AVBitStreamFilter;
2874
2875 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2876 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2877 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2878                                AVCodecContext *avctx, const char *args,
2879                                uint8_t **poutbuf, int *poutbuf_size,
2880                                const uint8_t *buf, int buf_size, int keyframe);
2881 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2882
2883 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2884
2885 /* memory */
2886
2887 /**
2888  * Reallocates the given block if it is not large enough, otherwise it
2889  * does nothing.
2890  *
2891  * @see av_realloc
2892  */
2893 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2894
2895 /* for static data only */
2896
2897 /**
2898  * Frees all static arrays and resets their pointers to 0.
2899  * Call this function to release all statically allocated tables.
2900  *
2901  * @deprecated. Code which uses av_free_static is broken/misdesigned
2902  * and should correctly use static arrays
2903  *
2904  */
2905 attribute_deprecated void av_free_static(void);
2906
2907 /**
2908  * Allocation of static arrays.
2909  *
2910  * @warning Do not use for normal allocation.
2911  *
2912  * @param[in] size The amount of memory you need in bytes.
2913  * @return block of memory of the requested size
2914  * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
2915  * and should correctly use static arrays
2916  */
2917 attribute_deprecated void *av_mallocz_static(unsigned int size);
2918
2919 /**
2920  * Copy image 'src' to 'dst'.
2921  */
2922 void av_picture_copy(AVPicture *dst, const AVPicture *src,
2923               int pix_fmt, int width, int height);
2924
2925 /**
2926  * Crop image top and left side.
2927  */
2928 int av_picture_crop(AVPicture *dst, const AVPicture *src,
2929              int pix_fmt, int top_band, int left_band);
2930
2931 /**
2932  * Pad image.
2933  */
2934 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2935             int padtop, int padbottom, int padleft, int padright, int *color);
2936
2937 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2938 /**
2939  * @deprecated Use the software scaler (swscale) instead.
2940  */
2941 attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
2942               int pix_fmt, int width, int height);
2943
2944 /**
2945  * @deprecated Use the software scaler (swscale) instead.
2946  */
2947 attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
2948              int pix_fmt, int top_band, int left_band);
2949
2950 /**
2951  * @deprecated Use the software scaler (swscale) instead.
2952  */
2953 attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2954             int padtop, int padbottom, int padleft, int padright, int *color);
2955 #endif
2956
2957 extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2958
2959 /**
2960  * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2961  *
2962  * @return 0 in case of a successful parsing, a negative value otherwise
2963  * @param[in] str the string to parse: it has to be a string in the format
2964  * <width>x<height> or a valid video frame size abbreviation.
2965  * @param[in,out] width_ptr pointer to the variable which will contain the detected
2966  * frame width value
2967  * @param[in,out] height_ptr pointer to the variable which will contain the detected
2968  * frame height value
2969  */
2970 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
2971
2972 /**
2973  * Parses \p str and put in \p frame_rate the detected values.
2974  *
2975  * @return 0 in case of a successful parsing, a negative value otherwise
2976  * @param[in] str the string to parse: it has to be a string in the format
2977  * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
2978  * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
2979  * frame rate
2980  */
2981 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
2982
2983 /* error handling */
2984 #if EINVAL > 0
2985 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
2986 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
2987 #else
2988 /* Some platforms have E* and errno already negated. */
2989 #define AVERROR(e) (e)
2990 #define AVUNERROR(e) (e)
2991 #endif
2992 #define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
2993 #define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
2994 #define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
2995 #define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
2996 #define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
2997 #define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
2998 #define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
2999 #define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
3000 #define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3001
3002 #endif /* FFMPEG_AVCODEC_H */