Merge commit '0338c396987c82b41d322630ea9712fe5f9561d6'
[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 "avcodec.h"
32 #include "dsputil.h"
33 #include "error_resilience.h"
34 #include "get_bits.h"
35 #include "h264chroma.h"
36 #include "h263dsp.h"
37 #include "hpeldsp.h"
38 #include "put_bits.h"
39 #include "ratecontrol.h"
40 #include "parser.h"
41 #include "mpeg12data.h"
42 #include "rl.h"
43 #include "thread.h"
44 #include "videodsp.h"
45
46 #include "libavutil/opt.h"
47 #include "libavutil/timecode.h"
48
49 #define FRAME_SKIPPED 100 ///< return value for header parsers if frame is not coded
50
51 enum OutputFormat {
52     FMT_MPEG1,
53     FMT_H261,
54     FMT_H263,
55     FMT_MJPEG,
56 };
57
58 #define MPEG_BUF_SIZE (16 * 1024)
59
60 #define QMAT_SHIFT_MMX 16
61 #define QMAT_SHIFT 21
62
63 #define MAX_FCODE 7
64 #define MAX_MV 4096
65
66 #define MAX_THREADS 32
67 #define MAX_PICTURE_COUNT 36
68
69 #define ME_MAP_SIZE 64
70 #define ME_MAP_SHIFT 3
71 #define ME_MAP_MV_BITS 11
72
73 #define MAX_MB_BYTES (30*16*16*3/8 + 120)
74
75 #define INPLACE_OFFSET 16
76
77 /* Start codes. */
78 #define SEQ_END_CODE            0x000001b7
79 #define SEQ_START_CODE          0x000001b3
80 #define GOP_START_CODE          0x000001b8
81 #define PICTURE_START_CODE      0x00000100
82 #define SLICE_MIN_START_CODE    0x00000101
83 #define SLICE_MAX_START_CODE    0x000001af
84 #define EXT_START_CODE          0x000001b5
85 #define USER_START_CODE         0x000001b2
86
87 /**
88  * Value of Picture.reference when Picture is not a reference picture, but
89  * is held for delayed output.
90  */
91 #define DELAYED_PIC_REF 4
92
93 struct MpegEncContext;
94
95 /**
96  * Picture.
97  */
98 typedef struct Picture{
99     struct AVFrame f;
100     ThreadFrame tf;
101
102     AVBufferRef *qscale_table_buf;
103     int8_t *qscale_table;
104
105     AVBufferRef *motion_val_buf[2];
106     int16_t (*motion_val[2])[2];
107
108     AVBufferRef *mb_type_buf;
109     uint32_t *mb_type;
110
111     AVBufferRef *mbskip_table_buf;
112     uint8_t *mbskip_table;
113
114     AVBufferRef *ref_index_buf[2];
115     int8_t *ref_index[2];
116
117     AVBufferRef *mb_var_buf;
118     uint16_t *mb_var;           ///< Table for MB variances
119
120     AVBufferRef *mc_mb_var_buf;
121     uint16_t *mc_mb_var;        ///< Table for motion compensated MB variances
122
123     int alloc_mb_width;         ///< mb_width used to allocate tables
124     int alloc_mb_height;        ///< mb_height used to allocate tables
125
126     AVBufferRef *mb_mean_buf;
127     uint8_t *mb_mean;           ///< Table for MB luminance
128
129     AVBufferRef *hwaccel_priv_buf;
130     /**
131      * hardware accelerator private data
132      */
133     void *hwaccel_picture_private;
134
135 #define MB_TYPE_INTRA MB_TYPE_INTRA4x4 //default mb_type if there is just one type
136 #define IS_INTRA4x4(a)   ((a)&MB_TYPE_INTRA4x4)
137 #define IS_INTRA16x16(a) ((a)&MB_TYPE_INTRA16x16)
138 #define IS_PCM(a)        ((a)&MB_TYPE_INTRA_PCM)
139 #define IS_INTRA(a)      ((a)&7)
140 #define IS_INTER(a)      ((a)&(MB_TYPE_16x16|MB_TYPE_16x8|MB_TYPE_8x16|MB_TYPE_8x8))
141 #define IS_SKIP(a)       ((a)&MB_TYPE_SKIP)
142 #define IS_INTRA_PCM(a)  ((a)&MB_TYPE_INTRA_PCM)
143 #define IS_INTERLACED(a) ((a)&MB_TYPE_INTERLACED)
144 #define IS_DIRECT(a)     ((a)&MB_TYPE_DIRECT2)
145 #define IS_GMC(a)        ((a)&MB_TYPE_GMC)
146 #define IS_16X16(a)      ((a)&MB_TYPE_16x16)
147 #define IS_16X8(a)       ((a)&MB_TYPE_16x8)
148 #define IS_8X16(a)       ((a)&MB_TYPE_8x16)
149 #define IS_8X8(a)        ((a)&MB_TYPE_8x8)
150 #define IS_SUB_8X8(a)    ((a)&MB_TYPE_16x16) //note reused
151 #define IS_SUB_8X4(a)    ((a)&MB_TYPE_16x8)  //note reused
152 #define IS_SUB_4X8(a)    ((a)&MB_TYPE_8x16)  //note reused
153 #define IS_SUB_4X4(a)    ((a)&MB_TYPE_8x8)   //note reused
154 #define IS_ACPRED(a)     ((a)&MB_TYPE_ACPRED)
155 #define IS_QUANT(a)      ((a)&MB_TYPE_QUANT)
156 #define IS_DIR(a, part, list) ((a) & (MB_TYPE_P0L0<<((part)+2*(list))))
157 #define USES_LIST(a, list) ((a) & ((MB_TYPE_P0L0|MB_TYPE_P1L0)<<(2*(list)))) ///< does this mb use listX, note does not work if subMBs
158 #define HAS_CBP(a)        ((a)&MB_TYPE_CBP)
159
160     int field_poc[2];           ///< h264 top/bottom POC
161     int poc;                    ///< h264 frame POC
162     int frame_num;              ///< h264 frame_num (raw frame_num from slice header)
163     int mmco_reset;             ///< h264 MMCO_RESET set this 1. Reordering code must not mix pictures before and after MMCO_RESET.
164     int pic_id;                 /**< h264 pic_num (short -> no wrap version of pic_num,
165                                      pic_num & max_pic_num; long -> long_pic_num) */
166     int long_ref;               ///< 1->long term reference 0->short term reference
167     int ref_poc[2][2][32];      ///< h264 POCs of the frames/fields used as reference (FIXME need per slice)
168     int ref_count[2][2];        ///< number of entries in ref_poc              (FIXME need per slice)
169     int mbaff;                  ///< h264 1 -> MBAFF frame 0-> not MBAFF
170     int field_picture;          ///< whether or not the picture was encoded in separate fields
171
172     int mb_var_sum;             ///< sum of MB variance for current frame
173     int mc_mb_var_sum;          ///< motion compensated MB variance for current frame
174
175     int b_frame_score;
176     int needs_realloc;          ///< Picture needs to be reallocated (eg due to a frame size change)
177
178     int reference;
179     int shared;
180     int recovered;              ///< Picture at IDR or recovery point + recovery count
181
182     int crop;
183     int crop_left;
184     int crop_top;
185 } Picture;
186
187 /**
188  * Motion estimation context.
189  */
190 typedef struct MotionEstContext{
191     AVCodecContext *avctx;
192     int skip;                          ///< set if ME is skipped for the current MB
193     int co_located_mv[4][2];           ///< mv from last P-frame for direct mode ME
194     int direct_basis_mv[4][2];
195     uint8_t *scratchpad;               ///< data area for the ME algo, so that the ME does not need to malloc/free
196     uint8_t *best_mb;
197     uint8_t *temp_mb[2];
198     uint8_t *temp;
199     int best_bits;
200     uint32_t *map;                     ///< map to avoid duplicate evaluations
201     uint32_t *score_map;               ///< map to store the scores
202     unsigned map_generation;
203     int pre_penalty_factor;
204     int penalty_factor;                /**< an estimate of the bits required to
205                                         code a given mv value, e.g. (1,0) takes
206                                         more bits than (0,0). We have to
207                                         estimate whether any reduction in
208                                         residual is worth the extra bits. */
209     int sub_penalty_factor;
210     int mb_penalty_factor;
211     int flags;
212     int sub_flags;
213     int mb_flags;
214     int pre_pass;                      ///< = 1 for the pre pass
215     int dia_size;
216     int xmin;
217     int xmax;
218     int ymin;
219     int ymax;
220     int pred_x;
221     int pred_y;
222     uint8_t *src[4][4];
223     uint8_t *ref[4][4];
224     int stride;
225     int uvstride;
226     /* temp variables for picture complexity calculation */
227     int mc_mb_var_sum_temp;
228     int mb_var_sum_temp;
229     int scene_change_score;
230 /*    cmp, chroma_cmp;*/
231     op_pixels_func (*hpel_put)[4];
232     op_pixels_func (*hpel_avg)[4];
233     qpel_mc_func (*qpel_put)[16];
234     qpel_mc_func (*qpel_avg)[16];
235     uint8_t (*mv_penalty)[MAX_MV*2+1];  ///< amount of bits needed to encode a MV
236     uint8_t *current_mv_penalty;
237     int (*sub_motion_search)(struct MpegEncContext * s,
238                                   int *mx_ptr, int *my_ptr, int dmin,
239                                   int src_index, int ref_index,
240                                   int size, int h);
241 }MotionEstContext;
242
243 /**
244  * MpegEncContext.
245  */
246 typedef struct MpegEncContext {
247     AVClass *class;
248     struct AVCodecContext *avctx;
249     /* the following parameters must be initialized before encoding */
250     int width, height;///< picture size. must be a multiple of 16
251     int gop_size;
252     int intra_only;   ///< if true, only intra pictures are generated
253     int bit_rate;     ///< wanted bit rate
254     enum OutputFormat out_format; ///< output format
255     int h263_pred;    ///< use mpeg4/h263 ac/dc predictions
256     int pb_frame;     ///< PB frame mode (0 = none, 1 = base, 2 = improved)
257
258 /* the following codec id fields are deprecated in favor of codec_id */
259     int h263_plus;    ///< h263 plus headers
260     int h263_flv;     ///< use flv h263 header
261
262     enum AVCodecID codec_id;     /* see AV_CODEC_ID_xxx */
263     int fixed_qscale; ///< fixed qscale if non zero
264     int encoding;     ///< true if we are encoding (vs decoding)
265     int flags;        ///< AVCodecContext.flags (HQ, MV4, ...)
266     int flags2;       ///< AVCodecContext.flags2
267     int max_b_frames; ///< max number of b-frames for encoding
268     int luma_elim_threshold;
269     int chroma_elim_threshold;
270     int strict_std_compliance; ///< strictly follow the std (MPEG4, ...)
271     int workaround_bugs;       ///< workaround bugs in encoders which cannot be detected automatically
272     int codec_tag;             ///< internal codec_tag upper case converted from avctx codec_tag
273     int stream_codec_tag;      ///< internal stream_codec_tag upper case converted from avctx stream_codec_tag
274     /* the following fields are managed internally by the encoder */
275
276     /* sequence parameters */
277     int context_initialized;
278     int input_picture_number;  ///< used to set pic->display_picture_number, should not be used for/by anything else
279     int coded_picture_number;  ///< used to set pic->coded_picture_number, should not be used for/by anything else
280     int picture_number;       //FIXME remove, unclear definition
281     int picture_in_gop_number; ///< 0-> first pic in gop, ...
282     int mb_width, mb_height;   ///< number of MBs horizontally & vertically
283     int mb_stride;             ///< mb_width+1 used for some arrays to allow simple addressing of left & top MBs without sig11
284     int b8_stride;             ///< 2*mb_width+1 used for some 8x8 block arrays to allow simple addressing
285     int b4_stride;             ///< 4*mb_width+1 used for some 4x4 block arrays to allow simple addressing
286     int h_edge_pos, v_edge_pos;///< horizontal / vertical position of the right/bottom edge (pixel replication)
287     int mb_num;                ///< number of MBs of a picture
288     ptrdiff_t linesize;        ///< line size, in bytes, may be different from width
289     ptrdiff_t uvlinesize;      ///< line size, for chroma in bytes, may be different from width
290     Picture *picture;          ///< main picture buffer
291     Picture **input_picture;   ///< next pictures on display order for encoding
292     Picture **reordered_input_picture; ///< pointer to the next pictures in codedorder for encoding
293
294     int y_dc_scale, c_dc_scale;
295     int ac_pred;
296     int block_last_index[12];  ///< last non zero coefficient in block
297     int h263_aic;              ///< Advanded INTRA Coding (AIC)
298
299     /* scantables */
300     ScanTable inter_scantable; ///< if inter == intra then intra should be used to reduce tha cache usage
301     ScanTable intra_scantable;
302     ScanTable intra_h_scantable;
303     ScanTable intra_v_scantable;
304
305     /* WARNING: changes above this line require updates to hardcoded
306      *          offsets used in asm. */
307
308     int64_t user_specified_pts; ///< last non-zero pts from AVFrame which was passed into avcodec_encode_video2()
309     /**
310      * pts difference between the first and second input frame, used for
311      * calculating dts of the first frame when there's a delay */
312     int64_t dts_delta;
313     /**
314      * reordered pts to be used as dts for the next output frame when there's
315      * a delay */
316     int64_t reordered_pts;
317
318     /** bit output */
319     PutBitContext pb;
320
321     int start_mb_y;            ///< start mb_y of this thread (so current thread should process start_mb_y <= row < end_mb_y)
322     int end_mb_y;              ///< end   mb_y of this thread (so current thread should process start_mb_y <= row < end_mb_y)
323     struct MpegEncContext *thread_context[MAX_THREADS];
324     int slice_context_count;   ///< number of used thread_contexts
325
326     /**
327      * copy of the previous picture structure.
328      * note, linesize & data, might not match the previous picture (for field pictures)
329      */
330     Picture last_picture;
331
332     /**
333      * copy of the next picture structure.
334      * note, linesize & data, might not match the next picture (for field pictures)
335      */
336     Picture next_picture;
337
338     /**
339      * copy of the source picture structure for encoding.
340      * note, linesize & data, might not match the source picture (for field pictures)
341      */
342     Picture new_picture;
343
344     /**
345      * copy of the current picture structure.
346      * note, linesize & data, might not match the current picture (for field pictures)
347      */
348     Picture current_picture;    ///< buffer to store the decompressed current picture
349
350     Picture *last_picture_ptr;     ///< pointer to the previous picture.
351     Picture *next_picture_ptr;     ///< pointer to the next picture (for bidir pred)
352     Picture *current_picture_ptr;  ///< pointer to the current picture
353     int last_dc[3];                ///< last DC values for MPEG1
354     int16_t *dc_val_base;
355     int16_t *dc_val[3];            ///< used for mpeg4 DC prediction, all 3 arrays must be continuous
356     const uint8_t *y_dc_scale_table;     ///< qscale -> y_dc_scale table
357     const uint8_t *c_dc_scale_table;     ///< qscale -> c_dc_scale table
358     const uint8_t *chroma_qscale_table;  ///< qscale -> chroma_qscale (h263)
359     uint8_t *coded_block_base;
360     uint8_t *coded_block;          ///< used for coded block pattern prediction (msmpeg4v3, wmv1)
361     int16_t (*ac_val_base)[16];
362     int16_t (*ac_val[3])[16];      ///< used for mpeg4 AC prediction, all 3 arrays must be continuous
363     int mb_skipped;                ///< MUST BE SET only during DECODING
364     uint8_t *mbskip_table;        /**< used to avoid copy if macroblock skipped (for black regions for example)
365                                    and used for b-frame encoding & decoding (contains skip table of next P Frame) */
366     uint8_t *mbintra_table;       ///< used to avoid setting {ac, dc, cbp}-pred stuff to zero on inter MB decoding
367     uint8_t *cbp_table;           ///< used to store cbp, ac_pred for partitioned decoding
368     uint8_t *pred_dir_table;      ///< used to store pred_dir for partitioned decoding
369     uint8_t *edge_emu_buffer;     ///< temporary buffer for if MVs point to out-of-frame data
370     uint8_t *rd_scratchpad;       ///< scratchpad for rate distortion mb decision
371     uint8_t *obmc_scratchpad;
372     uint8_t *b_scratchpad;        ///< scratchpad used for writing into write only buffers
373
374     int qscale;                 ///< QP
375     int chroma_qscale;          ///< chroma QP
376     unsigned int lambda;        ///< lagrange multipler used in rate distortion
377     unsigned int lambda2;       ///< (lambda*lambda) >> FF_LAMBDA_SHIFT
378     int *lambda_table;
379     int adaptive_quant;         ///< use adaptive quantization
380     int dquant;                 ///< qscale difference to prev qscale
381     int closed_gop;             ///< MPEG1/2 GOP is closed
382     int pict_type;              ///< AV_PICTURE_TYPE_I, AV_PICTURE_TYPE_P, AV_PICTURE_TYPE_B, ...
383     int vbv_delay;
384     int last_pict_type; //FIXME removes
385     int last_non_b_pict_type;   ///< used for mpeg4 gmc b-frames & ratecontrol
386     int droppable;
387     int frame_rate_index;
388     AVRational mpeg2_frame_rate_ext;
389     int last_lambda_for[5];     ///< last lambda for a specific pict type
390     int skipdct;                ///< skip dct and code zero residual
391
392     /* motion compensation */
393     int unrestricted_mv;        ///< mv can point outside of the coded picture
394     int h263_long_vectors;      ///< use horrible h263v1 long vector mode
395
396     DSPContext dsp;             ///< pointers for accelerated dsp functions
397     H264ChromaContext h264chroma;
398     HpelDSPContext hdsp;
399     VideoDSPContext vdsp;
400     H263DSPContext h263dsp;
401     int f_code;                 ///< forward MV resolution
402     int b_code;                 ///< backward MV resolution for B Frames (mpeg4)
403     int16_t (*p_mv_table_base)[2];
404     int16_t (*b_forw_mv_table_base)[2];
405     int16_t (*b_back_mv_table_base)[2];
406     int16_t (*b_bidir_forw_mv_table_base)[2];
407     int16_t (*b_bidir_back_mv_table_base)[2];
408     int16_t (*b_direct_mv_table_base)[2];
409     int16_t (*p_field_mv_table_base[2][2])[2];
410     int16_t (*b_field_mv_table_base[2][2][2])[2];
411     int16_t (*p_mv_table)[2];            ///< MV table (1MV per MB) p-frame encoding
412     int16_t (*b_forw_mv_table)[2];       ///< MV table (1MV per MB) forward mode b-frame encoding
413     int16_t (*b_back_mv_table)[2];       ///< MV table (1MV per MB) backward mode b-frame encoding
414     int16_t (*b_bidir_forw_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding
415     int16_t (*b_bidir_back_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding
416     int16_t (*b_direct_mv_table)[2];     ///< MV table (1MV per MB) direct mode b-frame encoding
417     int16_t (*p_field_mv_table[2][2])[2];   ///< MV table (2MV per MB) interlaced p-frame encoding
418     int16_t (*b_field_mv_table[2][2][2])[2];///< MV table (4MV per MB) interlaced b-frame encoding
419     uint8_t (*p_field_select_table[2]);
420     uint8_t (*b_field_select_table[2][2]);
421     int me_method;                       ///< ME algorithm
422     int mv_dir;
423 #define MV_DIR_FORWARD   1
424 #define MV_DIR_BACKWARD  2
425 #define MV_DIRECT        4 ///< bidirectional mode where the difference equals the MV of the last P/S/I-Frame (mpeg4)
426     int mv_type;
427 #define MV_TYPE_16X16       0   ///< 1 vector for the whole mb
428 #define MV_TYPE_8X8         1   ///< 4 vectors (h263, mpeg4 4MV)
429 #define MV_TYPE_16X8        2   ///< 2 vectors, one per 16x8 block
430 #define MV_TYPE_FIELD       3   ///< 2 vectors, one per field
431 #define MV_TYPE_DMV         4   ///< 2 vectors, special mpeg2 Dual Prime Vectors
432     /**motion vectors for a macroblock
433        first coordinate : 0 = forward 1 = backward
434        second "         : depend on type
435        third  "         : 0 = x, 1 = y
436     */
437     int mv[2][4][2];
438     int field_select[2][2];
439     int last_mv[2][2][2];             ///< last MV, used for MV prediction in MPEG1 & B-frame MPEG4
440     uint8_t *fcode_tab;               ///< smallest fcode needed for each MV
441     int16_t direct_scale_mv[2][64];   ///< precomputed to avoid divisions in ff_mpeg4_set_direct_mv
442
443     MotionEstContext me;
444
445     int no_rounding;  /**< apply no rounding to motion compensation (MPEG4, msmpeg4, ...)
446                         for b-frames rounding mode is always 0 */
447
448     /* macroblock layer */
449     int mb_x, mb_y;
450     int mb_skip_run;
451     int mb_intra;
452     uint16_t *mb_type;           ///< Table for candidate MB types for encoding
453 #define CANDIDATE_MB_TYPE_INTRA    0x01
454 #define CANDIDATE_MB_TYPE_INTER    0x02
455 #define CANDIDATE_MB_TYPE_INTER4V  0x04
456 #define CANDIDATE_MB_TYPE_SKIPPED   0x08
457 //#define MB_TYPE_GMC      0x10
458
459 #define CANDIDATE_MB_TYPE_DIRECT   0x10
460 #define CANDIDATE_MB_TYPE_FORWARD  0x20
461 #define CANDIDATE_MB_TYPE_BACKWARD 0x40
462 #define CANDIDATE_MB_TYPE_BIDIR    0x80
463
464 #define CANDIDATE_MB_TYPE_INTER_I    0x100
465 #define CANDIDATE_MB_TYPE_FORWARD_I  0x200
466 #define CANDIDATE_MB_TYPE_BACKWARD_I 0x400
467 #define CANDIDATE_MB_TYPE_BIDIR_I    0x800
468
469 #define CANDIDATE_MB_TYPE_DIRECT0    0x1000
470
471     int block_index[6]; ///< index to current MB in block based arrays with edges
472     int block_wrap[6];
473     uint8_t *dest[3];
474
475     int *mb_index2xy;        ///< mb_index -> mb_x + mb_y*mb_stride
476
477     /** matrix transmitted in the bitstream */
478     uint16_t intra_matrix[64];
479     uint16_t chroma_intra_matrix[64];
480     uint16_t inter_matrix[64];
481     uint16_t chroma_inter_matrix[64];
482 #define QUANT_BIAS_SHIFT 8
483     int intra_quant_bias;    ///< bias for the quantizer
484     int inter_quant_bias;    ///< bias for the quantizer
485     int min_qcoeff;          ///< minimum encodable coefficient
486     int max_qcoeff;          ///< maximum encodable coefficient
487     int ac_esc_length;       ///< num of bits needed to encode the longest esc
488     uint8_t *intra_ac_vlc_length;
489     uint8_t *intra_ac_vlc_last_length;
490     uint8_t *inter_ac_vlc_length;
491     uint8_t *inter_ac_vlc_last_length;
492     uint8_t *luma_dc_vlc_length;
493 #define UNI_AC_ENC_INDEX(run,level) ((run)*128 + (level))
494
495     int coded_score[12];
496
497     /** precomputed matrix (combine qscale and DCT renorm) */
498     int (*q_intra_matrix)[64];
499     int (*q_chroma_intra_matrix)[64];
500     int (*q_inter_matrix)[64];
501     /** identical to the above but for MMX & these are not permutated, second 64 entries are bias*/
502     uint16_t (*q_intra_matrix16)[2][64];
503     uint16_t (*q_chroma_intra_matrix16)[2][64];
504     uint16_t (*q_inter_matrix16)[2][64];
505
506     /* noise reduction */
507     int (*dct_error_sum)[64];
508     int dct_count[2];
509     uint16_t (*dct_offset)[64];
510
511     void *opaque;              ///< private data for the user
512
513     /* bit rate control */
514     int64_t total_bits;
515     int frame_bits;                ///< bits used for the current frame
516     int stuffing_bits;             ///< bits used for stuffing
517     int next_lambda;               ///< next lambda used for retrying to encode a frame
518     RateControlContext rc_context; ///< contains stuff only accessed in ratecontrol.c
519
520     /* statistics, used for 2-pass encoding */
521     int mv_bits;
522     int header_bits;
523     int i_tex_bits;
524     int p_tex_bits;
525     int i_count;
526     int f_count;
527     int b_count;
528     int skip_count;
529     int misc_bits; ///< cbp, mb_type
530     int last_bits; ///< temp var used for calculating the above vars
531
532     /* error concealment / resync */
533     int resync_mb_x;                 ///< x position of last resync marker
534     int resync_mb_y;                 ///< y position of last resync marker
535     GetBitContext last_resync_gb;    ///< used to search for the next resync marker
536     int mb_num_left;                 ///< number of MBs left in this video packet (for partitioned Slices only)
537     int next_p_frame_damaged;        ///< set if the next p frame is damaged, to avoid showing trashed b frames
538     int err_recognition;
539
540     ParseContext parse_context;
541
542     /* H.263 specific */
543     int gob_index;
544     int obmc;                       ///< overlapped block motion compensation
545     int showed_packed_warning;      ///< flag for having shown the warning about divxs invalid b frames
546     int mb_info;                    ///< interval for outputting info about mb offsets as side data
547     int prev_mb_info, last_mb_info;
548     uint8_t *mb_info_ptr;
549     int mb_info_size;
550     int ehc_mode;
551
552     /* H.263+ specific */
553     int umvplus;                    ///< == H263+ && unrestricted_mv
554     int h263_aic_dir;               ///< AIC direction: 0 = left, 1 = top
555     int h263_slice_structured;
556     int alt_inter_vlc;              ///< alternative inter vlc
557     int modified_quant;
558     int loop_filter;
559     int custom_pcf;
560
561     /* mpeg4 specific */
562     int time_increment_bits;        ///< number of bits to represent the fractional part of time
563     int last_time_base;
564     int time_base;                  ///< time in seconds of last I,P,S Frame
565     int64_t time;                   ///< time of current frame
566     int64_t last_non_b_time;
567     uint16_t pp_time;               ///< time distance between the last 2 p,s,i frames
568     uint16_t pb_time;               ///< time distance between the last b and p,s,i frame
569     uint16_t pp_field_time;
570     uint16_t pb_field_time;         ///< like above, just for interlaced
571     int shape;
572     int vol_sprite_usage;
573     int sprite_width;
574     int sprite_height;
575     int sprite_left;
576     int sprite_top;
577     int sprite_brightness_change;
578     int num_sprite_warping_points;
579     int real_sprite_warping_points;
580     uint16_t sprite_traj[4][2];      ///< sprite trajectory points
581     int sprite_offset[2][2];         ///< sprite offset[isChroma][isMVY]
582     int sprite_delta[2][2];          ///< sprite_delta [isY][isMVY]
583     int sprite_shift[2];             ///< sprite shift [isChroma]
584     int mcsel;
585     int quant_precision;
586     int quarter_sample;              ///< 1->qpel, 0->half pel ME/MC
587     int scalability;
588     int hierachy_type;
589     int enhancement_type;
590     int new_pred;
591     int reduced_res_vop;
592     int aspect_ratio_info; //FIXME remove
593     int sprite_warping_accuracy;
594     int low_latency_sprite;
595     int data_partitioning;           ///< data partitioning flag from header
596     int partitioned_frame;           ///< is current frame partitioned
597     int rvlc;                        ///< reversible vlc
598     int resync_marker;               ///< could this stream contain resync markers
599     int low_delay;                   ///< no reordering needed / has no b-frames
600     int vo_type;
601     int vol_control_parameters;      ///< does the stream contain the low_delay flag, used to workaround buggy encoders
602     int intra_dc_threshold;          ///< QP above whch the ac VLC should be used for intra dc
603     int use_intra_dc_vlc;
604     PutBitContext tex_pb;            ///< used for data partitioned VOPs
605     PutBitContext pb2;               ///< used for data partitioned VOPs
606     int mpeg_quant;
607     int t_frame;                       ///< time distance of first I -> B, used for interlaced b frames
608     int padding_bug_score;             ///< used to detect the VERY common padding bug in MPEG4
609     int cplx_estimation_trash_i;
610     int cplx_estimation_trash_p;
611     int cplx_estimation_trash_b;
612
613     /* divx specific, used to workaround (many) bugs in divx5 */
614     int divx_version;
615     int divx_build;
616     int divx_packed;
617     uint8_t *bitstream_buffer; //Divx 5.01 puts several frames in a single one, this is used to reorder them
618     int bitstream_buffer_size;
619     unsigned int allocated_bitstream_buffer_size;
620
621     int xvid_build;
622
623     /* lavc specific stuff, used to workaround bugs in libavcodec */
624     int lavc_build;
625
626     /* RV10 specific */
627     int rv10_version; ///< RV10 version: 0 or 3
628     int rv10_first_dc_coded[3];
629     int orig_width, orig_height;
630
631     /* MJPEG specific */
632     struct MJpegContext *mjpeg_ctx;
633     int mjpeg_vsample[3];       ///< vertical sampling factors, default = {2, 1, 1}
634     int mjpeg_hsample[3];       ///< horizontal sampling factors, default = {2, 1, 1}
635     int esc_pos;
636
637     /* MSMPEG4 specific */
638     int mv_table_index;
639     int rl_table_index;
640     int rl_chroma_table_index;
641     int dc_table_index;
642     int use_skip_mb_code;
643     int slice_height;      ///< in macroblocks
644     int first_slice_line;  ///< used in mpeg4 too to handle resync markers
645     int flipflop_rounding;
646     int msmpeg4_version;   ///< 0=not msmpeg4, 1=mp41, 2=mp42, 3=mp43/divx3 4=wmv1/7 5=wmv2/8
647     int per_mb_rl_table;
648     int esc3_level_length;
649     int esc3_run_length;
650     /** [mb_intra][isChroma][level][run][last] */
651     int (*ac_stats)[2][MAX_LEVEL+1][MAX_RUN+1][2];
652     int inter_intra_pred;
653     int mspel;
654
655     /* decompression specific */
656     GetBitContext gb;
657
658     /* Mpeg1 specific */
659     int gop_picture_number;  ///< index of the first picture of a GOP based on fake_pic_num & mpeg1 specific
660     int last_mv_dir;         ///< last mv_dir, used for b frame encoding
661     int broken_link;         ///< no_output_of_prior_pics_flag
662     uint8_t *vbv_delay_ptr;  ///< pointer to vbv_delay in the bitstream
663
664     /* MPEG-2-specific - I wished not to have to support this mess. */
665     int progressive_sequence;
666     int mpeg_f_code[2][2];
667     int picture_structure;
668 /* picture type */
669 #define PICT_TOP_FIELD     1
670 #define PICT_BOTTOM_FIELD  2
671 #define PICT_FRAME         3
672
673     int intra_dc_precision;
674     int frame_pred_frame_dct;
675     int top_field_first;
676     int concealment_motion_vectors;
677     int q_scale_type;
678     int intra_vlc_format;
679     int alternate_scan;
680     int repeat_first_field;
681     int chroma_420_type;
682     int chroma_format;
683 #define CHROMA_420 1
684 #define CHROMA_422 2
685 #define CHROMA_444 3
686     int chroma_x_shift;//depend on pix_format, that depend on chroma_format
687     int chroma_y_shift;
688
689     int progressive_frame;
690     int full_pel[2];
691     int interlaced_dct;
692     int first_slice;
693     int first_field;         ///< is 1 for the first field of a field picture 0 otherwise
694     int drop_frame_timecode; ///< timecode is in drop frame format.
695     int scan_offset;         ///< reserve space for SVCD scan offset user data.
696
697     /* RTP specific */
698     int rtp_mode;
699
700     char *tc_opt_str;        ///< timecode option string
701     AVTimecode tc;           ///< timecode context
702
703     uint8_t *ptr_lastgob;
704     int swap_uv;             //vcr2 codec is an MPEG-2 variant with U and V swapped
705     int16_t (*pblocks[12])[64];
706
707     int16_t (*block)[64]; ///< points to one of the following blocks
708     int16_t (*blocks)[12][64]; // for HQ mode we need to keep the best block
709     int (*decode_mb)(struct MpegEncContext *s, int16_t block[6][64]); // used by some codecs to avoid a switch()
710 #define SLICE_OK         0
711 #define SLICE_ERROR     -1
712 #define SLICE_END       -2 ///<end marker found
713 #define SLICE_NOEND     -3 ///<no end marker or error found but mb count exceeded
714
715     void (*dct_unquantize_mpeg1_intra)(struct MpegEncContext *s,
716                            int16_t *block/*align 16*/, int n, int qscale);
717     void (*dct_unquantize_mpeg1_inter)(struct MpegEncContext *s,
718                            int16_t *block/*align 16*/, int n, int qscale);
719     void (*dct_unquantize_mpeg2_intra)(struct MpegEncContext *s,
720                            int16_t *block/*align 16*/, int n, int qscale);
721     void (*dct_unquantize_mpeg2_inter)(struct MpegEncContext *s,
722                            int16_t *block/*align 16*/, int n, int qscale);
723     void (*dct_unquantize_h263_intra)(struct MpegEncContext *s,
724                            int16_t *block/*align 16*/, int n, int qscale);
725     void (*dct_unquantize_h263_inter)(struct MpegEncContext *s,
726                            int16_t *block/*align 16*/, int n, int qscale);
727     void (*dct_unquantize_h261_intra)(struct MpegEncContext *s,
728                            int16_t *block/*align 16*/, int n, int qscale);
729     void (*dct_unquantize_h261_inter)(struct MpegEncContext *s,
730                            int16_t *block/*align 16*/, int n, int qscale);
731     void (*dct_unquantize_intra)(struct MpegEncContext *s, // unquantizer to use (mpeg4 can use both)
732                            int16_t *block/*align 16*/, int n, int qscale);
733     void (*dct_unquantize_inter)(struct MpegEncContext *s, // unquantizer to use (mpeg4 can use both)
734                            int16_t *block/*align 16*/, int n, int qscale);
735     int (*dct_quantize)(struct MpegEncContext *s, int16_t *block/*align 16*/, int n, int qscale, int *overflow);
736     int (*fast_dct_quantize)(struct MpegEncContext *s, int16_t *block/*align 16*/, int n, int qscale, int *overflow);
737     void (*denoise_dct)(struct MpegEncContext *s, int16_t *block);
738
739     int mpv_flags;      ///< flags set by private options
740     int quantizer_noise_shaping;
741
742     /* temp buffers for rate control */
743     float *cplx_tab, *bits_tab;
744
745     /* flag to indicate a reinitialization is required, e.g. after
746      * a frame size change */
747     int context_reinit;
748
749     ERContext er;
750 } MpegEncContext;
751
752 #define REBASE_PICTURE(pic, new_ctx, old_ctx)             \
753     ((pic && pic >= old_ctx->picture &&                   \
754       pic < old_ctx->picture + MAX_PICTURE_COUNT) ?  \
755         &new_ctx->picture[pic - old_ctx->picture] : NULL)
756
757 /* mpegvideo_enc common options */
758 #define FF_MPV_FLAG_SKIP_RD      0x0001
759 #define FF_MPV_FLAG_STRICT_GOP   0x0002
760 #define FF_MPV_FLAG_QP_RD        0x0004
761 #define FF_MPV_FLAG_CBP_RD       0x0008
762
763 #define FF_MPV_OFFSET(x) offsetof(MpegEncContext, x)
764 #define FF_MPV_OPT_FLAGS (AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM)
765 #define FF_MPV_COMMON_OPTS \
766 { "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" },\
767 { "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" },\
768 { "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" },\
769 { "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" },\
770 { "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" },\
771 { "luma_elim_threshold",   "single coefficient elimination threshold for luminance (negative values also consider dc coefficient)",\
772                                                                       FF_MPV_OFFSET(luma_elim_threshold), AV_OPT_TYPE_INT, { .i64 = 0 }, INT_MIN, INT_MAX, FF_MPV_OPT_FLAGS },\
773 { "chroma_elim_threshold", "single coefficient elimination threshold for chrominance (negative values also consider dc coefficient)",\
774                                                                       FF_MPV_OFFSET(chroma_elim_threshold), AV_OPT_TYPE_INT, { .i64 = 0 }, INT_MIN, INT_MAX, FF_MPV_OPT_FLAGS },\
775 { "quantizer_noise_shaping", NULL,                                  FF_MPV_OFFSET(quantizer_noise_shaping), AV_OPT_TYPE_INT, { .i64 = 0 },       0, INT_MAX, FF_MPV_OPT_FLAGS },
776
777 extern const AVOption ff_mpv_generic_options[];
778
779 #define FF_MPV_GENERIC_CLASS(name) \
780 static const AVClass name ## _class = {\
781     .class_name = #name " encoder",\
782     .item_name  = av_default_item_name,\
783     .option     = ff_mpv_generic_options,\
784     .version    = LIBAVUTIL_VERSION_INT,\
785 };
786
787 /**
788  * Set the given MpegEncContext to common defaults (same for encoding
789  * and decoding).  The changed fields will not depend upon the prior
790  * state of the MpegEncContext.
791  */
792 void ff_MPV_common_defaults(MpegEncContext *s);
793
794 void ff_MPV_decode_defaults(MpegEncContext *s);
795 int ff_MPV_common_init(MpegEncContext *s);
796 int ff_mpv_frame_size_alloc(MpegEncContext *s, int linesize);
797 int ff_MPV_common_frame_size_change(MpegEncContext *s);
798 void ff_MPV_common_end(MpegEncContext *s);
799 void ff_MPV_decode_mb(MpegEncContext *s, int16_t block[12][64]);
800 int ff_MPV_frame_start(MpegEncContext *s, AVCodecContext *avctx);
801 void ff_MPV_frame_end(MpegEncContext *s);
802 int ff_MPV_encode_init(AVCodecContext *avctx);
803 int ff_MPV_encode_end(AVCodecContext *avctx);
804 int ff_MPV_encode_picture(AVCodecContext *avctx, AVPacket *pkt,
805                           AVFrame *frame, int *got_packet);
806 void ff_dct_encode_init_x86(MpegEncContext *s);
807 void ff_MPV_common_init_x86(MpegEncContext *s);
808 void ff_MPV_common_init_axp(MpegEncContext *s);
809 void ff_MPV_common_init_arm(MpegEncContext *s);
810 void ff_MPV_common_init_bfin(MpegEncContext *s);
811 void ff_MPV_common_init_ppc(MpegEncContext *s);
812 void ff_clean_intra_table_entries(MpegEncContext *s);
813 void ff_draw_horiz_band(AVCodecContext *avctx, DSPContext *dsp, Picture *cur,
814                         Picture *last, int y, int h, int picture_structure,
815                         int first_field, int draw_edges, int low_delay,
816                         int v_edge_pos, int h_edge_pos);
817 void ff_mpeg_draw_horiz_band(MpegEncContext *s, int y, int h);
818 void ff_mpeg_flush(AVCodecContext *avctx);
819
820 void ff_print_debug_info(MpegEncContext *s, Picture *p, AVFrame *pict);
821 void ff_print_debug_info2(AVCodecContext *avctx, Picture *p, AVFrame *pict, uint8_t *mbskip_table,
822                          int *low_delay,
823                          int mb_width, int mb_height, int mb_stride, int quarter_sample);
824
825 int ff_mpv_export_qp_table(MpegEncContext *s, AVFrame *f, Picture *p, int qp_type);
826
827 void ff_write_quant_matrix(PutBitContext *pb, uint16_t *matrix);
828 void ff_release_unused_pictures(MpegEncContext *s, int remove_current);
829 int ff_find_unused_picture(MpegEncContext *s, int shared);
830 void ff_denoise_dct(MpegEncContext *s, int16_t *block);
831 int ff_update_duplicate_context(MpegEncContext *dst, MpegEncContext *src);
832 int ff_MPV_lowest_referenced_row(MpegEncContext *s, int dir);
833 void ff_MPV_report_decode_progress(MpegEncContext *s);
834 int ff_mpeg_update_thread_context(AVCodecContext *dst, const AVCodecContext *src);
835 void ff_set_qscale(MpegEncContext * s, int qscale);
836
837 void ff_mpeg_er_frame_start(MpegEncContext *s);
838
839 int ff_dct_common_init(MpegEncContext *s);
840 int ff_dct_encode_init(MpegEncContext *s);
841 void ff_convert_matrix(DSPContext *dsp, int (*qmat)[64], uint16_t (*qmat16)[2][64],
842                        const uint16_t *quant_matrix, int bias, int qmin, int qmax, int intra);
843 int ff_dct_quantize_c(MpegEncContext *s, int16_t *block, int n, int qscale, int *overflow);
844
845 void ff_init_block_index(MpegEncContext *s);
846
847 void ff_MPV_motion(MpegEncContext *s,
848                    uint8_t *dest_y, uint8_t *dest_cb,
849                    uint8_t *dest_cr, int dir,
850                    uint8_t **ref_picture,
851                    op_pixels_func (*pix_op)[4],
852                    qpel_mc_func (*qpix_op)[16]);
853
854 /**
855  * Allocate a Picture.
856  * The pixels are allocated/set by calling get_buffer() if shared = 0.
857  */
858 int ff_alloc_picture(MpegEncContext *s, Picture *pic, int shared);
859
860 extern const enum AVPixelFormat ff_pixfmt_list_420[];
861
862 /**
863  * permute block according to permuatation.
864  * @param last last non zero element in scantable order
865  */
866 void ff_block_permute(int16_t *block, uint8_t *permutation, const uint8_t *scantable, int last);
867
868 static inline void ff_update_block_index(MpegEncContext *s){
869     const int block_size= 8 >> s->avctx->lowres;
870
871     s->block_index[0]+=2;
872     s->block_index[1]+=2;
873     s->block_index[2]+=2;
874     s->block_index[3]+=2;
875     s->block_index[4]++;
876     s->block_index[5]++;
877     s->dest[0]+= 2*block_size;
878     s->dest[1]+= block_size;
879     s->dest[2]+= block_size;
880 }
881
882 static inline int get_bits_diff(MpegEncContext *s){
883     const int bits= put_bits_count(&s->pb);
884     const int last= s->last_bits;
885
886     s->last_bits = bits;
887
888     return bits - last;
889 }
890
891 static inline int ff_h263_round_chroma(int x){
892     static const uint8_t h263_chroma_roundtab[16] = {
893     //  0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15
894         0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1,
895     };
896     return h263_chroma_roundtab[x & 0xf] + (x >> 3);
897 }
898
899 /* motion_est.c */
900 void ff_estimate_p_frame_motion(MpegEncContext * s,
901                              int mb_x, int mb_y);
902 void ff_estimate_b_frame_motion(MpegEncContext * s,
903                              int mb_x, int mb_y);
904 int ff_get_best_fcode(MpegEncContext * s, int16_t (*mv_table)[2], int type);
905 void ff_fix_long_p_mvs(MpegEncContext * s);
906 void ff_fix_long_mvs(MpegEncContext * s, uint8_t *field_select_table, int field_select,
907                      int16_t (*mv_table)[2], int f_code, int type, int truncate);
908 int ff_init_me(MpegEncContext *s);
909 int ff_pre_estimate_p_frame_motion(MpegEncContext * s, int mb_x, int mb_y);
910 int ff_epzs_motion_search(MpegEncContext * s, int *mx_ptr, int *my_ptr,
911                              int P[10][2], int src_index, int ref_index, int16_t (*last_mv)[2],
912                              int ref_mv_scale, int size, int h);
913 int ff_get_mb_score(MpegEncContext * s, int mx, int my, int src_index,
914                                int ref_index, int size, int h, int add_rate);
915
916 /* mpeg12.c */
917 extern const uint8_t ff_mpeg1_dc_scale_table[128];
918 extern const uint8_t * const ff_mpeg2_dc_scale_table[4];
919
920 void ff_mpeg1_encode_picture_header(MpegEncContext *s, int picture_number);
921 void ff_mpeg1_encode_mb(MpegEncContext *s,
922                         int16_t block[6][64],
923                         int motion_x, int motion_y);
924 void ff_mpeg1_encode_init(MpegEncContext *s);
925 void ff_mpeg1_encode_slice_header(MpegEncContext *s);
926
927 extern const uint8_t ff_aic_dc_scale_table[32];
928 extern const uint8_t ff_h263_chroma_qscale_table[32];
929
930 /* rv10.c */
931 void ff_rv10_encode_picture_header(MpegEncContext *s, int picture_number);
932 int ff_rv_decode_dc(MpegEncContext *s, int n);
933 void ff_rv20_encode_picture_header(MpegEncContext *s, int picture_number);
934
935
936 /* msmpeg4.c */
937 void ff_msmpeg4_encode_picture_header(MpegEncContext * s, int picture_number);
938 void ff_msmpeg4_encode_ext_header(MpegEncContext * s);
939 void ff_msmpeg4_encode_mb(MpegEncContext * s,
940                           int16_t block[6][64],
941                           int motion_x, int motion_y);
942 int ff_msmpeg4_decode_picture_header(MpegEncContext * s);
943 int ff_msmpeg4_decode_ext_header(MpegEncContext * s, int buf_size);
944 int ff_msmpeg4_decode_init(AVCodecContext *avctx);
945 void ff_msmpeg4_encode_init(MpegEncContext *s);
946 int ff_wmv2_decode_picture_header(MpegEncContext * s);
947 int ff_wmv2_decode_secondary_picture_header(MpegEncContext * s);
948 void ff_wmv2_add_mb(MpegEncContext *s, int16_t block[6][64], uint8_t *dest_y, uint8_t *dest_cb, uint8_t *dest_cr);
949 void ff_mspel_motion(MpegEncContext *s,
950                                uint8_t *dest_y, uint8_t *dest_cb, uint8_t *dest_cr,
951                                uint8_t **ref_picture, op_pixels_func (*pix_op)[4],
952                                int motion_x, int motion_y, int h);
953 int ff_wmv2_encode_picture_header(MpegEncContext * s, int picture_number);
954 void ff_wmv2_encode_mb(MpegEncContext * s,
955                        int16_t block[6][64],
956                        int motion_x, int motion_y);
957
958 int ff_mpeg_ref_picture(MpegEncContext *s, Picture *dst, Picture *src);
959 void ff_mpeg_unref_picture(MpegEncContext *s, Picture *picture);
960
961
962 #endif /* AVCODEC_MPEGVIDEO_H */