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