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