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

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