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