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