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

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