]> git.sesse.net Git - ffmpeg/blob - libavcodec/mpegvideo.h
doxygen: misc consistency, spelling and wording fixes
[ffmpeg] / 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 Libav.
7  *
8  * Libav 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  * Libav 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 Libav; 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
25  * mpegvideo header.
26  */
27
28 #ifndef AVCODEC_MPEGVIDEO_H
29 #define AVCODEC_MPEGVIDEO_H
30
31 #include "avcodec.h"
32 #include "dsputil.h"
33 #include "get_bits.h"
34 #include "put_bits.h"
35 #include "ratecontrol.h"
36 #include "parser.h"
37 #include "mpeg12data.h"
38 #include "rl.h"
39
40 #define FRAME_SKIPPED 100 ///< return value for header parsers if frame is not coded
41
42 enum OutputFormat {
43     FMT_MPEG1,
44     FMT_H261,
45     FMT_H263,
46     FMT_MJPEG,
47     FMT_H264,
48 };
49
50 #define MPEG_BUF_SIZE (16 * 1024)
51
52 #define QMAT_SHIFT_MMX 16
53 #define QMAT_SHIFT 22
54
55 #define MAX_FCODE 7
56 #define MAX_MV 2048
57
58 #define MAX_THREADS 16
59
60 #define MAX_PICTURE_COUNT 32
61
62 #define ME_MAP_SIZE 64
63 #define ME_MAP_SHIFT 3
64 #define ME_MAP_MV_BITS 11
65
66 #define MAX_MB_BYTES (30*16*16*3/8 + 120)
67
68 #define INPLACE_OFFSET 16
69
70 /* Start codes. */
71 #define SEQ_END_CODE            0x000001b7
72 #define SEQ_START_CODE          0x000001b3
73 #define GOP_START_CODE          0x000001b8
74 #define PICTURE_START_CODE      0x00000100
75 #define SLICE_MIN_START_CODE    0x00000101
76 #define SLICE_MAX_START_CODE    0x000001af
77 #define EXT_START_CODE          0x000001b5
78 #define USER_START_CODE         0x000001b2
79
80 struct MpegEncContext;
81
82 /**
83  * Picture.
84  */
85 typedef struct Picture{
86     struct AVFrame f;
87
88     /**
89      * halfpel luma planes.
90      */
91     uint8_t *interpolated[3];
92     int8_t *qscale_table_base;
93     int16_t (*motion_val_base[2])[2];
94     uint32_t *mb_type_base;
95 #define MB_TYPE_INTRA MB_TYPE_INTRA4x4 //default mb_type if there is just one type
96 #define IS_INTRA4x4(a)   ((a)&MB_TYPE_INTRA4x4)
97 #define IS_INTRA16x16(a) ((a)&MB_TYPE_INTRA16x16)
98 #define IS_PCM(a)        ((a)&MB_TYPE_INTRA_PCM)
99 #define IS_INTRA(a)      ((a)&7)
100 #define IS_INTER(a)      ((a)&(MB_TYPE_16x16|MB_TYPE_16x8|MB_TYPE_8x16|MB_TYPE_8x8))
101 #define IS_SKIP(a)       ((a)&MB_TYPE_SKIP)
102 #define IS_INTRA_PCM(a)  ((a)&MB_TYPE_INTRA_PCM)
103 #define IS_INTERLACED(a) ((a)&MB_TYPE_INTERLACED)
104 #define IS_DIRECT(a)     ((a)&MB_TYPE_DIRECT2)
105 #define IS_GMC(a)        ((a)&MB_TYPE_GMC)
106 #define IS_16X16(a)      ((a)&MB_TYPE_16x16)
107 #define IS_16X8(a)       ((a)&MB_TYPE_16x8)
108 #define IS_8X16(a)       ((a)&MB_TYPE_8x16)
109 #define IS_8X8(a)        ((a)&MB_TYPE_8x8)
110 #define IS_SUB_8X8(a)    ((a)&MB_TYPE_16x16) //note reused
111 #define IS_SUB_8X4(a)    ((a)&MB_TYPE_16x8)  //note reused
112 #define IS_SUB_4X8(a)    ((a)&MB_TYPE_8x16)  //note reused
113 #define IS_SUB_4X4(a)    ((a)&MB_TYPE_8x8)   //note reused
114 #define IS_ACPRED(a)     ((a)&MB_TYPE_ACPRED)
115 #define IS_QUANT(a)      ((a)&MB_TYPE_QUANT)
116 #define IS_DIR(a, part, list) ((a) & (MB_TYPE_P0L0<<((part)+2*(list))))
117 #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
118 #define HAS_CBP(a)        ((a)&MB_TYPE_CBP)
119
120     int field_poc[2];           ///< h264 top/bottom POC
121     int poc;                    ///< h264 frame POC
122     int frame_num;              ///< h264 frame_num (raw frame_num from slice header)
123     int mmco_reset;             ///< h264 MMCO_RESET set this 1. Reordering code must not mix pictures before and after MMCO_RESET.
124     int pic_id;                 /**< h264 pic_num (short -> no wrap version of pic_num,
125                                      pic_num & max_pic_num; long -> long_pic_num) */
126     int long_ref;               ///< 1->long term reference 0->short term reference
127     int ref_poc[2][2][16];      ///< h264 POCs of the frames used as reference (FIXME need per slice)
128     int ref_count[2][2];        ///< number of entries in ref_poc              (FIXME need per slice)
129     int mbaff;                  ///< h264 1 -> MBAFF frame 0-> not MBAFF
130     int field_picture;          ///< whether or not the picture was encoded in separate fields
131
132     int mb_var_sum;             ///< sum of MB variance for current frame
133     int mc_mb_var_sum;          ///< motion compensated MB variance for current frame
134     uint16_t *mb_var;           ///< Table for MB variances
135     uint16_t *mc_mb_var;        ///< Table for motion compensated MB variances
136     uint8_t *mb_mean;           ///< Table for MB luminance
137     int32_t *mb_cmp_score;      ///< Table for MB cmp scores, for mb decision FIXME remove
138     int b_frame_score;          /* */
139     struct MpegEncContext *owner2; ///< pointer to the MpegEncContext that allocated this picture
140 } Picture;
141
142 /**
143  * Motion estimation context.
144  */
145 typedef struct MotionEstContext{
146     AVCodecContext *avctx;
147     int skip;                          ///< set if ME is skipped for the current MB
148     int co_located_mv[4][2];           ///< mv from last P-frame for direct mode ME
149     int direct_basis_mv[4][2];
150     uint8_t *scratchpad;               ///< data area for the ME algo, so that the ME does not need to malloc/free
151     uint8_t *best_mb;
152     uint8_t *temp_mb[2];
153     uint8_t *temp;
154     int best_bits;
155     uint32_t *map;                     ///< map to avoid duplicate evaluations
156     uint32_t *score_map;               ///< map to store the scores
157     unsigned map_generation;
158     int pre_penalty_factor;
159     int penalty_factor;                /**< an estimate of the bits required to
160                                         code a given mv value, e.g. (1,0) takes
161                                         more bits than (0,0). We have to
162                                         estimate whether any reduction in
163                                         residual is worth the extra bits. */
164     int sub_penalty_factor;
165     int mb_penalty_factor;
166     int flags;
167     int sub_flags;
168     int mb_flags;
169     int pre_pass;                      ///< = 1 for the pre pass
170     int dia_size;
171     int xmin;
172     int xmax;
173     int ymin;
174     int ymax;
175     int pred_x;
176     int pred_y;
177     uint8_t *src[4][4];
178     uint8_t *ref[4][4];
179     int stride;
180     int uvstride;
181     /* temp variables for picture complexity calculation */
182     int mc_mb_var_sum_temp;
183     int mb_var_sum_temp;
184     int scene_change_score;
185 /*    cmp, chroma_cmp;*/
186     op_pixels_func (*hpel_put)[4];
187     op_pixels_func (*hpel_avg)[4];
188     qpel_mc_func (*qpel_put)[16];
189     qpel_mc_func (*qpel_avg)[16];
190     uint8_t (*mv_penalty)[MAX_MV*2+1];  ///< amount of bits needed to encode a MV
191     uint8_t *current_mv_penalty;
192     int (*sub_motion_search)(struct MpegEncContext * s,
193                                   int *mx_ptr, int *my_ptr, int dmin,
194                                   int src_index, int ref_index,
195                                   int size, int h);
196 }MotionEstContext;
197
198 /**
199  * MpegEncContext.
200  */
201 typedef struct MpegEncContext {
202     AVClass *class;
203     struct AVCodecContext *avctx;
204     /* the following parameters must be initialized before encoding */
205     int width, height;///< picture size. must be a multiple of 16
206     int gop_size;
207     int intra_only;   ///< if true, only intra pictures are generated
208     int bit_rate;     ///< wanted bit rate
209     enum OutputFormat out_format; ///< output format
210     int h263_pred;    ///< use mpeg4/h263 ac/dc predictions
211     int pb_frame;     ///< PB frame mode (0 = none, 1 = base, 2 = improved)
212
213 /* the following codec id fields are deprecated in favor of codec_id */
214     int h263_plus;    ///< h263 plus headers
215     int h263_flv;     ///< use flv h263 header
216
217     enum CodecID codec_id;     /* see CODEC_ID_xxx */
218     int fixed_qscale; ///< fixed qscale if non zero
219     int encoding;     ///< true if we are encoding (vs decoding)
220     int flags;        ///< AVCodecContext.flags (HQ, MV4, ...)
221     int flags2;       ///< AVCodecContext.flags2
222     int max_b_frames; ///< max number of b-frames for encoding
223     int luma_elim_threshold;
224     int chroma_elim_threshold;
225     int strict_std_compliance; ///< strictly follow the std (MPEG4, ...)
226     int workaround_bugs;       ///< workaround bugs in encoders which cannot be detected automatically
227     int codec_tag;             ///< internal codec_tag upper case converted from avctx codec_tag
228     int stream_codec_tag;      ///< internal stream_codec_tag upper case converted from avctx stream_codec_tag
229     /* the following fields are managed internally by the encoder */
230
231     /* sequence parameters */
232     int context_initialized;
233     int input_picture_number;  ///< used to set pic->display_picture_number, should not be used for/by anything else
234     int coded_picture_number;  ///< used to set pic->coded_picture_number, should not be used for/by anything else
235     int picture_number;       //FIXME remove, unclear definition
236     int picture_in_gop_number; ///< 0-> first pic in gop, ...
237     int mb_width, mb_height;   ///< number of MBs horizontally & vertically
238     int mb_stride;             ///< mb_width+1 used for some arrays to allow simple addressing of left & top MBs without sig11
239     int b8_stride;             ///< 2*mb_width+1 used for some 8x8 block arrays to allow simple addressing
240     int b4_stride;             ///< 4*mb_width+1 used for some 4x4 block arrays to allow simple addressing
241     int h_edge_pos, v_edge_pos;///< horizontal / vertical position of the right/bottom edge (pixel replication)
242     int mb_num;                ///< number of MBs of a picture
243     int linesize;              ///< line size, in bytes, may be different from width
244     int uvlinesize;            ///< line size, for chroma in bytes, may be different from width
245     Picture *picture;          ///< main picture buffer
246     Picture **input_picture;   ///< next pictures on display order for encoding
247     Picture **reordered_input_picture; ///< pointer to the next pictures in codedorder for encoding
248
249     int y_dc_scale, c_dc_scale;
250     int ac_pred;
251     int block_last_index[12];  ///< last non zero coefficient in block
252     int h263_aic;              ///< Advanded INTRA Coding (AIC)
253
254     /* scantables */
255     ScanTable inter_scantable; ///< if inter == intra then intra should be used to reduce tha cache usage
256     ScanTable intra_scantable;
257     ScanTable intra_h_scantable;
258     ScanTable intra_v_scantable;
259
260     /* WARNING: changes above this line require updates to hardcoded
261      *          offsets used in asm. */
262
263     int64_t user_specified_pts;///< last non zero pts from AVFrame which was passed into avcodec_encode_video()
264
265     /** bit output */
266     PutBitContext pb;
267
268     int start_mb_y;            ///< start mb_y of this thread (so current thread should process start_mb_y <= row < end_mb_y)
269     int end_mb_y;              ///< end   mb_y of this thread (so current thread should process start_mb_y <= row < end_mb_y)
270     struct MpegEncContext *thread_context[MAX_THREADS];
271
272     /**
273      * copy of the previous picture structure.
274      * note, linesize & data, might not match the previous picture (for field pictures)
275      */
276     Picture last_picture;
277
278     /**
279      * copy of the next picture structure.
280      * note, linesize & data, might not match the next picture (for field pictures)
281      */
282     Picture next_picture;
283
284     /**
285      * copy of the source picture structure for encoding.
286      * note, linesize & data, might not match the source picture (for field pictures)
287      */
288     Picture new_picture;
289
290     /**
291      * copy of the current picture structure.
292      * note, linesize & data, might not match the current picture (for field pictures)
293      */
294     Picture current_picture;    ///< buffer to store the decompressed current picture
295
296     Picture *last_picture_ptr;     ///< pointer to the previous picture.
297     Picture *next_picture_ptr;     ///< pointer to the next picture (for bidir pred)
298     Picture *current_picture_ptr;  ///< pointer to the current picture
299     int picture_count;             ///< number of allocated pictures (MAX_PICTURE_COUNT * avctx->thread_count)
300     int picture_range_start, picture_range_end; ///< the part of picture that this context can allocate in
301     uint8_t *visualization_buffer[3]; ///< temporary buffer vor MV visualization
302     int last_dc[3];                ///< last DC values for MPEG1
303     int16_t *dc_val_base;
304     int16_t *dc_val[3];            ///< used for mpeg4 DC prediction, all 3 arrays must be continuous
305     const uint8_t *y_dc_scale_table;     ///< qscale -> y_dc_scale table
306     const uint8_t *c_dc_scale_table;     ///< qscale -> c_dc_scale table
307     const uint8_t *chroma_qscale_table;  ///< qscale -> chroma_qscale (h263)
308     uint8_t *coded_block_base;
309     uint8_t *coded_block;          ///< used for coded block pattern prediction (msmpeg4v3, wmv1)
310     int16_t (*ac_val_base)[16];
311     int16_t (*ac_val[3])[16];      ///< used for for mpeg4 AC prediction, all 3 arrays must be continuous
312     uint8_t *prev_pict_types;     ///< previous picture types in bitstream order, used for mb skip
313 #define PREV_PICT_TYPES_BUFFER_SIZE 256
314     int mb_skipped;                ///< MUST BE SET only during DECODING
315     uint8_t *mbskip_table;        /**< used to avoid copy if macroblock skipped (for black regions for example)
316                                    and used for b-frame encoding & decoding (contains skip table of next P Frame) */
317     uint8_t *mbintra_table;       ///< used to avoid setting {ac, dc, cbp}-pred stuff to zero on inter MB decoding
318     uint8_t *cbp_table;           ///< used to store cbp, ac_pred for partitioned decoding
319     uint8_t *pred_dir_table;      ///< used to store pred_dir for partitioned decoding
320     uint8_t *edge_emu_buffer;     ///< temporary buffer for if MVs point to out-of-frame data
321     uint8_t *rd_scratchpad;       ///< scratchpad for rate distortion mb decision
322     uint8_t *obmc_scratchpad;
323     uint8_t *b_scratchpad;        ///< scratchpad used for writing into write only buffers
324
325     int qscale;                 ///< QP
326     int chroma_qscale;          ///< chroma QP
327     unsigned int lambda;        ///< lagrange multipler used in rate distortion
328     unsigned int lambda2;       ///< (lambda*lambda) >> FF_LAMBDA_SHIFT
329     int *lambda_table;
330     int adaptive_quant;         ///< use adaptive quantization
331     int dquant;                 ///< qscale difference to prev qscale
332     int pict_type;              ///< AV_PICTURE_TYPE_I, AV_PICTURE_TYPE_P, AV_PICTURE_TYPE_B, ...
333     int last_pict_type; //FIXME removes
334     int last_non_b_pict_type;   ///< used for mpeg4 gmc b-frames & ratecontrol
335     int dropable;
336     int frame_rate_index;
337     int last_lambda_for[5];     ///< last lambda for a specific pict type
338     int skipdct;                ///< skip dct and code zero residual
339
340     /* motion compensation */
341     int unrestricted_mv;        ///< mv can point outside of the coded picture
342     int h263_long_vectors;      ///< use horrible h263v1 long vector mode
343
344     DSPContext dsp;             ///< pointers for accelerated dsp functions
345     int f_code;                 ///< forward MV resolution
346     int b_code;                 ///< backward MV resolution for B Frames (mpeg4)
347     int16_t (*p_mv_table_base)[2];
348     int16_t (*b_forw_mv_table_base)[2];
349     int16_t (*b_back_mv_table_base)[2];
350     int16_t (*b_bidir_forw_mv_table_base)[2];
351     int16_t (*b_bidir_back_mv_table_base)[2];
352     int16_t (*b_direct_mv_table_base)[2];
353     int16_t (*p_field_mv_table_base[2][2])[2];
354     int16_t (*b_field_mv_table_base[2][2][2])[2];
355     int16_t (*p_mv_table)[2];            ///< MV table (1MV per MB) p-frame encoding
356     int16_t (*b_forw_mv_table)[2];       ///< MV table (1MV per MB) forward mode b-frame encoding
357     int16_t (*b_back_mv_table)[2];       ///< MV table (1MV per MB) backward mode b-frame encoding
358     int16_t (*b_bidir_forw_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding
359     int16_t (*b_bidir_back_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding
360     int16_t (*b_direct_mv_table)[2];     ///< MV table (1MV per MB) direct mode b-frame encoding
361     int16_t (*p_field_mv_table[2][2])[2];   ///< MV table (2MV per MB) interlaced p-frame encoding
362     int16_t (*b_field_mv_table[2][2][2])[2];///< MV table (4MV per MB) interlaced b-frame encoding
363     uint8_t (*p_field_select_table[2]);
364     uint8_t (*b_field_select_table[2][2]);
365     int me_method;                       ///< ME algorithm
366     int mv_dir;
367 #define MV_DIR_FORWARD   1
368 #define MV_DIR_BACKWARD  2
369 #define MV_DIRECT        4 ///< bidirectional mode where the difference equals the MV of the last P/S/I-Frame (mpeg4)
370     int mv_type;
371 #define MV_TYPE_16X16       0   ///< 1 vector for the whole mb
372 #define MV_TYPE_8X8         1   ///< 4 vectors (h263, mpeg4 4MV)
373 #define MV_TYPE_16X8        2   ///< 2 vectors, one per 16x8 block
374 #define MV_TYPE_FIELD       3   ///< 2 vectors, one per field
375 #define MV_TYPE_DMV         4   ///< 2 vectors, special mpeg2 Dual Prime Vectors
376     /**motion vectors for a macroblock
377        first coordinate : 0 = forward 1 = backward
378        second "         : depend on type
379        third  "         : 0 = x, 1 = y
380     */
381     int mv[2][4][2];
382     int field_select[2][2];
383     int last_mv[2][2][2];             ///< last MV, used for MV prediction in MPEG1 & B-frame MPEG4
384     uint8_t *fcode_tab;               ///< smallest fcode needed for each MV
385     int16_t direct_scale_mv[2][64];   ///< precomputed to avoid divisions in ff_mpeg4_set_direct_mv
386
387     MotionEstContext me;
388
389     int no_rounding;  /**< apply no rounding to motion compensation (MPEG4, msmpeg4, ...)
390                         for b-frames rounding mode is always 0 */
391
392     /* macroblock layer */
393     int mb_x, mb_y;
394     int mb_skip_run;
395     int mb_intra;
396     uint16_t *mb_type;           ///< Table for candidate MB types for encoding
397 #define CANDIDATE_MB_TYPE_INTRA    0x01
398 #define CANDIDATE_MB_TYPE_INTER    0x02
399 #define CANDIDATE_MB_TYPE_INTER4V  0x04
400 #define CANDIDATE_MB_TYPE_SKIPPED   0x08
401 //#define MB_TYPE_GMC      0x10
402
403 #define CANDIDATE_MB_TYPE_DIRECT   0x10
404 #define CANDIDATE_MB_TYPE_FORWARD  0x20
405 #define CANDIDATE_MB_TYPE_BACKWARD 0x40
406 #define CANDIDATE_MB_TYPE_BIDIR    0x80
407
408 #define CANDIDATE_MB_TYPE_INTER_I    0x100
409 #define CANDIDATE_MB_TYPE_FORWARD_I  0x200
410 #define CANDIDATE_MB_TYPE_BACKWARD_I 0x400
411 #define CANDIDATE_MB_TYPE_BIDIR_I    0x800
412
413 #define CANDIDATE_MB_TYPE_DIRECT0    0x1000
414
415     int block_index[6]; ///< index to current MB in block based arrays with edges
416     int block_wrap[6];
417     uint8_t *dest[3];
418
419     int *mb_index2xy;        ///< mb_index -> mb_x + mb_y*mb_stride
420
421     /** matrix transmitted in the bitstream */
422     uint16_t intra_matrix[64];
423     uint16_t chroma_intra_matrix[64];
424     uint16_t inter_matrix[64];
425     uint16_t chroma_inter_matrix[64];
426 #define QUANT_BIAS_SHIFT 8
427     int intra_quant_bias;    ///< bias for the quantizer
428     int inter_quant_bias;    ///< bias for the quantizer
429     int min_qcoeff;          ///< minimum encodable coefficient
430     int max_qcoeff;          ///< maximum encodable coefficient
431     int ac_esc_length;       ///< num of bits needed to encode the longest esc
432     uint8_t *intra_ac_vlc_length;
433     uint8_t *intra_ac_vlc_last_length;
434     uint8_t *inter_ac_vlc_length;
435     uint8_t *inter_ac_vlc_last_length;
436     uint8_t *luma_dc_vlc_length;
437 #define UNI_AC_ENC_INDEX(run,level) ((run)*128 + (level))
438
439     int coded_score[8];
440
441     /** precomputed matrix (combine qscale and DCT renorm) */
442     int (*q_intra_matrix)[64];
443     int (*q_inter_matrix)[64];
444     /** identical to the above but for MMX & these are not permutated, second 64 entries are bias*/
445     uint16_t (*q_intra_matrix16)[2][64];
446     uint16_t (*q_inter_matrix16)[2][64];
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 total_bits;
457     int frame_bits;                ///< bits used for the current frame
458     int next_lambda;               ///< next lambda used for retrying to encode a frame
459     RateControlContext rc_context; ///< contains stuff only accessed in ratecontrol.c
460
461     /* statistics, used for 2-pass encoding */
462     int mv_bits;
463     int header_bits;
464     int i_tex_bits;
465     int p_tex_bits;
466     int i_count;
467     int f_count;
468     int b_count;
469     int skip_count;
470     int misc_bits; ///< cbp, mb_type
471     int last_bits; ///< temp var used for calculating the above vars
472
473     /* error concealment / resync */
474     int error_count, error_occurred;
475     uint8_t *error_status_table;       ///< table of the error status of each MB
476 #define VP_START            1          ///< current MB is the first after a resync marker
477 #define AC_ERROR            2
478 #define DC_ERROR            4
479 #define MV_ERROR            8
480 #define AC_END              16
481 #define DC_END              32
482 #define MV_END              64
483 //FIXME some prefix?
484
485     int resync_mb_x;                 ///< x position of last resync marker
486     int resync_mb_y;                 ///< y position of last resync marker
487     GetBitContext last_resync_gb;    ///< used to search for the next resync marker
488     int mb_num_left;                 ///< number of MBs left in this video packet (for partitioned Slices only)
489     int next_p_frame_damaged;        ///< set if the next p frame is damaged, to avoid showing trashed b frames
490     int err_recognition;
491
492     ParseContext parse_context;
493
494     /* H.263 specific */
495     int gob_index;
496     int obmc;                       ///< overlapped block motion compensation
497     int showed_packed_warning;      ///< flag for having shown the warning about divxs invalid b frames
498
499     /* H.263+ specific */
500     int umvplus;                    ///< == H263+ && unrestricted_mv
501     int h263_aic_dir;               ///< AIC direction: 0 = left, 1 = top
502     int h263_slice_structured;
503     int alt_inter_vlc;              ///< alternative inter vlc
504     int modified_quant;
505     int loop_filter;
506     int custom_pcf;
507
508     /* mpeg4 specific */
509     int time_increment_bits;        ///< number of bits to represent the fractional part of time
510     int last_time_base;
511     int time_base;                  ///< time in seconds of last I,P,S Frame
512     int64_t time;                   ///< time of current frame
513     int64_t last_non_b_time;
514     uint16_t pp_time;               ///< time distance between the last 2 p,s,i frames
515     uint16_t pb_time;               ///< time distance between the last b and p,s,i frame
516     uint16_t pp_field_time;
517     uint16_t pb_field_time;         ///< like above, just for interlaced
518     int shape;
519     int vol_sprite_usage;
520     int sprite_width;
521     int sprite_height;
522     int sprite_left;
523     int sprite_top;
524     int sprite_brightness_change;
525     int num_sprite_warping_points;
526     int real_sprite_warping_points;
527     uint16_t sprite_traj[4][2];      ///< sprite trajectory 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     int cplx_estimation_trash_i;
557     int cplx_estimation_trash_p;
558     int cplx_estimation_trash_b;
559
560     /* divx specific, used to workaround (many) bugs in divx5 */
561     int divx_version;
562     int divx_build;
563     int divx_packed;
564     uint8_t *bitstream_buffer; //Divx 5.01 puts several frames in a single one, this is used to reorder them
565     int bitstream_buffer_size;
566     unsigned int allocated_bitstream_buffer_size;
567
568     int xvid_build;
569
570     /* lavc specific stuff, used to workaround bugs in libavcodec */
571     int lavc_build;
572
573     /* RV10 specific */
574     int rv10_version; ///< RV10 version: 0 or 3
575     int rv10_first_dc_coded[3];
576     int orig_width, orig_height;
577
578     /* MJPEG specific */
579     struct MJpegContext *mjpeg_ctx;
580     int mjpeg_vsample[3];       ///< vertical sampling factors, default = {2, 1, 1}
581     int mjpeg_hsample[3];       ///< horizontal sampling factors, default = {2, 1, 1}
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     /* MPEG-2-specific - I wished not to have 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     int drop_frame_timecode; ///< timecode is in drop frame format.
641     int scan_offset;         ///< reserve space for SVCD scan offset user data.
642
643     /* RTP specific */
644     int rtp_mode;
645
646     uint8_t *ptr_lastgob;
647     int swap_uv;             //vcr2 codec is an MPEG-2 variant with U and V swapped
648     DCTELEM (*pblocks[12])[64];
649
650     DCTELEM (*block)[64]; ///< points to one of the following blocks
651     DCTELEM (*blocks)[8][64]; // for HQ mode we need to keep the best block
652     int (*decode_mb)(struct MpegEncContext *s, DCTELEM block[6][64]); // used by some codecs to avoid a switch()
653 #define SLICE_OK         0
654 #define SLICE_ERROR     -1
655 #define SLICE_END       -2 ///<end marker found
656 #define SLICE_NOEND     -3 ///<no end marker or error found but mb count exceeded
657
658     void (*dct_unquantize_mpeg1_intra)(struct MpegEncContext *s,
659                            DCTELEM *block/*align 16*/, int n, int qscale);
660     void (*dct_unquantize_mpeg1_inter)(struct MpegEncContext *s,
661                            DCTELEM *block/*align 16*/, int n, int qscale);
662     void (*dct_unquantize_mpeg2_intra)(struct MpegEncContext *s,
663                            DCTELEM *block/*align 16*/, int n, int qscale);
664     void (*dct_unquantize_mpeg2_inter)(struct MpegEncContext *s,
665                            DCTELEM *block/*align 16*/, int n, int qscale);
666     void (*dct_unquantize_h263_intra)(struct MpegEncContext *s,
667                            DCTELEM *block/*align 16*/, int n, int qscale);
668     void (*dct_unquantize_h263_inter)(struct MpegEncContext *s,
669                            DCTELEM *block/*align 16*/, int n, int qscale);
670     void (*dct_unquantize_h261_intra)(struct MpegEncContext *s,
671                            DCTELEM *block/*align 16*/, int n, int qscale);
672     void (*dct_unquantize_h261_inter)(struct MpegEncContext *s,
673                            DCTELEM *block/*align 16*/, int n, int qscale);
674     void (*dct_unquantize_intra)(struct MpegEncContext *s, // unquantizer to use (mpeg4 can use both)
675                            DCTELEM *block/*align 16*/, int n, int qscale);
676     void (*dct_unquantize_inter)(struct MpegEncContext *s, // unquantizer to use (mpeg4 can use both)
677                            DCTELEM *block/*align 16*/, int n, int qscale);
678     int (*dct_quantize)(struct MpegEncContext *s, DCTELEM *block/*align 16*/, int n, int qscale, int *overflow);
679     int (*fast_dct_quantize)(struct MpegEncContext *s, DCTELEM *block/*align 16*/, int n, int qscale, int *overflow);
680     void (*denoise_dct)(struct MpegEncContext *s, DCTELEM *block);
681 } MpegEncContext;
682
683 #define REBASE_PICTURE(pic, new_ctx, old_ctx) (pic ? \
684     (pic >= old_ctx->picture && pic < old_ctx->picture+old_ctx->picture_count ?\
685         &new_ctx->picture[pic - old_ctx->picture] : pic - (Picture*)old_ctx + (Picture*)new_ctx)\
686     : NULL)
687
688 void MPV_decode_defaults(MpegEncContext *s);
689 int MPV_common_init(MpegEncContext *s);
690 void MPV_common_end(MpegEncContext *s);
691 void MPV_decode_mb(MpegEncContext *s, DCTELEM block[12][64]);
692 int MPV_frame_start(MpegEncContext *s, AVCodecContext *avctx);
693 void MPV_frame_end(MpegEncContext *s);
694 int MPV_encode_init(AVCodecContext *avctx);
695 int MPV_encode_end(AVCodecContext *avctx);
696 int MPV_encode_picture(AVCodecContext *avctx, unsigned char *buf, int buf_size, void *data);
697 void MPV_common_init_mmx(MpegEncContext *s);
698 void MPV_common_init_axp(MpegEncContext *s);
699 void MPV_common_init_mlib(MpegEncContext *s);
700 void MPV_common_init_mmi(MpegEncContext *s);
701 void MPV_common_init_arm(MpegEncContext *s);
702 void MPV_common_init_altivec(MpegEncContext *s);
703 void MPV_common_init_bfin(MpegEncContext *s);
704 void ff_clean_intra_table_entries(MpegEncContext *s);
705 void ff_draw_horiz_band(MpegEncContext *s, int y, int h);
706 void ff_mpeg_flush(AVCodecContext *avctx);
707 void ff_print_debug_info(MpegEncContext *s, AVFrame *pict);
708 void ff_write_quant_matrix(PutBitContext *pb, uint16_t *matrix);
709 void ff_release_unused_pictures(MpegEncContext *s, int remove_current);
710 int ff_find_unused_picture(MpegEncContext *s, int shared);
711 void ff_denoise_dct(MpegEncContext *s, DCTELEM *block);
712 void ff_update_duplicate_context(MpegEncContext *dst, MpegEncContext *src);
713 int MPV_lowest_referenced_row(MpegEncContext *s, int dir);
714 void MPV_report_decode_progress(MpegEncContext *s);
715 int ff_mpeg_update_thread_context(AVCodecContext *dst, const AVCodecContext *src);
716 const uint8_t *avpriv_mpv_find_start_code(const uint8_t *p, const uint8_t *end, uint32_t *state);
717 void ff_set_qscale(MpegEncContext * s, int qscale);
718
719 void ff_er_frame_start(MpegEncContext *s);
720 void ff_er_frame_end(MpegEncContext *s);
721 void ff_er_add_slice(MpegEncContext *s, int startx, int starty, int endx, int endy, int status);
722
723 int ff_dct_common_init(MpegEncContext *s);
724 void ff_convert_matrix(DSPContext *dsp, int (*qmat)[64], uint16_t (*qmat16)[2][64],
725                        const uint16_t *quant_matrix, int bias, int qmin, int qmax, int intra);
726
727 void ff_init_block_index(MpegEncContext *s);
728 void ff_copy_picture(Picture *dst, Picture *src);
729
730 /**
731  * Allocate a Picture.
732  * The pixels are allocated/set by calling get_buffer() if shared = 0.
733  */
734 int ff_alloc_picture(MpegEncContext *s, Picture *pic, int shared);
735
736 extern const enum PixelFormat ff_pixfmt_list_420[];
737 extern const enum PixelFormat ff_hwaccel_pixfmt_list_420[];
738
739 static inline void ff_update_block_index(MpegEncContext *s){
740     const int block_size= 8>>s->avctx->lowres;
741
742     s->block_index[0]+=2;
743     s->block_index[1]+=2;
744     s->block_index[2]+=2;
745     s->block_index[3]+=2;
746     s->block_index[4]++;
747     s->block_index[5]++;
748     s->dest[0]+= 2*block_size;
749     s->dest[1]+= block_size;
750     s->dest[2]+= block_size;
751 }
752
753 static inline int get_bits_diff(MpegEncContext *s){
754     const int bits= put_bits_count(&s->pb);
755     const int last= s->last_bits;
756
757     s->last_bits = bits;
758
759     return bits - last;
760 }
761
762 static inline int ff_h263_round_chroma(int x){
763     static const uint8_t h263_chroma_roundtab[16] = {
764     //  0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15
765         0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1,
766     };
767     return h263_chroma_roundtab[x & 0xf] + (x >> 3);
768 }
769
770 /* motion_est.c */
771 void ff_estimate_p_frame_motion(MpegEncContext * s,
772                              int mb_x, int mb_y);
773 void ff_estimate_b_frame_motion(MpegEncContext * s,
774                              int mb_x, int mb_y);
775 int ff_get_best_fcode(MpegEncContext * s, int16_t (*mv_table)[2], int type);
776 void ff_fix_long_p_mvs(MpegEncContext * s);
777 void ff_fix_long_mvs(MpegEncContext * s, uint8_t *field_select_table, int field_select,
778                      int16_t (*mv_table)[2], int f_code, int type, int truncate);
779 int ff_init_me(MpegEncContext *s);
780 int ff_pre_estimate_p_frame_motion(MpegEncContext * s, int mb_x, int mb_y);
781 int ff_epzs_motion_search(MpegEncContext * s, int *mx_ptr, int *my_ptr,
782                              int P[10][2], int src_index, int ref_index, int16_t (*last_mv)[2],
783                              int ref_mv_scale, int size, int h);
784 int ff_get_mb_score(MpegEncContext * s, int mx, int my, int src_index,
785                                int ref_index, int size, int h, int add_rate);
786
787 /* mpeg12.c */
788 extern const uint8_t ff_mpeg1_dc_scale_table[128];
789 extern const uint8_t * const ff_mpeg2_dc_scale_table[4];
790
791 void mpeg1_encode_picture_header(MpegEncContext *s, int picture_number);
792 void mpeg1_encode_mb(MpegEncContext *s,
793                      DCTELEM block[6][64],
794                      int motion_x, int motion_y);
795 void ff_mpeg1_encode_init(MpegEncContext *s);
796 void ff_mpeg1_encode_slice_header(MpegEncContext *s);
797 void ff_mpeg1_clean_buffers(MpegEncContext *s);
798 int ff_mpeg1_find_frame_end(ParseContext *pc, const uint8_t *buf, int buf_size, AVCodecParserContext *s);
799
800 extern const uint8_t ff_aic_dc_scale_table[32];
801 extern const uint8_t ff_h263_chroma_qscale_table[32];
802 extern const uint8_t ff_h263_loop_filter_strength[32];
803
804 /* h261.c */
805 void ff_h261_loop_filter(MpegEncContext *s);
806 void ff_h261_reorder_mb_index(MpegEncContext* s);
807 void ff_h261_encode_mb(MpegEncContext *s,
808                     DCTELEM block[6][64],
809                     int motion_x, int motion_y);
810 void ff_h261_encode_picture_header(MpegEncContext * s, int picture_number);
811 void ff_h261_encode_init(MpegEncContext *s);
812 int ff_h261_get_picture_format(int width, int height);
813
814
815 /* rv10.c */
816 void rv10_encode_picture_header(MpegEncContext *s, int picture_number);
817 int rv_decode_dc(MpegEncContext *s, int n);
818 void rv20_encode_picture_header(MpegEncContext *s, int picture_number);
819
820
821 /* msmpeg4.c */
822 void msmpeg4_encode_picture_header(MpegEncContext * s, int picture_number);
823 void msmpeg4_encode_ext_header(MpegEncContext * s);
824 void msmpeg4_encode_mb(MpegEncContext * s,
825                        DCTELEM block[6][64],
826                        int motion_x, int motion_y);
827 int msmpeg4_decode_picture_header(MpegEncContext * s);
828 int msmpeg4_decode_ext_header(MpegEncContext * s, int buf_size);
829 int ff_msmpeg4_decode_init(AVCodecContext *avctx);
830 void ff_msmpeg4_encode_init(MpegEncContext *s);
831 int ff_wmv2_decode_picture_header(MpegEncContext * s);
832 int ff_wmv2_decode_secondary_picture_header(MpegEncContext * s);
833 void ff_wmv2_add_mb(MpegEncContext *s, DCTELEM block[6][64], uint8_t *dest_y, uint8_t *dest_cb, uint8_t *dest_cr);
834 void ff_mspel_motion(MpegEncContext *s,
835                                uint8_t *dest_y, uint8_t *dest_cb, uint8_t *dest_cr,
836                                uint8_t **ref_picture, op_pixels_func (*pix_op)[4],
837                                int motion_x, int motion_y, int h);
838 int ff_wmv2_encode_picture_header(MpegEncContext * s, int picture_number);
839 void ff_wmv2_encode_mb(MpegEncContext * s,
840                        DCTELEM block[6][64],
841                        int motion_x, int motion_y);
842
843 #endif /* AVCODEC_MPEGVIDEO_H */