[5] | 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 |
---|
[56] | 4 | * granted under this license. |
---|
[5] | 5 | * |
---|
[608] | 6 | * Copyright (c) 2010-2013, ITU/ISO/IEC |
---|
[5] | 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. |
---|
[56] | 17 | * * Neither the name of the ITU/ISO/IEC nor the names of its contributors may |
---|
[5] | 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 | */ |
---|
[2] | 33 | |
---|
| 34 | /** \file CommonDef.h |
---|
| 35 | \brief Defines constants, macros and tool parameters |
---|
| 36 | */ |
---|
| 37 | |
---|
| 38 | #ifndef __COMMONDEF__ |
---|
| 39 | #define __COMMONDEF__ |
---|
| 40 | |
---|
[56] | 41 | #include <algorithm> |
---|
| 42 | |
---|
[2] | 43 | #if _MSC_VER > 1000 |
---|
[56] | 44 | // disable "signed and unsigned mismatch" |
---|
[2] | 45 | #pragma warning( disable : 4018 ) |
---|
[56] | 46 | // disable bool coercion "performance warning" |
---|
| 47 | #pragma warning( disable : 4800 ) |
---|
[2] | 48 | #endif // _MSC_VER > 1000 |
---|
| 49 | #include "TypeDef.h" |
---|
[622] | 50 | #if H_MV |
---|
| 51 | #include <assert.h> |
---|
| 52 | #endif |
---|
[2] | 53 | |
---|
[56] | 54 | //! \ingroup TLibCommon |
---|
| 55 | //! \{ |
---|
[2] | 56 | |
---|
| 57 | // ==================================================================================================================== |
---|
| 58 | // Version information |
---|
| 59 | // ==================================================================================================================== |
---|
| 60 | |
---|
[608] | 61 | #if H_MV |
---|
[759] | 62 | #define NV_VERSION "9.2" ///< Current software version |
---|
[655] | 63 | #define HM_VERSION "12.0" ///< |
---|
[608] | 64 | #else |
---|
[655] | 65 | #define NV_VERSION "12.0" ///< Current software version |
---|
[608] | 66 | #endif |
---|
[2] | 67 | |
---|
| 68 | // ==================================================================================================================== |
---|
| 69 | // Platform information |
---|
| 70 | // ==================================================================================================================== |
---|
| 71 | |
---|
| 72 | #ifdef __GNUC__ |
---|
| 73 | #define NVM_COMPILEDBY "[GCC %d.%d.%d]", __GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__ |
---|
| 74 | #ifdef __IA64__ |
---|
| 75 | #define NVM_ONARCH "[on 64-bit] " |
---|
| 76 | #else |
---|
| 77 | #define NVM_ONARCH "[on 32-bit] " |
---|
| 78 | #endif |
---|
| 79 | #endif |
---|
| 80 | |
---|
| 81 | #ifdef __INTEL_COMPILER |
---|
| 82 | #define NVM_COMPILEDBY "[ICC %d]", __INTEL_COMPILER |
---|
| 83 | #elif _MSC_VER |
---|
| 84 | #define NVM_COMPILEDBY "[VS %d]", _MSC_VER |
---|
| 85 | #endif |
---|
| 86 | |
---|
| 87 | #ifndef NVM_COMPILEDBY |
---|
| 88 | #define NVM_COMPILEDBY "[Unk-CXX]" |
---|
| 89 | #endif |
---|
| 90 | |
---|
| 91 | #ifdef _WIN32 |
---|
| 92 | #define NVM_ONOS "[Windows]" |
---|
| 93 | #elif __linux |
---|
| 94 | #define NVM_ONOS "[Linux]" |
---|
| 95 | #elif __CYGWIN__ |
---|
| 96 | #define NVM_ONOS "[Cygwin]" |
---|
| 97 | #elif __APPLE__ |
---|
| 98 | #define NVM_ONOS "[Mac OS X]" |
---|
| 99 | #else |
---|
| 100 | #define NVM_ONOS "[Unk-OS]" |
---|
| 101 | #endif |
---|
| 102 | |
---|
| 103 | #define NVM_BITS "[%d bit] ", (sizeof(void*) == 8 ? 64 : 32) ///< used for checking 64-bit O/S |
---|
| 104 | |
---|
| 105 | #ifndef NULL |
---|
| 106 | #define NULL 0 |
---|
| 107 | #endif |
---|
| 108 | |
---|
| 109 | // ==================================================================================================================== |
---|
| 110 | // Common constants |
---|
| 111 | // ==================================================================================================================== |
---|
| 112 | |
---|
| 113 | #define _SUMMARY_OUT_ 0 ///< print-out PSNR results of all slices to summary.txt |
---|
| 114 | #define _SUMMARY_PIC_ 0 ///< print-out PSNR results for each slice type to summary.txt |
---|
| 115 | |
---|
| 116 | #define MAX_GOP 64 ///< max. value of hierarchical GOP size |
---|
| 117 | |
---|
[608] | 118 | #define MAX_NUM_REF_PICS 16 ///< max. number of pictures used for reference |
---|
| 119 | #define MAX_NUM_REF 16 ///< max. number of entries in picture reference list |
---|
[2] | 120 | |
---|
| 121 | #define MAX_UINT 0xFFFFFFFFU ///< max. value of unsigned 32-bit integer |
---|
| 122 | #define MAX_INT 2147483647 ///< max. value of signed 32-bit integer |
---|
| 123 | #define MIN_INT (-2147483647-1) // < min. value of signed 32-bit integer |
---|
[738] | 124 | |
---|
[608] | 125 | #define MAX_INT64 0x7FFFFFFFFFFFFFFFLL ///< max. value of signed 64-bit integer |
---|
[2] | 126 | #define MAX_DOUBLE 1.7e+308 ///< max. value of double-type value |
---|
| 127 | |
---|
| 128 | #define MIN_QP 0 |
---|
| 129 | #define MAX_QP 51 |
---|
| 130 | |
---|
| 131 | #define NOT_VALID -1 |
---|
| 132 | |
---|
[56] | 133 | // ==================================================================================================================== |
---|
[2] | 134 | // Macro functions |
---|
| 135 | // ==================================================================================================================== |
---|
[608] | 136 | extern Int g_bitDepthY; |
---|
| 137 | extern Int g_bitDepthC; |
---|
[2] | 138 | |
---|
[608] | 139 | /** clip x, such that 0 <= x <= #g_maxLumaVal */ |
---|
| 140 | template <typename T> inline T ClipY(T x) { return std::min<T>(T((1 << g_bitDepthY)-1), std::max<T>( T(0), x)); } |
---|
| 141 | template <typename T> inline T ClipC(T x) { return std::min<T>(T((1 << g_bitDepthC)-1), std::max<T>( T(0), x)); } |
---|
[2] | 142 | |
---|
[56] | 143 | /** clip a, such that minVal <= a <= maxVal */ |
---|
| 144 | template <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 |
---|
| 145 | |
---|
[2] | 146 | #define DATA_ALIGN 1 ///< use 32-bit aligned malloc/free |
---|
| 147 | #if DATA_ALIGN && _WIN32 && ( _MSC_VER > 1300 ) |
---|
| 148 | #define xMalloc( type, len ) _aligned_malloc( sizeof(type)*(len), 32 ) |
---|
| 149 | #define xFree( ptr ) _aligned_free ( ptr ) |
---|
| 150 | #else |
---|
| 151 | #define xMalloc( type, len ) malloc ( sizeof(type)*(len) ) |
---|
| 152 | #define xFree( ptr ) free ( ptr ) |
---|
| 153 | #endif |
---|
| 154 | |
---|
| 155 | #define FATAL_ERROR_0(MESSAGE, EXITCODE) \ |
---|
| 156 | { \ |
---|
| 157 | printf(MESSAGE); \ |
---|
| 158 | exit(EXITCODE); \ |
---|
| 159 | } |
---|
| 160 | |
---|
[608] | 161 | #if H_MV |
---|
[2] | 162 | |
---|
| 163 | #define AOF( exp ) \ |
---|
| 164 | { \ |
---|
| 165 | if( !( exp ) ) \ |
---|
[56] | 166 | { \ |
---|
| 167 | assert( 0 ); \ |
---|
| 168 | } \ |
---|
[2] | 169 | } |
---|
| 170 | |
---|
| 171 | #define AOT( exp ) \ |
---|
| 172 | { \ |
---|
| 173 | if( ( exp ) ) \ |
---|
[56] | 174 | { \ |
---|
| 175 | assert( 0 ); \ |
---|
| 176 | } \ |
---|
[2] | 177 | } |
---|
| 178 | |
---|
[56] | 179 | template <typename T> |
---|
| 180 | __inline T gSign(const T& t) |
---|
| 181 | { |
---|
| 182 | if( t == 0 ) |
---|
| 183 | return T(0); |
---|
| 184 | else |
---|
| 185 | return (t < 0) ? T(-1) : T(1); |
---|
| 186 | } |
---|
[2] | 187 | |
---|
[622] | 188 | template <typename T> |
---|
| 189 | __inline T gCeilLog2( T val ) |
---|
| 190 | { |
---|
| 191 | assert( val > 0 ); |
---|
| 192 | Int ceilLog2 = 0; |
---|
| 193 | while( val > ( 1 << ceilLog2 ) ) ceilLog2++; |
---|
| 194 | return ceilLog2; |
---|
| 195 | } |
---|
| 196 | |
---|
[608] | 197 | #define RemoveBitIncrement( exp ) ( exp >> ( g_bitDepthY - 8 ) ) |
---|
[2] | 198 | |
---|
[100] | 199 | #endif |
---|
| 200 | |
---|
[56] | 201 | // ==================================================================================================================== |
---|
| 202 | // Coding tool configuration |
---|
| 203 | // ==================================================================================================================== |
---|
| 204 | |
---|
| 205 | // AMVP: advanced motion vector prediction |
---|
| 206 | #define AMVP_MAX_NUM_CANDS 2 ///< max number of final candidates |
---|
| 207 | #define AMVP_MAX_NUM_CANDS_MEM 3 ///< max number of candidates |
---|
| 208 | // MERGE |
---|
| 209 | #define MRG_MAX_NUM_CANDS 5 |
---|
[608] | 210 | #if H_3D_IV_MERGE |
---|
[56] | 211 | #define MRG_MAX_NUM_CANDS_MEM (MRG_MAX_NUM_CANDS+1) // one extra for inter-view motion prediction |
---|
| 212 | #endif |
---|
| 213 | // Reference memory management |
---|
| 214 | #define DYN_REF_FREE 0 ///< dynamic free of reference memories |
---|
[2] | 215 | |
---|
[56] | 216 | // Explicit temporal layer QP offset |
---|
| 217 | #define MAX_TLAYER 8 ///< max number of temporal layer |
---|
| 218 | #define HB_LAMBDA_FOR_LDC 1 ///< use of B-style lambda for non-key pictures in low-delay mode |
---|
[2] | 219 | |
---|
[56] | 220 | // Fast estimation of generalized B in low-delay mode |
---|
| 221 | #define GPB_SIMPLE 1 ///< Simple GPB mode |
---|
| 222 | #if GPB_SIMPLE |
---|
| 223 | #define GPB_SIMPLE_UNI 1 ///< Simple mode for uni-direction |
---|
| 224 | #endif |
---|
[2] | 225 | |
---|
[56] | 226 | // Fast ME using smoother MV assumption |
---|
| 227 | #define FASTME_SMOOTHER_MV 1 ///< reduce ME time using faster option |
---|
[2] | 228 | |
---|
[56] | 229 | // Adaptive search range depending on POC difference |
---|
| 230 | #define ADAPT_SR_SCALE 1 ///< division factor for adaptive search range |
---|
[2] | 231 | |
---|
[56] | 232 | #define CLIP_TO_709_RANGE 0 |
---|
[2] | 233 | |
---|
[56] | 234 | // Early-skip threshold (encoder) |
---|
| 235 | #define EARLY_SKIP_THRES 1.50 ///< if RD < thres*avg[BestSkipRD] |
---|
| 236 | |
---|
| 237 | |
---|
[608] | 238 | #define MAX_CHROMA_FORMAT_IDC 3 |
---|
[2] | 239 | |
---|
[608] | 240 | // TODO: Existing names used for the different NAL unit types can be altered to better reflect the names in the spec. |
---|
| 241 | // However, the names in the spec are not yet stable at this point. Once the names are stable, a cleanup |
---|
| 242 | // effort can be done without use of macros to alter the names used to indicate the different NAL unit types. |
---|
[56] | 243 | enum NalUnitType |
---|
| 244 | { |
---|
[608] | 245 | NAL_UNIT_CODED_SLICE_TRAIL_N = 0, // 0 |
---|
| 246 | NAL_UNIT_CODED_SLICE_TRAIL_R, // 1 |
---|
| 247 | |
---|
| 248 | NAL_UNIT_CODED_SLICE_TSA_N, // 2 |
---|
| 249 | NAL_UNIT_CODED_SLICE_TLA_R, // 3 |
---|
| 250 | |
---|
| 251 | NAL_UNIT_CODED_SLICE_STSA_N, // 4 |
---|
| 252 | NAL_UNIT_CODED_SLICE_STSA_R, // 5 |
---|
| 253 | |
---|
| 254 | NAL_UNIT_CODED_SLICE_RADL_N, // 6 |
---|
| 255 | NAL_UNIT_CODED_SLICE_RADL_R, // 7 |
---|
| 256 | |
---|
| 257 | NAL_UNIT_CODED_SLICE_RASL_N, // 8 |
---|
| 258 | NAL_UNIT_CODED_SLICE_RASL_R, // 9 |
---|
| 259 | |
---|
| 260 | NAL_UNIT_RESERVED_VCL_N10, |
---|
| 261 | NAL_UNIT_RESERVED_VCL_R11, |
---|
| 262 | NAL_UNIT_RESERVED_VCL_N12, |
---|
| 263 | NAL_UNIT_RESERVED_VCL_R13, |
---|
| 264 | NAL_UNIT_RESERVED_VCL_N14, |
---|
| 265 | NAL_UNIT_RESERVED_VCL_R15, |
---|
| 266 | |
---|
| 267 | NAL_UNIT_CODED_SLICE_BLA_W_LP, // 16 |
---|
| 268 | NAL_UNIT_CODED_SLICE_BLA_W_RADL, // 17 |
---|
| 269 | NAL_UNIT_CODED_SLICE_BLA_N_LP, // 18 |
---|
| 270 | NAL_UNIT_CODED_SLICE_IDR_W_RADL, // 19 |
---|
| 271 | NAL_UNIT_CODED_SLICE_IDR_N_LP, // 20 |
---|
| 272 | NAL_UNIT_CODED_SLICE_CRA, // 21 |
---|
| 273 | NAL_UNIT_RESERVED_IRAP_VCL22, |
---|
| 274 | NAL_UNIT_RESERVED_IRAP_VCL23, |
---|
| 275 | |
---|
| 276 | NAL_UNIT_RESERVED_VCL24, |
---|
| 277 | NAL_UNIT_RESERVED_VCL25, |
---|
| 278 | NAL_UNIT_RESERVED_VCL26, |
---|
| 279 | NAL_UNIT_RESERVED_VCL27, |
---|
| 280 | NAL_UNIT_RESERVED_VCL28, |
---|
| 281 | NAL_UNIT_RESERVED_VCL29, |
---|
| 282 | NAL_UNIT_RESERVED_VCL30, |
---|
| 283 | NAL_UNIT_RESERVED_VCL31, |
---|
| 284 | |
---|
| 285 | NAL_UNIT_VPS, // 32 |
---|
| 286 | NAL_UNIT_SPS, // 33 |
---|
| 287 | NAL_UNIT_PPS, // 34 |
---|
| 288 | NAL_UNIT_ACCESS_UNIT_DELIMITER, // 35 |
---|
| 289 | NAL_UNIT_EOS, // 36 |
---|
| 290 | NAL_UNIT_EOB, // 37 |
---|
| 291 | NAL_UNIT_FILLER_DATA, // 38 |
---|
| 292 | NAL_UNIT_PREFIX_SEI, // 39 |
---|
| 293 | NAL_UNIT_SUFFIX_SEI, // 40 |
---|
| 294 | NAL_UNIT_RESERVED_NVCL41, |
---|
| 295 | NAL_UNIT_RESERVED_NVCL42, |
---|
| 296 | NAL_UNIT_RESERVED_NVCL43, |
---|
| 297 | NAL_UNIT_RESERVED_NVCL44, |
---|
| 298 | NAL_UNIT_RESERVED_NVCL45, |
---|
| 299 | NAL_UNIT_RESERVED_NVCL46, |
---|
| 300 | NAL_UNIT_RESERVED_NVCL47, |
---|
| 301 | NAL_UNIT_UNSPECIFIED_48, |
---|
| 302 | NAL_UNIT_UNSPECIFIED_49, |
---|
| 303 | NAL_UNIT_UNSPECIFIED_50, |
---|
| 304 | NAL_UNIT_UNSPECIFIED_51, |
---|
| 305 | NAL_UNIT_UNSPECIFIED_52, |
---|
| 306 | NAL_UNIT_UNSPECIFIED_53, |
---|
| 307 | NAL_UNIT_UNSPECIFIED_54, |
---|
| 308 | NAL_UNIT_UNSPECIFIED_55, |
---|
| 309 | NAL_UNIT_UNSPECIFIED_56, |
---|
| 310 | NAL_UNIT_UNSPECIFIED_57, |
---|
| 311 | NAL_UNIT_UNSPECIFIED_58, |
---|
| 312 | NAL_UNIT_UNSPECIFIED_59, |
---|
| 313 | NAL_UNIT_UNSPECIFIED_60, |
---|
| 314 | NAL_UNIT_UNSPECIFIED_61, |
---|
| 315 | NAL_UNIT_UNSPECIFIED_62, |
---|
| 316 | NAL_UNIT_UNSPECIFIED_63, |
---|
[56] | 317 | NAL_UNIT_INVALID, |
---|
| 318 | }; |
---|
[2] | 319 | |
---|
[608] | 320 | #if H_3D |
---|
[56] | 321 | //PICYUV |
---|
| 322 | #define PICYUV_PAD 16 |
---|
[2] | 323 | |
---|
[56] | 324 | //RENDERER |
---|
| 325 | #define REN_LUMA_MARGIN ( g_uiMaxCUWidth + PICYUV_PAD ) |
---|
| 326 | #define REN_VDWEIGHT_PREC 8 |
---|
| 327 | #define REN_IS_FILLED ( 1 << REN_VDWEIGHT_PREC ) |
---|
[608] | 328 | #define REN_USED_PEL ( (1 << g_bitDepthY) - 1 ) |
---|
[56] | 329 | #define REN_UNUSED_PEL 0 |
---|
| 330 | #define REN_IS_HOLE 0 |
---|
| 331 | |
---|
| 332 | |
---|
[608] | 333 | // CAMERA PARAMETERS |
---|
| 334 | #define LOG2_DISP_PREC_LUT 2 ///< log2 of disparity precision used in integer disparity LUTs |
---|
| 335 | #define STD_CAM_PARAMETERS_PRECISION 5 ///< quarter luma sample accuarcy for derived disparities (as default) |
---|
[56] | 336 | |
---|
[608] | 337 | #endif // end of H_3D |
---|
[56] | 338 | //! \} |
---|
| 339 | |
---|
[2] | 340 | #endif // end of #ifndef __COMMONDEF__ |
---|
| 341 | |
---|