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