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