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