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

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