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