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