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