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