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