avcodec.h 30.3 KB
Newer Older
Fabrice Bellard's avatar
Fabrice Bellard committed
1 2 3
#ifndef AVCODEC_H
#define AVCODEC_H

Fabrice Bellard's avatar
Fabrice Bellard committed
4 5
#include "common.h"

6 7
#define LIBAVCODEC_VERSION_INT 0x000406
#define LIBAVCODEC_VERSION     "0.4.6"
8 9
#define LIBAVCODEC_BUILD       4642
#define LIBAVCODEC_BUILD_STR   "4642"
10

Fabrice Bellard's avatar
Fabrice Bellard committed
11 12 13 14 15 16
enum CodecID {
    CODEC_ID_NONE, 
    CODEC_ID_MPEG1VIDEO,
    CODEC_ID_H263,
    CODEC_ID_RV10,
    CODEC_ID_MP2,
17
    CODEC_ID_MP3LAME,
18
    CODEC_ID_VORBIS,
Fabrice Bellard's avatar
Fabrice Bellard committed
19 20
    CODEC_ID_AC3,
    CODEC_ID_MJPEG,
21
    CODEC_ID_MJPEGB,
Fabrice Bellard's avatar
Fabrice Bellard committed
22
    CODEC_ID_MPEG4,
Fabrice Bellard's avatar
Fabrice Bellard committed
23
    CODEC_ID_RAWVIDEO,
24 25 26
    CODEC_ID_MSMPEG4V1,
    CODEC_ID_MSMPEG4V2,
    CODEC_ID_MSMPEG4V3,
27
    CODEC_ID_WMV1,
Michael Niedermayer's avatar
Michael Niedermayer committed
28
    CODEC_ID_WMV2,
Fabrice Bellard's avatar
Fabrice Bellard committed
29 30
    CODEC_ID_H263P,
    CODEC_ID_H263I,
Nick Kurshev's avatar
Nick Kurshev committed
31
    CODEC_ID_SVQ1,
Fabrice Bellard's avatar
Fabrice Bellard committed
32 33
    CODEC_ID_DVVIDEO,
    CODEC_ID_DVAUDIO,
Fabrice Bellard's avatar
Fabrice Bellard committed
34 35
    CODEC_ID_WMAV1,
    CODEC_ID_WMAV2,
36 37
    CODEC_ID_MACE3,
    CODEC_ID_MACE6,
Michael Niedermayer's avatar
huffyuv  
Michael Niedermayer committed
38
    CODEC_ID_HUFFYUV,
Fabrice Bellard's avatar
Fabrice Bellard committed
39 40 41 42 43 44 45 46 47 48

    /* various pcm "codecs" */
    CODEC_ID_PCM_S16LE,
    CODEC_ID_PCM_S16BE,
    CODEC_ID_PCM_U16LE,
    CODEC_ID_PCM_U16BE,
    CODEC_ID_PCM_S8,
    CODEC_ID_PCM_U8,
    CODEC_ID_PCM_MULAW,
    CODEC_ID_PCM_ALAW,
49 50 51 52 53

    /* various adpcm codecs */
    CODEC_ID_ADPCM_IMA_QT,
    CODEC_ID_ADPCM_IMA_WAV,
    CODEC_ID_ADPCM_MS,
Fabrice Bellard's avatar
Fabrice Bellard committed
54 55 56
};

enum CodecType {
57
    CODEC_TYPE_UNKNOWN = -1,
Fabrice Bellard's avatar
Fabrice Bellard committed
58 59 60 61 62
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
};

enum PixelFormat {
63
    PIX_FMT_ANY = -1,
Fabrice Bellard's avatar
Fabrice Bellard committed
64 65 66 67
    PIX_FMT_YUV420P,
    PIX_FMT_YUV422,
    PIX_FMT_RGB24,
    PIX_FMT_BGR24,
68 69
    PIX_FMT_YUV422P,
    PIX_FMT_YUV444P,
70 71
    PIX_FMT_RGBA32,
    PIX_FMT_BGRA32,
Arpi's avatar
Arpi committed
72
    PIX_FMT_YUV410P,
73 74 75 76 77 78 79 80
    PIX_FMT_YUV411P,
    PIX_FMT_RGB565,
    PIX_FMT_RGB555,
//    PIX_FMT_RGB5551,
    PIX_FMT_BGR565,
    PIX_FMT_BGR555,
//    PIX_FMT_GBR565,
//    PIX_FMT_GBR555
Fabrice Bellard's avatar
Fabrice Bellard committed
81 82
};

Fabrice Bellard's avatar
Fabrice Bellard committed
83 84 85 86 87
/* currently unused, may be used if 24/32 bits samples ever supported */
enum SampleFormat {
    SAMPLE_FMT_S16 = 0,         /* signed 16 bits */
};

Fabrice Bellard's avatar
Fabrice Bellard committed
88
/* in bytes */
Fabrice Bellard's avatar
Fabrice Bellard committed
89
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
Fabrice Bellard's avatar
Fabrice Bellard committed
90

91 92 93 94 95 96
/**
 * Required number of zero bytes at the end of the input bitstream for decoding.
 * to avoid overreading (and possibly segfaulting)
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

97 98
/* motion estimation type, EPZS by default */
enum Motion_Est_ID {
99
    ME_ZERO = 1,
100 101 102 103 104 105 106
    ME_FULL,
    ME_LOG,
    ME_PHODS,
    ME_EPZS,
    ME_X1
};

Michael Niedermayer's avatar
Michael Niedermayer committed
107 108 109 110 111 112 113
typedef struct RcOverride{
    int start_frame;
    int end_frame;
    int qscale; // if this is 0 then quality_factor will be used instead
    float quality_factor;
} RcOverride;

114 115 116
/* only for ME compatiblity with old apps */
extern int motion_estimation_method;

117
/* ME algos sorted by quality */
118 119
static const int Motion_Est_QTab[] = { ME_ZERO, ME_PHODS, ME_LOG, 
                                       ME_X1, ME_EPZS, ME_FULL };
Fabrice Bellard's avatar
Fabrice Bellard committed
120

121

122 123
#define FF_MAX_B_FRAMES 4

Michael Niedermayer's avatar
Michael Niedermayer committed
124 125 126 127
/* encoding support
   these flags can be passed in AVCodecContext.flags before initing 
   Note: note not everything is supported yet 
*/
Fabrice Bellard's avatar
Fabrice Bellard committed
128

129 130 131 132 133 134
#define CODEC_FLAG_HQ     0x0001  /* brute force MB-type decission mode (slow) */
#define CODEC_FLAG_QSCALE 0x0002  /* use fixed qscale */
#define CODEC_FLAG_4MV    0x0004  /* 4 MV per MB allowed */
#define CODEC_FLAG_QPEL   0x0010  /* use qpel MC */
#define CODEC_FLAG_GMC    0x0020  /* use GMC */
#define CODEC_FLAG_PART   0x0080  /* use data partitioning */
135 136
/* parent program gurantees that the input for b-frame containing streams is not written to 
   for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
137
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
138 139
#define CODEC_FLAG_PASS1 0x0200   /* use internal 2pass ratecontrol in first  pass mode */
#define CODEC_FLAG_PASS2 0x0400   /* use internal 2pass ratecontrol in second pass mode */
140
#define CODEC_FLAG_EXTERN_HUFF 0x1000 /* use external huffman table (for mjpeg) */
141
#define CODEC_FLAG_GRAY  0x2000   /* only decode/encode grayscale */
142
#define CODEC_FLAG_EMU_EDGE 0x4000/* dont draw edges */
143 144
#define CODEC_FLAG_TRUNCATED  0x00010000 /* input bitstream might be truncated at a random location instead 
                                            of only at frame boundaries */
145
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 /* normalize adaptive quantization */
146
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 /* use interlaced dct */
147
#define CODEC_FLAG_LOW_DELAY      0x00080000 /* force low delay / will fail on b frames */
Michael Niedermayer's avatar
Michael Niedermayer committed
148
#define CODEC_FLAG_ALT_SCAN       0x00100000 /* use alternate scan */
149

Fabrice Bellard's avatar
Fabrice Bellard committed
150 151
/* codec capabilities */

152
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 /* decoder can use draw_horiz_band callback */
153
#define CODEC_CAP_DR1             0x0002 /* direct rendering method 1 */
154 155 156
/* if 'parse_only' field is true, then avcodec_parse_frame() can be
   used */
#define CODEC_CAP_PARSE_ONLY      0x0004
157
#define CODEC_CAP_TRUNCATED       0x0008
Fabrice Bellard's avatar
Fabrice Bellard committed
158

Fabrice Bellard's avatar
Fabrice Bellard committed
159 160
#define FRAME_RATE_BASE 10000

Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
#define FF_COMMON_PICTURE \
    uint8_t *data[4];\
    int linesize[4];\
    /**\
     * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer
     * this isnt used by lavc unless the default get/release_buffer() is used\
     * encoding: \
     * decoding: \
     */\
    uint8_t *base[4];\
    /**\
     * 1 -> keyframe, 0-> not\
     * encoding: set by lavc\
     * decoding: set by lavc\
     */\
    int key_frame;\
\
    /**\
     * picture type of the frame, see ?_TYPE below\
     * encoding: set by lavc for coded_picture (and set by user for input)\
     * decoding: set by lavc\
     */\
    int pict_type;\
\
    /**\
     * presentation timestamp in micro seconds (time when frame should be shown to user)\
     * if 0 then the frame_rate will be used as reference\
     * encoding: MUST be set by user\
     * decoding: set by lavc\
     */\
    long long int pts;\
\
    /**\
     * picture number in bitstream order.\
     * encoding: set by\
     * decoding: set by lavc\
     */\
    int coded_picture_number;\
    /**\
     * encoding: set by\
     * decoding: set by lavc\
     * picture number in display order.\
     */\
    int display_picture_number;\
\
    /**\
     * quality (between 1 (good) and 31 (bad)) \
     * encoding: set by lavc for coded_picture (and set by user for input)\
     * decoding: set by lavc\
     */\
    float quality; \
\
    /**\
     * buffer age (1->was last buffer and dint change, 2->..., ...).\
     * set to something large if the buffer has not been used yet \
     * encoding: unused\
     * decoding: MUST be set by get_buffer()\
     */\
    int age;\
\
    /**\
     * is this picture used as reference\
     * encoding: unused\
     * decoding: set by lavc (before get_buffer() call))\
     */\
    int reference;\
\
    /**\
     * QP table\
     * encoding: unused\
     * decoding: set by lavc\
     */\
    int8_t *qscale_table;\
    /**\
     * QP store stride\
     * encoding: unused\
     * decoding: set by lavc\
     */\
    int qstride;\
\
    /**\
     * mbskip_table[mb]>=1 if MB didnt change\
     * stride= mb_width = (width+15)>>4\
     * encoding: unused\
     * decoding: set by lavc\
     */\
    uint8_t *mbskip_table;\
\
    /**\
     * for some private data of the user\
     * encoding: unused\
     * decoding: set by user\
     */\
    void *opaque;\

/* FIXME: these should have FF_ */
#define I_TYPE 1 // Intra
#define P_TYPE 2 // Predicted
#define B_TYPE 3 // Bi-dir predicted
#define S_TYPE 4 // S(GMC)-VOP MPEG4

typedef struct AVVideoFrame {
    FF_COMMON_PICTURE
} AVVideoFrame;

Fabrice Bellard's avatar
Fabrice Bellard committed
266
typedef struct AVCodecContext {
267 268 269 270 271
    /**
     * the average bitrate
     * encoding: set by user. unused for constant quantizer encoding
     * decoding: set by lavc. 0 or some bitrate if this info is available in the stream 
     */
Fabrice Bellard's avatar
Fabrice Bellard committed
272
    int bit_rate;
273 274 275 276 277 278 279 280 281 282 283 284 285 286

    /**
     * number of bits the bitstream is allowed to diverge from the reference
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
     * encoding: set by user. unused for constant quantizer encoding
     * decoding: unused
     */
    int bit_rate_tolerance; 

    /**
     * CODEC_FLAG_*
     * encoding: set by user.
     * decoding: set by user.
     */
Fabrice Bellard's avatar
Fabrice Bellard committed
287
    int flags;
288 289 290 291 292 293 294 295 296 297

    /**
     * some codecs needs additionnal format info. It is stored here
     * encoding: set by user. 
     * decoding: set by lavc. (FIXME is this ok?)
     */
    int sub_id;

    /**
     * motion estimation algorithm used for video coding
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
298
     * encoding: MUST be set by user.
299 300 301 302 303 304 305 306
     * decoding: unused
     */
    int me_method;

    /**
     * some codecs need / can use extra-data like huffman tables
     * mjpeg: huffman tables
     * rv10: additional flags
307
     * mpeg4: global headers (they can be in the bitstream or here)
308 309
     * encoding: set/allocated/freed by lavc.
     * decoding: set/allocated/freed by user.
310
     */
311 312 313
    void *extradata;
    int extradata_size;
    
Fabrice Bellard's avatar
Fabrice Bellard committed
314
    /* video only */
315 316 317 318
    /**
     * frames per sec multiplied by FRAME_RATE_BASE
     * for variable fps this is the precission, so if the timestamps 
     * can be specified in msec precssion then this is 1000*FRAME_RATE_BASE
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
319
     * encoding: MUST be set by user
320 321 322 323 324
     * decoding: set by lavc. 0 or the frame_rate if available
     */
    int frame_rate;

    /**
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
325
     * encoding: MUST be set by user. 
326 327
     * decoding: set by user, some codecs might override / change it during playback
     */
Fabrice Bellard's avatar
Fabrice Bellard committed
328
    int width, height;
329
    
Michael Niedermayer's avatar
Michael Niedermayer committed
330 331 332 333 334
#define FF_ASPECT_SQUARE 1
#define FF_ASPECT_4_3_625 2
#define FF_ASPECT_4_3_525 3
#define FF_ASPECT_16_9_625 4
#define FF_ASPECT_16_9_525 5
335
#define FF_ASPECT_EXTENDED 15
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350

    /**
     * the number of pictures in a group of pitures, or 0 for intra_only
     * encoding: set by user.
     * decoding: unused
     */
    int gop_size;

    /**
     * pixel format, see PIX_FMT_xxx
     * encoding: unused
     * decoding: set by lavc.
     */
    enum PixelFormat pix_fmt;
    
351 352 353
    int repeat_pict; /* when decoding, this signal how much the picture */
                     /* must be delayed.                                */
                     /* extra_delay = (repeat_pict / 2) * (1/fps)       */
354 355 356 357 358 359 360 361 362
    
    /**
     * if non NULL, 'draw_horiz_band' is called by the libavcodec
     * decoder to draw an horizontal band. It improve cache usage. Not
     * all codecs can do that. You must check the codec capabilities
     * before
     * encoding: unused
     * decoding: set by user.
     */
Fabrice Bellard's avatar
Fabrice Bellard committed
363 364 365 366
    void (*draw_horiz_band)(struct AVCodecContext *s,
                            UINT8 **src_ptr, int linesize,
                            int y, int width, int height);

Fabrice Bellard's avatar
Fabrice Bellard committed
367 368 369
    /* audio only */
    int sample_rate; /* samples per sec */
    int channels;
Fabrice Bellard's avatar
Fabrice Bellard committed
370
    int sample_fmt;  /* sample format, currenly unused */
Fabrice Bellard's avatar
Fabrice Bellard committed
371 372

    /* the following data should not be initialized */
373 374 375 376
    int frame_size;     /* in samples, initialized when calling 'init' */
    int frame_number;   /* audio or video frame number */
    int real_pict_num;  /* returns the real picture number of
                           previous encoded frame */
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
377
    
378
    /**
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
379
     * 1 -> keyframe, 0-> not (this if for audio only, for video, AVVideoFrame.key_frame should be used)
380 381 382 383 384 385 386 387 388 389 390 391
     * encoding: set by lavc (for the outputed bitstream, not the input frame)
     * decoding: set by lavc (for the decoded  bitstream, not the displayed frame)
     */
    int key_frame;

    /**
     * number of frames the decoded output will be delayed relative to 
     * the encoded input
     * encoding: set by lavc.
     * decoding: unused
     */
    int delay;
Michael Niedermayer's avatar
Michael Niedermayer committed
392 393
    
    /* encoding parameters */
394 395
    float qcompress;  /* amount of qscale change between easy & hard scenes (0.0-1.0)*/
    float qblur;      /* amount of qscale smoothing over time (0.0-1.0) */
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
    
    /**
     * minimum quantizer
     * encoding: set by user.
     * decoding: unused
     */
    int qmin;

    /**
     * maximum quantizer
     * encoding: set by user.
     * decoding: unused
     */
    int qmax;

    /**
     * maximum quantizer difference etween frames
     * encoding: set by user.
     * decoding: unused
     */
    int max_qdiff;

    /**
     * maximum number of b frames between non b frames
     * note: the output will be delayed by max_b_frames+1 relative to the input
     * encoding: set by user.
     * decoding: unused
     */
    int max_b_frames;

    /**
     * qscale factor between ip and b frames
     * encoding: set by user.
     * decoding: unused
     */
    float b_quant_factor;
    
    /** obsolete FIXME remove */
    int rc_strategy;
435
    int b_frame_strategy;
436

437 438
    /**
     * encoding: unused
439
     * decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
440 441
     */
    int hurry_up;
442
    
Fabrice Bellard's avatar
Fabrice Bellard committed
443
    struct AVCodec *codec;
444
    
Fabrice Bellard's avatar
Fabrice Bellard committed
445 446
    void *priv_data;

447
    /* The following data is for RTP friendly coding */
448
    /* By now only H.263/H.263+/MPEG4 coder honours this   */
449 450 451 452 453 454 455 456 457 458
    int rtp_mode;   /* 1 for activate RTP friendly-mode           */
                    /* highers numbers represent more error-prone */
                    /* enviroments, by now just "1" exist         */
    
    int rtp_payload_size;   /* The size of the RTP payload, the coder will  */
                            /* do it's best to deliver a chunk with size    */
                            /* below rtp_payload_size, the chunk will start */
                            /* with a start code on some codecs like H.263  */
                            /* This doesn't take account of any particular  */
                            /* headers inside the transmited RTP payload    */
459 460 461 462 463 464 465 466

    
    /* The RTP callcack: This function is called  */
    /* every time the encoder as a packet to send */
    /* Depends on the encoder if the data starts  */
    /* with a Start Code (it should) H.263 does   */
    void (*rtp_callback)(void *data, int size, int packet_number); 

467 468 469 470 471 472
    /**
     * if you set get_psnr to 1 then after encoding you will have the 
     * PSNR on psnr_y/cb/cr
     * encoding: set by user (1-> on, 0-> off)
     * decoding: unused
     */
473 474 475 476
    int get_psnr;
    float psnr_y;
    float psnr_cb;
    float psnr_cr;
477 478 479 480 481 482 483 484 485
    
    /* statistics, used for 2-pass encoding */
    int mv_bits;
    int header_bits;
    int i_tex_bits;
    int p_tex_bits;
    int i_count;
    int p_count;
    int skip_count;
486 487 488 489 490
    int misc_bits;
    
    /**
     * number of bits used for the previously encoded frame
     * encoding: set by lavc
Zdenek Kabelac's avatar
Zdenek Kabelac committed
491
     * decoding: - for audio - bits_per_sample
492
     */
493
    int frame_bits;
494
                 
495 496 497 498 499 500 501
    /**
     * private data of the user, can be used to carry app specific stuff
     * encoding: set by user
     * decoding: set by user
     */
    void *opaque;

Fabrice Bellard's avatar
Fabrice Bellard committed
502
    char codec_name[32];
503 504
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
Fabrice Bellard's avatar
Fabrice Bellard committed
505
    unsigned int codec_tag;  /* codec tag, only used if unknown codec */
506
    
507
    /**
508
     * workaround bugs in encoders which sometimes cannot be detected automatically
509 510 511 512
     * encoding: unused
     * decoding: set by user
     */
    int workaround_bugs;
513 514 515 516 517 518
#define FF_BUG_AUTODETECT       1  //autodetection
#define FF_BUG_OLD_MSMPEG4      2
#define FF_BUG_XVID_ILACE       4
#define FF_BUG_UMP4             8
#define FF_BUG_NO_PADDING       16
#define FF_BUG_AC_VLC           32
Michael Niedermayer's avatar
Michael Niedermayer committed
519
#define FF_BUG_QPEL_CHROMA      64
520 521
//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
        
522 523 524 525
    /**
     * encoding: set by user
     * decoding: unused
     */
526
    int luma_elim_threshold;
527 528 529 530 531
    
    /**
     * encoding: set by user
     * decoding: unused
     */
532
    int chroma_elim_threshold;
533 534 535 536 537 538 539 540 541 542
    
    /**
     * strictly follow the std (MPEG4, ...)
     * encoding: set by user
     * decoding: unused
     */
    int strict_std_compliance;
    
    /**
     * qscale offset between ip and b frames
543 544
     * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
     * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
545 546 547 548 549 550
     * encoding: set by user.
     * decoding: unused
     */
    float b_quant_offset;
    
    /**
551
     * error resilience higher values will detect more errors but may missdetect
552 553 554 555
     * some more or less valid parts as errors
     * encoding: unused
     * decoding: set by user
     */
556
    int error_resilience;
557 558 559 560
#define FF_ER_CAREFULL        1
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
561
    
562
    /**
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
563 564
     * called at the beginning of each frame to get a buffer for it.
     * if pic.reference is set then the frame will be read later by lavc
565
     * encoding: unused
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
566
     * decoding: set by lavc, user can override
567
     */
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
568
    int (*get_buffer)(struct AVCodecContext *c, AVVideoFrame *pic);
569 570
    
    /**
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
571 572 573
     * called to release buffers which where allocated with get_buffer.
     * a released buffer can be reused in get_buffer()
     * pic.data[*] must be set to NULL
574
     * encoding: unused
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
575
     * decoding: set by lavc, user can override
576
     */
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
577
    void (*release_buffer)(struct AVCodecContext *c, AVVideoFrame *pic);
Michael Niedermayer's avatar
Michael Niedermayer committed
578

579 580 581 582 583 584 585
    /**
     * is 1 if the decoded stream contains b frames, 0 otherwise
     * encoding: unused
     * decoding: set by lavc
     */
    int has_b_frames;
    
Fabrice Bellard's avatar
Fabrice Bellard committed
586
    int block_align; /* used by some WAV based audio codecs */
Michael Niedermayer's avatar
Michael Niedermayer committed
587
    
588 589 590
    int parse_only; /* decoding only: if true, only parsing is done
                       (function avcodec_parse_frame()). The frame
                       data is returned. Only MPEG codecs support this now. */
Michael Niedermayer's avatar
Michael Niedermayer committed
591
    
592 593 594 595 596 597
    /**
     * 0-> h263 quant 1-> mpeg quant
     * encoding: set by user.
     * decoding: unused
     */
    int mpeg_quant;
Michael Niedermayer's avatar
Michael Niedermayer committed
598
    
599 600 601 602 603
    /**
     * pass1 encoding statistics output buffer
     * encoding: set by lavc
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
604
    char *stats_out; /* encoding statistics output buffer */
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
    
    /**
     * pass2 encoding statistics input buffer.
     * concatenated stuff from stats_out of pass1 should be placed here
     * encoding: allocated/set/freed by user
     * decoding: unused
     */
    char *stats_in;
    
    /**
     * ratecontrol qmin qmax limiting method
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
     * encoding: set by user.
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
620
    float rc_qsquish;
621

Michael Niedermayer's avatar
Michael Niedermayer committed
622 623
    float rc_qmod_amp;
    int rc_qmod_freq;
624 625 626 627 628 629
    
    /**
     * ratecontrol override, see RcOverride
     * encoding: allocated/set/freed by user.
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
630 631
    RcOverride *rc_override;
    int rc_override_count;
632 633 634 635 636 637
    
    /**
     * rate control equation
     * encoding: set by user
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
638
    char *rc_eq;
639 640 641 642 643 644
    
    /**
     * maximum bitrate
     * encoding: set by user.
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
645
    int rc_max_rate;
646 647 648 649 650 651
    
    /**
     * minimum bitrate
     * encoding: set by user.
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
652
    int rc_min_rate;
653 654 655 656 657 658
    
    /**
     * decoder bitstream buffer size
     * encoding: set by user.
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
659 660
    int rc_buffer_size;
    float rc_buffer_aggressivity;
661 662 663 664 665 666 667 668 669 670

    /**
     * qscale factor between p and i frames
     * encoding: set by user.
     * decoding: unused
     */
    float i_quant_factor;
    
    /**
     * qscale offset between p and i frames
671 672
     * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
     * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
673 674 675 676 677 678 679 680 681 682
     * encoding: set by user.
     * decoding: unused
     */
    float i_quant_offset;
    
    /**
     * initial complexity for pass1 ratecontrol
     * encoding: set by user.
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
683
    float rc_initial_cplx;
684

685 686 687 688 689
    /**
     * dct algorithm, see FF_DCT_* below
     * encoding: set by user
     * decoding: unused
     */
690
    int dct_algo;
691
#define FF_DCT_AUTO    0
692
#define FF_DCT_FASTINT 1
693 694 695
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
696
#define FF_DCT_ALTIVEC 5
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
    
    /**
     * luminance masking (0-> disabled)
     * encoding: set by user
     * decoding: unused
     */
    float lumi_masking;
    
    /**
     * temporary complexity masking (0-> disabled)
     * encoding: set by user
     * decoding: unused
     */
    float temporal_cplx_masking;
    
    /**
     * spatial complexity masking (0-> disabled)
     * encoding: set by user
     * decoding: unused
     */
    float spatial_cplx_masking;
    
    /**
     * p block masking (0-> disabled)
     * encoding: set by user
     * decoding: unused
     */
    float p_masking;
725

726 727 728 729 730 731
    /**
     * darkness masking (0-> disabled)
     * encoding: set by user
     * decoding: unused
     */
    float dark_masking;
732 733 734 735 736
    
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A')
     * this is used to workaround some encoder bugs
     * encoding: unused
737
     * decoding: set by user, will be converted to upper case by lavc during init
738 739
     */
    int fourcc;
740

741 742 743 744 745 746 747 748 749 750 751 752 753 754
    /**
     * idct algorithm, see FF_IDCT_* below
     * encoding: set by user
     * decoding: set by user
     */
    int idct_algo;
#define FF_IDCT_AUTO         0
#define FF_IDCT_INT          1
#define FF_IDCT_SIMPLE       2
#define FF_IDCT_SIMPLEMMX    3
#define FF_IDCT_LIBMPEG2MMX  4
#define FF_IDCT_PS2          5
#define FF_IDCT_MLIB         6
#define FF_IDCT_ARM          7
755
#define FF_IDCT_ALTIVEC      8
756

757 758 759 760 761 762 763 764 765 766 767 768 769
    /**
     * slice count
     * encoding: set by lavc
     * decoding: set by user (or 0)
     */
    int slice_count;
    /**
     * slice offsets in the frame in bytes
     * encoding: set/allocated by lavc
     * decoding: set/allocated by user (or NULL)
     */
    int *slice_offset;

770 771 772 773 774 775 776 777 778
    /**
     * error concealment flags
     * encoding: unused
     * decoding: set by user
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

Zdenek Kabelac's avatar
Zdenek Kabelac committed
779 780 781 782 783
    /**
     * dsp_mask could be used to disable unwanted
     * CPU features (i.e. MMX, SSE. ...)
     */
     unsigned dsp_mask;
Michael Niedermayer's avatar
huffyuv  
Michael Niedermayer committed
784 785 786

    /**
     * bits per sample/pixel from the demuxer (needed for huffyuv)
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
787
     * encoding: set by lavc
Michael Niedermayer's avatar
huffyuv  
Michael Niedermayer committed
788 789 790 791 792 793
     * decoding: set by user
     */
     int bits_per_sample;
    
    /**
     * prediction method (needed for huffyuv)
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
794
     * encoding: set by user
Michael Niedermayer's avatar
huffyuv  
Michael Niedermayer committed
795 796 797 798 799 800
     * decoding: unused
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
Michael Niedermayer's avatar
Michael Niedermayer committed
801 802 803 804 805 806 807
    
    /**
     * aspect ratio. (0 if unknown)
     * encoding: set by user.
     * decoding: set by lavc.
     */
    float aspect_ratio;
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
808 809 810 811 812 813 814

    /**
     * the picture in the bitstream
     * encoding: set by lavc
     * decoding: set by lavc
     */
    AVVideoFrame *coded_picture;
815 816 817 818 819 820 821 822 823 824 825 826 827 828

    /**
     * debug 
     * encoding: set by user.
     * decoding: set by user.
     */
    int debug;
#define FF_DEBUG_PICT_INFO 1
#define FF_DEBUG_RC        2
#define FF_DEBUG_BITSTREAM 4
#define FF_DEBUG_MB_TYPE   8
#define FF_DEBUG_QP        16
#define FF_DEBUG_MV        32
#define FF_DEBUG_VIS_MV    64
Fabrice Bellard's avatar
Fabrice Bellard committed
829 830 831
} AVCodecContext;

typedef struct AVCodec {
832
    const char *name;
Fabrice Bellard's avatar
Fabrice Bellard committed
833 834 835 836 837 838
    int type;
    int id;
    int priv_data_size;
    int (*init)(AVCodecContext *);
    int (*encode)(AVCodecContext *, UINT8 *buf, int buf_size, void *data);
    int (*close)(AVCodecContext *);
Michael Niedermayer's avatar
Michael Niedermayer committed
839
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
Fabrice Bellard's avatar
Fabrice Bellard committed
840
                  UINT8 *buf, int buf_size);
Fabrice Bellard's avatar
Fabrice Bellard committed
841
    int capabilities;
Fabrice Bellard's avatar
Fabrice Bellard committed
842 843 844
    struct AVCodec *next;
} AVCodec;

845 846 847 848
/** 
 * four components are given, that's all.
 * the last component is alpha
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
849
typedef struct AVPicture {
850 851
    UINT8 *data[4];
    int linesize[4];
Fabrice Bellard's avatar
Fabrice Bellard committed
852 853 854 855
} AVPicture;

extern AVCodec ac3_encoder;
extern AVCodec mp2_encoder;
856
extern AVCodec mp3lame_encoder;
857
extern AVCodec oggvorbis_encoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
858 859 860 861 862
extern AVCodec mpeg1video_encoder;
extern AVCodec h263_encoder;
extern AVCodec h263p_encoder;
extern AVCodec rv10_encoder;
extern AVCodec mjpeg_encoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
863
extern AVCodec mpeg4_encoder;
864 865 866
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
867 868
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
Michael Niedermayer's avatar
huffyuv  
Michael Niedermayer committed
869
extern AVCodec huffyuv_encoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
870 871

extern AVCodec h263_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
872
extern AVCodec mpeg4_decoder;
873 874 875
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
876
extern AVCodec wmv1_decoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
877
extern AVCodec wmv2_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
878 879 880
extern AVCodec mpeg_decoder;
extern AVCodec h263i_decoder;
extern AVCodec rv10_decoder;
Nick Kurshev's avatar
Nick Kurshev committed
881
extern AVCodec svq1_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
882 883
extern AVCodec dvvideo_decoder;
extern AVCodec dvaudio_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
884 885
extern AVCodec wmav1_decoder;
extern AVCodec wmav2_decoder;
886
extern AVCodec mjpeg_decoder;
887
extern AVCodec mjpegb_decoder;
888
extern AVCodec mp2_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
889
extern AVCodec mp3_decoder;
890 891
extern AVCodec mace3_decoder;
extern AVCodec mace6_decoder;
Michael Niedermayer's avatar
huffyuv  
Michael Niedermayer committed
892
extern AVCodec huffyuv_decoder;
Mark Hills's avatar
Mark Hills committed
893
extern AVCodec oggvorbis_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
894

Fabrice Bellard's avatar
Fabrice Bellard committed
895 896 897
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
898
extern AVCodec name ## _encoder
Fabrice Bellard's avatar
Fabrice Bellard committed
899 900 901 902 903 904 905 906 907 908

PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);

909 910 911 912 913 914
/* adpcm codecs */

PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);

Fabrice Bellard's avatar
Fabrice Bellard committed
915 916 917
#undef PCM_CODEC

/* dummy raw video codec */
Fabrice Bellard's avatar
Fabrice Bellard committed
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
extern AVCodec rawvideo_codec;

/* the following codecs use external GPL libs */
extern AVCodec ac3_decoder;

/* resample.c */

struct ReSampleContext;

typedef struct ReSampleContext ReSampleContext;

ReSampleContext *audio_resample_init(int output_channels, int input_channels, 
                                     int output_rate, int input_rate);
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
void audio_resample_close(ReSampleContext *s);

/* YUV420 format is assumed ! */

struct ImgReSampleContext;

typedef struct ImgReSampleContext ImgReSampleContext;

ImgReSampleContext *img_resample_init(int output_width, int output_height,
                                      int input_width, int input_height);
942 943 944 945 946 947

ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
                                      int iwidth, int iheight,
                                      int topBand, int bottomBand,
                                      int leftBand, int rightBand);

Fabrice Bellard's avatar
Fabrice Bellard committed
948 949 950 951 952
void img_resample(ImgReSampleContext *s, 
                  AVPicture *output, AVPicture *input);

void img_resample_close(ImgReSampleContext *s);

953 954 955
void avpicture_fill(AVPicture *picture, UINT8 *ptr,
                    int pix_fmt, int width, int height);
int avpicture_get_size(int pix_fmt, int width, int height);
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
956
void avcodec_get_chroma_sub_sample(int fmt, int *h_shift, int *v_shift);
957 958 959 960 961 962 963 964

/* convert among pixel formats */
int img_convert(AVPicture *dst, int dst_pix_fmt,
                AVPicture *src, int pix_fmt, 
                int width, int height);

/* deinterlace a picture */
int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
Fabrice Bellard's avatar
Fabrice Bellard committed
965 966 967 968 969 970
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

Nick Kurshev's avatar
Nick Kurshev committed
971
/* returns LIBAVCODEC_VERSION_INT constant */
972
unsigned avcodec_version(void);
Nick Kurshev's avatar
Nick Kurshev committed
973
/* returns LIBAVCODEC_BUILD constant */
974
unsigned avcodec_build(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
975 976
void avcodec_init(void);

977 978
void avcodec_set_bit_exact(void);

Fabrice Bellard's avatar
Fabrice Bellard committed
979 980
void register_avcodec(AVCodec *format);
AVCodec *avcodec_find_encoder(enum CodecID id);
981
AVCodec *avcodec_find_encoder_by_name(const char *name);
Fabrice Bellard's avatar
Fabrice Bellard committed
982 983 984 985
AVCodec *avcodec_find_decoder(enum CodecID id);
AVCodec *avcodec_find_decoder_by_name(const char *name);
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);

Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
986
void avcodec_get_context_defaults(AVCodecContext *s);
Falk Hüffner's avatar
Falk Hüffner committed
987
AVCodecContext *avcodec_alloc_context(void);
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
988 989 990 991 992
AVVideoFrame *avcodec_alloc_picture(void);

int avcodec_default_get_buffer(AVCodecContext *s, AVVideoFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVVideoFrame *pic);

Fabrice Bellard's avatar
Fabrice Bellard committed
993 994 995 996
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
int avcodec_decode_audio(AVCodecContext *avctx, INT16 *samples, 
                         int *frame_size_ptr,
                         UINT8 *buf, int buf_size);
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
997
int avcodec_decode_video(AVCodecContext *avctx, AVVideoFrame *picture, 
Fabrice Bellard's avatar
Fabrice Bellard committed
998 999
                         int *got_picture_ptr,
                         UINT8 *buf, int buf_size);
1000 1001 1002
int avcodec_parse_frame(AVCodecContext *avctx, UINT8 **pdata, 
                        int *data_size_ptr,
                        UINT8 *buf, int buf_size);
Fabrice Bellard's avatar
Fabrice Bellard committed
1003 1004 1005
int avcodec_encode_audio(AVCodecContext *avctx, UINT8 *buf, int buf_size, 
                         const short *samples);
int avcodec_encode_video(AVCodecContext *avctx, UINT8 *buf, int buf_size, 
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
1006
                         const AVVideoFrame *pict);
Fabrice Bellard's avatar
Fabrice Bellard committed
1007 1008 1009 1010

int avcodec_close(AVCodecContext *avctx);

void avcodec_register_all(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
1011

Michael Niedermayer's avatar
Michael Niedermayer committed
1012 1013
void avcodec_flush_buffers(AVCodecContext *avctx);

1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
/**
 * Interface for 0.5.0 version
 *
 * do not even think about it's usage for this moment
 */

typedef struct {
    // compressed size used from given memory buffer
    int size;
    /// I/P/B frame type
    int frame_type;
} avc_enc_result_t;

/**
 * Commands
 * order can't be changed - once it was defined
 */
typedef enum {
    // general commands
    AVC_OPEN_BY_NAME = 0xACA000,
    AVC_OPEN_BY_CODEC_ID,
    AVC_OPEN_BY_FOURCC,
    AVC_CLOSE,

    AVC_FLUSH,
    // pin - struct { uint8_t* src, uint_t src_size }
    // pout - struct { AVPicture* img, consumed_bytes,
    AVC_DECODE,
    // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
    // pout - uint_t used_from_dest_size
    AVC_ENCODE, 

    // query/get video commands
    AVC_GET_VERSION = 0xACB000,
    AVC_GET_WIDTH,
    AVC_GET_HEIGHT,
    AVC_GET_DELAY,
    AVC_GET_QUANT_TABLE,
    // ...

    // query/get audio commands
    AVC_GET_FRAME_SIZE = 0xABC000,

    // maybe define some simple structure which
    // might be passed to the user - but they can't
    // contain any codec specific parts and these
    // calls are usualy necessary only few times

    // set video commands
    AVC_SET_WIDTH = 0xACD000,
    AVC_SET_HEIGHT,

    // set video encoding commands
    AVC_SET_FRAME_RATE = 0xACD800,
    AVC_SET_QUALITY,
    AVC_SET_HURRY_UP,

    // set audio commands
    AVC_SET_SAMPLE_RATE = 0xACE000,
    AVC_SET_CHANNELS,

} avc_cmd_t;

/**
 * \param handle  allocated private structure by libavcodec
 *                for initialization pass NULL - will be returned pout
 *                user is supposed to know nothing about its structure
 * \param cmd     type of operation to be performed
 * \param pint    input parameter
 * \param pout    output parameter
 *
 * \returns  command status - eventually for query command it might return
 * integer resulting value
 */
int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);

1090
/* memory */
1091 1092
void *av_malloc(unsigned int size);
void *av_mallocz(unsigned int size);
1093 1094 1095
void av_free(void *ptr);
void __av_freep(void **ptr);
#define av_freep(p) __av_freep((void **)(p))
1096 1097 1098 1099 1100
/* for static data only */
/* call av_free_static to release all staticaly allocated tables */
void av_free_static();
void *__av_mallocz_static(void** location, unsigned int size);
#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
1101

Fabrice Bellard's avatar
Fabrice Bellard committed
1102
#endif /* AVCODEC_H */