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