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