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