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"
Michael Niedermayer's avatar
Michael Niedermayer committed
8 9
#define LIBAVCODEC_BUILD       4640
#define LIBAVCODEC_BUILD_STR   "4640"
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
#define CODEC_FLAG_DR1    0x8000  /* direct renderig type 1 (store internal frames in external buffers) */
144 145
#define CODEC_FLAG_TRUNCATED  0x00010000 /* input bitstream might be truncated at a random location instead 
                                            of only at frame boundaries */
146
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 /* normalize adaptive quantization */
147
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 /* use interlaced dct */
148
#define CODEC_FLAG_LOW_DELAY      0x00080000 /* force low delay / will fail on b frames */
Michael Niedermayer's avatar
Michael Niedermayer committed
149
#define CODEC_FLAG_ALT_SCAN       0x00100000 /* use alternate scan */
150

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

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

Fabrice Bellard's avatar
Fabrice Bellard committed
160 161 162
#define FRAME_RATE_BASE 10000

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

    /**
     * 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
183
    int flags;
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202

    /**
     * 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
203
     * mpeg4: global headers (they can be in the bitstream or here)
204 205
     * encoding: set/allocated/freed by lavc.
     * decoding: set/allocated/freed by user.
206
     */
207 208 209
    void *extradata;
    int extradata_size;
    
Fabrice Bellard's avatar
Fabrice Bellard committed
210
    /* video only */
211 212 213 214 215 216 217 218 219 220 221 222 223
    /**
     * 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
224
    int width, height;
225 226
    
    /**
Michael Niedermayer's avatar
Michael Niedermayer committed
227
     * Obsolete, will be removed
228
     */
229
    int aspect_ratio_info;
Michael Niedermayer's avatar
Michael Niedermayer committed
230 231 232 233 234
#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
235
#define FF_ASPECT_EXTENDED 15
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250

    /**
     * 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;
    
251 252 253
    int repeat_pict; /* when decoding, this signal how much the picture */
                     /* must be delayed.                                */
                     /* extra_delay = (repeat_pict / 2) * (1/fps)       */
254 255 256 257 258 259 260 261 262
    
    /**
     * 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
263 264 265 266
    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
267 268 269
    /* audio only */
    int sample_rate; /* samples per sec */
    int channels;
Fabrice Bellard's avatar
Fabrice Bellard committed
270
    int sample_fmt;  /* sample format, currenly unused */
Fabrice Bellard's avatar
Fabrice Bellard committed
271 272

    /* the following data should not be initialized */
273 274 275 276
    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 */
277 278 279 280 281 282 283 284 285 286 287 288 289 290
                           
    /**
     * 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;
291 292 293 294 295 296
/* 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

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
    /**
     * 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
312 313
    
    /* encoding parameters */
314 315 316 317 318
    /**
     * 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
319
    int quality;      /* quality of the previous encoded frame 
320
                         
321 322
                         this is allso used to set the quality in vbr mode
                         and the per frame quality in CODEC_FLAG_TYPE (second pass mode) */
323 324
    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) */
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
    
    /**
     * 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;
364
    int b_frame_strategy;
365

366 367
    /**
     * encoding: unused
368
     * decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
369 370
     */
    int hurry_up;
371
    
Fabrice Bellard's avatar
Fabrice Bellard committed
372
    struct AVCodec *codec;
373
    
Fabrice Bellard's avatar
Fabrice Bellard committed
374 375
    void *priv_data;

376
    /* The following data is for RTP friendly coding */
377
    /* By now only H.263/H.263+/MPEG4 coder honours this   */
378 379 380 381 382 383 384 385 386 387
    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    */
388 389 390 391 392 393 394 395

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

396 397 398 399 400 401
    /**
     * 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
     */
402 403 404 405
    int get_psnr;
    float psnr_y;
    float psnr_cb;
    float psnr_cr;
406 407 408 409 410 411 412 413 414
    
    /* 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;
415 416 417 418 419
    int misc_bits;
    
    /**
     * number of bits used for the previously encoded frame
     * encoding: set by lavc
Zdenek Kabelac's avatar
Zdenek Kabelac committed
420
     * decoding: - for audio - bits_per_sample
421
     */
422
    int frame_bits;
423
                 
424 425 426 427 428 429 430
    /**
     * 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
431
    char codec_name[32];
432 433
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
Fabrice Bellard's avatar
Fabrice Bellard committed
434
    unsigned int codec_tag;  /* codec tag, only used if unknown codec */
435
    
436
    /**
437
     * workaround bugs in encoders which sometimes cannot be detected automatically
438 439 440 441
     * encoding: unused
     * decoding: set by user
     */
    int workaround_bugs;
442 443 444 445 446 447
#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
448
#define FF_BUG_QPEL_CHROMA      64
449 450
//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
        
451 452 453 454
    /**
     * encoding: set by user
     * decoding: unused
     */
455
    int luma_elim_threshold;
456 457 458 459 460
    
    /**
     * encoding: set by user
     * decoding: unused
     */
461
    int chroma_elim_threshold;
462 463 464 465 466 467 468 469 470 471
    
    /**
     * strictly follow the std (MPEG4, ...)
     * encoding: set by user
     * decoding: unused
     */
    int strict_std_compliance;
    
    /**
     * qscale offset between ip and b frames
472 473
     * 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)
474 475 476 477 478 479 480 481 482 483 484
     * 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
     */
485
    int error_resilience;
486
    
487 488 489 490
    /**
     * obsolete, just here to keep ABI compatible (should be removed perhaps, dunno)
     */
    int *quant_store;
491

492 493 494 495 496 497
    /**
     * QP store stride
     * encoding: unused
     * decoding: set by lavc
     */
    int qstride;
498 499 500 501 502 503 504 505
    
    /**
     * 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
     */
506
    uint8_t *dr_buffer[3];
507 508 509 510 511 512
    
    /**
     * stride of the luminance part of the dr buffer
     * encoding: unused
     * decoding: set by user
     */
513
    int dr_stride;
514 515 516 517 518 519
    
    /**
     * 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
     */
520
    void *dr_opaque_frame;
521 522 523 524 525 526
    
    /**
     * called at the beginning of each frame to get a buffer for it
     * encoding: unused
     * decoding: set by user
     */
527
    int (*get_buffer_callback)(struct AVCodecContext *c, int width, int height, int pict_type);
Michael Niedermayer's avatar
Michael Niedermayer committed
528

529 530 531 532 533 534 535 536 537 538 539 540
    /**
     * 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
541
    int dr_uvstride;
542 543 544 545 546 547
    
    /**
     * number of dr buffers
     * encoding: unused
     * decoding: set by user
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
548
    int dr_ip_buffer_count;
549
    
Fabrice Bellard's avatar
Fabrice Bellard committed
550
    int block_align; /* used by some WAV based audio codecs */
Michael Niedermayer's avatar
Michael Niedermayer committed
551
    
552 553 554
    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
555
    
556 557 558 559 560 561
    /**
     * 0-> h263 quant 1-> mpeg quant
     * encoding: set by user.
     * decoding: unused
     */
    int mpeg_quant;
Michael Niedermayer's avatar
Michael Niedermayer committed
562
    
563 564 565 566 567
    /**
     * pass1 encoding statistics output buffer
     * encoding: set by lavc
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
568
    char *stats_out; /* encoding statistics output buffer */
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
    
    /**
     * 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
584
    float rc_qsquish;
585

Michael Niedermayer's avatar
Michael Niedermayer committed
586 587
    float rc_qmod_amp;
    int rc_qmod_freq;
588 589 590 591 592 593
    
    /**
     * ratecontrol override, see RcOverride
     * encoding: allocated/set/freed by user.
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
594 595
    RcOverride *rc_override;
    int rc_override_count;
596 597 598 599 600 601
    
    /**
     * rate control equation
     * encoding: set by user
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
602
    char *rc_eq;
603 604 605 606 607 608
    
    /**
     * maximum bitrate
     * encoding: set by user.
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
609
    int rc_max_rate;
610 611 612 613 614 615
    
    /**
     * minimum bitrate
     * encoding: set by user.
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
616
    int rc_min_rate;
617 618 619 620 621 622
    
    /**
     * decoder bitstream buffer size
     * encoding: set by user.
     * decoding: unused
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
623 624
    int rc_buffer_size;
    float rc_buffer_aggressivity;
625 626 627 628 629 630 631 632 633 634

    /**
     * qscale factor between p and i frames
     * encoding: set by user.
     * decoding: unused
     */
    float i_quant_factor;
    
    /**
     * qscale offset between p and i frames
635 636
     * 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)
637 638 639 640 641 642 643 644 645 646
     * 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
647
    float rc_initial_cplx;
648

649
    /**
Michael Niedermayer's avatar
Michael Niedermayer committed
650
     * Obsolete, will be removed
651
     */
652 653 654
    int aspected_width;
    int aspected_height;

655 656 657 658 659
    /**
     * dct algorithm, see FF_DCT_* below
     * encoding: set by user
     * decoding: unused
     */
660
    int dct_algo;
661
#define FF_DCT_AUTO    0
662
#define FF_DCT_FASTINT 1
663 664 665
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
666
#define FF_DCT_ALTIVEC 5
667

668 669 670 671 672 673 674
    /**
     * 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;
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
    
    /**
     * 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;
703

704 705 706 707 708 709
    /**
     * darkness masking (0-> disabled)
     * encoding: set by user
     * decoding: unused
     */
    float dark_masking;
710 711 712 713 714
    
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A')
     * this is used to workaround some encoder bugs
     * encoding: unused
715
     * decoding: set by user, will be converted to upper case by lavc during init
716 717
     */
    int fourcc;
718

719 720 721 722 723 724 725 726 727 728 729 730 731 732
    /**
     * 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
733
#define FF_IDCT_ALTIVEC      8
734

735 736 737 738 739 740 741 742 743 744 745 746 747
    /**
     * 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;

748 749 750 751 752 753 754 755 756
    /**
     * error concealment flags
     * encoding: unused
     * decoding: set by user
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

757 758 759 760 761
    /**
     * QP table of the currently decoded frame
     * encoding; unused
     * decoding: set by lavc
     */
Zdenek Kabelac's avatar
Zdenek Kabelac committed
762
    int8_t *current_qscale_table;
763 764 765 766 767
    /**
     * QP table of the currently displayed frame
     * encoding; unused
     * decoding: set by lavc
     */
Zdenek Kabelac's avatar
Zdenek Kabelac committed
768
    int8_t *display_qscale_table;
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
769 770 771 772 773 774
    /**
     * force specific pict_type.
     * encoding; set by user (I/P/B_TYPE)
     * decoding: unused
     */
    int force_type;
Zdenek Kabelac's avatar
Zdenek Kabelac committed
775 776 777 778 779
    /**
     * 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
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796

    /**
     * bits per sample/pixel from the demuxer (needed for huffyuv)
     * encoding; set by lavc
     * decoding: set by user
     */
     int bits_per_sample;
    
    /**
     * prediction method (needed for huffyuv)
     * encoding; set by user
     * 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
797 798 799 800 801 802 803
    
    /**
     * aspect ratio. (0 if unknown)
     * encoding: set by user.
     * decoding: set by lavc.
     */
    float aspect_ratio;
Fabrice Bellard's avatar
Fabrice Bellard committed
804 805 806
} AVCodecContext;

typedef struct AVCodec {
807
    const char *name;
Fabrice Bellard's avatar
Fabrice Bellard committed
808 809 810 811 812 813
    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
814
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
Fabrice Bellard's avatar
Fabrice Bellard committed
815
                  UINT8 *buf, int buf_size);
Fabrice Bellard's avatar
Fabrice Bellard committed
816
    int capabilities;
Fabrice Bellard's avatar
Fabrice Bellard committed
817 818 819
    struct AVCodec *next;
} AVCodec;

820 821 822 823
/** 
 * four components are given, that's all.
 * the last component is alpha
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
824
typedef struct AVPicture {
825 826
    UINT8 *data[4];
    int linesize[4];
Fabrice Bellard's avatar
Fabrice Bellard committed
827 828 829 830
} AVPicture;

extern AVCodec ac3_encoder;
extern AVCodec mp2_encoder;
831
extern AVCodec mp3lame_encoder;
832
extern AVCodec oggvorbis_encoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
833 834 835 836 837
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
838
extern AVCodec mpeg4_encoder;
839 840 841
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
842 843
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
Michael Niedermayer's avatar
huffyuv  
Michael Niedermayer committed
844
extern AVCodec huffyuv_encoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
845 846

extern AVCodec h263_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
847
extern AVCodec mpeg4_decoder;
848 849 850
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
851
extern AVCodec wmv1_decoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
852
extern AVCodec wmv2_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
853 854 855
extern AVCodec mpeg_decoder;
extern AVCodec h263i_decoder;
extern AVCodec rv10_decoder;
Nick Kurshev's avatar
Nick Kurshev committed
856
extern AVCodec svq1_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
857 858
extern AVCodec dvvideo_decoder;
extern AVCodec dvaudio_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
859 860
extern AVCodec wmav1_decoder;
extern AVCodec wmav2_decoder;
861
extern AVCodec mjpeg_decoder;
862
extern AVCodec mjpegb_decoder;
863
extern AVCodec mp2_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
864
extern AVCodec mp3_decoder;
865 866
extern AVCodec mace3_decoder;
extern AVCodec mace6_decoder;
Michael Niedermayer's avatar
huffyuv  
Michael Niedermayer committed
867
extern AVCodec huffyuv_decoder;
Mark Hills's avatar
Mark Hills committed
868
extern AVCodec oggvorbis_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
869

Fabrice Bellard's avatar
Fabrice Bellard committed
870 871 872
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
873
extern AVCodec name ## _encoder
Fabrice Bellard's avatar
Fabrice Bellard committed
874 875 876 877 878 879 880 881 882 883

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

884 885 886 887 888 889
/* 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
890 891 892
#undef PCM_CODEC

/* dummy raw video codec */
Fabrice Bellard's avatar
Fabrice Bellard committed
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
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);
917 918 919 920 921 922

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
923 924 925 926 927
void img_resample(ImgReSampleContext *s, 
                  AVPicture *output, AVPicture *input);

void img_resample_close(ImgReSampleContext *s);

928 929 930 931 932 933 934 935 936 937 938
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
939 940 941 942 943 944
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

Nick Kurshev's avatar
Nick Kurshev committed
945
/* returns LIBAVCODEC_VERSION_INT constant */
946
unsigned avcodec_version(void);
Nick Kurshev's avatar
Nick Kurshev committed
947
/* returns LIBAVCODEC_BUILD constant */
948
unsigned avcodec_build(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
949 950
void avcodec_init(void);

951 952
void avcodec_set_bit_exact(void);

Fabrice Bellard's avatar
Fabrice Bellard committed
953 954
void register_avcodec(AVCodec *format);
AVCodec *avcodec_find_encoder(enum CodecID id);
955
AVCodec *avcodec_find_encoder_by_name(const char *name);
Fabrice Bellard's avatar
Fabrice Bellard committed
956 957 958 959
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
960
AVCodecContext *avcodec_alloc_context(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
961 962 963 964 965 966 967
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);
968 969 970
int avcodec_parse_frame(AVCodecContext *avctx, UINT8 **pdata, 
                        int *data_size_ptr,
                        UINT8 *buf, int buf_size);
Fabrice Bellard's avatar
Fabrice Bellard committed
971 972 973 974 975 976 977 978
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
979

Michael Niedermayer's avatar
Michael Niedermayer committed
980 981
void avcodec_flush_buffers(AVCodecContext *avctx);

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

1058
/* memory */
1059 1060
void *av_malloc(unsigned int size);
void *av_mallocz(unsigned int size);
1061 1062 1063 1064
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
1065
#endif /* AVCODEC_H */