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