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

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