source: 3DVCSoftware/branches/HTM-3.1-Qualcomm/source/Lib/TLibCommon/CommonDef.h @ 91

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

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