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