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