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