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