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