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