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

   1 #ifndef AVCODEC_H
   2 #define AVCODEC_H
   3
   4 #include "common.h"
   5
   6 #define LIBAVCODEC_VERSION_INT 0x000406
   7 #define LIBAVCODEC_VERSION     "0.4.6"
   8 #define LIBAVCODEC_BUILD       4611
   9 #define LIBAVCODEC_BUILD_STR   "4611"
  10
  11 enum CodecID {
  12     CODEC_ID_NONE,
  13     CODEC_ID_MPEG1VIDEO,
  14     CODEC_ID_H263,
  15     CODEC_ID_RV10,
  16     CODEC_ID_MP2,
  17     CODEC_ID_MP3LAME,
  18     CODEC_ID_AC3,
  19     CODEC_ID_MJPEG,
  20     CODEC_ID_MPEG4,
  21     CODEC_ID_RAWVIDEO,
  22     CODEC_ID_MSMPEG4V1,
  23     CODEC_ID_MSMPEG4V2,
  24     CODEC_ID_MSMPEG4V3,
  25     CODEC_ID_WMV1,
  26     CODEC_ID_H263P,
  27     CODEC_ID_H263I,
  28
  29     /* various pcm "codecs" */
  30     CODEC_ID_PCM_S16LE,
  31     CODEC_ID_PCM_S16BE,
  32     CODEC_ID_PCM_U16LE,
  33     CODEC_ID_PCM_U16BE,
  34     CODEC_ID_PCM_S8,
  35     CODEC_ID_PCM_U8,
  36     CODEC_ID_PCM_MULAW,
  37     CODEC_ID_PCM_ALAW,
  38 };
  39 #define CODEC_ID_MSMPEG4 CODEC_ID_MSMPEG4V3
  40
  41 enum CodecType {
  42     CODEC_TYPE_UNKNOWN = -1,
  43     CODEC_TYPE_VIDEO,
  44     CODEC_TYPE_AUDIO,
  45 };
  46
  47 enum PixelFormat {
  48     PIX_FMT_ANY = -1,
  49     PIX_FMT_YUV420P,
  50     PIX_FMT_YUV422,
  51     PIX_FMT_RGB24,
  52     PIX_FMT_BGR24,
  53     PIX_FMT_YUV422P,
  54     PIX_FMT_YUV444P,
  55 };
  56
  57 /* currently unused, may be used if 24/32 bits samples ever supported */
  58 enum SampleFormat {
  59     SAMPLE_FMT_S16 = 0,         /* signed 16 bits */
  60 };
  61
  62 /* in bytes */
  63 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 18432
  64
  65 /* motion estimation type, EPZS by default */
  66 enum Motion_Est_ID {
  67     ME_ZERO = 1,
  68     ME_FULL,
  69     ME_LOG,
  70     ME_PHODS,
  71     ME_EPZS,
  72     ME_X1
  73 };
  74
  75 /* only for ME compatiblity with old apps */
  76 extern int motion_estimation_method;
  77
  78 /* ME algos sorted by quality */
  79 static const int Motion_Est_QTab[] = { ME_ZERO, ME_PHODS, ME_LOG,
  80                                        ME_X1, ME_EPZS, ME_FULL };
  81
  82 #define FF_MAX_B_FRAMES 4
  83
  84 /* encoding support */
  85 /* note not everything is supported yet */
  86
  87 #define CODEC_FLAG_HQ     0x0001 /* high quality (non real time) encoding */
  88 #define CODEC_FLAG_QSCALE 0x0002 /* use fixed qscale */
  89 #define CODEC_FLAG_4MV    0x0004 /* 4 MV per MB allowed */
  90 #define CODEC_FLAG_QPEL   0x0010 /* use qpel MC */
  91 #define CODEC_FLAG_GMC    0x0020 /* use GMC */
  92 #define CODEC_FLAG_TYPE   0x0040 /* fixed I/P frame type, from avctx->key_frame */
  93 #define CODEC_FLAG_PART   0x0080 /* use data partitioning */
  94 /* parent program gurantees that the input for b-frame containing streams is not written to
  95    for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
  96 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
  97 #define CODEC_FLAG_PASS1 0x0200  /* use internal 2pass ratecontrol in first  pass mode */
  98 #define CODEC_FLAG_PASS2 0x0400  /* use internal 2pass ratecontrol in second pass mode */
  99 #define CODEC_FLAG_EXTERN_HUFF 0x1000 /* use external huffman table (for mjpeg) */
 100
 101 /* codec capabilities */
 102
 103 /* decoder can use draw_horiz_band callback */
 104 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001
 105
 106 #define FRAME_RATE_BASE 10000
 107
 108 typedef struct AVCodecContext {
 109     int bit_rate;
 110     int bit_rate_tolerance; /* amount of +- bits (>0)*/
 111     int flags;
 112     int sub_id;    /* some codecs needs additionnal format info. It is
 113                       stored there */
 114
 115     int me_method; /* ME algorithm used for video coding */
 116
 117     /* extra data from parent application to codec, e.g. huffman table
 118        for mjpeg */
 119     /* the parent should allocate and free this buffer */
 120     void *extradata;
 121     int extradata_size;
 122
 123     /* video only */
 124     int frame_rate; /* frames per sec multiplied by FRAME_RATE_BASE */
 125     int width, height;
 126     int aspect_ratio_info;
 127 #define FF_ASPECT_SQUARE 1
 128 #define FF_ASPECT_4_3_625 2
 129 #define FF_ASPECT_4_3_525 3
 130 #define FF_ASPECT_16_9_625 4
 131 #define FF_ASPECT_16_9_525 5
 132     int gop_size; /* 0 = intra only */
 133     enum PixelFormat pix_fmt;  /* pixel format, see PIX_FMT_xxx */
 134     int repeat_pict; /* when decoding, this signal how much the picture */
 135                      /* must be delayed.                                */
 136                      /* extra_delay = (repeat_pict / 2) * (1/fps)       */
 137     /* if non NULL, 'draw_horiz_band' is called by the libavcodec
 138        decoder to draw an horizontal band. It improve cache usage. Not
 139        all codecs can do that. You must check the codec capabilities
 140        before */
 141     void (*draw_horiz_band)(struct AVCodecContext *s,
 142                             UINT8 **src_ptr, int linesize,
 143                             int y, int width, int height);
 144
 145     /* audio only */
 146     int sample_rate; /* samples per sec */
 147     int channels;
 148     int sample_fmt;  /* sample format, currenly unused */
 149
 150     /* the following data should not be initialized */
 151     int frame_size;     /* in samples, initialized when calling 'init' */
 152     int frame_number;   /* audio or video frame number */
 153     int real_pict_num;  /* returns the real picture number of
 154                            previous encoded frame */
 155     int key_frame;      /* true if the previous compressed frame was
 156                            a key frame (intra, or seekable) */
 157     int pict_type;      /* picture type of the previous
 158                            encoded frame */
 159 /* FIXME: these should have FF_ */
 160 #define I_TYPE 1 // Intra
 161 #define P_TYPE 2 // Predicted
 162 #define B_TYPE 3 // Bi-dir predicted
 163 #define S_TYPE 4 // S(GMC)-VOP MPEG4
 164
 165     int delay;          /* number of frames the decoded output
 166                            will be delayed relative to the encoded input */
 167     uint8_t *mbskip_table; /* =1 if MB didnt change, is only valid for I/P frames
 168                               stride= mb_width = (width+15)>>4 */
 169
 170     /* encoding parameters */
 171     int quality;      /* quality of the previous encoded frame
 172                          (between 1 (good) and 31 (bad))
 173                          this is allso used to set the quality in vbr mode
 174                          and the per frame quality in CODEC_FLAG_TYPE (second pass mode) */
 175     float qcompress;  /* amount of qscale change between easy & hard scenes (0.0-1.0)*/
 176     float qblur;      /* amount of qscale smoothing over time (0.0-1.0) */
 177     int qmin;         /* min qscale */
 178     int qmax;         /* max qscale */
 179     int max_qdiff;    /* max qscale difference between frames */
 180     int max_b_frames; /* maximum b frames, the output will be delayed by max_b_frames+1 relative to the input */
 181     float b_quant_factor;/* qscale factor between ips and b frames */
 182     int rc_strategy;
 183     int b_frame_strategy;
 184
 185     int hurry_up;     /* when set to 1 during decoding, b frames will be skiped
 186                          when set to 2 idct/dequant will be skipped too */
 187
 188     struct AVCodec *codec;
 189     void *priv_data;
 190
 191     /* The following data is for RTP friendly coding */
 192     /* By now only H.263/H.263+/MPEG4 coder honours this   */
 193     int rtp_mode;   /* 1 for activate RTP friendly-mode           */
 194                     /* highers numbers represent more error-prone */
 195                     /* enviroments, by now just "1" exist         */
 196
 197     int rtp_payload_size;   /* The size of the RTP payload, the coder will  */
 198                             /* do it's best to deliver a chunk with size    */
 199                             /* below rtp_payload_size, the chunk will start */
 200                             /* with a start code on some codecs like H.263  */
 201                             /* This doesn't take account of any particular  */
 202                             /* headers inside the transmited RTP payload    */
 203
 204
 205     /* The RTP callcack: This function is called  */
 206     /* every time the encoder as a packet to send */
 207     /* Depends on the encoder if the data starts  */
 208     /* with a Start Code (it should) H.263 does   */
 209     void (*rtp_callback)(void *data, int size, int packet_number);
 210
 211     /* These are for PSNR calculation, if you set get_psnr to 1 */
 212     /* after encoding you will have the PSNR on psnr_y/cb/cr    */
 213     int get_psnr;
 214     float psnr_y;
 215     float psnr_cb;
 216     float psnr_cr;
 217
 218     /* statistics, used for 2-pass encoding */
 219     int mv_bits;
 220     int header_bits;
 221     int i_tex_bits;
 222     int p_tex_bits;
 223     int i_count;
 224     int p_count;
 225     int skip_count;
 226     int misc_bits; // cbp, mb_type
 227     int frame_bits;
 228
 229     /* the following fields are ignored */
 230     void *opaque;   /* can be used to carry app specific stuff */
 231     char codec_name[32];
 232     enum CodecType codec_type; /* see CODEC_TYPE_xxx */
 233     enum CodecID codec_id; /* see CODEC_ID_xxx */
 234     unsigned int codec_tag;  /* codec tag, only used if unknown codec */
 235
 236     int workaround_bugs;       /* workaround bugs in encoders which cannot be detected automatically */
 237     int luma_elim_threshold;
 238     int chroma_elim_threshold;
 239     int strict_std_compliance; /* strictly follow the std (MPEG4, ...) */
 240     float b_quant_offset;/* qscale offset between ips and b frames, not implemented yet */
 241     int error_resilience;
 242
 243     //FIXME this should be reordered after kabis API is finished ...
 244     /*
 245         Note: Below are located reserved fields for further usage
 246         It requires for ABI !!!
 247         If you'll perform some changes then borrow new space from these fields
 248         (void * can be safety replaced with struct * ;)
 249         P L E A S E ! ! !
 250         IMPORTANT: Never change order of already declared fields!!!
 251     */
 252     unsigned long long int
 253             ull_res0,ull_res1,ull_res2,ull_res3,ull_res4,ull_res5,
 254             ull_res6,ull_res7,ull_res8,ull_res9,ull_res10,ull_res11,ull_res12;
 255     float
 256             flt_res0,flt_res1,flt_res2,flt_res3,flt_res4,flt_res5,
 257             flt_res6,flt_res7,flt_res8,flt_res9,flt_res10,flt_res11;
 258     void
 259             *ptr_res0,*ptr_res1,*ptr_res2,*ptr_res3,*ptr_res4,*ptr_res5,
 260             *ptr_res6,*ptr_res7,*ptr_res8,*ptr_res9,*ptr_res10,*ptr_res11,*ptr_res12;
 261     unsigned long int
 262             ul_res0,ul_res1,ul_res2,ul_res3,ul_res4,ul_res5,
 263             ul_res6,ul_res7,ul_res8,ul_res9,ul_res10,ul_res11,ul_res12;
 264     unsigned int
 265             ui_res0,ui_res1,ui_res2,ui_res3,ui_res4,ui_res5,
 266             ui_res6,ui_res7;
 267     unsigned short int
 268             us_res0,us_res1,us_res2,us_res3,us_res4,us_res5,
 269             us_res6,us_res7,us_res8,us_res9,us_res10,us_res11,us_res12;
 270     unsigned char
 271             uc_res0,uc_res1,uc_res2,uc_res3,uc_res4,uc_res5,
 272             uc_res6,uc_res7,uc_res8,uc_res9,uc_res10,uc_res11,uc_res12;
 273 } AVCodecContext;
 274
 275 typedef struct AVCodec {
 276     char *name;
 277     int type;
 278     int id;
 279     int priv_data_size;
 280     int (*init)(AVCodecContext *);
 281     int (*encode)(AVCodecContext *, UINT8 *buf, int buf_size, void *data);
 282     int (*close)(AVCodecContext *);
 283     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
 284                   UINT8 *buf, int buf_size);
 285     int capabilities;
 286     struct AVCodec *next;
 287     /*
 288         Note: Below are located reserved fields for further usage
 289         It requires for ABI !!!
 290         If you'll perform some changes then borrow new space from these fields
 291         (void * can be safety replaced with struct * ;)
 292         P L E A S E ! ! !
 293         IMPORTANT: Never change order of already declared fields!!!
 294     */
 295     unsigned long long int
 296             ull_res0,ull_res1,ull_res2,ull_res3,ull_res4,ull_res5,
 297             ull_res6,ull_res7,ull_res8,ull_res9,ull_res10,ull_res11,ull_res12;
 298     float
 299             flt_res0,flt_res1,flt_res2,flt_res3,flt_res4,flt_res5,
 300             flt_res6,flt_res7,flt_res8,flt_res9,flt_res10,flt_res11,flt_res12;
 301     void
 302             *ptr_res0,*ptr_res1,*ptr_res2,*ptr_res3,*ptr_res4,*ptr_res5,
 303             *ptr_res6,*ptr_res7,*ptr_res8,*ptr_res9,*ptr_res10,*ptr_res11,*ptr_res12;
 304 } AVCodec;
 305
 306 /* three components are given, that's all */
 307 typedef struct AVPicture {
 308     UINT8 *data[3];
 309     int linesize[3];
 310 } AVPicture;
 311
 312 extern AVCodec ac3_encoder;
 313 extern AVCodec mp2_encoder;
 314 extern AVCodec mp3lame_encoder;
 315 extern AVCodec mpeg1video_encoder;
 316 extern AVCodec h263_encoder;
 317 extern AVCodec h263p_encoder;
 318 extern AVCodec rv10_encoder;
 319 extern AVCodec mjpeg_encoder;
 320 extern AVCodec mpeg4_encoder;
 321 extern AVCodec msmpeg4v1_encoder;
 322 extern AVCodec msmpeg4v2_encoder;
 323 extern AVCodec msmpeg4v3_encoder;
 324
 325 extern AVCodec h263_decoder;
 326 extern AVCodec mpeg4_decoder;
 327 extern AVCodec msmpeg4v1_decoder;
 328 extern AVCodec msmpeg4v2_decoder;
 329 extern AVCodec msmpeg4v3_decoder;
 330 extern AVCodec wmv1_decoder;
 331 extern AVCodec mpeg_decoder;
 332 extern AVCodec h263i_decoder;
 333 extern AVCodec rv10_decoder;
 334 extern AVCodec mjpeg_decoder;
 335 extern AVCodec mp2_decoder;
 336 extern AVCodec mp3_decoder;
 337
 338 /* pcm codecs */
 339 #define PCM_CODEC(id, name) \
 340 extern AVCodec name ## _decoder; \
 341 extern AVCodec name ## _encoder;
 342
 343 PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
 344 PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
 345 PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
 346 PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
 347 PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
 348 PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
 349 PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
 350 PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
 351
 352 #undef PCM_CODEC
 353
 354 /* dummy raw video codec */
 355 extern AVCodec rawvideo_codec;
 356
 357 /* the following codecs use external GPL libs */
 358 extern AVCodec ac3_decoder;
 359
 360 /* resample.c */
 361
 362 struct ReSampleContext;
 363
 364 typedef struct ReSampleContext ReSampleContext;
 365
 366 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
 367                                      int output_rate, int input_rate);
 368 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
 369 void audio_resample_close(ReSampleContext *s);
 370
 371 /* YUV420 format is assumed ! */
 372
 373 struct ImgReSampleContext;
 374
 375 typedef struct ImgReSampleContext ImgReSampleContext;
 376
 377 ImgReSampleContext *img_resample_init(int output_width, int output_height,
 378                                       int input_width, int input_height);
 379 void img_resample(ImgReSampleContext *s,
 380                   AVPicture *output, AVPicture *input);
 381
 382 void img_resample_close(ImgReSampleContext *s);
 383
 384 void avpicture_fill(AVPicture *picture, UINT8 *ptr,
 385                     int pix_fmt, int width, int height);
 386 int avpicture_get_size(int pix_fmt, int width, int height);
 387
 388 /* convert among pixel formats */
 389 int img_convert(AVPicture *dst, int dst_pix_fmt,
 390                 AVPicture *src, int pix_fmt,
 391                 int width, int height);
 392
 393 /* deinterlace a picture */
 394 int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
 395                           int pix_fmt, int width, int height);
 396
 397 /* external high level API */
 398
 399 extern AVCodec *first_avcodec;
 400
 401 /* returns LIBAVCODEC_VERSION_INT constant */
 402 unsigned avcodec_version(void);
 403 /* returns LIBAVCODEC_BUILD constant */
 404 unsigned avcodec_build(void);
 405 void avcodec_init(void);
 406
 407 void avcodec_set_bit_exact(void);
 408
 409 void register_avcodec(AVCodec *format);
 410 AVCodec *avcodec_find_encoder(enum CodecID id);
 411 AVCodec *avcodec_find_encoder_by_name(const char *name);
 412 AVCodec *avcodec_find_decoder(enum CodecID id);
 413 AVCodec *avcodec_find_decoder_by_name(const char *name);
 414 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
 415
 416 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
 417 int avcodec_decode_audio(AVCodecContext *avctx, INT16 *samples,
 418                          int *frame_size_ptr,
 419                          UINT8 *buf, int buf_size);
 420 int avcodec_decode_video(AVCodecContext *avctx, AVPicture *picture,
 421                          int *got_picture_ptr,
 422                          UINT8 *buf, int buf_size);
 423 int avcodec_encode_audio(AVCodecContext *avctx, UINT8 *buf, int buf_size,
 424                          const short *samples);
 425 int avcodec_encode_video(AVCodecContext *avctx, UINT8 *buf, int buf_size,
 426                          const AVPicture *pict);
 427
 428 int avcodec_close(AVCodecContext *avctx);
 429
 430 void avcodec_register_all(void);
 431
 432 void avcodec_flush_buffers(AVCodecContext *avctx);
 433
 434 #ifdef FF_POSTPROCESS
 435 #ifndef MBC
 436 #define MBC 128
 437 #define MBR 96
 438 #endif
 439 extern int quant_store[MBR+1][MBC+1]; // [Review]
 440 #endif
 441
 442
 443 /**
 444  * Interface for 0.5.0 version
 445  *
 446  * do not even think about it's usage for this moment
 447  */
 448
 449 typedef struct {
 450     // compressed size used from given memory buffer
 451     int size;
 452     /// I/P/B frame type
 453     int frame_type;
 454 } avc_enc_result_t;
 455
 456 /**
 457  * Commands
 458  * order can't be changed - once it was defined
 459  */
 460 typedef enum {
 461     // general commands
 462     AVC_OPEN_BY_NAME = 0xACA000,
 463     AVC_OPEN_BY_CODEC_ID,
 464     AVC_OPEN_BY_FOURCC,
 465     AVC_CLOSE,
 466
 467     AVC_FLUSH,
 468     // pin - struct { uint8_t* src, uint_t src_size }
 469     // pout - struct { AVPicture* img, consumed_bytes,
 470     AVC_DECODE,
 471     // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
 472     // pout - uint_t used_from_dest_size
 473     AVC_ENCODE,
 474
 475     // query/get video commands
 476     AVC_GET_VERSION = 0xACB000,
 477     AVC_GET_WIDTH,
 478     AVC_GET_HEIGHT,
 479     AVC_GET_DELAY,
 480     AVC_GET_QUANT_TABLE,
 481     // ...
 482
 483     // query/get audio commands
 484     AVC_GET_FRAME_SIZE = 0xABC000,
 485
 486     // maybe define some simple structure which
 487     // might be passed to the user - but they can't
 488     // contain any codec specific parts and these
 489     // calls are usualy necessary only few times
 490
 491     // set video commands
 492     AVC_SET_WIDTH = 0xACD000,
 493     AVC_SET_HEIGHT,
 494
 495     // set video encoding commands
 496     AVC_SET_FRAME_RATE = 0xACD800,
 497     AVC_SET_QUALITY,
 498     AVC_SET_HURRY_UP,
 499
 500     // set audio commands
 501     AVC_SET_SAMPLE_RATE = 0xACE000,
 502     AVC_SET_CHANNELS,
 503
 504 } avc_cmd_t;
 505
 506 /**
 507  * \param handle  allocated private structure by libavcodec
 508  *                for initialization pass NULL - will be returned pout
 509  *                user is supposed to know nothing about its structure
 510  * \param cmd     type of operation to be performed
 511  * \param pint    input parameter
 512  * \param pout    output parameter
 513  *
 514  * \returns  command status - eventually for query command it might return
 515  * integer resulting value
 516  */
 517 int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);
 518
 519 #endif /* AVCODEC_H */