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