source: SHVCSoftware/trunk/source/Lib/TLibCommon/CommonDef.h @ 614

Last change on this file since 614 was 595, checked in by seregin, 11 years ago

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