source: 3DVCSoftware/branches/HTM-4.0-Nokia/source/Lib/TLibCommon/CommonDef.h @ 138

Last change on this file since 138 was 105, checked in by tech, 12 years ago

Fixes and update of xcode project

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