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