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

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