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