source: SHVCSoftware/branches/SHM-dev/source/Lib/TLibCommon/CommonDef.h @ 1284

Last change on this file since 1284 was 1283, checked in by seregin, 10 years ago

port rev 4313
  • Property svn:eol-style set to native
File size: 13.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-2015, 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#include <iostream>
43#include <assert.h>
44
45#if _MSC_VER > 1000
46// disable "signed and unsigned mismatch"
47#pragma warning( disable : 4018 )
48// disable Bool coercion "performance warning"
49#pragma warning( disable : 4800 )
50#endif // _MSC_VER > 1000
51#include "TypeDef.h"
52
53#ifdef _MSC_VER
54#if _MSC_VER <= 1500
55inline Int64 abs (Int64 x) { return _abs64(x); };
56#endif
57#endif
58
59//! \ingroup TLibCommon
60//! \{
61
62// ====================================================================================================================
63// Version information
64// ====================================================================================================================
65
66#if SVC_EXTENSION
67#include <vector>
68#define NV_VERSION        "9.0 (HM-16.3)"        ///< Current SHM software version
69#else
70#define NV_VERSION        "16.3"                 ///< Current software version
71#endif
72
73// ====================================================================================================================
74// Platform information
75// ====================================================================================================================
76
77#ifdef __GNUC__
78#define NVM_COMPILEDBY  "[GCC %d.%d.%d]", __GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__
79#ifdef __IA64__
80#define NVM_ONARCH    "[on 64-bit] "
81#else
82#define NVM_ONARCH    "[on 32-bit] "
83#endif
84#endif
85
86#ifdef __INTEL_COMPILER
87#define NVM_COMPILEDBY  "[ICC %d]", __INTEL_COMPILER
88#elif  _MSC_VER
89#define NVM_COMPILEDBY  "[VS %d]", _MSC_VER
90#endif
91
92#ifndef NVM_COMPILEDBY
93#define NVM_COMPILEDBY "[Unk-CXX]"
94#endif
95
96#ifdef _WIN32
97#define NVM_ONOS        "[Windows]"
98#elif  __linux
99#define NVM_ONOS        "[Linux]"
100#elif  __CYGWIN__
101#define NVM_ONOS        "[Cygwin]"
102#elif __APPLE__
103#define NVM_ONOS        "[Mac OS X]"
104#else
105#define NVM_ONOS "[Unk-OS]"
106#endif
107
108#define NVM_BITS          "[%d bit] ", (sizeof(Void*) == 8 ? 64 : 32) ///< used for checking 64-bit O/S
109
110#ifndef NULL
111#define NULL              0
112#endif
113
114// ====================================================================================================================
115// Common constants
116// ====================================================================================================================
117
118#define _SUMMARY_OUT_               0           ///< print-out PSNR results of all slices to summary.txt
119#define _SUMMARY_PIC_               0           ///< print-out PSNR results for each slice type to summary.txt
120
121#define MAX_GOP                     64          ///< max. value of hierarchical GOP size
122
123#define MAX_NUM_REF_PICS            16          ///< max. number of pictures used for reference
124#define MAX_NUM_REF                 16          ///< max. number of entries in picture reference list
125
126#define MAX_UINT                    0xFFFFFFFFU ///< max. value of unsigned 32-bit integer
127#define MAX_INT                     2147483647  ///< max. value of signed 32-bit integer
128#define MAX_INT64                   0x7FFFFFFFFFFFFFFFLL  ///< max. value of signed 64-bit integer
129#if RExt__HIGH_BIT_DEPTH_SUPPORT
130#define MAX_INTERMEDIATE_INT        MAX_INT64
131#else
132#define MAX_INTERMEDIATE_INT        MAX_INT
133#endif
134
135#define MAX_DOUBLE                  1.7e+308    ///< max. value of Double-type value
136
137#define MIN_QP                      0
138#define MAX_QP                      51
139
140#define NOT_VALID                   -1
141
142// ====================================================================================================================
143// Macro functions
144// ====================================================================================================================
145
146extern Int g_bitDepth[MAX_NUM_CHANNEL_TYPE];
147
148#if SVC_EXTENSION
149extern Int  g_bitDepthLayer[MAX_NUM_CHANNEL_TYPE][MAX_LAYERS];
150extern void* g_refWeightACDCParam; //type:wpACDCParam
151#endif
152
153template <typename T> inline T Clip3 (const T minVal, const T maxVal, const T a) { return std::min<T> (std::max<T> (minVal, a) , maxVal); }  ///< general min/max clip
154template <typename T> inline T ClipBD(const T x, const Int bitDepth)             { return Clip3(T(0), T((1 << bitDepth)-1), x);           }
155template <typename T> inline T Clip  (const T x, const ChannelType type)         { return ClipBD(x, g_bitDepth[type]);                    }
156
157template <typename T> inline Void Check3( T minVal, T maxVal, T a)
158{
159  if ((a > maxVal) || (a < minVal))
160  {
161    std::cerr << "ERROR: Range check " << minVal << " >= " << a << " <= " << maxVal << " failed" << std::endl;
162    assert(false);
163    exit(1);
164  }
165}  ///< general min/max clip
166
167#define DATA_ALIGN                  1                                                                 ///< use 32-bit aligned malloc/free
168#if     DATA_ALIGN && _WIN32 && ( _MSC_VER > 1300 )
169#define xMalloc( type, len )        _aligned_malloc( sizeof(type)*(len), 32 )
170#define xFree( ptr )                _aligned_free  ( ptr )
171#else
172#define xMalloc( type, len )        malloc   ( sizeof(type)*(len) )
173#define xFree( ptr )                free     ( ptr )
174#endif
175
176#define FATAL_ERROR_0(MESSAGE, EXITCODE)                      \
177{                                                             \
178  printf(MESSAGE);                                            \
179  exit(EXITCODE);                                             \
180}
181
182template <typename ValueType> inline ValueType leftShift       (const ValueType value, const Int shift) { return (shift >= 0) ? ( value                                  << shift) : ( value                                   >> -shift); }
183template <typename ValueType> inline ValueType rightShift      (const ValueType value, const Int shift) { return (shift >= 0) ? ( value                                  >> shift) : ( value                                   << -shift); }
184template <typename ValueType> inline ValueType leftShift_round (const ValueType value, const Int shift) { return (shift >= 0) ? ( value                                  << shift) : ((value + (ValueType(1) << (-shift - 1))) >> -shift); }
185template <typename ValueType> inline ValueType rightShift_round(const ValueType value, const Int shift) { return (shift >= 0) ? ((value + (ValueType(1) << (shift - 1))) >> shift) : ( value                                   << -shift); }
186#if O0043_BEST_EFFORT_DECODING
187// when shift = 0, returns value
188// when shift = 1, (value + 0 + value[1]) >> 1
189// when shift = 2, (value + 1 + value[2]) >> 2
190// when shift = 3, (value + 3 + value[3]) >> 3
191template <typename ValueType> inline ValueType rightShiftEvenRounding(const ValueType value, const UInt shift) { return (shift == 0) ? value : ((value + (1<<(shift-1))-1 + ((value>>shift)&1)) >> shift) ; }
192#endif
193
194// ====================================================================================================================
195// Coding tool configuration
196// ====================================================================================================================
197
198// AMVP: advanced motion vector prediction
199#define AMVP_MAX_NUM_CANDS          2           ///< max number of final candidates
200#define AMVP_MAX_NUM_CANDS_MEM      3           ///< max number of candidates
201// MERGE
202#define MRG_MAX_NUM_CANDS           5
203
204// Reference memory management
205#define DYN_REF_FREE                0           ///< dynamic free of reference memories
206
207// Explicit temporal layer QP offset
208#define MAX_TLAYER                  7           ///< max number of temporal layer
209#define HB_LAMBDA_FOR_LDC           1           ///< use of B-style lambda for non-key pictures in low-delay mode
210
211// Fast estimation of generalized B in low-delay mode
212#define GPB_SIMPLE                  1           ///< Simple GPB mode
213#if     GPB_SIMPLE
214#define GPB_SIMPLE_UNI              1           ///< Simple mode for uni-direction
215#endif
216
217// Fast ME using smoother MV assumption
218#define FASTME_SMOOTHER_MV          1           ///< reduce ME time using faster option
219
220// Adaptive search range depending on POC difference
221#define ADAPT_SR_SCALE              1           ///< division factor for adaptive search range
222
223#define CLIP_TO_709_RANGE           0
224
225// Early-skip threshold (encoder)
226#define EARLY_SKIP_THRES            1.50        ///< if RD < thres*avg[BestSkipRD]
227
228
229#define MAX_CHROMA_FORMAT_IDC      3
230
231// TODO: Existing names used for the different NAL unit types can be altered to better reflect the names in the spec.
232//       However, the names in the spec are not yet stable at this point. Once the names are stable, a cleanup
233//       effort can be done without use of macros to alter the names used to indicate the different NAL unit types.
234enum NalUnitType
235{
236  NAL_UNIT_CODED_SLICE_TRAIL_N = 0, // 0
237  NAL_UNIT_CODED_SLICE_TRAIL_R,     // 1
238
239  NAL_UNIT_CODED_SLICE_TSA_N,       // 2
240  NAL_UNIT_CODED_SLICE_TSA_R,       // 3
241
242  NAL_UNIT_CODED_SLICE_STSA_N,      // 4
243  NAL_UNIT_CODED_SLICE_STSA_R,      // 5
244
245  NAL_UNIT_CODED_SLICE_RADL_N,      // 6
246  NAL_UNIT_CODED_SLICE_RADL_R,      // 7
247
248  NAL_UNIT_CODED_SLICE_RASL_N,      // 8
249  NAL_UNIT_CODED_SLICE_RASL_R,      // 9
250
251  NAL_UNIT_RESERVED_VCL_N10,
252  NAL_UNIT_RESERVED_VCL_R11,
253  NAL_UNIT_RESERVED_VCL_N12,
254  NAL_UNIT_RESERVED_VCL_R13,
255  NAL_UNIT_RESERVED_VCL_N14,
256  NAL_UNIT_RESERVED_VCL_R15,
257
258  NAL_UNIT_CODED_SLICE_BLA_W_LP,    // 16
259  NAL_UNIT_CODED_SLICE_BLA_W_RADL,  // 17
260  NAL_UNIT_CODED_SLICE_BLA_N_LP,    // 18
261  NAL_UNIT_CODED_SLICE_IDR_W_RADL,  // 19
262  NAL_UNIT_CODED_SLICE_IDR_N_LP,    // 20
263  NAL_UNIT_CODED_SLICE_CRA,         // 21
264  NAL_UNIT_RESERVED_IRAP_VCL22,
265  NAL_UNIT_RESERVED_IRAP_VCL23,
266
267  NAL_UNIT_RESERVED_VCL24,
268  NAL_UNIT_RESERVED_VCL25,
269  NAL_UNIT_RESERVED_VCL26,
270  NAL_UNIT_RESERVED_VCL27,
271  NAL_UNIT_RESERVED_VCL28,
272  NAL_UNIT_RESERVED_VCL29,
273  NAL_UNIT_RESERVED_VCL30,
274  NAL_UNIT_RESERVED_VCL31,
275
276  NAL_UNIT_VPS,                     // 32
277  NAL_UNIT_SPS,                     // 33
278  NAL_UNIT_PPS,                     // 34
279  NAL_UNIT_ACCESS_UNIT_DELIMITER,   // 35
280  NAL_UNIT_EOS,                     // 36
281  NAL_UNIT_EOB,                     // 37
282  NAL_UNIT_FILLER_DATA,             // 38
283  NAL_UNIT_PREFIX_SEI,              // 39
284  NAL_UNIT_SUFFIX_SEI,              // 40
285
286  NAL_UNIT_RESERVED_NVCL41,
287  NAL_UNIT_RESERVED_NVCL42,
288  NAL_UNIT_RESERVED_NVCL43,
289  NAL_UNIT_RESERVED_NVCL44,
290  NAL_UNIT_RESERVED_NVCL45,
291  NAL_UNIT_RESERVED_NVCL46,
292  NAL_UNIT_RESERVED_NVCL47,
293  NAL_UNIT_UNSPECIFIED_48,
294  NAL_UNIT_UNSPECIFIED_49,
295  NAL_UNIT_UNSPECIFIED_50,
296  NAL_UNIT_UNSPECIFIED_51,
297  NAL_UNIT_UNSPECIFIED_52,
298  NAL_UNIT_UNSPECIFIED_53,
299  NAL_UNIT_UNSPECIFIED_54,
300  NAL_UNIT_UNSPECIFIED_55,
301  NAL_UNIT_UNSPECIFIED_56,
302  NAL_UNIT_UNSPECIFIED_57,
303  NAL_UNIT_UNSPECIFIED_58,
304  NAL_UNIT_UNSPECIFIED_59,
305  NAL_UNIT_UNSPECIFIED_60,
306  NAL_UNIT_UNSPECIFIED_61,
307  NAL_UNIT_UNSPECIFIED_62,
308  NAL_UNIT_UNSPECIFIED_63,
309  NAL_UNIT_INVALID,
310};
311
312#if SVC_EXTENSION
313class CommonDecoderParams
314{
315  Int m_targetLayerId;
316  Int m_targetOutputLayerSetIdx;
317  std::vector<Int> *m_targetDecLayerIdSet;
318  Bool m_valueCheckedFlag;
319  Int m_highestTId;
320public:
321  CommonDecoderParams():
322#if CONFORMANCE_BITSTREAM_MODE
323    m_targetLayerId(MAX_VPS_LAYER_IDX_PLUS1)
324#else
325    m_targetLayerId(0)
326#endif
327    , m_targetOutputLayerSetIdx(-1)
328    , m_targetDecLayerIdSet(NULL)
329    , m_valueCheckedFlag(false)
330    , m_highestTId(6)
331 {}
332
333  Void setTargetLayerId(const Int x) { m_targetLayerId = x;   }
334  Int  getTargetLayerId()            { return m_targetLayerId;}
335 
336  Void setTargetOutputLayerSetIdx(const Int x) { m_targetOutputLayerSetIdx = x;   }
337  Int  getTargetOutputLayerSetIdx()            { return m_targetOutputLayerSetIdx;}
338
339  Void               setTargetDecLayerIdSet(std::vector<Int> *x) { m_targetDecLayerIdSet = x;   }
340  std::vector<Int>*  getTargetDecLayerIdSet()                    { return m_targetDecLayerIdSet;}
341 
342  Void setValueCheckedFlag(const Bool x) { m_valueCheckedFlag = x;   }
343  Bool getValueCheckedFlag()            { return m_valueCheckedFlag;}
344 
345  Void setHighestTId(const Int x) { m_highestTId = x; }
346  Int  getHighestTId()            { return m_highestTId; }
347};
348#endif
349//! \}
350
351#endif // end of #ifndef  __COMMONDEF__
352
Note: See TracBrowser for help on using the repository browser.