source: SHVCSoftware/branches/HM-10.0-dev-SHM/source/Lib/TLibCommon/CommonDef.h @ 558

Last change on this file since 558 was 54, checked in by seregin, 12 years ago

port simulcast
File size: 10.6 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-2013, 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#define NV_VERSION        "1.2"                 ///< Current software version
59
60// ====================================================================================================================
61// Platform information
62// ====================================================================================================================
63
64#ifdef __GNUC__
65#define NVM_COMPILEDBY  "[GCC %d.%d.%d]", __GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__
66#ifdef __IA64__
67#define NVM_ONARCH    "[on 64-bit] "
68#else
69#define NVM_ONARCH    "[on 32-bit] "
70#endif
71#endif
72
73#ifdef __INTEL_COMPILER
74#define NVM_COMPILEDBY  "[ICC %d]", __INTEL_COMPILER
75#elif  _MSC_VER
76#define NVM_COMPILEDBY  "[VS %d]", _MSC_VER
77#endif
78
79#ifndef NVM_COMPILEDBY
80#define NVM_COMPILEDBY "[Unk-CXX]"
81#endif
82
83#ifdef _WIN32
84#define NVM_ONOS        "[Windows]"
85#elif  __linux
86#define NVM_ONOS        "[Linux]"
87#elif  __CYGWIN__
88#define NVM_ONOS        "[Cygwin]"
89#elif __APPLE__
90#define NVM_ONOS        "[Mac OS X]"
91#else
92#define NVM_ONOS "[Unk-OS]"
93#endif
94
95#define NVM_BITS          "[%d bit] ", (sizeof(void*) == 8 ? 64 : 32) ///< used for checking 64-bit O/S
96
97#ifndef NULL
98#define NULL              0
99#endif
100
101// ====================================================================================================================
102// Common constants
103// ====================================================================================================================
104
105#define _SUMMARY_OUT_               0           ///< print-out PSNR results of all slices to summary.txt
106#define _SUMMARY_PIC_               0           ///< print-out PSNR results for each slice type to summary.txt
107
108#define MAX_GOP                     64          ///< max. value of hierarchical GOP size
109
110#define MAX_NUM_REF_PICS            16          ///< max. number of pictures used for reference
111#define MAX_NUM_REF                 16          ///< max. number of entries in picture reference list
112#define MAX_NUM_REF_LC              MAX_NUM_REF_PICS  // TODO: remove this macro definition (leftover from combined list concept)
113
114#define MAX_UINT                    0xFFFFFFFFU ///< max. value of unsigned 32-bit integer
115#define MAX_INT                     2147483647  ///< max. value of signed 32-bit integer
116#define MAX_INT64                   0x7FFFFFFFFFFFFFFFLL  ///< max. value of signed 64-bit integer
117#define MAX_DOUBLE                  1.7e+308    ///< max. value of double-type value
118
119#define MIN_QP                      0
120#define MAX_QP                      51
121
122#define NOT_VALID                   -1
123
124// ====================================================================================================================
125// Macro functions
126// ====================================================================================================================
127extern Int g_bitDepthY;
128extern Int g_bitDepthC;
129
130/** clip x, such that 0 <= x <= #g_maxLumaVal */
131template <typename T> inline T ClipY(T x) { return std::min<T>(T((1 << g_bitDepthY)-1), std::max<T>( T(0), x)); }
132template <typename T> inline T ClipC(T x) { return std::min<T>(T((1 << g_bitDepthC)-1), std::max<T>( T(0), x)); }
133
134/** clip a, such that minVal <= a <= maxVal */
135template <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
136
137#define DATA_ALIGN                  1                                                                 ///< use 32-bit aligned malloc/free
138#if     DATA_ALIGN && _WIN32 && ( _MSC_VER > 1300 )
139#define xMalloc( type, len )        _aligned_malloc( sizeof(type)*(len), 32 )
140#define xFree( ptr )                _aligned_free  ( ptr )
141#else
142#define xMalloc( type, len )        malloc   ( sizeof(type)*(len) )
143#define xFree( ptr )                free     ( ptr )
144#endif
145
146#define FATAL_ERROR_0(MESSAGE, EXITCODE)                      \
147{                                                             \
148  printf(MESSAGE);                                            \
149  exit(EXITCODE);                                             \
150}
151
152
153// ====================================================================================================================
154// Coding tool configuration
155// ====================================================================================================================
156
157// AMVP: advanced motion vector prediction
158#define AMVP_MAX_NUM_CANDS          2           ///< max number of final candidates
159#define AMVP_MAX_NUM_CANDS_MEM      3           ///< max number of candidates
160// MERGE
161#define MRG_MAX_NUM_CANDS           5
162
163// Reference memory management
164#define DYN_REF_FREE                0           ///< dynamic free of reference memories
165
166// Explicit temporal layer QP offset
167#define MAX_TLAYER                  8           ///< max number of temporal layer
168#define HB_LAMBDA_FOR_LDC           1           ///< use of B-style lambda for non-key pictures in low-delay mode
169
170// Fast estimation of generalized B in low-delay mode
171#define GPB_SIMPLE                  1           ///< Simple GPB mode
172#if     GPB_SIMPLE
173#define GPB_SIMPLE_UNI              1           ///< Simple mode for uni-direction
174#endif
175
176// Fast ME using smoother MV assumption
177#define FASTME_SMOOTHER_MV          1           ///< reduce ME time using faster option
178
179// Adaptive search range depending on POC difference
180#define ADAPT_SR_SCALE              1           ///< division factor for adaptive search range
181
182#define CLIP_TO_709_RANGE           0
183
184// Early-skip threshold (encoder)
185#define EARLY_SKIP_THRES            1.50        ///< if RD < thres*avg[BestSkipRD]
186
187
188#define MAX_CHROMA_FORMAT_IDC      3
189
190// TODO: Existing names used for the different NAL unit types can be altered to better reflect the names in the spec.
191//       However, the names in the spec are not yet stable at this point. Once the names are stable, a cleanup
192//       effort can be done without use of macros to alter the names used to indicate the different NAL unit types.
193enum NalUnitType
194{
195  NAL_UNIT_CODED_SLICE_TRAIL_N = 0,   // 0
196  NAL_UNIT_CODED_SLICE_TRAIL_R,   // 1
197 
198  NAL_UNIT_CODED_SLICE_TSA_N,     // 2
199  NAL_UNIT_CODED_SLICE_TLA,       // 3   // Current name in the spec: TSA_R
200 
201  NAL_UNIT_CODED_SLICE_STSA_N,    // 4
202  NAL_UNIT_CODED_SLICE_STSA_R,    // 5
203
204  NAL_UNIT_CODED_SLICE_RADL_N,    // 6
205  NAL_UNIT_CODED_SLICE_DLP,       // 7 // Current name in the spec: RADL_R
206 
207  NAL_UNIT_CODED_SLICE_RASL_N,    // 8
208  NAL_UNIT_CODED_SLICE_TFD,       // 9 // Current name in the spec: RASL_R
209
210  NAL_UNIT_RESERVED_10,
211  NAL_UNIT_RESERVED_11,
212  NAL_UNIT_RESERVED_12,
213  NAL_UNIT_RESERVED_13,
214  NAL_UNIT_RESERVED_14,
215  NAL_UNIT_RESERVED_15,
216
217  NAL_UNIT_CODED_SLICE_BLA,       // 16   // Current name in the spec: BLA_W_LP
218  NAL_UNIT_CODED_SLICE_BLANT,     // 17   // Current name in the spec: BLA_W_DLP
219  NAL_UNIT_CODED_SLICE_BLA_N_LP,  // 18
220  NAL_UNIT_CODED_SLICE_IDR,       // 19  // Current name in the spec: IDR_W_DLP
221  NAL_UNIT_CODED_SLICE_IDR_N_LP,  // 20
222  NAL_UNIT_CODED_SLICE_CRA,       // 21
223  NAL_UNIT_RESERVED_22,
224  NAL_UNIT_RESERVED_23,
225
226  NAL_UNIT_RESERVED_24,
227  NAL_UNIT_RESERVED_25,
228  NAL_UNIT_RESERVED_26,
229  NAL_UNIT_RESERVED_27,
230  NAL_UNIT_RESERVED_28,
231  NAL_UNIT_RESERVED_29,
232  NAL_UNIT_RESERVED_30,
233  NAL_UNIT_RESERVED_31,
234
235  NAL_UNIT_VPS,                   // 32
236  NAL_UNIT_SPS,                   // 33
237  NAL_UNIT_PPS,                   // 34
238  NAL_UNIT_ACCESS_UNIT_DELIMITER, // 35
239  NAL_UNIT_EOS,                   // 36
240  NAL_UNIT_EOB,                   // 37
241  NAL_UNIT_FILLER_DATA,           // 38
242  NAL_UNIT_SEI,                   // 39 Prefix SEI
243  NAL_UNIT_SEI_SUFFIX,            // 40 Suffix SEI
244  NAL_UNIT_RESERVED_41,
245  NAL_UNIT_RESERVED_42,
246  NAL_UNIT_RESERVED_43,
247  NAL_UNIT_RESERVED_44,
248  NAL_UNIT_RESERVED_45,
249  NAL_UNIT_RESERVED_46,
250  NAL_UNIT_RESERVED_47,
251  NAL_UNIT_UNSPECIFIED_48,
252  NAL_UNIT_UNSPECIFIED_49,
253  NAL_UNIT_UNSPECIFIED_50,
254  NAL_UNIT_UNSPECIFIED_51,
255  NAL_UNIT_UNSPECIFIED_52,
256  NAL_UNIT_UNSPECIFIED_53,
257  NAL_UNIT_UNSPECIFIED_54,
258  NAL_UNIT_UNSPECIFIED_55,
259  NAL_UNIT_UNSPECIFIED_56,
260  NAL_UNIT_UNSPECIFIED_57,
261  NAL_UNIT_UNSPECIFIED_58,
262  NAL_UNIT_UNSPECIFIED_59,
263  NAL_UNIT_UNSPECIFIED_60,
264  NAL_UNIT_UNSPECIFIED_61,
265  NAL_UNIT_UNSPECIFIED_62,
266  NAL_UNIT_UNSPECIFIED_63,
267  NAL_UNIT_INVALID,
268};
269
270//! \}
271
272#endif // end of #ifndef  __COMMONDEF__
273
Note: See TracBrowser for help on using the repository browser.