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