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