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