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