source: 3DVCSoftware/branches/HTM-5.0-Qualcomm/source/Lib/TLibCommon/CommonDef.h

Last change on this file was 195, checked in by tech, 12 years ago

Changed macro switch names to match conventions.

  • Property svn:eol-style set to native
File size: 19.0 KB
RevLine 
[5]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
[56]4 * granted under this license. 
[5]5 *
[56]6 * Copyright (c) 2010-2012, ITU/ISO/IEC
[5]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.
[56]17 *  * Neither the name of the ITU/ISO/IEC nor the names of its contributors may
[5]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 */
[2]33
34/** \file     CommonDef.h
35    \brief    Defines constants, macros and tool parameters
36*/
37
38#ifndef __COMMONDEF__
39#define __COMMONDEF__
40
[56]41#include <algorithm>
42
[2]43#if _MSC_VER > 1000
[56]44// disable "signed and unsigned mismatch"
[2]45#pragma warning( disable : 4018 )
[56]46// disable bool coercion "performance warning"
47#pragma warning( disable : 4800 )
[2]48#endif // _MSC_VER > 1000
49#include "TypeDef.h"
50
[56]51#include <stdio.h>
52//! \ingroup TLibCommon
53//! \{
[2]54
55// ====================================================================================================================
56// Version information
57// ====================================================================================================================
58
[56]59#define HM_VERSION        "6.1"
[189]60#define NV_VERSION        "5.0"                  ///< Current software version
[2]61
62// ====================================================================================================================
63// Platform information
64// ====================================================================================================================
65
66#ifdef __GNUC__
67#define NVM_COMPILEDBY  "[GCC %d.%d.%d]", __GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__
68#ifdef __IA64__
69#define NVM_ONARCH    "[on 64-bit] "
70#else
71#define NVM_ONARCH    "[on 32-bit] "
72#endif
73#endif
74
75#ifdef __INTEL_COMPILER
76#define NVM_COMPILEDBY  "[ICC %d]", __INTEL_COMPILER
77#elif  _MSC_VER
78#define NVM_COMPILEDBY  "[VS %d]", _MSC_VER
79#endif
80
81#ifndef NVM_COMPILEDBY
82#define NVM_COMPILEDBY "[Unk-CXX]"
83#endif
84
85#ifdef _WIN32
86#define NVM_ONOS        "[Windows]"
87#elif  __linux
88#define NVM_ONOS        "[Linux]"
89#elif  __CYGWIN__
90#define NVM_ONOS        "[Cygwin]"
91#elif __APPLE__
92#define NVM_ONOS        "[Mac OS X]"
93#else
94#define NVM_ONOS "[Unk-OS]"
95#endif
96
97#define NVM_BITS          "[%d bit] ", (sizeof(void*) == 8 ? 64 : 32) ///< used for checking 64-bit O/S
98
99#ifndef NULL
100#define NULL              0
101#endif
102
103// ====================================================================================================================
104// Common constants
105// ====================================================================================================================
106
107#define _SUMMARY_OUT_               0           ///< print-out PSNR results of all slices to summary.txt
108#define _SUMMARY_PIC_               0           ///< print-out PSNR results for each slice type to summary.txt
109
110#define MAX_GOP                     64          ///< max. value of hierarchical GOP size
111
112#define MAX_NUM_REF                 4           ///< max. value of multiple reference frames
113#define MAX_NUM_REF_LC              8           ///< max. value of combined reference frames
114
115#define MAX_UINT                    0xFFFFFFFFU ///< max. value of unsigned 32-bit integer
116#define MAX_INT                     2147483647  ///< max. value of signed 32-bit integer
117#define MIN_INT                     (-2147483647-1) // < min. value of signed 32-bit integer
118#define MAX_DOUBLE                  1.7e+308    ///< max. value of double-type value
119
120#define MIN_QP                      0
121#define MAX_QP                      51
122
123#define NOT_VALID                   -1
124
[56]125// ====================================================================================================================
126// 3D constants
127// ====================================================================================================================
128#define MAX_VIEW_NUM                10
[2]129
[5]130#if ( HHI_INTER_VIEW_MOTION_PRED || HHI_INTER_VIEW_RESIDUAL_PRED )
131#define DEPTH_MAP_GENERATION        1
[100]132#define PDM_REMOVE_DEPENDENCE       1      //bug-fix for DMDV JCT2-A0095
[5]133#else
134#define DEPTH_MAP_GENERATION        0
135#endif
136
[2]137//>>>>> generation and usage of virtual prediction depth maps >>>>>
138#define PDM_ONE_DEPTH_PER_PU              1         // use only a single depth for a prediction unit (in update)
[21]139#define PDM_NO_INTER_UPDATE               1         // no update for inter (but not inter-view) predicted blocks
[56]140#define PDM_MERGE_POS                     0         // position of pdm in merge list (0..4)
[189]141
142#if QC_MRG_CANS_B0048
143#if OL_DISMV_POS_B0069
144#define DMV_MERGE_POS                     4
145#else
146#define DMV_MERGE_POS                     1
147#endif
148#endif
149
150#if SAIT_IMPROV_MOTION_PRED_M24829&!QC_MULTI_DIS_CAN_A0097
[77]151#define PDM_AMVP_POS                      0         // position of pdm in amvp list  (0..3)
152#else
[2]153#define PDM_AMVP_POS                      2         // position of pdm in amvp list  (0..3)
[77]154#endif
[2]155#define PDM_OUTPUT_PRED_DEPTH_MAP         0         // output prediction depth map (for debugging)
156
157#define PDM_INTERNAL_CALC_BIT_DEPTH       31        // bit depth for internal calculations (32 - 1 for signed values)
158#define PDM_BITDEPTH_VIRT_DEPTH           15        // bit depth for virtual depth storage (16 - 1 for signed values)
159#define PDM_LOG2_MAX_ABS_NORMAL_DISPARITY 8         // maximum absolute normal disparity = 256 (for setting accuracy)
160#define PDM_VIRT_DEPTH_PRECISION          4         // must be greater than or equal to 2 (since MVs are given in quarter-pel units)
161
162#define PDM_INTER_CALC_SHIFT              ( PDM_INTERNAL_CALC_BIT_DEPTH - PDM_BITDEPTH_VIRT_DEPTH )         // avoids overflow
163#define PDM_LOG4_SCALE_DENOMINATOR        ( PDM_LOG2_MAX_ABS_NORMAL_DISPARITY + PDM_VIRT_DEPTH_PRECISION )  // accuracy of scaling factor
164#define PDM_OFFSET_SHIFT                  ( PDM_LOG2_MAX_ABS_NORMAL_DISPARITY )                             // accuracy of offset
165
166#define PDM_MAX_ABS_VIRT_DEPTH            (  ( 1 << PDM_BITDEPTH_VIRT_DEPTH ) - 1 )
167#define PDM_UNDEFINED_DEPTH               ( -( 1 << PDM_BITDEPTH_VIRT_DEPTH )     )
168
169#define PDM_USE_FOR_IVIEW                 1
170#define PDM_USE_FOR_INTER                 2
171#define PDM_USE_FOR_MERGE                 4
[21]172
[56]173#define PDM_SUBSAMPLING_EXP               2         // subsampling factor is 2^PDM_SUBSAMPLING_EXP
[21]174#define PDM_SUB_SAMP_EXP_X(Pdm)           ((Pdm)==1?PDM_SUBSAMPLING_EXP:0)
175#define PDM_SUB_SAMP_EXP_Y(Pdm)           ((Pdm)==1?PDM_SUBSAMPLING_EXP:0)
[2]176//<<<<< generation and usage of virtual prediction depth maps <<<<<
177
178#define OUTPUT_RESIDUAL_PICTURES          0         // output residual pictures (for debugging)
179
[56]180#define STD_CAM_PARAMETERS_PRECISION 5        ///< quarter luma sample accuarcy for derived disparities (as default)
[2]181
[100]182#define LOG2_DISP_PREC_LUT           2          ///< log2 of disparity precision used in integer disparity LUTs
[2]183
[77]184// ====================================================================================================================
185// VPS constants
186// ====================================================================================================================
[195]187#if QC_MVHEVC_B0046
[194]188#define MAX_LAYER_NUM                     MAX_VIEW_NUM
189#endif
[77]190#if VIDYO_VPS_INTEGRATION
191#define MAX_LAYER_NUM                     MAX_VIEW_NUM
192#define VPS_EXTENSION_TYPE_MULTI_VIEW     0
193#endif
[56]194
[2]195// ====================================================================================================================
196// Macro functions
197// ====================================================================================================================
[56]198extern UInt g_uiIBDI_MAX;
[2]199
[56]200/** clip x, such that 0 <= x <= #g_uiIBDI_MAX */
201template <typename T> inline T Clip(T x) { return std::min<T>(T(g_uiIBDI_MAX), std::max<T>( T(0), x)); }
[2]202
[56]203/** clip a, such that minVal <= a <= maxVal */
204template <typename T> inline T Clip3( T minVal, T maxVal, T a) { return std::min<T> (std::max<T> (minVal, a) , maxVal); }  ///< general min/max clip
205
[2]206#define DATA_ALIGN                  1                                                                 ///< use 32-bit aligned malloc/free
207#if     DATA_ALIGN && _WIN32 && ( _MSC_VER > 1300 )
208#define xMalloc( type, len )        _aligned_malloc( sizeof(type)*(len), 32 )
209#define xFree( ptr )                _aligned_free  ( ptr )
210#else
211#define xMalloc( type, len )        malloc   ( sizeof(type)*(len) )
212#define xFree( ptr )                free     ( ptr )
213#endif
214
215#define FATAL_ERROR_0(MESSAGE, EXITCODE)                      \
216{                                                             \
217  printf(MESSAGE);                                            \
218  exit(EXITCODE);                                             \
219}
220
221#define ROF( exp )            \
222{                             \
223  if( !( exp ) )              \
[56]224{                           \
225  assert( 0 );              \
226  return -1;                \
227}                           \
[2]228}
229
230#define ROT( exp )            \
231{                             \
232  if( ( exp ) )               \
[56]233{                           \
234  assert( 0 );              \
235  return -1;                \
236}                           \
[2]237}
238
239#define ROFS( exp )           \
240{                             \
241  if( !( exp ) )              \
[56]242{                           \
243  return -1;                \
244}                           \
[2]245}
246
247#define ROTS( exp )           \
248{                             \
249  if( ( exp ) )               \
[56]250{                           \
251  return -1;                \
252}                           \
[2]253}
254
255#define ROFR( exp, retVal )   \
256{                             \
257  if( !( exp ) )              \
[56]258{                           \
259  assert( 0 );              \
260  return retVal;            \
261}                           \
[2]262}
263
264#define ROTR( exp, retVal )   \
265{                             \
266  if( ( exp ) )               \
[56]267{                           \
268  assert( 0 );              \
269  return retVal;            \
270}                           \
[2]271}
272
273#define ROFRS( exp, retVal )  \
274{                             \
275  if( !( exp ) )              \
[56]276{                           \
277  return retVal;            \
278}                           \
[2]279}
280
281#define ROTRS( exp, retVal )  \
282{                             \
283  if( ( exp ) )               \
[56]284{                           \
285  return retVal;            \
286}                           \
[2]287}
288
289#define ROFV( exp )           \
290{                             \
291  if( !( exp ) )              \
[56]292{                           \
293  assert( 0 );              \
294  return;                   \
295}                           \
[2]296}
297
298#define ROTV( exp )           \
299{                             \
300  if( ( exp ) )               \
[56]301{                           \
302  assert( 0 );              \
303  return;                   \
304}                           \
[2]305}
306
307#define ROFVS( exp )          \
308{                             \
309  if( !( exp ) )              \
[56]310{                           \
311  return;                   \
312}                           \
[2]313}
314
315#define ROTVS( exp )          \
316{                             \
317  if( ( exp ) )               \
[56]318{                           \
319  return;                   \
320}                           \
[2]321}
322
323#define RNOK( exp )                   \
324{                                     \
325  const ErrVal nMSysRetVal = ( exp ); \
326  if( 0 != nMSysRetVal )              \
[56]327{                                   \
328  assert( 0 );                      \
329  return nMSysRetVal;               \
330}                                   \
[2]331}
332
333#define RNOKR( exp, retVal )        \
334{                                   \
335  if( 0 != ( exp ) )                \
[56]336{                                 \
337  assert( 0 );                    \
338  return retVal;                  \
339}                                 \
[2]340}
341
342#define RNOKS( exp )                  \
343{                                     \
344  const ErrVal nMSysRetVal = ( exp ); \
345  if( 0 != nMSysRetVal )              \
[56]346{                                   \
347  return nMSysRetVal;               \
348}                                   \
[2]349}
350
351#define RNOKRS( exp, retVal )       \
352{                                   \
353  if( 0 != ( exp ) )                \
[56]354{                                 \
355  return retVal;                  \
356}                                 \
[2]357}
358
359#define RNOKV( exp )                \
360{                                   \
361  if( 0 != ( exp ) )                \
[56]362{                                 \
363  assert( 0 );                    \
364  return;                         \
365}                                 \
[2]366}
367
368#define RNOKVS( exp )               \
369{                                   \
370  if( 0 != ( exp ) )                \
[56]371{                                 \
372  return;                         \
373}                                 \
[2]374}
375
376#define ANOK( exp )                 \
377{                                   \
378  if( 0 != ( exp ) )                \
[56]379{                                 \
380  assert( 0 );                    \
381}                                 \
[2]382}
383
384#define AOF( exp )                  \
385{                                   \
386  if( !( exp ) )                    \
[56]387{                                 \
388  assert( 0 );                    \
389}                                 \
[2]390}
391
392#define AOT( exp )            \
393{                             \
394  if( ( exp ) )               \
[56]395{                           \
396  assert( 0 );              \
397}                           \
[2]398}
399
[56]400template <typename T>
401__inline T gSign(const T& t)
402{
403  if( t == 0 )
404    return T(0);
405  else
406    return (t < 0) ? T(-1) : T(1);
407}
[2]408
[56]409#define Max(x, y)                   ((x)>(y)?(x):(y))                                                 ///< max of (x, y)
410#define Min(x, y)                   ((x)<(y)?(x):(y))                                                 ///< min of (x, y)
411#define Median(a,b,c)               ((a)>(b)?(a)>(c)?(b)>(c)?(b):(c):(a):(b)>(c)?(a)>(c)?(a):(c):(b)) ///< 3-point median
412#define Clip(x)                     ( Min(g_uiIBDI_MAX, Max( 0, (x)) ) )                              ///< clip with bit-depth range
413#define Clip3( MinVal, MaxVal, a)   ( ((a)<(MinVal)) ? (MinVal) : (((a)>(MaxVal)) ? (MaxVal) :(a)) )  ///< general min/max clip
414#define RemoveBitIncrement(x)       ( (x + ( (1 << g_uiBitIncrement) >> 1 )) >> g_uiBitIncrement )     ///< Remove Bit increment
[2]415
[100]416#if SAIT_VSO_EST_A0033
417#define ROUND(a)  (((a) < 0)? (int)((a) - 0.5) : (int)((a) + 0.5))
418#endif
419
[56]420// ====================================================================================================================
421// Coding tool configuration
422// ====================================================================================================================
423
424// AMVP: advanced motion vector prediction
425#define AMVP_MAX_NUM_CANDS          2           ///< max number of final candidates
426#if HHI_INTER_VIEW_MOTION_PRED
427#define AMVP_MAX_NUM_CANDS_MEM      4           ///< max number of candidates
[2]428#else
[56]429#define AMVP_MAX_NUM_CANDS_MEM      3           ///< max number of candidates
430#endif
431// MERGE
432#define MRG_MAX_NUM_CANDS           5
433#if HHI_INTER_VIEW_MOTION_PRED
434#define MRG_MAX_NUM_CANDS_MEM       (MRG_MAX_NUM_CANDS+1) // one extra for inter-view motion prediction
435#endif
[2]436
[56]437// Reference memory management
438#define DYN_REF_FREE                0           ///< dynamic free of reference memories
[2]439
[56]440// Explicit temporal layer QP offset
441#if H0567_DPB_PARAMETERS_PER_TEMPORAL_LAYER
442#define MAX_TLAYER                  8           ///< max number of temporal layer
443#else
444#define MAX_TLAYER                  4           ///< max number of temporal layer
[2]445#endif
[56]446#define HB_LAMBDA_FOR_LDC           1           ///< use of B-style lambda for non-key pictures in low-delay mode
[2]447
[56]448// Fast estimation of generalized B in low-delay mode
449#define GPB_SIMPLE                  1           ///< Simple GPB mode
450#if     GPB_SIMPLE
451#define GPB_SIMPLE_UNI              1           ///< Simple mode for uni-direction
452#endif
[2]453
[56]454// Fast ME using smoother MV assumption
455#define FASTME_SMOOTHER_MV          1           ///< reduce ME time using faster option
[2]456
[56]457// Adaptive search range depending on POC difference
458#define ADAPT_SR_SCALE              1           ///< division factor for adaptive search range
[2]459
[56]460#define CLIP_TO_709_RANGE           0
[2]461
[56]462// IBDI range restriction for skipping clip
463#define IBDI_NOCLIP_RANGE           0           ///< restrict max. value after IBDI to skip clip
[2]464
[56]465// Early-skip threshold (encoder)
466#define EARLY_SKIP_THRES            1.50        ///< if RD < thres*avg[BestSkipRD]
467
468#define MAX_NUM_REF_PICS 16
469
470#if !NAL_REF_FLAG
471enum NalRefIdc
[2]472{
[56]473  NAL_REF_IDC_PRIORITY_LOWEST = 0,
474  NAL_REF_IDC_PRIORITY_LOW,
475  NAL_REF_IDC_PRIORITY_HIGH,
476  NAL_REF_IDC_PRIORITY_HIGHEST
477};
478#endif
[2]479
[56]480enum NalUnitType
481{
482  NAL_UNIT_UNSPECIFIED_0 = 0,
483  NAL_UNIT_CODED_SLICE,
484#if H0566_TLA
[195]485#if QC_REM_IDV_B0046
[194]486  NAL_UNIT_RESERVED,
487#else
[56]488  NAL_UNIT_CODED_SLICE_IDV,
[194]489#endif
[56]490  NAL_UNIT_CODED_SLICE_TLA,
491  NAL_UNIT_CODED_SLICE_CRA,
492#else
493  NAL_UNIT_CODED_SLICE_DATAPART_A,
494  NAL_UNIT_CODED_SLICE_DATAPART_B,
495  NAL_UNIT_CODED_SLICE_CDR,
496#endif
497  NAL_UNIT_CODED_SLICE_IDR,
498  NAL_UNIT_SEI,
499  NAL_UNIT_SPS,
500  NAL_UNIT_PPS,
501  NAL_UNIT_ACCESS_UNIT_DELIMITER,
502  NAL_UNIT_RESERVED_10,
503  NAL_UNIT_RESERVED_11,
504  NAL_UNIT_FILLER_DATA,
505  NAL_UNIT_RESERVED_13,
506  NAL_UNIT_APS,
507  NAL_UNIT_RESERVED_15,
508  NAL_UNIT_RESERVED_16,
509  NAL_UNIT_RESERVED_17,
510  NAL_UNIT_RESERVED_18,
511  NAL_UNIT_RESERVED_19,
512  NAL_UNIT_RESERVED_20,
513  NAL_UNIT_RESERVED_21,
514  NAL_UNIT_RESERVED_22,
515  NAL_UNIT_RESERVED_23,
516  NAL_UNIT_UNSPECIFIED_24,
[195]517#if VIDYO_VPS_INTEGRATION|QC_MVHEVC_B0046
[100]518  NAL_UNIT_VPS,
[77]519#else
[56]520  NAL_UNIT_UNSPECIFIED_25,
[77]521#endif
[56]522  NAL_UNIT_UNSPECIFIED_26,
523  NAL_UNIT_UNSPECIFIED_27,
524  NAL_UNIT_UNSPECIFIED_28,
525  NAL_UNIT_UNSPECIFIED_29,
526  NAL_UNIT_UNSPECIFIED_30,
527  NAL_UNIT_UNSPECIFIED_31,
528  NAL_UNIT_INVALID,
529};
[2]530
[56]531//PICYUV
532#define PICYUV_PAD         16
[2]533
[56]534//RENDERER
535#define REN_LUMA_MARGIN   ( g_uiMaxCUWidth + PICYUV_PAD )
536#define REN_VDWEIGHT_PREC  8
537#define REN_IS_FILLED     ( 1 << REN_VDWEIGHT_PREC )
538#define REN_USED_PEL       g_uiIBDI_MAX
539#define REN_UNUSED_PEL     0
540#define REN_IS_HOLE        0
541
542
543typedef Int64 PicOrderCnt;
544
545//! \}
546
[2]547#endif // end of #ifndef  __COMMONDEF__
548
Note: See TracBrowser for help on using the repository browser.