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       4605
   9 #define LIBAVCODEC_BUILD_STR   "4605"
  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_VIDEO,
  43     CODEC_TYPE_AUDIO,
  44 };
  45
  46 enum PixelFormat {
  47     PIX_FMT_ANY = -1,
  48     PIX_FMT_YUV420P,
  49     PIX_FMT_YUV422,
  50     PIX_FMT_RGB24,
  51     PIX_FMT_BGR24,
  52     PIX_FMT_YUV422P,
  53     PIX_FMT_YUV444P,
  54 };
  55
  56 /* currently unused, may be used if 24/32 bits samples ever supported */
  57 enum SampleFormat {
  58     SAMPLE_FMT_S16 = 0,         /* signed 16 bits */
  59 };
  60
  61 /* in bytes */
  62 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 18432
  63
  64 /* motion estimation type, EPZS by default */
  65 enum Motion_Est_ID {
  66     ME_ZERO = 1,
  67     ME_FULL,
  68     ME_LOG,
  69     ME_PHODS,
  70     ME_EPZS,
  71     ME_X1
  72 };
  73
  74 /* only for ME compatiblity with old apps */
  75 extern int motion_estimation_method;
  76
  77 /* ME algos sorted by quality */
  78 static const int Motion_Est_QTab[] = { 1, 4, 3, 6, 5, 2 };
  79
  80 #define FF_MAX_B_FRAMES 4
  81
  82 /* encoding support */
  83 /* note not everything is supported yet */
  84
  85 #define CODEC_FLAG_HQ     0x0001 /* high quality (non real time) encoding */
  86 #define CODEC_FLAG_QSCALE 0x0002 /* use fixed qscale */
  87 #define CODEC_FLAG_4MV    0x0004 /* 4 MV per MB allowed */
  88 #define CODEC_FLAG_QPEL   0x0010 /* use qpel MC */
  89 #define CODEC_FLAG_GMC    0x0020 /* use GMC */
  90 #define CODEC_FLAG_TYPE   0x0040 /* fixed I/P frame type, from avctx->key_frame */
  91 /* parent program gurantees that the input for b-frame containing streams is not written to
  92    for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
  93 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
  94 #define CODEC_FLAG_PASS1 0x0200  /* use internal 2pass ratecontrol in first  pass mode */
  95 #define CODEC_FLAG_PASS2 0x0400  /* use internal 2pass ratecontrol in second pass mode */
  96 #define CODEC_FLAG_EXTERN_HUFF 0x1000 /* use external huffman table (for mjpeg) */
  97
  98 /* codec capabilities */
  99
 100 /* decoder can use draw_horiz_band callback */
 101 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001
 102
 103 #define FRAME_RATE_BASE 10000
 104
 105 typedef struct AVCodecContext {
 106     int bit_rate;
 107     int bit_rate_tolerance; /* amount of +- bits (>0)*/
 108     int flags;
 109     int sub_id;    /* some codecs needs additionnal format info. It is
 110                       stored there */
 111
 112     int me_method; /* ME algorithm used for video coding */
 113
 114     /* extra data from parent application to codec, e.g. huffman table
 115        for mjpeg */
 116     /* the parent should allocate and free this buffer */
 117     void *extradata;
 118     int extradata_size;
 119
 120     /* video only */
 121     int frame_rate; /* frames per sec multiplied by FRAME_RATE_BASE */
 122     int width, height;
 123     int aspect_ratio_info;
 124 #define FF_ASPECT_SQUARE 1
 125 #define FF_ASPECT_4_3_625 2
 126 #define FF_ASPECT_4_3_525 3
 127 #define FF_ASPECT_16_9_625 4
 128 #define FF_ASPECT_16_9_525 5
 129     int gop_size; /* 0 = intra only */
 130     enum PixelFormat pix_fmt;  /* pixel format, see PIX_FMT_xxx */
 131
 132     /* if non NULL, 'draw_horiz_band' is called by the libavcodec
 133        decoder to draw an horizontal band. It improve cache usage. Not
 134        all codecs can do that. You must check the codec capabilities
 135        before */
 136     void (*draw_horiz_band)(struct AVCodecContext *s,
 137                             UINT8 **src_ptr, int linesize,
 138                             int y, int width, int height);
 139
 140     /* audio only */
 141     int sample_rate; /* samples per sec */
 142     int channels;
 143     int sample_fmt;  /* sample format, currenly unused */
 144
 145     /* the following data should not be initialized */
 146     int frame_size; /* in samples, initialized when calling 'init' */
 147     int frame_number; /* audio or video frame number */
 148     int key_frame;    /* true if the previous compressed frame was
 149                          a key frame (intra, or seekable) */
 150     int delay;        /* number of frames the decoded output will be delayed relative to the encoded input */
 151     uint8_t *mbskip_table; /* =1 if MB didnt change, is only valid for I/P frames
 152                               stride= mb_width = (width+15)>>4 */
 153
 154     /* encoding parameters */
 155     int quality;      /* quality of the previous encoded frame
 156                          (between 1 (good) and 31 (bad))
 157                          this is allso used to set the quality in vbr mode
 158                          and the per frame quality in CODEC_FLAG_TYPE (second pass mode) */
 159     float qcompress;  /* amount of qscale change between easy & hard scenes (0.0-1.0)*/
 160     float qblur;      /* amount of qscale smoothing over time (0.0-1.0) */
 161     int qmin;         /* min qscale */
 162     int qmax;         /* max qscale */
 163     int max_qdiff;    /* max qscale difference between frames */
 164     int max_b_frames; /* maximum b frames, the output will be delayed by max_b_frames+1 relative to the input */
 165     float b_quant_factor;/* qscale factor between ips and b frames */
 166     int rc_strategy;
 167     int b_frame_strategy;
 168
 169     int hurry_up;     /* when set to 1 during decoding, b frames will be skiped
 170                          when set to 2 idct/dequant will be skipped too */
 171
 172     struct AVCodec *codec;
 173     void *priv_data;
 174
 175     /* The following data is for RTP friendly coding */
 176     /* By now only H.263/H.263+ coder honours this   */
 177     int rtp_mode;   /* 1 for activate RTP friendly-mode           */
 178                     /* highers numbers represent more error-prone */
 179                     /* enviroments, by now just "1" exist         */
 180
 181     int rtp_payload_size;   /* The size of the RTP payload, the coder will  */
 182                             /* do it's best to deliver a chunk with size    */
 183                             /* below rtp_payload_size, the chunk will start */
 184                             /* with a start code on some codecs like H.263  */
 185                             /* This doesn't take account of any particular  */
 186                             /* headers inside the transmited RTP payload    */
 187
 188
 189     /* The RTP callcack: This function is called  */
 190     /* every time the encoder as a packet to send */
 191     /* Depends on the encoder if the data starts  */
 192     /* with a Start Code (it should) H.263 does   */
 193     void (*rtp_callback)(void *data, int size, int packet_number);
 194
 195     /* These are for PSNR calculation, if you set get_psnr to 1 */
 196     /* after encoding you will have the PSNR on psnr_y/cb/cr    */
 197     int get_psnr;
 198     float psnr_y;
 199     float psnr_cb;
 200     float psnr_cr;
 201
 202     /* statistics, used for 2-pass encoding */
 203     int mv_bits;
 204     int header_bits;
 205     int i_tex_bits;
 206     int p_tex_bits;
 207     int i_count;
 208     int p_count;
 209     int skip_count;
 210     int misc_bits; // cbp, mb_type
 211     int frame_bits;
 212
 213     /* the following fields are ignored */
 214     void *opaque;   /* can be used to carry app specific stuff */
 215     char codec_name[32];
 216     int codec_type; /* see CODEC_TYPE_xxx */
 217     int codec_id; /* see CODEC_ID_xxx */
 218     unsigned int codec_tag;  /* codec tag, only used if unknown codec */
 219 } AVCodecContext;
 220
 221 typedef struct AVCodec {
 222     char *name;
 223     int type;
 224     int id;
 225     int priv_data_size;
 226     int (*init)(AVCodecContext *);
 227     int (*encode)(AVCodecContext *, UINT8 *buf, int buf_size, void *data);
 228     int (*close)(AVCodecContext *);
 229     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
 230                   UINT8 *buf, int buf_size);
 231     int capabilities;
 232     struct AVCodec *next;
 233 } AVCodec;
 234
 235 /* three components are given, that's all */
 236 typedef struct AVPicture {
 237     UINT8 *data[3];
 238     int linesize[3];
 239 } AVPicture;
 240
 241 extern AVCodec ac3_encoder;
 242 extern AVCodec mp2_encoder;
 243 extern AVCodec mp3lame_encoder;
 244 extern AVCodec mpeg1video_encoder;
 245 extern AVCodec h263_encoder;
 246 extern AVCodec h263p_encoder;
 247 extern AVCodec rv10_encoder;
 248 extern AVCodec mjpeg_encoder;
 249 extern AVCodec mpeg4_encoder;
 250 extern AVCodec msmpeg4v1_encoder;
 251 extern AVCodec msmpeg4v2_encoder;
 252 extern AVCodec msmpeg4v3_encoder;
 253
 254 extern AVCodec h263_decoder;
 255 extern AVCodec mpeg4_decoder;
 256 extern AVCodec msmpeg4v1_decoder;
 257 extern AVCodec msmpeg4v2_decoder;
 258 extern AVCodec msmpeg4v3_decoder;
 259 extern AVCodec wmv1_decoder;
 260 extern AVCodec mpeg_decoder;
 261 extern AVCodec h263i_decoder;
 262 extern AVCodec rv10_decoder;
 263 extern AVCodec mjpeg_decoder;
 264 extern AVCodec mp2_decoder;
 265 extern AVCodec mp3_decoder;
 266
 267 /* pcm codecs */
 268 #define PCM_CODEC(id, name) \
 269 extern AVCodec name ## _decoder; \
 270 extern AVCodec name ## _encoder;
 271
 272 PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
 273 PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
 274 PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
 275 PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
 276 PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
 277 PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
 278 PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
 279 PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
 280
 281 #undef PCM_CODEC
 282
 283 /* dummy raw video codec */
 284 extern AVCodec rawvideo_codec;
 285
 286 /* the following codecs use external GPL libs */
 287 extern AVCodec ac3_decoder;
 288
 289 /* resample.c */
 290
 291 struct ReSampleContext;
 292
 293 typedef struct ReSampleContext ReSampleContext;
 294
 295 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
 296                                      int output_rate, int input_rate);
 297 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
 298 void audio_resample_close(ReSampleContext *s);
 299
 300 /* YUV420 format is assumed ! */
 301
 302 struct ImgReSampleContext;
 303
 304 typedef struct ImgReSampleContext ImgReSampleContext;
 305
 306 ImgReSampleContext *img_resample_init(int output_width, int output_height,
 307                                       int input_width, int input_height);
 308 void img_resample(ImgReSampleContext *s,
 309                   AVPicture *output, AVPicture *input);
 310
 311 void img_resample_close(ImgReSampleContext *s);
 312
 313 void avpicture_fill(AVPicture *picture, UINT8 *ptr,
 314                     int pix_fmt, int width, int height);
 315 int avpicture_get_size(int pix_fmt, int width, int height);
 316
 317 /* convert among pixel formats */
 318 int img_convert(AVPicture *dst, int dst_pix_fmt,
 319                 AVPicture *src, int pix_fmt,
 320                 int width, int height);
 321
 322 /* deinterlace a picture */
 323 int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
 324                           int pix_fmt, int width, int height);
 325
 326 /* external high level API */
 327
 328 extern AVCodec *first_avcodec;
 329
 330 void avcodec_init(void);
 331
 332 void register_avcodec(AVCodec *format);
 333 AVCodec *avcodec_find_encoder(enum CodecID id);
 334 AVCodec *avcodec_find_encoder_by_name(const char *name);
 335 AVCodec *avcodec_find_decoder(enum CodecID id);
 336 AVCodec *avcodec_find_decoder_by_name(const char *name);
 337 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
 338
 339 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
 340 int avcodec_decode_audio(AVCodecContext *avctx, INT16 *samples,
 341                          int *frame_size_ptr,
 342                          UINT8 *buf, int buf_size);
 343 int avcodec_decode_video(AVCodecContext *avctx, AVPicture *picture,
 344                          int *got_picture_ptr,
 345                          UINT8 *buf, int buf_size);
 346 int avcodec_encode_audio(AVCodecContext *avctx, UINT8 *buf, int buf_size,
 347                          const short *samples);
 348 int avcodec_encode_video(AVCodecContext *avctx, UINT8 *buf, int buf_size,
 349                          const AVPicture *pict);
 350
 351 int avcodec_close(AVCodecContext *avctx);
 352
 353 void avcodec_register_all(void);
 354
 355 void avcodec_flush_buffers(AVCodecContext *avctx);
 356
 357 #ifdef FF_POSTPROCESS
 358 #ifndef MBC
 359 #define MBC 128
 360 #define MBR 96
 361 #endif
 362 extern int quant_store[MBR+1][MBC+1]; // [Review]
 363 #endif
 364
 365 #endif /* AVCODEC_H */