Merge commit '910247f1720c6aae422723c05dac6d0b19f20bec'
[ffmpeg.git] / libavcodec / mpegvideo.h
1 /*
2  * Generic DCT based hybrid video encoder
3  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
4  * Copyright (c) 2002-2004 Michael Niedermayer
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * mpegvideo header.
26  */
27
28 #ifndef AVCODEC_MPEGVIDEO_H
29 #define AVCODEC_MPEGVIDEO_H
30
31 #include <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 "h264chroma.h"
39 #include "h263dsp.h"
40 #include "hpeldsp.h"
41 #include "idctdsp.h"
42 #include "me_cmp.h"
43 #include "motion_est.h"
44 #include "mpegpicture.h"
45 #include "mpegvideodsp.h"
46 #include "mpegvideoencdsp.h"
47 #include "pixblockdsp.h"
48 #include "put_bits.h"
49 #include "ratecontrol.h"
50 #include "parser.h"
51 #include "mpegutils.h"
52 #include "mpeg12data.h"
53 #include "qpeldsp.h"
54 #include "thread.h"
55 #include "videodsp.h"
56
57 #include "libavutil/opt.h"
58 #include "libavutil/timecode.h"
59
60 #define FRAME_SKIPPED 100 ///< return value for header parsers if frame is not coded
61
62 #define MAX_FCODE 7
63
64 #define MAX_THREADS 32
65
66 #define MAX_B_FRAMES 16
67
68 #define ME_MAP_SIZE 64
69
70 #define MAX_MB_BYTES (30*16*16*3/8 + 120)
71
72 #define INPLACE_OFFSET 16
73
74 /* Start codes. */
75 #define SEQ_END_CODE            0x000001b7
76 #define SEQ_START_CODE          0x000001b3
77 #define GOP_START_CODE          0x000001b8
78 #define PICTURE_START_CODE      0x00000100
79 #define SLICE_MIN_START_CODE    0x00000101
80 #define SLICE_MAX_START_CODE    0x000001af
81 #define EXT_START_CODE          0x000001b5
82 #define USER_START_CODE         0x000001b2
83
84 /**
85  * MpegEncContext.
86  */
87 typedef struct MpegEncContext {
88     AVClass *class;
89
90     int y_dc_scale, c_dc_scale;
91     int ac_pred;
92     int block_last_index[12];  ///< last non zero coefficient in block
93     int h263_aic;              ///< Advanded INTRA Coding (AIC)
94
95     /* scantables */
96     ScanTable inter_scantable; ///< if inter == intra then intra should be used to reduce tha cache usage
97     ScanTable intra_scantable;
98     ScanTable intra_h_scantable;
99     ScanTable intra_v_scantable;
100
101     /* WARNING: changes above this line require updates to hardcoded
102      *          offsets used in asm. */
103
104     struct AVCodecContext *avctx;
105     /* the following parameters must be initialized before encoding */
106     int width, height;///< picture size. must be a multiple of 16
107     int gop_size;
108     int intra_only;   ///< if true, only intra pictures are generated
109     int bit_rate;     ///< wanted bit rate
110     enum OutputFormat out_format; ///< output format
111     int h263_pred;    ///< use mpeg4/h263 ac/dc predictions
112     int pb_frame;     ///< PB frame mode (0 = none, 1 = base, 2 = improved)
113
114 /* the following codec id fields are deprecated in favor of codec_id */
115     int h263_plus;    ///< h263 plus headers
116     int h263_flv;     ///< use flv h263 header
117
118     enum AVCodecID codec_id;     /* see AV_CODEC_ID_xxx */
119     int fixed_qscale; ///< fixed qscale if non zero
120     int encoding;     ///< true if we are encoding (vs decoding)
121     int max_b_frames; ///< max number of b-frames for encoding
122     int luma_elim_threshold;
123     int chroma_elim_threshold;
124     int strict_std_compliance; ///< strictly follow the std (MPEG4, ...)
125     int workaround_bugs;       ///< workaround bugs in encoders which cannot be detected automatically
126     int codec_tag;             ///< internal codec_tag upper case converted from avctx codec_tag
127     /* the following fields are managed internally by the encoder */
128
129     /* sequence parameters */
130     int context_initialized;
131     int input_picture_number;  ///< used to set pic->display_picture_number, should not be used for/by anything else
132     int coded_picture_number;  ///< used to set pic->coded_picture_number, should not be used for/by anything else
133     int picture_number;       //FIXME remove, unclear definition
134     int picture_in_gop_number; ///< 0-> first pic in gop, ...
135     int mb_width, mb_height;   ///< number of MBs horizontally & vertically
136     int mb_stride;             ///< mb_width+1 used for some arrays to allow simple addressing of left & top MBs without sig11
137     int b8_stride;             ///< 2*mb_width+1 used for some 8x8 block arrays to allow simple addressing
138     int h_edge_pos, v_edge_pos;///< horizontal / vertical position of the right/bottom edge (pixel replication)
139     int mb_num;                ///< number of MBs of a picture
140     ptrdiff_t linesize;        ///< line size, in bytes, may be different from width
141     ptrdiff_t uvlinesize;      ///< line size, for chroma in bytes, may be different from width
142     Picture *picture;          ///< main picture buffer
143     Picture **input_picture;   ///< next pictures on display order for encoding
144     Picture **reordered_input_picture; ///< pointer to the next pictures in codedorder for encoding
145
146     int64_t user_specified_pts; ///< last non-zero pts from AVFrame which was passed into avcodec_encode_video2()
147     /**
148      * pts difference between the first and second input frame, used for
149      * calculating dts of the first frame when there's a delay */
150     int64_t dts_delta;
151     /**
152      * reordered pts to be used as dts for the next output frame when there's
153      * a delay */
154     int64_t reordered_pts;
155
156     /** bit output */
157     PutBitContext pb;
158
159     int start_mb_y;            ///< start mb_y of this thread (so current thread should process start_mb_y <= row < end_mb_y)
160     int end_mb_y;              ///< end   mb_y of this thread (so current thread should process start_mb_y <= row < end_mb_y)
161     struct MpegEncContext *thread_context[MAX_THREADS];
162     int slice_context_count;   ///< number of used thread_contexts
163
164     /**
165      * copy of the previous picture structure.
166      * note, linesize & data, might not match the previous picture (for field pictures)
167      */
168     Picture last_picture;
169
170     /**
171      * copy of the next picture structure.
172      * note, linesize & data, might not match the next picture (for field pictures)
173      */
174     Picture next_picture;
175
176     /**
177      * copy of the source picture structure for encoding.
178      * note, linesize & data, might not match the source picture (for field pictures)
179      */
180     Picture new_picture;
181
182     /**
183      * copy of the current picture structure.
184      * note, linesize & data, might not match the current picture (for field pictures)
185      */
186     Picture current_picture;    ///< buffer to store the decompressed current picture
187
188     Picture *last_picture_ptr;     ///< pointer to the previous picture.
189     Picture *next_picture_ptr;     ///< pointer to the next picture (for bidir pred)
190     Picture *current_picture_ptr;  ///< pointer to the current picture
191     int last_dc[3];                ///< last DC values for MPEG1
192     int16_t *dc_val_base;
193     int16_t *dc_val[3];            ///< used for mpeg4 DC prediction, all 3 arrays must be continuous
194     const uint8_t *y_dc_scale_table;     ///< qscale -> y_dc_scale table
195     const uint8_t *c_dc_scale_table;     ///< qscale -> c_dc_scale table
196     const uint8_t *chroma_qscale_table;  ///< qscale -> chroma_qscale (h263)
197     uint8_t *coded_block_base;
198     uint8_t *coded_block;          ///< used for coded block pattern prediction (msmpeg4v3, wmv1)
199     int16_t (*ac_val_base)[16];
200     int16_t (*ac_val[3])[16];      ///< used for mpeg4 AC prediction, all 3 arrays must be continuous
201     int mb_skipped;                ///< MUST BE SET only during DECODING
202     uint8_t *mbskip_table;        /**< used to avoid copy if macroblock skipped (for black regions for example)
203                                    and used for b-frame encoding & decoding (contains skip table of next P Frame) */
204     uint8_t *mbintra_table;       ///< used to avoid setting {ac, dc, cbp}-pred stuff to zero on inter MB decoding
205     uint8_t *cbp_table;           ///< used to store cbp, ac_pred for partitioned decoding
206     uint8_t *pred_dir_table;      ///< used to store pred_dir for partitioned decoding
207
208     ScratchpadContext sc;
209
210     int qscale;                 ///< QP
211     int chroma_qscale;          ///< chroma QP
212     unsigned int lambda;        ///< lagrange multipler used in rate distortion
213     unsigned int lambda2;       ///< (lambda*lambda) >> FF_LAMBDA_SHIFT
214     int *lambda_table;
215     int adaptive_quant;         ///< use adaptive quantization
216     int dquant;                 ///< qscale difference to prev qscale
217     int closed_gop;             ///< MPEG1/2 GOP is closed
218     int pict_type;              ///< AV_PICTURE_TYPE_I, AV_PICTURE_TYPE_P, AV_PICTURE_TYPE_B, ...
219     int vbv_delay;
220     int last_pict_type; //FIXME removes
221     int last_non_b_pict_type;   ///< used for mpeg4 gmc b-frames & ratecontrol
222     int droppable;
223     int frame_rate_index;
224     AVRational mpeg2_frame_rate_ext;
225     int last_lambda_for[5];     ///< last lambda for a specific pict type
226     int skipdct;                ///< skip dct and code zero residual
227
228     /* motion compensation */
229     int unrestricted_mv;        ///< mv can point outside of the coded picture
230     int h263_long_vectors;      ///< use horrible h263v1 long vector mode
231
232     BlockDSPContext bdsp;
233     FDCTDSPContext fdsp;
234     H264ChromaContext h264chroma;
235     HpelDSPContext hdsp;
236     IDCTDSPContext idsp;
237     MECmpContext mecc;
238     MpegVideoDSPContext mdsp;
239     MpegvideoEncDSPContext mpvencdsp;
240     PixblockDSPContext pdsp;
241     QpelDSPContext qdsp;
242     VideoDSPContext vdsp;
243     H263DSPContext h263dsp;
244     int f_code;                 ///< forward MV resolution
245     int b_code;                 ///< backward MV resolution for B Frames (mpeg4)
246     int16_t (*p_mv_table_base)[2];
247     int16_t (*b_forw_mv_table_base)[2];
248     int16_t (*b_back_mv_table_base)[2];
249     int16_t (*b_bidir_forw_mv_table_base)[2];
250     int16_t (*b_bidir_back_mv_table_base)[2];
251     int16_t (*b_direct_mv_table_base)[2];
252     int16_t (*p_field_mv_table_base[2][2])[2];
253     int16_t (*b_field_mv_table_base[2][2][2])[2];
254     int16_t (*p_mv_table)[2];            ///< MV table (1MV per MB) p-frame encoding
255     int16_t (*b_forw_mv_table)[2];       ///< MV table (1MV per MB) forward mode b-frame encoding
256     int16_t (*b_back_mv_table)[2];       ///< MV table (1MV per MB) backward mode b-frame encoding
257     int16_t (*b_bidir_forw_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding
258     int16_t (*b_bidir_back_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding
259     int16_t (*b_direct_mv_table)[2];     ///< MV table (1MV per MB) direct mode b-frame encoding
260     int16_t (*p_field_mv_table[2][2])[2];   ///< MV table (2MV per MB) interlaced p-frame encoding
261     int16_t (*b_field_mv_table[2][2][2])[2];///< MV table (4MV per MB) interlaced b-frame encoding
262     uint8_t (*p_field_select_table[2]);
263     uint8_t (*b_field_select_table[2][2]);
264     int me_method;                       ///< ME algorithm
265     int mv_dir;
266 #define MV_DIR_FORWARD   1
267 #define MV_DIR_BACKWARD  2
268 #define MV_DIRECT        4 ///< bidirectional mode where the difference equals the MV of the last P/S/I-Frame (mpeg4)
269     int mv_type;
270 #define MV_TYPE_16X16       0   ///< 1 vector for the whole mb
271 #define MV_TYPE_8X8         1   ///< 4 vectors (h263, mpeg4 4MV)
272 #define MV_TYPE_16X8        2   ///< 2 vectors, one per 16x8 block
273 #define MV_TYPE_FIELD       3   ///< 2 vectors, one per field
274 #define MV_TYPE_DMV         4   ///< 2 vectors, special mpeg2 Dual Prime Vectors
275     /**motion vectors for a macroblock
276        first coordinate : 0 = forward 1 = backward
277        second "         : depend on type
278        third  "         : 0 = x, 1 = y
279     */
280     int mv[2][4][2];
281     int field_select[2][2];
282     int last_mv[2][2][2];             ///< last MV, used for MV prediction in MPEG1 & B-frame MPEG4
283     uint8_t *fcode_tab;               ///< smallest fcode needed for each MV
284     int16_t direct_scale_mv[2][64];   ///< precomputed to avoid divisions in ff_mpeg4_set_direct_mv
285
286     MotionEstContext me;
287
288     int no_rounding;  /**< apply no rounding to motion compensation (MPEG4, msmpeg4, ...)
289                         for b-frames rounding mode is always 0 */
290
291     /* macroblock layer */
292     int mb_x, mb_y;
293     int mb_skip_run;
294     int mb_intra;
295     uint16_t *mb_type;  ///< Table for candidate MB types for encoding (defines in mpegutils.h)
296
297     int block_index[6]; ///< index to current MB in block based arrays with edges
298     int block_wrap[6];
299     uint8_t *dest[3];
300
301     int *mb_index2xy;        ///< mb_index -> mb_x + mb_y*mb_stride
302
303     /** matrix transmitted in the bitstream */
304     uint16_t intra_matrix[64];
305     uint16_t chroma_intra_matrix[64];
306     uint16_t inter_matrix[64];
307     uint16_t chroma_inter_matrix[64];
308
309     int intra_quant_bias;    ///< bias for the quantizer
310     int inter_quant_bias;    ///< bias for the quantizer
311     int min_qcoeff;          ///< minimum encodable coefficient
312     int max_qcoeff;          ///< maximum encodable coefficient
313     int ac_esc_length;       ///< num of bits needed to encode the longest esc
314     uint8_t *intra_ac_vlc_length;
315     uint8_t *intra_ac_vlc_last_length;
316     uint8_t *intra_chroma_ac_vlc_length;
317     uint8_t *intra_chroma_ac_vlc_last_length;
318     uint8_t *inter_ac_vlc_length;
319     uint8_t *inter_ac_vlc_last_length;
320     uint8_t *luma_dc_vlc_length;
321 #define UNI_AC_ENC_INDEX(run,level) ((run)*128 + (level))
322
323     int coded_score[12];
324
325     /** precomputed matrix (combine qscale and DCT renorm) */
326     int (*q_intra_matrix)[64];
327     int (*q_chroma_intra_matrix)[64];
328     int (*q_inter_matrix)[64];
329     /** identical to the above but for MMX & these are not permutated, second 64 entries are bias*/
330     uint16_t (*q_intra_matrix16)[2][64];
331     uint16_t (*q_chroma_intra_matrix16)[2][64];
332     uint16_t (*q_inter_matrix16)[2][64];
333
334     /* noise reduction */
335     int (*dct_error_sum)[64];
336     int dct_count[2];
337     uint16_t (*dct_offset)[64];
338
339     /* bit rate control */
340     int64_t total_bits;
341     int frame_bits;                ///< bits used for the current frame
342     int stuffing_bits;             ///< bits used for stuffing
343     int next_lambda;               ///< next lambda used for retrying to encode a frame
344     RateControlContext rc_context; ///< contains stuff only accessed in ratecontrol.c
345
346     /* statistics, used for 2-pass encoding */
347     int mv_bits;
348     int header_bits;
349     int i_tex_bits;
350     int p_tex_bits;
351     int i_count;
352     int f_count;
353     int b_count;
354     int skip_count;
355     int misc_bits; ///< cbp, mb_type
356     int last_bits; ///< temp var used for calculating the above vars
357
358     /* error concealment / resync */
359     int resync_mb_x;                 ///< x position of last resync marker
360     int resync_mb_y;                 ///< y position of last resync marker
361     GetBitContext last_resync_gb;    ///< used to search for the next resync marker
362     int mb_num_left;                 ///< number of MBs left in this video packet (for partitioned Slices only)
363     int next_p_frame_damaged;        ///< set if the next p frame is damaged, to avoid showing trashed b frames
364
365     ParseContext parse_context;
366
367     /* H.263 specific */
368     int gob_index;
369     int obmc;                       ///< overlapped block motion compensation
370     int mb_info;                    ///< interval for outputting info about mb offsets as side data
371     int prev_mb_info, last_mb_info;
372     uint8_t *mb_info_ptr;
373     int mb_info_size;
374     int ehc_mode;
375
376     /* H.263+ specific */
377     int umvplus;                    ///< == H263+ && unrestricted_mv
378     int h263_aic_dir;               ///< AIC direction: 0 = left, 1 = top
379     int h263_slice_structured;
380     int alt_inter_vlc;              ///< alternative inter vlc
381     int modified_quant;
382     int loop_filter;
383     int custom_pcf;
384
385     /* mpeg4 specific */
386     ///< number of bits to represent the fractional part of time (encoder only)
387     int time_increment_bits;
388     int last_time_base;
389     int time_base;                  ///< time in seconds of last I,P,S Frame
390     int64_t time;                   ///< time of current frame
391     int64_t last_non_b_time;
392     uint16_t pp_time;               ///< time distance between the last 2 p,s,i frames
393     uint16_t pb_time;               ///< time distance between the last b and p,s,i frame
394     uint16_t pp_field_time;
395     uint16_t pb_field_time;         ///< like above, just for interlaced
396     int real_sprite_warping_points;
397     int sprite_offset[2][2];         ///< sprite offset[isChroma][isMVY]
398     int sprite_delta[2][2];          ///< sprite_delta [isY][isMVY]
399     int mcsel;
400     int quant_precision;
401     int quarter_sample;              ///< 1->qpel, 0->half pel ME/MC
402     int aspect_ratio_info; //FIXME remove
403     int sprite_warping_accuracy;
404     int data_partitioning;           ///< data partitioning flag from header
405     int partitioned_frame;           ///< is current frame partitioned
406     int low_delay;                   ///< no reordering needed / has no b-frames
407     int vo_type;
408     PutBitContext tex_pb;            ///< used for data partitioned VOPs
409     PutBitContext pb2;               ///< used for data partitioned VOPs
410     int mpeg_quant;
411     int padding_bug_score;             ///< used to detect the VERY common padding bug in MPEG4
412
413     /* divx specific, used to workaround (many) bugs in divx5 */
414     int divx_packed;
415     uint8_t *bitstream_buffer; //Divx 5.01 puts several frames in a single one, this is used to reorder them
416     int bitstream_buffer_size;
417     unsigned int allocated_bitstream_buffer_size;
418
419     /* RV10 specific */
420     int rv10_version; ///< RV10 version: 0 or 3
421     int rv10_first_dc_coded[3];
422
423     /* MJPEG specific */
424     struct MJpegContext *mjpeg_ctx;
425     int esc_pos;
426
427     /* MSMPEG4 specific */
428     int mv_table_index;
429     int rl_table_index;
430     int rl_chroma_table_index;
431     int dc_table_index;
432     int use_skip_mb_code;
433     int slice_height;      ///< in macroblocks
434     int first_slice_line;  ///< used in mpeg4 too to handle resync markers
435     int flipflop_rounding;
436     int msmpeg4_version;   ///< 0=not msmpeg4, 1=mp41, 2=mp42, 3=mp43/divx3 4=wmv1/7 5=wmv2/8
437     int per_mb_rl_table;
438     int esc3_level_length;
439     int esc3_run_length;
440     /** [mb_intra][isChroma][level][run][last] */
441     int (*ac_stats)[2][MAX_LEVEL+1][MAX_RUN+1][2];
442     int inter_intra_pred;
443     int mspel;
444
445     /* decompression specific */
446     GetBitContext gb;
447
448     /* Mpeg1 specific */
449     int gop_picture_number;  ///< index of the first picture of a GOP based on fake_pic_num & mpeg1 specific
450     int last_mv_dir;         ///< last mv_dir, used for b frame encoding
451     uint8_t *vbv_delay_ptr;  ///< pointer to vbv_delay in the bitstream
452
453     /* MPEG-2-specific - I wished not to have to support this mess. */
454     int progressive_sequence;
455     int mpeg_f_code[2][2];
456
457     // picture structure defines are loaded from mpegutils.h
458     int picture_structure;
459
460     int intra_dc_precision;
461     int frame_pred_frame_dct;
462     int top_field_first;
463     int concealment_motion_vectors;
464     int q_scale_type;
465     int intra_vlc_format;
466     int alternate_scan;
467     int seq_disp_ext;
468     int repeat_first_field;
469     int chroma_420_type;
470     int chroma_format;
471 #define CHROMA_420 1
472 #define CHROMA_422 2
473 #define CHROMA_444 3
474     int chroma_x_shift;//depend on pix_format, that depend on chroma_format
475     int chroma_y_shift;
476
477     int progressive_frame;
478     int full_pel[2];
479     int interlaced_dct;
480     int first_field;         ///< is 1 for the first field of a field picture 0 otherwise
481     int drop_frame_timecode; ///< timecode is in drop frame format.
482     int scan_offset;         ///< reserve space for SVCD scan offset user data.
483
484     /* RTP specific */
485     int rtp_mode;
486
487     char *tc_opt_str;        ///< timecode option string
488     AVTimecode tc;           ///< timecode context
489
490     uint8_t *ptr_lastgob;
491     int swap_uv;             //vcr2 codec is an MPEG-2 variant with U and V swapped
492     int pack_pblocks;        //xvmc needs to keep blocks without gaps.
493     int16_t (*pblocks[12])[64];
494
495     int16_t (*block)[64]; ///< points to one of the following blocks
496     int16_t (*blocks)[12][64]; // for HQ mode we need to keep the best block
497     int (*decode_mb)(struct MpegEncContext *s, int16_t block[6][64]); // used by some codecs to avoid a switch()
498 #define SLICE_OK         0
499 #define SLICE_ERROR     -1
500 #define SLICE_END       -2 ///<end marker found
501 #define SLICE_NOEND     -3 ///<no end marker or error found but mb count exceeded
502
503     void (*dct_unquantize_mpeg1_intra)(struct MpegEncContext *s,
504                            int16_t *block/*align 16*/, int n, int qscale);
505     void (*dct_unquantize_mpeg1_inter)(struct MpegEncContext *s,
506                            int16_t *block/*align 16*/, int n, int qscale);
507     void (*dct_unquantize_mpeg2_intra)(struct MpegEncContext *s,
508                            int16_t *block/*align 16*/, int n, int qscale);
509     void (*dct_unquantize_mpeg2_inter)(struct MpegEncContext *s,
510                            int16_t *block/*align 16*/, int n, int qscale);
511     void (*dct_unquantize_h263_intra)(struct MpegEncContext *s,
512                            int16_t *block/*align 16*/, int n, int qscale);
513     void (*dct_unquantize_h263_inter)(struct MpegEncContext *s,
514                            int16_t *block/*align 16*/, int n, int qscale);
515     void (*dct_unquantize_intra)(struct MpegEncContext *s, // unquantizer to use (mpeg4 can use both)
516                            int16_t *block/*align 16*/, int n, int qscale);
517     void (*dct_unquantize_inter)(struct MpegEncContext *s, // unquantizer to use (mpeg4 can use both)
518                            int16_t *block/*align 16*/, int n, int qscale);
519     int (*dct_quantize)(struct MpegEncContext *s, int16_t *block/*align 16*/, int n, int qscale, int *overflow);
520     int (*fast_dct_quantize)(struct MpegEncContext *s, int16_t *block/*align 16*/, int n, int qscale, int *overflow);
521     void (*denoise_dct)(struct MpegEncContext *s, int16_t *block);
522
523     int mpv_flags;      ///< flags set by private options
524     int quantizer_noise_shaping;
525
526     /**
527      * ratecontrol qmin qmax limiting method
528      * 0-> clipping, 1-> use a nice continuous function to limit qscale within qmin/qmax.
529      */
530     float rc_qsquish;
531     float rc_qmod_amp;
532     int   rc_qmod_freq;
533     float rc_initial_cplx;
534     float rc_buffer_aggressivity;
535     float border_masking;
536     int lmin, lmax;
537
538     char *rc_eq;
539
540     /* temp buffers for rate control */
541     float *cplx_tab, *bits_tab;
542
543     /* flag to indicate a reinitialization is required, e.g. after
544      * a frame size change */
545     int context_reinit;
546
547     ERContext er;
548
549     int error_rate;
550
551     /* temporary frames used by b_frame_strategy = 2 */
552     AVFrame *tmp_frames[MAX_B_FRAMES + 2];
553 } MpegEncContext;
554
555 /* mpegvideo_enc common options */
556 #define FF_MPV_FLAG_SKIP_RD      0x0001
557 #define FF_MPV_FLAG_STRICT_GOP   0x0002
558 #define FF_MPV_FLAG_QP_RD        0x0004
559 #define FF_MPV_FLAG_CBP_RD       0x0008
560 #define FF_MPV_FLAG_NAQ          0x0010
561 #define FF_MPV_FLAG_MV0          0x0020
562
563 #ifndef FF_MPV_OFFSET
564 #define FF_MPV_OFFSET(x) offsetof(MpegEncContext, x)
565 #endif
566 #define FF_MPV_OPT_FLAGS (AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM)
567 #define FF_MPV_COMMON_OPTS \
568 { "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" },\
569 { "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" },\
570 { "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" },\
571 { "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" },\
572 { "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" },\
573 { "naq",            "normalize adaptive quantization",                   0, AV_OPT_TYPE_CONST, { .i64 = FF_MPV_FLAG_NAQ },    0, 0, FF_MPV_OPT_FLAGS, "mpv_flags" },\
574 { "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" },\
575 { "luma_elim_threshold",   "single coefficient elimination threshold for luminance (negative values also consider dc coefficient)",\
576                                                                       FF_MPV_OFFSET(luma_elim_threshold), AV_OPT_TYPE_INT, { .i64 = 0 }, INT_MIN, INT_MAX, FF_MPV_OPT_FLAGS },\
577 { "chroma_elim_threshold", "single coefficient elimination threshold for chrominance (negative values also consider dc coefficient)",\
578                                                                       FF_MPV_OFFSET(chroma_elim_threshold), AV_OPT_TYPE_INT, { .i64 = 0 }, INT_MIN, INT_MAX, FF_MPV_OPT_FLAGS },\
579 { "quantizer_noise_shaping", NULL,                                  FF_MPV_OFFSET(quantizer_noise_shaping), AV_OPT_TYPE_INT, { .i64 = 0 },       0, INT_MAX, FF_MPV_OPT_FLAGS },\
580 { "error_rate", "Simulate errors in the bitstream to test error concealment.",                                                                                                  \
581                                                                     FF_MPV_OFFSET(error_rate),              AV_OPT_TYPE_INT, { .i64 = 0 },       0, INT_MAX, FF_MPV_OPT_FLAGS },\
582 {"qsquish", "how to keep quantizer between qmin and qmax (0 = clip, 1 = use differentiable function)",                                                                          \
583                                                                     FF_MPV_OFFSET(rc_qsquish), AV_OPT_TYPE_FLOAT, {.dbl = 0 }, 0, 99, FF_MPV_OPT_FLAGS},                        \
584 {"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},           \
585 {"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},             \
586 {"rc_eq", "Set rate control equation. When computing the expression, besides the standard functions "                                                                           \
587           "defined in the section 'Expression Evaluation', the following functions are available: "                                                                             \
588           "bits2qp(bits), qp2bits(qp). Also the following constants are available: iTex pTex tex mv "                                                                           \
589           "fCode iCount mcVar var isI isP isB avgQP qComp avgIITex avgPITex avgPPTex avgBPTex avgTex.",                                                                         \
590                                                                     FF_MPV_OFFSET(rc_eq), AV_OPT_TYPE_STRING,                           .flags = FF_MPV_OPT_FLAGS },            \
591 {"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},       \
592 {"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}, \
593 {"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},    \
594 {"lmin", "minimum Lagrange factor (VBR)",                           FF_MPV_OFFSET(lmin), AV_OPT_TYPE_INT, {.i64 =  2*FF_QP2LAMBDA }, 0, INT_MAX, FF_MPV_OPT_FLAGS },            \
595 {"lmax", "maximum Lagrange factor (VBR)",                           FF_MPV_OFFSET(lmax), AV_OPT_TYPE_INT, {.i64 = 31*FF_QP2LAMBDA }, 0, INT_MAX, FF_MPV_OPT_FLAGS },            \
596 {"ibias", "intra quant bias",                                       FF_MPV_OFFSET(intra_quant_bias), AV_OPT_TYPE_INT, {.i64 = FF_DEFAULT_QUANT_BIAS }, INT_MIN, INT_MAX, FF_MPV_OPT_FLAGS },   \
597 {"pbias", "inter quant bias",                                       FF_MPV_OFFSET(inter_quant_bias), AV_OPT_TYPE_INT, {.i64 = FF_DEFAULT_QUANT_BIAS }, INT_MIN, INT_MAX, FF_MPV_OPT_FLAGS },   \
598
599 extern const AVOption ff_mpv_generic_options[];
600
601 /**
602  * Set the given MpegEncContext to common defaults (same for encoding
603  * and decoding).  The changed fields will not depend upon the prior
604  * state of the MpegEncContext.
605  */
606 void ff_mpv_common_defaults(MpegEncContext *s);
607
608 void ff_dct_encode_init_x86(MpegEncContext *s);
609
610 int ff_mpv_common_init(MpegEncContext *s);
611 void ff_mpv_common_init_arm(MpegEncContext *s);
612 void ff_mpv_common_init_axp(MpegEncContext *s);
613 void ff_mpv_common_init_neon(MpegEncContext *s);
614 void ff_mpv_common_init_ppc(MpegEncContext *s);
615 void ff_mpv_common_init_x86(MpegEncContext *s);
616 void ff_mpv_common_init_mips(MpegEncContext *s);
617
618 int ff_mpv_common_frame_size_change(MpegEncContext *s);
619 void ff_mpv_common_end(MpegEncContext *s);
620
621 void ff_mpv_decode_defaults(MpegEncContext *s);
622 void ff_mpv_decode_init(MpegEncContext *s, AVCodecContext *avctx);
623 void ff_mpv_decode_mb(MpegEncContext *s, int16_t block[12][64]);
624 void ff_mpv_report_decode_progress(MpegEncContext *s);
625
626 int ff_mpv_frame_start(MpegEncContext *s, AVCodecContext *avctx);
627 void ff_mpv_frame_end(MpegEncContext *s);
628
629 int ff_mpv_encode_init(AVCodecContext *avctx);
630 void ff_mpv_encode_init_x86(MpegEncContext *s);
631
632 int ff_mpv_encode_end(AVCodecContext *avctx);
633 int ff_mpv_encode_picture(AVCodecContext *avctx, AVPacket *pkt,
634                           const AVFrame *frame, int *got_packet);
635 int ff_mpv_reallocate_putbitbuffer(MpegEncContext *s, size_t threshold, size_t size_increase);
636
637 void ff_clean_intra_table_entries(MpegEncContext *s);
638 void ff_mpeg_draw_horiz_band(MpegEncContext *s, int y, int h);
639 void ff_mpeg_flush(AVCodecContext *avctx);
640
641 void ff_print_debug_info(MpegEncContext *s, Picture *p, AVFrame *pict);
642 void ff_print_debug_info2(AVCodecContext *avctx, AVFrame *pict, uint8_t *mbskip_table,
643                          uint32_t *mbtype_table, int8_t *qscale_table, int16_t (*motion_val[2])[2],
644                          int *low_delay,
645                          int mb_width, int mb_height, int mb_stride, int quarter_sample);
646
647 int ff_mpv_export_qp_table(MpegEncContext *s, AVFrame *f, Picture *p, int qp_type);
648
649 void ff_write_quant_matrix(PutBitContext *pb, uint16_t *matrix);
650
651 int ff_update_duplicate_context(MpegEncContext *dst, MpegEncContext *src);
652 int ff_mpeg_update_thread_context(AVCodecContext *dst, const AVCodecContext *src);
653 void ff_set_qscale(MpegEncContext * s, int qscale);
654
655 void ff_mpv_idct_init(MpegEncContext *s);
656 int ff_dct_encode_init(MpegEncContext *s);
657 void ff_convert_matrix(MpegEncContext *s, int (*qmat)[64], uint16_t (*qmat16)[2][64],
658                        const uint16_t *quant_matrix, int bias, int qmin, int qmax, int intra);
659 int ff_dct_quantize_c(MpegEncContext *s, int16_t *block, int n, int qscale, int *overflow);
660
661 void ff_init_block_index(MpegEncContext *s);
662
663 void ff_mpv_motion(MpegEncContext *s,
664                    uint8_t *dest_y, uint8_t *dest_cb,
665                    uint8_t *dest_cr, int dir,
666                    uint8_t **ref_picture,
667                    op_pixels_func (*pix_op)[4],
668                    qpel_mc_func (*qpix_op)[16]);
669
670 static inline void ff_update_block_index(MpegEncContext *s){
671     const int block_size= 8 >> s->avctx->lowres;
672
673     s->block_index[0]+=2;
674     s->block_index[1]+=2;
675     s->block_index[2]+=2;
676     s->block_index[3]+=2;
677     s->block_index[4]++;
678     s->block_index[5]++;
679     s->dest[0]+= 2*block_size;
680     s->dest[1]+= block_size;
681     s->dest[2]+= block_size;
682 }
683
684 static inline int get_bits_diff(MpegEncContext *s){
685     const int bits= put_bits_count(&s->pb);
686     const int last= s->last_bits;
687
688     s->last_bits = bits;
689
690     return bits - last;
691 }
692
693 #endif /* AVCODEC_MPEGVIDEO_H */