avcodec.h 29.4 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       4630
#define LIBAVCODEC_BUILD_STR   "4630"
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,
Fabrice Bellard's avatar
Fabrice Bellard committed
21
    CODEC_ID_MPEG4,
Fabrice Bellard's avatar
Fabrice Bellard committed
22
    CODEC_ID_RAWVIDEO,
23 24 25
    CODEC_ID_MSMPEG4V1,
    CODEC_ID_MSMPEG4V2,
    CODEC_ID_MSMPEG4V3,
26
    CODEC_ID_WMV1,
Michael Niedermayer's avatar
Michael Niedermayer committed
27
    CODEC_ID_WMV2,
Fabrice Bellard's avatar
Fabrice Bellard committed
28 29
    CODEC_ID_H263P,
    CODEC_ID_H263I,
Nick Kurshev's avatar
Nick Kurshev committed
30
    CODEC_ID_SVQ1,
Fabrice Bellard's avatar
Fabrice Bellard committed
31 32
    CODEC_ID_DVVIDEO,
    CODEC_ID_DVAUDIO,
Fabrice Bellard's avatar
Fabrice Bellard committed
33 34 35 36 37 38 39 40 41 42

    /* 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,
43 44 45 46 47

    /* various adpcm codecs */
    CODEC_ID_ADPCM_IMA_QT,
    CODEC_ID_ADPCM_IMA_WAV,
    CODEC_ID_ADPCM_MS,
Fabrice Bellard's avatar
Fabrice Bellard committed
48
};
49
#define CODEC_ID_MSMPEG4 CODEC_ID_MSMPEG4V3
Fabrice Bellard's avatar
Fabrice Bellard committed
50 51

enum CodecType {
52
    CODEC_TYPE_UNKNOWN = -1,
Fabrice Bellard's avatar
Fabrice Bellard committed
53 54 55 56 57
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
};

enum PixelFormat {
58
    PIX_FMT_ANY = -1,
Fabrice Bellard's avatar
Fabrice Bellard committed
59 60 61 62
    PIX_FMT_YUV420P,
    PIX_FMT_YUV422,
    PIX_FMT_RGB24,
    PIX_FMT_BGR24,
63 64
    PIX_FMT_YUV422P,
    PIX_FMT_YUV444P,
65 66
    PIX_FMT_RGBA32,
    PIX_FMT_BGRA32,
Arpi's avatar
Arpi committed
67 68
    PIX_FMT_YUV410P,
    PIX_FMT_YUV411P
Fabrice Bellard's avatar
Fabrice Bellard committed
69 70
};

Fabrice Bellard's avatar
Fabrice Bellard committed
71 72 73 74 75
/* 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
76 77 78
/* in bytes */
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 18432

79 80
/* motion estimation type, EPZS by default */
enum Motion_Est_ID {
81
    ME_ZERO = 1,
82 83 84 85 86 87 88
    ME_FULL,
    ME_LOG,
    ME_PHODS,
    ME_EPZS,
    ME_X1
};

Michael Niedermayer's avatar
Michael Niedermayer committed
89 90 91 92 93 94 95
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;

96 97 98
/* only for ME compatiblity with old apps */
extern int motion_estimation_method;

99
/* ME algos sorted by quality */
100 101
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
102

103

104 105
#define FF_MAX_B_FRAMES 4

Michael Niedermayer's avatar
Michael Niedermayer committed
106 107 108 109
/* 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
110

111 112 113 114 115 116 117
#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_TYPE   0x0040  /* fixed I/P frame type, from avctx->key_frame */
#define CODEC_FLAG_PART   0x0080  /* use data partitioning */
118 119
/* 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 */
120
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
121 122
#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 */
123
#define CODEC_FLAG_EXTERN_HUFF 0x1000 /* use external huffman table (for mjpeg) */
124
#define CODEC_FLAG_GRAY  0x2000   /* only decode/encode grayscale */
125
#define CODEC_FLAG_EMU_EDGE 0x4000/* dont draw edges */
126 127 128
#define CODEC_FLAG_DR1    0x8000  /* direct renderig type 1 (store internal frames in external buffers) */
#define CODEC_FLAG_NOT_TRUNCATED  0x00010000 /* input bitstream is not truncated, except before a startcode 
                                                allows the last part of a frame to be decoded earlier */
129
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 /* normalize adaptive quantization */
130
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 /* use interlaced dct */
131

Fabrice Bellard's avatar
Fabrice Bellard committed
132 133
/* codec capabilities */

134
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 /* decoder can use draw_horiz_band callback */
135
#define CODEC_CAP_DR1             0x0002 /* direct rendering method 1 */
136 137 138
/* if 'parse_only' field is true, then avcodec_parse_frame() can be
   used */
#define CODEC_CAP_PARSE_ONLY      0x0004
Fabrice Bellard's avatar
Fabrice Bellard committed
139

Fabrice Bellard's avatar
Fabrice Bellard committed
140 141 142
#define FRAME_RATE_BASE 10000

typedef struct AVCodecContext {
143 144 145 146 147
    /**
     * 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
148
    int bit_rate;
149 150 151 152 153 154 155 156 157 158 159 160 161 162

    /**
     * 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
163
    int flags;
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182

    /**
     * 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
     * encoding: set by user.
     * decoding: unused
     */
    int me_method;

    /**
     * some codecs need / can use extra-data like huffman tables
     * mjpeg: huffman tables
     * rv10: additional flags
183 184
     * encoding: set/allocated/freed by lavc.
     * decoding: set/allocated/freed by user.
185
     */
186 187 188
    void *extradata;
    int extradata_size;
    
Fabrice Bellard's avatar
Fabrice Bellard committed
189
    /* video only */
190 191 192 193 194 195 196 197 198 199 200 201 202
    /**
     * 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
     * encoding: set by user
     * decoding: set by lavc. 0 or the frame_rate if available
     */
    int frame_rate;

    /**
     * encoding: set by user.
     * decoding: set by user, some codecs might override / change it during playback
     */
Fabrice Bellard's avatar
Fabrice Bellard committed
203
    int width, height;
204 205 206 207 208
    
    /**
     * encoding: set by user. 0 if not known
     * decoding: set by lavc. 0 if not known
     */
209
    int aspect_ratio_info;
Michael Niedermayer's avatar
Michael Niedermayer committed
210 211 212 213 214
#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
215
#define FF_ASPECT_EXTENDED 15
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230

    /**
     * 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;
    
231 232 233
    int repeat_pict; /* when decoding, this signal how much the picture */
                     /* must be delayed.                                */
                     /* extra_delay = (repeat_pict / 2) * (1/fps)       */
234 235 236 237 238 239 240 241 242
    
    /**
     * 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
243 244 245 246
    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
247 248 249
    /* audio only */
    int sample_rate; /* samples per sec */
    int channels;
Fabrice Bellard's avatar
Fabrice Bellard committed
250
    int sample_fmt;  /* sample format, currenly unused */
Fabrice Bellard's avatar
Fabrice Bellard committed
251 252

    /* the following data should not be initialized */
253 254 255 256
    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 */
257 258 259 260 261 262 263 264 265 266 267 268 269 270
                           
    /**
     * 1 -> keyframe, 0-> not
     * 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;

    /**
     * picture type of the previous en/decoded frame, see ?_TYPE below
     * 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 pict_type;
271 272 273 274 275 276
/* 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

277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
    /**
     * number of frames the decoded output will be delayed relative to 
     * the encoded input
     * encoding: set by lavc.
     * decoding: unused
     */
    int delay;

    /**
     * mbskip_table[mb]=1 if MB didnt change, is only valid for I/P frames 
     * stride= mb_width = (width+15)>>4 (FIXME export stride?)
     * encoding: unused
     * decoding: set by lavc
     */
    uint8_t *mbskip_table;
Michael Niedermayer's avatar
Michael Niedermayer committed
292 293
    
    /* encoding parameters */
294 295 296 297 298
    /**
     * quality (between 1 (good) and 31 (bad)) 
     * encoding: set by user if CODEC_FLAG_QSCALE is set otherwise set by lavc
     * decoding: set by lavc
     */
Fabrice Bellard's avatar
Fabrice Bellard committed
299
    int quality;      /* quality of the previous encoded frame 
300
                         
301 302
                         this is allso used to set the quality in vbr mode
                         and the per frame quality in CODEC_FLAG_TYPE (second pass mode) */
303 304
    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) */
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
    
    /**
     * 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;
344
    int b_frame_strategy;
345

346 347 348 349 350
    /**
     * encoding: unused
     * decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too
     */
    int hurry_up;
351
    
Fabrice Bellard's avatar
Fabrice Bellard committed
352
    struct AVCodec *codec;
353
    
Fabrice Bellard's avatar
Fabrice Bellard committed
354 355
    void *priv_data;

356
    /* The following data is for RTP friendly coding */
357
    /* By now only H.263/H.263+/MPEG4 coder honours this   */
358 359 360 361 362 363 364 365 366 367
    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    */
368 369 370 371 372 373 374 375

    
    /* 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); 

376 377 378 379 380 381
    /**
     * 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
     */
382 383 384 385
    int get_psnr;
    float psnr_y;
    float psnr_cb;
    float psnr_cr;
386 387 388 389 390 391 392 393 394
    
    /* 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;
395 396 397 398 399 400 401
    int misc_bits;
    
    /**
     * number of bits used for the previously encoded frame
     * encoding: set by lavc
     * decoding: unused
     */
402
    int frame_bits;
403
                 
404 405 406 407 408 409 410
    /**
     * 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
411
    char codec_name[32];
412 413
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
Fabrice Bellard's avatar
Fabrice Bellard committed
414
    unsigned int codec_tag;  /* codec tag, only used if unknown codec */
415
    
416 417 418 419 420 421 422 423 424 425 426
    /**
     * workaround bugs in encoders which cannot be detected automatically
     * encoding: unused
     * decoding: set by user
     */
    int workaround_bugs;
    
    /**
     * encoding: set by user
     * decoding: unused
     */
427
    int luma_elim_threshold;
428 429 430 431 432
    
    /**
     * encoding: set by user
     * decoding: unused
     */
433
    int chroma_elim_threshold;
434 435 436 437 438 439 440 441 442 443
    
    /**
     * strictly follow the std (MPEG4, ...)
     * encoding: set by user
     * decoding: unused
     */
    int strict_std_compliance;
    
    /**
     * qscale offset between ip and b frames
444 445
     * 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)
446 447 448 449 450 451 452 453 454 455 456
     * encoding: set by user.
     * decoding: unused
     */
    float b_quant_offset;
    
    /**
     * error resilience {-1,0,1} higher values will detect more errors but may missdetect
     * some more or less valid parts as errors
     * encoding: unused
     * decoding: set by user
     */
457
    int error_resilience;
458 459 460 461 462
    
#ifndef MBC
#define MBC 128
#define MBR 96
#endif
463 464 465 466
#define QP_TYPE int //FIXME note xxx this might be changed to int8_t

    QP_TYPE *quant_store; /* field for communicating with external postprocessing */

467
    unsigned qstride;
468 469 470 471 472 473 474 475
    
    /**
     * buffer, where the next picture should be decoded into
     * encoding: unused
     * decoding: set by user in get_buffer_callback to a buffer into which the next part
     *           of the bitstream will be decoded, and set by lavc at end of frame to the
     *           next frame which needs to be displayed
     */
476
    uint8_t *dr_buffer[3];
477 478 479 480 481 482
    
    /**
     * stride of the luminance part of the dr buffer
     * encoding: unused
     * decoding: set by user
     */
483
    int dr_stride;
484 485 486 487 488 489
    
    /**
     * same behavior as dr_buffer, just for some private data of the user
     * encoding: unused
     * decoding: set by user in get_buffer_callback, and set by lavc at end of frame
     */
490
    void *dr_opaque_frame;
491 492 493 494 495 496
    
    /**
     * called at the beginning of each frame to get a buffer for it
     * encoding: unused
     * decoding: set by user
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
497 498
    void (*get_buffer_callback)(struct AVCodecContext *c, int width, int height, int pict_type);

499 500 501 502 503 504 505 506 507 508 509 510
    /**
     * is 1 if the decoded stream contains b frames, 0 otherwise
     * encoding: unused
     * decoding: set by lavc
     */
    int has_b_frames;

    /**
     * stride of the chrominance part of the dr buffer
     * encoding: unused
     * decoding: set by user
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
511
    int dr_uvstride;
512 513 514 515 516 517
    
    /**
     * number of dr buffers
     * encoding: unused
     * decoding: set by user
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
518
    int dr_ip_buffer_count;
519
    
520
    int block_align; /* currently only for adpcm codec in wav/avi */
Michael Niedermayer's avatar
Michael Niedermayer committed
521
    
522 523 524
    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
525
    
526 527 528 529 530 531
    /**
     * 0-> h263 quant 1-> mpeg quant
     * encoding: set by user.
     * decoding: unused
     */
    int mpeg_quant;
Michael Niedermayer's avatar
Michael Niedermayer committed
532
    
533 534 535 536 537
    /**
     * pass1 encoding statistics output buffer
     * encoding: set by lavc
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
538
    char *stats_out; /* encoding statistics output buffer */
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
    
    /**
     * 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
554
    float rc_qsquish;
555

Michael Niedermayer's avatar
Michael Niedermayer committed
556 557
    float rc_qmod_amp;
    int rc_qmod_freq;
558 559 560 561 562 563
    
    /**
     * ratecontrol override, see RcOverride
     * encoding: allocated/set/freed by user.
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
564 565
    RcOverride *rc_override;
    int rc_override_count;
566 567 568 569 570 571
    
    /**
     * rate control equation
     * encoding: set by user
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
572
    char *rc_eq;
573 574 575 576 577 578
    
    /**
     * maximum bitrate
     * encoding: set by user.
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
579
    int rc_max_rate;
580 581 582 583 584 585
    
    /**
     * minimum bitrate
     * encoding: set by user.
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
586
    int rc_min_rate;
587 588 589 590 591 592
    
    /**
     * decoder bitstream buffer size
     * encoding: set by user.
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
593 594
    int rc_buffer_size;
    float rc_buffer_aggressivity;
595 596 597 598 599 600 601 602 603 604

    /**
     * qscale factor between p and i frames
     * encoding: set by user.
     * decoding: unused
     */
    float i_quant_factor;
    
    /**
     * qscale offset between p and i frames
605 606
     * 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)
607 608 609 610 611 612 613 614 615 616
     * 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
617
    float rc_initial_cplx;
618

619 620 621 622 623
    /**
     * custom aspect ratio, used if aspect_info==FF_ASPECT_EXTENDED
     * encoding: set by user.
     * decoding: set by lavc.
     */
624 625 626
    int aspected_width;
    int aspected_height;

627 628 629 630 631
    /**
     * dct algorithm, see FF_DCT_* below
     * encoding: set by user
     * decoding: unused
     */
632
    int dct_algo;
633
#define FF_DCT_AUTO    0
634
#define FF_DCT_FASTINT 1
635 636 637
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
638

639 640 641 642 643 644 645
    /**
     * 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: set by user
     * decoding; set by lavc
     */
    long long int pts;
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
    
    /**
     * 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;
674

675 676 677 678 679 680
    /**
     * darkness masking (0-> disabled)
     * encoding: set by user
     * decoding: unused
     */
    float dark_masking;
681 682 683 684 685
    
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A')
     * this is used to workaround some encoder bugs
     * encoding: unused
686
     * decoding: set by user, will be converted to upper case by lavc during init
687 688
     */
    int fourcc;
689

690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
    /**
     * 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

705 706 707 708 709 710 711 712 713 714 715 716 717
    /**
     * 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;

718
    //FIXME this should be reordered after kabis API is finished ...
Michael Niedermayer's avatar
Michael Niedermayer committed
719
    //TODO kill kabi
Nick Kurshev's avatar
Nick Kurshev committed
720 721 722 723 724 725
    /*
	Note: Below are located reserved fields for further usage
	It requires for ABI !!!
	If you'll perform some changes then borrow new space from these fields
	(void * can be safety replaced with struct * ;)
	P L E A S E ! ! !
726 727 728 729 730
	Note: use avcodec_alloc_context instead of malloc to allocate this, 
        otherwise the ABI compatibility will be broken between versions
 	IMPORTANT: Never change order of already declared fields!!!
     */
     //TODO: remove mess below
Nick Kurshev's avatar
Nick Kurshev committed
731 732
    unsigned long long int
	    ull_res0,ull_res1,ull_res2,ull_res3,ull_res4,ull_res5,
733
	    ull_res6,ull_res7,ull_res8,ull_res9,ull_res10,ull_res11;
Nick Kurshev's avatar
Nick Kurshev committed
734 735
    float
	    flt_res0,flt_res1,flt_res2,flt_res3,flt_res4,flt_res5,
Michael Niedermayer's avatar
Michael Niedermayer committed
736
	    flt_res6,flt_res7,flt_res8,flt_res9,flt_res10,flt_res11,flt_res12;
Nick Kurshev's avatar
Nick Kurshev committed
737 738
    void
	    *ptr_res0,*ptr_res1,*ptr_res2,*ptr_res3,*ptr_res4,*ptr_res5,
Michael Niedermayer's avatar
Michael Niedermayer committed
739
            *ptr_res6,*ptr_res7,*ptr_res8,*ptr_res9,*ptr_res10,*ptr_res11,*ptr_res12;
Nick Kurshev's avatar
Nick Kurshev committed
740 741 742 743 744 745 746 747
    unsigned long int
	    ul_res0,ul_res1,ul_res2,ul_res3,ul_res4,ul_res5,
	    ul_res6,ul_res7,ul_res8,ul_res9,ul_res10,ul_res11,ul_res12;
    unsigned short int
	    us_res0,us_res1,us_res2,us_res3,us_res4,us_res5,
	    us_res6,us_res7,us_res8,us_res9,us_res10,us_res11,us_res12;
    unsigned char
	    uc_res0,uc_res1,uc_res2,uc_res3,uc_res4,uc_res5,
Michael Niedermayer's avatar
Michael Niedermayer committed
748
	    uc_res6,uc_res7,uc_res8,uc_res9,uc_res10,uc_res11,uc_res12;
Michael Niedermayer's avatar
Michael Niedermayer committed
749 750
    unsigned int
	    ui_res0,ui_res1,ui_res2,ui_res3,ui_res4,ui_res5,ui_res6,ui_res7,ui_res8,ui_res9,
751
	    ui_res10,ui_res11,ui_res12,ui_res13,ui_res14,ui_res15,ui_res16;
Fabrice Bellard's avatar
Fabrice Bellard committed
752 753 754 755 756 757 758 759 760 761
} AVCodecContext;

typedef struct AVCodec {
    char *name;
    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
762
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
Fabrice Bellard's avatar
Fabrice Bellard committed
763
                  UINT8 *buf, int buf_size);
Fabrice Bellard's avatar
Fabrice Bellard committed
764
    int capabilities;
Fabrice Bellard's avatar
Fabrice Bellard committed
765
    struct AVCodec *next;
Nick Kurshev's avatar
Nick Kurshev committed
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
    /*
	Note: Below are located reserved fields for further usage
	It requires for ABI !!!
	If you'll perform some changes then borrow new space from these fields
	(void * can be safety replaced with struct * ;)
	P L E A S E ! ! !
	IMPORTANT: Never change order of already declared fields!!!
    */
    unsigned long long int
	    ull_res0,ull_res1,ull_res2,ull_res3,ull_res4,ull_res5,
	    ull_res6,ull_res7,ull_res8,ull_res9,ull_res10,ull_res11,ull_res12;
    float
	    flt_res0,flt_res1,flt_res2,flt_res3,flt_res4,flt_res5,
	    flt_res6,flt_res7,flt_res8,flt_res9,flt_res10,flt_res11,flt_res12;
    void
	    *ptr_res0,*ptr_res1,*ptr_res2,*ptr_res3,*ptr_res4,*ptr_res5,
	    *ptr_res6,*ptr_res7,*ptr_res8,*ptr_res9,*ptr_res10,*ptr_res11,*ptr_res12;
Fabrice Bellard's avatar
Fabrice Bellard committed
783 784 785 786 787 788 789 790 791 792
} AVCodec;

/* three components are given, that's all */
typedef struct AVPicture {
    UINT8 *data[3];
    int linesize[3];
} AVPicture;

extern AVCodec ac3_encoder;
extern AVCodec mp2_encoder;
793
extern AVCodec mp3lame_encoder;
794
extern AVCodec oggvorbis_encoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
795 796 797 798 799
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
800
extern AVCodec mpeg4_encoder;
801 802 803
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
804 805
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
806 807

extern AVCodec h263_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
808
extern AVCodec mpeg4_decoder;
809 810 811
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
812
extern AVCodec wmv1_decoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
813
extern AVCodec wmv2_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
814 815 816
extern AVCodec mpeg_decoder;
extern AVCodec h263i_decoder;
extern AVCodec rv10_decoder;
Nick Kurshev's avatar
Nick Kurshev committed
817
extern AVCodec svq1_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
818 819
extern AVCodec dvvideo_decoder;
extern AVCodec dvaudio_decoder;
820
extern AVCodec mjpeg_decoder;
821
extern AVCodec mp2_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
822
extern AVCodec mp3_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
823

Fabrice Bellard's avatar
Fabrice Bellard committed
824 825 826 827 828 829 830 831 832 833 834 835 836 837
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
extern AVCodec name ## _encoder;

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);

838 839 840 841 842 843
/* 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
844 845 846
#undef PCM_CODEC

/* dummy raw video codec */
Fabrice Bellard's avatar
Fabrice Bellard committed
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
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);
871 872 873 874 875 876

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
877 878 879 880 881
void img_resample(ImgReSampleContext *s, 
                  AVPicture *output, AVPicture *input);

void img_resample_close(ImgReSampleContext *s);

882 883 884 885 886 887 888 889 890 891 892
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);

/* 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
893 894 895 896 897 898
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

Nick Kurshev's avatar
Nick Kurshev committed
899
/* returns LIBAVCODEC_VERSION_INT constant */
900
unsigned avcodec_version(void);
Nick Kurshev's avatar
Nick Kurshev committed
901
/* returns LIBAVCODEC_BUILD constant */
902
unsigned avcodec_build(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
903 904
void avcodec_init(void);

905 906
void avcodec_set_bit_exact(void);

Fabrice Bellard's avatar
Fabrice Bellard committed
907 908
void register_avcodec(AVCodec *format);
AVCodec *avcodec_find_encoder(enum CodecID id);
909
AVCodec *avcodec_find_encoder_by_name(const char *name);
Fabrice Bellard's avatar
Fabrice Bellard committed
910 911 912 913
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);

Falk Hüffner's avatar
Falk Hüffner committed
914
AVCodecContext *avcodec_alloc_context(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
915 916 917 918 919 920 921
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
int avcodec_decode_audio(AVCodecContext *avctx, INT16 *samples, 
                         int *frame_size_ptr,
                         UINT8 *buf, int buf_size);
int avcodec_decode_video(AVCodecContext *avctx, AVPicture *picture, 
                         int *got_picture_ptr,
                         UINT8 *buf, int buf_size);
922 923 924
int avcodec_parse_frame(AVCodecContext *avctx, UINT8 **pdata, 
                        int *data_size_ptr,
                        UINT8 *buf, int buf_size);
Fabrice Bellard's avatar
Fabrice Bellard committed
925 926 927 928 929 930 931 932
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, 
                         const AVPicture *pict);

int avcodec_close(AVCodecContext *avctx);

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

Michael Niedermayer's avatar
Michael Niedermayer committed
934 935
void avcodec_flush_buffers(AVCodecContext *avctx);

936 937 938 939
#ifdef FF_POSTPROCESS
extern int quant_store[MBR+1][MBC+1]; // [Review]
#endif

940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016

/**
 * 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);

1017 1018 1019 1020 1021 1022 1023
/* memory */
void *av_malloc(int size);
void *av_mallocz(int size);
void av_free(void *ptr);
void __av_freep(void **ptr);
#define av_freep(p) __av_freep((void **)(p))

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