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       4607
   9 #define LIBAVCODEC_BUILD_STR   "4607"
  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; /* set this to 1 if you want the decoder
 134                         to repeat frames for 3:2 pulldown (MPEG-2) */
 135     /* if non NULL, 'draw_horiz_band' is called by the libavcodec
 136        decoder to draw an horizontal band. It improve cache usage. Not
 137        all codecs can do that. You must check the codec capabilities
 138        before */
 139     void (*draw_horiz_band)(struct AVCodecContext *s,
 140                             UINT8 **src_ptr, int linesize,
 141                             int y, int width, int height);
 142
 143     /* audio only */
 144     int sample_rate; /* samples per sec */
 145     int channels;
 146     int sample_fmt;  /* sample format, currenly unused */
 147
 148     /* the following data should not be initialized */
 149     int frame_size;     /* in samples, initialized when calling 'init' */
 150     int frame_number;   /* audio or video frame number */
 151     int real_pict_num;  /* returns the real picture number of
 152                            previous encoded frame */
 153     int key_frame;      /* true if the previous compressed frame was
 154                            a key frame (intra, or seekable) */
 155     int pict_type;      /* picture type of the previous
 156                            encoded frame */
 157 /* FIXME: these should have FF_ */
 158 #define I_TYPE 1 // Intra
 159 #define P_TYPE 2 // Predicted
 160 #define B_TYPE 3 // Bi-dir predicted
 161 #define S_TYPE 4 // S(GMC)-VOP MPEG4
 162
 163     int delay;          /* number of frames the decoded output
 164                            will be delayed relative to the encoded input */
 165     uint8_t *mbskip_table; /* =1 if MB didnt change, is only valid for I/P frames
 166                               stride= mb_width = (width+15)>>4 */
 167
 168     /* encoding parameters */
 169     int quality;      /* quality of the previous encoded frame
 170                          (between 1 (good) and 31 (bad))
 171                          this is allso used to set the quality in vbr mode
 172                          and the per frame quality in CODEC_FLAG_TYPE (second pass mode) */
 173     float qcompress;  /* amount of qscale change between easy & hard scenes (0.0-1.0)*/
 174     float qblur;      /* amount of qscale smoothing over time (0.0-1.0) */
 175     int qmin;         /* min qscale */
 176     int qmax;         /* max qscale */
 177     int max_qdiff;    /* max qscale difference between frames */
 178     int max_b_frames; /* maximum b frames, the output will be delayed by max_b_frames+1 relative to the input */
 179     float b_quant_factor;/* qscale factor between ips and b frames */
 180     int rc_strategy;
 181     int b_frame_strategy;
 182
 183     int hurry_up;     /* when set to 1 during decoding, b frames will be skiped
 184                          when set to 2 idct/dequant will be skipped too */
 185
 186     struct AVCodec *codec;
 187     void *priv_data;
 188
 189     /* The following data is for RTP friendly coding */
 190     /* By now only H.263/H.263+ coder honours this   */
 191     int rtp_mode;   /* 1 for activate RTP friendly-mode           */
 192                     /* highers numbers represent more error-prone */
 193                     /* enviroments, by now just "1" exist         */
 194
 195     int rtp_payload_size;   /* The size of the RTP payload, the coder will  */
 196                             /* do it's best to deliver a chunk with size    */
 197                             /* below rtp_payload_size, the chunk will start */
 198                             /* with a start code on some codecs like H.263  */
 199                             /* This doesn't take account of any particular  */
 200                             /* headers inside the transmited RTP payload    */
 201
 202
 203     /* The RTP callcack: This function is called  */
 204     /* every time the encoder as a packet to send */
 205     /* Depends on the encoder if the data starts  */
 206     /* with a Start Code (it should) H.263 does   */
 207     void (*rtp_callback)(void *data, int size, int packet_number);
 208
 209     /* These are for PSNR calculation, if you set get_psnr to 1 */
 210     /* after encoding you will have the PSNR on psnr_y/cb/cr    */
 211     int get_psnr;
 212     float psnr_y;
 213     float psnr_cb;
 214     float psnr_cr;
 215
 216     /* statistics, used for 2-pass encoding */
 217     int mv_bits;
 218     int header_bits;
 219     int i_tex_bits;
 220     int p_tex_bits;
 221     int i_count;
 222     int p_count;
 223     int skip_count;
 224     int misc_bits; // cbp, mb_type
 225     int frame_bits;
 226
 227     /* the following fields are ignored */
 228     void *opaque;   /* can be used to carry app specific stuff */
 229     char codec_name[32];
 230     enum CodecType codec_type; /* see CODEC_TYPE_xxx */
 231     enum CodecID codec_id; /* see CODEC_ID_xxx */
 232     unsigned int codec_tag;  /* codec tag, only used if unknown codec */
 233     /*
 234         Note: Below are located reserved fields for further usage
 235         It requires for ABI !!!
 236         If you'll perform some changes then borrow new space from these fields
 237         (void * can be safety replaced with struct * ;)
 238         P L E A S E ! ! !
 239         IMPORTANT: Never change order of already declared fields!!!
 240     */
 241     unsigned long long int
 242             ull_res0,ull_res1,ull_res2,ull_res3,ull_res4,ull_res5,
 243             ull_res6,ull_res7,ull_res8,ull_res9,ull_res10,ull_res11,ull_res12;
 244     float
 245             flt_res0,flt_res1,flt_res2,flt_res3,flt_res4,flt_res5,
 246             flt_res6,flt_res7,flt_res8,flt_res9,flt_res10,flt_res11,flt_res12;
 247     void
 248             *ptr_res0,*ptr_res1,*ptr_res2,*ptr_res3,*ptr_res4,*ptr_res5,
 249             *ptr_res6,*ptr_res7,*ptr_res8,*ptr_res9,*ptr_res10,*ptr_res11,*ptr_res12;
 250     unsigned long int
 251             ul_res0,ul_res1,ul_res2,ul_res3,ul_res4,ul_res5,
 252             ul_res6,ul_res7,ul_res8,ul_res9,ul_res10,ul_res11,ul_res12;
 253     unsigned int
 254             ui_res0,ui_res1,ui_res2,ui_res3,ui_res4,ui_res5,
 255             ui_res6,ui_res7,ui_res8,ui_res9,ui_res10,ui_res11,ui_res12;
 256     unsigned short int
 257             us_res0,us_res1,us_res2,us_res3,us_res4,us_res5,
 258             us_res6,us_res7,us_res8,us_res9,us_res10,us_res11,us_res12;
 259     unsigned char
 260             uc_res0,uc_res1,uc_res2,uc_res3,uc_res4,uc_res5,
 261             uc_res6,uc_res7,uc_res8,uc_res9,uc_res10,uc_res11,uc_res12;
 262 } AVCodecContext;
 263
 264 typedef struct AVCodec {
 265     char *name;
 266     int type;
 267     int id;
 268     int priv_data_size;
 269     int (*init)(AVCodecContext *);
 270     int (*encode)(AVCodecContext *, UINT8 *buf, int buf_size, void *data);
 271     int (*close)(AVCodecContext *);
 272     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
 273                   UINT8 *buf, int buf_size);
 274     int capabilities;
 275     struct AVCodec *next;
 276     /*
 277         Note: Below are located reserved fields for further usage
 278         It requires for ABI !!!
 279         If you'll perform some changes then borrow new space from these fields
 280         (void * can be safety replaced with struct * ;)
 281         P L E A S E ! ! !
 282         IMPORTANT: Never change order of already declared fields!!!
 283     */
 284     unsigned long long int
 285             ull_res0,ull_res1,ull_res2,ull_res3,ull_res4,ull_res5,
 286             ull_res6,ull_res7,ull_res8,ull_res9,ull_res10,ull_res11,ull_res12;
 287     float
 288             flt_res0,flt_res1,flt_res2,flt_res3,flt_res4,flt_res5,
 289             flt_res6,flt_res7,flt_res8,flt_res9,flt_res10,flt_res11,flt_res12;
 290     void
 291             *ptr_res0,*ptr_res1,*ptr_res2,*ptr_res3,*ptr_res4,*ptr_res5,
 292             *ptr_res6,*ptr_res7,*ptr_res8,*ptr_res9,*ptr_res10,*ptr_res11,*ptr_res12;
 293 } AVCodec;
 294
 295 /* three components are given, that's all */
 296 typedef struct AVPicture {
 297     UINT8 *data[3];
 298     int linesize[3];
 299 } AVPicture;
 300
 301 extern AVCodec ac3_encoder;
 302 extern AVCodec mp2_encoder;
 303 extern AVCodec mp3lame_encoder;
 304 extern AVCodec mpeg1video_encoder;
 305 extern AVCodec h263_encoder;
 306 extern AVCodec h263p_encoder;
 307 extern AVCodec rv10_encoder;
 308 extern AVCodec mjpeg_encoder;
 309 extern AVCodec mpeg4_encoder;
 310 extern AVCodec msmpeg4v1_encoder;
 311 extern AVCodec msmpeg4v2_encoder;
 312 extern AVCodec msmpeg4v3_encoder;
 313
 314 extern AVCodec h263_decoder;
 315 extern AVCodec mpeg4_decoder;
 316 extern AVCodec msmpeg4v1_decoder;
 317 extern AVCodec msmpeg4v2_decoder;
 318 extern AVCodec msmpeg4v3_decoder;
 319 extern AVCodec wmv1_decoder;
 320 extern AVCodec mpeg_decoder;
 321 extern AVCodec h263i_decoder;
 322 extern AVCodec rv10_decoder;
 323 extern AVCodec mjpeg_decoder;
 324 extern AVCodec mp2_decoder;
 325 extern AVCodec mp3_decoder;
 326
 327 /* pcm codecs */
 328 #define PCM_CODEC(id, name) \
 329 extern AVCodec name ## _decoder; \
 330 extern AVCodec name ## _encoder;
 331
 332 PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
 333 PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
 334 PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
 335 PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
 336 PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
 337 PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
 338 PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
 339 PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
 340
 341 #undef PCM_CODEC
 342
 343 /* dummy raw video codec */
 344 extern AVCodec rawvideo_codec;
 345
 346 /* the following codecs use external GPL libs */
 347 extern AVCodec ac3_decoder;
 348
 349 /* resample.c */
 350
 351 struct ReSampleContext;
 352
 353 typedef struct ReSampleContext ReSampleContext;
 354
 355 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
 356                                      int output_rate, int input_rate);
 357 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
 358 void audio_resample_close(ReSampleContext *s);
 359
 360 /* YUV420 format is assumed ! */
 361
 362 struct ImgReSampleContext;
 363
 364 typedef struct ImgReSampleContext ImgReSampleContext;
 365
 366 ImgReSampleContext *img_resample_init(int output_width, int output_height,
 367                                       int input_width, int input_height);
 368 void img_resample(ImgReSampleContext *s,
 369                   AVPicture *output, AVPicture *input);
 370
 371 void img_resample_close(ImgReSampleContext *s);
 372
 373 void avpicture_fill(AVPicture *picture, UINT8 *ptr,
 374                     int pix_fmt, int width, int height);
 375 int avpicture_get_size(int pix_fmt, int width, int height);
 376
 377 /* convert among pixel formats */
 378 int img_convert(AVPicture *dst, int dst_pix_fmt,
 379                 AVPicture *src, int pix_fmt,
 380                 int width, int height);
 381
 382 /* deinterlace a picture */
 383 int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
 384                           int pix_fmt, int width, int height);
 385
 386 /* external high level API */
 387
 388 extern AVCodec *first_avcodec;
 389
 390 /* returns LIBAVCODEC_VERSION_INT constant */
 391 unsigned avcodec_version( void );
 392 void avcodec_init(void);
 393
 394 void register_avcodec(AVCodec *format);
 395 AVCodec *avcodec_find_encoder(enum CodecID id);
 396 AVCodec *avcodec_find_encoder_by_name(const char *name);
 397 AVCodec *avcodec_find_decoder(enum CodecID id);
 398 AVCodec *avcodec_find_decoder_by_name(const char *name);
 399 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
 400
 401 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
 402 int avcodec_decode_audio(AVCodecContext *avctx, INT16 *samples,
 403                          int *frame_size_ptr,
 404                          UINT8 *buf, int buf_size);
 405 int avcodec_decode_video(AVCodecContext *avctx, AVPicture *picture,
 406                          int *got_picture_ptr,
 407                          UINT8 *buf, int buf_size);
 408 int avcodec_encode_audio(AVCodecContext *avctx, UINT8 *buf, int buf_size,
 409                          const short *samples);
 410 int avcodec_encode_video(AVCodecContext *avctx, UINT8 *buf, int buf_size,
 411                          const AVPicture *pict);
 412
 413 int avcodec_close(AVCodecContext *avctx);
 414
 415 void avcodec_register_all(void);
 416
 417 void avcodec_flush_buffers(AVCodecContext *avctx);
 418
 419 #ifdef FF_POSTPROCESS
 420 #ifndef MBC
 421 #define MBC 128
 422 #define MBR 96
 423 #endif
 424 extern int quant_store[MBR+1][MBC+1]; // [Review]
 425 #endif
 426
 427 #endif /* AVCODEC_H */