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