source: 3DVCSoftware/branches/HTM-15.2-dev/source/Lib/TLibCommon/CommonDef.h @ 1362

Last change on this file since 1362 was 1362, checked in by tech, 9 years ago

Align macros
  • Property svn:eol-style set to native
File size: 21.4 KB
Line 
1/* The copyright in this software is being made available under the BSD
2 * License, included below. This software may be subject to other third party
3 * and contributor rights, including patent rights, and no such rights are
4 * granted under this license.
5 *
6 * Copyright (c) 2010-2015, ITU/ISO/IEC
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 *
12 *  * Redistributions of source code must retain the above copyright notice,
13 *    this list of conditions and the following disclaimer.
14 *  * Redistributions in binary form must reproduce the above copyright notice,
15 *    this list of conditions and the following disclaimer in the documentation
16 *    and/or other materials provided with the distribution.
17 *  * Neither the name of the ITU/ISO/IEC nor the names of its contributors may
18 *    be used to endorse or promote products derived from this software without
19 *    specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
31 * THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34/** \file     CommonDef.h
35    \brief    Defines version information, constants and small in-line functions
36*/
37
38#ifndef __COMMONDEF__
39#define __COMMONDEF__
40
41#include <algorithm>
42#include <iostream>
43#include <assert.h>
44#include <limits>
45
46#if _MSC_VER > 1000
47// disable "signed and unsigned mismatch"
48#pragma warning( disable : 4018 )
49// disable Bool coercion "performance warning"
50#pragma warning( disable : 4800 )
51// NH_MV
52// disabled decorated name length warning issued for IntAry5d
53#pragma warning(disable : 4503)
54//
55#endif // _MSC_VER > 1000
56#include "TypeDef.h"
57#ifdef _MSC_VER
58#if _MSC_VER <= 1500
59inline Int64 abs (Int64 x) { return _abs64(x); };
60#endif
61#endif
62#if NH_MV
63#include <assert.h>
64#endif
65
66//! \ingroup TLibCommon
67//! \{
68
69// ====================================================================================================================
70// Version information
71// ====================================================================================================================
72#if NH_MV
73#define NV_VERSION        "15.2"                ///< Current software version
74#define HM_VERSION        "16.6"                ///<
75#else
76#define NV_VERSION        "16.7"                 ///< Current software version
77#endif
78// ====================================================================================================================
79// Platform information
80// ====================================================================================================================
81
82#ifdef __GNUC__
83#define NVM_COMPILEDBY  "[GCC %d.%d.%d]", __GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__
84#ifdef __IA64__
85#define NVM_ONARCH    "[on 64-bit] "
86#else
87#define NVM_ONARCH    "[on 32-bit] "
88#endif
89#endif
90
91#ifdef __INTEL_COMPILER
92#define NVM_COMPILEDBY  "[ICC %d]", __INTEL_COMPILER
93#elif  _MSC_VER
94#define NVM_COMPILEDBY  "[VS %d]", _MSC_VER
95#endif
96
97#ifndef NVM_COMPILEDBY
98#define NVM_COMPILEDBY "[Unk-CXX]"
99#endif
100
101#ifdef _WIN32
102#define NVM_ONOS        "[Windows]"
103#elif  __linux
104#define NVM_ONOS        "[Linux]"
105#elif  __CYGWIN__
106#define NVM_ONOS        "[Cygwin]"
107#elif __APPLE__
108#define NVM_ONOS        "[Mac OS X]"
109#else
110#define NVM_ONOS "[Unk-OS]"
111#endif
112
113#define NVM_BITS          "[%d bit] ", (sizeof(Void*) == 8 ? 64 : 32) ///< used for checking 64-bit O/S
114
115#ifndef NULL
116#define NULL              0
117#endif
118
119// ====================================================================================================================
120// Common constants
121// ====================================================================================================================
122
123static const UInt   MAX_UINT =                            0xFFFFFFFFU; ///< max. value of unsigned 32-bit integer
124static const Int    MAX_INT =                              2147483647; ///< max. value of signed 32-bit integer
125#if NH_MV
126static const Int    MIN_INT =                         (- MAX_INT - 1); ///< max. value of signed 32-bit integer
127#endif
128static const Double MAX_DOUBLE =                             1.7e+308; ///< max. value of Double-type value
129
130// ====================================================================================================================
131// Coding tool configuration
132// ====================================================================================================================
133// Most of these should not be changed - they resolve the meaning of otherwise magic numbers.
134
135static const Int MAX_GOP =                                         64; ///< max. value of hierarchical GOP size
136static const Int MAX_NUM_REF_PICS =                                16; ///< max. number of pictures used for reference
137static const Int MAX_NUM_REF =                                     16; ///< max. number of entries in picture reference list
138static const Int MAX_QP =                                          51;
139static const Int NOT_VALID =                                       -1;
140
141static const Int AMVP_MAX_NUM_CANDS =                               2; ///< AMVP: advanced motion vector prediction - max number of final candidates
142static const Int AMVP_DECIMATION_FACTOR =                           4;
143static const Int MRG_MAX_NUM_CANDS =                                5; ///< MERGE
144
145
146static const Int MAX_TLAYER =                                       7; ///< Explicit temporal layer QP offset - max number of temporal layer
147
148static const Int ADAPT_SR_SCALE =                                   1; ///< division factor for adaptive search range
149
150static const Int MAX_NUM_PICS_IN_SOP =                           1024;
151
152static const Int MAX_NESTING_NUM_OPS =                           1024;
153static const Int MAX_NESTING_NUM_LAYER =                           64;
154
155#if NH_MV
156static const Int MAX_VPS_NUM_HRD_PARAMETERS =                    1024;
157#else
158static const Int MAX_VPS_NUM_HRD_PARAMETERS =                       1;
159#endif
160static const Int MAX_VPS_OP_SETS_PLUS1 =                         1024;
161#if NH_MV
162static const Int MAX_VPS_NUH_LAYER_ID_PLUS1 =                      63;               
163#else
164static const Int MAX_VPS_NUH_RESERVED_ZERO_LAYER_ID_PLUS1 =         1;
165#endif
166
167static const Int MAXIMUM_INTRA_FILTERED_WIDTH =                    16;
168static const Int MAXIMUM_INTRA_FILTERED_HEIGHT =                   16;
169
170static const Int MAX_CPB_CNT =                                     32; ///< Upper bound of (cpb_cnt_minus1 + 1)
171#if NH_MV
172static const Int MAX_NUM_LAYER_IDS =                               63;
173#if NH_MV_SEI
174static const Int MAX_NUM_SEIS      =                               1000;
175#endif
176#else
177static const Int MAX_NUM_LAYER_IDS =                               64;
178#endif
179
180static const Int COEF_REMAIN_BIN_REDUCTION =                        3; ///< indicates the level at which the VLC transitions from Golomb-Rice to TU+EG(k)
181
182static const Int CU_DQP_TU_CMAX =                                   5; ///< max number bins for truncated unary
183static const Int CU_DQP_EG_k =                                      0; ///< expgolomb order
184
185static const Int SBH_THRESHOLD =                                    4; ///< value of the fixed SBH controlling threshold
186
187static const Int C1FLAG_NUMBER =                                    8; // maximum number of largerThan1 flag coded in one chunk:  16 in HM5
188static const Int C2FLAG_NUMBER =                                    1; // maximum number of largerThan2 flag coded in one chunk:  16 in HM5
189
190static const Int MAX_NUM_VPS =                                     16;
191static const Int MAX_NUM_SPS =                                     16;
192static const Int MAX_NUM_PPS =                                     64;
193
194
195static const Int MLS_GRP_NUM =                                     64; ///< Max number of coefficient groups, max(16, 64)
196static const Int MLS_CG_LOG2_WIDTH =                                2;
197static const Int MLS_CG_LOG2_HEIGHT =                               2;
198static const Int MLS_CG_SIZE =                                      4; ///< Coefficient group size of 4x4; = MLS_CG_LOG2_WIDTH + MLS_CG_LOG2_HEIGHT
199
200#if ADAPTIVE_QP_SELECTION
201static const Int ARL_C_PRECISION =                                  7; ///< G382: 7-bit arithmetic precision
202static const Int LEVEL_RANGE =                                     30; ///< G382: max coefficient level in statistics collection
203#endif
204
205static const Int RVM_VCEGAM10_M =                                   4;
206
207static const Int FAST_UDI_MAX_RDMODE_NUM =                         35; ///< maximum number of RD comparison in fast-UDI estimation loop
208
209static const Int NUM_INTRA_MODE =                                  36;
210static const Int PLANAR_IDX =                                       0;
211static const Int VER_IDX =                                         26; ///< index for intra VERTICAL   mode
212static const Int HOR_IDX =                                         10; ///< index for intra HORIZONTAL mode
213static const Int DC_IDX =                                           1; ///< index for intra DC mode
214static const Int NUM_CHROMA_MODE =                                  5; ///< total number of chroma modes
215static const Int DM_CHROMA_IDX =                                   36; ///< chroma mode index for derived from luma intra mode
216
217static const Int MDCS_ANGLE_LIMIT =                                 4; ///< 0 = Horizontal/vertical only, 1 = Horizontal/vertical +/- 1, 2 = Horizontal/vertical +/- 2 etc...
218static const Int MDCS_MAXIMUM_WIDTH =                               8; ///< (measured in pixels) TUs with width greater than this can only use diagonal scan
219static const Int MDCS_MAXIMUM_HEIGHT =                              8; ///< (measured in pixels) TUs with height greater than this can only use diagonal scan
220
221
222static const Int LOG2_MAX_NUM_COLUMNS_MINUS1 =                      7;
223static const Int LOG2_MAX_NUM_ROWS_MINUS1 =                         7;
224
225static const Int CABAC_INIT_PRESENT_FLAG =                          1;
226
227static const Int LUMA_INTERPOLATION_FILTER_SUB_SAMPLE_POSITIONS =   4;
228static const Int CHROMA_INTERPOLATION_FILTER_SUB_SAMPLE_POSITIONS = 8;
229
230static const Int MAX_NUM_LONG_TERM_REF_PICS =                      33;
231static const Int NUM_LONG_TERM_REF_PIC_SPS =                        0;
232
233
234static const Int MAX_QP_OFFSET_LIST_SIZE =                          6; ///< Maximum size of QP offset list is 6 entries
235
236// Cost mode support
237static const Int LOSSLESS_AND_MIXED_LOSSLESS_RD_COST_TEST_QP =      0; ///< QP to use for lossless coding.
238static const Int LOSSLESS_AND_MIXED_LOSSLESS_RD_COST_TEST_QP_PRIME =4; ///< QP' to use for mixed_lossy_lossless coding.
239
240static const Int RExt__GOLOMB_RICE_ADAPTATION_STATISTICS_SETS =     4;
241static const Int RExt__GOLOMB_RICE_INCREMENT_DIVISOR =              4;
242
243static const Int RExt__PREDICTION_WEIGHTING_ANALYSIS_DC_PRECISION = 0; ///< Additional fixed bit precision used during encoder-side weighting prediction analysis. Currently only used when high_precision_prediction_weighting_flag is set, for backwards compatibility reasons.
244
245static const Int MAX_TIMECODE_SEI_SETS =                            3; ///< Maximum number of time sets
246
247static const Int MAX_CU_DEPTH =                                     6; ///< log2(CTUSize)
248static const Int MAX_CU_SIZE =                                     64; ///< = 1<<(MAX_CU_DEPTH)
249static const Int MIN_PU_SIZE =                                      4;
250static const Int MIN_TU_SIZE =                                      4;
251static const Int MAX_TU_SIZE =                                     32;
252static const Int MAX_NUM_PART_IDXS_IN_CTU_WIDTH = MAX_CU_SIZE/MIN_PU_SIZE; ///< maximum number of partition indices across the width of a CTU (or height of a CTU)
253static const Int SCALING_LIST_REM_NUM =                             6;
254
255static const Int QUANT_SHIFT =                                     14; ///< Q(4) = 2^14
256static const Int IQUANT_SHIFT =                                     6;
257static const Int SCALE_BITS =                                      15; ///< For fractional bit estimates in RDOQ
258
259static const Int SCALING_LIST_NUM = MAX_NUM_COMPONENT * NUMBER_OF_PREDICTION_MODES; ///< list number for quantization matrix
260
261static const Int SCALING_LIST_START_VALUE =                        8 ; ///< start value for dpcm mode
262static const Int MAX_MATRIX_COEF_NUM =                            64 ; ///< max coefficient number for quantization matrix
263static const Int MAX_MATRIX_SIZE_NUM =                             8 ; ///< max size number for quantization matrix
264static const Int SCALING_LIST_BITS =                               8 ; ///< bit depth of scaling list entries
265static const Int LOG2_SCALING_LIST_NEUTRAL_VALUE =                 4 ; ///< log2 of the value that, when used in a scaling list, has no effect on quantisation
266static const Int SCALING_LIST_DC =                                16 ; ///< default DC value
267
268static const Int CONTEXT_STATE_BITS =                              6 ;
269static const Int LAST_SIGNIFICANT_GROUPS =                        10 ;
270
271#if NH_MV
272static const Int  MAX_VPS_NUM_ADD_LAYER_SETS =                  1024 ;
273static const Int  MAX_NUM_SCALABILITY_TYPES =                     16 ;
274static const Int  ENC_CFG_CONSOUT_SPACE =                         34 ;           
275static const Int  MAX_NUM_LAYERS =                                63 ;
276static const Int  MAX_VPS_PROFILE_TIER_LEVEL =                    64 ;
277static const Int  MAX_VPS_ADD_OUTPUT_LAYER_SETS =               1024 ;
278static const Int  MAX_VPS_OUTPUTLAYER_SETS =  MAX_VPS_ADD_OUTPUT_LAYER_SETS + MAX_VPS_OP_SETS_PLUS1 + MAX_VPS_OP_SETS_PLUS1 ;
279static const Int  MAX_NUM_VIDEO_SIGNAL_INFO =                     16 ;
280static const Int  MAX_NUM_SCALED_REF_LAYERS =     MAX_NUM_LAYERS - 1 ; 
281static const Int  MAX_NUM_PICS_RPS          =                     16 ; 
282static const Int  MAX_NUM_REF_LAYERS        =                     63 ; 
283#if NH_MV_SEI
284static IntAry1d getRangeVec( Int rngStart, Int rngEnd ) { IntAry1d rng; for (Int i = rngStart; i<=rngEnd; i++) rng.push_back(i);  return rng; };
285static const IntAry1d IDR_NAL_UNIT_TYPES   = getRangeVec( NAL_UNIT_CODED_SLICE_IDR_W_RADL, NAL_UNIT_CODED_SLICE_IDR_N_LP ); 
286static const IntAry1d IRAP_NAL_UNIT_TYPES  = getRangeVec( NAL_UNIT_CODED_SLICE_BLA_W_LP  , NAL_UNIT_CODED_SLICE_CRA      ); 
287
288#endif
289#endif
290
291// ====================================================================================================================
292// Macro functions
293// ====================================================================================================================
294
295template <typename T> inline T Clip3 (const T minVal, const T maxVal, const T a) { return std::min<T> (std::max<T> (minVal, a) , maxVal); }  ///< general min/max clip
296template <typename T> inline T ClipBD(const T x, const Int bitDepth)             { return Clip3(T(0), T((1 << bitDepth)-1), x);           }
297
298template <typename T> inline Void Check3( T minVal, T maxVal, T a)
299{
300  if ((a > maxVal) || (a < minVal))
301  {
302    std::cerr << "ERROR: Range check " << minVal << " >= " << a << " <= " << maxVal << " failed" << std::endl;
303    assert(false);
304    exit(1);
305  }
306}  ///< general min/max clip
307
308#define DATA_ALIGN                  1                                                                 ///< use 32-bit aligned malloc/free
309#if     DATA_ALIGN && _WIN32 && ( _MSC_VER > 1300 )
310#define xMalloc( type, len )        _aligned_malloc( sizeof(type)*(len), 32 )
311#define xFree( ptr )                _aligned_free  ( ptr )
312#else
313#define xMalloc( type, len )        malloc   ( sizeof(type)*(len) )
314#define xFree( ptr )                free     ( ptr )
315#endif
316
317#define FATAL_ERROR_0(MESSAGE, EXITCODE)                      \
318{                                                             \
319  printf(MESSAGE);                                            \
320  exit(EXITCODE);                                             \
321}
322
323template <typename ValueType> inline ValueType leftShift       (const ValueType value, const Int shift) { return (shift >= 0) ? ( value                                  << shift) : ( value                                   >> -shift); }
324template <typename ValueType> inline ValueType rightShift      (const ValueType value, const Int shift) { return (shift >= 0) ? ( value                                  >> shift) : ( value                                   << -shift); }
325template <typename ValueType> inline ValueType leftShift_round (const ValueType value, const Int shift) { return (shift >= 0) ? ( value                                  << shift) : ((value + (ValueType(1) << (-shift - 1))) >> -shift); }
326template <typename ValueType> inline ValueType rightShift_round(const ValueType value, const Int shift) { return (shift >= 0) ? ((value + (ValueType(1) << (shift - 1))) >> shift) : ( value                                   << -shift); }
327#if O0043_BEST_EFFORT_DECODING
328// when shift = 0, returns value
329// when shift = 1, (value + 0 + value[1]) >> 1
330// when shift = 2, (value + 1 + value[2]) >> 2
331// when shift = 3, (value + 3 + value[3]) >> 3
332template <typename ValueType> inline ValueType rightShiftEvenRounding(const ValueType value, const UInt shift) { return (shift == 0) ? value : ((value + (1<<(shift-1))-1 + ((value>>shift)&1)) >> shift) ; }
333#endif
334#if NH_MV
335
336#define AOF( exp )                  \
337{                                   \
338  if( !( exp ) )                    \
339{                                 \
340  assert( 0 );                    \
341}                                 \
342}
343
344#define AOT( exp )            \
345{                             \
346  if( ( exp ) )               \
347{                           \
348  assert( 0 );              \
349}                           \
350}
351
352template <typename T>
353__inline T gSign(const T& t)
354{
355  if( t == 0 )
356    return T(0);
357  else
358    return (t < 0) ? T(-1) : T(1);
359}
360
361template <typename T>
362__inline T gCeilLog2( T val )
363{
364  assert( val > 0 ); 
365  Int ceilLog2 = 0;
366  while( val > ( 1 << ceilLog2 ) ) ceilLog2++;
367  return ceilLog2;
368}
369
370#define RemoveBitIncrement( exp ) ( exp >> ( REN_BIT_DEPTH - 8 ) )
371
372#endif
373
374#if NH_3D_MLC  || NH_3D_ARP
375#define MRG_MAX_NUM_CANDS_MEM       (MRG_MAX_NUM_CANDS+1) // one extra for inter-view motion prediction
376#endif
377
378#if NH_MV
379static const std::string NALU_TYPE_STR[] = { 
380    "CODED_SLICE_TRAIL_N   ",  // 0
381    "CODED_SLICE_TRAIL_R   ",  // 1
382    "CODED_SLICE_TSA_N     ",  // 2
383    "CODED_SLICE_TSA_R     ",  // 3
384    "CODED_SLICE_STSA_N    ",  // 4
385    "CODED_SLICE_STSA_R    ",  // 5
386    "CODED_SLICE_RADL_N    ",  // 6
387    "CODED_SLICE_RADL_R    ",  // 7
388    "CODED_SLICE_RASL_N    ",  // 8
389    "CODED_SLICE_RASL_R    ",  // 9
390    "RESERVED_VCL_N10      ",
391    "RESERVED_VCL_R11      ",
392    "RESERVED_VCL_N12      ",
393    "RESERVED_VCL_R13      ",
394    "RESERVED_VCL_N14      ",
395    "RESERVED_VCL_R15      ",
396    "CODED_SLICE_BLA_W_LP  ",  // 16
397    "CODED_SLICE_BLA_W_RADL",  // 17
398    "CODED_SLICE_BLA_N_LP  ",  // 18
399    "CODED_SLICE_IDR_W_RADL",  // 19
400    "CODED_SLICE_IDR_N_LP  ",  // 20
401    "CODED_SLICE_CRA       ",  // 21
402    "RESERVED_IRAP_VCL22   ",
403    "RESERVED_IRAP_VCL23   ",
404    "RESERVED_VCL24        ",
405    "RESERVED_VCL25        ",
406    "RESERVED_VCL26        ",
407    "RESERVED_VCL27        ",
408    "RESERVED_VCL28        ",
409    "RESERVED_VCL29        ",
410    "RESERVED_VCL30        ",
411    "RESERVED_VCL31        ",
412    "VPS                   ",   // 32
413    "SPS                   ",   // 33
414    "PPS                   ",   // 34
415    "ACCESS_UNIT_DELIMITER ",   // 35
416    "EOS                   ",   // 36
417    "EOB                   ",   // 37
418    "FILLER_DATA           ",   // 38
419    "PREFIX_SEI            ",   // 39
420    "SUFFIX_SEI            ",   // 40
421    "RESERVED_NVCL41       ",
422    "RESERVED_NVCL42       ",
423    "RESERVED_NVCL43       ",
424    "RESERVED_NVCL44       ",
425    "RESERVED_NVCL45       ",
426    "RESERVED_NVCL46       ",
427    "RESERVED_NVCL47       ",
428    "UNSPECIFIED_48        ",
429    "UNSPECIFIED_49        ",
430    "UNSPECIFIED_50        ",
431    "UNSPECIFIED_51        ",
432    "UNSPECIFIED_52        ",
433    "UNSPECIFIED_53        ",
434    "UNSPECIFIED_54        ",
435    "UNSPECIFIED_55        ",
436    "UNSPECIFIED_56        ",
437    "UNSPECIFIED_57        ",
438    "UNSPECIFIED_58        ",
439    "UNSPECIFIED_59        ",
440    "UNSPECIFIED_60        ",
441    "UNSPECIFIED_61        ",
442    "UNSPECIFIED_62        ",
443    "UNSPECIFIED_63        ",
444    "INVALID               "               
445  };
446#endif
447
448#if NH_3D
449//PICYUV
450#define PICYUV_PAD         16
451
452//RENDERER
453
454
455#define REN_BIT_DEPTH     8
456#define REN_LUMA_MARGIN   ( PICYUV_PAD + 1 ) // + g_uiMaxCuWidth instead of 1 ???
457#define REN_VDWEIGHT_PREC  8
458#define REN_IS_FILLED     ( 1 << REN_VDWEIGHT_PREC )
459#define REN_USED_PEL       ( (1 << REN_BIT_DEPTH) - 1 )
460#define REN_UNUSED_PEL     0
461#define REN_IS_HOLE        0
462#if NH_3D_VSO
463#define ENC_INTERNAL_BIT_DEPTH  REN_BIT_DEPTH // consider making this a variable
464#endif
465
466
467// CAMERA PARAMETERS
468#define LOG2_DISP_PREC_LUT           2           ///< log2 of disparity precision used in integer disparity LUTs
469#define STD_CAM_PARAMETERS_PRECISION 5        ///< quarter luma sample accuarcy for derived disparities (as default)
470
471#endif // end of NH_3D
472//! \}
473
474#endif // end of #ifndef  __COMMONDEF__
475
Note: See TracBrowser for help on using the repository browser.