dsputil: Split off global motion compensation bits into a separate context
[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 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 "blockdsp.h"
33 #include "dsputil.h"
34 #include "error_resilience.h"
35 #include "get_bits.h"
36 #include "h263dsp.h"
37 #include "hpeldsp.h"
38 #include "mpegvideodsp.h"
39 #include "put_bits.h"
40 #include "ratecontrol.h"
41 #include "parser.h"
42 #include "mpeg12data.h"
43 #include "qpeldsp.h"
44 #include "rl.h"
45 #include "thread.h"
46 #include "videodsp.h"
47
48 #include "libavutil/opt.h"
49
50 #define FRAME_SKIPPED 100 ///< return value for header parsers if frame is not coded
51
52 enum OutputFormat {
53     FMT_MPEG1,
54     FMT_H261,
55     FMT_H263,
56     FMT_MJPEG,
57 };
58
59 #define MPEG_BUF_SIZE (16 * 1024)
60
61 #define QMAT_SHIFT_MMX 16
62 #define QMAT_SHIFT 22
63
64 #define MAX_FCODE 7
65 #define MAX_MV 2048
66
67 #define MAX_THREADS 16
68
69 #define MAX_PICTURE_COUNT 32
70
71 #define MAX_B_FRAMES 16
72
73 #define ME_MAP_SIZE 64
74 #define ME_MAP_SHIFT 3
75 #define ME_MAP_MV_BITS 11
76
77 #define MAX_MB_BYTES (30*16*16*3/8 + 120)
78
79 #define INPLACE_OFFSET 16
80
81 /* Start codes. */
82 #define SEQ_END_CODE            0x000001b7
83 #define SEQ_START_CODE          0x000001b3
84 #define GOP_START_CODE          0x000001b8
85 #define PICTURE_START_CODE      0x00000100
86 #define SLICE_MIN_START_CODE    0x00000101
87 #define SLICE_MAX_START_CODE    0x000001af
88 #define EXT_START_CODE          0x000001b5
89 #define USER_START_CODE         0x000001b2
90
91 /* encoding scans */
92 extern const uint8_t ff_alternate_horizontal_scan[64];
93 extern const uint8_t ff_alternate_vertical_scan[64];
94
95 struct MpegEncContext;
96
97 /**
98  * Picture.
99  */
100 typedef struct Picture{
101     struct AVFrame *f;
102     ThreadFrame tf;
103
104     AVBufferRef *qscale_table_buf;
105     int8_t *qscale_table;
106
107     AVBufferRef *motion_val_buf[2];
108     int16_t (*motion_val[2])[2];
109
110     AVBufferRef *mb_type_buf;
111     uint32_t *mb_type;          ///< types and macros are defined in mpegutils.h
112
113     AVBufferRef *mbskip_table_buf;
114     uint8_t *mbskip_table;
115
116     AVBufferRef *ref_index_buf[2];
117     int8_t *ref_index[2];
118
119     AVBufferRef *mb_var_buf;
120     uint16_t *mb_var;           ///< Table for MB variances
121
122     AVBufferRef *mc_mb_var_buf;
123     uint16_t *mc_mb_var;        ///< Table for motion compensated MB variances
124
125     AVBufferRef *mb_mean_buf;
126     uint8_t *mb_mean;           ///< Table for MB luminance
127
128     AVBufferRef *hwaccel_priv_buf;
129     /**
130      * hardware accelerator private data
131      */
132     void *hwaccel_picture_private;
133
134     int field_picture;          ///< whether or not the picture was encoded in separate fields
135
136     int mb_var_sum;             ///< sum of MB variance for current frame
137     int mc_mb_var_sum;          ///< motion compensated MB variance for current frame
138
139     int b_frame_score;          /* */
140     int needs_realloc;          ///< Picture needs to be reallocated (eg due to a frame size change)
141
142     int reference;
143     int shared;
144 } Picture;
145
146 /**
147  * Motion estimation context.
148  */
149 typedef struct MotionEstContext{
150     AVCodecContext *avctx;
151     int skip;                          ///< set if ME is skipped for the current MB
152     int co_located_mv[4][2];           ///< mv from last P-frame for direct mode ME
153     int direct_basis_mv[4][2];
154     uint8_t *scratchpad;               ///< data area for the ME algo, so that the ME does not need to malloc/free
155     uint8_t *best_mb;
156     uint8_t *temp_mb[2];
157     uint8_t *temp;
158     int best_bits;
159     uint32_t *map;                     ///< map to avoid duplicate evaluations
160     uint32_t *score_map;               ///< map to store the scores
161     unsigned map_generation;
162     int pre_penalty_factor;
163     int penalty_factor;                /**< an estimate of the bits required to
164                                         code a given mv value, e.g. (1,0) takes
165                                         more bits than (0,0). We have to
166                                         estimate whether any reduction in
167                                         residual is worth the extra bits. */
168     int sub_penalty_factor;
169     int mb_penalty_factor;
170     int flags;
171     int sub_flags;
172     int mb_flags;
173     int pre_pass;                      ///< = 1 for the pre pass
174     int dia_size;
175     int xmin;
176     int xmax;
177     int ymin;
178     int ymax;
179     int pred_x;
180     int pred_y;
181     uint8_t *src[4][4];
182     uint8_t *ref[4][4];
183     int stride;
184     int uvstride;
185     /* temp variables for picture complexity calculation */
186     int mc_mb_var_sum_temp;
187     int mb_var_sum_temp;
188     int scene_change_score;
189 /*    cmp, chroma_cmp;*/
190     op_pixels_func (*hpel_put)[4];
191     op_pixels_func (*hpel_avg)[4];
192     qpel_mc_func (*qpel_put)[16];
193     qpel_mc_func (*qpel_avg)[16];
194     uint8_t (*mv_penalty)[MAX_MV*2+1];  ///< amount of bits needed to encode a MV
195     uint8_t *current_mv_penalty;
196     int (*sub_motion_search)(struct MpegEncContext * s,
197                                   int *mx_ptr, int *my_ptr, int dmin,
198                                   int src_index, int ref_index,
199                                   int size, int h);
200 }MotionEstContext;
201
202 /**
203  * MpegEncContext.
204  */
205 typedef struct MpegEncContext {
206     AVClass *class;
207
208     int y_dc_scale, c_dc_scale;
209     int ac_pred;
210     int block_last_index[12];  ///< last non zero coefficient in block
211     int h263_aic;              ///< Advanded INTRA Coding (AIC)
212
213     /* scantables */
214     ScanTable inter_scantable; ///< if inter == intra then intra should be used to reduce tha cache usage
215     ScanTable intra_scantable;
216     ScanTable intra_h_scantable;
217     ScanTable intra_v_scantable;
218
219     /* WARNING: changes above this line require updates to hardcoded
220      *          offsets used in asm. */
221
222     struct AVCodecContext *avctx;
223     /* the following parameters must be initialized before encoding */
224     int width, height;///< picture size. must be a multiple of 16
225     int gop_size;
226     int intra_only;   ///< if true, only intra pictures are generated
227     int bit_rate;     ///< wanted bit rate
228     enum OutputFormat out_format; ///< output format
229     int h263_pred;    ///< use mpeg4/h263 ac/dc predictions
230     int pb_frame;     ///< PB frame mode (0 = none, 1 = base, 2 = improved)
231
232 /* the following codec id fields are deprecated in favor of codec_id */
233     int h263_plus;    ///< h263 plus headers
234     int h263_flv;     ///< use flv h263 header
235
236     enum AVCodecID codec_id;     /* see AV_CODEC_ID_xxx */
237     int fixed_qscale; ///< fixed qscale if non zero
238     int encoding;     ///< true if we are encoding (vs decoding)
239     int flags;        ///< AVCodecContext.flags (HQ, MV4, ...)
240     int flags2;       ///< AVCodecContext.flags2
241     int max_b_frames; ///< max number of b-frames for encoding
242     int luma_elim_threshold;
243     int chroma_elim_threshold;
244     int strict_std_compliance; ///< strictly follow the std (MPEG4, ...)
245     int workaround_bugs;       ///< workaround bugs in encoders which cannot be detected automatically
246     int codec_tag;             ///< internal codec_tag upper case converted from avctx codec_tag
247     int stream_codec_tag;      ///< internal stream_codec_tag upper case converted from avctx stream_codec_tag
248     /* the following fields are managed internally by the encoder */
249
250     /* sequence parameters */
251     int context_initialized;
252     int input_picture_number;  ///< used to set pic->display_picture_number, should not be used for/by anything else
253     int coded_picture_number;  ///< used to set pic->coded_picture_number, should not be used for/by anything else
254     int picture_number;       //FIXME remove, unclear definition
255     int picture_in_gop_number; ///< 0-> first pic in gop, ...
256     int mb_width, mb_height;   ///< number of MBs horizontally & vertically
257     int mb_stride;             ///< mb_width+1 used for some arrays to allow simple addressing of left & top MBs without sig11
258     int b8_stride;             ///< 2*mb_width+1 used for some 8x8 block arrays to allow simple addressing
259     int h_edge_pos, v_edge_pos;///< horizontal / vertical position of the right/bottom edge (pixel replication)
260     int mb_num;                ///< number of MBs of a picture
261     ptrdiff_t linesize;        ///< line size, in bytes, may be different from width
262     ptrdiff_t uvlinesize;      ///< line size, for chroma in bytes, may be different from width
263     Picture *picture;          ///< main picture buffer
264     Picture **input_picture;   ///< next pictures on display order for encoding
265     Picture **reordered_input_picture; ///< pointer to the next pictures in codedorder for encoding
266
267     int64_t user_specified_pts; ///< last non-zero pts from AVFrame which was passed into avcodec_encode_video2()
268     /**
269      * pts difference between the first and second input frame, used for
270      * calculating dts of the first frame when there's a delay */
271     int64_t dts_delta;
272     /**
273      * reordered pts to be used as dts for the next output frame when there's
274      * a delay */
275     int64_t reordered_pts;
276
277     /** bit output */
278     PutBitContext pb;
279
280     int start_mb_y;            ///< start mb_y of this thread (so current thread should process start_mb_y <= row < end_mb_y)
281     int end_mb_y;              ///< end   mb_y of this thread (so current thread should process start_mb_y <= row < end_mb_y)
282     struct MpegEncContext *thread_context[MAX_THREADS];
283     int slice_context_count;   ///< number of used thread_contexts
284
285     /**
286      * copy of the previous picture structure.
287      * note, linesize & data, might not match the previous picture (for field pictures)
288      */
289     Picture last_picture;
290
291     /**
292      * copy of the next picture structure.
293      * note, linesize & data, might not match the next picture (for field pictures)
294      */
295     Picture next_picture;
296
297     /**
298      * copy of the source picture structure for encoding.
299      * note, linesize & data, might not match the source picture (for field pictures)
300      */
301     Picture new_picture;
302
303     /**
304      * copy of the current picture structure.
305      * note, linesize & data, might not match the current picture (for field pictures)
306      */
307     Picture current_picture;    ///< buffer to store the decompressed current picture
308
309     Picture *last_picture_ptr;     ///< pointer to the previous picture.
310     Picture *next_picture_ptr;     ///< pointer to the next picture (for bidir pred)
311     Picture *current_picture_ptr;  ///< pointer to the current picture
312     int last_dc[3];                ///< last DC values for MPEG1
313     int16_t *dc_val_base;
314     int16_t *dc_val[3];            ///< used for mpeg4 DC prediction, all 3 arrays must be continuous
315     const uint8_t *y_dc_scale_table;     ///< qscale -> y_dc_scale table
316     const uint8_t *c_dc_scale_table;     ///< qscale -> c_dc_scale table
317     const uint8_t *chroma_qscale_table;  ///< qscale -> chroma_qscale (h263)
318     uint8_t *coded_block_base;
319     uint8_t *coded_block;          ///< used for coded block pattern prediction (msmpeg4v3, wmv1)
320     int16_t (*ac_val_base)[16];
321     int16_t (*ac_val[3])[16];      ///< used for for mpeg4 AC prediction, all 3 arrays must be continuous
322     int mb_skipped;                ///< MUST BE SET only during DECODING
323     uint8_t *mbskip_table;        /**< used to avoid copy if macroblock skipped (for black regions for example)
324                                    and used for b-frame encoding & decoding (contains skip table of next P Frame) */
325     uint8_t *mbintra_table;       ///< used to avoid setting {ac, dc, cbp}-pred stuff to zero on inter MB decoding
326     uint8_t *cbp_table;           ///< used to store cbp, ac_pred for partitioned decoding
327     uint8_t *pred_dir_table;      ///< used to store pred_dir for partitioned decoding
328     uint8_t *edge_emu_buffer;     ///< temporary buffer for if MVs point to out-of-frame data
329     uint8_t *rd_scratchpad;       ///< scratchpad for rate distortion mb decision
330     uint8_t *obmc_scratchpad;
331     uint8_t *b_scratchpad;        ///< scratchpad used for writing into write only buffers
332
333     int qscale;                 ///< QP
334     int chroma_qscale;          ///< chroma QP
335     unsigned int lambda;        ///< lagrange multipler used in rate distortion
336     unsigned int lambda2;       ///< (lambda*lambda) >> FF_LAMBDA_SHIFT
337     int *lambda_table;
338     int adaptive_quant;         ///< use adaptive quantization
339     int dquant;                 ///< qscale difference to prev qscale
340     int pict_type;              ///< AV_PICTURE_TYPE_I, AV_PICTURE_TYPE_P, AV_PICTURE_TYPE_B, ...
341     int last_pict_type; //FIXME removes
342     int last_non_b_pict_type;   ///< used for mpeg4 gmc b-frames & ratecontrol
343     int droppable;
344     int frame_rate_index;
345     int last_lambda_for[5];     ///< last lambda for a specific pict type
346     int skipdct;                ///< skip dct and code zero residual
347
348     /* motion compensation */
349     int unrestricted_mv;        ///< mv can point outside of the coded picture
350     int h263_long_vectors;      ///< use horrible h263v1 long vector mode
351
352     BlockDSPContext bdsp;
353     DSPContext dsp;             ///< pointers for accelerated dsp functions
354     HpelDSPContext hdsp;
355     MpegVideoDSPContext mdsp;
356     QpelDSPContext qdsp;
357     VideoDSPContext vdsp;
358     H263DSPContext h263dsp;
359     int f_code;                 ///< forward MV resolution
360     int b_code;                 ///< backward MV resolution for B Frames (mpeg4)
361     int16_t (*p_mv_table_base)[2];
362     int16_t (*b_forw_mv_table_base)[2];
363     int16_t (*b_back_mv_table_base)[2];
364     int16_t (*b_bidir_forw_mv_table_base)[2];
365     int16_t (*b_bidir_back_mv_table_base)[2];
366     int16_t (*b_direct_mv_table_base)[2];
367     int16_t (*p_field_mv_table_base[2][2])[2];
368     int16_t (*b_field_mv_table_base[2][2][2])[2];
369     int16_t (*p_mv_table)[2];            ///< MV table (1MV per MB) p-frame encoding
370     int16_t (*b_forw_mv_table)[2];       ///< MV table (1MV per MB) forward mode b-frame encoding
371     int16_t (*b_back_mv_table)[2];       ///< MV table (1MV per MB) backward mode b-frame encoding
372     int16_t (*b_bidir_forw_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding
373     int16_t (*b_bidir_back_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding
374     int16_t (*b_direct_mv_table)[2];     ///< MV table (1MV per MB) direct mode b-frame encoding
375     int16_t (*p_field_mv_table[2][2])[2];   ///< MV table (2MV per MB) interlaced p-frame encoding
376     int16_t (*b_field_mv_table[2][2][2])[2];///< MV table (4MV per MB) interlaced b-frame encoding
377     uint8_t (*p_field_select_table[2]);
378     uint8_t (*b_field_select_table[2][2]);
379     int me_method;                       ///< ME algorithm
380     int mv_dir;
381 #define MV_DIR_FORWARD   1
382 #define MV_DIR_BACKWARD  2
383 #define MV_DIRECT        4 ///< bidirectional mode where the difference equals the MV of the last P/S/I-Frame (mpeg4)
384     int mv_type;
385 #define MV_TYPE_16X16       0   ///< 1 vector for the whole mb
386 #define MV_TYPE_8X8         1   ///< 4 vectors (h263, mpeg4 4MV)
387 #define MV_TYPE_16X8        2   ///< 2 vectors, one per 16x8 block
388 #define MV_TYPE_FIELD       3   ///< 2 vectors, one per field
389 #define MV_TYPE_DMV         4   ///< 2 vectors, special mpeg2 Dual Prime Vectors
390     /**motion vectors for a macroblock
391        first coordinate : 0 = forward 1 = backward
392        second "         : depend on type
393        third  "         : 0 = x, 1 = y
394     */
395     int mv[2][4][2];
396     int field_select[2][2];
397     int last_mv[2][2][2];             ///< last MV, used for MV prediction in MPEG1 & B-frame MPEG4
398     uint8_t *fcode_tab;               ///< smallest fcode needed for each MV
399     int16_t direct_scale_mv[2][64];   ///< precomputed to avoid divisions in ff_mpeg4_set_direct_mv
400
401     MotionEstContext me;
402
403     int no_rounding;  /**< apply no rounding to motion compensation (MPEG4, msmpeg4, ...)
404                         for b-frames rounding mode is always 0 */
405
406     /* macroblock layer */
407     int mb_x, mb_y;
408     int mb_skip_run;
409     int mb_intra;
410     uint16_t *mb_type;  ///< Table for candidate MB types for encoding (defines in mpegutils.h)
411
412     int block_index[6]; ///< index to current MB in block based arrays with edges
413     int block_wrap[6];
414     uint8_t *dest[3];
415
416     int *mb_index2xy;        ///< mb_index -> mb_x + mb_y*mb_stride
417
418     /** matrix transmitted in the bitstream */
419     uint16_t intra_matrix[64];
420     uint16_t chroma_intra_matrix[64];
421     uint16_t inter_matrix[64];
422     uint16_t chroma_inter_matrix[64];
423 #define QUANT_BIAS_SHIFT 8
424     int intra_quant_bias;    ///< bias for the quantizer
425     int inter_quant_bias;    ///< bias for the quantizer
426     int min_qcoeff;          ///< minimum encodable coefficient
427     int max_qcoeff;          ///< maximum encodable coefficient
428     int ac_esc_length;       ///< num of bits needed to encode the longest esc
429     uint8_t *intra_ac_vlc_length;
430     uint8_t *intra_ac_vlc_last_length;
431     uint8_t *inter_ac_vlc_length;
432     uint8_t *inter_ac_vlc_last_length;
433     uint8_t *luma_dc_vlc_length;
434 #define UNI_AC_ENC_INDEX(run,level) ((run)*128 + (level))
435
436     int coded_score[8];
437
438     /** precomputed matrix (combine qscale and DCT renorm) */
439     int (*q_intra_matrix)[64];
440     int (*q_inter_matrix)[64];
441     /** identical to the above but for MMX & these are not permutated, second 64 entries are bias*/
442     uint16_t (*q_intra_matrix16)[2][64];
443     uint16_t (*q_inter_matrix16)[2][64];
444
445     /* noise reduction */
446     int (*dct_error_sum)[64];
447     int dct_count[2];
448     uint16_t (*dct_offset)[64];
449
450     void *opaque;              ///< private data for the user
451
452     /* bit rate control */
453     int64_t total_bits;
454     int frame_bits;                ///< bits used for the current frame
455     int next_lambda;               ///< next lambda used for retrying to encode a frame
456     RateControlContext rc_context; ///< contains stuff only accessed in ratecontrol.c
457
458     /* statistics, used for 2-pass encoding */
459     int mv_bits;
460     int header_bits;
461     int i_tex_bits;
462     int p_tex_bits;
463     int i_count;
464     int f_count;
465     int b_count;
466     int skip_count;
467     int misc_bits; ///< cbp, mb_type
468     int last_bits; ///< temp var used for calculating the above vars
469
470     /* error concealment / resync */
471     int resync_mb_x;                 ///< x position of last resync marker
472     int resync_mb_y;                 ///< y position of last resync marker
473     GetBitContext last_resync_gb;    ///< used to search for the next resync marker
474     int mb_num_left;                 ///< number of MBs left in this video packet (for partitioned Slices only)
475     int next_p_frame_damaged;        ///< set if the next p frame is damaged, to avoid showing trashed b frames
476     int err_recognition;
477
478     ParseContext parse_context;
479
480     /* H.263 specific */
481     int gob_index;
482     int obmc;                       ///< overlapped block motion compensation
483     int mb_info;                    ///< interval for outputting info about mb offsets as side data
484     int prev_mb_info, last_mb_info;
485     uint8_t *mb_info_ptr;
486     int mb_info_size;
487
488     /* H.263+ specific */
489     int umvplus;                    ///< == H263+ && unrestricted_mv
490     int h263_aic_dir;               ///< AIC direction: 0 = left, 1 = top
491     int h263_slice_structured;
492     int alt_inter_vlc;              ///< alternative inter vlc
493     int modified_quant;
494     int loop_filter;
495     int custom_pcf;
496
497     /* mpeg4 specific */
498     ///< number of bits to represent the fractional part of time (encoder only)
499     int time_increment_bits;
500     int last_time_base;
501     int time_base;                  ///< time in seconds of last I,P,S Frame
502     int64_t time;                   ///< time of current frame
503     int64_t last_non_b_time;
504     uint16_t pp_time;               ///< time distance between the last 2 p,s,i frames
505     uint16_t pb_time;               ///< time distance between the last b and p,s,i frame
506     uint16_t pp_field_time;
507     uint16_t pb_field_time;         ///< like above, just for interlaced
508     int real_sprite_warping_points;
509     int sprite_offset[2][2];         ///< sprite offset[isChroma][isMVY]
510     int sprite_delta[2][2];          ///< sprite_delta [isY][isMVY]
511     int mcsel;
512     int quant_precision;
513     int quarter_sample;              ///< 1->qpel, 0->half pel ME/MC
514     int aspect_ratio_info; //FIXME remove
515     int sprite_warping_accuracy;
516     int data_partitioning;           ///< data partitioning flag from header
517     int partitioned_frame;           ///< is current frame partitioned
518     int low_delay;                   ///< no reordering needed / has no b-frames
519     int vo_type;
520     int vol_control_parameters;      ///< does the stream contain the low_delay flag, used to workaround buggy encoders
521     PutBitContext tex_pb;            ///< used for data partitioned VOPs
522     PutBitContext pb2;               ///< used for data partitioned VOPs
523     int mpeg_quant;
524     int padding_bug_score;             ///< used to detect the VERY common padding bug in MPEG4
525
526     /* divx specific, used to workaround (many) bugs in divx5 */
527     int divx_packed;
528     uint8_t *bitstream_buffer; //Divx 5.01 puts several frames in a single one, this is used to reorder them
529     int bitstream_buffer_size;
530     unsigned int allocated_bitstream_buffer_size;
531
532     /* RV10 specific */
533     int rv10_version; ///< RV10 version: 0 or 3
534     int rv10_first_dc_coded[3];
535     int orig_width, orig_height;
536
537     /* MJPEG specific */
538     struct MJpegContext *mjpeg_ctx;
539
540     /* MSMPEG4 specific */
541     int mv_table_index;
542     int rl_table_index;
543     int rl_chroma_table_index;
544     int dc_table_index;
545     int use_skip_mb_code;
546     int slice_height;      ///< in macroblocks
547     int first_slice_line;  ///< used in mpeg4 too to handle resync markers
548     int flipflop_rounding;
549     int msmpeg4_version;   ///< 0=not msmpeg4, 1=mp41, 2=mp42, 3=mp43/divx3 4=wmv1/7 5=wmv2/8
550     int per_mb_rl_table;
551     int esc3_level_length;
552     int esc3_run_length;
553     /** [mb_intra][isChroma][level][run][last] */
554     int (*ac_stats)[2][MAX_LEVEL+1][MAX_RUN+1][2];
555     int inter_intra_pred;
556     int mspel;
557
558     /* decompression specific */
559     GetBitContext gb;
560
561     /* Mpeg1 specific */
562     int gop_picture_number;  ///< index of the first picture of a GOP based on fake_pic_num & mpeg1 specific
563     int last_mv_dir;         ///< last mv_dir, used for b frame encoding
564     uint8_t *vbv_delay_ptr;  ///< pointer to vbv_delay in the bitstream
565
566     /* MPEG-2-specific - I wished not to have to support this mess. */
567     int progressive_sequence;
568     int mpeg_f_code[2][2];
569
570     // picture structure defines are loaded from mpegutils.h
571     int picture_structure;
572
573     int intra_dc_precision;
574     int frame_pred_frame_dct;
575     int top_field_first;
576     int concealment_motion_vectors;
577     int q_scale_type;
578     int intra_vlc_format;
579     int alternate_scan;
580     int repeat_first_field;
581     int chroma_420_type;
582     int chroma_format;
583 #define CHROMA_420 1
584 #define CHROMA_422 2
585 #define CHROMA_444 3
586     int chroma_x_shift;//depend on pix_format, that depend on chroma_format
587     int chroma_y_shift;
588
589     int progressive_frame;
590     int full_pel[2];
591     int interlaced_dct;
592     int first_field;         ///< is 1 for the first field of a field picture 0 otherwise
593     int drop_frame_timecode; ///< timecode is in drop frame format.
594     int scan_offset;         ///< reserve space for SVCD scan offset user data.
595
596     /* RTP specific */
597     int rtp_mode;
598
599     uint8_t *ptr_lastgob;
600     int16_t (*pblocks[12])[64];
601
602     int16_t (*block)[64]; ///< points to one of the following blocks
603     int16_t (*blocks)[8][64]; // for HQ mode we need to keep the best block
604     int (*decode_mb)(struct MpegEncContext *s, int16_t block[6][64]); // used by some codecs to avoid a switch()
605 #define SLICE_OK         0
606 #define SLICE_ERROR     -1
607 #define SLICE_END       -2 ///<end marker found
608 #define SLICE_NOEND     -3 ///<no end marker or error found but mb count exceeded
609
610     void (*dct_unquantize_mpeg1_intra)(struct MpegEncContext *s,
611                            int16_t *block/*align 16*/, int n, int qscale);
612     void (*dct_unquantize_mpeg1_inter)(struct MpegEncContext *s,
613                            int16_t *block/*align 16*/, int n, int qscale);
614     void (*dct_unquantize_mpeg2_intra)(struct MpegEncContext *s,
615                            int16_t *block/*align 16*/, int n, int qscale);
616     void (*dct_unquantize_mpeg2_inter)(struct MpegEncContext *s,
617                            int16_t *block/*align 16*/, int n, int qscale);
618     void (*dct_unquantize_h263_intra)(struct MpegEncContext *s,
619                            int16_t *block/*align 16*/, int n, int qscale);
620     void (*dct_unquantize_h263_inter)(struct MpegEncContext *s,
621                            int16_t *block/*align 16*/, int n, int qscale);
622     void (*dct_unquantize_h261_intra)(struct MpegEncContext *s,
623                            int16_t *block/*align 16*/, int n, int qscale);
624     void (*dct_unquantize_h261_inter)(struct MpegEncContext *s,
625                            int16_t *block/*align 16*/, int n, int qscale);
626     void (*dct_unquantize_intra)(struct MpegEncContext *s, // unquantizer to use (mpeg4 can use both)
627                            int16_t *block/*align 16*/, int n, int qscale);
628     void (*dct_unquantize_inter)(struct MpegEncContext *s, // unquantizer to use (mpeg4 can use both)
629                            int16_t *block/*align 16*/, int n, int qscale);
630     int (*dct_quantize)(struct MpegEncContext *s, int16_t *block/*align 16*/, int n, int qscale, int *overflow);
631     int (*fast_dct_quantize)(struct MpegEncContext *s, int16_t *block/*align 16*/, int n, int qscale, int *overflow);
632     void (*denoise_dct)(struct MpegEncContext *s, int16_t *block);
633
634     int mpv_flags;      ///< flags set by private options
635     int quantizer_noise_shaping;
636
637     /* temp buffers for rate control */
638     float *cplx_tab, *bits_tab;
639
640     /* flag to indicate a reinitialization is required, e.g. after
641      * a frame size change */
642     int context_reinit;
643
644     ERContext er;
645
646     int error_rate;
647
648     /* temporary frames used by b_frame_strategy = 2 */
649     AVFrame *tmp_frames[MAX_B_FRAMES + 2];
650 } MpegEncContext;
651
652 #define REBASE_PICTURE(pic, new_ctx, old_ctx)             \
653     ((pic && pic >= old_ctx->picture &&                   \
654       pic < old_ctx->picture + MAX_PICTURE_COUNT) ?  \
655         &new_ctx->picture[pic - old_ctx->picture] : NULL)
656
657 /* mpegvideo_enc common options */
658 #define FF_MPV_FLAG_SKIP_RD      0x0001
659 #define FF_MPV_FLAG_STRICT_GOP   0x0002
660 #define FF_MPV_FLAG_QP_RD        0x0004
661 #define FF_MPV_FLAG_CBP_RD       0x0008
662 #define FF_MPV_FLAG_NAQ          0x0010
663 #define FF_MPV_FLAG_MV0          0x0020
664
665 #define FF_MPV_OFFSET(x) offsetof(MpegEncContext, x)
666 #define FF_MPV_OPT_FLAGS (AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM)
667 #define FF_MPV_COMMON_OPTS \
668 { "mpv_flags",      "Flags common for all mpegvideo-based encoders.", FF_MPV_OFFSET(mpv_flags), AV_OPT_TYPE_FLAGS, { .i64 = 0 }, INT_MIN, INT_MAX, FF_MPV_OPT_FLAGS, "mpv_flags" },\
669 { "skip_rd",        "RD optimal MB level residual skipping", 0, AV_OPT_TYPE_CONST, { .i64 = FF_MPV_FLAG_SKIP_RD },    0, 0, FF_MPV_OPT_FLAGS, "mpv_flags" },\
670 { "strict_gop",     "Strictly enforce gop size",             0, AV_OPT_TYPE_CONST, { .i64 = FF_MPV_FLAG_STRICT_GOP }, 0, 0, FF_MPV_OPT_FLAGS, "mpv_flags" },\
671 { "qp_rd",          "Use rate distortion optimization for qp selection", 0, AV_OPT_TYPE_CONST, { .i64 = FF_MPV_FLAG_QP_RD },  0, 0, FF_MPV_OPT_FLAGS, "mpv_flags" },\
672 { "cbp_rd",         "use rate distortion optimization for CBP",          0, AV_OPT_TYPE_CONST, { .i64 = FF_MPV_FLAG_CBP_RD }, 0, 0, FF_MPV_OPT_FLAGS, "mpv_flags" },\
673 { "naq",            "normalize adaptive quantization",                   0, AV_OPT_TYPE_CONST, { .i64 = FF_MPV_FLAG_NAQ },    0, 0, FF_MPV_OPT_FLAGS, "mpv_flags" },\
674 { "mv0",            "always try a mb with mv=<0,0>",                     0, AV_OPT_TYPE_CONST, { .i64 = FF_MPV_FLAG_MV0 },    0, 0, FF_MPV_OPT_FLAGS, "mpv_flags" },\
675 { "luma_elim_threshold",   "single coefficient elimination threshold for luminance (negative values also consider dc coefficient)",\
676                                                                       FF_MPV_OFFSET(luma_elim_threshold), AV_OPT_TYPE_INT, { .i64 = 0 }, INT_MIN, INT_MAX, FF_MPV_OPT_FLAGS },\
677 { "chroma_elim_threshold", "single coefficient elimination threshold for chrominance (negative values also consider dc coefficient)",\
678                                                                       FF_MPV_OFFSET(chroma_elim_threshold), AV_OPT_TYPE_INT, { .i64 = 0 }, INT_MIN, INT_MAX, FF_MPV_OPT_FLAGS },\
679 { "quantizer_noise_shaping", NULL,                                  FF_MPV_OFFSET(quantizer_noise_shaping), AV_OPT_TYPE_INT, { .i64 = 0 },       0, INT_MAX, FF_MPV_OPT_FLAGS },\
680 { "error_rate", "Simulate errors in the bitstream to test error concealment.",                                                                                                  \
681                                                                     FF_MPV_OFFSET(error_rate),              AV_OPT_TYPE_INT, { .i64 = 0 },       0, INT_MAX, FF_MPV_OPT_FLAGS },
682
683 extern const AVOption ff_mpv_generic_options[];
684
685 #define FF_MPV_GENERIC_CLASS(name) \
686 static const AVClass name ## _class = {\
687     .class_name = #name " encoder",\
688     .item_name  = av_default_item_name,\
689     .option     = ff_mpv_generic_options,\
690     .version    = LIBAVUTIL_VERSION_INT,\
691 };
692
693 /**
694  * Set the given MpegEncContext to common defaults (same for encoding
695  * and decoding).  The changed fields will not depend upon the prior
696  * state of the MpegEncContext.
697  */
698 void ff_MPV_common_defaults(MpegEncContext *s);
699
700 void ff_MPV_decode_defaults(MpegEncContext *s);
701 int ff_MPV_common_init(MpegEncContext *s);
702 int ff_MPV_common_frame_size_change(MpegEncContext *s);
703 void ff_MPV_common_end(MpegEncContext *s);
704 void ff_MPV_decode_mb(MpegEncContext *s, int16_t block[12][64]);
705 int ff_MPV_frame_start(MpegEncContext *s, AVCodecContext *avctx);
706 void ff_MPV_frame_end(MpegEncContext *s);
707 int ff_MPV_encode_init(AVCodecContext *avctx);
708 int ff_MPV_encode_end(AVCodecContext *avctx);
709 int ff_MPV_encode_picture(AVCodecContext *avctx, AVPacket *pkt,
710                           const AVFrame *frame, int *got_packet);
711 void ff_MPV_encode_init_x86(MpegEncContext *s);
712 void ff_MPV_common_init_x86(MpegEncContext *s);
713 void ff_MPV_common_init_arm(MpegEncContext *s);
714 void ff_MPV_common_init_ppc(MpegEncContext *s);
715 void ff_clean_intra_table_entries(MpegEncContext *s);
716 void ff_mpeg_draw_horiz_band(MpegEncContext *s, int y, int h);
717 void ff_mpeg_flush(AVCodecContext *avctx);
718 void ff_print_debug_info(MpegEncContext *s, Picture *p);
719 void ff_write_quant_matrix(PutBitContext *pb, uint16_t *matrix);
720 int ff_find_unused_picture(MpegEncContext *s, int shared);
721 void ff_denoise_dct(MpegEncContext *s, int16_t *block);
722 int ff_update_duplicate_context(MpegEncContext *dst, MpegEncContext *src);
723 int ff_MPV_lowest_referenced_row(MpegEncContext *s, int dir);
724 void ff_MPV_report_decode_progress(MpegEncContext *s);
725 int ff_mpeg_update_thread_context(AVCodecContext *dst, const AVCodecContext *src);
726 void ff_set_qscale(MpegEncContext * s, int qscale);
727
728 int ff_dct_common_init(MpegEncContext *s);
729 void ff_convert_matrix(DSPContext *dsp, int (*qmat)[64], uint16_t (*qmat16)[2][64],
730                        const uint16_t *quant_matrix, int bias, int qmin, int qmax, int intra);
731 int ff_dct_quantize_c(MpegEncContext *s, int16_t *block, int n, int qscale, int *overflow);
732
733 void ff_init_block_index(MpegEncContext *s);
734
735 void ff_MPV_motion(MpegEncContext *s,
736                    uint8_t *dest_y, uint8_t *dest_cb,
737                    uint8_t *dest_cr, int dir,
738                    uint8_t **ref_picture,
739                    op_pixels_func (*pix_op)[4],
740                    qpel_mc_func (*qpix_op)[16]);
741
742 /**
743  * Allocate a Picture.
744  * The pixels are allocated/set by calling get_buffer() if shared = 0.
745  */
746 int ff_alloc_picture(MpegEncContext *s, Picture *pic, int shared);
747
748 /**
749  * permute block according to permuatation.
750  * @param last last non zero element in scantable order
751  */
752 void ff_block_permute(int16_t *block, uint8_t *permutation, const uint8_t *scantable, int last);
753
754 static inline void ff_update_block_index(MpegEncContext *s){
755     const int block_size = 8;
756
757     s->block_index[0]+=2;
758     s->block_index[1]+=2;
759     s->block_index[2]+=2;
760     s->block_index[3]+=2;
761     s->block_index[4]++;
762     s->block_index[5]++;
763     s->dest[0]+= 2*block_size;
764     s->dest[1]+= block_size;
765     s->dest[2]+= block_size;
766 }
767
768 static inline int get_bits_diff(MpegEncContext *s){
769     const int bits= put_bits_count(&s->pb);
770     const int last= s->last_bits;
771
772     s->last_bits = bits;
773
774     return bits - last;
775 }
776
777 static inline int ff_h263_round_chroma(int x){
778     static const uint8_t h263_chroma_roundtab[16] = {
779     //  0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15
780         0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1,
781     };
782     return h263_chroma_roundtab[x & 0xf] + (x >> 3);
783 }
784
785 /* motion_est.c */
786 void ff_estimate_p_frame_motion(MpegEncContext * s,
787                              int mb_x, int mb_y);
788 void ff_estimate_b_frame_motion(MpegEncContext * s,
789                              int mb_x, int mb_y);
790 int ff_get_best_fcode(MpegEncContext * s, int16_t (*mv_table)[2], int type);
791 void ff_fix_long_p_mvs(MpegEncContext * s);
792 void ff_fix_long_mvs(MpegEncContext * s, uint8_t *field_select_table, int field_select,
793                      int16_t (*mv_table)[2], int f_code, int type, int truncate);
794 int ff_init_me(MpegEncContext *s);
795 int ff_pre_estimate_p_frame_motion(MpegEncContext * s, int mb_x, int mb_y);
796 int ff_epzs_motion_search(MpegEncContext * s, int *mx_ptr, int *my_ptr,
797                              int P[10][2], int src_index, int ref_index, int16_t (*last_mv)[2],
798                              int ref_mv_scale, int size, int h);
799 int ff_get_mb_score(MpegEncContext * s, int mx, int my, int src_index,
800                                int ref_index, int size, int h, int add_rate);
801
802 /* mpeg12.c */
803 extern const uint8_t ff_mpeg1_dc_scale_table[128];
804 extern const uint8_t * const ff_mpeg2_dc_scale_table[4];
805
806 void ff_mpeg1_encode_picture_header(MpegEncContext *s, int picture_number);
807 void ff_mpeg1_encode_mb(MpegEncContext *s,
808                         int16_t block[6][64],
809                         int motion_x, int motion_y);
810 void ff_mpeg1_encode_init(MpegEncContext *s);
811 void ff_mpeg1_encode_slice_header(MpegEncContext *s);
812
813 extern const uint8_t ff_aic_dc_scale_table[32];
814 extern const uint8_t ff_h263_chroma_qscale_table[32];
815
816 /* rv10.c */
817 void ff_rv10_encode_picture_header(MpegEncContext *s, int picture_number);
818 int ff_rv_decode_dc(MpegEncContext *s, int n);
819 void ff_rv20_encode_picture_header(MpegEncContext *s, int picture_number);
820
821
822 /* msmpeg4.c */
823 void ff_msmpeg4_encode_picture_header(MpegEncContext * s, int picture_number);
824 void ff_msmpeg4_encode_ext_header(MpegEncContext * s);
825 void ff_msmpeg4_encode_mb(MpegEncContext * s,
826                           int16_t block[6][64],
827                           int motion_x, int motion_y);
828 int ff_msmpeg4_decode_picture_header(MpegEncContext * s);
829 int ff_msmpeg4_decode_ext_header(MpegEncContext * s, int buf_size);
830 int ff_msmpeg4_decode_init(AVCodecContext *avctx);
831 void ff_msmpeg4_encode_init(MpegEncContext *s);
832 int ff_wmv2_decode_picture_header(MpegEncContext * s);
833 int ff_wmv2_decode_secondary_picture_header(MpegEncContext * s);
834 void ff_wmv2_add_mb(MpegEncContext *s, int16_t block[6][64], uint8_t *dest_y, uint8_t *dest_cb, uint8_t *dest_cr);
835 void ff_mspel_motion(MpegEncContext *s,
836                                uint8_t *dest_y, uint8_t *dest_cb, uint8_t *dest_cr,
837                                uint8_t **ref_picture, op_pixels_func (*pix_op)[4],
838                                int motion_x, int motion_y, int h);
839 int ff_wmv2_encode_picture_header(MpegEncContext * s, int picture_number);
840 void ff_wmv2_encode_mb(MpegEncContext * s,
841                        int16_t block[6][64],
842                        int motion_x, int motion_y);
843
844 int ff_mpeg_ref_picture(MpegEncContext *s, Picture *dst, Picture *src);
845 void ff_mpeg_unref_picture(MpegEncContext *s, Picture *picture);
846 void ff_free_picture_tables(Picture *pic);
847
848 #endif /* AVCODEC_MPEGVIDEO_H */