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