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