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