rv10: check size of s->mb_width * s->mb_height
[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 <float.h>
32
33 #include "avcodec.h"
34 #include "blockdsp.h"
35 #include "error_resilience.h"
36 #include "fdctdsp.h"
37 #include "get_bits.h"
38 #include "h263dsp.h"
39 #include "hpeldsp.h"
40 #include "idctdsp.h"
41 #include "me_cmp.h"
42 #include "mpegvideodsp.h"
43 #include "mpegvideoencdsp.h"
44 #include "pixblockdsp.h"
45 #include "put_bits.h"
46 #include "ratecontrol.h"
47 #include "parser.h"
48 #include "mpeg12data.h"
49 #include "qpeldsp.h"
50 #include "rl.h"
51 #include "thread.h"
52 #include "videodsp.h"
53
54 #include "libavutil/opt.h"
55
56 #define FRAME_SKIPPED 100 ///< return value for header parsers if frame is not coded
57
58 enum OutputFormat {
59     FMT_MPEG1,
60     FMT_H261,
61     FMT_H263,
62     FMT_MJPEG,
63 };
64
65 #define MAX_FCODE 7
66 #define MAX_MV 2048
67
68 #define MAX_THREADS 16
69
70 #define MAX_PICTURE_COUNT 32
71
72 #define MAX_B_FRAMES 16
73
74 #define ME_MAP_SIZE 64
75
76 #define MAX_MB_BYTES (30*16*16*3/8 + 120)
77
78 #define INPLACE_OFFSET 16
79
80 #define EDGE_WIDTH 16
81
82 /* Start codes. */
83 #define SEQ_END_CODE            0x000001b7
84 #define SEQ_START_CODE          0x000001b3
85 #define GOP_START_CODE          0x000001b8
86 #define PICTURE_START_CODE      0x00000100
87 #define SLICE_MIN_START_CODE    0x00000101
88 #define SLICE_MAX_START_CODE    0x000001af
89 #define EXT_START_CODE          0x000001b5
90 #define USER_START_CODE         0x000001b2
91
92 /* encoding scans */
93 extern const uint8_t ff_alternate_horizontal_scan[64];
94 extern const uint8_t ff_alternate_vertical_scan[64];
95
96 struct MpegEncContext;
97
98 /**
99  * Picture.
100  */
101 typedef struct Picture{
102     struct AVFrame *f;
103     ThreadFrame tf;
104
105     AVBufferRef *qscale_table_buf;
106     int8_t *qscale_table;
107
108     AVBufferRef *motion_val_buf[2];
109     int16_t (*motion_val[2])[2];
110
111     AVBufferRef *mb_type_buf;
112     uint32_t *mb_type;          ///< types and macros are defined in mpegutils.h
113
114     AVBufferRef *mbskip_table_buf;
115     uint8_t *mbskip_table;
116
117     AVBufferRef *ref_index_buf[2];
118     int8_t *ref_index[2];
119
120     AVBufferRef *mb_var_buf;
121     uint16_t *mb_var;           ///< Table for MB variances
122
123     AVBufferRef *mc_mb_var_buf;
124     uint16_t *mc_mb_var;        ///< Table for motion compensated MB variances
125
126     AVBufferRef *mb_mean_buf;
127     uint8_t *mb_mean;           ///< Table for MB luminance
128
129     AVBufferRef *hwaccel_priv_buf;
130     /**
131      * hardware accelerator private data
132      */
133     void *hwaccel_picture_private;
134
135     int field_picture;          ///< whether or not the picture was encoded in separate fields
136
137     int mb_var_sum;             ///< sum of MB variance for current frame
138     int mc_mb_var_sum;          ///< motion compensated MB variance for current frame
139
140     int b_frame_score;          /* */
141     int needs_realloc;          ///< Picture needs to be reallocated (eg due to a frame size change)
142
143     int reference;
144     int shared;
145 } Picture;
146
147 /**
148  * Motion estimation context.
149  */
150 typedef struct MotionEstContext{
151     AVCodecContext *avctx;
152     int skip;                          ///< set if ME is skipped for the current MB
153     int co_located_mv[4][2];           ///< mv from last P-frame for direct mode ME
154     int direct_basis_mv[4][2];
155     uint8_t *scratchpad;               ///< data area for the ME algo, so that the ME does not need to malloc/free
156     uint8_t *best_mb;
157     uint8_t *temp_mb[2];
158     uint8_t *temp;
159     int best_bits;
160     uint32_t *map;                     ///< map to avoid duplicate evaluations
161     uint32_t *score_map;               ///< map to store the scores
162     unsigned map_generation;
163     int pre_penalty_factor;
164     int penalty_factor;                /**< an estimate of the bits required to
165                                         code a given mv value, e.g. (1,0) takes
166                                         more bits than (0,0). We have to
167                                         estimate whether any reduction in
168                                         residual is worth the extra bits. */
169     int sub_penalty_factor;
170     int mb_penalty_factor;
171     int flags;
172     int sub_flags;
173     int mb_flags;
174     int pre_pass;                      ///< = 1 for the pre pass
175     int dia_size;
176     int xmin;
177     int xmax;
178     int ymin;
179     int ymax;
180     int pred_x;
181     int pred_y;
182     uint8_t *src[4][4];
183     uint8_t *ref[4][4];
184     int stride;
185     int uvstride;
186     /* temp variables for picture complexity calculation */
187     int mc_mb_var_sum_temp;
188     int mb_var_sum_temp;
189     int scene_change_score;
190 /*    cmp, chroma_cmp;*/
191     op_pixels_func (*hpel_put)[4];
192     op_pixels_func (*hpel_avg)[4];
193     qpel_mc_func (*qpel_put)[16];
194     qpel_mc_func (*qpel_avg)[16];
195     uint8_t (*mv_penalty)[MAX_MV*2+1];  ///< amount of bits needed to encode a MV
196     uint8_t *current_mv_penalty;
197     int (*sub_motion_search)(struct MpegEncContext * s,
198                                   int *mx_ptr, int *my_ptr, int dmin,
199                                   int src_index, int ref_index,
200                                   int size, int h);
201 }MotionEstContext;
202
203 /**
204  * MpegEncContext.
205  */
206 typedef struct MpegEncContext {
207     AVClass *class;
208
209     int y_dc_scale, c_dc_scale;
210     int ac_pred;
211     int block_last_index[12];  ///< last non zero coefficient in block
212     int h263_aic;              ///< Advanded INTRA Coding (AIC)
213
214     /* scantables */
215     ScanTable inter_scantable; ///< if inter == intra then intra should be used to reduce tha cache usage
216     ScanTable intra_scantable;
217     ScanTable intra_h_scantable;
218     ScanTable intra_v_scantable;
219
220     /* WARNING: changes above this line require updates to hardcoded
221      *          offsets used in asm. */
222
223     struct AVCodecContext *avctx;
224     /* the following parameters must be initialized before encoding */
225     int width, height;///< picture size. must be a multiple of 16
226     int gop_size;
227     int intra_only;   ///< if true, only intra pictures are generated
228     int bit_rate;     ///< wanted bit rate
229     enum OutputFormat out_format; ///< output format
230     int h263_pred;    ///< use mpeg4/h263 ac/dc predictions
231     int pb_frame;     ///< PB frame mode (0 = none, 1 = base, 2 = improved)
232
233 /* the following codec id fields are deprecated in favor of codec_id */
234     int h263_plus;    ///< h263 plus headers
235     int h263_flv;     ///< use flv h263 header
236
237     enum AVCodecID codec_id;     /* see AV_CODEC_ID_xxx */
238     int fixed_qscale; ///< fixed qscale if non zero
239     int encoding;     ///< true if we are encoding (vs decoding)
240     int flags;        ///< AVCodecContext.flags (HQ, MV4, ...)
241     int flags2;       ///< AVCodecContext.flags2
242     int max_b_frames; ///< max number of b-frames for encoding
243     int luma_elim_threshold;
244     int chroma_elim_threshold;
245     int strict_std_compliance; ///< strictly follow the std (MPEG4, ...)
246     int workaround_bugs;       ///< workaround bugs in encoders which cannot be detected automatically
247     int codec_tag;             ///< internal codec_tag upper case converted from avctx codec_tag
248     int stream_codec_tag;      ///< internal stream_codec_tag upper case converted from avctx stream_codec_tag
249     /* the following fields are managed internally by the encoder */
250
251     /* sequence parameters */
252     int context_initialized;
253     int input_picture_number;  ///< used to set pic->display_picture_number, should not be used for/by anything else
254     int coded_picture_number;  ///< used to set pic->coded_picture_number, should not be used for/by anything else
255     int picture_number;       //FIXME remove, unclear definition
256     int picture_in_gop_number; ///< 0-> first pic in gop, ...
257     int mb_width, mb_height;   ///< number of MBs horizontally & vertically
258     int mb_stride;             ///< mb_width+1 used for some arrays to allow simple addressing of left & top MBs without sig11
259     int b8_stride;             ///< 2*mb_width+1 used for some 8x8 block arrays to allow simple addressing
260     int h_edge_pos, v_edge_pos;///< horizontal / vertical position of the right/bottom edge (pixel replication)
261     int mb_num;                ///< number of MBs of a picture
262     ptrdiff_t linesize;        ///< line size, in bytes, may be different from width
263     ptrdiff_t uvlinesize;      ///< line size, for chroma in bytes, may be different from width
264     Picture *picture;          ///< main picture buffer
265     Picture **input_picture;   ///< next pictures on display order for encoding
266     Picture **reordered_input_picture; ///< pointer to the next pictures in codedorder for encoding
267
268     int64_t user_specified_pts; ///< last non-zero pts from AVFrame which was passed into avcodec_encode_video2()
269     /**
270      * pts difference between the first and second input frame, used for
271      * calculating dts of the first frame when there's a delay */
272     int64_t dts_delta;
273     /**
274      * reordered pts to be used as dts for the next output frame when there's
275      * a delay */
276     int64_t reordered_pts;
277
278     /** bit output */
279     PutBitContext pb;
280
281     int start_mb_y;            ///< start mb_y of this thread (so current thread should process start_mb_y <= row < end_mb_y)
282     int end_mb_y;              ///< end   mb_y of this thread (so current thread should process start_mb_y <= row < end_mb_y)
283     struct MpegEncContext *thread_context[MAX_THREADS];
284     int slice_context_count;   ///< number of used thread_contexts
285
286     /**
287      * copy of the previous picture structure.
288      * note, linesize & data, might not match the previous picture (for field pictures)
289      */
290     Picture last_picture;
291
292     /**
293      * copy of the next picture structure.
294      * note, linesize & data, might not match the next picture (for field pictures)
295      */
296     Picture next_picture;
297
298     /**
299      * copy of the source picture structure for encoding.
300      * note, linesize & data, might not match the source picture (for field pictures)
301      */
302     Picture new_picture;
303
304     /**
305      * copy of the current picture structure.
306      * note, linesize & data, might not match the current picture (for field pictures)
307      */
308     Picture current_picture;    ///< buffer to store the decompressed current picture
309
310     Picture *last_picture_ptr;     ///< pointer to the previous picture.
311     Picture *next_picture_ptr;     ///< pointer to the next picture (for bidir pred)
312     Picture *current_picture_ptr;  ///< pointer to the current picture
313     int last_dc[3];                ///< last DC values for MPEG1
314     int16_t *dc_val_base;
315     int16_t *dc_val[3];            ///< used for mpeg4 DC prediction, all 3 arrays must be continuous
316     const uint8_t *y_dc_scale_table;     ///< qscale -> y_dc_scale table
317     const uint8_t *c_dc_scale_table;     ///< qscale -> c_dc_scale table
318     const uint8_t *chroma_qscale_table;  ///< qscale -> chroma_qscale (h263)
319     uint8_t *coded_block_base;
320     uint8_t *coded_block;          ///< used for coded block pattern prediction (msmpeg4v3, wmv1)
321     int16_t (*ac_val_base)[16];
322     int16_t (*ac_val[3])[16];      ///< used for for mpeg4 AC prediction, all 3 arrays must be continuous
323     int mb_skipped;                ///< MUST BE SET only during DECODING
324     uint8_t *mbskip_table;        /**< used to avoid copy if macroblock skipped (for black regions for example)
325                                    and used for b-frame encoding & decoding (contains skip table of next P Frame) */
326     uint8_t *mbintra_table;       ///< used to avoid setting {ac, dc, cbp}-pred stuff to zero on inter MB decoding
327     uint8_t *cbp_table;           ///< used to store cbp, ac_pred for partitioned decoding
328     uint8_t *pred_dir_table;      ///< used to store pred_dir for partitioned decoding
329     uint8_t *edge_emu_buffer;     ///< temporary buffer for if MVs point to out-of-frame data
330     uint8_t *rd_scratchpad;       ///< scratchpad for rate distortion mb decision
331     uint8_t *obmc_scratchpad;
332     uint8_t *b_scratchpad;        ///< scratchpad used for writing into write only buffers
333
334     int qscale;                 ///< QP
335     int chroma_qscale;          ///< chroma QP
336     unsigned int lambda;        ///< lagrange multipler used in rate distortion
337     unsigned int lambda2;       ///< (lambda*lambda) >> FF_LAMBDA_SHIFT
338     int *lambda_table;
339     int adaptive_quant;         ///< use adaptive quantization
340     int dquant;                 ///< qscale difference to prev qscale
341     int pict_type;              ///< AV_PICTURE_TYPE_I, AV_PICTURE_TYPE_P, AV_PICTURE_TYPE_B, ...
342     int last_pict_type; //FIXME removes
343     int last_non_b_pict_type;   ///< used for mpeg4 gmc b-frames & ratecontrol
344     int droppable;
345     int frame_rate_index;
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     BlockDSPContext bdsp;
354     FDCTDSPContext fdsp;
355     HpelDSPContext hdsp;
356     IDCTDSPContext idsp;
357     MECmpContext mecc;
358     MpegVideoDSPContext mdsp;
359     MpegvideoEncDSPContext mpvencdsp;
360     PixblockDSPContext pdsp;
361     QpelDSPContext qdsp;
362     VideoDSPContext vdsp;
363     H263DSPContext h263dsp;
364     int f_code;                 ///< forward MV resolution
365     int b_code;                 ///< backward MV resolution for B Frames (mpeg4)
366     int16_t (*p_mv_table_base)[2];
367     int16_t (*b_forw_mv_table_base)[2];
368     int16_t (*b_back_mv_table_base)[2];
369     int16_t (*b_bidir_forw_mv_table_base)[2];
370     int16_t (*b_bidir_back_mv_table_base)[2];
371     int16_t (*b_direct_mv_table_base)[2];
372     int16_t (*p_field_mv_table_base[2][2])[2];
373     int16_t (*b_field_mv_table_base[2][2][2])[2];
374     int16_t (*p_mv_table)[2];            ///< MV table (1MV per MB) p-frame encoding
375     int16_t (*b_forw_mv_table)[2];       ///< MV table (1MV per MB) forward mode b-frame encoding
376     int16_t (*b_back_mv_table)[2];       ///< MV table (1MV per MB) backward mode b-frame encoding
377     int16_t (*b_bidir_forw_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding
378     int16_t (*b_bidir_back_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding
379     int16_t (*b_direct_mv_table)[2];     ///< MV table (1MV per MB) direct mode b-frame encoding
380     int16_t (*p_field_mv_table[2][2])[2];   ///< MV table (2MV per MB) interlaced p-frame encoding
381     int16_t (*b_field_mv_table[2][2][2])[2];///< MV table (4MV per MB) interlaced b-frame encoding
382     uint8_t (*p_field_select_table[2]);
383     uint8_t (*b_field_select_table[2][2]);
384     int me_method;                       ///< ME algorithm
385     int mv_dir;
386 #define MV_DIR_FORWARD   1
387 #define MV_DIR_BACKWARD  2
388 #define MV_DIRECT        4 ///< bidirectional mode where the difference equals the MV of the last P/S/I-Frame (mpeg4)
389     int mv_type;
390 #define MV_TYPE_16X16       0   ///< 1 vector for the whole mb
391 #define MV_TYPE_8X8         1   ///< 4 vectors (h263, mpeg4 4MV)
392 #define MV_TYPE_16X8        2   ///< 2 vectors, one per 16x8 block
393 #define MV_TYPE_FIELD       3   ///< 2 vectors, one per field
394 #define MV_TYPE_DMV         4   ///< 2 vectors, special mpeg2 Dual Prime Vectors
395     /**motion vectors for a macroblock
396        first coordinate : 0 = forward 1 = backward
397        second "         : depend on type
398        third  "         : 0 = x, 1 = y
399     */
400     int mv[2][4][2];
401     int field_select[2][2];
402     int last_mv[2][2][2];             ///< last MV, used for MV prediction in MPEG1 & B-frame MPEG4
403     uint8_t *fcode_tab;               ///< smallest fcode needed for each MV
404     int16_t direct_scale_mv[2][64];   ///< precomputed to avoid divisions in ff_mpeg4_set_direct_mv
405
406     MotionEstContext me;
407
408     int no_rounding;  /**< apply no rounding to motion compensation (MPEG4, msmpeg4, ...)
409                         for b-frames rounding mode is always 0 */
410
411     /* macroblock layer */
412     int mb_x, mb_y;
413     int mb_skip_run;
414     int mb_intra;
415     uint16_t *mb_type;  ///< Table for candidate MB types for encoding (defines in mpegutils.h)
416
417     int block_index[6]; ///< index to current MB in block based arrays with edges
418     int block_wrap[6];
419     uint8_t *dest[3];
420
421     int *mb_index2xy;        ///< mb_index -> mb_x + mb_y*mb_stride
422
423     /** matrix transmitted in the bitstream */
424     uint16_t intra_matrix[64];
425     uint16_t chroma_intra_matrix[64];
426     uint16_t inter_matrix[64];
427     uint16_t chroma_inter_matrix[64];
428
429     int intra_quant_bias;    ///< bias for the quantizer
430     int inter_quant_bias;    ///< bias for the quantizer
431     int min_qcoeff;          ///< minimum encodable coefficient
432     int max_qcoeff;          ///< maximum encodable coefficient
433     int ac_esc_length;       ///< num of bits needed to encode the longest esc
434     uint8_t *intra_ac_vlc_length;
435     uint8_t *intra_ac_vlc_last_length;
436     uint8_t *inter_ac_vlc_length;
437     uint8_t *inter_ac_vlc_last_length;
438     uint8_t *luma_dc_vlc_length;
439 #define UNI_AC_ENC_INDEX(run,level) ((run)*128 + (level))
440
441     int coded_score[8];
442
443     /** precomputed matrix (combine qscale and DCT renorm) */
444     int (*q_intra_matrix)[64];
445     int (*q_inter_matrix)[64];
446     /** identical to the above but for MMX & these are not permutated, second 64 entries are bias*/
447     uint16_t (*q_intra_matrix16)[2][64];
448     uint16_t (*q_inter_matrix16)[2][64];
449
450     /* noise reduction */
451     int (*dct_error_sum)[64];
452     int dct_count[2];
453     uint16_t (*dct_offset)[64];
454
455     /* bit rate control */
456     int64_t total_bits;
457     int frame_bits;                ///< bits used for the current frame
458     int next_lambda;               ///< next lambda used for retrying to encode a frame
459     RateControlContext rc_context; ///< contains stuff only accessed in ratecontrol.c
460
461     /* statistics, used for 2-pass encoding */
462     int mv_bits;
463     int header_bits;
464     int i_tex_bits;
465     int p_tex_bits;
466     int i_count;
467     int f_count;
468     int b_count;
469     int skip_count;
470     int misc_bits; ///< cbp, mb_type
471     int last_bits; ///< temp var used for calculating the above vars
472
473     /* error concealment / resync */
474     int resync_mb_x;                 ///< x position of last resync marker
475     int resync_mb_y;                 ///< y position of last resync marker
476     GetBitContext last_resync_gb;    ///< used to search for the next resync marker
477     int mb_num_left;                 ///< number of MBs left in this video packet (for partitioned Slices only)
478     int next_p_frame_damaged;        ///< set if the next p frame is damaged, to avoid showing trashed b frames
479     int err_recognition;
480
481     ParseContext parse_context;
482
483     /* H.263 specific */
484     int gob_index;
485     int obmc;                       ///< overlapped block motion compensation
486     int mb_info;                    ///< interval for outputting info about mb offsets as side data
487     int prev_mb_info, last_mb_info;
488     uint8_t *mb_info_ptr;
489     int mb_info_size;
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     PutBitContext tex_pb;            ///< used for data partitioned VOPs
524     PutBitContext pb2;               ///< used for data partitioned VOPs
525     int mpeg_quant;
526     int padding_bug_score;             ///< used to detect the VERY common padding bug in MPEG4
527
528     /* divx specific, used to workaround (many) bugs in divx5 */
529     int divx_packed;
530     uint8_t *bitstream_buffer; //Divx 5.01 puts several frames in a single one, this is used to reorder them
531     int bitstream_buffer_size;
532     unsigned int allocated_bitstream_buffer_size;
533
534     /* RV10 specific */
535     int rv10_version; ///< RV10 version: 0 or 3
536     int rv10_first_dc_coded[3];
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     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)[12][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_intra)(struct MpegEncContext *s, // unquantizer to use (mpeg4 can use both)
623                            int16_t *block/*align 16*/, int n, int qscale);
624     void (*dct_unquantize_inter)(struct MpegEncContext *s, // unquantizer to use (mpeg4 can use both)
625                            int16_t *block/*align 16*/, int n, int qscale);
626     int (*dct_quantize)(struct MpegEncContext *s, int16_t *block/*align 16*/, int n, int qscale, int *overflow);
627     int (*fast_dct_quantize)(struct MpegEncContext *s, int16_t *block/*align 16*/, int n, int qscale, int *overflow);
628     void (*denoise_dct)(struct MpegEncContext *s, int16_t *block);
629
630     int mpv_flags;      ///< flags set by private options
631     int quantizer_noise_shaping;
632
633     /**
634      * ratecontrol qmin qmax limiting method
635      * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
636      */
637     float rc_qsquish;
638     float rc_qmod_amp;
639     int   rc_qmod_freq;
640     float rc_initial_cplx;
641     float rc_buffer_aggressivity;
642     float border_masking;
643     int lmin, lmax;
644
645     char *rc_eq;
646
647     /* temp buffers for rate control */
648     float *cplx_tab, *bits_tab;
649
650     /* flag to indicate a reinitialization is required, e.g. after
651      * a frame size change */
652     int context_reinit;
653
654     ERContext er;
655
656     int error_rate;
657
658     /* temporary frames used by b_frame_strategy = 2 */
659     AVFrame *tmp_frames[MAX_B_FRAMES + 2];
660 } MpegEncContext;
661
662 /* mpegvideo_enc common options */
663 #define FF_MPV_FLAG_SKIP_RD      0x0001
664 #define FF_MPV_FLAG_STRICT_GOP   0x0002
665 #define FF_MPV_FLAG_QP_RD        0x0004
666 #define FF_MPV_FLAG_CBP_RD       0x0008
667 #define FF_MPV_FLAG_NAQ          0x0010
668 #define FF_MPV_FLAG_MV0          0x0020
669
670 #define FF_MPV_OFFSET(x) offsetof(MpegEncContext, x)
671 #define FF_MPV_OPT_FLAGS (AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM)
672 #define FF_MPV_COMMON_OPTS \
673 { "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" },\
674 { "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" },\
675 { "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" },\
676 { "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" },\
677 { "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" },\
678 { "naq",            "normalize adaptive quantization",                   0, AV_OPT_TYPE_CONST, { .i64 = FF_MPV_FLAG_NAQ },    0, 0, FF_MPV_OPT_FLAGS, "mpv_flags" },\
679 { "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" },\
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 {"qsquish", "how to keep quantizer between qmin and qmax (0 = clip, 1 = use differentiable function)",                                                                          \
688                                                                     FF_MPV_OFFSET(rc_qsquish), AV_OPT_TYPE_FLOAT, {.dbl = 0 }, 0, 99, FF_MPV_OPT_FLAGS},                        \
689 {"rc_qmod_amp", "experimental quantizer modulation",                FF_MPV_OFFSET(rc_qmod_amp), AV_OPT_TYPE_FLOAT, {.dbl = 0 }, -FLT_MAX, FLT_MAX, FF_MPV_OPT_FLAGS},           \
690 {"rc_qmod_freq", "experimental quantizer modulation",               FF_MPV_OFFSET(rc_qmod_freq), AV_OPT_TYPE_INT, {.i64 = 0 }, INT_MIN, INT_MAX, FF_MPV_OPT_FLAGS},             \
691 {"rc_eq", "Set rate control equation. When computing the expression, besides the standard functions "                                                                           \
692           "defined in the section 'Expression Evaluation', the following functions are available: "                                                                             \
693           "bits2qp(bits), qp2bits(qp). Also the following constants are available: iTex pTex tex mv "                                                                           \
694           "fCode iCount mcVar var isI isP isB avgQP qComp avgIITex avgPITex avgPPTex avgBPTex avgTex.",                                                                         \
695                                                                     FF_MPV_OFFSET(rc_eq), AV_OPT_TYPE_STRING,                           .flags = FF_MPV_OPT_FLAGS },            \
696 {"rc_init_cplx", "initial complexity for 1-pass encoding",          FF_MPV_OFFSET(rc_initial_cplx), AV_OPT_TYPE_FLOAT, {.dbl = 0 }, -FLT_MAX, FLT_MAX, FF_MPV_OPT_FLAGS},       \
697 {"rc_buf_aggressivity", "currently useless",                        FF_MPV_OFFSET(rc_buffer_aggressivity), AV_OPT_TYPE_FLOAT, {.dbl = 1.0 }, -FLT_MAX, FLT_MAX, FF_MPV_OPT_FLAGS}, \
698 {"border_mask", "increase the quantizer for macroblocks close to borders", FF_MPV_OFFSET(border_masking), AV_OPT_TYPE_FLOAT, {.dbl = 0 }, -FLT_MAX, FLT_MAX, FF_MPV_OPT_FLAGS},    \
699 {"lmin", "minimum Lagrange factor (VBR)",                           FF_MPV_OFFSET(lmin), AV_OPT_TYPE_INT, {.i64 =  2*FF_QP2LAMBDA }, 0, INT_MAX, FF_MPV_OPT_FLAGS },            \
700 {"lmax", "maximum Lagrange factor (VBR)",                           FF_MPV_OFFSET(lmax), AV_OPT_TYPE_INT, {.i64 = 31*FF_QP2LAMBDA }, 0, INT_MAX, FF_MPV_OPT_FLAGS },            \
701
702 extern const AVOption ff_mpv_generic_options[];
703
704 #define FF_MPV_GENERIC_CLASS(name) \
705 static const AVClass name ## _class = {\
706     .class_name = #name " encoder",\
707     .item_name  = av_default_item_name,\
708     .option     = ff_mpv_generic_options,\
709     .version    = LIBAVUTIL_VERSION_INT,\
710 };
711
712 /**
713  * Set the given MpegEncContext to common defaults (same for encoding
714  * and decoding).  The changed fields will not depend upon the prior
715  * state of the MpegEncContext.
716  */
717 void ff_mpv_common_defaults(MpegEncContext *s);
718
719 int ff_mpv_common_init(MpegEncContext *s);
720 void ff_mpv_common_init_arm(MpegEncContext *s);
721 void ff_mpv_common_init_neon(MpegEncContext *s);
722 void ff_mpv_common_init_ppc(MpegEncContext *s);
723 void ff_mpv_common_init_x86(MpegEncContext *s);
724
725 int ff_mpv_common_frame_size_change(MpegEncContext *s);
726 void ff_mpv_common_end(MpegEncContext *s);
727
728 void ff_mpv_decode_defaults(MpegEncContext *s);
729 void ff_mpv_decode_mb(MpegEncContext *s, int16_t block[12][64]);
730 void ff_mpv_report_decode_progress(MpegEncContext *s);
731
732 int ff_mpv_frame_start(MpegEncContext *s, AVCodecContext *avctx);
733 void ff_mpv_frame_end(MpegEncContext *s);
734
735 int ff_mpv_lowest_referenced_row(MpegEncContext *s, int dir);
736
737 int ff_mpv_encode_init(AVCodecContext *avctx);
738 void ff_mpv_encode_init_x86(MpegEncContext *s);
739
740 int ff_mpv_encode_end(AVCodecContext *avctx);
741 int ff_mpv_encode_picture(AVCodecContext *avctx, AVPacket *pkt,
742                           const AVFrame *frame, int *got_packet);
743
744 void ff_clean_intra_table_entries(MpegEncContext *s);
745 void ff_mpeg_draw_horiz_band(MpegEncContext *s, int y, int h);
746 void ff_mpeg_flush(AVCodecContext *avctx);
747 void ff_print_debug_info(MpegEncContext *s, Picture *p);
748 void ff_write_quant_matrix(PutBitContext *pb, uint16_t *matrix);
749 int ff_find_unused_picture(MpegEncContext *s, int shared);
750 int ff_update_duplicate_context(MpegEncContext *dst, MpegEncContext *src);
751 int ff_mpeg_update_thread_context(AVCodecContext *dst, const AVCodecContext *src);
752 void ff_set_qscale(MpegEncContext * s, int qscale);
753
754 void ff_mpv_idct_init(MpegEncContext *s);
755 void ff_convert_matrix(MpegEncContext *s, int (*qmat)[64], uint16_t (*qmat16)[2][64],
756                        const uint16_t *quant_matrix, int bias, int qmin, int qmax, int intra);
757 int ff_dct_quantize_c(MpegEncContext *s, int16_t *block, int n, int qscale, int *overflow);
758
759 void ff_init_block_index(MpegEncContext *s);
760
761 void ff_mpv_motion(MpegEncContext *s,
762                    uint8_t *dest_y, uint8_t *dest_cb,
763                    uint8_t *dest_cr, int dir,
764                    uint8_t **ref_picture,
765                    op_pixels_func (*pix_op)[4],
766                    qpel_mc_func (*qpix_op)[16]);
767
768 /**
769  * Allocate a Picture.
770  * The pixels are allocated/set by calling get_buffer() if shared = 0.
771  */
772 int ff_alloc_picture(MpegEncContext *s, Picture *pic, int shared);
773
774 /**
775  * permute block according to permuatation.
776  * @param last last non zero element in scantable order
777  */
778 void ff_block_permute(int16_t *block, uint8_t *permutation, const uint8_t *scantable, int last);
779
780 static inline void ff_update_block_index(MpegEncContext *s){
781     const int block_size = 8;
782
783     s->block_index[0]+=2;
784     s->block_index[1]+=2;
785     s->block_index[2]+=2;
786     s->block_index[3]+=2;
787     s->block_index[4]++;
788     s->block_index[5]++;
789     s->dest[0]+= 2*block_size;
790     s->dest[1]+= block_size;
791     s->dest[2]+= block_size;
792 }
793
794 static inline int get_bits_diff(MpegEncContext *s){
795     const int bits= put_bits_count(&s->pb);
796     const int last= s->last_bits;
797
798     s->last_bits = bits;
799
800     return bits - last;
801 }
802
803 static inline int ff_h263_round_chroma(int x){
804     static const uint8_t h263_chroma_roundtab[16] = {
805     //  0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15
806         0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1,
807     };
808     return h263_chroma_roundtab[x & 0xf] + (x >> 3);
809 }
810
811 /* motion_est.c */
812 void ff_estimate_p_frame_motion(MpegEncContext * s,
813                              int mb_x, int mb_y);
814 void ff_estimate_b_frame_motion(MpegEncContext * s,
815                              int mb_x, int mb_y);
816 int ff_get_best_fcode(MpegEncContext * s, int16_t (*mv_table)[2], int type);
817 void ff_fix_long_p_mvs(MpegEncContext * s);
818 void ff_fix_long_mvs(MpegEncContext * s, uint8_t *field_select_table, int field_select,
819                      int16_t (*mv_table)[2], int f_code, int type, int truncate);
820 int ff_init_me(MpegEncContext *s);
821 int ff_pre_estimate_p_frame_motion(MpegEncContext * s, int mb_x, int mb_y);
822 int ff_epzs_motion_search(MpegEncContext * s, int *mx_ptr, int *my_ptr,
823                              int P[10][2], int src_index, int ref_index, int16_t (*last_mv)[2],
824                              int ref_mv_scale, int size, int h);
825 int ff_get_mb_score(MpegEncContext * s, int mx, int my, int src_index,
826                                int ref_index, int size, int h, int add_rate);
827
828 /* mpeg12.c */
829 extern const uint8_t ff_mpeg1_dc_scale_table[128];
830 extern const uint8_t * const ff_mpeg2_dc_scale_table[4];
831
832 void ff_mpeg1_encode_picture_header(MpegEncContext *s, int picture_number);
833 void ff_mpeg1_encode_mb(MpegEncContext *s,
834                         int16_t block[8][64],
835                         int motion_x, int motion_y);
836 void ff_mpeg1_encode_init(MpegEncContext *s);
837 void ff_mpeg1_encode_slice_header(MpegEncContext *s);
838
839 extern const uint8_t ff_aic_dc_scale_table[32];
840 extern const uint8_t ff_h263_chroma_qscale_table[32];
841
842 /* rv10.c */
843 int ff_rv10_encode_picture_header(MpegEncContext *s, int picture_number);
844 int ff_rv_decode_dc(MpegEncContext *s, int n);
845 void ff_rv20_encode_picture_header(MpegEncContext *s, int picture_number);
846
847
848 /* msmpeg4.c */
849 void ff_msmpeg4_encode_picture_header(MpegEncContext * s, int picture_number);
850 void ff_msmpeg4_encode_ext_header(MpegEncContext * s);
851 void ff_msmpeg4_encode_mb(MpegEncContext * s,
852                           int16_t block[6][64],
853                           int motion_x, int motion_y);
854 int ff_msmpeg4_decode_picture_header(MpegEncContext * s);
855 int ff_msmpeg4_decode_ext_header(MpegEncContext * s, int buf_size);
856 int ff_msmpeg4_decode_init(AVCodecContext *avctx);
857 int ff_msmpeg4_encode_init(MpegEncContext *s);
858 int ff_wmv2_decode_picture_header(MpegEncContext * s);
859 int ff_wmv2_decode_secondary_picture_header(MpegEncContext * s);
860 void ff_wmv2_add_mb(MpegEncContext *s, int16_t block[6][64], uint8_t *dest_y, uint8_t *dest_cb, uint8_t *dest_cr);
861 void ff_mspel_motion(MpegEncContext *s,
862                                uint8_t *dest_y, uint8_t *dest_cb, uint8_t *dest_cr,
863                                uint8_t **ref_picture, op_pixels_func (*pix_op)[4],
864                                int motion_x, int motion_y, int h);
865 int ff_wmv2_encode_picture_header(MpegEncContext * s, int picture_number);
866 void ff_wmv2_encode_mb(MpegEncContext * s,
867                        int16_t block[6][64],
868                        int motion_x, int motion_y);
869
870 int ff_mpeg_ref_picture(MpegEncContext *s, Picture *dst, Picture *src);
871 void ff_mpeg_unref_picture(MpegEncContext *s, Picture *picture);
872 void ff_free_picture_tables(Picture *pic);
873
874 #endif /* AVCODEC_MPEGVIDEO_H */