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