source: 3DVCSoftware/branches/HTM-4.1-dev1-HHI/source/Lib/TLibCommon/CommonDef.h

Last change on this file was 169, checked in by qualcomm, 12 years ago

JCT3V-B0047, B0069 and B0086

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