common.h 12.9 KB
Newer Older
Laurent Aimar's avatar
Laurent Aimar committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/*****************************************************************************
 * common.h: h264 encoder
 *****************************************************************************
 * Copyright (C) 2003 Laurent Aimar
 * $Id: common.h,v 1.1 2004/06/03 19:27:06 fenrir Exp $
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

#ifndef _COMMON_H
#define _COMMON_H 1

27
#ifdef HAVE_STDINT_H
Laurent Aimar's avatar
Laurent Aimar committed
28
#include <stdint.h>
29 30 31
#else
#include <inttypes.h>
#endif
32
#include <stdarg.h>
Laurent Aimar's avatar
Laurent Aimar committed
33

34 35
#ifdef _MSC_VER
#define snprintf _snprintf
Loren Merritt's avatar
Loren Merritt committed
36
#define X264_VERSION "" // no configure script for msvc
37 38
#endif

39
#include "x264.h"
Laurent Aimar's avatar
Laurent Aimar committed
40 41 42 43 44 45 46 47 48 49
#include "bs.h"
#include "set.h"
#include "predict.h"
#include "pixel.h"
#include "mc.h"
#include "frame.h"
#include "dct.h"
#include "cabac.h"
#include "csp.h"

50 51 52
/****************************************************************************
 * Macros
 ****************************************************************************/
Laurent Aimar's avatar
Laurent Aimar committed
53 54 55
#define X264_MIN(a,b) ( (a)<(b) ? (a) : (b) )
#define X264_MAX(a,b) ( (a)>(b) ? (a) : (b) )
#define X264_ABS(a)   ( (a)< 0 ? -(a) : (a) )
56 57
#define X264_MIN3(a,b,c) X264_MIN((a),X264_MIN((b),(c)))
#define X264_MIN4(a,b,c,d) X264_MIN((a),X264_MIN3((b),(c),(d)))
Laurent Aimar's avatar
Laurent Aimar committed
58

59 60 61
/****************************************************************************
 * Generals functions
 ****************************************************************************/
Laurent Aimar's avatar
Laurent Aimar committed
62 63 64 65 66 67 68 69 70 71 72
/* x264_malloc : will do or emulate a memalign
 * XXX you HAVE TO use x264_free for buffer allocated
 * with x264_malloc
 */
void *x264_malloc( int );
void *x264_realloc( void *p, int i_size );
void  x264_free( void * );

/* mdate: return the current date in microsecond */
int64_t x264_mdate( void );

73 74 75
/* log */
void x264_log( x264_t *h, int i_level, const char *psz_fmt, ... );

Laurent Aimar's avatar
Laurent Aimar committed
76 77
static inline int x264_clip3( int v, int i_min, int i_max )
{
Loren Merritt's avatar
Loren Merritt committed
78
    return ( (v < i_min) ? i_min : (v > i_max) ? i_max : v );
Laurent Aimar's avatar
Laurent Aimar committed
79 80
}

Loren Merritt's avatar
Loren Merritt committed
81 82 83 84
static inline float x264_clip3f( float v, float f_min, float f_max )
{
    return ( (v < f_min) ? f_min : (v > f_max) ? f_max : v );
}
85

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
static inline int x264_median( int a, int b, int c )
{
    int min = a, max =a;
    if( b < min )
        min = b;
    else
        max = b;    /* no need to do 'b > max' (more consuming than always doing affectation) */

    if( c < min )
        min = c;
    else if( c > max )
        max = c;

    return a + b + c - min - max;
}


103 104 105
/****************************************************************************
 *
 ****************************************************************************/
Laurent Aimar's avatar
Laurent Aimar committed
106 107 108 109 110 111 112 113 114
enum slice_type_e
{
    SLICE_TYPE_P  = 0,
    SLICE_TYPE_B  = 1,
    SLICE_TYPE_I  = 2,
    SLICE_TYPE_SP = 3,
    SLICE_TYPE_SI = 4
};

Loren Merritt's avatar
Loren Merritt committed
115 116
static const char slice_type_to_char[] = { 'P', 'B', 'I', 'S', 'S' };

Laurent Aimar's avatar
Laurent Aimar committed
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
typedef struct
{
    x264_sps_t *sps;
    x264_pps_t *pps;

    int i_type;
    int i_first_mb;

    int i_pps_id;

    int i_frame_num;

    int b_field_pic;
    int b_bottom_field;

    int i_idr_pic_id;   /* -1 if nal_type != 5 */

    int i_poc_lsb;
    int i_delta_poc_bottom;

    int i_delta_poc[2];
    int i_redundant_pic_cnt;

    int b_direct_spatial_mv_pred;

    int b_num_ref_idx_override;
    int i_num_ref_idx_l0_active;
    int i_num_ref_idx_l1_active;

146 147 148 149 150 151 152
    int b_ref_pic_list_reordering_l0;
    int b_ref_pic_list_reordering_l1;
    struct {
        int idc;
        int arg;
    } ref_pic_list_order[2][16];

Laurent Aimar's avatar
Laurent Aimar committed
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
    int i_cabac_init_idc;

    int i_qp_delta;
    int b_sp_for_swidth;
    int i_qs_delta;

    /* deblocking filter */
    int i_disable_deblocking_filter_idc;
    int i_alpha_c0_offset;
    int i_beta_offset;

} x264_slice_header_t;

/* From ffmpeg
 */
#define X264_SCAN8_SIZE (6*8)
#define X264_SCAN8_0 (4+1*8)

static const int x264_scan8[16+2*4] =
{
    /* Luma */
    4+1*8, 5+1*8, 4+2*8, 5+2*8,
    6+1*8, 7+1*8, 6+2*8, 7+2*8,
    4+3*8, 5+3*8, 4+4*8, 5+4*8,
    6+3*8, 7+3*8, 6+4*8, 7+4*8,

    /* Cb */
    1+1*8, 2+1*8,
    1+2*8, 2+2*8,

    /* Cr */
    1+4*8, 2+4*8,
    1+5*8, 2+5*8,
};
/*
   0 1 2 3 4 5 6 7
 0
 1   B B   L L L L
 2   B B   L L L L
 3         L L L L
 4   R R   L L L L
 5   R R
*/

#define X264_BFRAME_MAX 16

typedef struct x264_ratecontrol_t   x264_ratecontrol_t;
typedef struct x264_vlc_table_t     x264_vlc_table_t;

struct x264_t
{
    /* encoder parameters */
    x264_param_t    param;

    /* bitstream output */
    struct
    {
        int         i_nal;
211
        x264_nal_t  nal[5];         /* for now 5 is enough */
Laurent Aimar's avatar
Laurent Aimar committed
212 213 214 215 216 217 218 219 220 221 222 223
        int         i_bitstream;    /* size of p_bitstream */
        uint8_t     *p_bitstream;   /* will hold data for all nal */
        bs_t        bs;
    } out;

    /* frame number/poc */
    int             i_frame;

    int             i_frame_offset; /* decoding only */
    int             i_frame_num;    /* decoding only */
    int             i_poc_msb;      /* decoding only */
    int             i_poc_lsb;      /* decoding only */
224
    int             i_poc;          /* decoding only */
Laurent Aimar's avatar
Laurent Aimar committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240

    /* We use only one SPS and one PPS */
    x264_sps_t      sps_array[32];
    x264_sps_t      *sps;
    x264_pps_t      pps_array[256];
    x264_pps_t      *pps;
    int             i_idr_pic_id;

    /* Slice header */
    x264_slice_header_t sh;

    /* cabac context */
    x264_cabac_t    cabac;

    struct
    {
241 242 243 244
        /* Frames to be encoded (whose types have been decided) */
        x264_frame_t *current[X264_BFRAME_MAX+3];
        /* Temporary buffer (frames types not yet decided) */
        x264_frame_t *next[X264_BFRAME_MAX+3];
Laurent Aimar's avatar
Laurent Aimar committed
245
        /* Unused frames */
246
        x264_frame_t *unused[X264_BFRAME_MAX+3];
247 248
        /* For adaptive B decision */
        x264_frame_t *last_nonb;
Laurent Aimar's avatar
Laurent Aimar committed
249

250 251
        /* frames used for reference +1 for decoding + sentinels */
        x264_frame_t *reference[16+2+1+2];
Laurent Aimar's avatar
Laurent Aimar committed
252

253
        int i_last_idr; /* Frame number of the last IDR */
254 255

        int i_input;    /* Number of input frames already accepted */
256 257 258 259

        int i_max_dpb;  /* Number of frames allocated in the decoded picture buffer */
        int i_max_ref0;
        int i_max_ref1;
260
        int i_delay;    /* Number of frames buffered for B reordering */
Laurent Aimar's avatar
Laurent Aimar committed
261 262 263 264 265 266 267 268 269 270
    } frames;

    /* current frame being encoded */
    x264_frame_t    *fenc;

    /* frame being reconstructed */
    x264_frame_t    *fdec;

    /* references lists */
    int             i_ref0;
Loren Merritt's avatar
Loren Merritt committed
271
    x264_frame_t    *fref0[16+3];     /* ref list 0 */
Laurent Aimar's avatar
Laurent Aimar committed
272
    int             i_ref1;
Loren Merritt's avatar
Loren Merritt committed
273
    x264_frame_t    *fref1[16+3];     /* ref list 1 */
274
    int             b_ref_reorder[2];
Laurent Aimar's avatar
Laurent Aimar committed
275 276 277 278 279 280 281 282



    /* Current MB DCT coeffs */
    struct
    {
        DECLARE_ALIGNED( int, luma16x16_dc[16], 16 );
        DECLARE_ALIGNED( int, chroma_dc[2][4], 16 );
Loren Merritt's avatar
Loren Merritt committed
283
        union
Laurent Aimar's avatar
Laurent Aimar committed
284 285 286 287 288 289 290 291 292
        {
            DECLARE_ALIGNED( int, residual_ac[15], 16 );
            DECLARE_ALIGNED( int, luma4x4[16], 16 );
        } block[16+8];
    } dct;

    /* MB table and cache for current frame/mb */
    struct
    {
293 294
        int     i_mb_count;                 /* number of mbs in a frame */

Laurent Aimar's avatar
Laurent Aimar committed
295 296
        /* Strides */
        int     i_mb_stride;
297 298
        int     i_b8_stride;
        int     i_b4_stride;
Laurent Aimar's avatar
Laurent Aimar committed
299 300 301 302 303

        /* Current index */
        int     i_mb_x;
        int     i_mb_y;
        int     i_mb_xy;
304 305
        int     i_b8_xy;
        int     i_b4_xy;
306 307
        
        /* Search parameters */
Loren Merritt's avatar
Loren Merritt committed
308
        int     i_me_method;
309
        int     i_subpel_refine;
Loren Merritt's avatar
Loren Merritt committed
310
        int     b_chroma_me;
311
        /* Allowed qpel MV range to stay within the picture + emulated edge pixels */
312 313
        int     mv_min[2];
        int     mv_max[2];
314 315 316
        /* Fullpel MV range for motion search */
        int     mv_min_fpel[2];
        int     mv_max_fpel[2];
317

Laurent Aimar's avatar
Laurent Aimar committed
318 319 320 321 322 323 324 325 326 327 328
        unsigned int i_neighbour;

        /* mb table */
        int8_t  *type;                      /* mb type */
        int8_t  *qp;                        /* mb qp */
        int16_t *cbp;                       /* mb cbp: 0x0?: luma, 0x?0: chroma, 0x100: luma dc, 0x0200 and 0x0400: chroma dc  (all set for PCM)*/
        int8_t  (*intra4x4_pred_mode)[7];   /* intra4x4 pred mode. for non I4x4 set to I_PRED_4x4_DC(2) */
        uint8_t (*non_zero_count)[16+4+4];  /* nzc. for I_PCM set to 16 */
        int8_t  *chroma_pred_mode;          /* chroma_pred_mode. cabac only. for non intra I_PRED_CHROMA_DC(0) */
        int16_t (*mv[2])[2];                /* mb mv. set to 0 for intra mb */
        int16_t (*mvd[2])[2];               /* mb mv difference with predict. set to 0 if intra. cabac only */
329
        int8_t   *ref[2];                   /* mb ref. set to -1 if non used (intra or Lx only) */
330 331 332
        int16_t (*mvr[2][16])[2];           /* 16x16 mv for each possible ref */
        int8_t  *skipbp;                    /* block pattern for SKIP or DIRECT (sub)mbs. B-frames + cabac only */

Laurent Aimar's avatar
Laurent Aimar committed
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
        /* current value */
        int     i_type;
        int     i_partition;
        int     i_sub_partition[4];

        int     i_cbp_luma;
        int     i_cbp_chroma;

        int     i_intra16x16_pred_mode;
        int     i_chroma_pred_mode;

        struct
        {
            /* pointer over mb of the frame to be compressed */
            uint8_t *p_fenc[3];

            /* pointer over mb of the frame to be reconstrucated  */
            uint8_t *p_fdec[3];

            /* pointer over mb of the references */
353
            uint8_t *p_fref[2][16][4+2]; /* last: lN, lH, lV, lHV, cU, cV */
Laurent Aimar's avatar
Laurent Aimar committed
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373

            /* common stride */
            int     i_stride[3];
        } pic;

        /* cache */
        struct
        {
            /* real intra4x4_pred_mode if I_4X4, I_PRED_4x4_DC if mb available, -1 if not */
            int     intra4x4_pred_mode[X264_SCAN8_SIZE];

            /* i_non_zero_count if availble else 0x80 */
            int     non_zero_count[X264_SCAN8_SIZE];

            /* -1 if unused, -2 if unavaible */
            int8_t  ref[2][X264_SCAN8_SIZE];

            /* 0 if non avaible */
            int16_t mv[2][X264_SCAN8_SIZE][2];
            int16_t mvd[2][X264_SCAN8_SIZE][2];
374 375 376 377 378 379

            /* 1 if SKIP or DIRECT. set only for B-frames + CABAC */
            int8_t  skip[X264_SCAN8_SIZE];

            int16_t direct_mv[2][X264_SCAN8_SIZE][2];
            int8_t  direct_ref[2][X264_SCAN8_SIZE];
Laurent Aimar's avatar
Laurent Aimar committed
380 381 382 383 384
        } cache;

        /* */
        int     i_last_qp;  /* last qp */
        int     i_last_dqp; /* last delta qp */
385
        int     b_variable_qp; /* whether qp is allowed to vary per macroblock */
Laurent Aimar's avatar
Laurent Aimar committed
386

387 388 389
        /* B_direct and weighted prediction */
        int     dist_scale_factor[16][16];
        int     bipred_weight[16][16];
390 391 392
        /* maps fref1[0]'s ref indices into the current list0 */
        int     map_col_to_list0_buf[2]; // for negative indices
        int     map_col_to_list0[16];
Laurent Aimar's avatar
Laurent Aimar committed
393 394 395 396 397
    } mb;

    /* rate control encoding only */
    x264_ratecontrol_t *rc;

398 399 400 401
    int i_last_inter_size;
    int i_last_intra_size;
    int i_last_intra_qp;

Laurent Aimar's avatar
Laurent Aimar committed
402 403 404
    /* stats */
    struct
    {
405 406 407 408 409 410 411 412 413 414 415 416
        /* Current frame stats */
        struct
        {
            /* Headers bits (MV+Ref+MB Block Type */
            int i_hdr_bits;
            /* Texture bits (Intra/Predicted) */
            int i_itex_bits;
            int i_ptex_bits;
            /* ? */
            int i_misc_bits;
            /* MB type counts */
            int i_mb_count[18];
Loren Merritt's avatar
Loren Merritt committed
417 418
            int i_mb_count_p;
            int i_mb_count_skip;
419 420 421 422
            /* Estimated (SATD) cost as Intra/Predicted frame */
            /* XXX: both omit the cost of MBs coded as P_SKIP */
            int i_intra_cost;
            int i_inter_cost;
423 424 425 426
        } frame;

        /* Cummulated stats */

Laurent Aimar's avatar
Laurent Aimar committed
427 428
        /* per slice info */
        int   i_slice_count[5];
429
        int64_t i_slice_size[5];
Loren Merritt's avatar
Loren Merritt committed
430
        int     i_slice_qp[5];
431 432 433 434 435 436 437
        /* */
        int64_t i_sqe_global[5];
        float   f_psnr_average[5];
        float   f_psnr_mean_y[5];
        float   f_psnr_mean_u[5];
        float   f_psnr_mean_v[5];
        /* */
438
        int64_t i_mb_count[5][18];
439

Laurent Aimar's avatar
Laurent Aimar committed
440 441 442 443 444 445 446 447
    } stat;

    /* CPU functions dependants */
    x264_predict_t      predict_16x16[4+3];
    x264_predict_t      predict_8x8[4+3];
    x264_predict_t      predict_4x4[9+3];

    x264_pixel_function_t pixf;
448
    x264_mc_functions_t   mc;
Laurent Aimar's avatar
Laurent Aimar committed
449 450 451 452 453 454 455 456 457
    x264_dct_function_t   dctf;
    x264_csp_function_t   csp;

    /* vlc table for decoding purpose only */
    x264_vlc_table_t *x264_coeff_token_lookup[5];
    x264_vlc_table_t *x264_level_prefix_lookup;
    x264_vlc_table_t *x264_total_zeros_lookup[15];
    x264_vlc_table_t *x264_total_zeros_dc_lookup[3];
    x264_vlc_table_t *x264_run_before_lookup[7];
Loren Merritt's avatar
Loren Merritt committed
458 459 460 461

#if VISUALIZE
    struct visualize_t *visualize;
#endif
Laurent Aimar's avatar
Laurent Aimar committed
462 463 464 465
};

#endif