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