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

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