source: 3DVCSoftware/trunk/source/Lib/TLibCommon/CommonDef.h @ 332

Last change on this file since 332 was 332, checked in by tech, 11 years ago

Merged branch 6.1-Cleanup@329.

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