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