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