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