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

   1 #ifndef AVCODEC_H
   2 #define AVCODEC_H
   3
   4 /**
   5  * @file avcodec.h
   6  * external api header.
   7  */
   8
   9
  10 #ifdef __cplusplus
  11 extern "C" {
  12 #endif
  13
  14 #include "common.h"
  15 #include "rational.h"
  16 #include <sys/types.h> /* size_t */
  17
  18 //FIXME the following 2 really dont belong in here
  19 #define FFMPEG_VERSION_INT     0x000409
  20 #define FFMPEG_VERSION         "CVS"
  21
  22 #define AV_STRINGIFY(s) AV_TOSTRING(s)
  23 #define AV_TOSTRING(s) #s
  24
  25 #define LIBAVCODEC_VERSION_INT ((49<<16)+(0<<8)+0)
  26 #define LIBAVCODEC_VERSION     49.0.0
  27 #define LIBAVCODEC_BUILD       LIBAVCODEC_VERSION_INT
  28
  29 #define LIBAVCODEC_IDENT       "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
  30
  31 #define AV_NOPTS_VALUE int64_t_C(0x8000000000000000)
  32 #define AV_TIME_BASE 1000000
  33 #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
  34
  35 enum CodecID {
  36     CODEC_ID_NONE,
  37     CODEC_ID_MPEG1VIDEO,
  38     CODEC_ID_MPEG2VIDEO, /* prefered ID for MPEG Video 1 or 2 decoding */
  39     CODEC_ID_MPEG2VIDEO_XVMC,
  40     CODEC_ID_H261,
  41     CODEC_ID_H263,
  42     CODEC_ID_RV10,
  43     CODEC_ID_RV20,
  44     CODEC_ID_MJPEG,
  45     CODEC_ID_MJPEGB,
  46     CODEC_ID_LJPEG,
  47     CODEC_ID_SP5X,
  48     CODEC_ID_MPEG4,
  49     CODEC_ID_RAWVIDEO,
  50     CODEC_ID_MSMPEG4V1,
  51     CODEC_ID_MSMPEG4V2,
  52     CODEC_ID_MSMPEG4V3,
  53     CODEC_ID_WMV1,
  54     CODEC_ID_WMV2,
  55     CODEC_ID_H263P,
  56     CODEC_ID_H263I,
  57     CODEC_ID_FLV1,
  58     CODEC_ID_SVQ1,
  59     CODEC_ID_SVQ3,
  60     CODEC_ID_DVVIDEO,
  61     CODEC_ID_HUFFYUV,
  62     CODEC_ID_CYUV,
  63     CODEC_ID_H264,
  64     CODEC_ID_INDEO3,
  65     CODEC_ID_VP3,
  66     CODEC_ID_THEORA,
  67     CODEC_ID_ASV1,
  68     CODEC_ID_ASV2,
  69     CODEC_ID_FFV1,
  70     CODEC_ID_4XM,
  71     CODEC_ID_VCR1,
  72     CODEC_ID_CLJR,
  73     CODEC_ID_MDEC,
  74     CODEC_ID_ROQ,
  75     CODEC_ID_INTERPLAY_VIDEO,
  76     CODEC_ID_XAN_WC3,
  77     CODEC_ID_XAN_WC4,
  78     CODEC_ID_RPZA,
  79     CODEC_ID_CINEPAK,
  80     CODEC_ID_WS_VQA,
  81     CODEC_ID_MSRLE,
  82     CODEC_ID_MSVIDEO1,
  83     CODEC_ID_IDCIN,
  84     CODEC_ID_8BPS,
  85     CODEC_ID_SMC,
  86     CODEC_ID_FLIC,
  87     CODEC_ID_TRUEMOTION1,
  88     CODEC_ID_VMDVIDEO,
  89     CODEC_ID_MSZH,
  90     CODEC_ID_ZLIB,
  91     CODEC_ID_QTRLE,
  92     CODEC_ID_SNOW,
  93     CODEC_ID_TSCC,
  94     CODEC_ID_ULTI,
  95     CODEC_ID_QDRAW,
  96     CODEC_ID_VIXL,
  97     CODEC_ID_QPEG,
  98     CODEC_ID_XVID,
  99     CODEC_ID_PNG,
 100     CODEC_ID_PPM,
 101     CODEC_ID_PBM,
 102     CODEC_ID_PGM,
 103     CODEC_ID_PGMYUV,
 104     CODEC_ID_PAM,
 105     CODEC_ID_FFVHUFF,
 106     CODEC_ID_RV30,
 107     CODEC_ID_RV40,
 108     CODEC_ID_VC9,
 109     CODEC_ID_WMV3,
 110     CODEC_ID_LOCO,
 111     CODEC_ID_WNV1,
 112     CODEC_ID_AASC,
 113     CODEC_ID_INDEO2,
 114     CODEC_ID_FRAPS,
 115
 116     /* various pcm "codecs" */
 117     CODEC_ID_PCM_S16LE= 0x10000,
 118     CODEC_ID_PCM_S16BE,
 119     CODEC_ID_PCM_U16LE,
 120     CODEC_ID_PCM_U16BE,
 121     CODEC_ID_PCM_S8,
 122     CODEC_ID_PCM_U8,
 123     CODEC_ID_PCM_MULAW,
 124     CODEC_ID_PCM_ALAW,
 125
 126     /* various adpcm codecs */
 127     CODEC_ID_ADPCM_IMA_QT= 0x11000,
 128     CODEC_ID_ADPCM_IMA_WAV,
 129     CODEC_ID_ADPCM_IMA_DK3,
 130     CODEC_ID_ADPCM_IMA_DK4,
 131     CODEC_ID_ADPCM_IMA_WS,
 132     CODEC_ID_ADPCM_IMA_SMJPEG,
 133     CODEC_ID_ADPCM_MS,
 134     CODEC_ID_ADPCM_4XM,
 135     CODEC_ID_ADPCM_XA,
 136     CODEC_ID_ADPCM_ADX,
 137     CODEC_ID_ADPCM_EA,
 138     CODEC_ID_ADPCM_G726,
 139     CODEC_ID_ADPCM_CT,
 140     CODEC_ID_ADPCM_SWF,
 141     CODEC_ID_ADPCM_YAMAHA,
 142
 143     /* AMR */
 144     CODEC_ID_AMR_NB= 0x12000,
 145     CODEC_ID_AMR_WB,
 146
 147     /* RealAudio codecs*/
 148     CODEC_ID_RA_144= 0x13000,
 149     CODEC_ID_RA_288,
 150
 151     /* various DPCM codecs */
 152     CODEC_ID_ROQ_DPCM= 0x14000,
 153     CODEC_ID_INTERPLAY_DPCM,
 154     CODEC_ID_XAN_DPCM,
 155     CODEC_ID_SOL_DPCM,
 156
 157     CODEC_ID_MP2= 0x15000,
 158     CODEC_ID_MP3, /* prefered ID for MPEG Audio layer 1, 2 or3 decoding */
 159     CODEC_ID_AAC,
 160     CODEC_ID_MPEG4AAC,
 161     CODEC_ID_AC3,
 162     CODEC_ID_DTS,
 163     CODEC_ID_VORBIS,
 164     CODEC_ID_DVAUDIO,
 165     CODEC_ID_WMAV1,
 166     CODEC_ID_WMAV2,
 167     CODEC_ID_MACE3,
 168     CODEC_ID_MACE6,
 169     CODEC_ID_VMDAUDIO,
 170     CODEC_ID_SONIC,
 171     CODEC_ID_SONIC_LS,
 172     CODEC_ID_FLAC,
 173     CODEC_ID_MP3ADU,
 174     CODEC_ID_MP3ON4,
 175     CODEC_ID_SHORTEN,
 176     CODEC_ID_ALAC,
 177     CODEC_ID_WESTWOOD_SND1,
 178     CODEC_ID_GSM,
 179
 180     CODEC_ID_OGGTHEORA= 0x16000,
 181
 182     /* subtitle codecs */
 183     CODEC_ID_DVD_SUBTITLE= 0x17000,
 184     CODEC_ID_DVB_SUBTITLE,
 185
 186     CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG2 transport
 187                          stream (only used by libavformat) */
 188 };
 189
 190 /* CODEC_ID_MP3LAME is absolete */
 191 #define CODEC_ID_MP3LAME CODEC_ID_MP3
 192
 193 enum CodecType {
 194     CODEC_TYPE_UNKNOWN = -1,
 195     CODEC_TYPE_VIDEO,
 196     CODEC_TYPE_AUDIO,
 197     CODEC_TYPE_DATA,
 198     CODEC_TYPE_SUBTITLE,
 199 };
 200
 201 /**
 202  * Pixel format. Notes:
 203  *
 204  * PIX_FMT_RGBA32 is handled in an endian-specific manner. A RGBA
 205  * color is put together as:
 206  *  (A << 24) | (R << 16) | (G << 8) | B
 207  * This is stored as BGRA on little endian CPU architectures and ARGB on
 208  * big endian CPUs.
 209  *
 210  * When the pixel format is palettized RGB (PIX_FMT_PAL8), the palettized
 211  * image data is stored in AVFrame.data[0]. The palette is transported in
 212  * AVFrame.data[1] and, is 1024 bytes long (256 4-byte entries) and is
 213  * formatted the same as in PIX_FMT_RGBA32 described above (i.e., it is
 214  * also endian-specific). Note also that the individual RGB palette
 215  * components stored in AVFrame.data[1] should be in the range 0..255.
 216  * This is important as many custom PAL8 video codecs that were designed
 217  * to run on the IBM VGA graphics adapter use 6-bit palette components.
 218  */
 219 enum PixelFormat {
 220     PIX_FMT_NONE= -1,
 221     PIX_FMT_YUV420P,   ///< Planar YUV 4:2:0 (1 Cr & Cb sample per 2x2 Y samples)
 222     PIX_FMT_YUV422,    ///< Packed pixel, Y0 Cb Y1 Cr
 223     PIX_FMT_RGB24,     ///< Packed pixel, 3 bytes per pixel, RGBRGB...
 224     PIX_FMT_BGR24,     ///< Packed pixel, 3 bytes per pixel, BGRBGR...
 225     PIX_FMT_YUV422P,   ///< Planar YUV 4:2:2 (1 Cr & Cb sample per 2x1 Y samples)
 226     PIX_FMT_YUV444P,   ///< Planar YUV 4:4:4 (1 Cr & Cb sample per 1x1 Y samples)
 227     PIX_FMT_RGBA32,    ///< Packed pixel, 4 bytes per pixel, BGRABGRA..., stored in cpu endianness
 228     PIX_FMT_YUV410P,   ///< Planar YUV 4:1:0 (1 Cr & Cb sample per 4x4 Y samples)
 229     PIX_FMT_YUV411P,   ///< Planar YUV 4:1:1 (1 Cr & Cb sample per 4x1 Y samples)
 230     PIX_FMT_RGB565,    ///< always stored in cpu endianness
 231     PIX_FMT_RGB555,    ///< always stored in cpu endianness, most significant bit to 1
 232     PIX_FMT_GRAY8,
 233     PIX_FMT_MONOWHITE, ///< 0 is white
 234     PIX_FMT_MONOBLACK, ///< 0 is black
 235     PIX_FMT_PAL8,      ///< 8 bit with RGBA palette
 236     PIX_FMT_YUVJ420P,  ///< Planar YUV 4:2:0 full scale (jpeg)
 237     PIX_FMT_YUVJ422P,  ///< Planar YUV 4:2:2 full scale (jpeg)
 238     PIX_FMT_YUVJ444P,  ///< Planar YUV 4:4:4 full scale (jpeg)
 239     PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
 240     PIX_FMT_XVMC_MPEG2_IDCT,
 241     PIX_FMT_UYVY422,   ///< Packed pixel, Cb Y0 Cr Y1
 242     PIX_FMT_UYVY411,   ///< Packed pixel, Cb Y0 Y1 Cr Y2 Y3
 243     PIX_FMT_NB,
 244 };
 245
 246 /* currently unused, may be used if 24/32 bits samples ever supported */
 247 enum SampleFormat {
 248     SAMPLE_FMT_S16 = 0,         ///< signed 16 bits
 249     SAMPLE_FMT_S32,             ///< signed 32 bits
 250     SAMPLE_FMT_FLT,             ///< float
 251     SAMPLE_FMT_DBL,             ///< double
 252 };
 253
 254 /* in bytes */
 255 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
 256
 257 /**
 258  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
 259  * this is mainly needed because some optimized bitstream readers read
 260  * 32 or 64 bit at once and could read over the end<br>
 261  * Note, if the first 23 bits of the additional bytes are not 0 then damaged
 262  * MPEG bitstreams could cause overread and segfault
 263  */
 264 #define FF_INPUT_BUFFER_PADDING_SIZE 8
 265
 266 /**
 267  * minimum encoding buffer size.
 268  * used to avoid some checks during header writing
 269  */
 270 #define FF_MIN_BUFFER_SIZE 16384
 271
 272 /* motion estimation type, EPZS by default */
 273 enum Motion_Est_ID {
 274     ME_ZERO = 1,
 275     ME_FULL,
 276     ME_LOG,
 277     ME_PHODS,
 278     ME_EPZS,
 279     ME_X1
 280 };
 281
 282 enum AVRounding {
 283     AV_ROUND_ZERO     = 0, ///< round toward zero
 284     AV_ROUND_INF      = 1, ///< round away from zero
 285     AV_ROUND_DOWN     = 2, ///< round toward -infinity
 286     AV_ROUND_UP       = 3, ///< round toward +infinity
 287     AV_ROUND_NEAR_INF = 5, ///< round to nearest and halfway cases away from zero
 288 };
 289
 290 enum AVDiscard{
 291 //we leave some space between them for extensions (drop some keyframes for intra only or drop just some bidir frames)
 292     AVDISCARD_NONE   =-16, ///< discard nothing
 293     AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
 294     AVDISCARD_NONREF =  8, ///< discard all non reference
 295     AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
 296     AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
 297     AVDISCARD_ALL    = 48, ///< discard all
 298 };
 299
 300 typedef struct RcOverride{
 301     int start_frame;
 302     int end_frame;
 303     int qscale; // if this is 0 then quality_factor will be used instead
 304     float quality_factor;
 305 } RcOverride;
 306
 307 /* only for ME compatiblity with old apps */
 308 extern int motion_estimation_method;
 309
 310 #define FF_MAX_B_FRAMES 8
 311
 312 /* encoding support
 313    these flags can be passed in AVCodecContext.flags before initing
 314    Note: not everything is supported yet.
 315 */
 316
 317 #define CODEC_FLAG_QSCALE 0x0002  ///< use fixed qscale
 318 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / Advanced prediction for H263
 319 #define CODEC_FLAG_QPEL   0x0010  ///< use qpel MC
 320 #define CODEC_FLAG_GMC    0x0020  ///< use GMC
 321 #define CODEC_FLAG_MV0    0x0040  ///< always try a MB with MV=<0,0>
 322 #define CODEC_FLAG_PART   0x0080  ///< use data partitioning
 323 /* parent program gurantees that the input for b-frame containing streams is not written to
 324    for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
 325 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
 326 #define CODEC_FLAG_PASS1 0x0200   ///< use internal 2pass ratecontrol in first  pass mode
 327 #define CODEC_FLAG_PASS2 0x0400   ///< use internal 2pass ratecontrol in second pass mode
 328 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< use external huffman table (for mjpeg)
 329 #define CODEC_FLAG_GRAY  0x2000   ///< only decode/encode grayscale
 330 #define CODEC_FLAG_EMU_EDGE 0x4000///< don't draw edges
 331 #define CODEC_FLAG_PSNR           0x8000 ///< error[?] variables will be set during encoding
 332 #define CODEC_FLAG_TRUNCATED  0x00010000 /** input bitstream might be truncated at a random location instead
 333                                             of only at frame boundaries */
 334 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< normalize adaptive quantization
 335 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct
 336 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< force low delay
 337 #define CODEC_FLAG_ALT_SCAN       0x00100000 ///< use alternate scan
 338 #define CODEC_FLAG_TRELLIS_QUANT  0x00200000 ///< use trellis quantization
 339 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< place global headers in extradata instead of every keyframe
 340 #define CODEC_FLAG_BITEXACT       0x00800000 ///< use only bitexact stuff (except (i)dct)
 341 /* Fx : Flag for h263+ extra options */
 342 #define CODEC_FLAG_H263P_AIC      0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction (remove this)
 343 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction
 344 #define CODEC_FLAG_H263P_UMV      0x02000000 ///< Unlimited motion vector
 345 #define CODEC_FLAG_CBP_RD         0x04000000 ///< use rate distortion optimization for cbp
 346 #define CODEC_FLAG_QP_RD          0x08000000 ///< use rate distortion optimization for qp selectioon
 347 #define CODEC_FLAG_H263P_AIV      0x00000008 ///< H263 Alternative inter vlc
 348 #define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
 349 #define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
 350 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
 351 #define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
 352 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< will reserve space for SVCD scan offset user data
 353 #define CODEC_FLAG_CLOSED_GOP     0x80000000
 354 #define CODEC_FLAG2_FAST          0x00000001 ///< allow non spec compliant speedup tricks
 355 #define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< strictly enforce GOP size
 356 #define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< skip bitstream encoding
 357 #define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< place global headers at every keyframe instead of in extradata
 358
 359 /* Unsupported options :
 360  *              Syntax Arithmetic coding (SAC)
 361  *              Reference Picture Selection
 362  *              Independant Segment Decoding */
 363 /* /Fx */
 364 /* codec capabilities */
 365
 366 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback
 367 /**
 368  * Codec uses get_buffer() for allocating buffers.
 369  * direct rendering method 1
 370  */
 371 #define CODEC_CAP_DR1             0x0002
 372 /* if 'parse_only' field is true, then avcodec_parse_frame() can be
 373    used */
 374 #define CODEC_CAP_PARSE_ONLY      0x0004
 375 #define CODEC_CAP_TRUNCATED       0x0008
 376 /* codec can export data for HW decoding (XvMC) */
 377 #define CODEC_CAP_HWACCEL         0x0010
 378 /**
 379  * codec has a non zero delay and needs to be feeded with NULL at the end to get the delayed data.
 380  * if this is not set, the codec is guranteed to never be feeded with NULL data
 381  */
 382 #define CODEC_CAP_DELAY           0x0020
 383
 384 //the following defines may change, don't expect compatibility if you use them
 385 #define MB_TYPE_INTRA4x4   0x0001
 386 #define MB_TYPE_INTRA16x16 0x0002 //FIXME h264 specific
 387 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME h264 specific
 388 #define MB_TYPE_16x16      0x0008
 389 #define MB_TYPE_16x8       0x0010
 390 #define MB_TYPE_8x16       0x0020
 391 #define MB_TYPE_8x8        0x0040
 392 #define MB_TYPE_INTERLACED 0x0080
 393 #define MB_TYPE_DIRECT2     0x0100 //FIXME
 394 #define MB_TYPE_ACPRED     0x0200
 395 #define MB_TYPE_GMC        0x0400
 396 #define MB_TYPE_SKIP       0x0800
 397 #define MB_TYPE_P0L0       0x1000
 398 #define MB_TYPE_P1L0       0x2000
 399 #define MB_TYPE_P0L1       0x4000
 400 #define MB_TYPE_P1L1       0x8000
 401 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
 402 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
 403 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
 404 #define MB_TYPE_QUANT      0x00010000
 405 #define MB_TYPE_CBP        0x00020000
 406 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
 407
 408 /**
 409  * Pan Scan area.
 410  * this specifies the area which should be displayed. Note there may be multiple such areas for one frame
 411  */
 412 typedef struct AVPanScan{
 413     /**
 414      * id.
 415      * - encoding: set by user.
 416      * - decoding: set by lavc
 417      */
 418     int id;
 419
 420     /**
 421      * width and height in 1/16 pel
 422      * - encoding: set by user.
 423      * - decoding: set by lavc
 424      */
 425     int width;
 426     int height;
 427
 428     /**
 429      * position of the top left corner in 1/16 pel for up to 3 fields/frames.
 430      * - encoding: set by user.
 431      * - decoding: set by lavc
 432      */
 433     int16_t position[3][2];
 434 }AVPanScan;
 435
 436 #define FF_COMMON_FRAME \
 437     /**\
 438      * pointer to the picture planes.\
 439      * this might be different from the first allocated byte\
 440      * - encoding: \
 441      * - decoding: \
 442      */\
 443     uint8_t *data[4];\
 444     int linesize[4];\
 445     /**\
 446      * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
 447      * this isn't used by lavc unless the default get/release_buffer() is used\
 448      * - encoding: \
 449      * - decoding: \
 450      */\
 451     uint8_t *base[4];\
 452     /**\
 453      * 1 -> keyframe, 0-> not\
 454      * - encoding: set by lavc\
 455      * - decoding: set by lavc\
 456      */\
 457     int key_frame;\
 458 \
 459     /**\
 460      * picture type of the frame, see ?_TYPE below.\
 461      * - encoding: set by lavc for coded_picture (and set by user for input)\
 462      * - decoding: set by lavc\
 463      */\
 464     int pict_type;\
 465 \
 466     /**\
 467      * presentation timestamp in time_base units (time when frame should be shown to user)\
 468      * if AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed\
 469      * - encoding: MUST be set by user\
 470      * - decoding: set by lavc\
 471      */\
 472     int64_t pts;\
 473 \
 474     /**\
 475      * picture number in bitstream order.\
 476      * - encoding: set by\
 477      * - decoding: set by lavc\
 478      */\
 479     int coded_picture_number;\
 480     /**\
 481      * picture number in display order.\
 482      * - encoding: set by\
 483      * - decoding: set by lavc\
 484      */\
 485     int display_picture_number;\
 486 \
 487     /**\
 488      * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
 489      * - encoding: set by lavc for coded_picture (and set by user for input)\
 490      * - decoding: set by lavc\
 491      */\
 492     int quality; \
 493 \
 494     /**\
 495      * buffer age (1->was last buffer and dint change, 2->..., ...).\
 496      * set to INT_MAX if the buffer has not been used yet \
 497      * - encoding: unused\
 498      * - decoding: MUST be set by get_buffer()\
 499      */\
 500     int age;\
 501 \
 502     /**\
 503      * is this picture used as reference\
 504      * - encoding: unused\
 505      * - decoding: set by lavc (before get_buffer() call))\
 506      */\
 507     int reference;\
 508 \
 509     /**\
 510      * QP table\
 511      * - encoding: unused\
 512      * - decoding: set by lavc\
 513      */\
 514     int8_t *qscale_table;\
 515     /**\
 516      * QP store stride\
 517      * - encoding: unused\
 518      * - decoding: set by lavc\
 519      */\
 520     int qstride;\
 521 \
 522     /**\
 523      * mbskip_table[mb]>=1 if MB didnt change\
 524      * stride= mb_width = (width+15)>>4\
 525      * - encoding: unused\
 526      * - decoding: set by lavc\
 527      */\
 528     uint8_t *mbskip_table;\
 529 \
 530     /**\
 531      * Motion vector table.\
 532      * @code\
 533      * example:\
 534      * int mv_sample_log2= 4 - motion_subsample_log2;\
 535      * int mb_width= (width+15)>>4;\
 536      * int mv_stride= (mb_width << mv_sample_log2) + 1;\
 537      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
 538      * @endcode\
 539      * - encoding: set by user\
 540      * - decoding: set by lavc\
 541      */\
 542     int16_t (*motion_val[2])[2];\
 543 \
 544     /**\
 545      * Macroblock type table\
 546      * mb_type_base + mb_width + 2\
 547      * - encoding: set by user\
 548      * - decoding: set by lavc\
 549      */\
 550     uint32_t *mb_type;\
 551 \
 552     /**\
 553      * log2 of the size of the block which a single vector in motion_val represents: \
 554      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
 555      * - encoding: unused\
 556      * - decoding: set by lavc\
 557      */\
 558     uint8_t motion_subsample_log2;\
 559 \
 560     /**\
 561      * for some private data of the user\
 562      * - encoding: unused\
 563      * - decoding: set by user\
 564      */\
 565     void *opaque;\
 566 \
 567     /**\
 568      * error\
 569      * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
 570      * - decoding: unused\
 571      */\
 572     uint64_t error[4];\
 573 \
 574     /**\
 575      * type of the buffer (to keep track of who has to dealloc data[*])\
 576      * - encoding: set by the one who allocs it\
 577      * - decoding: set by the one who allocs it\
 578      * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
 579      */\
 580     int type;\
 581     \
 582     /**\
 583      * when decoding, this signal how much the picture must be delayed.\
 584      * extra_delay = repeat_pict / (2*fps)\
 585      * - encoding: unused\
 586      * - decoding: set by lavc\
 587      */\
 588     int repeat_pict;\
 589     \
 590     /**\
 591      * \
 592      */\
 593     int qscale_type;\
 594     \
 595     /**\
 596      * The content of the picture is interlaced.\
 597      * - encoding: set by user\
 598      * - decoding: set by lavc (default 0)\
 599      */\
 600     int interlaced_frame;\
 601     \
 602     /**\
 603      * if the content is interlaced, is top field displayed first.\
 604      * - encoding: set by user\
 605      * - decoding: set by lavc\
 606      */\
 607     int top_field_first;\
 608     \
 609     /**\
 610      * Pan scan.\
 611      * - encoding: set by user\
 612      * - decoding: set by lavc\
 613      */\
 614     AVPanScan *pan_scan;\
 615     \
 616     /**\
 617      * tell user application that palette has changed from previous frame.\
 618      * - encoding: ??? (no palette-enabled encoder yet)\
 619      * - decoding: set by lavc (default 0)\
 620      */\
 621     int palette_has_changed;\
 622     \
 623     /**\
 624      * Codec suggestion on buffer type if != 0\
 625      * - encoding: unused\
 626      * - decoding: set by lavc (before get_buffer() call))\
 627      */\
 628     int buffer_hints;\
 629 \
 630     /**\
 631      * DCT coeffitients\
 632      * - encoding: unused\
 633      * - decoding: set by lavc\
 634      */\
 635     short *dct_coeff;\
 636 \
 637     /**\
 638      * Motion referece frame index\
 639      * - encoding: set by user\
 640      * - decoding: set by lavc\
 641      */\
 642     int8_t *ref_index[2];
 643
 644 #define FF_QSCALE_TYPE_MPEG1    0
 645 #define FF_QSCALE_TYPE_MPEG2    1
 646
 647 #define FF_BUFFER_TYPE_INTERNAL 1
 648 #define FF_BUFFER_TYPE_USER     2 ///< Direct rendering buffers (image is (de)allocated by user)
 649 #define FF_BUFFER_TYPE_SHARED   4 ///< buffer from somewhere else, don't dealloc image (data/base), all other tables are not shared
 650 #define FF_BUFFER_TYPE_COPY     8 ///< just a (modified) copy of some other buffer, don't dealloc anything
 651
 652
 653 #define FF_I_TYPE 1 // Intra
 654 #define FF_P_TYPE 2 // Predicted
 655 #define FF_B_TYPE 3 // Bi-dir predicted
 656 #define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
 657 #define FF_SI_TYPE 5
 658 #define FF_SP_TYPE 6
 659
 660 #define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore)
 661 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer
 662 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content
 663 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update)
 664
 665 /**
 666  * Audio Video Frame.
 667  */
 668 typedef struct AVFrame {
 669     FF_COMMON_FRAME
 670 } AVFrame;
 671
 672 #define DEFAULT_FRAME_RATE_BASE 1001000
 673
 674 /**
 675  * Used by av_log
 676  */
 677 typedef struct AVCLASS AVClass;
 678 struct AVCLASS {
 679     const char* class_name;
 680     const char* (*item_name)(void*); /* actually passing a pointer to an AVCodecContext
 681                                         or AVFormatContext, which begin with an AVClass.
 682                                         Needed because av_log is in libavcodec and has no visibility
 683                                         of AVIn/OutputFormat */
 684 };
 685
 686 /**
 687  * main external api structure.
 688  */
 689 typedef struct AVCodecContext {
 690     /**
 691      * Info on struct for av_log
 692      * - set by avcodec_alloc_context
 693      */
 694     AVClass *av_class;
 695     /**
 696      * the average bitrate.
 697      * - encoding: set by user. unused for constant quantizer encoding
 698      * - decoding: set by lavc. 0 or some bitrate if this info is available in the stream
 699      */
 700     int bit_rate;
 701
 702     /**
 703      * number of bits the bitstream is allowed to diverge from the reference.
 704      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
 705      * - encoding: set by user. unused for constant quantizer encoding
 706      * - decoding: unused
 707      */
 708     int bit_rate_tolerance;
 709
 710     /**
 711      * CODEC_FLAG_*.
 712      * - encoding: set by user.
 713      * - decoding: set by user.
 714      */
 715     int flags;
 716
 717     /**
 718      * some codecs needs additionnal format info. It is stored here
 719      * - encoding: set by user.
 720      * - decoding: set by lavc. (FIXME is this ok?)
 721      */
 722     int sub_id;
 723
 724     /**
 725      * motion estimation algorithm used for video coding.
 726      * - encoding: MUST be set by user.
 727      * - decoding: unused
 728      */
 729     int me_method;
 730
 731     /**
 732      * some codecs need / can use extra-data like huffman tables.
 733      * mjpeg: huffman tables
 734      * rv10: additional flags
 735      * mpeg4: global headers (they can be in the bitstream or here)
 736      * the allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
 737      * then extradata_size to avoid prolems if its read with the bitstream reader
 738      * - encoding: set/allocated/freed by lavc.
 739      * - decoding: set/allocated/freed by user.
 740      */
 741     void *extradata;
 742     int extradata_size;
 743
 744     /* video only */
 745     /**
 746      * time base in which the timestamps are specified.
 747      * - encoding: MUST be set by user
 748      * - decoding: set by lavc.
 749      */
 750     AVRational time_base;
 751
 752     /**
 753      * picture width / height.
 754      * - encoding: MUST be set by user.
 755      * - decoding: set by lavc.
 756      * Note, for compatibility its possible to set this instead of
 757      * coded_width/height before decoding
 758      */
 759     int width, height;
 760
 761 #define FF_ASPECT_EXTENDED 15
 762
 763     /**
 764      * the number of pictures in a group of pitures, or 0 for intra_only.
 765      * - encoding: set by user.
 766      * - decoding: unused
 767      */
 768     int gop_size;
 769
 770     /**
 771      * pixel format, see PIX_FMT_xxx.
 772      * - encoding: set by user.
 773      * - decoding: set by lavc.
 774      */
 775     enum PixelFormat pix_fmt;
 776
 777     /**
 778      * Frame rate emulation. If not zero lower layer (i.e. format handler)
 779      * has to read frames at native frame rate.
 780      * - encoding: set by user.
 781      * - decoding: unused.
 782      */
 783     int rate_emu;
 784
 785     /**
 786      * if non NULL, 'draw_horiz_band' is called by the libavcodec
 787      * decoder to draw an horizontal band. It improve cache usage. Not
 788      * all codecs can do that. You must check the codec capabilities
 789      * before
 790      * - encoding: unused
 791      * - decoding: set by user.
 792      * @param height the height of the slice
 793      * @param y the y position of the slice
 794      * @param type 1->top field, 2->bottom field, 3->frame
 795      * @param offset offset into the AVFrame.data from which the slice should be read
 796      */
 797     void (*draw_horiz_band)(struct AVCodecContext *s,
 798                             const AVFrame *src, int offset[4],
 799                             int y, int type, int height);
 800
 801     /* audio only */
 802     int sample_rate; ///< samples per sec
 803     int channels;
 804
 805     /**
 806      * audio sample format.
 807      * - encoding: set by user.
 808      * - decoding: set by lavc.
 809      */
 810     enum SampleFormat sample_fmt;  ///< sample format, currenly unused
 811
 812     /* the following data should not be initialized */
 813     /**
 814      * samples per packet. initialized when calling 'init'
 815      */
 816     int frame_size;
 817     int frame_number;   ///< audio or video frame number
 818     int real_pict_num;  ///< returns the real picture number of previous encoded frame
 819
 820     /**
 821      * number of frames the decoded output will be delayed relative to
 822      * the encoded input.
 823      * - encoding: set by lavc.
 824      * - decoding: unused
 825      */
 826     int delay;
 827
 828     /* - encoding parameters */
 829     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
 830     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
 831
 832     /**
 833      * minimum quantizer.
 834      * - encoding: set by user.
 835      * - decoding: unused
 836      */
 837     int qmin;
 838
 839     /**
 840      * maximum quantizer.
 841      * - encoding: set by user.
 842      * - decoding: unused
 843      */
 844     int qmax;
 845
 846     /**
 847      * maximum quantizer difference etween frames.
 848      * - encoding: set by user.
 849      * - decoding: unused
 850      */
 851     int max_qdiff;
 852
 853     /**
 854      * maximum number of b frames between non b frames.
 855      * note: the output will be delayed by max_b_frames+1 relative to the input
 856      * - encoding: set by user.
 857      * - decoding: unused
 858      */
 859     int max_b_frames;
 860
 861     /**
 862      * qscale factor between ip and b frames.
 863      * - encoding: set by user.
 864      * - decoding: unused
 865      */
 866     float b_quant_factor;
 867
 868     /** obsolete FIXME remove */
 869     int rc_strategy;
 870     int b_frame_strategy;
 871
 872     /**
 873      * hurry up amount.
 874      * deprecated in favor of skip_idct and skip_frame
 875      * - encoding: unused
 876      * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
 877      */
 878     int hurry_up;
 879
 880     struct AVCodec *codec;
 881
 882     void *priv_data;
 883
 884     /* unused, FIXME remove*/
 885     int rtp_mode;
 886
 887     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
 888                             /* do it's best to deliver a chunk with size    */
 889                             /* below rtp_payload_size, the chunk will start */
 890                             /* with a start code on some codecs like H.263  */
 891                             /* This doesn't take account of any particular  */
 892                             /* headers inside the transmited RTP payload    */
 893
 894
 895     /* The RTP callback: This function is called   */
 896     /* every time the encoder has a packet to send */
 897     /* Depends on the encoder if the data starts   */
 898     /* with a Start Code (it should) H.263 does.   */
 899     /* mb_nb contains the number of macroblocks    */
 900     /* encoded in the RTP payload                  */
 901     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
 902
 903     /* statistics, used for 2-pass encoding */
 904     int mv_bits;
 905     int header_bits;
 906     int i_tex_bits;
 907     int p_tex_bits;
 908     int i_count;
 909     int p_count;
 910     int skip_count;
 911     int misc_bits;
 912
 913     /**
 914      * number of bits used for the previously encoded frame.
 915      * - encoding: set by lavc
 916      * - decoding: unused
 917      */
 918     int frame_bits;
 919
 920     /**
 921      * private data of the user, can be used to carry app specific stuff.
 922      * - encoding: set by user
 923      * - decoding: set by user
 924      */
 925     void *opaque;
 926
 927     char codec_name[32];
 928     enum CodecType codec_type; /* see CODEC_TYPE_xxx */
 929     enum CodecID codec_id; /* see CODEC_ID_xxx */
 930
 931     /**
 932      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
 933      * this is used to workaround some encoder bugs
 934      * - encoding: set by user, if not then the default based on codec_id will be used
 935      * - decoding: set by user, will be converted to upper case by lavc during init
 936      */
 937     unsigned int codec_tag;
 938
 939     /**
 940      * workaround bugs in encoders which sometimes cannot be detected automatically.
 941      * - encoding: set by user
 942      * - decoding: set by user
 943      */
 944     int workaround_bugs;
 945 #define FF_BUG_AUTODETECT       1  ///< autodetection
 946 #define FF_BUG_OLD_MSMPEG4      2
 947 #define FF_BUG_XVID_ILACE       4
 948 #define FF_BUG_UMP4             8
 949 #define FF_BUG_NO_PADDING       16
 950 #define FF_BUG_AMV              32
 951 #define FF_BUG_AC_VLC           0  ///< will be removed, libavcodec can now handle these non compliant files by default
 952 #define FF_BUG_QPEL_CHROMA      64
 953 #define FF_BUG_STD_QPEL         128
 954 #define FF_BUG_QPEL_CHROMA2     256
 955 #define FF_BUG_DIRECT_BLOCKSIZE 512
 956 #define FF_BUG_EDGE             1024
 957 #define FF_BUG_HPEL_CHROMA      2048
 958 #define FF_BUG_DC_CLIP          4096
 959 #define FF_BUG_MS               8192 ///< workaround various bugs in microsofts broken decoders
 960 //#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
 961
 962     /**
 963      * luma single coeff elimination threshold.
 964      * - encoding: set by user
 965      * - decoding: unused
 966      */
 967     int luma_elim_threshold;
 968
 969     /**
 970      * chroma single coeff elimination threshold.
 971      * - encoding: set by user
 972      * - decoding: unused
 973      */
 974     int chroma_elim_threshold;
 975
 976     /**
 977      * strictly follow the std (MPEG4, ...).
 978      * - encoding: set by user
 979      * - decoding: unused
 980      */
 981     int strict_std_compliance;
 982 #define FF_COMPLIANCE_VERY_STRICT   2 ///< strictly conform to a older more strict version of the spec or reference software
 983 #define FF_COMPLIANCE_STRICT        1 ///< strictly conform to all the things in the spec no matter what consequences
 984 #define FF_COMPLIANCE_NORMAL        0
 985 #define FF_COMPLIANCE_INOFFICIAL   -1 ///< allow inofficial extensions
 986 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< allow non standarized experimental things
 987
 988     /**
 989      * qscale offset between ip and b frames.
 990      * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
 991      * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
 992      * - encoding: set by user.
 993      * - decoding: unused
 994      */
 995     float b_quant_offset;
 996
 997     /**
 998      * error resilience higher values will detect more errors but may missdetect
 999      * some more or less valid parts as errors.
1000      * - encoding: unused
1001      * - decoding: set by user
1002      */
1003     int error_resilience;
1004 #define FF_ER_CAREFULL        1
1005 #define FF_ER_COMPLIANT       2
1006 #define FF_ER_AGGRESSIVE      3
1007 #define FF_ER_VERY_AGGRESSIVE 4
1008
1009     /**
1010      * called at the beginning of each frame to get a buffer for it.
1011      * if pic.reference is set then the frame will be read later by lavc
1012      * avcodec_align_dimensions() should be used to find the required width and
1013      * height, as they normally need to be rounded up to the next multiple of 16
1014      * - encoding: unused
1015      * - decoding: set by lavc, user can override
1016      */
1017     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1018
1019     /**
1020      * called to release buffers which where allocated with get_buffer.
1021      * a released buffer can be reused in get_buffer()
1022      * pic.data[*] must be set to NULL
1023      * - encoding: unused
1024      * - decoding: set by lavc, user can override
1025      */
1026     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1027
1028     /**
1029      * if 1 the stream has a 1 frame delay during decoding.
1030      * - encoding: set by lavc
1031      * - decoding: set by lavc
1032      */
1033     int has_b_frames;
1034
1035     /**
1036      * number of bytes per packet if constant and known or 0
1037      * used by some WAV based audio codecs
1038      */
1039     int block_align;
1040
1041     int parse_only; /* - decoding only: if true, only parsing is done
1042                        (function avcodec_parse_frame()). The frame
1043                        data is returned. Only MPEG codecs support this now. */
1044
1045     /**
1046      * 0-> h263 quant 1-> mpeg quant.
1047      * - encoding: set by user.
1048      * - decoding: unused
1049      */
1050     int mpeg_quant;
1051
1052     /**
1053      * pass1 encoding statistics output buffer.
1054      * - encoding: set by lavc
1055      * - decoding: unused
1056      */
1057     char *stats_out;
1058
1059     /**
1060      * pass2 encoding statistics input buffer.
1061      * concatenated stuff from stats_out of pass1 should be placed here
1062      * - encoding: allocated/set/freed by user
1063      * - decoding: unused
1064      */
1065     char *stats_in;
1066
1067     /**
1068      * ratecontrol qmin qmax limiting method.
1069      * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
1070      * - encoding: set by user.
1071      * - decoding: unused
1072      */
1073     float rc_qsquish;
1074
1075     float rc_qmod_amp;
1076     int rc_qmod_freq;
1077
1078     /**
1079      * ratecontrol override, see RcOverride.
1080      * - encoding: allocated/set/freed by user.
1081      * - decoding: unused
1082      */
1083     RcOverride *rc_override;
1084     int rc_override_count;
1085
1086     /**
1087      * rate control equation.
1088      * - encoding: set by user
1089      * - decoding: unused
1090      */
1091     char *rc_eq;
1092
1093     /**
1094      * maximum bitrate.
1095      * - encoding: set by user.
1096      * - decoding: unused
1097      */
1098     int rc_max_rate;
1099
1100     /**
1101      * minimum bitrate.
1102      * - encoding: set by user.
1103      * - decoding: unused
1104      */
1105     int rc_min_rate;
1106
1107     /**
1108      * decoder bitstream buffer size.
1109      * - encoding: set by user.
1110      * - decoding: unused
1111      */
1112     int rc_buffer_size;
1113     float rc_buffer_aggressivity;
1114
1115     /**
1116      * qscale factor between p and i frames.
1117      * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
1118      * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
1119      * - encoding: set by user.
1120      * - decoding: unused
1121      */
1122     float i_quant_factor;
1123
1124     /**
1125      * qscale offset between p and i frames.
1126      * - encoding: set by user.
1127      * - decoding: unused
1128      */
1129     float i_quant_offset;
1130
1131     /**
1132      * initial complexity for pass1 ratecontrol.
1133      * - encoding: set by user.
1134      * - decoding: unused
1135      */
1136     float rc_initial_cplx;
1137
1138     /**
1139      * dct algorithm, see FF_DCT_* below.
1140      * - encoding: set by user
1141      * - decoding: unused
1142      */
1143     int dct_algo;
1144 #define FF_DCT_AUTO    0
1145 #define FF_DCT_FASTINT 1
1146 #define FF_DCT_INT     2
1147 #define FF_DCT_MMX     3
1148 #define FF_DCT_MLIB    4
1149 #define FF_DCT_ALTIVEC 5
1150 #define FF_DCT_FAAN    6
1151
1152     /**
1153      * luminance masking (0-> disabled).
1154      * - encoding: set by user
1155      * - decoding: unused
1156      */
1157     float lumi_masking;
1158
1159     /**
1160      * temporary complexity masking (0-> disabled).
1161      * - encoding: set by user
1162      * - decoding: unused
1163      */
1164     float temporal_cplx_masking;
1165
1166     /**
1167      * spatial complexity masking (0-> disabled).
1168      * - encoding: set by user
1169      * - decoding: unused
1170      */
1171     float spatial_cplx_masking;
1172
1173     /**
1174      * p block masking (0-> disabled).
1175      * - encoding: set by user
1176      * - decoding: unused
1177      */
1178     float p_masking;
1179
1180     /**
1181      * darkness masking (0-> disabled).
1182      * - encoding: set by user
1183      * - decoding: unused
1184      */
1185     float dark_masking;
1186
1187
1188     /* for binary compatibility */
1189     int unused;
1190
1191     /**
1192      * idct algorithm, see FF_IDCT_* below.
1193      * - encoding: set by user
1194      * - decoding: set by user
1195      */
1196     int idct_algo;
1197 #define FF_IDCT_AUTO         0
1198 #define FF_IDCT_INT          1
1199 #define FF_IDCT_SIMPLE       2
1200 #define FF_IDCT_SIMPLEMMX    3
1201 #define FF_IDCT_LIBMPEG2MMX  4
1202 #define FF_IDCT_PS2          5
1203 #define FF_IDCT_MLIB         6
1204 #define FF_IDCT_ARM          7
1205 #define FF_IDCT_ALTIVEC      8
1206 #define FF_IDCT_SH4          9
1207 #define FF_IDCT_SIMPLEARM    10
1208 #define FF_IDCT_H264         11
1209 #define FF_IDCT_VP3          12
1210 #define FF_IDCT_IPP          13
1211
1212     /**
1213      * slice count.
1214      * - encoding: set by lavc
1215      * - decoding: set by user (or 0)
1216      */
1217     int slice_count;
1218     /**
1219      * slice offsets in the frame in bytes.
1220      * - encoding: set/allocated by lavc
1221      * - decoding: set/allocated by user (or NULL)
1222      */
1223     int *slice_offset;
1224
1225     /**
1226      * error concealment flags.
1227      * - encoding: unused
1228      * - decoding: set by user
1229      */
1230     int error_concealment;
1231 #define FF_EC_GUESS_MVS   1
1232 #define FF_EC_DEBLOCK     2
1233
1234     /**
1235      * dsp_mask could be add used to disable unwanted CPU features
1236      * CPU features (i.e. MMX, SSE. ...)
1237      *
1238      * with FORCE flag you may instead enable given CPU features
1239      * (Dangerous: usable in case of misdetection, improper usage however will
1240      * result into program crash)
1241      */
1242     unsigned dsp_mask;
1243 #define FF_MM_FORCE     0x80000000 /* force usage of selected flags (OR) */
1244     /* lower 16 bits - CPU features */
1245 #ifdef HAVE_MMX
1246 #define FF_MM_MMX       0x0001 /* standard MMX */
1247 #define FF_MM_3DNOW     0x0004 /* AMD 3DNOW */
1248 #define FF_MM_MMXEXT    0x0002 /* SSE integer functions or AMD MMX ext */
1249 #define FF_MM_SSE       0x0008 /* SSE functions */
1250 #define FF_MM_SSE2      0x0010 /* PIV SSE2 functions */
1251 #define FF_MM_3DNOWEXT  0x0020 /* AMD 3DNowExt */
1252 #endif /* HAVE_MMX */
1253 #ifdef HAVE_IWMMXT
1254 #define FF_MM_IWMMXT    0x0100 /* XScale IWMMXT */
1255 #endif /* HAVE_IWMMXT */
1256
1257     /**
1258      * bits per sample/pixel from the demuxer (needed for huffyuv).
1259      * - encoding: set by lavc
1260      * - decoding: set by user
1261      */
1262      int bits_per_sample;
1263
1264     /**
1265      * prediction method (needed for huffyuv).
1266      * - encoding: set by user
1267      * - decoding: unused
1268      */
1269      int prediction_method;
1270 #define FF_PRED_LEFT   0
1271 #define FF_PRED_PLANE  1
1272 #define FF_PRED_MEDIAN 2
1273
1274     /**
1275      * sample aspect ratio (0 if unknown).
1276      * numerator and denominator must be relative prime and smaller then 256 for some video standards
1277      * - encoding: set by user.
1278      * - decoding: set by lavc.
1279      */
1280     AVRational sample_aspect_ratio;
1281
1282     /**
1283      * the picture in the bitstream.
1284      * - encoding: set by lavc
1285      * - decoding: set by lavc
1286      */
1287     AVFrame *coded_frame;
1288
1289     /**
1290      * debug.
1291      * - encoding: set by user.
1292      * - decoding: set by user.
1293      */
1294     int debug;
1295 #define FF_DEBUG_PICT_INFO 1
1296 #define FF_DEBUG_RC        2
1297 #define FF_DEBUG_BITSTREAM 4
1298 #define FF_DEBUG_MB_TYPE   8
1299 #define FF_DEBUG_QP        16
1300 #define FF_DEBUG_MV        32
1301 #define FF_DEBUG_DCT_COEFF 0x00000040
1302 #define FF_DEBUG_SKIP      0x00000080
1303 #define FF_DEBUG_STARTCODE 0x00000100
1304 #define FF_DEBUG_PTS       0x00000200
1305 #define FF_DEBUG_ER        0x00000400
1306 #define FF_DEBUG_MMCO      0x00000800
1307 #define FF_DEBUG_BUGS      0x00001000
1308 #define FF_DEBUG_VIS_QP    0x00002000
1309 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1310
1311     /**
1312      * debug.
1313      * - encoding: set by user.
1314      * - decoding: set by user.
1315      */
1316     int debug_mv;
1317 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1318 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1319 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1320
1321     /**
1322      * error.
1323      * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
1324      * - decoding: unused
1325      */
1326     uint64_t error[4];
1327
1328     /**
1329      * minimum MB quantizer.
1330      * - encoding: unused
1331      * - decoding: unused
1332      */
1333     int mb_qmin;
1334
1335     /**
1336      * maximum MB quantizer.
1337      * - encoding: unused
1338      * - decoding: unused
1339      */
1340     int mb_qmax;
1341
1342     /**
1343      * motion estimation compare function.
1344      * - encoding: set by user.
1345      * - decoding: unused
1346      */
1347     int me_cmp;
1348     /**
1349      * subpixel motion estimation compare function.
1350      * - encoding: set by user.
1351      * - decoding: unused
1352      */
1353     int me_sub_cmp;
1354     /**
1355      * macroblock compare function (not supported yet).
1356      * - encoding: set by user.
1357      * - decoding: unused
1358      */
1359     int mb_cmp;
1360     /**
1361      * interlaced dct compare function
1362      * - encoding: set by user.
1363      * - decoding: unused
1364      */
1365     int ildct_cmp;
1366 #define FF_CMP_SAD  0
1367 #define FF_CMP_SSE  1
1368 #define FF_CMP_SATD 2
1369 #define FF_CMP_DCT  3
1370 #define FF_CMP_PSNR 4
1371 #define FF_CMP_BIT  5
1372 #define FF_CMP_RD   6
1373 #define FF_CMP_ZERO 7
1374 #define FF_CMP_VSAD 8
1375 #define FF_CMP_VSSE 9
1376 #define FF_CMP_NSSE 10
1377 #define FF_CMP_W53  11
1378 #define FF_CMP_W97  12
1379 #define FF_CMP_DCTMAX 13
1380 #define FF_CMP_CHROMA 256
1381
1382     /**
1383      * ME diamond size & shape.
1384      * - encoding: set by user.
1385      * - decoding: unused
1386      */
1387     int dia_size;
1388
1389     /**
1390      * amount of previous MV predictors (2a+1 x 2a+1 square).
1391      * - encoding: set by user.
1392      * - decoding: unused
1393      */
1394     int last_predictor_count;
1395
1396     /**
1397      * pre pass for motion estimation.
1398      * - encoding: set by user.
1399      * - decoding: unused
1400      */
1401     int pre_me;
1402
1403     /**
1404      * motion estimation pre pass compare function.
1405      * - encoding: set by user.
1406      * - decoding: unused
1407      */
1408     int me_pre_cmp;
1409
1410     /**
1411      * ME pre pass diamond size & shape.
1412      * - encoding: set by user.
1413      * - decoding: unused
1414      */
1415     int pre_dia_size;
1416
1417     /**
1418      * subpel ME quality.
1419      * - encoding: set by user.
1420      * - decoding: unused
1421      */
1422     int me_subpel_quality;
1423
1424     /**
1425      * callback to negotiate the pixelFormat.
1426      * @param fmt is the list of formats which are supported by the codec,
1427      * its terminated by -1 as 0 is a valid format, the formats are ordered by quality
1428      * the first is allways the native one
1429      * @return the choosen format
1430      * - encoding: unused
1431      * - decoding: set by user, if not set then the native format will always be choosen
1432      */
1433     enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1434
1435     /**
1436      * DTG active format information (additionnal aspect ratio
1437      * information only used in DVB MPEG2 transport streams). 0 if
1438      * not set.
1439      *
1440      * - encoding: unused.
1441      * - decoding: set by decoder
1442      */
1443     int dtg_active_format;
1444 #define FF_DTG_AFD_SAME         8
1445 #define FF_DTG_AFD_4_3          9
1446 #define FF_DTG_AFD_16_9         10
1447 #define FF_DTG_AFD_14_9         11
1448 #define FF_DTG_AFD_4_3_SP_14_9  13
1449 #define FF_DTG_AFD_16_9_SP_14_9 14
1450 #define FF_DTG_AFD_SP_4_3       15
1451
1452     /**
1453      * Maximum motion estimation search range in subpel units.
1454      * if 0 then no limit
1455      *
1456      * - encoding: set by user.
1457      * - decoding: unused.
1458      */
1459     int me_range;
1460
1461     /**
1462      * intra quantizer bias.
1463      * - encoding: set by user.
1464      * - decoding: unused
1465      */
1466     int intra_quant_bias;
1467 #define FF_DEFAULT_QUANT_BIAS 999999
1468
1469     /**
1470      * inter quantizer bias.
1471      * - encoding: set by user.
1472      * - decoding: unused
1473      */
1474     int inter_quant_bias;
1475
1476     /**
1477      * color table ID.
1478      * - encoding: unused.
1479      * - decoding: which clrtable should be used for 8bit RGB images
1480      *             table have to be stored somewhere FIXME
1481      */
1482     int color_table_id;
1483
1484     /**
1485      * internal_buffer count.
1486      * Don't touch, used by lavc default_get_buffer()
1487      */
1488     int internal_buffer_count;
1489
1490     /**
1491      * internal_buffers.
1492      * Don't touch, used by lavc default_get_buffer()
1493      */
1494     void *internal_buffer;
1495
1496 #define FF_LAMBDA_SHIFT 7
1497 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1498 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1499 #define FF_LAMBDA_MAX (256*128-1)
1500
1501 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1502     /**
1503      * global quality for codecs which cannot change it per frame.
1504      * this should be proportional to MPEG1/2/4 qscale.
1505      * - encoding: set by user.
1506      * - decoding: unused
1507      */
1508     int global_quality;
1509
1510 #define FF_CODER_TYPE_VLC   0
1511 #define FF_CODER_TYPE_AC    1
1512     /**
1513      * coder type
1514      * - encoding: set by user.
1515      * - decoding: unused
1516      */
1517     int coder_type;
1518
1519     /**
1520      * context model
1521      * - encoding: set by user.
1522      * - decoding: unused
1523      */
1524     int context_model;
1525
1526     /**
1527      * slice flags
1528      * - encoding: unused
1529      * - decoding: set by user.
1530      */
1531     int slice_flags;
1532 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1533 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1534 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1535
1536     /**
1537      * XVideo Motion Acceleration
1538      * - encoding: forbidden
1539      * - decoding: set by decoder
1540      */
1541     int xvmc_acceleration;
1542
1543     /**
1544      * macroblock decision mode
1545      * - encoding: set by user.
1546      * - decoding: unused
1547      */
1548     int mb_decision;
1549 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1550 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1551 #define FF_MB_DECISION_RD     2        ///< rate distoration
1552
1553     /**
1554      * custom intra quantization matrix
1555      * - encoding: set by user, can be NULL
1556      * - decoding: set by lavc
1557      */
1558     uint16_t *intra_matrix;
1559
1560     /**
1561      * custom inter quantization matrix
1562      * - encoding: set by user, can be NULL
1563      * - decoding: set by lavc
1564      */
1565     uint16_t *inter_matrix;
1566
1567     /**
1568      * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1569      * this is used to workaround some encoder bugs
1570      * - encoding: unused
1571      * - decoding: set by user, will be converted to upper case by lavc during init
1572      */
1573     unsigned int stream_codec_tag;
1574
1575     /**
1576      * scene change detection threshold.
1577      * 0 is default, larger means fewer detected scene changes
1578      * - encoding: set by user.
1579      * - decoding: unused
1580      */
1581     int scenechange_threshold;
1582
1583     /**
1584      * minimum lagrange multipler
1585      * - encoding: set by user.
1586      * - decoding: unused
1587      */
1588     int lmin;
1589
1590     /**
1591      * maximum lagrange multipler
1592      * - encoding: set by user.
1593      * - decoding: unused
1594      */
1595     int lmax;
1596
1597     /**
1598      * Palette control structure
1599      * - encoding: ??? (no palette-enabled encoder yet)
1600      * - decoding: set by user.
1601      */
1602     struct AVPaletteControl *palctrl;
1603
1604     /**
1605      * noise reduction strength
1606      * - encoding: set by user.
1607      * - decoding: unused
1608      */
1609     int noise_reduction;
1610
1611     /**
1612      * called at the beginning of a frame to get cr buffer for it.
1613      * buffer type (size, hints) must be the same. lavc won't check it.
1614      * lavc will pass previous buffer in pic, function should return
1615      * same buffer or new buffer with old frame "painted" into it.
1616      * if pic.data[0] == NULL must behave like get_buffer().
1617      * - encoding: unused
1618      * - decoding: set by lavc, user can override
1619      */
1620     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1621
1622     /**
1623      * number of bits which should be loaded into the rc buffer before decoding starts
1624      * - encoding: set by user.
1625      * - decoding: unused
1626      */
1627     int rc_initial_buffer_occupancy;
1628
1629     /**
1630      *
1631      * - encoding: set by user.
1632      * - decoding: unused
1633      */
1634     int inter_threshold;
1635
1636     /**
1637      * CODEC_FLAG2_*.
1638      * - encoding: set by user.
1639      * - decoding: set by user.
1640      */
1641     int flags2;
1642
1643     /**
1644      * simulates errors in the bitstream to test error concealment.
1645      * - encoding: set by user.
1646      * - decoding: unused.
1647      */
1648     int error_rate;
1649
1650     /**
1651      * MP3 antialias algorithm, see FF_AA_* below.
1652      * - encoding: unused
1653      * - decoding: set by user
1654      */
1655     int antialias_algo;
1656 #define FF_AA_AUTO    0
1657 #define FF_AA_FASTINT 1 //not implemented yet
1658 #define FF_AA_INT     2
1659 #define FF_AA_FLOAT   3
1660     /**
1661      * Quantizer noise shaping.
1662      * - encoding: set by user
1663      * - decoding: unused
1664      */
1665     int quantizer_noise_shaping;
1666
1667     /**
1668      * Thread count.
1669      * is used to decide how many independant tasks should be passed to execute()
1670      * - encoding: set by user
1671      * - decoding: set by user
1672      */
1673     int thread_count;
1674
1675     /**
1676      * the codec may call this to execute several independant things. it will return only after
1677      * finishing all tasks, the user may replace this with some multithreaded implementation, the
1678      * default implementation will execute the parts serially
1679      * @param count the number of things to execute
1680      * - encoding: set by lavc, user can override
1681      * - decoding: set by lavc, user can override
1682      */
1683     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1684
1685     /**
1686      * Thread opaque.
1687      * can be used by execute() to store some per AVCodecContext stuff.
1688      * - encoding: set by execute()
1689      * - decoding: set by execute()
1690      */
1691     void *thread_opaque;
1692
1693     /**
1694      * Motion estimation threshold. under which no motion estimation is
1695      * performed, but instead the user specified motion vectors are used
1696      *
1697      * - encoding: set by user
1698      * - decoding: unused
1699      */
1700      int me_threshold;
1701
1702     /**
1703      * Macroblock threshold. under which the user specified macroblock types will be used
1704      * - encoding: set by user
1705      * - decoding: unused
1706      */
1707      int mb_threshold;
1708
1709     /**
1710      * precision of the intra dc coefficient - 8.
1711      * - encoding: set by user
1712      * - decoding: unused
1713      */
1714      int intra_dc_precision;
1715
1716     /**
1717      * noise vs. sse weight for the nsse comparsion function.
1718      * - encoding: set by user
1719      * - decoding: unused
1720      */
1721      int nsse_weight;
1722
1723     /**
1724      * number of macroblock rows at the top which are skipped.
1725      * - encoding: unused
1726      * - decoding: set by user
1727      */
1728      int skip_top;
1729
1730     /**
1731      * number of macroblock rows at the bottom which are skipped.
1732      * - encoding: unused
1733      * - decoding: set by user
1734      */
1735      int skip_bottom;
1736
1737     /**
1738      * profile
1739      * - encoding: set by user
1740      * - decoding: set by lavc
1741      */
1742      int profile;
1743 #define FF_PROFILE_UNKNOWN -99
1744
1745     /**
1746      * level
1747      * - encoding: set by user
1748      * - decoding: set by lavc
1749      */
1750      int level;
1751 #define FF_LEVEL_UNKNOWN -99
1752
1753     /**
1754      * low resolution decoding. 1-> 1/2 size, 2->1/4 size
1755      * - encoding: unused
1756      * - decoding: set by user
1757      */
1758      int lowres;
1759
1760     /**
1761      * bitsream width / height. may be different from width/height if lowres
1762      * or other things are used
1763      * - encoding: unused
1764      * - decoding: set by user before init if known, codec should override / dynamically change if needed
1765      */
1766     int coded_width, coded_height;
1767
1768     /**
1769      * frame skip threshold
1770      * - encoding: set by user
1771      * - decoding: unused
1772      */
1773     int frame_skip_threshold;
1774
1775     /**
1776      * frame skip factor
1777      * - encoding: set by user
1778      * - decoding: unused
1779      */
1780     int frame_skip_factor;
1781
1782     /**
1783      * frame skip exponent
1784      * - encoding: set by user
1785      * - decoding: unused
1786      */
1787     int frame_skip_exp;
1788
1789     /**
1790      * frame skip comparission function
1791      * - encoding: set by user.
1792      * - decoding: unused
1793      */
1794     int frame_skip_cmp;
1795
1796     /**
1797      * border processing masking. raises the quantizer for mbs on the borders
1798      * of the picture.
1799      * - encoding: set by user
1800      * - decoding: unused
1801      */
1802     float border_masking;
1803
1804     /**
1805      * minimum MB lagrange multipler.
1806      * - encoding: set by user.
1807      * - decoding: unused
1808      */
1809     int mb_lmin;
1810
1811     /**
1812      * maximum MB lagrange multipler.
1813      * - encoding: set by user.
1814      * - decoding: unused
1815      */
1816     int mb_lmax;
1817
1818     /**
1819      *
1820      * - encoding: set by user.
1821      * - decoding: unused
1822      */
1823     int me_penalty_compensation;
1824
1825     /**
1826      *
1827      * - encoding: unused
1828      * - decoding: set by user.
1829      */
1830     enum AVDiscard skip_loop_filter;
1831
1832     /**
1833      *
1834      * - encoding: unused
1835      * - decoding: set by user.
1836      */
1837     enum AVDiscard skip_idct;
1838
1839     /**
1840      *
1841      * - encoding: unused
1842      * - decoding: set by user.
1843      */
1844     enum AVDiscard skip_frame;
1845 } AVCodecContext;
1846
1847
1848 /**
1849  * AVOption.
1850  */
1851 typedef struct AVOption {
1852     /** options' name */
1853     const char *name; /* if name is NULL, it indicates a link to next */
1854     /** short English text help or const struct AVOption* subpointer */
1855     const char *help; //        const struct AVOption* sub;
1856     /** offset to context structure where the parsed value should be stored */
1857     int offset;
1858     /** options' type */
1859     int type;
1860 #define FF_OPT_TYPE_BOOL 1      ///< boolean - true,1,on  (or simply presence)
1861 #define FF_OPT_TYPE_DOUBLE 2    ///< double
1862 #define FF_OPT_TYPE_INT 3       ///< integer
1863 #define FF_OPT_TYPE_STRING 4    ///< string (finished with \0)
1864 #define FF_OPT_TYPE_MASK 0x1f   ///< mask for types - upper bits are various flags
1865 //#define FF_OPT_TYPE_EXPERT 0x20 // flag for expert option
1866 #define FF_OPT_TYPE_FLAG (FF_OPT_TYPE_BOOL | 0x40)
1867 #define FF_OPT_TYPE_RCOVERRIDE (FF_OPT_TYPE_STRING | 0x80)
1868     /** min value  (min == max   ->  no limits) */
1869     double min;
1870     /** maximum value for double/int */
1871     double max;
1872     /** default boo [0,1]l/double/int value */
1873     double defval;
1874     /**
1875      * default string value (with optional semicolon delimited extra option-list
1876      * i.e.   option1;option2;option3
1877      * defval might select other then first argument as default
1878      */
1879     const char *defstr;
1880 #define FF_OPT_MAX_DEPTH 10
1881 } AVOption;
1882
1883 /**
1884  * AVCodec.
1885  */
1886 typedef struct AVCodec {
1887     const char *name;
1888     enum CodecType type;
1889     enum CodecID id;
1890     int priv_data_size;
1891     int (*init)(AVCodecContext *);
1892     int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
1893     int (*close)(AVCodecContext *);
1894     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
1895                   uint8_t *buf, int buf_size);
1896     int capabilities;
1897     void *dummy; // FIXME remove next time we break binary compatibility
1898     struct AVCodec *next;
1899     void (*flush)(AVCodecContext *);
1900     const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
1901     const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
1902 } AVCodec;
1903
1904 /**
1905  * four components are given, that's all.
1906  * the last component is alpha
1907  */
1908 typedef struct AVPicture {
1909     uint8_t *data[4];
1910     int linesize[4];       ///< number of bytes per line
1911 } AVPicture;
1912
1913 /**
1914  * AVPaletteControl
1915  * This structure defines a method for communicating palette changes
1916  * between and demuxer and a decoder.
1917  */
1918 #define AVPALETTE_SIZE 1024
1919 #define AVPALETTE_COUNT 256
1920 typedef struct AVPaletteControl {
1921
1922     /* demuxer sets this to 1 to indicate the palette has changed;
1923      * decoder resets to 0 */
1924     int palette_changed;
1925
1926     /* 4-byte ARGB palette entries, stored in native byte order; note that
1927      * the individual palette components should be on a 8-bit scale; if
1928      * the palette data comes from a IBM VGA native format, the component
1929      * data is probably 6 bits in size and needs to be scaled */
1930     unsigned int palette[AVPALETTE_COUNT];
1931
1932 } AVPaletteControl;
1933
1934 typedef struct AVSubtitleRect {
1935     uint16_t x;
1936     uint16_t y;
1937     uint16_t w;
1938     uint16_t h;
1939     uint16_t nb_colors;
1940     int linesize;
1941     uint32_t *rgba_palette;
1942     uint8_t *bitmap;
1943 } AVSubtitleRect;
1944
1945 typedef struct AVSubtitle {
1946     uint16_t format; /* 0 = graphics */
1947     uint32_t start_display_time; /* relative to packet pts, in ms */
1948     uint32_t end_display_time; /* relative to packet pts, in ms */
1949     uint32_t num_rects;
1950     AVSubtitleRect *rects;
1951 } AVSubtitle;
1952
1953 extern AVCodec ac3_encoder;
1954 extern AVCodec mp2_encoder;
1955 extern AVCodec mp3lame_encoder;
1956 extern AVCodec oggvorbis_encoder;
1957 extern AVCodec oggtheora_encoder;
1958 extern AVCodec faac_encoder;
1959 extern AVCodec xvid_encoder;
1960 extern AVCodec mpeg1video_encoder;
1961 extern AVCodec mpeg2video_encoder;
1962 extern AVCodec h261_encoder;
1963 extern AVCodec h263_encoder;
1964 extern AVCodec h263p_encoder;
1965 extern AVCodec flv_encoder;
1966 extern AVCodec rv10_encoder;
1967 extern AVCodec rv20_encoder;
1968 extern AVCodec dvvideo_encoder;
1969 extern AVCodec mjpeg_encoder;
1970 extern AVCodec ljpeg_encoder;
1971 extern AVCodec png_encoder;
1972 extern AVCodec ppm_encoder;
1973 extern AVCodec pgm_encoder;
1974 extern AVCodec pgmyuv_encoder;
1975 extern AVCodec pbm_encoder;
1976 extern AVCodec pam_encoder;
1977 extern AVCodec mpeg4_encoder;
1978 extern AVCodec msmpeg4v1_encoder;
1979 extern AVCodec msmpeg4v2_encoder;
1980 extern AVCodec msmpeg4v3_encoder;
1981 extern AVCodec wmv1_encoder;
1982 extern AVCodec wmv2_encoder;
1983 extern AVCodec huffyuv_encoder;
1984 extern AVCodec ffvhuff_encoder;
1985 extern AVCodec h264_encoder;
1986 extern AVCodec asv1_encoder;
1987 extern AVCodec asv2_encoder;
1988 extern AVCodec vcr1_encoder;
1989 extern AVCodec ffv1_encoder;
1990 extern AVCodec snow_encoder;
1991 extern AVCodec mdec_encoder;
1992 extern AVCodec zlib_encoder;
1993 extern AVCodec sonic_encoder;
1994 extern AVCodec sonic_ls_encoder;
1995 extern AVCodec svq1_encoder;
1996 extern AVCodec x264_encoder;
1997
1998 extern AVCodec h263_decoder;
1999 extern AVCodec h261_decoder;
2000 extern AVCodec mpeg4_decoder;
2001 extern AVCodec msmpeg4v1_decoder;
2002 extern AVCodec msmpeg4v2_decoder;
2003 extern AVCodec msmpeg4v3_decoder;
2004 extern AVCodec wmv1_decoder;
2005 extern AVCodec wmv2_decoder;
2006 extern AVCodec vc9_decoder;
2007 extern AVCodec wmv3_decoder;
2008 extern AVCodec mpeg1video_decoder;
2009 extern AVCodec mpeg2video_decoder;
2010 extern AVCodec mpegvideo_decoder;
2011 extern AVCodec mpeg_xvmc_decoder;
2012 extern AVCodec h263i_decoder;
2013 extern AVCodec flv_decoder;
2014 extern AVCodec rv10_decoder;
2015 extern AVCodec rv20_decoder;
2016 extern AVCodec rv30_decoder;
2017 extern AVCodec rv40_decoder;
2018 extern AVCodec svq1_decoder;
2019 extern AVCodec svq3_decoder;
2020 extern AVCodec dvvideo_decoder;
2021 extern AVCodec wmav1_decoder;
2022 extern AVCodec wmav2_decoder;
2023 extern AVCodec mjpeg_decoder;
2024 extern AVCodec mjpegb_decoder;
2025 extern AVCodec sp5x_decoder;
2026 extern AVCodec png_decoder;
2027 extern AVCodec mp2_decoder;
2028 extern AVCodec mp3_decoder;
2029 extern AVCodec mp3adu_decoder;
2030 extern AVCodec mp3on4_decoder;
2031 extern AVCodec mace3_decoder;
2032 extern AVCodec mace6_decoder;
2033 extern AVCodec huffyuv_decoder;
2034 extern AVCodec ffvhuff_decoder;
2035 extern AVCodec oggvorbis_decoder;
2036 extern AVCodec oggtheora_decoder;
2037 extern AVCodec cyuv_decoder;
2038 extern AVCodec h264_decoder;
2039 extern AVCodec indeo3_decoder;
2040 extern AVCodec vp3_decoder;
2041 extern AVCodec theora_decoder;
2042 extern AVCodec amr_nb_decoder;
2043 extern AVCodec amr_nb_encoder;
2044 extern AVCodec amr_wb_encoder;
2045 extern AVCodec amr_wb_decoder;
2046 extern AVCodec aac_decoder;
2047 extern AVCodec mpeg4aac_decoder;
2048 extern AVCodec asv1_decoder;
2049 extern AVCodec asv2_decoder;
2050 extern AVCodec vcr1_decoder;
2051 extern AVCodec cljr_decoder;
2052 extern AVCodec ffv1_decoder;
2053 extern AVCodec snow_decoder;
2054 extern AVCodec fourxm_decoder;
2055 extern AVCodec mdec_decoder;
2056 extern AVCodec roq_decoder;
2057 extern AVCodec interplay_video_decoder;
2058 extern AVCodec xan_wc3_decoder;
2059 extern AVCodec rpza_decoder;
2060 extern AVCodec cinepak_decoder;
2061 extern AVCodec msrle_decoder;
2062 extern AVCodec msvideo1_decoder;
2063 extern AVCodec vqa_decoder;
2064 extern AVCodec idcin_decoder;
2065 extern AVCodec eightbps_decoder;
2066 extern AVCodec smc_decoder;
2067 extern AVCodec flic_decoder;
2068 extern AVCodec vmdvideo_decoder;
2069 extern AVCodec vmdaudio_decoder;
2070 extern AVCodec truemotion1_decoder;
2071 extern AVCodec mszh_decoder;
2072 extern AVCodec zlib_decoder;
2073 extern AVCodec ra_144_decoder;
2074 extern AVCodec ra_288_decoder;
2075 extern AVCodec roq_dpcm_decoder;
2076 extern AVCodec interplay_dpcm_decoder;
2077 extern AVCodec xan_dpcm_decoder;
2078 extern AVCodec sol_dpcm_decoder;
2079 extern AVCodec sonic_decoder;
2080 extern AVCodec qtrle_decoder;
2081 extern AVCodec flac_decoder;
2082 extern AVCodec tscc_decoder;
2083 extern AVCodec ulti_decoder;
2084 extern AVCodec qdraw_decoder;
2085 extern AVCodec xl_decoder;
2086 extern AVCodec qpeg_decoder;
2087 extern AVCodec shorten_decoder;
2088 extern AVCodec loco_decoder;
2089 extern AVCodec wnv1_decoder;
2090 extern AVCodec aasc_decoder;
2091 extern AVCodec alac_decoder;
2092 extern AVCodec ws_snd1_decoder;
2093 extern AVCodec indeo2_decoder;
2094 extern AVCodec vorbis_decoder;
2095 extern AVCodec fraps_decoder;
2096 extern AVCodec libgsm_encoder;
2097 extern AVCodec libgsm_decoder;
2098
2099 /* pcm codecs */
2100 #define PCM_CODEC(id, name) \
2101 extern AVCodec name ## _decoder; \
2102 extern AVCodec name ## _encoder
2103
2104 PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
2105 PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
2106 PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
2107 PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
2108 PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
2109 PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
2110 PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
2111 PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
2112
2113 /* adpcm codecs */
2114
2115 PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
2116 PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
2117 PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
2118 PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
2119 PCM_CODEC(CODEC_ID_ADPCM_IMA_WS, adpcm_ima_ws);
2120 PCM_CODEC(CODEC_ID_ADPCM_SMJPEG, adpcm_ima_smjpeg);
2121 PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
2122 PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
2123 PCM_CODEC(CODEC_ID_ADPCM_XA, adpcm_xa);
2124 PCM_CODEC(CODEC_ID_ADPCM_ADX, adpcm_adx);
2125 PCM_CODEC(CODEC_ID_ADPCM_EA, adpcm_ea);
2126 PCM_CODEC(CODEC_ID_ADPCM_G726, adpcm_g726);
2127 PCM_CODEC(CODEC_ID_ADPCM_CT, adpcm_ct);
2128 PCM_CODEC(CODEC_ID_ADPCM_SWF, adpcm_swf);
2129 PCM_CODEC(CODEC_ID_ADPCM_YAMAHA, adpcm_yamaha);
2130
2131 #undef PCM_CODEC
2132
2133 /* dummy raw video codec */
2134 extern AVCodec rawvideo_encoder;
2135 extern AVCodec rawvideo_decoder;
2136
2137 /* the following codecs use external GPL libs */
2138 extern AVCodec ac3_decoder;
2139 extern AVCodec dts_decoder;
2140
2141 /* subtitles */
2142 extern AVCodec dvdsub_decoder;
2143 extern AVCodec dvbsub_encoder;
2144 extern AVCodec dvbsub_decoder;
2145
2146 /* resample.c */
2147
2148 struct ReSampleContext;
2149 struct AVResampleContext;
2150
2151 typedef struct ReSampleContext ReSampleContext;
2152
2153 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2154                                      int output_rate, int input_rate);
2155 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2156 void audio_resample_close(ReSampleContext *s);
2157
2158 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2159 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2160 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2161 void av_resample_close(struct AVResampleContext *c);
2162
2163 /* YUV420 format is assumed ! */
2164
2165 struct ImgReSampleContext;
2166
2167 typedef struct ImgReSampleContext ImgReSampleContext;
2168
2169 ImgReSampleContext *img_resample_init(int output_width, int output_height,
2170                                       int input_width, int input_height);
2171
2172 ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2173                                       int iwidth, int iheight,
2174                                       int topBand, int bottomBand,
2175                                       int leftBand, int rightBand,
2176                                       int padtop, int padbottom,
2177                                       int padleft, int padright);
2178
2179
2180 void img_resample(ImgReSampleContext *s,
2181                   AVPicture *output, const AVPicture *input);
2182
2183 void img_resample_close(ImgReSampleContext *s);
2184
2185 /**
2186  * Allocate memory for a picture.  Call avpicture_free to free it.
2187  *
2188  * @param picture the picture to be filled in.
2189  * @param pix_fmt the format of the picture.
2190  * @param width the width of the picture.
2191  * @param height the height of the picture.
2192  * @return 0 if successful, -1 if not.
2193  */
2194 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2195
2196 /* Free a picture previously allocated by avpicture_alloc. */
2197 void avpicture_free(AVPicture *picture);
2198
2199 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2200                    int pix_fmt, int width, int height);
2201 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2202                      unsigned char *dest, int dest_size);
2203 int avpicture_get_size(int pix_fmt, int width, int height);
2204 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2205 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2206 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2207 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2208 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2209
2210 #define FF_LOSS_RESOLUTION  0x0001 /* loss due to resolution change */
2211 #define FF_LOSS_DEPTH       0x0002 /* loss due to color depth change */
2212 #define FF_LOSS_COLORSPACE  0x0004 /* loss due to color space conversion */
2213 #define FF_LOSS_ALPHA       0x0008 /* loss of alpha bits */
2214 #define FF_LOSS_COLORQUANT  0x0010 /* loss due to color quantization */
2215 #define FF_LOSS_CHROMA      0x0020 /* loss of chroma (e.g. rgb to gray conversion) */
2216
2217 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2218                              int has_alpha);
2219 int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2220                               int has_alpha, int *loss_ptr);
2221
2222 #define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
2223 #define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2224 int img_get_alpha_info(const AVPicture *src,
2225                        int pix_fmt, int width, int height);
2226
2227 /* convert among pixel formats */
2228 int img_convert(AVPicture *dst, int dst_pix_fmt,
2229                 const AVPicture *src, int pix_fmt,
2230                 int width, int height);
2231
2232 /* deinterlace a picture */
2233 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2234                           int pix_fmt, int width, int height);
2235
2236 /* external high level API */
2237
2238 extern AVCodec *first_avcodec;
2239
2240 /* returns LIBAVCODEC_VERSION_INT constant */
2241 unsigned avcodec_version(void);
2242 /* returns LIBAVCODEC_BUILD constant */
2243 unsigned avcodec_build(void);
2244 void avcodec_init(void);
2245
2246 void register_avcodec(AVCodec *format);
2247 AVCodec *avcodec_find_encoder(enum CodecID id);
2248 AVCodec *avcodec_find_encoder_by_name(const char *name);
2249 AVCodec *avcodec_find_decoder(enum CodecID id);
2250 AVCodec *avcodec_find_decoder_by_name(const char *name);
2251 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2252
2253 void avcodec_get_context_defaults(AVCodecContext *s);
2254 AVCodecContext *avcodec_alloc_context(void);
2255 void avcodec_get_frame_defaults(AVFrame *pic);
2256 AVFrame *avcodec_alloc_frame(void);
2257
2258 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2259 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2260 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2261 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2262 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2263 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2264
2265 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2266 void avcodec_thread_free(AVCodecContext *s);
2267 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2268 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2269 //FIXME func typedef
2270
2271 /**
2272  * opens / inits the AVCodecContext.
2273  * not thread save!
2274  */
2275 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2276
2277 int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2278                          int *frame_size_ptr,
2279                          uint8_t *buf, int buf_size);
2280 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2281                          int *got_picture_ptr,
2282                          uint8_t *buf, int buf_size);
2283 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2284                             int *got_sub_ptr,
2285                             const uint8_t *buf, int buf_size);
2286 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2287                         int *data_size_ptr,
2288                         uint8_t *buf, int buf_size);
2289 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2290                          const short *samples);
2291 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2292                          const AVFrame *pict);
2293 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2294                             const AVSubtitle *sub);
2295
2296 int avcodec_close(AVCodecContext *avctx);
2297
2298 void avcodec_register_all(void);
2299
2300 void avcodec_flush_buffers(AVCodecContext *avctx);
2301
2302 void avcodec_default_free_buffers(AVCodecContext *s);
2303
2304 /* misc usefull functions */
2305
2306 /**
2307  * returns a single letter to describe the picture type
2308  */
2309 char av_get_pict_type_char(int pict_type);
2310
2311 /**
2312  * reduce a fraction.
2313  * this is usefull for framerate calculations
2314  * @param max the maximum allowed for dst_nom & dst_den
2315  * @return 1 if exact, 0 otherwise
2316  */
2317 int av_reduce(int *dst_nom, int *dst_den, int64_t nom, int64_t den, int64_t max);
2318
2319 /**
2320  * rescale a 64bit integer with rounding to nearest.
2321  * a simple a*b/c isn't possible as it can overflow
2322  */
2323 int64_t av_rescale(int64_t a, int64_t b, int64_t c);
2324
2325 /**
2326  * rescale a 64bit integer with specified rounding.
2327  * a simple a*b/c isn't possible as it can overflow
2328  */
2329 int64_t av_rescale_rnd(int64_t a, int64_t b, int64_t c, enum AVRounding);
2330
2331 /**
2332  * rescale a 64bit integer by 2 rational numbers.
2333  */
2334 int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq);
2335
2336 double av_int2dbl(int64_t v);
2337 float av_int2flt(int32_t v);
2338 int64_t av_dbl2int(double d);
2339 int32_t av_flt2int(float d);
2340
2341
2342 /* frame parsing */
2343 typedef struct AVCodecParserContext {
2344     void *priv_data;
2345     struct AVCodecParser *parser;
2346     int64_t frame_offset; /* offset of the current frame */
2347     int64_t cur_offset; /* current offset
2348                            (incremented by each av_parser_parse()) */
2349     int64_t last_frame_offset; /* offset of the last frame */
2350     /* video info */
2351     int pict_type; /* XXX: put it back in AVCodecContext */
2352     int repeat_pict; /* XXX: put it back in AVCodecContext */
2353     int64_t pts;     /* pts of the current frame */
2354     int64_t dts;     /* dts of the current frame */
2355
2356     /* private data */
2357     int64_t last_pts;
2358     int64_t last_dts;
2359     int fetch_timestamp;
2360
2361 #define AV_PARSER_PTS_NB 4
2362     int cur_frame_start_index;
2363     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2364     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2365     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2366 } AVCodecParserContext;
2367
2368 typedef struct AVCodecParser {
2369     int codec_ids[5]; /* several codec IDs are permitted */
2370     int priv_data_size;
2371     int (*parser_init)(AVCodecParserContext *s);
2372     int (*parser_parse)(AVCodecParserContext *s,
2373                         AVCodecContext *avctx,
2374                         uint8_t **poutbuf, int *poutbuf_size,
2375                         const uint8_t *buf, int buf_size);
2376     void (*parser_close)(AVCodecParserContext *s);
2377     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2378     struct AVCodecParser *next;
2379 } AVCodecParser;
2380
2381 extern AVCodecParser *av_first_parser;
2382
2383 void av_register_codec_parser(AVCodecParser *parser);
2384 AVCodecParserContext *av_parser_init(int codec_id);
2385 int av_parser_parse(AVCodecParserContext *s,
2386                     AVCodecContext *avctx,
2387                     uint8_t **poutbuf, int *poutbuf_size,
2388                     const uint8_t *buf, int buf_size,
2389                     int64_t pts, int64_t dts);
2390 int av_parser_change(AVCodecParserContext *s,
2391                      AVCodecContext *avctx,
2392                      uint8_t **poutbuf, int *poutbuf_size,
2393                      const uint8_t *buf, int buf_size, int keyframe);
2394 void av_parser_close(AVCodecParserContext *s);
2395
2396 extern AVCodecParser mpegvideo_parser;
2397 extern AVCodecParser mpeg4video_parser;
2398 extern AVCodecParser h261_parser;
2399 extern AVCodecParser h263_parser;
2400 extern AVCodecParser h264_parser;
2401 extern AVCodecParser mjpeg_parser;
2402 extern AVCodecParser pnm_parser;
2403 extern AVCodecParser mpegaudio_parser;
2404 extern AVCodecParser ac3_parser;
2405 extern AVCodecParser dvdsub_parser;
2406 extern AVCodecParser dvbsub_parser;
2407
2408 /* memory */
2409 void *av_malloc(unsigned int size);
2410 void *av_mallocz(unsigned int size);
2411 void *av_realloc(void *ptr, unsigned int size);
2412 void av_free(void *ptr);
2413 char *av_strdup(const char *s);
2414 void av_freep(void *ptr);
2415 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2416 /* for static data only */
2417 /* call av_free_static to release all staticaly allocated tables */
2418 void av_free_static(void);
2419 void *av_mallocz_static(unsigned int size);
2420 void *av_realloc_static(void *ptr, unsigned int size);
2421
2422 /* add by bero : in adx.c */
2423 int is_adx(const unsigned char *buf,size_t bufsize);
2424
2425 void img_copy(AVPicture *dst, const AVPicture *src,
2426               int pix_fmt, int width, int height);
2427
2428 /* av_log API */
2429
2430 #include <stdarg.h>
2431
2432 #define AV_LOG_QUIET -1
2433 #define AV_LOG_ERROR 0
2434 #define AV_LOG_INFO 1
2435 #define AV_LOG_DEBUG 2
2436
2437 #ifdef __GNUC__
2438 extern void av_log(void*, int level, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 3, 4)));
2439 #else
2440 extern void av_log(void*, int level, const char *fmt, ...);
2441 #endif
2442
2443 extern void av_vlog(void*, int level, const char *fmt, va_list);
2444 extern int av_log_get_level(void);
2445 extern void av_log_set_level(int);
2446 extern void av_log_set_callback(void (*)(void*, int, const char*, va_list));
2447
2448 /* endian macros */
2449 #if !defined(BE_16) || !defined(BE_32) || !defined(LE_16) || !defined(LE_32)
2450 #define BE_16(x)  ((((uint8_t*)(x))[0] << 8) | ((uint8_t*)(x))[1])
2451 #define BE_32(x)  ((((uint8_t*)(x))[0] << 24) | \
2452                    (((uint8_t*)(x))[1] << 16) | \
2453                    (((uint8_t*)(x))[2] << 8) | \
2454                     ((uint8_t*)(x))[3])
2455 #define LE_16(x)  ((((uint8_t*)(x))[1] << 8) | ((uint8_t*)(x))[0])
2456 #define LE_32(x)  ((((uint8_t*)(x))[3] << 24) | \
2457                    (((uint8_t*)(x))[2] << 16) | \
2458                    (((uint8_t*)(x))[1] << 8) | \
2459                     ((uint8_t*)(x))[0])
2460 #endif
2461
2462 extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2463
2464 #ifdef __cplusplus
2465 }
2466 #endif
2467
2468 #endif /* AVCODEC_H */