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