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