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