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

Last change on this file since 56 was 56, checked in by hschwarz, 12 years ago

updated trunk (move to HM6.1)

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