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