git.sesse.net Git - x264/blob - common/common.h

   1 /*****************************************************************************
   2  * common.h: h264 encoder
   3  *****************************************************************************
   4  * Copyright (C) 2003-2008 x264 project
   5  *
   6  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   7  *          Loren Merritt <lorenm@u.washington.edu>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 #ifndef X264_COMMON_H
  25 #define X264_COMMON_H
  26
  27 /****************************************************************************
  28  * Macros
  29  ****************************************************************************/
  30 #define X264_MIN(a,b) ( (a)<(b) ? (a) : (b) )
  31 #define X264_MAX(a,b) ( (a)>(b) ? (a) : (b) )
  32 #define X264_MIN3(a,b,c) X264_MIN((a),X264_MIN((b),(c)))
  33 #define X264_MAX3(a,b,c) X264_MAX((a),X264_MAX((b),(c)))
  34 #define X264_MIN4(a,b,c,d) X264_MIN((a),X264_MIN3((b),(c),(d)))
  35 #define X264_MAX4(a,b,c,d) X264_MAX((a),X264_MAX3((b),(c),(d)))
  36 #define XCHG(type,a,b) { type t = a; a = b; b = t; }
  37 #define FIX8(f) ((int)(f*(1<<8)+.5))
  38
  39 #define CHECKED_MALLOC( var, size )\
  40 {\
  41     var = x264_malloc( size );\
  42     if( !var )\
  43     {\
  44         x264_log( h, X264_LOG_ERROR, "malloc failed\n" );\
  45         goto fail;\
  46     }\
  47 }
  48
  49 #define X264_BFRAME_MAX 16
  50 #define X264_THREAD_MAX 128
  51 #define X264_SLICE_MAX 4
  52 #define X264_NAL_MAX (4 + X264_SLICE_MAX)
  53
  54 // number of pixels (per thread) in progress at any given time.
  55 // 16 for the macroblock in progress + 3 for deblocking + 3 for motion compensation filter + 2 for extra safety
  56 #define X264_THREAD_HEIGHT 24
  57
  58 /****************************************************************************
  59  * Includes
  60  ****************************************************************************/
  61 #include "osdep.h"
  62 #include <stdarg.h>
  63 #include <stddef.h>
  64 #include <stdlib.h>
  65 #include <string.h>
  66 #include <assert.h>
  67 #include "x264.h"
  68 #include "bs.h"
  69 #include "set.h"
  70 #include "predict.h"
  71 #include "pixel.h"
  72 #include "mc.h"
  73 #include "frame.h"
  74 #include "dct.h"
  75 #include "cabac.h"
  76 #include "quant.h"
  77
  78 /****************************************************************************
  79  * Generals functions
  80  ****************************************************************************/
  81 /* x264_malloc : will do or emulate a memalign
  82  * you have to use x264_free for buffers allocated with x264_malloc */
  83 void *x264_malloc( int );
  84 void *x264_realloc( void *p, int i_size );
  85 void  x264_free( void * );
  86
  87 /* x264_slurp_file: malloc space for the whole file and read it */
  88 char *x264_slurp_file( const char *filename );
  89
  90 /* mdate: return the current date in microsecond */
  91 int64_t x264_mdate( void );
  92
  93 /* x264_param2string: return a (malloced) string containing most of
  94  * the encoding options */
  95 char *x264_param2string( x264_param_t *p, int b_res );
  96
  97 /* log */
  98 void x264_log( x264_t *h, int i_level, const char *psz_fmt, ... );
  99
 100 void x264_reduce_fraction( int *n, int *d );
 101
 102 static inline uint8_t x264_clip_uint8( int x )
 103 {
 104     return x&(~255) ? (-x)>>31 : x;
 105 }
 106
 107 static inline int x264_clip3( int v, int i_min, int i_max )
 108 {
 109     return ( (v < i_min) ? i_min : (v > i_max) ? i_max : v );
 110 }
 111
 112 static inline double x264_clip3f( double v, double f_min, double f_max )
 113 {
 114     return ( (v < f_min) ? f_min : (v > f_max) ? f_max : v );
 115 }
 116
 117 static inline int x264_median( int a, int b, int c )
 118 {
 119     int t = (a-b)&((a-b)>>31);
 120     a -= t;
 121     b += t;
 122     b -= (b-c)&((b-c)>>31);
 123     b += (a-b)&((a-b)>>31);
 124     return b;
 125 }
 126
 127 static inline void x264_median_mv( int16_t *dst, int16_t *a, int16_t *b, int16_t *c )
 128 {
 129     dst[0] = x264_median( a[0], b[0], c[0] );
 130     dst[1] = x264_median( a[1], b[1], c[1] );
 131 }
 132
 133 static inline int x264_predictor_difference( int16_t (*mvc)[2], intptr_t i_mvc )
 134 {
 135     int sum = 0, i;
 136     for( i = 0; i < i_mvc-1; i++ )
 137     {
 138         sum += abs( mvc[i][0] - mvc[i+1][0] )
 139              + abs( mvc[i][1] - mvc[i+1][1] );
 140     }
 141     return sum;
 142 }
 143
 144 /****************************************************************************
 145  *
 146  ****************************************************************************/
 147 enum slice_type_e
 148 {
 149     SLICE_TYPE_P  = 0,
 150     SLICE_TYPE_B  = 1,
 151     SLICE_TYPE_I  = 2,
 152     SLICE_TYPE_SP = 3,
 153     SLICE_TYPE_SI = 4
 154 };
 155
 156 static const char slice_type_to_char[] = { 'P', 'B', 'I', 'S', 'S' };
 157
 158 typedef struct
 159 {
 160     x264_sps_t *sps;
 161     x264_pps_t *pps;
 162
 163     int i_type;
 164     int i_first_mb;
 165     int i_last_mb;
 166
 167     int i_pps_id;
 168
 169     int i_frame_num;
 170
 171     int b_mbaff;
 172     int b_field_pic;
 173     int b_bottom_field;
 174
 175     int i_idr_pic_id;   /* -1 if nal_type != 5 */
 176
 177     int i_poc_lsb;
 178     int i_delta_poc_bottom;
 179
 180     int i_delta_poc[2];
 181     int i_redundant_pic_cnt;
 182
 183     int b_direct_spatial_mv_pred;
 184
 185     int b_num_ref_idx_override;
 186     int i_num_ref_idx_l0_active;
 187     int i_num_ref_idx_l1_active;
 188
 189     int b_ref_pic_list_reordering_l0;
 190     int b_ref_pic_list_reordering_l1;
 191     struct {
 192         int idc;
 193         int arg;
 194     } ref_pic_list_order[2][16];
 195
 196     int i_cabac_init_idc;
 197
 198     int i_qp;
 199     int i_qp_delta;
 200     int b_sp_for_swidth;
 201     int i_qs_delta;
 202
 203     /* deblocking filter */
 204     int i_disable_deblocking_filter_idc;
 205     int i_alpha_c0_offset;
 206     int i_beta_offset;
 207
 208 } x264_slice_header_t;
 209
 210 /* From ffmpeg
 211  */
 212 #define X264_SCAN8_SIZE (6*8)
 213 #define X264_SCAN8_0 (4+1*8)
 214
 215 static const int x264_scan8[16+2*4] =
 216 {
 217     /* Luma */
 218     4+1*8, 5+1*8, 4+2*8, 5+2*8,
 219     6+1*8, 7+1*8, 6+2*8, 7+2*8,
 220     4+3*8, 5+3*8, 4+4*8, 5+4*8,
 221     6+3*8, 7+3*8, 6+4*8, 7+4*8,
 222
 223     /* Cb */
 224     1+1*8, 2+1*8,
 225     1+2*8, 2+2*8,
 226
 227     /* Cr */
 228     1+4*8, 2+4*8,
 229     1+5*8, 2+5*8,
 230 };
 231 /*
 232    0 1 2 3 4 5 6 7
 233  0
 234  1   B B   L L L L
 235  2   B B   L L L L
 236  3         L L L L
 237  4   R R   L L L L
 238  5   R R
 239 */
 240
 241 typedef struct x264_ratecontrol_t   x264_ratecontrol_t;
 242
 243 struct x264_t
 244 {
 245     /* encoder parameters */
 246     x264_param_t    param;
 247
 248     x264_t          *thread[X264_THREAD_MAX];
 249     x264_pthread_t  thread_handle;
 250     int             b_thread_active;
 251     int             i_thread_phase; /* which thread to use for the next frame */
 252
 253     /* bitstream output */
 254     struct
 255     {
 256         int         i_nal;
 257         x264_nal_t  nal[X264_NAL_MAX];
 258         int         i_bitstream;    /* size of p_bitstream */
 259         uint8_t     *p_bitstream;   /* will hold data for all nal */
 260         bs_t        bs;
 261         int         i_frame_size;
 262     } out;
 263
 264     /* frame number/poc */
 265     int             i_frame;
 266
 267     int             i_frame_offset; /* decoding only */
 268     int             i_frame_num;    /* decoding only */
 269     int             i_poc_msb;      /* decoding only */
 270     int             i_poc_lsb;      /* decoding only */
 271     int             i_poc;          /* decoding only */
 272
 273     int             i_thread_num;   /* threads only */
 274     int             i_nal_type;     /* threads only */
 275     int             i_nal_ref_idc;  /* threads only */
 276
 277     /* We use only one SPS and one PPS */
 278     x264_sps_t      sps_array[1];
 279     x264_sps_t      *sps;
 280     x264_pps_t      pps_array[1];
 281     x264_pps_t      *pps;
 282     int             i_idr_pic_id;
 283
 284     /* quantization matrix for decoding, [cqm][qp%6][coef_y][coef_x] */
 285     int             (*dequant4_mf[4])[4][4]; /* [4][6][4][4] */
 286     int             (*dequant8_mf[2])[8][8]; /* [2][6][8][8] */
 287     /* quantization matrix for trellis, [cqm][qp][coef] */
 288     int             (*unquant4_mf[4])[16];   /* [4][52][16] */
 289     int             (*unquant8_mf[2])[64];   /* [2][52][64] */
 290     /* quantization matrix for deadzone */
 291     uint16_t        (*quant4_mf[4])[16];     /* [4][52][16] */
 292     uint16_t        (*quant8_mf[2])[64];     /* [2][52][64] */
 293     uint16_t        (*quant4_bias[4])[16];   /* [4][52][16] */
 294     uint16_t        (*quant8_bias[2])[64];   /* [2][52][64] */
 295
 296     DECLARE_ALIGNED_16( uint32_t nr_residual_sum[2][64] );
 297     DECLARE_ALIGNED_16( uint16_t nr_offset[2][64] );
 298     uint32_t        nr_count[2];
 299
 300     /* Slice header */
 301     x264_slice_header_t sh;
 302
 303     /* cabac context */
 304     x264_cabac_t    cabac;
 305
 306     struct
 307     {
 308         /* Frames to be encoded (whose types have been decided) */
 309         x264_frame_t *current[X264_BFRAME_MAX+3];
 310         /* Temporary buffer (frames types not yet decided) */
 311         x264_frame_t *next[X264_BFRAME_MAX+3];
 312         /* Unused frames */
 313         x264_frame_t *unused[X264_BFRAME_MAX + X264_THREAD_MAX*2 + 16+4];
 314         /* For adaptive B decision */
 315         x264_frame_t *last_nonb;
 316
 317         /* frames used for reference + sentinels */
 318         x264_frame_t *reference[16+2];
 319
 320         int i_last_idr; /* Frame number of the last IDR */
 321
 322         int i_input;    /* Number of input frames already accepted */
 323
 324         int i_max_dpb;  /* Number of frames allocated in the decoded picture buffer */
 325         int i_max_ref0;
 326         int i_max_ref1;
 327         int i_delay;    /* Number of frames buffered for B reordering */
 328         int b_have_lowres;  /* Whether 1/2 resolution luma planes are being used */
 329     } frames;
 330
 331     /* current frame being encoded */
 332     x264_frame_t    *fenc;
 333
 334     /* frame being reconstructed */
 335     x264_frame_t    *fdec;
 336
 337     /* references lists */
 338     int             i_ref0;
 339     x264_frame_t    *fref0[16+3];     /* ref list 0 */
 340     int             i_ref1;
 341     x264_frame_t    *fref1[16+3];     /* ref list 1 */
 342     int             b_ref_reorder[2];
 343
 344
 345
 346     /* Current MB DCT coeffs */
 347     struct
 348     {
 349         DECLARE_ALIGNED_16( int16_t luma16x16_dc[16] );
 350         DECLARE_ALIGNED_16( int16_t chroma_dc[2][4] );
 351         // FIXME share memory?
 352         DECLARE_ALIGNED_16( int16_t luma8x8[4][64] );
 353         DECLARE_ALIGNED_16( int16_t luma4x4[16+8][16] );
 354     } dct;
 355
 356     /* MB table and cache for current frame/mb */
 357     struct
 358     {
 359         int     i_mb_count;                 /* number of mbs in a frame */
 360
 361         /* Strides */
 362         int     i_mb_stride;
 363         int     i_b8_stride;
 364         int     i_b4_stride;
 365
 366         /* Current index */
 367         int     i_mb_x;
 368         int     i_mb_y;
 369         int     i_mb_xy;
 370         int     i_b8_xy;
 371         int     i_b4_xy;
 372
 373         /* Search parameters */
 374         int     i_me_method;
 375         int     i_subpel_refine;
 376         int     b_chroma_me;
 377         int     b_trellis;
 378         int     b_noise_reduction;
 379
 380         int     b_interlaced;
 381
 382         /* Allowed qpel MV range to stay within the picture + emulated edge pixels */
 383         int     mv_min[2];
 384         int     mv_max[2];
 385         /* Subpel MV range for motion search.
 386          * same mv_min/max but includes levels' i_mv_range. */
 387         int     mv_min_spel[2];
 388         int     mv_max_spel[2];
 389         /* Fullpel MV range for motion search */
 390         int     mv_min_fpel[2];
 391         int     mv_max_fpel[2];
 392
 393         /* neighboring MBs */
 394         unsigned int i_neighbour;
 395         unsigned int i_neighbour8[4];       /* neighbours of each 8x8 or 4x4 block that are available */
 396         unsigned int i_neighbour4[16];      /* at the time the block is coded */
 397         int     i_mb_type_top;
 398         int     i_mb_type_left;
 399         int     i_mb_type_topleft;
 400         int     i_mb_type_topright;
 401         int     i_mb_prev_xy;
 402         int     i_mb_top_xy;
 403
 404         /* mb table */
 405         int8_t  *type;                      /* mb type */
 406         int8_t  *qp;                        /* mb qp */
 407         int16_t *cbp;                       /* mb cbp: 0x0?: luma, 0x?0: chroma, 0x100: luma dc, 0x0200 and 0x0400: chroma dc  (all set for PCM)*/
 408         int8_t  (*intra4x4_pred_mode)[8];   /* intra4x4 pred mode. for non I4x4 set to I_PRED_4x4_DC(2) */
 409                                             /* actually has only 7 entries; set to 8 for write-combining optimizations */
 410         uint8_t (*non_zero_count)[16+4+4];  /* nzc. for I_PCM set to 16 */
 411         int8_t  *chroma_pred_mode;          /* chroma_pred_mode. cabac only. for non intra I_PRED_CHROMA_DC(0) */
 412         int16_t (*mv[2])[2];                /* mb mv. set to 0 for intra mb */
 413         int16_t (*mvd[2])[2];               /* mb mv difference with predict. set to 0 if intra. cabac only */
 414         int8_t   *ref[2];                   /* mb ref. set to -1 if non used (intra or Lx only) */
 415         int16_t (*mvr[2][32])[2];           /* 16x16 mv for each possible ref */
 416         int8_t  *skipbp;                    /* block pattern for SKIP or DIRECT (sub)mbs. B-frames + cabac only */
 417         int8_t  *mb_transform_size;         /* transform_size_8x8_flag of each mb */
 418         uint8_t *intra_border_backup[2][3]; /* bottom pixels of the previous mb row, used for intra prediction after the framebuffer has been deblocked */
 419         uint8_t (*nnz_backup)[16];          /* when using cavlc + 8x8dct, the deblocker uses a modified nnz */
 420
 421         /* current value */
 422         int     i_type;
 423         int     i_partition;
 424         int     i_sub_partition[4];
 425         int     b_transform_8x8;
 426
 427         int     i_cbp_luma;
 428         int     i_cbp_chroma;
 429
 430         int     i_intra16x16_pred_mode;
 431         int     i_chroma_pred_mode;
 432
 433         /* skip flags for i4x4 and i8x8
 434          * 0 = encode as normal.
 435          * 1 (non-RD only) = the DCT is still in h->dct, restore fdec and skip reconstruction.
 436          * 2 (RD only) = the DCT has since been overwritten by RD; restore that too. */
 437         int i_skip_intra;
 438         /* skip flag for motion compensation */
 439         /* if we've already done MC, we don't need to do it again */
 440         int b_skip_mc;
 441
 442         struct
 443         {
 444             /* space for p_fenc and p_fdec */
 445 #define FENC_STRIDE 16
 446 #define FDEC_STRIDE 32
 447             DECLARE_ALIGNED_16( uint8_t fenc_buf[24*FENC_STRIDE] );
 448             DECLARE_ALIGNED_16( uint8_t fdec_buf[27*FDEC_STRIDE] );
 449
 450             /* i4x4 and i8x8 backup data, for skipping the encode stage when possible */
 451             DECLARE_ALIGNED_16( uint8_t i4x4_fdec_buf[16*16] );
 452             DECLARE_ALIGNED_16( uint8_t i8x8_fdec_buf[16*16] );
 453             DECLARE_ALIGNED_16( int16_t i8x8_dct_buf[3][64] );
 454             DECLARE_ALIGNED_16( int16_t i4x4_dct_buf[15][16] );
 455
 456             /* pointer over mb of the frame to be compressed */
 457             uint8_t *p_fenc[3];
 458
 459             /* pointer over mb of the frame to be reconstructed  */
 460             uint8_t *p_fdec[3];
 461
 462             /* pointer over mb of the references */
 463             int i_fref[2];
 464             uint8_t *p_fref[2][32][4+2]; /* last: lN, lH, lV, lHV, cU, cV */
 465             uint16_t *p_integral[2][16];
 466
 467             /* fref stride */
 468             int     i_stride[3];
 469         } pic;
 470
 471         /* cache */
 472         struct
 473         {
 474             /* real intra4x4_pred_mode if I_4X4 or I_8X8, I_PRED_4x4_DC if mb available, -1 if not */
 475             int8_t  intra4x4_pred_mode[X264_SCAN8_SIZE];
 476
 477             /* i_non_zero_count if available else 0x80 */
 478             uint8_t non_zero_count[X264_SCAN8_SIZE];
 479
 480             /* -1 if unused, -2 if unavailable */
 481             DECLARE_ALIGNED_4( int8_t ref[2][X264_SCAN8_SIZE] );
 482
 483             /* 0 if not available */
 484             DECLARE_ALIGNED_16( int16_t mv[2][X264_SCAN8_SIZE][2] );
 485             DECLARE_ALIGNED_8( int16_t mvd[2][X264_SCAN8_SIZE][2] );
 486
 487             /* 1 if SKIP or DIRECT. set only for B-frames + CABAC */
 488             DECLARE_ALIGNED_4( int8_t skip[X264_SCAN8_SIZE] );
 489
 490             DECLARE_ALIGNED_16( int16_t direct_mv[2][X264_SCAN8_SIZE][2] );
 491             DECLARE_ALIGNED_4( int8_t  direct_ref[2][X264_SCAN8_SIZE] );
 492             DECLARE_ALIGNED_4( int16_t pskip_mv[2] );
 493
 494             /* number of neighbors (top and left) that used 8x8 dct */
 495             int     i_neighbour_transform_size;
 496             int     i_neighbour_interlaced;
 497         } cache;
 498
 499         /* */
 500         int     i_qp;       /* current qp */
 501         int     i_chroma_qp;
 502         int     i_last_qp;  /* last qp */
 503         int     i_last_dqp; /* last delta qp */
 504         int     b_variable_qp; /* whether qp is allowed to vary per macroblock */
 505         int     b_lossless;
 506         int     b_direct_auto_read; /* take stats for --direct auto from the 2pass log */
 507         int     b_direct_auto_write; /* analyse direct modes, to use and/or save */
 508
 509         /* B_direct and weighted prediction */
 510         int16_t dist_scale_factor[16][2];
 511         int16_t bipred_weight[32][4];
 512         /* maps fref1[0]'s ref indices into the current list0 */
 513         int8_t  map_col_to_list0_buf[2]; // for negative indices
 514         int8_t  map_col_to_list0[16];
 515     } mb;
 516
 517     /* rate control encoding only */
 518     x264_ratecontrol_t *rc;
 519
 520     /* stats */
 521     struct
 522     {
 523         /* Current frame stats */
 524         struct
 525         {
 526             /* Headers bits (MV+Ref+MB Block Type */
 527             int i_hdr_bits;
 528             /* Texture bits (Intra/Predicted) */
 529             int i_itex_bits;
 530             int i_ptex_bits;
 531             /* ? */
 532             int i_misc_bits;
 533             /* MB type counts */
 534             int i_mb_count[19];
 535             int i_mb_count_i;
 536             int i_mb_count_p;
 537             int i_mb_count_skip;
 538             int i_mb_count_8x8dct[2];
 539             int i_mb_count_size[7];
 540             int i_mb_count_ref[32];
 541             /* Estimated (SATD) cost as Intra/Predicted frame */
 542             /* XXX: both omit the cost of MBs coded as P_SKIP */
 543             int i_intra_cost;
 544             int i_inter_cost;
 545             int i_mbs_analysed;
 546             /* Adaptive direct mv pred */
 547             int i_direct_score[2];
 548             /* Metrics */
 549             int64_t i_ssd[3];
 550             double f_ssim;
 551         } frame;
 552
 553         /* Cumulated stats */
 554
 555         /* per slice info */
 556         int     i_slice_count[5];
 557         int64_t i_slice_size[5];
 558         double  f_slice_qp[5];
 559         /* */
 560         int64_t i_sqe_global[5];
 561         double  f_psnr_average[5];
 562         double  f_psnr_mean_y[5];
 563         double  f_psnr_mean_u[5];
 564         double  f_psnr_mean_v[5];
 565         double  f_ssim_mean_y[5];
 566         /* */
 567         int64_t i_mb_count[5][19];
 568         int64_t i_mb_count_8x8dct[2];
 569         int64_t i_mb_count_size[2][7];
 570         int64_t i_mb_count_ref[2][32];
 571         /* */
 572         int     i_direct_score[2];
 573         int     i_direct_frames[2];
 574
 575     } stat;
 576
 577     /* CPU functions dependents */
 578     x264_predict_t      predict_16x16[4+3];
 579     x264_predict_t      predict_8x8c[4+3];
 580     x264_predict8x8_t   predict_8x8[9+3];
 581     x264_predict_t      predict_4x4[9+3];
 582
 583     x264_pixel_function_t pixf;
 584     x264_mc_functions_t   mc;
 585     x264_dct_function_t   dctf;
 586     x264_zigzag_function_t zigzagf;
 587     x264_quant_function_t quantf;
 588     x264_deblock_function_t loopf;
 589
 590 #if VISUALIZE
 591     struct visualize_t *visualize;
 592 #endif
 593 };
 594
 595 // included at the end because it needs x264_t
 596 #include "macroblock.h"
 597
 598 #ifdef HAVE_MMX
 599 #include "x86/util.h"
 600 #endif
 601
 602 #endif
 603