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       4613
   9 #define LIBAVCODEC_BUILD_STR   "4613"
  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 #ifndef MBC
 244 #define MBC 128
 245 #define MBR 96
 246 #endif
 247     int *quant_store; /* field for communicating with external postprocessing */
 248     unsigned qstride;
 249     //FIXME this should be reordered after kabis API is finished ...
 250     /*
 251         Note: Below are located reserved fields for further usage
 252         It requires for ABI !!!
 253         If you'll perform some changes then borrow new space from these fields
 254         (void * can be safety replaced with struct * ;)
 255         P L E A S E ! ! !
 256         IMPORTANT: Never change order of already declared fields!!!
 257     */
 258     unsigned long long int
 259             ull_res0,ull_res1,ull_res2,ull_res3,ull_res4,ull_res5,
 260             ull_res6,ull_res7,ull_res8,ull_res9,ull_res10,ull_res11,ull_res12;
 261     float
 262             flt_res0,flt_res1,flt_res2,flt_res3,flt_res4,flt_res5,
 263             flt_res6,flt_res7,flt_res8,flt_res9,flt_res10,flt_res11;
 264     void
 265             *ptr_res0,*ptr_res1,*ptr_res2,*ptr_res3,*ptr_res4,*ptr_res5,
 266             *ptr_res6,*ptr_res7,*ptr_res8,*ptr_res9,*ptr_res10,*ptr_res11;
 267     unsigned long int
 268             ul_res0,ul_res1,ul_res2,ul_res3,ul_res4,ul_res5,
 269             ul_res6,ul_res7,ul_res8,ul_res9,ul_res10,ul_res11,ul_res12;
 270     unsigned int
 271             ui_res0,ui_res1,ui_res2,ui_res3,ui_res4,ui_res5,
 272             ui_res6;
 273     unsigned short int
 274             us_res0,us_res1,us_res2,us_res3,us_res4,us_res5,
 275             us_res6,us_res7,us_res8,us_res9,us_res10,us_res11,us_res12;
 276     unsigned char
 277             uc_res0,uc_res1,uc_res2,uc_res3,uc_res4,uc_res5,
 278             uc_res6,uc_res7,uc_res8,uc_res9,uc_res10,uc_res11,uc_res12;
 279 } AVCodecContext;
 280
 281 typedef struct AVCodec {
 282     char *name;
 283     int type;
 284     int id;
 285     int priv_data_size;
 286     int (*init)(AVCodecContext *);
 287     int (*encode)(AVCodecContext *, UINT8 *buf, int buf_size, void *data);
 288     int (*close)(AVCodecContext *);
 289     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
 290                   UINT8 *buf, int buf_size);
 291     int capabilities;
 292     struct AVCodec *next;
 293     /*
 294         Note: Below are located reserved fields for further usage
 295         It requires for ABI !!!
 296         If you'll perform some changes then borrow new space from these fields
 297         (void * can be safety replaced with struct * ;)
 298         P L E A S E ! ! !
 299         IMPORTANT: Never change order of already declared fields!!!
 300     */
 301     unsigned long long int
 302             ull_res0,ull_res1,ull_res2,ull_res3,ull_res4,ull_res5,
 303             ull_res6,ull_res7,ull_res8,ull_res9,ull_res10,ull_res11,ull_res12;
 304     float
 305             flt_res0,flt_res1,flt_res2,flt_res3,flt_res4,flt_res5,
 306             flt_res6,flt_res7,flt_res8,flt_res9,flt_res10,flt_res11,flt_res12;
 307     void
 308             *ptr_res0,*ptr_res1,*ptr_res2,*ptr_res3,*ptr_res4,*ptr_res5,
 309             *ptr_res6,*ptr_res7,*ptr_res8,*ptr_res9,*ptr_res10,*ptr_res11,*ptr_res12;
 310 } AVCodec;
 311
 312 /* three components are given, that's all */
 313 typedef struct AVPicture {
 314     UINT8 *data[3];
 315     int linesize[3];
 316 } AVPicture;
 317
 318 extern AVCodec ac3_encoder;
 319 extern AVCodec mp2_encoder;
 320 extern AVCodec mp3lame_encoder;
 321 extern AVCodec mpeg1video_encoder;
 322 extern AVCodec h263_encoder;
 323 extern AVCodec h263p_encoder;
 324 extern AVCodec rv10_encoder;
 325 extern AVCodec mjpeg_encoder;
 326 extern AVCodec mpeg4_encoder;
 327 extern AVCodec msmpeg4v1_encoder;
 328 extern AVCodec msmpeg4v2_encoder;
 329 extern AVCodec msmpeg4v3_encoder;
 330
 331 extern AVCodec h263_decoder;
 332 extern AVCodec mpeg4_decoder;
 333 extern AVCodec msmpeg4v1_decoder;
 334 extern AVCodec msmpeg4v2_decoder;
 335 extern AVCodec msmpeg4v3_decoder;
 336 extern AVCodec wmv1_decoder;
 337 extern AVCodec mpeg_decoder;
 338 extern AVCodec h263i_decoder;
 339 extern AVCodec rv10_decoder;
 340 extern AVCodec mjpeg_decoder;
 341 extern AVCodec mp2_decoder;
 342 extern AVCodec mp3_decoder;
 343
 344 /* pcm codecs */
 345 #define PCM_CODEC(id, name) \
 346 extern AVCodec name ## _decoder; \
 347 extern AVCodec name ## _encoder;
 348
 349 PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
 350 PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
 351 PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
 352 PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
 353 PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
 354 PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
 355 PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
 356 PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
 357
 358 #undef PCM_CODEC
 359
 360 /* dummy raw video codec */
 361 extern AVCodec rawvideo_codec;
 362
 363 /* the following codecs use external GPL libs */
 364 extern AVCodec ac3_decoder;
 365
 366 /* resample.c */
 367
 368 struct ReSampleContext;
 369
 370 typedef struct ReSampleContext ReSampleContext;
 371
 372 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
 373                                      int output_rate, int input_rate);
 374 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
 375 void audio_resample_close(ReSampleContext *s);
 376
 377 /* YUV420 format is assumed ! */
 378
 379 struct ImgReSampleContext;
 380
 381 typedef struct ImgReSampleContext ImgReSampleContext;
 382
 383 ImgReSampleContext *img_resample_init(int output_width, int output_height,
 384                                       int input_width, int input_height);
 385 void img_resample(ImgReSampleContext *s,
 386                   AVPicture *output, AVPicture *input);
 387
 388 void img_resample_close(ImgReSampleContext *s);
 389
 390 void avpicture_fill(AVPicture *picture, UINT8 *ptr,
 391                     int pix_fmt, int width, int height);
 392 int avpicture_get_size(int pix_fmt, int width, int height);
 393
 394 /* convert among pixel formats */
 395 int img_convert(AVPicture *dst, int dst_pix_fmt,
 396                 AVPicture *src, int pix_fmt,
 397                 int width, int height);
 398
 399 /* deinterlace a picture */
 400 int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
 401                           int pix_fmt, int width, int height);
 402
 403 /* external high level API */
 404
 405 extern AVCodec *first_avcodec;
 406
 407 /* returns LIBAVCODEC_VERSION_INT constant */
 408 unsigned avcodec_version(void);
 409 /* returns LIBAVCODEC_BUILD constant */
 410 unsigned avcodec_build(void);
 411 void avcodec_init(void);
 412
 413 void avcodec_set_bit_exact(void);
 414
 415 void register_avcodec(AVCodec *format);
 416 AVCodec *avcodec_find_encoder(enum CodecID id);
 417 AVCodec *avcodec_find_encoder_by_name(const char *name);
 418 AVCodec *avcodec_find_decoder(enum CodecID id);
 419 AVCodec *avcodec_find_decoder_by_name(const char *name);
 420 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
 421
 422 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
 423 int avcodec_decode_audio(AVCodecContext *avctx, INT16 *samples,
 424                          int *frame_size_ptr,
 425                          UINT8 *buf, int buf_size);
 426 int avcodec_decode_video(AVCodecContext *avctx, AVPicture *picture,
 427                          int *got_picture_ptr,
 428                          UINT8 *buf, int buf_size);
 429 int avcodec_encode_audio(AVCodecContext *avctx, UINT8 *buf, int buf_size,
 430                          const short *samples);
 431 int avcodec_encode_video(AVCodecContext *avctx, UINT8 *buf, int buf_size,
 432                          const AVPicture *pict);
 433
 434 int avcodec_close(AVCodecContext *avctx);
 435
 436 void avcodec_register_all(void);
 437
 438 void avcodec_flush_buffers(AVCodecContext *avctx);
 439
 440 #ifdef FF_POSTPROCESS
 441 extern int quant_store[MBR+1][MBC+1]; // [Review]
 442 #endif
 443
 444
 445 /**
 446  * Interface for 0.5.0 version
 447  *
 448  * do not even think about it's usage for this moment
 449  */
 450
 451 typedef struct {
 452     // compressed size used from given memory buffer
 453     int size;
 454     /// I/P/B frame type
 455     int frame_type;
 456 } avc_enc_result_t;
 457
 458 /**
 459  * Commands
 460  * order can't be changed - once it was defined
 461  */
 462 typedef enum {
 463     // general commands
 464     AVC_OPEN_BY_NAME = 0xACA000,
 465     AVC_OPEN_BY_CODEC_ID,
 466     AVC_OPEN_BY_FOURCC,
 467     AVC_CLOSE,
 468
 469     AVC_FLUSH,
 470     // pin - struct { uint8_t* src, uint_t src_size }
 471     // pout - struct { AVPicture* img, consumed_bytes,
 472     AVC_DECODE,
 473     // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
 474     // pout - uint_t used_from_dest_size
 475     AVC_ENCODE,
 476
 477     // query/get video commands
 478     AVC_GET_VERSION = 0xACB000,
 479     AVC_GET_WIDTH,
 480     AVC_GET_HEIGHT,
 481     AVC_GET_DELAY,
 482     AVC_GET_QUANT_TABLE,
 483     // ...
 484
 485     // query/get audio commands
 486     AVC_GET_FRAME_SIZE = 0xABC000,
 487
 488     // maybe define some simple structure which
 489     // might be passed to the user - but they can't
 490     // contain any codec specific parts and these
 491     // calls are usualy necessary only few times
 492
 493     // set video commands
 494     AVC_SET_WIDTH = 0xACD000,
 495     AVC_SET_HEIGHT,
 496
 497     // set video encoding commands
 498     AVC_SET_FRAME_RATE = 0xACD800,
 499     AVC_SET_QUALITY,
 500     AVC_SET_HURRY_UP,
 501
 502     // set audio commands
 503     AVC_SET_SAMPLE_RATE = 0xACE000,
 504     AVC_SET_CHANNELS,
 505
 506 } avc_cmd_t;
 507
 508 /**
 509  * \param handle  allocated private structure by libavcodec
 510  *                for initialization pass NULL - will be returned pout
 511  *                user is supposed to know nothing about its structure
 512  * \param cmd     type of operation to be performed
 513  * \param pint    input parameter
 514  * \param pout    output parameter
 515  *
 516  * \returns  command status - eventually for query command it might return
 517  * integer resulting value
 518  */
 519 int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);
 520
 521 #endif /* AVCODEC_H */