AVCodec.flush()
[ffmpeg.git] / libavcodec / mpegvideo.h
1 /*
2  * Generic DCT based hybrid video encoder
3  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  */
19
20 /**
21  * @file mpegvideo.h
22  * mpegvideo header.
23  */
24  
25 #ifndef AVCODEC_MPEGVIDEO_H
26 #define AVCODEC_MPEGVIDEO_H
27
28 #include "dsputil.h"
29
30 #define FRAME_SKIPED 100 ///< return value for header parsers if frame is not coded
31
32 enum OutputFormat {
33     FMT_MPEG1,
34     FMT_H263,
35     FMT_MJPEG, 
36     FMT_H264,
37 };
38
39 #define EDGE_WIDTH 16
40
41 #define MPEG_BUF_SIZE (16 * 1024)
42
43 #define QMAT_SHIFT_MMX 16
44 #define QMAT_SHIFT 22
45
46 #define MAX_FCODE 7
47 #define MAX_MV 2048
48
49 #define MAX_PICTURE_COUNT 15
50
51 #define ME_MAP_SIZE 64
52 #define ME_MAP_SHIFT 3
53 #define ME_MAP_MV_BITS 11
54
55 /* run length table */
56 #define MAX_RUN    64
57 #define MAX_LEVEL  64
58
59 #define I_TYPE FF_I_TYPE  ///< Intra
60 #define P_TYPE FF_P_TYPE  ///< Predicted
61 #define B_TYPE FF_B_TYPE  ///< Bi-dir predicted
62 #define S_TYPE FF_S_TYPE  ///< S(GMC)-VOP MPEG4
63 #define SI_TYPE FF_SI_TYPE  ///< Switching Intra
64 #define SP_TYPE FF_SP_TYPE  ///< Switching Predicted
65
66 typedef struct Predictor{
67     double coeff;
68     double count;
69     double decay;
70 } Predictor;
71
72 typedef struct RateControlEntry{
73     int pict_type;
74     float qscale;
75     int mv_bits;
76     int i_tex_bits;
77     int p_tex_bits;
78     int misc_bits;
79     uint64_t expected_bits;
80     int new_pict_type;
81     float new_qscale;
82     int mc_mb_var_sum;
83     int mb_var_sum;
84     int i_count;
85     int f_code;
86     int b_code;
87 }RateControlEntry;
88
89 /**
90  * rate control context.
91  */
92 typedef struct RateControlContext{
93     FILE *stats_file;
94     int num_entries;              ///< number of RateControlEntries 
95     RateControlEntry *entry;
96     int buffer_index;             ///< amount of bits in the video/audio buffer 
97     Predictor pred[5];
98     double short_term_qsum;       ///< sum of recent qscales 
99     double short_term_qcount;     ///< count of recent qscales 
100     double pass1_rc_eq_output_sum;///< sum of the output of the rc equation, this is used for normalization  
101     double pass1_wanted_bits;     ///< bits which should have been outputed by the pass1 code (including complexity init) 
102     double last_qscale;
103     double last_qscale_for[5];    ///< last qscale for a specific pict type, used for max_diff & ipb factor stuff 
104     int last_mc_mb_var_sum;
105     int last_mb_var_sum;
106     uint64_t i_cplx_sum[5];
107     uint64_t p_cplx_sum[5];
108     uint64_t mv_bits_sum[5];
109     uint64_t qscale_sum[5];
110     int frame_count[5];
111     int last_non_b_pict_type;
112 }RateControlContext;
113
114 /**
115  * Scantable.
116  */
117 typedef struct ScanTable{
118     const uint8_t *scantable;
119     uint8_t permutated[64];
120     uint8_t raster_end[64];
121 #ifdef ARCH_POWERPC
122                 /** Used by dct_quantise_alitvec to find last-non-zero */
123     uint8_t __align8 inverse[64];
124 #endif
125 } ScanTable;
126
127 /**
128  * Picture.
129  */
130 typedef struct Picture{
131     FF_COMMON_FRAME
132
133     /**
134      * halfpel luma planes.
135      */
136     uint8_t *interpolated[3];
137     
138     int16_t (*motion_val[2])[2];
139     int8_t *ref_index[2];
140     uint32_t *mb_type_base;
141     uint32_t *mb_type;           ///< mb_type_base + mb_width + 2, note: only used for decoding currently
142 #define MB_TYPE_INTRA4x4   0x0001
143 #define MB_TYPE_INTRA16x16 0x0002 //FIXME h264 specific
144 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME h264 specific
145 #define MB_TYPE_16x16      0x0008
146 #define MB_TYPE_16x8       0x0010
147 #define MB_TYPE_8x16       0x0020
148 #define MB_TYPE_8x8        0x0040
149 #define MB_TYPE_INTERLACED 0x0080
150 #define MB_TYPE_DIRECT2     0x0100 //FIXME
151 #define MB_TYPE_ACPRED     0x0200
152 #define MB_TYPE_GMC        0x0400 //FIXME mpeg4 specific
153 #define MB_TYPE_SKIP       0x0800
154 #define MB_TYPE_P0L0       0x1000
155 #define MB_TYPE_P1L0       0x2000
156 #define MB_TYPE_P0L1       0x4000
157 #define MB_TYPE_P1L1       0x8000
158 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
159 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
160 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
161 #define MB_TYPE_QUANT      0x00010000
162 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 pat, ...)
163
164 #define IS_INTRA4x4(a)   ((a)&MB_TYPE_INTRA4x4)
165 #define IS_INTRA16x16(a) ((a)&MB_TYPE_INTRA16x16)
166 #define IS_PCM(a)        ((a)&MB_TYPE_INTRA_PCM)
167 #define IS_INTRA(a)      ((a)&7)
168 #define IS_INTER(a)      ((a)&(MB_TYPE_16x16|MB_TYPE_16x8|MB_TYPE_8x16|MB_TYPE_8x8))
169 #define IS_SKIP(a)       ((a)&MB_TYPE_SKIP)
170 #define IS_INTRA_PCM(a)  ((a)&MB_TYPE_INTRA_PCM)
171 #define IS_INTERLACED(a) ((a)&MB_TYPE_INTERLACED)
172 #define IS_DIRECT(a)     ((a)&MB_TYPE_DIRECT2)
173 #define IS_GMC(a)        ((a)&MB_TYPE_GMC)
174 #define IS_16X16(a)      ((a)&MB_TYPE_16x16)
175 #define IS_16X8(a)       ((a)&MB_TYPE_16x8)
176 #define IS_8X16(a)       ((a)&MB_TYPE_8x16)
177 #define IS_8X8(a)        ((a)&MB_TYPE_8x8)
178 #define IS_SUB_8X8(a)    ((a)&MB_TYPE_16x16) //note reused
179 #define IS_SUB_8X4(a)    ((a)&MB_TYPE_16x8)  //note reused
180 #define IS_SUB_4X8(a)    ((a)&MB_TYPE_8x16)  //note reused
181 #define IS_SUB_4X4(a)    ((a)&MB_TYPE_8x8)   //note reused
182 #define IS_ACPRED(a)     ((a)&MB_TYPE_ACPRED)
183 #define IS_QUANT(a)      ((a)&MB_TYPE_QUANT)
184 #define IS_DIR(a, part, list) ((a) & (MB_TYPE_P0L0<<((part)+2*(list))))
185 #define USES_LIST(a, list) ((a) & ((MB_TYPE_P0L0|MB_TYPE_P1L0)<<(2*(list)))) ///< does this mb use listX, note doesnt work if subMBs
186
187
188     int field_poc[2];           ///< h264 top/bottom POC
189     int poc;                    ///< h264 frame POC
190     int frame_num;              ///< h264 frame_num
191     int pic_id;                 ///< h264 pic_num or long_term_pic_idx
192     int long_ref;               ///< 1->long term reference 0->short term reference
193
194     int mb_var_sum;             ///< sum of MB variance for current frame 
195     int mc_mb_var_sum;          ///< motion compensated MB variance for current frame 
196     uint16_t *mb_var;           ///< Table for MB variances 
197     uint16_t *mc_mb_var;        ///< Table for motion compensated MB variances 
198     uint8_t *mb_mean;           ///< Table for MB luminance 
199     int32_t *mb_cmp_score;      ///< Table for MB cmp scores, for mb decission 
200     int b_frame_score;          /* */
201 } Picture;
202
203 typedef struct ParseContext{
204     uint8_t *buffer;
205     int index;
206     int last_index;
207     int buffer_size;
208     uint32_t state;             ///< contains the last few bytes in MSB order
209     int frame_start_found;
210     int overread;               ///< the number of bytes which where irreversibly read from the next frame
211     int overread_index;         ///< the index into ParseContext.buffer of the overreaded bytes
212 } ParseContext;
213
214 struct MpegEncContext;
215
216 /**
217  * Motion estimation context.
218  */
219 typedef struct MotionEstContext{
220     int skip;                          ///< set if ME is skiped for the current MB 
221     int co_located_mv[4][2];           ///< mv from last p frame for direct mode ME 
222     int direct_basis_mv[4][2];
223     uint8_t *scratchpad;               ///< data area for the me algo, so that the ME doesnt need to malloc/free 
224     uint32_t *map;                     ///< map to avoid duplicate evaluations 
225     uint32_t *score_map;               ///< map to store the scores 
226     int map_generation;  
227     int pre_penalty_factor;
228     int penalty_factor;
229     int sub_penalty_factor;
230     int mb_penalty_factor;
231     int pre_pass;                      ///< = 1 for the pre pass 
232     int dia_size;
233     uint8_t (*mv_penalty)[MAX_MV*2+1];  ///< amount of bits needed to encode a MV 
234     int (*sub_motion_search)(struct MpegEncContext * s,
235                                   int *mx_ptr, int *my_ptr, int dmin,
236                                   int xmin, int ymin, int xmax, int ymax,
237                                   int pred_x, int pred_y, Picture *ref_picture, 
238                                   int n, int size, uint8_t * const mv_penalty);
239     int (*motion_search[7])(struct MpegEncContext * s, int block,
240                              int *mx_ptr, int *my_ptr,
241                              int P[10][2], int pred_x, int pred_y,
242                              int xmin, int ymin, int xmax, int ymax, Picture *ref_picture, int16_t (*last_mv)[2], 
243                              int ref_mv_scale, uint8_t * const mv_penalty);
244     int (*pre_motion_search)(struct MpegEncContext * s, int block,
245                              int *mx_ptr, int *my_ptr,
246                              int P[10][2], int pred_x, int pred_y,
247                              int xmin, int ymin, int xmax, int ymax, Picture *ref_picture, int16_t (*last_mv)[2], 
248                              int ref_mv_scale, uint8_t * const mv_penalty);
249     int (*get_mb_score)(struct MpegEncContext * s, int mx, int my, int pred_x, int pred_y, Picture *ref_picture, 
250                                   uint8_t * const mv_penalty);
251 }MotionEstContext;
252
253 /**
254  * MpegEncContext.
255  */
256 typedef struct MpegEncContext {
257     struct AVCodecContext *avctx;
258     /* the following parameters must be initialized before encoding */
259     int width, height;///< picture size. must be a multiple of 16 
260     int gop_size;
261     int intra_only;   ///< if true, only intra pictures are generated 
262     int bit_rate;     ///< wanted bit rate 
263     int bit_rate_tolerance; ///< amount of +- bits (>0)
264     enum OutputFormat out_format; ///< output format 
265     int h263_pred;    ///< use mpeg4/h263 ac/dc predictions 
266
267 /* the following codec id fields are deprecated in favor of codec_id */
268     int h263_plus;    ///< h263 plus headers 
269     int h263_rv10;    ///< use RV10 variation for H263 
270     int h263_msmpeg4; ///< generate MSMPEG4 compatible stream (deprecated, use msmpeg4_version instead)
271     int h263_intel;   ///< use I263 intel h263 header 
272     int h263_flv;     ///< use flv h263 header 
273     
274     int codec_id;     /* see CODEC_ID_xxx */
275     int fixed_qscale; ///< fixed qscale if non zero 
276     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0) 
277     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0) 
278     int max_qdiff;    ///< max qscale difference between frames 
279     int encoding;     ///< true if we are encoding (vs decoding) 
280     int flags;        ///< AVCodecContext.flags (HQ, MV4, ...) 
281     int max_b_frames; ///< max number of b-frames for encoding 
282     int b_frame_strategy;
283     int luma_elim_threshold;
284     int chroma_elim_threshold;
285     int strict_std_compliance; ///< strictly follow the std (MPEG4, ...) 
286     int workaround_bugs;       ///< workaround bugs in encoders which cannot be detected automatically 
287     /* the following fields are managed internally by the encoder */
288
289     /** bit output */
290     PutBitContext pb;
291
292     /* sequence parameters */
293     int context_initialized;
294     int input_picture_number;
295     int picture_number;
296     int picture_in_gop_number; ///< 0-> first pic in gop, ... 
297     int b_frames_since_non_b;  ///< used for encoding, relative to not yet reordered input 
298     int mb_width, mb_height;   ///< number of MBs horizontally & vertically 
299     int mb_stride;             ///< mb_width+1 used for some arrays to allow simple addressng of left & top MBs withoutt sig11
300     int h_edge_pos, v_edge_pos;///< horizontal / vertical position of the right/bottom edge (pixel replicateion)
301     int mb_num;                ///< number of MBs of a picture 
302     int linesize;              ///< line size, in bytes, may be different from width 
303     int uvlinesize;            ///< line size, for chroma in bytes, may be different from width 
304     Picture picture[MAX_PICTURE_COUNT]; ///< main picture buffer 
305     Picture *input_picture[MAX_PICTURE_COUNT]; ///< next pictures on display order for encoding
306     Picture *reordered_input_picture[MAX_PICTURE_COUNT]; ///< pointer to the next pictures in codedorder for encoding
307     
308     /** 
309      * copy of the previous picture structure.
310      * note, linesize & data, might not match the previous picture (for field pictures)
311      */
312     Picture last_picture;       
313     
314     /** 
315      * copy of the next picture structure.
316      * note, linesize & data, might not match the next picture (for field pictures)
317      */
318     Picture next_picture;
319     
320     /** 
321      * copy of the source picture structure for encoding.
322      * note, linesize & data, might not match the source picture (for field pictures)
323      */
324     Picture new_picture;
325     
326     /** 
327      * copy of the current picture structure.
328      * note, linesize & data, might not match the current picture (for field pictures)
329      */
330     Picture current_picture;    ///< buffer to store the decompressed current picture 
331     
332     Picture *last_picture_ptr;     ///< pointer to the previous picture.
333     Picture *next_picture_ptr;     ///< pointer to the next picture (for bidir pred) 
334     Picture *new_picture_ptr;      ///< pointer to the source picture for encoding 
335     Picture *current_picture_ptr;  ///< pointer to the current picture
336     int last_dc[3];                ///< last DC values for MPEG1 
337     int16_t *dc_val[3];            ///< used for mpeg4 DC prediction, all 3 arrays must be continuous 
338     int16_t dc_cache[4*5];
339     int y_dc_scale, c_dc_scale;
340     uint8_t *y_dc_scale_table;     ///< qscale -> y_dc_scale table 
341     uint8_t *c_dc_scale_table;     ///< qscale -> c_dc_scale table 
342     uint8_t *coded_block;          ///< used for coded block pattern prediction (msmpeg4v3, wmv1)
343     int16_t (*ac_val[3])[16];      ///< used for for mpeg4 AC prediction, all 3 arrays must be continuous 
344     int ac_pred;
345     uint8_t *prev_pict_types;     ///< previous picture types in bitstream order, used for mb skip 
346 #define PREV_PICT_TYPES_BUFFER_SIZE 256
347     int mb_skiped;                ///< MUST BE SET only during DECODING 
348     uint8_t *mbskip_table;        /**< used to avoid copy if macroblock skipped (for black regions for example) 
349                                    and used for b-frame encoding & decoding (contains skip table of next P Frame) */
350     uint8_t *mbintra_table;       ///< used to avoid setting {ac, dc, cbp}-pred stuff to zero on inter MB decoding 
351     uint8_t *cbp_table;           ///< used to store cbp, ac_pred for partitioned decoding 
352     uint8_t *pred_dir_table;      ///< used to store pred_dir for partitioned decoding 
353     uint8_t *allocated_edge_emu_buffer;
354     uint8_t *edge_emu_buffer;     ///< points into the middle of allocated_edge_emu_buffer  
355
356     int qscale;                 ///< QP 
357     float frame_qscale;         ///< qscale from the frame level rc FIXME remove
358     int adaptive_quant;         ///< use adaptive quantization 
359     int dquant;                 ///< qscale difference to prev qscale  
360     int pict_type;              ///< I_TYPE, P_TYPE, B_TYPE, ... 
361     int last_pict_type;
362     int last_non_b_pict_type;   ///< used for mpeg4 gmc b-frames & ratecontrol 
363     int frame_rate_index;
364     /* motion compensation */
365     int unrestricted_mv;        ///< mv can point outside of the coded picture 
366     int h263_long_vectors;      ///< use horrible h263v1 long vector mode 
367     int decode;                 ///< if 0 then decoding will be skiped (for encoding b frames for example)
368
369     DSPContext dsp;             ///< pointers for accelerated dsp fucntions 
370     int f_code;                 ///< forward MV resolution 
371     int b_code;                 ///< backward MV resolution for B Frames (mpeg4) 
372     int16_t (*motion_val)[2];
373     int16_t (*p_mv_table_base)[2];
374     int16_t (*b_forw_mv_table_base)[2];
375     int16_t (*b_back_mv_table_base)[2];
376     int16_t (*b_bidir_forw_mv_table_base)[2]; 
377     int16_t (*b_bidir_back_mv_table_base)[2]; 
378     int16_t (*b_direct_mv_table_base)[2];
379     int16_t (*p_mv_table)[2];            ///< MV table (1MV per MB) p-frame encoding 
380     int16_t (*b_forw_mv_table)[2];       ///< MV table (1MV per MB) forward mode b-frame encoding 
381     int16_t (*b_back_mv_table)[2];       ///< MV table (1MV per MB) backward mode b-frame encoding 
382     int16_t (*b_bidir_forw_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding 
383     int16_t (*b_bidir_back_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding 
384     int16_t (*b_direct_mv_table)[2];     ///< MV table (1MV per MB) direct mode b-frame encoding 
385     int me_method;                       ///< ME algorithm 
386     int scene_change_score;
387     int mv_dir;
388 #define MV_DIR_BACKWARD  1
389 #define MV_DIR_FORWARD   2
390 #define MV_DIRECT        4 ///< bidirectional mode where the difference equals the MV of the last P/S/I-Frame (mpeg4)
391     int mv_type;
392 #define MV_TYPE_16X16       0   ///< 1 vector for the whole mb 
393 #define MV_TYPE_8X8         1   ///< 4 vectors (h263, mpeg4 4MV) 
394 #define MV_TYPE_16X8        2   ///< 2 vectors, one per 16x8 block  
395 #define MV_TYPE_FIELD       3   ///< 2 vectors, one per field  
396 #define MV_TYPE_DMV         4   ///< 2 vectors, special mpeg2 Dual Prime Vectors 
397     /**motion vectors for a macroblock 
398        first coordinate : 0 = forward 1 = backward
399        second "         : depend on type
400        third  "         : 0 = x, 1 = y
401     */
402     int mv[2][4][2];
403     int field_select[2][2];
404     int last_mv[2][2][2];             ///< last MV, used for MV prediction in MPEG1 & B-frame MPEG4 
405     uint8_t *fcode_tab;               ///< smallest fcode needed for each MV 
406     
407     MotionEstContext me;
408
409     int no_rounding;  /**< apply no rounding to motion compensation (MPEG4, msmpeg4, ...) 
410                         for b-frames rounding mode is allways 0 */
411
412     int hurry_up;     /**< when set to 1 during decoding, b frames will be skiped
413                          when set to 2 idct/dequant will be skipped too */
414                         
415     /* macroblock layer */
416     int mb_x, mb_y;
417     int mb_skip_run;
418     int mb_intra;
419     uint8_t *mb_type;       ///< Table for MB type FIXME remove and use picture->mb_type
420 #define MB_TYPE_INTRA    0x01
421 #define MB_TYPE_INTER    0x02
422 #define MB_TYPE_INTER4V  0x04
423 #define MB_TYPE_SKIPED   0x08
424 //#define MB_TYPE_GMC      0x10
425
426 #define MB_TYPE_DIRECT   0x10
427 #define MB_TYPE_FORWARD  0x20
428 #define MB_TYPE_BACKWARD 0x40
429 #define MB_TYPE_BIDIR    0x80
430
431     int block_index[6]; ///< index to current MB in block based arrays with edges
432     int block_wrap[6];
433     
434     int *mb_index2xy;        ///< mb_index -> mb_x + mb_y*mb_stride
435
436     /** matrix transmitted in the bitstream */
437     uint16_t intra_matrix[64];
438     uint16_t chroma_intra_matrix[64];
439     uint16_t inter_matrix[64];
440     uint16_t chroma_inter_matrix[64];
441 #define QUANT_BIAS_SHIFT 8
442     int intra_quant_bias;    ///< bias for the quantizer 
443     int inter_quant_bias;    ///< bias for the quantizer 
444     int min_qcoeff;          ///< minimum encodable coefficient 
445     int max_qcoeff;          ///< maximum encodable coefficient 
446     int ac_esc_length;       ///< num of bits needed to encode the longest esc 
447     uint8_t *intra_ac_vlc_length;
448     uint8_t *intra_ac_vlc_last_length;
449     uint8_t *inter_ac_vlc_length;
450     uint8_t *inter_ac_vlc_last_length;
451     uint8_t *luma_dc_vlc_length;
452     uint8_t *chroma_dc_vlc_length;
453 #define UNI_AC_ENC_INDEX(run,level) ((run)*128 + (level))
454
455     /** precomputed matrix (combine qscale and DCT renorm) */
456     int __align8 q_intra_matrix[32][64];
457     int __align8 q_inter_matrix[32][64];
458     /** identical to the above but for MMX & these are not permutated */
459     uint16_t __align8 q_intra_matrix16[32][64];
460     uint16_t __align8 q_inter_matrix16[32][64];
461     uint16_t __align8 q_intra_matrix16_bias[32][64];
462     uint16_t __align8 q_inter_matrix16_bias[32][64];
463     int block_last_index[6];  ///< last non zero coefficient in block
464     /* scantables */
465     ScanTable __align8 intra_scantable;
466     ScanTable intra_h_scantable;
467     ScanTable intra_v_scantable;
468     ScanTable inter_scantable; ///< if inter == intra then intra should be used to reduce tha cache usage
469
470     void *opaque;              ///< private data for the user
471
472     /* bit rate control */
473     int I_frame_bits; //FIXME used in mpeg12 ...
474     int64_t wanted_bits;
475     int64_t total_bits;
476     int frame_bits;                ///< bits used for the current frame 
477     RateControlContext rc_context; ///< contains stuff only accessed in ratecontrol.c
478
479     /* statistics, used for 2-pass encoding */
480     int mv_bits;
481     int header_bits;
482     int i_tex_bits;
483     int p_tex_bits;
484     int i_count;
485     int f_count;
486     int b_count;
487     int skip_count;
488     int misc_bits; ///< cbp, mb_type
489     int last_bits; ///< temp var used for calculating the above vars
490     
491     /* error concealment / resync */
492     int error_count;
493     uint8_t *error_status_table;       ///< table of the error status of each MB  
494 #define VP_START            1          ///< current MB is the first after a resync marker 
495 #define AC_ERROR            2
496 #define DC_ERROR            4
497 #define MV_ERROR            8
498 #define AC_END              16
499 #define DC_END              32
500 #define MV_END              64
501 //FIXME some prefix?
502     
503     int resync_mb_x;                 ///< x position of last resync marker 
504     int resync_mb_y;                 ///< y position of last resync marker 
505     GetBitContext last_resync_gb;    ///< used to search for the next resync marker 
506     int mb_num_left;                 ///< number of MBs left in this video packet (for partitioned Slices only)
507     int next_p_frame_damaged;        ///< set if the next p frame is damaged, to avoid showing trashed b frames 
508     int error_resilience;
509     
510     ParseContext parse_context;
511
512     /* H.263 specific */
513     int gob_number;
514     int gob_index;
515         
516     /* H.263+ specific */
517     int umvplus;                    ///< == H263+ && unrestricted_mv 
518     int h263_aic;                   ///< Advanded INTRA Coding (AIC) 
519     int h263_aic_dir;               ///< AIC direction: 0 = left, 1 = top 
520     
521     /* mpeg4 specific */
522     int time_increment_resolution;
523     int time_increment_bits;        ///< number of bits to represent the fractional part of time 
524     int last_time_base;
525     int time_base;                  ///< time in seconds of last I,P,S Frame 
526     int64_t time;                   ///< time of current frame  
527     int64_t last_non_b_time;
528     uint16_t pp_time;               ///< time distance between the last 2 p,s,i frames 
529     uint16_t pb_time;               ///< time distance between the last b and p,s,i frame 
530     uint16_t pp_field_time;
531     uint16_t pb_field_time;         ///< like above, just for interlaced 
532     int shape;
533     int vol_sprite_usage;
534     int sprite_width;
535     int sprite_height;
536     int sprite_left;
537     int sprite_top;
538     int sprite_brightness_change;
539     int num_sprite_warping_points;
540     int real_sprite_warping_points;
541     int sprite_offset[2][2];         ///< sprite offset[isChroma][isMVY] 
542     int sprite_delta[2][2];          ///< sprite_delta [isY][isMVY]  
543     int sprite_shift[2];             ///< sprite shift [isChroma] 
544     int mcsel;
545     int quant_precision;
546     int quarter_sample;              ///< 1->qpel, 0->half pel ME/MC  
547     int scalability;
548     int hierachy_type;
549     int enhancement_type;
550     int new_pred;
551     int reduced_res_vop;
552     int aspect_ratio_info; //FIXME remove
553     int aspected_width;    //FIXME remove
554     int aspected_height;   //FIXME remove
555     int sprite_warping_accuracy;
556     int low_latency_sprite;
557     int data_partitioning;           ///< data partitioning flag from header 
558     int partitioned_frame;           ///< is current frame partitioned 
559     int rvlc;                        ///< reversible vlc 
560     int resync_marker;               ///< could this stream contain resync markers
561     int low_delay;                   ///< no reordering needed / has no b-frames 
562     int vo_type;
563     int vol_control_parameters;      ///< does the stream contain the low_delay flag, used to workaround buggy encoders 
564     PutBitContext tex_pb;            ///< used for data partitioned VOPs 
565     PutBitContext pb2;               ///< used for data partitioned VOPs 
566 #define PB_BUFFER_SIZE 1024*256
567     uint8_t *tex_pb_buffer;          
568     uint8_t *pb2_buffer;
569     int mpeg_quant;
570     int16_t (*field_mv_table)[2][2];   ///< used for interlaced b frame decoding 
571     int8_t (*field_select_table)[2];   ///< wtf, no really another table for interlaced b frames 
572     int t_frame;                       ///< time distance of first I -> B, used for interlaced b frames 
573     int padding_bug_score;             ///< used to detect the VERY common padding bug in MPEG4 
574
575     /* divx specific, used to workaround (many) bugs in divx5 */
576     int divx_version;
577     int divx_build;
578     int divx_packed;
579 #define BITSTREAM_BUFFER_SIZE 1024*256
580     uint8_t *bitstream_buffer; //Divx 5.01 puts several frames in a single one, this is used to reorder them
581     int bitstream_buffer_size;
582     
583     int xvid_build;
584     
585     /* lavc specific stuff, used to workaround bugs in libavcodec */
586     int ffmpeg_version;
587     int lavc_build;
588     
589     /* RV10 specific */
590     int rv10_version; ///< RV10 version: 0 or 3 
591     int rv10_first_dc_coded[3];
592     
593     /* MJPEG specific */
594     struct MJpegContext *mjpeg_ctx;
595     int mjpeg_vsample[3];       ///< vertical sampling factors, default = {2, 1, 1} 
596     int mjpeg_hsample[3];       ///< horizontal sampling factors, default = {2, 1, 1} 
597     int mjpeg_write_tables;     ///< do we want to have quantisation- and huffmantables in the jpeg file ? 
598     int mjpeg_data_only_frames; ///< frames only with SOI, SOS and EOI markers 
599
600     /* MSMPEG4 specific */
601     int mv_table_index;
602     int rl_table_index;
603     int rl_chroma_table_index;
604     int dc_table_index;
605     int use_skip_mb_code;
606     int slice_height;      ///< in macroblocks 
607     int first_slice_line;  ///< used in mpeg4 too to handle resync markers 
608     int flipflop_rounding;
609     int msmpeg4_version;   ///< 0=not msmpeg4, 1=mp41, 2=mp42, 3=mp43/divx3 4=wmv1/7 5=wmv2/8
610     int per_mb_rl_table;
611     int esc3_level_length;
612     int esc3_run_length;
613     /** [mb_intra][isChroma][level][run][last] */
614     int (*ac_stats)[2][MAX_LEVEL+1][MAX_RUN+1][2];
615     int inter_intra_pred;
616     int mspel;
617
618     /* decompression specific */
619     GetBitContext gb;
620
621     /* Mpeg1 specific */
622     int fake_picture_number; ///< picture number at the bitstream frame rate 
623     int gop_picture_number;  ///< index of the first picture of a GOP based on fake_pic_num & mpeg1 specific 
624     int last_mv_dir;         ///< last mv_dir, used for b frame encoding 
625     int broken_link;         ///< no_output_of_prior_pics_flag
626     
627     /* MPEG2 specific - I wish I had not to support this mess. */
628     int progressive_sequence;
629     int mpeg_f_code[2][2];
630     int picture_structure;
631 /* picture type */
632 #define PICT_TOP_FIELD     1
633 #define PICT_BOTTOM_FIELD  2
634 #define PICT_FRAME         3
635
636     int intra_dc_precision;
637     int frame_pred_frame_dct;
638     int top_field_first;
639     int concealment_motion_vectors;
640     int q_scale_type;
641     int intra_vlc_format;
642     int alternate_scan;
643     int repeat_first_field;
644     int chroma_420_type;
645     int progressive_frame;
646     int mpeg2;
647     int full_pel[2];
648     int interlaced_dct;
649     int first_slice;
650     int first_field;
651     
652     /* RTP specific */
653     /* These are explained on avcodec.h */
654     int rtp_mode;
655     int rtp_payload_size;
656     void (*rtp_callback)(void *data, int size, int packet_number);
657     uint8_t *ptr_lastgob;
658     
659     DCTELEM (*block)[64]; ///< points to one of the following blocks 
660     DCTELEM blocks[2][6][64] __align8; // for HQ mode we need to keep the best block
661     int (*decode_mb)(struct MpegEncContext *s, DCTELEM block[6][64]); // used by some codecs to avoid a switch()
662 #define SLICE_OK         0
663 #define SLICE_ERROR     -1
664 #define SLICE_END       -2 //end marker found
665 #define SLICE_NOEND     -3 //no end marker or error found but mb count exceeded
666     
667     void (*dct_unquantize_mpeg1)(struct MpegEncContext *s, 
668                            DCTELEM *block/*align 16*/, int n, int qscale);
669     void (*dct_unquantize_mpeg2)(struct MpegEncContext *s, 
670                            DCTELEM *block/*align 16*/, int n, int qscale);
671     void (*dct_unquantize_h263)(struct MpegEncContext *s, 
672                            DCTELEM *block/*align 16*/, int n, int qscale);
673     void (*dct_unquantize)(struct MpegEncContext *s, // unquantizer to use (mpeg4 can use both)
674                            DCTELEM *block/*align 16*/, int n, int qscale);
675     int (*dct_quantize)(struct MpegEncContext *s, DCTELEM *block/*align 16*/, int n, int qscale, int *overflow);
676     int (*fast_dct_quantize)(struct MpegEncContext *s, DCTELEM *block/*align 16*/, int n, int qscale, int *overflow);
677 } MpegEncContext;
678
679
680 int DCT_common_init(MpegEncContext *s);
681 int MPV_common_init(MpegEncContext *s);
682 void MPV_common_end(MpegEncContext *s);
683 void MPV_decode_mb(MpegEncContext *s, DCTELEM block[6][64]);
684 int MPV_frame_start(MpegEncContext *s, AVCodecContext *avctx);
685 void MPV_frame_end(MpegEncContext *s);
686 int MPV_encode_init(AVCodecContext *avctx);
687 int MPV_encode_end(AVCodecContext *avctx);
688 int MPV_encode_picture(AVCodecContext *avctx, unsigned char *buf, int buf_size, void *data);
689 #ifdef HAVE_MMX
690 void MPV_common_init_mmx(MpegEncContext *s);
691 #endif
692 #ifdef ARCH_ALPHA
693 void MPV_common_init_axp(MpegEncContext *s);
694 #endif
695 #ifdef HAVE_MLIB
696 void MPV_common_init_mlib(MpegEncContext *s);
697 #endif
698 #ifdef HAVE_MMI
699 void MPV_common_init_mmi(MpegEncContext *s);
700 #endif
701 #ifdef ARCH_ARMV4L
702 void MPV_common_init_armv4l(MpegEncContext *s);
703 #endif
704 #ifdef ARCH_POWERPC
705 void MPV_common_init_ppc(MpegEncContext *s);
706 #endif
707 extern void (*draw_edges)(uint8_t *buf, int wrap, int width, int height, int w);
708 void ff_copy_bits(PutBitContext *pb, uint8_t *src, int length);
709 void ff_clean_intra_table_entries(MpegEncContext *s);
710 void ff_init_scantable(uint8_t *, ScanTable *st, const uint8_t *src_scantable);
711 void ff_draw_horiz_band(MpegEncContext *s, int y, int h);
712 void ff_emulated_edge_mc(uint8_t *buf, uint8_t *src, int linesize, int block_w, int block_h, 
713                                     int src_x, int src_y, int w, int h);
714 #define END_NOT_FOUND -100
715 int ff_combine_frame( MpegEncContext *s, int next, uint8_t **buf, int *buf_size);
716 void ff_mpeg_flush(AVCodecContext *avctx);
717 void ff_print_debug_info(MpegEncContext *s, Picture *pict);
718
719 void ff_er_frame_start(MpegEncContext *s);
720 void ff_er_frame_end(MpegEncContext *s);
721 void ff_er_add_slice(MpegEncContext *s, int startx, int starty, int endx, int endy, int status);
722
723
724 extern enum PixelFormat ff_yuv420p_list[2];
725
726 static inline void ff_init_block_index(MpegEncContext *s){
727     s->block_index[0]= s->block_wrap[0]*(s->mb_y*2 + 1) - 1 + s->mb_x*2;
728     s->block_index[1]= s->block_wrap[0]*(s->mb_y*2 + 1)     + s->mb_x*2;
729     s->block_index[2]= s->block_wrap[0]*(s->mb_y*2 + 2) - 1 + s->mb_x*2;
730     s->block_index[3]= s->block_wrap[0]*(s->mb_y*2 + 2)     + s->mb_x*2;
731     s->block_index[4]= s->block_wrap[4]*(s->mb_y + 1)                    + s->block_wrap[0]*(s->mb_height*2 + 2) + s->mb_x;
732     s->block_index[5]= s->block_wrap[4]*(s->mb_y + 1 + s->mb_height + 2) + s->block_wrap[0]*(s->mb_height*2 + 2) + s->mb_x;
733 }
734
735 static inline void ff_update_block_index(MpegEncContext *s){
736     s->block_index[0]+=2;
737     s->block_index[1]+=2;
738     s->block_index[2]+=2;
739     s->block_index[3]+=2;
740     s->block_index[4]++;
741     s->block_index[5]++;
742 }
743
744 static inline int get_bits_diff(MpegEncContext *s){
745     const int bits= get_bit_count(&s->pb);
746     const int last= s->last_bits;
747
748     s->last_bits = bits;
749
750     return bits - last;
751 }
752
753 /* motion_est.c */
754 void ff_estimate_p_frame_motion(MpegEncContext * s,
755                              int mb_x, int mb_y);
756 void ff_estimate_b_frame_motion(MpegEncContext * s,
757                              int mb_x, int mb_y);
758 int ff_get_best_fcode(MpegEncContext * s, int16_t (*mv_table)[2], int type);
759 void ff_fix_long_p_mvs(MpegEncContext * s);
760 void ff_fix_long_b_mvs(MpegEncContext * s, int16_t (*mv_table)[2], int f_code, int type);
761 void ff_init_me(MpegEncContext *s);
762 int ff_pre_estimate_p_frame_motion(MpegEncContext * s, int mb_x, int mb_y);
763
764
765 /* mpeg12.c */
766 extern const int16_t ff_mpeg1_default_intra_matrix[64];
767 extern const int16_t ff_mpeg1_default_non_intra_matrix[64];
768 extern uint8_t ff_mpeg1_dc_scale_table[128];
769
770 void mpeg1_encode_picture_header(MpegEncContext *s, int picture_number);
771 void mpeg1_encode_mb(MpegEncContext *s,
772                      DCTELEM block[6][64],
773                      int motion_x, int motion_y);
774 void ff_mpeg1_encode_init(MpegEncContext *s);
775 void ff_mpeg1_encode_slice_header(MpegEncContext *s);
776 void ff_mpeg1_clean_buffers(MpegEncContext *s);
777
778
779 /** RLTable. */
780 typedef struct RLTable {
781     int n;                         ///< number of entries of table_vlc minus 1 
782     int last;                      ///< number of values for last = 0 
783     const uint16_t (*table_vlc)[2];
784     const int8_t *table_run;
785     const int8_t *table_level;
786     uint8_t *index_run[2];         ///< encoding only 
787     int8_t *max_level[2];          ///< encoding & decoding 
788     int8_t *max_run[2];            ///< encoding & decoding 
789     VLC vlc;                       ///< decoding only deprected FIXME remove
790     RL_VLC_ELEM *rl_vlc[32];       ///< decoding only 
791 } RLTable;
792
793 void init_rl(RLTable *rl);
794 void init_vlc_rl(RLTable *rl);
795
796 static inline int get_rl_index(const RLTable *rl, int last, int run, int level)
797 {
798     int index;
799     index = rl->index_run[last][run];
800     if (index >= rl->n)
801         return rl->n;
802     if (level > rl->max_level[last][run])
803         return rl->n;
804     return index + level - 1;
805 }
806
807 extern uint8_t ff_mpeg4_y_dc_scale_table[32];
808 extern uint8_t ff_mpeg4_c_dc_scale_table[32];
809 extern const int16_t ff_mpeg4_default_intra_matrix[64];
810 extern const int16_t ff_mpeg4_default_non_intra_matrix[64];
811 int ff_h263_decode_init(AVCodecContext *avctx);
812 int ff_h263_decode_frame(AVCodecContext *avctx, 
813                              void *data, int *data_size,
814                              uint8_t *buf, int buf_size);
815 int ff_h263_decode_end(AVCodecContext *avctx);
816 void h263_encode_mb(MpegEncContext *s, 
817                     DCTELEM block[6][64],
818                     int motion_x, int motion_y);
819 void mpeg4_encode_mb(MpegEncContext *s, 
820                     DCTELEM block[6][64],
821                     int motion_x, int motion_y);
822 void h263_encode_picture_header(MpegEncContext *s, int picture_number);
823 void ff_flv_encode_picture_header(MpegEncContext *s, int picture_number);
824 int h263_encode_gob_header(MpegEncContext * s, int mb_line);
825 int16_t *h263_pred_motion(MpegEncContext * s, int block, 
826                         int *px, int *py);
827 void mpeg4_pred_ac(MpegEncContext * s, DCTELEM *block, int n, 
828                    int dir);
829 void ff_set_mpeg4_time(MpegEncContext * s, int picture_number);
830 void mpeg4_encode_picture_header(MpegEncContext *s, int picture_number);
831 void h263_encode_init(MpegEncContext *s);
832 void h263_decode_init_vlc(MpegEncContext *s);
833 int h263_decode_picture_header(MpegEncContext *s);
834 int ff_h263_decode_gob_header(MpegEncContext *s);
835 int ff_mpeg4_decode_picture_header(MpegEncContext * s, GetBitContext *gb);
836
837
838 int intel_h263_decode_picture_header(MpegEncContext *s);
839 int flv_h263_decode_picture_header(MpegEncContext *s);
840 int ff_h263_decode_mb(MpegEncContext *s,
841                       DCTELEM block[6][64]);
842 int h263_get_picture_format(int width, int height);
843 void ff_mpeg4_encode_video_packet_header(MpegEncContext *s);
844 void ff_mpeg4_clean_buffers(MpegEncContext *s);
845 void ff_mpeg4_stuffing(PutBitContext * pbc);
846 void ff_mpeg4_init_partitions(MpegEncContext *s);
847 void ff_mpeg4_merge_partitions(MpegEncContext *s);
848 void ff_clean_mpeg4_qscales(MpegEncContext *s);
849 void ff_clean_h263_qscales(MpegEncContext *s);
850 int ff_mpeg4_decode_partitions(MpegEncContext *s);
851 int ff_mpeg4_get_video_packet_prefix_length(MpegEncContext *s);
852 int ff_h263_resync(MpegEncContext *s);
853 int ff_h263_get_gob_height(MpegEncContext *s);
854 int ff_mpeg4_set_direct_mv(MpegEncContext *s, int mx, int my);
855 inline int ff_h263_round_chroma(int x);
856
857
858 /* rv10.c */
859 void rv10_encode_picture_header(MpegEncContext *s, int picture_number);
860 int rv_decode_dc(MpegEncContext *s, int n);
861
862
863 /* msmpeg4.c */
864 void msmpeg4_encode_picture_header(MpegEncContext * s, int picture_number);
865 void msmpeg4_encode_ext_header(MpegEncContext * s);
866 void msmpeg4_encode_mb(MpegEncContext * s, 
867                        DCTELEM block[6][64],
868                        int motion_x, int motion_y);
869 int msmpeg4_decode_picture_header(MpegEncContext * s);
870 int msmpeg4_decode_ext_header(MpegEncContext * s, int buf_size);
871 int ff_msmpeg4_decode_init(MpegEncContext *s);
872 void ff_msmpeg4_encode_init(MpegEncContext *s);
873 int ff_wmv2_decode_picture_header(MpegEncContext * s);
874 void ff_wmv2_add_mb(MpegEncContext *s, DCTELEM block[6][64], uint8_t *dest_y, uint8_t *dest_cb, uint8_t *dest_cr);
875 void ff_mspel_motion(MpegEncContext *s,
876                                uint8_t *dest_y, uint8_t *dest_cb, uint8_t *dest_cr,
877                                uint8_t **ref_picture, op_pixels_func (*pix_op)[4],
878                                int motion_x, int motion_y, int h);
879 int ff_wmv2_encode_picture_header(MpegEncContext * s, int picture_number);
880 void ff_wmv2_encode_mb(MpegEncContext * s, 
881                        DCTELEM block[6][64],
882                        int motion_x, int motion_y);
883
884 /* mjpeg.c */
885 int mjpeg_init(MpegEncContext *s);
886 void mjpeg_close(MpegEncContext *s);
887 void mjpeg_encode_mb(MpegEncContext *s, 
888                      DCTELEM block[6][64]);
889 void mjpeg_picture_header(MpegEncContext *s);
890 void mjpeg_picture_trailer(MpegEncContext *s);
891
892
893 /* rate control */
894 int ff_rate_control_init(MpegEncContext *s);
895 float ff_rate_estimate_qscale(MpegEncContext *s);
896 void ff_write_pass1_stats(MpegEncContext *s);
897 void ff_rate_control_uninit(MpegEncContext *s);
898 double ff_eval(char *s, double *const_value, const char **const_name,
899                double (**func1)(void *, double), const char **func1_name,
900                double (**func2)(void *, double, double), char **func2_name,
901                void *opaque);
902
903
904 #endif /* AVCODEC_MPEGVIDEO_H */