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
  17 #define FFMPEG_VERSION_INT     0x000408
  18 #define FFMPEG_VERSION         "0.4.8"
  19 #define LIBAVCODEC_BUILD       4687
  20
  21 #define LIBAVCODEC_VERSION_INT FFMPEG_VERSION_INT
  22 #define LIBAVCODEC_VERSION     FFMPEG_VERSION
  23
  24 #define AV_STRINGIFY(s) AV_TOSTRING(s)
  25 #define AV_TOSTRING(s) #s
  26 #define LIBAVCODEC_IDENT        "FFmpeg" LIBAVCODEC_VERSION "b" AV_STRINGIFY(LIBAVCODEC_BUILD)
  27
  28 enum CodecID {
  29     CODEC_ID_NONE,
  30     CODEC_ID_MPEG1VIDEO,
  31     CODEC_ID_MPEG2VIDEO, /* prefered ID for MPEG Video 1 or 2 decoding */
  32     CODEC_ID_MPEG2VIDEO_XVMC,
  33     CODEC_ID_H263,
  34     CODEC_ID_RV10,
  35     CODEC_ID_MP2,
  36     CODEC_ID_MP3, /* prefered ID for MPEG Audio layer 1, 2 or3 decoding */
  37     CODEC_ID_VORBIS,
  38     CODEC_ID_AC3,
  39     CODEC_ID_MJPEG,
  40     CODEC_ID_MJPEGB,
  41     CODEC_ID_LJPEG,
  42     CODEC_ID_SP5X,
  43     CODEC_ID_MPEG4,
  44     CODEC_ID_RAWVIDEO,
  45     CODEC_ID_MSMPEG4V1,
  46     CODEC_ID_MSMPEG4V2,
  47     CODEC_ID_MSMPEG4V3,
  48     CODEC_ID_WMV1,
  49     CODEC_ID_WMV2,
  50     CODEC_ID_H263P,
  51     CODEC_ID_H263I,
  52     CODEC_ID_FLV1,
  53     CODEC_ID_SVQ1,
  54     CODEC_ID_SVQ3,
  55     CODEC_ID_DVVIDEO,
  56     CODEC_ID_DVAUDIO,
  57     CODEC_ID_WMAV1,
  58     CODEC_ID_WMAV2,
  59     CODEC_ID_MACE3,
  60     CODEC_ID_MACE6,
  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_AAC,
  68     CODEC_ID_MPEG4AAC,
  69     CODEC_ID_ASV1,
  70     CODEC_ID_ASV2,
  71     CODEC_ID_FFV1,
  72     CODEC_ID_4XM,
  73     CODEC_ID_VCR1,
  74     CODEC_ID_CLJR,
  75     CODEC_ID_MDEC,
  76     CODEC_ID_ROQ,
  77     CODEC_ID_INTERPLAY_VIDEO,
  78     CODEC_ID_XAN_WC3,
  79     CODEC_ID_XAN_WC4,
  80     CODEC_ID_RPZA,
  81     CODEC_ID_CINEPAK,
  82     CODEC_ID_WS_VQA,
  83     CODEC_ID_MSRLE,
  84     CODEC_ID_MSVIDEO1,
  85     CODEC_ID_IDCIN,
  86
  87     /* various pcm "codecs" */
  88     CODEC_ID_PCM_S16LE,
  89     CODEC_ID_PCM_S16BE,
  90     CODEC_ID_PCM_U16LE,
  91     CODEC_ID_PCM_U16BE,
  92     CODEC_ID_PCM_S8,
  93     CODEC_ID_PCM_U8,
  94     CODEC_ID_PCM_MULAW,
  95     CODEC_ID_PCM_ALAW,
  96
  97     /* various adpcm codecs */
  98     CODEC_ID_ADPCM_IMA_QT,
  99     CODEC_ID_ADPCM_IMA_WAV,
 100     CODEC_ID_ADPCM_IMA_DK3,
 101     CODEC_ID_ADPCM_IMA_DK4,
 102     CODEC_ID_ADPCM_IMA_WS,
 103     CODEC_ID_ADPCM_MS,
 104     CODEC_ID_ADPCM_4XM,
 105     CODEC_ID_ADPCM_XA,
 106     CODEC_ID_ADPCM_ADX,
 107
 108         /* AMR */
 109     CODEC_ID_AMR_NB,
 110     CODEC_ID_AMR_WB,
 111
 112     /* RealAudio codecs*/
 113     CODEC_ID_RA_144,
 114     CODEC_ID_RA_288,
 115
 116     /* various DPCM codecs */
 117     CODEC_ID_ROQ_DPCM,
 118     CODEC_ID_INTERPLAY_DPCM,
 119     CODEC_ID_XAN_DPCM,
 120 };
 121
 122 /* CODEC_ID_MP3LAME is absolete */
 123 #define CODEC_ID_MP3LAME CODEC_ID_MP3
 124
 125 enum CodecType {
 126     CODEC_TYPE_UNKNOWN = -1,
 127     CODEC_TYPE_VIDEO,
 128     CODEC_TYPE_AUDIO,
 129 };
 130
 131 /**
 132  * Pixel format. Notes:
 133  *
 134  * PIX_FMT_RGBA32 is handled in an endian-specific manner. A RGBA
 135  * color is put together as:
 136  *  (A << 24) | (R << 16) | (G << 8) | B
 137  * This is stored as BGRA on little endian CPU architectures and ARGB on
 138  * big endian CPUs.
 139  *
 140  * When the pixel format is palettized RGB (PIX_FMT_PAL8), the palettized
 141  * image data is stored in AVFrame.data[0]. The palette is transported in
 142  * AVFrame.data[1] and, is 1024 bytes long (256 4-byte entries) and is
 143  * formatted the same as in PIX_FMT_RGBA32 described above (i.e., it is
 144  * also endian-specific). Note also that the individual RGB palette
 145  * components stored in AVFrame.data[1] should be in the range 0..255.
 146  * This is important as many custom PAL8 video codecs that were designed
 147  * to run on the IBM VGA graphics adapter use 6-bit palette components.
 148  */
 149 enum PixelFormat {
 150     PIX_FMT_YUV420P,   ///< Planar YUV 4:2:0 (1 Cr & Cb sample per 2x2 Y samples)
 151     PIX_FMT_YUV422,
 152     PIX_FMT_RGB24,     ///< Packed pixel, 3 bytes per pixel, RGBRGB...
 153     PIX_FMT_BGR24,     ///< Packed pixel, 3 bytes per pixel, BGRBGR...
 154     PIX_FMT_YUV422P,   ///< Planar YUV 4:2:2 (1 Cr & Cb sample per 2x1 Y samples)
 155     PIX_FMT_YUV444P,   ///< Planar YUV 4:4:4 (1 Cr & Cb sample per 1x1 Y samples)
 156     PIX_FMT_RGBA32,    ///< Packed pixel, 4 bytes per pixel, BGRABGRA..., stored in cpu endianness
 157     PIX_FMT_YUV410P,   ///< Planar YUV 4:1:0 (1 Cr & Cb sample per 4x4 Y samples)
 158     PIX_FMT_YUV411P,   ///< Planar YUV 4:1:1 (1 Cr & Cb sample per 4x1 Y samples)
 159     PIX_FMT_RGB565,    ///< always stored in cpu endianness
 160     PIX_FMT_RGB555,    ///< always stored in cpu endianness, most significant bit to 1
 161     PIX_FMT_GRAY8,
 162     PIX_FMT_MONOWHITE, ///< 0 is white
 163     PIX_FMT_MONOBLACK, ///< 0 is black
 164     PIX_FMT_PAL8,      ///< 8 bit with RGBA palette
 165     PIX_FMT_YUVJ420P,  ///< Planar YUV 4:2:0 full scale (jpeg)
 166     PIX_FMT_YUVJ422P,  ///< Planar YUV 4:2:2 full scale (jpeg)
 167     PIX_FMT_YUVJ444P,  ///< Planar YUV 4:4:4 full scale (jpeg)
 168     PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
 169     PIX_FMT_XVMC_MPEG2_IDCT,
 170     PIX_FMT_NB,
 171 };
 172
 173 /* currently unused, may be used if 24/32 bits samples ever supported */
 174 enum SampleFormat {
 175     SAMPLE_FMT_S16 = 0,         ///< signed 16 bits
 176 };
 177
 178 /* in bytes */
 179 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
 180
 181 /**
 182  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
 183  * this is mainly needed because some optimized bitstream readers read
 184  * 32 or 64 bit at once and could read over the end<br>
 185  * Note, if the first 23 bits of the additional bytes are not 0 then damaged
 186  * MPEG bitstreams could cause overread and segfault
 187  */
 188 #define FF_INPUT_BUFFER_PADDING_SIZE 8
 189
 190 /* motion estimation type, EPZS by default */
 191 enum Motion_Est_ID {
 192     ME_ZERO = 1,
 193     ME_FULL,
 194     ME_LOG,
 195     ME_PHODS,
 196     ME_EPZS,
 197     ME_X1
 198 };
 199
 200 typedef struct RcOverride{
 201     int start_frame;
 202     int end_frame;
 203     int qscale; // if this is 0 then quality_factor will be used instead
 204     float quality_factor;
 205 } RcOverride;
 206
 207 /* only for ME compatiblity with old apps */
 208 extern int motion_estimation_method;
 209
 210 /* ME algos sorted by quality */
 211 //FIXME remove IMHO
 212 static const __attribute__((unused)) int Motion_Est_QTab[] =
 213  { ME_ZERO, ME_PHODS, ME_LOG, ME_X1, ME_EPZS, ME_FULL };
 214
 215
 216 #define FF_MAX_B_FRAMES 8
 217
 218 /* encoding support
 219    these flags can be passed in AVCodecContext.flags before initing
 220    Note: note not everything is supported yet
 221 */
 222
 223 #define CODEC_FLAG_QSCALE 0x0002  ///< use fixed qscale
 224 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed
 225 #define CODEC_FLAG_QPEL   0x0010  ///< use qpel MC
 226 #define CODEC_FLAG_GMC    0x0020  ///< use GMC
 227 #define CODEC_FLAG_MV0    0x0040  ///< always try a MB with MV=<0,0>
 228 #define CODEC_FLAG_PART   0x0080  ///< use data partitioning
 229 /* parent program gurantees that the input for b-frame containing streams is not written to
 230    for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
 231 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
 232 #define CODEC_FLAG_PASS1 0x0200   ///< use internal 2pass ratecontrol in first  pass mode
 233 #define CODEC_FLAG_PASS2 0x0400   ///< use internal 2pass ratecontrol in second pass mode
 234 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< use external huffman table (for mjpeg)
 235 #define CODEC_FLAG_GRAY  0x2000   ///< only decode/encode grayscale
 236 #define CODEC_FLAG_EMU_EDGE 0x4000///< dont draw edges
 237 #define CODEC_FLAG_PSNR           0x8000 ///< error[?] variables will be set during encoding
 238 #define CODEC_FLAG_TRUNCATED  0x00010000 /** input bitstream might be truncated at a random location instead
 239                                             of only at frame boundaries */
 240 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< normalize adaptive quantization
 241 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct
 242 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< force low delay
 243 #define CODEC_FLAG_ALT_SCAN       0x00100000 ///< use alternate scan
 244 #define CODEC_FLAG_TRELLIS_QUANT  0x00200000 ///< use trellis quantization
 245 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< place global headers in extradata instead of every keyframe
 246 #define CODEC_FLAG_BITEXACT       0x00800000 ///< use only bitexact stuff (except (i)dct)
 247 /* Fx : Flag for h263+ extra options */
 248 #define CODEC_FLAG_H263P_AIC      0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction (remove this)
 249 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction
 250 #define CODEC_FLAG_H263P_UMV      0x02000000 ///< Unlimited motion vector
 251 #define CODEC_FLAG_CBP_RD         0x04000000 ///< use rate distortion optimization for cbp
 252 /* For advanced prediction mode, we reuse the 4MV flag */
 253 /* Unsupported options :
 254  *              Syntax Arithmetic coding (SAC)
 255  *              Deblocking filter internal loop
 256  *              Slice structured
 257  *              Reference Picture Selection
 258  *              Independant Segment Decoding
 259  *              Alternative Inter *             VLC
 260  *              Modified Quantization */
 261 /* /Fx */
 262 /* codec capabilities */
 263
 264 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback
 265 /**
 266  * Codec uses get_buffer() for allocating buffers.
 267  * direct rendering method 1
 268  */
 269 #define CODEC_CAP_DR1             0x0002
 270 /* if 'parse_only' field is true, then avcodec_parse_frame() can be
 271    used */
 272 #define CODEC_CAP_PARSE_ONLY      0x0004
 273 #define CODEC_CAP_TRUNCATED       0x0008
 274
 275 /**
 276  * Pan Scan area.
 277  * this specifies the area which should be displayed. Note there may be multiple such areas for one frame
 278  */
 279 typedef struct AVPanScan{
 280     /**
 281      * id.
 282      * - encoding: set by user.
 283      * - decoding: set by lavc
 284      */
 285     int id;
 286
 287     /**
 288      * width and height in 1/16 pel
 289      * - encoding: set by user.
 290      * - decoding: set by lavc
 291      */
 292     int width;
 293     int height;
 294
 295     /**
 296      * position of the top left corner in 1/16 pel for up to 3 fields/frames.
 297      * - encoding: set by user.
 298      * - decoding: set by lavc
 299      */
 300     int16_t position[3][2];
 301 }AVPanScan;
 302
 303 #define FF_COMMON_FRAME \
 304     /**\
 305      * pointer to the picture planes.\
 306      * this might be different from the first allocated byte\
 307      * - encoding: \
 308      * - decoding: \
 309      */\
 310     uint8_t *data[4];\
 311     int linesize[4];\
 312     /**\
 313      * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
 314      * this isnt used by lavc unless the default get/release_buffer() is used\
 315      * - encoding: \
 316      * - decoding: \
 317      */\
 318     uint8_t *base[4];\
 319     /**\
 320      * 1 -> keyframe, 0-> not\
 321      * - encoding: set by lavc\
 322      * - decoding: set by lavc\
 323      */\
 324     int key_frame;\
 325 \
 326     /**\
 327      * picture type of the frame, see ?_TYPE below.\
 328      * - encoding: set by lavc for coded_picture (and set by user for input)\
 329      * - decoding: set by lavc\
 330      */\
 331     int pict_type;\
 332 \
 333     /**\
 334      * presentation timestamp in micro seconds (time when frame should be shown to user)\
 335      * if 0 then the frame_rate will be used as reference\
 336      * - encoding: MUST be set by user\
 337      * - decoding: set by lavc\
 338      */\
 339     int64_t pts;\
 340 \
 341     /**\
 342      * picture number in bitstream order.\
 343      * - encoding: set by\
 344      * - decoding: set by lavc\
 345      */\
 346     int coded_picture_number;\
 347     /**\
 348      * picture number in display order.\
 349      * - encoding: set by\
 350      * - decoding: set by lavc\
 351      */\
 352     int display_picture_number;\
 353 \
 354     /**\
 355      * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
 356      * - encoding: set by lavc for coded_picture (and set by user for input)\
 357      * - decoding: set by lavc\
 358      */\
 359     int quality; \
 360 \
 361     /**\
 362      * buffer age (1->was last buffer and dint change, 2->..., ...).\
 363      * set to INT_MAX if the buffer has not been used yet \
 364      * - encoding: unused\
 365      * - decoding: MUST be set by get_buffer()\
 366      */\
 367     int age;\
 368 \
 369     /**\
 370      * is this picture used as reference\
 371      * - encoding: unused\
 372      * - decoding: set by lavc (before get_buffer() call))\
 373      */\
 374     int reference;\
 375 \
 376     /**\
 377      * QP table\
 378      * - encoding: unused\
 379      * - decoding: set by lavc\
 380      */\
 381     int8_t *qscale_table;\
 382     /**\
 383      * QP store stride\
 384      * - encoding: unused\
 385      * - decoding: set by lavc\
 386      */\
 387     int qstride;\
 388 \
 389     /**\
 390      * mbskip_table[mb]>=1 if MB didnt change\
 391      * stride= mb_width = (width+15)>>4\
 392      * - encoding: unused\
 393      * - decoding: set by lavc\
 394      */\
 395     uint8_t *mbskip_table;\
 396 \
 397     /**\
 398      * for some private data of the user\
 399      * - encoding: unused\
 400      * - decoding: set by user\
 401      */\
 402     void *opaque;\
 403 \
 404     /**\
 405      * error\
 406      * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
 407      * - decoding: unused\
 408      */\
 409     uint64_t error[4];\
 410 \
 411     /**\
 412      * type of the buffer (to keep track of who has to dealloc data[*])\
 413      * - encoding: set by the one who allocs it\
 414      * - decoding: set by the one who allocs it\
 415      * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
 416      */\
 417     int type;\
 418     \
 419     /**\
 420      * when decoding, this signal how much the picture must be delayed.\
 421      * extra_delay = repeat_pict / (2*fps)\
 422      * - encoding: unused\
 423      * - decoding: set by lavc\
 424      */\
 425     int repeat_pict;\
 426     \
 427     /**\
 428      * \
 429      */\
 430     int qscale_type;\
 431     \
 432     /**\
 433      * The content of the picture is interlaced.\
 434      * - encoding: set by user\
 435      * - decoding: set by lavc (default 0)\
 436      */\
 437     int interlaced_frame;\
 438     \
 439     /**\
 440      * if the content is interlaced, is top field displayed first.\
 441      * - encoding: set by user\
 442      * - decoding: set by lavc\
 443      */\
 444     int top_field_first;\
 445     \
 446     /**\
 447      * Pan scan.\
 448      * - encoding: set by user\
 449      * - decoding: set by lavc\
 450      */\
 451     AVPanScan *pan_scan;\
 452
 453
 454 #define FF_QSCALE_TYPE_MPEG1    0
 455 #define FF_QSCALE_TYPE_MPEG2    1
 456
 457 #define FF_BUFFER_TYPE_INTERNAL 1
 458 #define FF_BUFFER_TYPE_USER     2 ///< Direct rendering buffers (image is (de)allocated by user)
 459 #define FF_BUFFER_TYPE_SHARED   4 ///< buffer from somewher else, dont dealloc image (data/base)
 460 #define FF_BUFFER_TYPE_COPY     8 ///< just a (modified) copy of some other buffer, dont dealloc anything
 461
 462
 463 #define FF_I_TYPE 1 // Intra
 464 #define FF_P_TYPE 2 // Predicted
 465 #define FF_B_TYPE 3 // Bi-dir predicted
 466 #define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
 467 #define FF_SI_TYPE 5
 468 #define FF_SP_TYPE 6
 469
 470 /**
 471  * Audio Video Frame.
 472  */
 473 typedef struct AVFrame {
 474     FF_COMMON_FRAME
 475 } AVFrame;
 476
 477 #define DEFAULT_FRAME_RATE_BASE 1001000
 478
 479 /**
 480  * main external api structure.
 481  */
 482 typedef struct AVCodecContext {
 483     /**
 484      * the average bitrate.
 485      * - encoding: set by user. unused for constant quantizer encoding
 486      * - decoding: set by lavc. 0 or some bitrate if this info is available in the stream
 487      */
 488     int bit_rate;
 489
 490     /**
 491      * number of bits the bitstream is allowed to diverge from the reference.
 492      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
 493      * - encoding: set by user. unused for constant quantizer encoding
 494      * - decoding: unused
 495      */
 496     int bit_rate_tolerance;
 497
 498     /**
 499      * CODEC_FLAG_*.
 500      * - encoding: set by user.
 501      * - decoding: set by user.
 502      */
 503     int flags;
 504
 505     /**
 506      * some codecs needs additionnal format info. It is stored here
 507      * - encoding: set by user.
 508      * - decoding: set by lavc. (FIXME is this ok?)
 509      */
 510     int sub_id;
 511
 512     /**
 513      * motion estimation algorithm used for video coding.
 514      * - encoding: MUST be set by user.
 515      * - decoding: unused
 516      */
 517     int me_method;
 518
 519     /**
 520      * some codecs need / can use extra-data like huffman tables.
 521      * mjpeg: huffman tables
 522      * rv10: additional flags
 523      * mpeg4: global headers (they can be in the bitstream or here)
 524      * - encoding: set/allocated/freed by lavc.
 525      * - decoding: set/allocated/freed by user.
 526      */
 527     void *extradata;
 528     int extradata_size;
 529
 530     /* video only */
 531     /**
 532      * frames per sec multiplied by frame_rate_base.
 533      * for variable fps this is the precission, so if the timestamps
 534      * can be specified in msec precssion then this is 1000*frame_rate_base
 535      * - encoding: MUST be set by user
 536      * - decoding: set by lavc. 0 or the frame_rate if available
 537      */
 538     int frame_rate;
 539
 540     /**
 541      * width / height.
 542      * - encoding: MUST be set by user.
 543      * - decoding: set by user if known, codec should override / dynamically change if needed
 544      */
 545     int width, height;
 546
 547 #define FF_ASPECT_SQUARE 1
 548 #define FF_ASPECT_4_3_625 2
 549 #define FF_ASPECT_4_3_525 3
 550 #define FF_ASPECT_16_9_625 4
 551 #define FF_ASPECT_16_9_525 5
 552 #define FF_ASPECT_EXTENDED 15
 553
 554     /**
 555      * the number of pictures in a group of pitures, or 0 for intra_only.
 556      * - encoding: set by user.
 557      * - decoding: unused
 558      */
 559     int gop_size;
 560
 561     /**
 562      * pixel format, see PIX_FMT_xxx.
 563      * - encoding: FIXME: used by ffmpeg to decide whether an pix_fmt
 564      *                    conversion is in order. This only works for
 565      *                    codecs with one supported pix_fmt, we should
 566      *                    do something for a generic case as well.
 567      * - decoding: set by lavc.
 568      */
 569     enum PixelFormat pix_fmt;
 570
 571     /**
 572      * Frame rate emulation. If not zero lower layer (i.e. format handler)
 573      * has to read frames at native frame rate.
 574      * - encoding: set by user.
 575      * - decoding: unused.
 576      */
 577     int rate_emu;
 578
 579     /**
 580      * if non NULL, 'draw_horiz_band' is called by the libavcodec
 581      * decoder to draw an horizontal band. It improve cache usage. Not
 582      * all codecs can do that. You must check the codec capabilities
 583      * before
 584      * - encoding: unused
 585      * - decoding: set by user.
 586      * @param height the height of the slice
 587      * @param y the y position of the slice
 588      * @param type 1->top field, 2->bottom field, 3->frame
 589      * @param offset offset into the AVFrame.data from which the slice should be read
 590      */
 591     void (*draw_horiz_band)(struct AVCodecContext *s,
 592                             const AVFrame *src, int offset[4],
 593                             int y, int type, int height);
 594
 595     /* audio only */
 596     int sample_rate; ///< samples per sec
 597     int channels;
 598     int sample_fmt;  ///< sample format, currenly unused
 599
 600     /* the following data should not be initialized */
 601     int frame_size;     ///< in samples, initialized when calling 'init'
 602     int frame_number;   ///< audio or video frame number
 603     int real_pict_num;  ///< returns the real picture number of previous encoded frame
 604
 605     /**
 606      * number of frames the decoded output will be delayed relative to
 607      * the encoded input.
 608      * - encoding: set by lavc.
 609      * - decoding: unused
 610      */
 611     int delay;
 612
 613     /* - encoding parameters */
 614     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
 615     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
 616
 617     /**
 618      * minimum quantizer.
 619      * - encoding: set by user.
 620      * - decoding: unused
 621      */
 622     int qmin;
 623
 624     /**
 625      * maximum quantizer.
 626      * - encoding: set by user.
 627      * - decoding: unused
 628      */
 629     int qmax;
 630
 631     /**
 632      * maximum quantizer difference etween frames.
 633      * - encoding: set by user.
 634      * - decoding: unused
 635      */
 636     int max_qdiff;
 637
 638     /**
 639      * maximum number of b frames between non b frames.
 640      * note: the output will be delayed by max_b_frames+1 relative to the input
 641      * - encoding: set by user.
 642      * - decoding: unused
 643      */
 644     int max_b_frames;
 645
 646     /**
 647      * qscale factor between ip and b frames.
 648      * - encoding: set by user.
 649      * - decoding: unused
 650      */
 651     float b_quant_factor;
 652
 653     /** obsolete FIXME remove */
 654     int rc_strategy;
 655     int b_frame_strategy;
 656
 657     /**
 658      * hurry up amount.
 659      * - encoding: unused
 660      * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
 661      */
 662     int hurry_up;
 663
 664     struct AVCodec *codec;
 665
 666     void *priv_data;
 667
 668     /* The following data is for RTP friendly coding */
 669     /* By now only H.263/H.263+/MPEG4 coder honours this   */
 670     int rtp_mode;   /* 1 for activate RTP friendly-mode           */
 671                     /* highers numbers represent more error-prone */
 672                     /* enviroments, by now just "1" exist         */
 673
 674     int rtp_payload_size;   /* The size of the RTP payload, the coder will  */
 675                             /* do it's best to deliver a chunk with size    */
 676                             /* below rtp_payload_size, the chunk will start */
 677                             /* with a start code on some codecs like H.263  */
 678                             /* This doesn't take account of any particular  */
 679                             /* headers inside the transmited RTP payload    */
 680
 681
 682     /* The RTP callcack: This function is called  */
 683     /* every time the encoder as a packet to send */
 684     /* Depends on the encoder if the data starts  */
 685     /* with a Start Code (it should) H.263 does   */
 686     void (*rtp_callback)(void *data, int size, int packet_number);
 687
 688     /* statistics, used for 2-pass encoding */
 689     int mv_bits;
 690     int header_bits;
 691     int i_tex_bits;
 692     int p_tex_bits;
 693     int i_count;
 694     int p_count;
 695     int skip_count;
 696     int misc_bits;
 697
 698     /**
 699      * number of bits used for the previously encoded frame.
 700      * - encoding: set by lavc
 701      * - decoding: unused
 702      */
 703     int frame_bits;
 704
 705     /**
 706      * private data of the user, can be used to carry app specific stuff.
 707      * - encoding: set by user
 708      * - decoding: set by user
 709      */
 710     void *opaque;
 711
 712     char codec_name[32];
 713     enum CodecType codec_type; /* see CODEC_TYPE_xxx */
 714     enum CodecID codec_id; /* see CODEC_ID_xxx */
 715
 716     /**
 717      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
 718      * this is used to workaround some encoder bugs
 719      * - encoding: set by user, if not then the default based on codec_id will be used
 720      * - decoding: set by user, will be converted to upper case by lavc during init
 721      */
 722     unsigned int codec_tag;
 723
 724     /**
 725      * workaround bugs in encoders which sometimes cannot be detected automatically.
 726      * - encoding: unused
 727      * - decoding: set by user
 728      */
 729     int workaround_bugs;
 730 #define FF_BUG_AUTODETECT       1  ///< autodetection
 731 #define FF_BUG_OLD_MSMPEG4      2
 732 #define FF_BUG_XVID_ILACE       4
 733 #define FF_BUG_UMP4             8
 734 #define FF_BUG_NO_PADDING       16
 735 #define FF_BUG_AC_VLC           0  ///< will be removed, libavcodec can now handle these non compliant files by default
 736 #define FF_BUG_QPEL_CHROMA      64
 737 #define FF_BUG_STD_QPEL         128
 738 #define FF_BUG_QPEL_CHROMA2     256
 739 #define FF_BUG_DIRECT_BLOCKSIZE 512
 740 #define FF_BUG_EDGE             1024
 741 //#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
 742
 743     /**
 744      * luma single coeff elimination threshold.
 745      * - encoding: set by user
 746      * - decoding: unused
 747      */
 748     int luma_elim_threshold;
 749
 750     /**
 751      * chroma single coeff elimination threshold.
 752      * - encoding: set by user
 753      * - decoding: unused
 754      */
 755     int chroma_elim_threshold;
 756
 757     /**
 758      * strictly follow the std (MPEG4, ...).
 759      * - encoding: set by user
 760      * - decoding: unused
 761      */
 762     int strict_std_compliance;
 763
 764     /**
 765      * qscale offset between ip and b frames.
 766      * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
 767      * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
 768      * - encoding: set by user.
 769      * - decoding: unused
 770      */
 771     float b_quant_offset;
 772
 773     /**
 774      * error resilience higher values will detect more errors but may missdetect
 775      * some more or less valid parts as errors.
 776      * - encoding: unused
 777      * - decoding: set by user
 778      */
 779     int error_resilience;
 780 #define FF_ER_CAREFULL        1
 781 #define FF_ER_COMPLIANT       2
 782 #define FF_ER_AGGRESSIVE      3
 783 #define FF_ER_VERY_AGGRESSIVE 4
 784
 785     /**
 786      * called at the beginning of each frame to get a buffer for it.
 787      * if pic.reference is set then the frame will be read later by lavc
 788      * width and height should be rounded up to the next multiple of 16
 789      * - encoding: unused
 790      * - decoding: set by lavc, user can override
 791      */
 792     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
 793
 794     /**
 795      * called to release buffers which where allocated with get_buffer.
 796      * a released buffer can be reused in get_buffer()
 797      * pic.data[*] must be set to NULL
 798      * - encoding: unused
 799      * - decoding: set by lavc, user can override
 800      */
 801     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
 802
 803     /**
 804      * is 1 if the decoded stream contains b frames, 0 otherwise.
 805      * - encoding: unused
 806      * - decoding: set by lavc
 807      */
 808     int has_b_frames;
 809
 810     int block_align; ///< used by some WAV based audio codecs
 811
 812     int parse_only; /* - decoding only: if true, only parsing is done
 813                        (function avcodec_parse_frame()). The frame
 814                        data is returned. Only MPEG codecs support this now. */
 815
 816     /**
 817      * 0-> h263 quant 1-> mpeg quant.
 818      * - encoding: set by user.
 819      * - decoding: unused
 820      */
 821     int mpeg_quant;
 822
 823     /**
 824      * pass1 encoding statistics output buffer.
 825      * - encoding: set by lavc
 826      * - decoding: unused
 827      */
 828     char *stats_out;
 829
 830     /**
 831      * pass2 encoding statistics input buffer.
 832      * concatenated stuff from stats_out of pass1 should be placed here
 833      * - encoding: allocated/set/freed by user
 834      * - decoding: unused
 835      */
 836     char *stats_in;
 837
 838     /**
 839      * ratecontrol qmin qmax limiting method.
 840      * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
 841      * - encoding: set by user.
 842      * - decoding: unused
 843      */
 844     float rc_qsquish;
 845
 846     float rc_qmod_amp;
 847     int rc_qmod_freq;
 848
 849     /**
 850      * ratecontrol override, see RcOverride.
 851      * - encoding: allocated/set/freed by user.
 852      * - decoding: unused
 853      */
 854     RcOverride *rc_override;
 855     int rc_override_count;
 856
 857     /**
 858      * rate control equation.
 859      * - encoding: set by user
 860      * - decoding: unused
 861      */
 862     char *rc_eq;
 863
 864     /**
 865      * maximum bitrate.
 866      * - encoding: set by user.
 867      * - decoding: unused
 868      */
 869     int rc_max_rate;
 870
 871     /**
 872      * minimum bitrate.
 873      * - encoding: set by user.
 874      * - decoding: unused
 875      */
 876     int rc_min_rate;
 877
 878     /**
 879      * decoder bitstream buffer size.
 880      * - encoding: set by user.
 881      * - decoding: unused
 882      */
 883     int rc_buffer_size;
 884     float rc_buffer_aggressivity;
 885
 886     /**
 887      * qscale factor between p and i frames.
 888      * - encoding: set by user.
 889      * - decoding: unused
 890      */
 891     float i_quant_factor;
 892
 893     /**
 894      * qscale offset between p and i frames.
 895      * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
 896      * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
 897      * - encoding: set by user.
 898      * - decoding: unused
 899      */
 900     float i_quant_offset;
 901
 902     /**
 903      * initial complexity for pass1 ratecontrol.
 904      * - encoding: set by user.
 905      * - decoding: unused
 906      */
 907     float rc_initial_cplx;
 908
 909     /**
 910      * dct algorithm, see FF_DCT_* below.
 911      * - encoding: set by user
 912      * - decoding: unused
 913      */
 914     int dct_algo;
 915 #define FF_DCT_AUTO    0
 916 #define FF_DCT_FASTINT 1
 917 #define FF_DCT_INT     2
 918 #define FF_DCT_MMX     3
 919 #define FF_DCT_MLIB    4
 920 #define FF_DCT_ALTIVEC 5
 921
 922     /**
 923      * luminance masking (0-> disabled).
 924      * - encoding: set by user
 925      * - decoding: unused
 926      */
 927     float lumi_masking;
 928
 929     /**
 930      * temporary complexity masking (0-> disabled).
 931      * - encoding: set by user
 932      * - decoding: unused
 933      */
 934     float temporal_cplx_masking;
 935
 936     /**
 937      * spatial complexity masking (0-> disabled).
 938      * - encoding: set by user
 939      * - decoding: unused
 940      */
 941     float spatial_cplx_masking;
 942
 943     /**
 944      * p block masking (0-> disabled).
 945      * - encoding: set by user
 946      * - decoding: unused
 947      */
 948     float p_masking;
 949
 950     /**
 951      * darkness masking (0-> disabled).
 952      * - encoding: set by user
 953      * - decoding: unused
 954      */
 955     float dark_masking;
 956
 957
 958     /* for binary compatibility */
 959     int unused;
 960
 961     /**
 962      * idct algorithm, see FF_IDCT_* below.
 963      * - encoding: set by user
 964      * - decoding: set by user
 965      */
 966     int idct_algo;
 967 #define FF_IDCT_AUTO         0
 968 #define FF_IDCT_INT          1
 969 #define FF_IDCT_SIMPLE       2
 970 #define FF_IDCT_SIMPLEMMX    3
 971 #define FF_IDCT_LIBMPEG2MMX  4
 972 #define FF_IDCT_PS2          5
 973 #define FF_IDCT_MLIB         6
 974 #define FF_IDCT_ARM          7
 975 #define FF_IDCT_ALTIVEC      8
 976 #define FF_IDCT_SH4          9
 977 #define FF_IDCT_SIMPLEARM    10
 978
 979     /**
 980      * slice count.
 981      * - encoding: set by lavc
 982      * - decoding: set by user (or 0)
 983      */
 984     int slice_count;
 985     /**
 986      * slice offsets in the frame in bytes.
 987      * - encoding: set/allocated by lavc
 988      * - decoding: set/allocated by user (or NULL)
 989      */
 990     int *slice_offset;
 991
 992     /**
 993      * error concealment flags.
 994      * - encoding: unused
 995      * - decoding: set by user
 996      */
 997     int error_concealment;
 998 #define FF_EC_GUESS_MVS   1
 999 #define FF_EC_DEBLOCK     2
1000
1001     /**
1002      * dsp_mask could be add used to disable unwanted CPU features
1003      * CPU features (i.e. MMX, SSE. ...)
1004      *
1005      * with FORCE flag you may instead enable given CPU features
1006      * (Dangerous: usable in case of misdetection, improper usage however will
1007      * result into program crash)
1008      */
1009     unsigned dsp_mask;
1010 #define FF_MM_FORCE     0x80000000 /* force usage of selected flags (OR) */
1011     /* lower 16 bits - CPU features */
1012 #ifdef HAVE_MMX
1013 #define FF_MM_MMX       0x0001 /* standard MMX */
1014 #define FF_MM_3DNOW     0x0004 /* AMD 3DNOW */
1015 #define FF_MM_MMXEXT    0x0002 /* SSE integer functions or AMD MMX ext */
1016 #define FF_MM_SSE       0x0008 /* SSE functions */
1017 #define FF_MM_SSE2      0x0010 /* PIV SSE2 functions */
1018 #endif /* HAVE_MMX */
1019
1020     /**
1021      * bits per sample/pixel from the demuxer (needed for huffyuv).
1022      * - encoding: set by lavc
1023      * - decoding: set by user
1024      */
1025      int bits_per_sample;
1026
1027     /**
1028      * prediction method (needed for huffyuv).
1029      * - encoding: set by user
1030      * - decoding: unused
1031      */
1032      int prediction_method;
1033 #define FF_PRED_LEFT   0
1034 #define FF_PRED_PLANE  1
1035 #define FF_PRED_MEDIAN 2
1036
1037     /**
1038      * sample aspect ratio (0 if unknown).
1039      * - encoding: set by user.
1040      * - decoding: set by lavc.
1041      */
1042     AVRational sample_aspect_ratio;
1043
1044     /**
1045      * the picture in the bitstream.
1046      * - encoding: set by lavc
1047      * - decoding: set by lavc
1048      */
1049     AVFrame *coded_frame;
1050
1051     /**
1052      * debug.
1053      * - encoding: set by user.
1054      * - decoding: set by user.
1055      */
1056     int debug;
1057 #define FF_DEBUG_PICT_INFO 1
1058 #define FF_DEBUG_RC        2
1059 #define FF_DEBUG_BITSTREAM 4
1060 #define FF_DEBUG_MB_TYPE   8
1061 #define FF_DEBUG_QP        16
1062 #define FF_DEBUG_MV        32
1063 #define FF_DEBUG_VIS_MV    0x00000040
1064 #define FF_DEBUG_SKIP      0x00000080
1065 #define FF_DEBUG_STARTCODE 0x00000100
1066 #define FF_DEBUG_PTS       0x00000200
1067 #define FF_DEBUG_ER        0x00000400
1068 #define FF_DEBUG_MMCO      0x00000800
1069 #define FF_DEBUG_BUGS      0x00001000
1070
1071     /**
1072      * error.
1073      * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
1074      * - decoding: unused
1075      */
1076     uint64_t error[4];
1077
1078     /**
1079      * minimum MB quantizer.
1080      * - encoding: set by user.
1081      * - decoding: unused
1082      */
1083     int mb_qmin;
1084
1085     /**
1086      * maximum MB quantizer.
1087      * - encoding: set by user.
1088      * - decoding: unused
1089      */
1090     int mb_qmax;
1091
1092     /**
1093      * motion estimation compare function.
1094      * - encoding: set by user.
1095      * - decoding: unused
1096      */
1097     int me_cmp;
1098     /**
1099      * subpixel motion estimation compare function.
1100      * - encoding: set by user.
1101      * - decoding: unused
1102      */
1103     int me_sub_cmp;
1104     /**
1105      * macroblock compare function (not supported yet).
1106      * - encoding: set by user.
1107      * - decoding: unused
1108      */
1109     int mb_cmp;
1110 #define FF_CMP_SAD  0
1111 #define FF_CMP_SSE  1
1112 #define FF_CMP_SATD 2
1113 #define FF_CMP_DCT  3
1114 #define FF_CMP_PSNR 4
1115 #define FF_CMP_BIT  5
1116 #define FF_CMP_RD   6
1117 #define FF_CMP_ZERO 7
1118 #define FF_CMP_CHROMA 256
1119
1120     /**
1121      * ME diamond size & shape.
1122      * - encoding: set by user.
1123      * - decoding: unused
1124      */
1125     int dia_size;
1126
1127     /**
1128      * amount of previous MV predictors (2a+1 x 2a+1 square).
1129      * - encoding: set by user.
1130      * - decoding: unused
1131      */
1132     int last_predictor_count;
1133
1134     /**
1135      * pre pass for motion estimation.
1136      * - encoding: set by user.
1137      * - decoding: unused
1138      */
1139     int pre_me;
1140
1141     /**
1142      * motion estimation pre pass compare function.
1143      * - encoding: set by user.
1144      * - decoding: unused
1145      */
1146     int me_pre_cmp;
1147
1148     /**
1149      * ME pre pass diamond size & shape.
1150      * - encoding: set by user.
1151      * - decoding: unused
1152      */
1153     int pre_dia_size;
1154
1155     /**
1156      * subpel ME quality.
1157      * - encoding: set by user.
1158      * - decoding: unused
1159      */
1160     int me_subpel_quality;
1161
1162     /**
1163      * callback to negotiate the pixelFormat.
1164      * @param fmt is the list of formats which are supported by the codec,
1165      * its terminated by -1 as 0 is a valid format, the formats are ordered by quality
1166      * the first is allways the native one
1167      * @return the choosen format
1168      * - encoding: unused
1169      * - decoding: set by user, if not set then the native format will always be choosen
1170      */
1171     enum PixelFormat (*get_format)(struct AVCodecContext *s, enum PixelFormat * fmt);
1172
1173     /**
1174      * DTG active format information (additionnal aspect ratio
1175      * information only used in DVB MPEG2 transport streams). 0 if
1176      * not set.
1177      *
1178      * - encoding: unused.
1179      * - decoding: set by decoder
1180      */
1181     int dtg_active_format;
1182 #define FF_DTG_AFD_SAME         8
1183 #define FF_DTG_AFD_4_3          9
1184 #define FF_DTG_AFD_16_9         10
1185 #define FF_DTG_AFD_14_9         11
1186 #define FF_DTG_AFD_4_3_SP_14_9  13
1187 #define FF_DTG_AFD_16_9_SP_14_9 14
1188 #define FF_DTG_AFD_SP_4_3       15
1189
1190     /**
1191      * Maximum motion estimation search range in subpel units.
1192      * if 0 then no limit
1193      *
1194      * - encoding: set by user.
1195      * - decoding: unused.
1196      */
1197     int me_range;
1198
1199     /**
1200      * frame_rate_base.
1201      * for variable fps this is 1
1202      * - encoding: set by user.
1203      * - decoding: set by lavc.
1204      * @todo move this after frame_rate
1205      */
1206
1207     int frame_rate_base;
1208     /**
1209      * intra quantizer bias.
1210      * - encoding: set by user.
1211      * - decoding: unused
1212      */
1213     int intra_quant_bias;
1214 #define FF_DEFAULT_QUANT_BIAS 999999
1215
1216     /**
1217      * inter quantizer bias.
1218      * - encoding: set by user.
1219      * - decoding: unused
1220      */
1221     int inter_quant_bias;
1222
1223     /**
1224      * color table ID.
1225      * - encoding: unused.
1226      * - decoding: which clrtable should be used for 8bit RGB images
1227      *             table have to be stored somewhere FIXME
1228      */
1229     int color_table_id;
1230
1231     /**
1232      * internal_buffer count.
1233      * Dont touch, used by lavc default_get_buffer()
1234      */
1235     int internal_buffer_count;
1236
1237     /**
1238      * internal_buffers.
1239      * Dont touch, used by lavc default_get_buffer()
1240      */
1241     void *internal_buffer;
1242
1243 #define FF_LAMBDA_SHIFT 7
1244 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1245 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1246 #define FF_LAMBDA_MAX (256*128-1)
1247
1248 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1249     /**
1250      * global quality for codecs which cannot change it per frame.
1251      * this should be proportional to MPEG1/2/4 qscale.
1252      * - encoding: set by user.
1253      * - decoding: unused
1254      */
1255     int global_quality;
1256
1257 #define FF_CODER_TYPE_VLC   0
1258 #define FF_CODER_TYPE_AC    1
1259     /**
1260      * coder type
1261      * - encoding: set by user.
1262      * - decoding: unused
1263      */
1264     int coder_type;
1265
1266     /**
1267      * context model
1268      * - encoding: set by user.
1269      * - decoding: unused
1270      */
1271     int context_model;
1272
1273     /**
1274      * slice flags
1275      * - encoding: unused
1276      * - decoding: set by user.
1277      */
1278     int slice_flags;
1279 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1280 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1281 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1282
1283     /**
1284      * XVideo Motion Acceleration
1285      * - encoding: forbidden
1286      * - decoding: set by decoder
1287      */
1288     int xvmc_acceleration;
1289
1290     /**
1291      * macroblock decision mode
1292      * - encoding: set by user.
1293      * - decoding: unused
1294      */
1295     int mb_decision;
1296 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1297 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1298 #define FF_MB_DECISION_RD     2        ///< rate distoration
1299
1300     /**
1301      * custom intra quantization matrix
1302      * - encoding: set by user, can be NULL
1303      * - decoding: set by lavc
1304      */
1305     uint16_t *intra_matrix;
1306
1307     /**
1308      * custom inter quantization matrix
1309      * - encoding: set by user, can be NULL
1310      * - decoding: set by lavc
1311      */
1312     uint16_t *inter_matrix;
1313
1314     /**
1315      * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1316      * this is used to workaround some encoder bugs
1317      * - encoding: unused
1318      * - decoding: set by user, will be converted to upper case by lavc during init
1319      */
1320     unsigned int stream_codec_tag;
1321
1322     /**
1323      * scene change detection threshold.
1324      * 0 is default, larger means fewer detected scene changes
1325      * - encoding: set by user.
1326      * - decoding: unused
1327      */
1328     int scenechange_threshold;
1329
1330     /**
1331      * minimum lagrange multipler
1332      * - encoding: set by user.
1333      * - decoding: unused
1334      */
1335     int lmin;
1336
1337     /**
1338      * maximum lagrange multipler
1339      * - encoding: set by user.
1340      * - decoding: unused
1341      */
1342     int lmax;
1343
1344 } AVCodecContext;
1345
1346
1347 /**
1348  * AVOption.
1349  */
1350 typedef struct AVOption {
1351     /** options' name */
1352     const char *name; /* if name is NULL, it indicates a link to next */
1353     /** short English text help or const struct AVOption* subpointer */
1354     const char *help; //        const struct AVOption* sub;
1355     /** offset to context structure where the parsed value should be stored */
1356     int offset;
1357     /** options' type */
1358     int type;
1359 #define FF_OPT_TYPE_BOOL 1      ///< boolean - true,1,on  (or simply presence)
1360 #define FF_OPT_TYPE_DOUBLE 2    ///< double
1361 #define FF_OPT_TYPE_INT 3       ///< integer
1362 #define FF_OPT_TYPE_STRING 4    ///< string (finished with \0)
1363 #define FF_OPT_TYPE_MASK 0x1f   ///< mask for types - upper bits are various flags
1364 //#define FF_OPT_TYPE_EXPERT 0x20 // flag for expert option
1365 #define FF_OPT_TYPE_FLAG (FF_OPT_TYPE_BOOL | 0x40)
1366 #define FF_OPT_TYPE_RCOVERRIDE (FF_OPT_TYPE_STRING | 0x80)
1367     /** min value  (min == max   ->  no limits) */
1368     double min;
1369     /** maximum value for double/int */
1370     double max;
1371     /** default boo [0,1]l/double/int value */
1372     double defval;
1373     /**
1374      * default string value (with optional semicolon delimited extra option-list
1375      * i.e.   option1;option2;option3
1376      * defval might select other then first argument as default
1377      */
1378     const char *defstr;
1379 #define FF_OPT_MAX_DEPTH 10
1380 } AVOption;
1381
1382 /**
1383  * Parse option(s) and sets fields in passed structure
1384  * @param strct structure where the parsed results will be written
1385  * @param list  list with AVOptions
1386  * @param opts  string with options for parsing
1387  */
1388 int avoption_parse(void* strct, const AVOption* list, const char* opts);
1389
1390
1391 /**
1392  * AVCodec.
1393  */
1394 typedef struct AVCodec {
1395     const char *name;
1396     enum CodecType type;
1397     int id;
1398     int priv_data_size;
1399     int (*init)(AVCodecContext *);
1400     int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
1401     int (*close)(AVCodecContext *);
1402     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
1403                   uint8_t *buf, int buf_size);
1404     int capabilities;
1405     const AVOption *options;
1406     struct AVCodec *next;
1407     void (*flush)(AVCodecContext *);
1408 } AVCodec;
1409
1410 /**
1411  * four components are given, that's all.
1412  * the last component is alpha
1413  */
1414 typedef struct AVPicture {
1415     uint8_t *data[4];
1416     int linesize[4];       ///< number of bytes per line
1417 } AVPicture;
1418
1419 /**
1420  * AVPaletteControl
1421  * This structure defines a method for communicating palette changes
1422  * between and demuxer and a decoder.
1423  */
1424 typedef struct AVPaletteControl {
1425
1426     /* demuxer sets this to 1 to indicate the palette has changed;
1427      * decoder resets to 0 */
1428     int palette_changed;
1429
1430     /* 256 3-byte RGB palette entries; the components should be
1431      * formatted in the buffer as "RGBRGB..." and should be scaled to
1432      * 8 bits if they originally represented 6-bit VGA palette
1433      * components */
1434     unsigned char palette[256 * 3];
1435
1436 } AVPaletteControl;
1437
1438 extern AVCodec ac3_encoder;
1439 extern AVCodec mp2_encoder;
1440 extern AVCodec mp3lame_encoder;
1441 extern AVCodec oggvorbis_encoder;
1442 extern AVCodec faac_encoder;
1443 extern AVCodec mpeg1video_encoder;
1444 extern AVCodec mpeg2video_encoder;
1445 extern AVCodec h263_encoder;
1446 extern AVCodec h263p_encoder;
1447 extern AVCodec flv_encoder;
1448 extern AVCodec rv10_encoder;
1449 extern AVCodec mjpeg_encoder;
1450 extern AVCodec ljpeg_encoder;
1451 extern AVCodec mpeg4_encoder;
1452 extern AVCodec msmpeg4v1_encoder;
1453 extern AVCodec msmpeg4v2_encoder;
1454 extern AVCodec msmpeg4v3_encoder;
1455 extern AVCodec wmv1_encoder;
1456 extern AVCodec wmv2_encoder;
1457 extern AVCodec huffyuv_encoder;
1458 extern AVCodec h264_encoder;
1459 extern AVCodec asv1_encoder;
1460 extern AVCodec asv2_encoder;
1461 extern AVCodec vcr1_encoder;
1462 extern AVCodec ffv1_encoder;
1463 extern AVCodec mdec_encoder;
1464
1465 extern AVCodec h263_decoder;
1466 extern AVCodec mpeg4_decoder;
1467 extern AVCodec msmpeg4v1_decoder;
1468 extern AVCodec msmpeg4v2_decoder;
1469 extern AVCodec msmpeg4v3_decoder;
1470 extern AVCodec wmv1_decoder;
1471 extern AVCodec wmv2_decoder;
1472 extern AVCodec mpeg1video_decoder;
1473 extern AVCodec mpeg2video_decoder;
1474 extern AVCodec mpeg_xvmc_decoder;
1475 extern AVCodec h263i_decoder;
1476 extern AVCodec flv_decoder;
1477 extern AVCodec rv10_decoder;
1478 extern AVCodec svq1_decoder;
1479 extern AVCodec svq3_decoder;
1480 extern AVCodec dvvideo_decoder;
1481 extern AVCodec wmav1_decoder;
1482 extern AVCodec wmav2_decoder;
1483 extern AVCodec mjpeg_decoder;
1484 extern AVCodec mjpegb_decoder;
1485 extern AVCodec sp5x_decoder;
1486 extern AVCodec mp2_decoder;
1487 extern AVCodec mp3_decoder;
1488 extern AVCodec mace3_decoder;
1489 extern AVCodec mace6_decoder;
1490 extern AVCodec huffyuv_decoder;
1491 extern AVCodec oggvorbis_decoder;
1492 extern AVCodec cyuv_decoder;
1493 extern AVCodec h264_decoder;
1494 extern AVCodec indeo3_decoder;
1495 extern AVCodec vp3_decoder;
1496 extern AVCodec theora_decoder;
1497 extern AVCodec amr_nb_decoder;
1498 extern AVCodec amr_nb_encoder;
1499 extern AVCodec amr_wb_encoder;
1500 extern AVCodec amr_wb_decoder;
1501 extern AVCodec aac_decoder;
1502 extern AVCodec mpeg4aac_decoder;
1503 extern AVCodec asv1_decoder;
1504 extern AVCodec asv2_decoder;
1505 extern AVCodec vcr1_decoder;
1506 extern AVCodec cljr_decoder;
1507 extern AVCodec ffv1_decoder;
1508 extern AVCodec fourxm_decoder;
1509 extern AVCodec mdec_decoder;
1510 extern AVCodec roq_decoder;
1511 extern AVCodec interplay_video_decoder;
1512 extern AVCodec xan_wc3_decoder;
1513 extern AVCodec rpza_decoder;
1514 extern AVCodec cinepak_decoder;
1515 extern AVCodec msrle_decoder;
1516 extern AVCodec msvideo1_decoder;
1517 extern AVCodec vqa_decoder;
1518 extern AVCodec idcin_decoder;
1519 extern AVCodec ra_144_decoder;
1520 extern AVCodec ra_288_decoder;
1521 extern AVCodec roq_dpcm_decoder;
1522 extern AVCodec interplay_dpcm_decoder;
1523 extern AVCodec xan_dpcm_decoder;
1524
1525 /* pcm codecs */
1526 #define PCM_CODEC(id, name) \
1527 extern AVCodec name ## _decoder; \
1528 extern AVCodec name ## _encoder
1529
1530 PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
1531 PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
1532 PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
1533 PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
1534 PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
1535 PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
1536 PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
1537 PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
1538
1539 /* adpcm codecs */
1540
1541 PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
1542 PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
1543 PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
1544 PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
1545 PCM_CODEC(CODEC_ID_ADPCM_IMA_WS, adpcm_ima_ws);
1546 PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
1547 PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
1548 PCM_CODEC(CODEC_ID_ADPCM_XA, adpcm_xa);
1549 PCM_CODEC(CODEC_ID_ADPCM_ADX, adpcm_adx);
1550
1551 #undef PCM_CODEC
1552
1553 /* dummy raw video codec */
1554 extern AVCodec rawvideo_encoder;
1555 extern AVCodec rawvideo_decoder;
1556
1557 /* the following codecs use external GPL libs */
1558 extern AVCodec ac3_decoder;
1559
1560 /* resample.c */
1561
1562 struct ReSampleContext;
1563
1564 typedef struct ReSampleContext ReSampleContext;
1565
1566 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
1567                                      int output_rate, int input_rate);
1568 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
1569 void audio_resample_close(ReSampleContext *s);
1570
1571 /* YUV420 format is assumed ! */
1572
1573 struct ImgReSampleContext;
1574
1575 typedef struct ImgReSampleContext ImgReSampleContext;
1576
1577 ImgReSampleContext *img_resample_init(int output_width, int output_height,
1578                                       int input_width, int input_height);
1579
1580 ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
1581                                       int iwidth, int iheight,
1582                                       int topBand, int bottomBand,
1583                                       int leftBand, int rightBand);
1584
1585 void img_resample(ImgReSampleContext *s,
1586                   AVPicture *output, const AVPicture *input);
1587
1588 void img_resample_close(ImgReSampleContext *s);
1589
1590 /**
1591  * Allocate memory for a picture.  Call avpicture_free to free it.
1592  *
1593  * @param picture the picture to be filled in.
1594  * @param pix_fmt the format of the picture.
1595  * @param width the width of the picture.
1596  * @param height the height of the picture.
1597  * @return 0 if successful, -1 if not.
1598  */
1599 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
1600
1601 /* Free a picture previously allocated by avpicture_alloc. */
1602 void avpicture_free(AVPicture *picture);
1603
1604 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
1605                    int pix_fmt, int width, int height);
1606 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
1607                      unsigned char *dest, int dest_size);
1608 int avpicture_get_size(int pix_fmt, int width, int height);
1609 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
1610 const char *avcodec_get_pix_fmt_name(int pix_fmt);
1611 enum PixelFormat avcodec_get_pix_fmt(const char* name);
1612
1613 #define FF_LOSS_RESOLUTION  0x0001 /* loss due to resolution change */
1614 #define FF_LOSS_DEPTH       0x0002 /* loss due to color depth change */
1615 #define FF_LOSS_COLORSPACE  0x0004 /* loss due to color space conversion */
1616 #define FF_LOSS_ALPHA       0x0008 /* loss of alpha bits */
1617 #define FF_LOSS_COLORQUANT  0x0010 /* loss due to color quantization */
1618 #define FF_LOSS_CHROMA      0x0020 /* loss of chroma (e.g. rgb to gray conversion) */
1619
1620 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
1621                              int has_alpha);
1622 int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
1623                               int has_alpha, int *loss_ptr);
1624
1625 #define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
1626 #define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
1627 int img_get_alpha_info(const AVPicture *src,
1628                        int pix_fmt, int width, int height);
1629
1630 /* convert among pixel formats */
1631 int img_convert(AVPicture *dst, int dst_pix_fmt,
1632                 const AVPicture *src, int pix_fmt,
1633                 int width, int height);
1634
1635 /* deinterlace a picture */
1636 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
1637                           int pix_fmt, int width, int height);
1638
1639 /* external high level API */
1640
1641 extern AVCodec *first_avcodec;
1642
1643 /* returns LIBAVCODEC_VERSION_INT constant */
1644 unsigned avcodec_version(void);
1645 /* returns LIBAVCODEC_BUILD constant */
1646 unsigned avcodec_build(void);
1647 void avcodec_init(void);
1648
1649 void register_avcodec(AVCodec *format);
1650 AVCodec *avcodec_find_encoder(enum CodecID id);
1651 AVCodec *avcodec_find_encoder_by_name(const char *name);
1652 AVCodec *avcodec_find_decoder(enum CodecID id);
1653 AVCodec *avcodec_find_decoder_by_name(const char *name);
1654 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
1655
1656 void avcodec_get_context_defaults(AVCodecContext *s);
1657 AVCodecContext *avcodec_alloc_context(void);
1658 AVFrame *avcodec_alloc_frame(void);
1659
1660 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
1661 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
1662 void avcodec_default_free_buffers(AVCodecContext *s);
1663
1664 /**
1665  * opens / inits the AVCodecContext.
1666  * not thread save!
1667  */
1668 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
1669
1670 int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
1671                          int *frame_size_ptr,
1672                          uint8_t *buf, int buf_size);
1673 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
1674                          int *got_picture_ptr,
1675                          uint8_t *buf, int buf_size);
1676 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
1677                         int *data_size_ptr,
1678                         uint8_t *buf, int buf_size);
1679 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
1680                          const short *samples);
1681 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
1682                          const AVFrame *pict);
1683
1684 int avcodec_close(AVCodecContext *avctx);
1685
1686 void avcodec_register_all(void);
1687
1688 void avcodec_flush_buffers(AVCodecContext *avctx);
1689
1690 /* misc usefull functions */
1691
1692 /**
1693  * returns a single letter to describe the picture type
1694  */
1695 char av_get_pict_type_char(int pict_type);
1696
1697 /**
1698  * reduce a fraction.
1699  * this is usefull for framerate calculations
1700  * @param max the maximum allowed for dst_nom & dst_den
1701  * @return 1 if exact, 0 otherwise
1702  */
1703 int av_reduce(int *dst_nom, int *dst_den, int64_t nom, int64_t den, int64_t max);
1704
1705 /**
1706  * rescale a 64bit integer.
1707  * a simple a*b/c isnt possible as it can overflow
1708  */
1709 int64_t av_rescale(int64_t a, int b, int c);
1710
1711
1712 /**
1713  * Interface for 0.5.0 version
1714  *
1715  * do not even think about it's usage for this moment
1716  */
1717
1718 typedef struct {
1719     /// compressed size used from given memory buffer
1720     int size;
1721     /// I/P/B frame type
1722     int frame_type;
1723 } avc_enc_result_t;
1724
1725 /**
1726  * Commands
1727  * order can't be changed - once it was defined
1728  */
1729 typedef enum {
1730     // general commands
1731     AVC_OPEN_BY_NAME = 0xACA000,
1732     AVC_OPEN_BY_CODEC_ID,
1733     AVC_OPEN_BY_FOURCC,
1734     AVC_CLOSE,
1735
1736     AVC_FLUSH,
1737     // pin - struct { uint8_t* src, uint_t src_size }
1738     // pout - struct { AVPicture* img, consumed_bytes,
1739     AVC_DECODE,
1740     // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
1741     // pout - uint_t used_from_dest_size
1742     AVC_ENCODE,
1743
1744     // query/get video commands
1745     AVC_GET_VERSION = 0xACB000,
1746     AVC_GET_WIDTH,
1747     AVC_GET_HEIGHT,
1748     AVC_GET_DELAY,
1749     AVC_GET_QUANT_TABLE,
1750     // ...
1751
1752     // query/get audio commands
1753     AVC_GET_FRAME_SIZE = 0xABC000,
1754
1755     // maybe define some simple structure which
1756     // might be passed to the user - but they can't
1757     // contain any codec specific parts and these
1758     // calls are usualy necessary only few times
1759
1760     // set video commands
1761     AVC_SET_WIDTH = 0xACD000,
1762     AVC_SET_HEIGHT,
1763
1764     // set video encoding commands
1765     AVC_SET_FRAME_RATE = 0xACD800,
1766     AVC_SET_QUALITY,
1767     AVC_SET_HURRY_UP,
1768
1769     // set audio commands
1770     AVC_SET_SAMPLE_RATE = 0xACE000,
1771     AVC_SET_CHANNELS,
1772
1773 } avc_cmd_t;
1774
1775 /**
1776  * \param handle  allocated private structure by libavcodec
1777  *                for initialization pass NULL - will be returned pout
1778  *                user is supposed to know nothing about its structure
1779  * \param cmd     type of operation to be performed
1780  * \param pint    input parameter
1781  * \param pout    output parameter
1782  *
1783  * \returns  command status - eventually for query command it might return
1784  * integer resulting value
1785  */
1786 int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);
1787
1788 /* memory */
1789 void *av_malloc(unsigned int size);
1790 void *av_mallocz(unsigned int size);
1791 void *av_realloc(void *ptr, unsigned int size);
1792 void av_free(void *ptr);
1793 char *av_strdup(const char *s);
1794 void __av_freep(void **ptr);
1795 #define av_freep(p) __av_freep((void **)(p))
1796 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
1797 /* for static data only */
1798 /* call av_free_static to release all staticaly allocated tables */
1799 void av_free_static(void);
1800 void *__av_mallocz_static(void** location, unsigned int size);
1801 #define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
1802
1803 /* add by bero : in adx.c */
1804 int is_adx(const unsigned char *buf,size_t bufsize);
1805
1806 #ifdef __cplusplus
1807 }
1808 #endif
1809
1810 #endif /* AVCODEC_H */