mpegvideo.h 35.8 KB
Newer Older
Fabrice Bellard's avatar
Fabrice Bellard committed
1 2
/*
 * Generic DCT based hybrid video encoder
3
 * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
4
 * Copyright (c) 2002-2004 Michael Niedermayer
Fabrice Bellard's avatar
Fabrice Bellard committed
5
 *
6 7 8
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
Fabrice Bellard's avatar
Fabrice Bellard committed
9 10
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
11
 * version 2.1 of the License, or (at your option) any later version.
Fabrice Bellard's avatar
Fabrice Bellard committed
12
 *
13
 * FFmpeg is distributed in the hope that it will be useful,
Fabrice Bellard's avatar
Fabrice Bellard committed
14
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Fabrice Bellard's avatar
Fabrice Bellard committed
15 16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
Fabrice Bellard's avatar
Fabrice Bellard committed
17
 *
Fabrice Bellard's avatar
Fabrice Bellard committed
18
 * You should have received a copy of the GNU Lesser General Public
19
 * License along with FFmpeg; if not, write to the Free Software
20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Fabrice Bellard's avatar
Fabrice Bellard committed
21 22
 */

Michael Niedermayer's avatar
Michael Niedermayer committed
23
/**
24
 * @file libavcodec/mpegvideo.h
Michael Niedermayer's avatar
Michael Niedermayer committed
25 26
 * mpegvideo header.
 */
27

28 29
#ifndef AVCODEC_MPEGVIDEO_H
#define AVCODEC_MPEGVIDEO_H
30

31
#include "dsputil.h"
32
#include "get_bits.h"
33
#include "put_bits.h"
34
#include "ratecontrol.h"
35
#include "parser.h"
36
#include "mpeg12data.h"
37
#include "rl.h"
38

39
#define FRAME_SKIPPED 100 ///< return value for header parsers if frame is not coded
Michael Niedermayer's avatar
Michael Niedermayer committed
40

Fabrice Bellard's avatar
Fabrice Bellard committed
41 42
enum OutputFormat {
    FMT_MPEG1,
43
    FMT_H261,
Fabrice Bellard's avatar
Fabrice Bellard committed
44
    FMT_H263,
45
    FMT_MJPEG,
Michael Niedermayer's avatar
Michael Niedermayer committed
46
    FMT_H264,
Fabrice Bellard's avatar
Fabrice Bellard committed
47 48 49 50
};

#define MPEG_BUF_SIZE (16 * 1024)

Michael Niedermayer's avatar
Michael Niedermayer committed
51 52
#define QMAT_SHIFT_MMX 16
#define QMAT_SHIFT 22
Michael Niedermayer's avatar
Michael Niedermayer committed
53

54 55
#define MAX_FCODE 7
#define MAX_MV 2048
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
56

Frank Barchard's avatar
Frank Barchard committed
57
#define MAX_THREADS 16
58

59
#define MAX_PICTURE_COUNT 32
60

61 62 63 64
#define ME_MAP_SIZE 64
#define ME_MAP_SHIFT 3
#define ME_MAP_MV_BITS 11

65 66
#define MAX_MB_BYTES (30*16*16*3/8 + 120)

Michael Niedermayer's avatar
Michael Niedermayer committed
67 68
#define INPLACE_OFFSET 16

69 70 71 72 73 74 75 76 77 78
/* Start codes. */
#define SEQ_END_CODE            0x000001b7
#define SEQ_START_CODE          0x000001b3
#define GOP_START_CODE          0x000001b8
#define PICTURE_START_CODE      0x00000100
#define SLICE_MIN_START_CODE    0x00000101
#define SLICE_MAX_START_CODE    0x000001af
#define EXT_START_CODE          0x000001b5
#define USER_START_CODE         0x000001b2

Michael Niedermayer's avatar
Michael Niedermayer committed
79 80 81
/**
 * Picture.
 */
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
82
typedef struct Picture{
Michael Niedermayer's avatar
Michael Niedermayer committed
83
    FF_COMMON_FRAME
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
84

Michael Niedermayer's avatar
Michael Niedermayer committed
85 86 87 88
    /**
     * halfpel luma planes.
     */
    uint8_t *interpolated[3];
89
    int16_t (*motion_val_base[2])[2];
90
    uint32_t *mb_type_base;
Diego Biurrun's avatar
Diego Biurrun committed
91
#define MB_TYPE_INTRA MB_TYPE_INTRA4x4 //default mb_type if there is just one type
Michael Niedermayer's avatar
Michael Niedermayer committed
92 93
#define IS_INTRA4x4(a)   ((a)&MB_TYPE_INTRA4x4)
#define IS_INTRA16x16(a) ((a)&MB_TYPE_INTRA16x16)
94 95
#define IS_PCM(a)        ((a)&MB_TYPE_INTRA_PCM)
#define IS_INTRA(a)      ((a)&7)
Michael Niedermayer's avatar
Michael Niedermayer committed
96
#define IS_INTER(a)      ((a)&(MB_TYPE_16x16|MB_TYPE_16x8|MB_TYPE_8x16|MB_TYPE_8x8))
97
#define IS_SKIP(a)       ((a)&MB_TYPE_SKIP)
Michael Niedermayer's avatar
Michael Niedermayer committed
98 99 100
#define IS_INTRA_PCM(a)  ((a)&MB_TYPE_INTRA_PCM)
#define IS_INTERLACED(a) ((a)&MB_TYPE_INTERLACED)
#define IS_DIRECT(a)     ((a)&MB_TYPE_DIRECT2)
101
#define IS_GMC(a)        ((a)&MB_TYPE_GMC)
Michael Niedermayer's avatar
Michael Niedermayer committed
102 103 104 105 106 107 108 109
#define IS_16X16(a)      ((a)&MB_TYPE_16x16)
#define IS_16X8(a)       ((a)&MB_TYPE_16x8)
#define IS_8X16(a)       ((a)&MB_TYPE_8x16)
#define IS_8X8(a)        ((a)&MB_TYPE_8x8)
#define IS_SUB_8X8(a)    ((a)&MB_TYPE_16x16) //note reused
#define IS_SUB_8X4(a)    ((a)&MB_TYPE_16x8)  //note reused
#define IS_SUB_4X8(a)    ((a)&MB_TYPE_8x16)  //note reused
#define IS_SUB_4X4(a)    ((a)&MB_TYPE_8x8)   //note reused
110 111
#define IS_ACPRED(a)     ((a)&MB_TYPE_ACPRED)
#define IS_QUANT(a)      ((a)&MB_TYPE_QUANT)
Michael Niedermayer's avatar
Michael Niedermayer committed
112
#define IS_DIR(a, part, list) ((a) & (MB_TYPE_P0L0<<((part)+2*(list))))
Diego Biurrun's avatar
Diego Biurrun committed
113
#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
114
#define HAS_CBP(a)        ((a)&MB_TYPE_CBP)
Michael Niedermayer's avatar
Michael Niedermayer committed
115 116 117

    int field_poc[2];           ///< h264 top/bottom POC
    int poc;                    ///< h264 frame POC
118
    int frame_num;              ///< h264 frame_num (raw frame_num from slice header)
119
    int mmco_reset;             ///< h264 MMCO_RESET set this 1. Reordering code must not mix pictures before and after MMCO_RESET.
120 121
    int pic_id;                 /**< h264 pic_num (short -> no wrap version of pic_num,
                                     pic_num & max_pic_num; long -> long_pic_num) */
Michael Niedermayer's avatar
Michael Niedermayer committed
122
    int long_ref;               ///< 1->long term reference 0->short term reference
123 124
    int ref_poc[2][2][16];      ///< h264 POCs of the frames used as reference (FIXME need per slice)
    int ref_count[2][2];        ///< number of entries in ref_poc              (FIXME need per slice)
125
    int mbaff;                  ///< h264 1 -> MBAFF frame 0-> not MBAFF
Michael Niedermayer's avatar
Michael Niedermayer committed
126

127 128 129 130 131
    int mb_var_sum;             ///< sum of MB variance for current frame
    int mc_mb_var_sum;          ///< motion compensated MB variance for current frame
    uint16_t *mb_var;           ///< Table for MB variances
    uint16_t *mc_mb_var;        ///< Table for motion compensated MB variances
    uint8_t *mb_mean;           ///< Table for MB luminance
132
    int32_t *mb_cmp_score;      ///< Table for MB cmp scores, for mb decision FIXME remove
133
    int b_frame_score;          /* */
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
134 135
} Picture;

Michael Niedermayer's avatar
Michael Niedermayer committed
136 137
struct MpegEncContext;

Michael Niedermayer's avatar
Michael Niedermayer committed
138 139 140
/**
 * Motion estimation context.
 */
Michael Niedermayer's avatar
Michael Niedermayer committed
141
typedef struct MotionEstContext{
142
    AVCodecContext *avctx;
143
    int skip;                          ///< set if ME is skipped for the current MB
Diego Biurrun's avatar
Diego Biurrun committed
144
    int co_located_mv[4][2];           ///< mv from last P-frame for direct mode ME
Michael Niedermayer's avatar
Michael Niedermayer committed
145
    int direct_basis_mv[4][2];
Diego Biurrun's avatar
Diego Biurrun committed
146
    uint8_t *scratchpad;               ///< data area for the ME algo, so that the ME does not need to malloc/free
147 148 149 150
    uint8_t *best_mb;
    uint8_t *temp_mb[2];
    uint8_t *temp;
    int best_bits;
151 152 153
    uint32_t *map;                     ///< map to avoid duplicate evaluations
    uint32_t *score_map;               ///< map to store the scores
    int map_generation;
Michael Niedermayer's avatar
Michael Niedermayer committed
154
    int pre_penalty_factor;
155 156 157 158 159
    int penalty_factor;                /*!< an estimate of the bits required to
                                        code a given mv value, e.g. (1,0) takes
                                        more bits than (0,0). We have to
                                        estimate whether any reduction in
                                        residual is worth the extra bits. */
Michael Niedermayer's avatar
Michael Niedermayer committed
160
    int sub_penalty_factor;
161
    int mb_penalty_factor;
162 163 164
    int flags;
    int sub_flags;
    int mb_flags;
165
    int pre_pass;                      ///< = 1 for the pre pass
Michael Niedermayer's avatar
Michael Niedermayer committed
166
    int dia_size;
167 168 169 170
    int xmin;
    int xmax;
    int ymin;
    int ymax;
171 172 173 174 175 176
    int pred_x;
    int pred_y;
    uint8_t *src[4][4];
    uint8_t *ref[4][4];
    int stride;
    int uvstride;
177 178 179 180
    /* temp variables for picture complexity calculation */
    int mc_mb_var_sum_temp;
    int mb_var_sum_temp;
    int scene_change_score;
181 182 183 184 185
/*    cmp, chroma_cmp;*/
    op_pixels_func (*hpel_put)[4];
    op_pixels_func (*hpel_avg)[4];
    qpel_mc_func (*qpel_put)[16];
    qpel_mc_func (*qpel_avg)[16];
186
    uint8_t (*mv_penalty)[MAX_MV*2+1];  ///< amount of bits needed to encode a MV
187
    uint8_t *current_mv_penalty;
Michael Niedermayer's avatar
Michael Niedermayer committed
188
    int (*sub_motion_search)(struct MpegEncContext * s,
189
                                  int *mx_ptr, int *my_ptr, int dmin,
190 191
                                  int src_index, int ref_index,
                                  int size, int h);
Michael Niedermayer's avatar
Michael Niedermayer committed
192 193
}MotionEstContext;

Michael Niedermayer's avatar
Michael Niedermayer committed
194 195 196
/**
 * MpegEncContext.
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
197
typedef struct MpegEncContext {
Fabrice Bellard's avatar
Fabrice Bellard committed
198
    struct AVCodecContext *avctx;
Fabrice Bellard's avatar
Fabrice Bellard committed
199
    /* the following parameters must be initialized before encoding */
200
    int width, height;///< picture size. must be a multiple of 16
Fabrice Bellard's avatar
Fabrice Bellard committed
201
    int gop_size;
202 203 204 205
    int intra_only;   ///< if true, only intra pictures are generated
    int bit_rate;     ///< wanted bit rate
    enum OutputFormat out_format; ///< output format
    int h263_pred;    ///< use mpeg4/h263 ac/dc predictions
206
    int pb_frame;     ///< PB frame mode (0 = none, 1 = base, 2 = improved)
207 208

/* the following codec id fields are deprecated in favor of codec_id */
209
    int h263_plus;    ///< h263 plus headers
Michael Niedermayer's avatar
Michael Niedermayer committed
210
    int h263_msmpeg4; ///< generate MSMPEG4 compatible stream (deprecated, use msmpeg4_version instead)
211 212
    int h263_flv;     ///< use flv h263 header

Michael Niedermayer's avatar
Michael Niedermayer committed
213
    enum CodecID codec_id;     /* see CODEC_ID_xxx */
214 215 216
    int fixed_qscale; ///< fixed qscale if non zero
    int encoding;     ///< true if we are encoding (vs decoding)
    int flags;        ///< AVCodecContext.flags (HQ, MV4, ...)
217
    int flags2;       ///< AVCodecContext.flags2
218
    int max_b_frames; ///< max number of b-frames for encoding
219 220
    int luma_elim_threshold;
    int chroma_elim_threshold;
221 222
    int strict_std_compliance; ///< strictly follow the std (MPEG4, ...)
    int workaround_bugs;       ///< workaround bugs in encoders which cannot be detected automatically
223 224
    int codec_tag;             ///< internal codec_tag upper case converted from avctx codec_tag
    int stream_codec_tag;      ///< internal stream_codec_tag upper case converted from avctx stream_codec_tag
Fabrice Bellard's avatar
Fabrice Bellard committed
225 226
    /* the following fields are managed internally by the encoder */

Michael Niedermayer's avatar
Michael Niedermayer committed
227
    /** bit output */
Fabrice Bellard's avatar
Fabrice Bellard committed
228 229 230 231
    PutBitContext pb;

    /* sequence parameters */
    int context_initialized;
Diego Biurrun's avatar
Diego Biurrun committed
232 233
    int input_picture_number;  ///< used to set pic->display_picture_number, should not be used for/by anything else
    int coded_picture_number;  ///< used to set pic->coded_picture_number, should not be used for/by anything else
Michael Niedermayer's avatar
Michael Niedermayer committed
234
    int picture_number;       //FIXME remove, unclear definition
235 236
    int picture_in_gop_number; ///< 0-> first pic in gop, ...
    int b_frames_since_non_b;  ///< used for encoding, relative to not yet reordered input
237
    int64_t user_specified_pts;///< last non zero pts from AVFrame which was passed into avcodec_encode_video()
238
    int mb_width, mb_height;   ///< number of MBs horizontally & vertically
Diego Biurrun's avatar
Diego Biurrun committed
239 240 241 242
    int mb_stride;             ///< mb_width+1 used for some arrays to allow simple addressing of left & top MBs without sig11
    int b8_stride;             ///< 2*mb_width+1 used for some 8x8 block arrays to allow simple addressing
    int b4_stride;             ///< 4*mb_width+1 used for some 4x4 block arrays to allow simple addressing
    int h_edge_pos, v_edge_pos;///< horizontal / vertical position of the right/bottom edge (pixel replication)
243 244 245 246
    int mb_num;                ///< number of MBs of a picture
    int linesize;              ///< line size, in bytes, may be different from width
    int uvlinesize;            ///< line size, for chroma in bytes, may be different from width
    Picture *picture;          ///< main picture buffer
247 248
    Picture **input_picture;   ///< next pictures on display order for encoding
    Picture **reordered_input_picture; ///< pointer to the next pictures in codedorder for encoding
249

250 251 252
    int start_mb_y;            ///< start mb_y of this thread (so current thread should process start_mb_y <= row < end_mb_y)
    int end_mb_y;              ///< end   mb_y of this thread (so current thread should process start_mb_y <= row < end_mb_y)
    struct MpegEncContext *thread_context[MAX_THREADS];
253 254

    /**
255 256 257
     * copy of the previous picture structure.
     * note, linesize & data, might not match the previous picture (for field pictures)
     */
258 259 260
    Picture last_picture;

    /**
261 262 263 264
     * copy of the next picture structure.
     * note, linesize & data, might not match the next picture (for field pictures)
     */
    Picture next_picture;
265 266

    /**
267 268 269 270
     * copy of the source picture structure for encoding.
     * note, linesize & data, might not match the source picture (for field pictures)
     */
    Picture new_picture;
271 272

    /**
273 274 275
     * copy of the current picture structure.
     * note, linesize & data, might not match the current picture (for field pictures)
     */
276 277
    Picture current_picture;    ///< buffer to store the decompressed current picture

278
    Picture *last_picture_ptr;     ///< pointer to the previous picture.
279
    Picture *next_picture_ptr;     ///< pointer to the next picture (for bidir pred)
280
    Picture *current_picture_ptr;  ///< pointer to the current picture
281
    uint8_t *visualization_buffer[3]; //< temporary buffer vor MV visualization
282
    int last_dc[3];                ///< last DC values for MPEG1
Måns Rullgård's avatar
Måns Rullgård committed
283 284
    int16_t *dc_val_base;
    int16_t *dc_val[3];            ///< used for mpeg4 DC prediction, all 3 arrays must be continuous
Michael Niedermayer's avatar
Michael Niedermayer committed
285
    int16_t dc_cache[4*5];
Fabrice Bellard's avatar
Fabrice Bellard committed
286
    int y_dc_scale, c_dc_scale;
287 288
    const uint8_t *y_dc_scale_table;     ///< qscale -> y_dc_scale table
    const uint8_t *c_dc_scale_table;     ///< qscale -> c_dc_scale table
Michael Niedermayer's avatar
Michael Niedermayer committed
289
    const uint8_t *chroma_qscale_table;  ///< qscale -> chroma_qscale (h263)
290
    uint8_t *coded_block_base;
Michael Niedermayer's avatar
Michael Niedermayer committed
291
    uint8_t *coded_block;          ///< used for coded block pattern prediction (msmpeg4v3, wmv1)
292
    int16_t (*ac_val_base)[16];
293
    int16_t (*ac_val[3])[16];      ///< used for for mpeg4 AC prediction, all 3 arrays must be continuous
Fabrice Bellard's avatar
Fabrice Bellard committed
294
    int ac_pred;
295
    uint8_t *prev_pict_types;     ///< previous picture types in bitstream order, used for mb skip
296
#define PREV_PICT_TYPES_BUFFER_SIZE 256
297 298
    int mb_skipped;                ///< MUST BE SET only during DECODING
    uint8_t *mbskip_table;        /**< used to avoid copy if macroblock skipped (for black regions for example)
299
                                   and used for b-frame encoding & decoding (contains skip table of next P Frame) */
300 301 302
    uint8_t *mbintra_table;       ///< used to avoid setting {ac, dc, cbp}-pred stuff to zero on inter MB decoding
    uint8_t *cbp_table;           ///< used to store cbp, ac_pred for partitioned decoding
    uint8_t *pred_dir_table;      ///< used to store pred_dir for partitioned decoding
303
    uint8_t *allocated_edge_emu_buffer;
304
    uint8_t *edge_emu_buffer;     ///< points into the middle of allocated_edge_emu_buffer
Diego Biurrun's avatar
Diego Biurrun committed
305
    uint8_t *rd_scratchpad;       ///< scratchpad for rate distortion mb decision
306 307
    uint8_t *obmc_scratchpad;
    uint8_t *b_scratchpad;        ///< scratchpad used for writing into write only buffers
Fabrice Bellard's avatar
Fabrice Bellard committed
308

309 310
    int qscale;                 ///< QP
    int chroma_qscale;          ///< chroma QP
311 312
    unsigned int lambda;        ///< lagrange multipler used in rate distortion
    unsigned int lambda2;       ///< (lambda*lambda) >> FF_LAMBDA_SHIFT
313
    int *lambda_table;
314 315
    int adaptive_quant;         ///< use adaptive quantization
    int dquant;                 ///< qscale difference to prev qscale
316
    int closed_gop;             ///< MPEG1/2 GOP is closed
317
    int pict_type;              ///< FF_I_TYPE, FF_P_TYPE, FF_B_TYPE, ...
318
    int last_pict_type; //FIXME removes
319
    int last_non_b_pict_type;   ///< used for mpeg4 gmc b-frames & ratecontrol
320
    int dropable;
Fabrice Bellard's avatar
Fabrice Bellard committed
321
    int frame_rate_index;
322
    int last_lambda_for[5];     ///< last lambda for a specific pict type
Michael Niedermayer's avatar
skiprd  
Michael Niedermayer committed
323
    int skipdct;                ///< skip dct and code zero residual
324

Fabrice Bellard's avatar
Fabrice Bellard committed
325
    /* motion compensation */
326 327
    int unrestricted_mv;        ///< mv can point outside of the coded picture
    int h263_long_vectors;      ///< use horrible h263v1 long vector mode
328
    int decode;                 ///< if 0 then decoding will be skipped (for encoding b frames for example)
Michael Niedermayer's avatar
Michael Niedermayer committed
329

Diego Biurrun's avatar
Diego Biurrun committed
330
    DSPContext dsp;             ///< pointers for accelerated dsp functions
331 332
    int f_code;                 ///< forward MV resolution
    int b_code;                 ///< backward MV resolution for B Frames (mpeg4)
333 334 335
    int16_t (*p_mv_table_base)[2];
    int16_t (*b_forw_mv_table_base)[2];
    int16_t (*b_back_mv_table_base)[2];
336 337
    int16_t (*b_bidir_forw_mv_table_base)[2];
    int16_t (*b_bidir_back_mv_table_base)[2];
338
    int16_t (*b_direct_mv_table_base)[2];
339 340
    int16_t (*p_field_mv_table_base[2][2])[2];
    int16_t (*b_field_mv_table_base[2][2][2])[2];
341 342 343 344 345 346
    int16_t (*p_mv_table)[2];            ///< MV table (1MV per MB) p-frame encoding
    int16_t (*b_forw_mv_table)[2];       ///< MV table (1MV per MB) forward mode b-frame encoding
    int16_t (*b_back_mv_table)[2];       ///< MV table (1MV per MB) backward mode b-frame encoding
    int16_t (*b_bidir_forw_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding
    int16_t (*b_bidir_back_mv_table)[2]; ///< MV table (1MV per MB) bidir mode b-frame encoding
    int16_t (*b_direct_mv_table)[2];     ///< MV table (1MV per MB) direct mode b-frame encoding
347 348 349 350
    int16_t (*p_field_mv_table[2][2])[2];   ///< MV table (2MV per MB) interlaced p-frame encoding
    int16_t (*b_field_mv_table[2][2][2])[2];///< MV table (4MV per MB) interlaced b-frame encoding
    uint8_t (*p_field_select_table[2]);
    uint8_t (*b_field_select_table[2][2]);
351
    int me_method;                       ///< ME algorithm
Fabrice Bellard's avatar
Fabrice Bellard committed
352
    int mv_dir;
353 354
#define MV_DIR_FORWARD   1
#define MV_DIR_BACKWARD  2
Michael Niedermayer's avatar
Michael Niedermayer committed
355
#define MV_DIRECT        4 ///< bidirectional mode where the difference equals the MV of the last P/S/I-Frame (mpeg4)
Fabrice Bellard's avatar
Fabrice Bellard committed
356
    int mv_type;
357 358 359 360 361 362
#define MV_TYPE_16X16       0   ///< 1 vector for the whole mb
#define MV_TYPE_8X8         1   ///< 4 vectors (h263, mpeg4 4MV)
#define MV_TYPE_16X8        2   ///< 2 vectors, one per 16x8 block
#define MV_TYPE_FIELD       3   ///< 2 vectors, one per field
#define MV_TYPE_DMV         4   ///< 2 vectors, special mpeg2 Dual Prime Vectors
    /**motion vectors for a macroblock
Fabrice Bellard's avatar
Fabrice Bellard committed
363 364 365 366 367 368
       first coordinate : 0 = forward 1 = backward
       second "         : depend on type
       third  "         : 0 = x, 1 = y
    */
    int mv[2][4][2];
    int field_select[2][2];
369 370
    int last_mv[2][2][2];             ///< last MV, used for MV prediction in MPEG1 & B-frame MPEG4
    uint8_t *fcode_tab;               ///< smallest fcode needed for each MV
371
    int16_t direct_scale_mv[2][64];   ///< precomputed to avoid divisions in ff_mpeg4_set_direct_mv
372

Michael Niedermayer's avatar
Michael Niedermayer committed
373
    MotionEstContext me;
Fabrice Bellard's avatar
Fabrice Bellard committed
374

375
    int no_rounding;  /**< apply no rounding to motion compensation (MPEG4, msmpeg4, ...)
Diego Biurrun's avatar
Diego Biurrun committed
376
                        for b-frames rounding mode is always 0 */
Fabrice Bellard's avatar
Fabrice Bellard committed
377

378
    int hurry_up;     /**< when set to 1 during decoding, b frames will be skipped
379
                         when set to 2 idct/dequant will be skipped too */
380

Fabrice Bellard's avatar
Fabrice Bellard committed
381 382
    /* macroblock layer */
    int mb_x, mb_y;
383
    int mb_skip_run;
Fabrice Bellard's avatar
Fabrice Bellard committed
384
    int mb_intra;
385 386 387 388
    uint16_t *mb_type;           ///< Table for candidate MB types for encoding
#define CANDIDATE_MB_TYPE_INTRA    0x01
#define CANDIDATE_MB_TYPE_INTER    0x02
#define CANDIDATE_MB_TYPE_INTER4V  0x04
389
#define CANDIDATE_MB_TYPE_SKIPPED   0x08
390
//#define MB_TYPE_GMC      0x10
391

392 393 394 395 396 397 398 399 400
#define CANDIDATE_MB_TYPE_DIRECT   0x10
#define CANDIDATE_MB_TYPE_FORWARD  0x20
#define CANDIDATE_MB_TYPE_BACKWARD 0x40
#define CANDIDATE_MB_TYPE_BIDIR    0x80

#define CANDIDATE_MB_TYPE_INTER_I    0x100
#define CANDIDATE_MB_TYPE_FORWARD_I  0x200
#define CANDIDATE_MB_TYPE_BACKWARD_I 0x400
#define CANDIDATE_MB_TYPE_BIDIR_I    0x800
Michael Niedermayer's avatar
Michael Niedermayer committed
401

402 403
#define CANDIDATE_MB_TYPE_DIRECT0    0x1000

Michael Niedermayer's avatar
Michael Niedermayer committed
404
    int block_index[6]; ///< index to current MB in block based arrays with edges
Michael Niedermayer's avatar
Michael Niedermayer committed
405
    int block_wrap[6];
406
    uint8_t *dest[3];
407

408
    int *mb_index2xy;        ///< mb_index -> mb_x + mb_y*mb_stride
Michael Niedermayer's avatar
Michael Niedermayer committed
409

Michael Niedermayer's avatar
Michael Niedermayer committed
410
    /** matrix transmitted in the bitstream */
411 412 413 414
    uint16_t intra_matrix[64];
    uint16_t chroma_intra_matrix[64];
    uint16_t inter_matrix[64];
    uint16_t chroma_inter_matrix[64];
415
#define QUANT_BIAS_SHIFT 8
416 417 418 419 420
    int intra_quant_bias;    ///< bias for the quantizer
    int inter_quant_bias;    ///< bias for the quantizer
    int min_qcoeff;          ///< minimum encodable coefficient
    int max_qcoeff;          ///< maximum encodable coefficient
    int ac_esc_length;       ///< num of bits needed to encode the longest esc
Michael Niedermayer's avatar
Michael Niedermayer committed
421 422 423 424
    uint8_t *intra_ac_vlc_length;
    uint8_t *intra_ac_vlc_last_length;
    uint8_t *inter_ac_vlc_length;
    uint8_t *inter_ac_vlc_last_length;
425 426
    uint8_t *luma_dc_vlc_length;
    uint8_t *chroma_dc_vlc_length;
427
#define UNI_AC_ENC_INDEX(run,level) ((run)*128 + (level))
Michael Niedermayer's avatar
Michael Niedermayer committed
428

429
    int coded_score[8];
430

Michael Niedermayer's avatar
Michael Niedermayer committed
431
    /** precomputed matrix (combine qscale and DCT renorm) */
432 433
    int (*q_intra_matrix)[64];
    int (*q_inter_matrix)[64];
434 435 436
    /** identical to the above but for MMX & these are not permutated, second 64 entries are bias*/
    uint16_t (*q_intra_matrix16)[2][64];
    uint16_t (*q_inter_matrix16)[2][64];
437
    int block_last_index[12];  ///< last non zero coefficient in block
438
    /* scantables */
439
    ScanTable intra_scantable;
440 441
    ScanTable intra_h_scantable;
    ScanTable intra_v_scantable;
Michael Niedermayer's avatar
Michael Niedermayer committed
442
    ScanTable inter_scantable; ///< if inter == intra then intra should be used to reduce tha cache usage
443

444 445 446 447
    /* noise reduction */
    int (*dct_error_sum)[64];
    int dct_count[2];
    uint16_t (*dct_offset)[64];
Fabrice Bellard's avatar
Fabrice Bellard committed
448

Michael Niedermayer's avatar
Michael Niedermayer committed
449
    void *opaque;              ///< private data for the user
Fabrice Bellard's avatar
Fabrice Bellard committed
450 451

    /* bit rate control */
452 453
    int64_t wanted_bits;
    int64_t total_bits;
454
    int frame_bits;                ///< bits used for the current frame
455
    int next_lambda;               ///< next lambda used for retrying to encode a frame
Michael Niedermayer's avatar
Michael Niedermayer committed
456
    RateControlContext rc_context; ///< contains stuff only accessed in ratecontrol.c
457

458 459 460 461 462 463
    /* statistics, used for 2-pass encoding */
    int mv_bits;
    int header_bits;
    int i_tex_bits;
    int p_tex_bits;
    int i_count;
464 465
    int f_count;
    int b_count;
466
    int skip_count;
Michael Niedermayer's avatar
Michael Niedermayer committed
467 468
    int misc_bits; ///< cbp, mb_type
    int last_bits; ///< temp var used for calculating the above vars
469

470
    /* error concealment / resync */
471
    int error_count;
472 473
    uint8_t *error_status_table;       ///< table of the error status of each MB
#define VP_START            1          ///< current MB is the first after a resync marker
474 475 476 477 478 479 480
#define AC_ERROR            2
#define DC_ERROR            4
#define MV_ERROR            8
#define AC_END              16
#define DC_END              32
#define MV_END              64
//FIXME some prefix?
481 482 483 484

    int resync_mb_x;                 ///< x position of last resync marker
    int resync_mb_y;                 ///< y position of last resync marker
    GetBitContext last_resync_gb;    ///< used to search for the next resync marker
Michael Niedermayer's avatar
Michael Niedermayer committed
485
    int mb_num_left;                 ///< number of MBs left in this video packet (for partitioned Slices only)
486
    int next_p_frame_damaged;        ///< set if the next p frame is damaged, to avoid showing trashed b frames
487
    int error_recognition;
488

489
    ParseContext parse_context;
490

491
    /* H.263 specific */
492
    int gob_index;
493
    int obmc;                       ///< overlapped block motion compensation
494
    int showed_packed_warning;      ///< flag for having shown the warning about divxs invalid b frames
495

496
    /* H.263+ specific */
497 498
    int umvplus;                    ///< == H263+ && unrestricted_mv
    int h263_aic;                   ///< Advanded INTRA Coding (AIC)
499 500
    int h263_aic_dir;               ///< AIC direction: 0 = left, 1 = top
    int h263_slice_structured;
501
    int alt_inter_vlc;              ///< alternative inter vlc
Michael Niedermayer's avatar
Michael Niedermayer committed
502
    int modified_quant;
503
    int loop_filter;
Michael Niedermayer's avatar
Michael Niedermayer committed
504
    int custom_pcf;
505

Fabrice Bellard's avatar
Fabrice Bellard committed
506
    /* mpeg4 specific */
507
    int time_increment_bits;        ///< number of bits to represent the fractional part of time
508
    int last_time_base;
509 510
    int time_base;                  ///< time in seconds of last I,P,S Frame
    int64_t time;                   ///< time of current frame
511
    int64_t last_non_b_time;
512 513
    uint16_t pp_time;               ///< time distance between the last 2 p,s,i frames
    uint16_t pb_time;               ///< time distance between the last b and p,s,i frame
514
    uint16_t pp_field_time;
515
    uint16_t pb_field_time;         ///< like above, just for interlaced
Fabrice Bellard's avatar
Fabrice Bellard committed
516 517
    int shape;
    int vol_sprite_usage;
518 519 520 521 522
    int sprite_width;
    int sprite_height;
    int sprite_left;
    int sprite_top;
    int sprite_brightness_change;
523
    int num_sprite_warping_points;
Michael Niedermayer's avatar
Michael Niedermayer committed
524
    int real_sprite_warping_points;
525
    uint16_t sprite_traj[4][2];      ///< sprite trajectory points
526 527 528
    int sprite_offset[2][2];         ///< sprite offset[isChroma][isMVY]
    int sprite_delta[2][2];          ///< sprite_delta [isY][isMVY]
    int sprite_shift[2];             ///< sprite shift [isChroma]
529
    int mcsel;
Fabrice Bellard's avatar
Fabrice Bellard committed
530
    int quant_precision;
531
    int quarter_sample;              ///< 1->qpel, 0->half pel ME/MC
532
    int scalability;
Michael Niedermayer's avatar
Michael Niedermayer committed
533 534
    int hierachy_type;
    int enhancement_type;
535 536
    int new_pred;
    int reduced_res_vop;
Michael Niedermayer's avatar
Michael Niedermayer committed
537
    int aspect_ratio_info; //FIXME remove
538 539
    int sprite_warping_accuracy;
    int low_latency_sprite;
540 541 542
    int data_partitioning;           ///< data partitioning flag from header
    int partitioned_frame;           ///< is current frame partitioned
    int rvlc;                        ///< reversible vlc
Michael Niedermayer's avatar
Michael Niedermayer committed
543
    int resync_marker;               ///< could this stream contain resync markers
544
    int low_delay;                   ///< no reordering needed / has no b-frames
Michael Niedermayer's avatar
Michael Niedermayer committed
545
    int vo_type;
546 547
    int vol_control_parameters;      ///< does the stream contain the low_delay flag, used to workaround buggy encoders
    int intra_dc_threshold;          ///< QP above whch the ac VLC should be used for intra dc
548
    int use_intra_dc_vlc;
549 550
    PutBitContext tex_pb;            ///< used for data partitioned VOPs
    PutBitContext pb2;               ///< used for data partitioned VOPs
551
    int mpeg_quant;
552 553
    int t_frame;                       ///< time distance of first I -> B, used for interlaced b frames
    int padding_bug_score;             ///< used to detect the VERY common padding bug in MPEG4
554 555 556
    int cplx_estimation_trash_i;
    int cplx_estimation_trash_p;
    int cplx_estimation_trash_b;
Michael Niedermayer's avatar
Michael Niedermayer committed
557 558 559 560

    /* divx specific, used to workaround (many) bugs in divx5 */
    int divx_version;
    int divx_build;
561
    int divx_packed;
562
    uint8_t *bitstream_buffer; //Divx 5.01 puts several frames in a single one, this is used to reorder them
Michael Niedermayer's avatar
Michael Niedermayer committed
563
    int bitstream_buffer_size;
564
    unsigned int allocated_bitstream_buffer_size;
565

Michael Niedermayer's avatar
Michael Niedermayer committed
566
    int xvid_build;
567

568 569
    /* lavc specific stuff, used to workaround bugs in libavcodec */
    int lavc_build;
570

Fabrice Bellard's avatar
Fabrice Bellard committed
571
    /* RV10 specific */
572
    int rv10_version; ///< RV10 version: 0 or 3
Fabrice Bellard's avatar
Fabrice Bellard committed
573
    int rv10_first_dc_coded[3];
574
    int orig_width, orig_height;
575

Fabrice Bellard's avatar
Fabrice Bellard committed
576 577
    /* MJPEG specific */
    struct MJpegContext *mjpeg_ctx;
578 579
    int mjpeg_vsample[3];       ///< vertical sampling factors, default = {2, 1, 1}
    int mjpeg_hsample[3];       ///< horizontal sampling factors, default = {2, 1, 1}
Fabrice Bellard's avatar
Fabrice Bellard committed
580 581 582 583 584 585 586

    /* MSMPEG4 specific */
    int mv_table_index;
    int rl_table_index;
    int rl_chroma_table_index;
    int dc_table_index;
    int use_skip_mb_code;
587 588
    int slice_height;      ///< in macroblocks
    int first_slice_line;  ///< used in mpeg4 too to handle resync markers
Michael Niedermayer's avatar
Michael Niedermayer committed
589
    int flipflop_rounding;
Michael Niedermayer's avatar
Michael Niedermayer committed
590
    int msmpeg4_version;   ///< 0=not msmpeg4, 1=mp41, 2=mp42, 3=mp43/divx3 4=wmv1/7 5=wmv2/8
Michael Niedermayer's avatar
Michael Niedermayer committed
591 592 593
    int per_mb_rl_table;
    int esc3_level_length;
    int esc3_run_length;
Michael Niedermayer's avatar
Michael Niedermayer committed
594
    /** [mb_intra][isChroma][level][run][last] */
595
    int (*ac_stats)[2][MAX_LEVEL+1][MAX_RUN+1][2];
596
    int inter_intra_pred;
Michael Niedermayer's avatar
Michael Niedermayer committed
597
    int mspel;
Michael Niedermayer's avatar
Michael Niedermayer committed
598

Fabrice Bellard's avatar
Fabrice Bellard committed
599 600 601
    /* decompression specific */
    GetBitContext gb;

Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
602
    /* Mpeg1 specific */
603 604
    int gop_picture_number;  ///< index of the first picture of a GOP based on fake_pic_num & mpeg1 specific
    int last_mv_dir;         ///< last mv_dir, used for b frame encoding
Michael Niedermayer's avatar
Michael Niedermayer committed
605
    int broken_link;         ///< no_output_of_prior_pics_flag
606 607
    uint8_t *vbv_delay_ptr;  ///< pointer to vbv_delay in the bitstream

Diego Biurrun's avatar
Diego Biurrun committed
608
    /* MPEG-2-specific - I wished not to have to support this mess. */
Fabrice Bellard's avatar
Fabrice Bellard committed
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
    int progressive_sequence;
    int mpeg_f_code[2][2];
    int picture_structure;
/* picture type */
#define PICT_TOP_FIELD     1
#define PICT_BOTTOM_FIELD  2
#define PICT_FRAME         3

    int intra_dc_precision;
    int frame_pred_frame_dct;
    int top_field_first;
    int concealment_motion_vectors;
    int q_scale_type;
    int intra_vlc_format;
    int alternate_scan;
    int repeat_first_field;
    int chroma_420_type;
626 627 628 629
    int chroma_format;
#define CHROMA_420 1
#define CHROMA_422 2
#define CHROMA_444 3
630 631
    int chroma_x_shift;//depend on pix_format, that depend on chroma_format
    int chroma_y_shift;
632

Fabrice Bellard's avatar
Fabrice Bellard committed
633 634 635 636
    int progressive_frame;
    int full_pel[2];
    int interlaced_dct;
    int first_slice;
637
    int first_field;         ///< is 1 for the first field of a field picture 0 otherwise
638

639
    /* RTP specific */
640
    int rtp_mode;
641

642
    uint8_t *ptr_lastgob;
Diego Biurrun's avatar
Diego Biurrun committed
643
    int swap_uv;             //vcr2 codec is an MPEG-2 variant with U and V swapped
644
    DCTELEM (*pblocks[12])[64];
645 646

    DCTELEM (*block)[64]; ///< points to one of the following blocks
Baptiste Coudurier's avatar
Baptiste Coudurier committed
647
    DCTELEM (*blocks)[8][64]; // for HQ mode we need to keep the best block
648 649 650
    int (*decode_mb)(struct MpegEncContext *s, DCTELEM block[6][64]); // used by some codecs to avoid a switch()
#define SLICE_OK         0
#define SLICE_ERROR     -1
651 652
#define SLICE_END       -2 ///<end marker found
#define SLICE_NOEND     -3 ///<no end marker or error found but mb count exceeded
653 654

    void (*dct_unquantize_mpeg1_intra)(struct MpegEncContext *s,
Michael Niedermayer's avatar
Michael Niedermayer committed
655
                           DCTELEM *block/*align 16*/, int n, int qscale);
656
    void (*dct_unquantize_mpeg1_inter)(struct MpegEncContext *s,
Michael Niedermayer's avatar
Michael Niedermayer committed
657
                           DCTELEM *block/*align 16*/, int n, int qscale);
658
    void (*dct_unquantize_mpeg2_intra)(struct MpegEncContext *s,
Michael Niedermayer's avatar
Michael Niedermayer committed
659
                           DCTELEM *block/*align 16*/, int n, int qscale);
660
    void (*dct_unquantize_mpeg2_inter)(struct MpegEncContext *s,
661
                           DCTELEM *block/*align 16*/, int n, int qscale);
662
    void (*dct_unquantize_h263_intra)(struct MpegEncContext *s,
663
                           DCTELEM *block/*align 16*/, int n, int qscale);
664
    void (*dct_unquantize_h263_inter)(struct MpegEncContext *s,
665
                           DCTELEM *block/*align 16*/, int n, int qscale);
666
    void (*dct_unquantize_h261_intra)(struct MpegEncContext *s,
667
                           DCTELEM *block/*align 16*/, int n, int qscale);
668
    void (*dct_unquantize_h261_inter)(struct MpegEncContext *s,
669
                           DCTELEM *block/*align 16*/, int n, int qscale);
670 671 672
    void (*dct_unquantize_intra)(struct MpegEncContext *s, // unquantizer to use (mpeg4 can use both)
                           DCTELEM *block/*align 16*/, int n, int qscale);
    void (*dct_unquantize_inter)(struct MpegEncContext *s, // unquantizer to use (mpeg4 can use both)
Michael Niedermayer's avatar
Michael Niedermayer committed
673 674
                           DCTELEM *block/*align 16*/, int n, int qscale);
    int (*dct_quantize)(struct MpegEncContext *s, DCTELEM *block/*align 16*/, int n, int qscale, int *overflow);
675
    int (*fast_dct_quantize)(struct MpegEncContext *s, DCTELEM *block/*align 16*/, int n, int qscale, int *overflow);
Michael Niedermayer's avatar
Michael Niedermayer committed
676
    void (*denoise_dct)(struct MpegEncContext *s, DCTELEM *block);
Fabrice Bellard's avatar
Fabrice Bellard committed
677 678
} MpegEncContext;

679

Michael Niedermayer's avatar
Michael Niedermayer committed
680
void MPV_decode_defaults(MpegEncContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
681 682
int MPV_common_init(MpegEncContext *s);
void MPV_common_end(MpegEncContext *s);
683
void MPV_decode_mb(MpegEncContext *s, DCTELEM block[12][64]);
684
int MPV_frame_start(MpegEncContext *s, AVCodecContext *avctx);
Fabrice Bellard's avatar
Fabrice Bellard committed
685
void MPV_frame_end(MpegEncContext *s);
Michael Niedermayer's avatar
Michael Niedermayer committed
686 687 688
int MPV_encode_init(AVCodecContext *avctx);
int MPV_encode_end(AVCodecContext *avctx);
int MPV_encode_picture(AVCodecContext *avctx, unsigned char *buf, int buf_size, void *data);
689
void MPV_common_init_mmx(MpegEncContext *s);
690
void MPV_common_init_axp(MpegEncContext *s);
691
void MPV_common_init_mlib(MpegEncContext *s);
692
void MPV_common_init_mmi(MpegEncContext *s);
693
void MPV_common_init_arm(MpegEncContext *s);
694
void MPV_common_init_altivec(MpegEncContext *s);
695
void MPV_common_init_bfin(MpegEncContext *s);
696
void ff_clean_intra_table_entries(MpegEncContext *s);
697
void ff_draw_horiz_band(MpegEncContext *s, int y, int h);
Michael Niedermayer's avatar
Michael Niedermayer committed
698
void ff_mpeg_flush(AVCodecContext *avctx);
699
void ff_print_debug_info(MpegEncContext *s, AVFrame *pict);
Måns Rullgård's avatar
Måns Rullgård committed
700
void ff_write_quant_matrix(PutBitContext *pb, uint16_t *matrix);
701
int ff_find_unused_picture(MpegEncContext *s, int shared);
702
void ff_denoise_dct(MpegEncContext *s, DCTELEM *block);
703
void ff_update_duplicate_context(MpegEncContext *dst, MpegEncContext *src);
Michael Niedermayer's avatar
Michael Niedermayer committed
704
const uint8_t *ff_find_start_code(const uint8_t *p, const uint8_t *end, uint32_t *state);
705
void ff_set_qscale(MpegEncContext * s, int qscale);
Michael Niedermayer's avatar
Michael Niedermayer committed
706

707 708 709 710
void ff_er_frame_start(MpegEncContext *s);
void ff_er_frame_end(MpegEncContext *s);
void ff_er_add_slice(MpegEncContext *s, int startx, int starty, int endx, int endy, int status);

711
int ff_dct_common_init(MpegEncContext *s);
712 713
void ff_convert_matrix(DSPContext *dsp, int (*qmat)[64], uint16_t (*qmat16)[2][64],
                       const uint16_t *quant_matrix, int bias, int qmin, int qmax, int intra);
714

715
void ff_init_block_index(MpegEncContext *s);
716
void ff_copy_picture(Picture *dst, Picture *src);
717

718 719 720 721 722 723
/**
 * allocates a Picture
 * The pixels are allocated/set by calling get_buffer() if shared=0
 */
int ff_alloc_picture(MpegEncContext *s, Picture *pic, int shared);