src/lib/openjp2/opj_intmath.h

   1 /*
   2  * The copyright in this software is being made available under the 2-clauses
   3  * BSD License, included below. This software may be subject to other third
   4  * party and contributor rights, including patent rights, and no such rights
   5  * are granted under this license.
   6  *
   7  * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
   8  * Copyright (c) 2002-2014, Professor Benoit Macq
   9  * Copyright (c) 2001-2003, David Janssens
  10  * Copyright (c) 2002-2003, Yannick Verschueren
  11  * Copyright (c) 2003-2007, Francois-Olivier Devaux
  12  * Copyright (c) 2003-2014, Antonin Descampe
  13  * Copyright (c) 2005, Herve Drolon, FreeImage Team
  14  * All rights reserved.
  15  *
  16  * Redistribution and use in source and binary forms, with or without
  17  * modification, are permitted provided that the following conditions
  18  * are met:
  19  * 1. Redistributions of source code must retain the above copyright
  20  *    notice, this list of conditions and the following disclaimer.
  21  * 2. Redistributions in binary form must reproduce the above copyright
  22  *    notice, this list of conditions and the following disclaimer in the
  23  *    documentation and/or other materials provided with the distribution.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  */
  37 #ifndef __INT_H
  38 #define __INT_H
  39 /**
  40 @file opj_intmath.h
  41 @brief Implementation of operations on integers (INT)
  42
  43 The functions in OPJ_INTMATH.H have for goal to realize operations on integers.
  44 */
  45
  46 /** @defgroup OPJ_INTMATH OPJ_INTMATH - Implementation of operations on integers */
  47 /*@{*/
  48
  49 /** @name Exported functions (see also openjpeg.h) */
  50 /*@{*/
  51 /* ----------------------------------------------------------------------- */
  52 /**
  53 Get the minimum of two integers
  54 @return Returns a if a < b else b
  55 */
  56 static INLINE OPJ_INT32 opj_int_min(OPJ_INT32 a, OPJ_INT32 b)
  57 {
  58     return a < b ? a : b;
  59 }
  60
  61 /**
  62 Get the minimum of two integers
  63 @return Returns a if a < b else b
  64 */
  65 static INLINE OPJ_UINT32 opj_uint_min(OPJ_UINT32 a, OPJ_UINT32 b)
  66 {
  67     return a < b ? a : b;
  68 }
  69
  70 /**
  71 Get the maximum of two integers
  72 @return Returns a if a > b else b
  73 */
  74 static INLINE OPJ_INT32 opj_int_max(OPJ_INT32 a, OPJ_INT32 b)
  75 {
  76     return (a > b) ? a : b;
  77 }
  78
  79 /**
  80 Get the maximum of two integers
  81 @return Returns a if a > b else b
  82 */
  83 static INLINE OPJ_UINT32 opj_uint_max(OPJ_UINT32  a, OPJ_UINT32  b)
  84 {
  85     return (a > b) ? a : b;
  86 }
  87
  88 /**
  89  Get the saturated sum of two unsigned integers
  90  @return Returns saturated sum of a+b
  91  */
  92 static INLINE OPJ_UINT32 opj_uint_adds(OPJ_UINT32 a, OPJ_UINT32 b)
  93 {
  94     OPJ_UINT64 sum = (OPJ_UINT64)a + (OPJ_UINT64)b;
  95     return (OPJ_UINT32)(-(OPJ_INT32)(sum >> 32)) | (OPJ_UINT32)sum;
  96 }
  97
  98 /**
  99 Clamp an integer inside an interval
 100 @return
 101 <ul>
 102 <li>Returns a if (min < a < max)
 103 <li>Returns max if (a > max)
 104 <li>Returns min if (a < min)
 105 </ul>
 106 */
 107 static INLINE OPJ_INT32 opj_int_clamp(OPJ_INT32 a, OPJ_INT32 min,
 108                                       OPJ_INT32 max)
 109 {
 110     if (a < min) {
 111         return min;
 112     }
 113     if (a > max) {
 114         return max;
 115     }
 116     return a;
 117 }
 118 /**
 119 @return Get absolute value of integer
 120 */
 121 static INLINE OPJ_INT32 opj_int_abs(OPJ_INT32 a)
 122 {
 123     return a < 0 ? -a : a;
 124 }
 125 /**
 126 Divide an integer and round upwards
 127 @return Returns a divided by b
 128 */
 129 static INLINE OPJ_INT32 opj_int_ceildiv(OPJ_INT32 a, OPJ_INT32 b)
 130 {
 131     assert(b);
 132     return (OPJ_INT32)(((OPJ_INT64)a + b - 1) / b);
 133 }
 134
 135 /**
 136 Divide an integer and round upwards
 137 @return Returns a divided by b
 138 */
 139 static INLINE OPJ_UINT32  opj_uint_ceildiv(OPJ_UINT32  a, OPJ_UINT32  b)
 140 {
 141     assert(b);
 142     return (a + b - 1) / b;
 143 }
 144
 145 /**
 146 Divide an integer by a power of 2 and round upwards
 147 @return Returns a divided by 2^b
 148 */
 149 static INLINE OPJ_INT32 opj_int_ceildivpow2(OPJ_INT32 a, OPJ_INT32 b)
 150 {
 151     return (OPJ_INT32)((a + ((OPJ_INT64)1 << b) - 1) >> b);
 152 }
 153
 154 /**
 155  Divide a 64bits integer by a power of 2 and round upwards
 156  @return Returns a divided by 2^b
 157  */
 158 static INLINE OPJ_INT32 opj_int64_ceildivpow2(OPJ_INT64 a, OPJ_INT32 b)
 159 {
 160     return (OPJ_INT32)((a + ((OPJ_INT64)1 << b) - 1) >> b);
 161 }
 162
 163 /**
 164  Divide an integer by a power of 2 and round upwards
 165  @return Returns a divided by 2^b
 166  */
 167 static INLINE OPJ_UINT32 opj_uint_ceildivpow2(OPJ_UINT32 a, OPJ_UINT32 b)
 168 {
 169     return (OPJ_UINT32)((a + ((OPJ_UINT64)1U << b) - 1U) >> b);
 170 }
 171
 172 /**
 173 Divide an integer by a power of 2 and round downwards
 174 @return Returns a divided by 2^b
 175 */
 176 static INLINE OPJ_INT32 opj_int_floordivpow2(OPJ_INT32 a, OPJ_INT32 b)
 177 {
 178     return a >> b;
 179 }
 180 /**
 181 Get logarithm of an integer and round downwards
 182 @return Returns log2(a)
 183 */
 184 static INLINE OPJ_INT32 opj_int_floorlog2(OPJ_INT32 a)
 185 {
 186     OPJ_INT32 l;
 187     for (l = 0; a > 1; l++) {
 188         a >>= 1;
 189     }
 190     return l;
 191 }
 192 /**
 193 Get logarithm of an integer and round downwards
 194 @return Returns log2(a)
 195 */
 196 static INLINE OPJ_UINT32  opj_uint_floorlog2(OPJ_UINT32  a)
 197 {
 198     OPJ_UINT32  l;
 199     for (l = 0; a > 1; ++l) {
 200         a >>= 1;
 201     }
 202     return l;
 203 }
 204
 205 /**
 206 Multiply two fixed-precision rational numbers.
 207 @param a
 208 @param b
 209 @return Returns a * b
 210 */
 211 static INLINE OPJ_INT32 opj_int_fix_mul(OPJ_INT32 a, OPJ_INT32 b)
 212 {
 213 #if defined(_MSC_VER) && (_MSC_VER >= 1400) && !defined(__INTEL_COMPILER) && defined(_M_IX86)
 214     OPJ_INT64 temp = __emul(a, b);
 215 #else
 216     OPJ_INT64 temp = (OPJ_INT64) a * (OPJ_INT64) b ;
 217 #endif
 218     temp += 4096;
 219     assert((temp >> 13) <= (OPJ_INT64)0x7FFFFFFF);
 220     assert((temp >> 13) >= (-(OPJ_INT64)0x7FFFFFFF - (OPJ_INT64)1));
 221     return (OPJ_INT32)(temp >> 13);
 222 }
 223
 224 static INLINE OPJ_INT32 opj_int_fix_mul_t1(OPJ_INT32 a, OPJ_INT32 b)
 225 {
 226 #if defined(_MSC_VER) && (_MSC_VER >= 1400) && !defined(__INTEL_COMPILER) && defined(_M_IX86)
 227     OPJ_INT64 temp = __emul(a, b);
 228 #else
 229     OPJ_INT64 temp = (OPJ_INT64) a * (OPJ_INT64) b ;
 230 #endif
 231     temp += 4096;
 232     assert((temp >> (13 + 11 - T1_NMSEDEC_FRACBITS)) <= (OPJ_INT64)0x7FFFFFFF);
 233     assert((temp >> (13 + 11 - T1_NMSEDEC_FRACBITS)) >= (-(OPJ_INT64)0x7FFFFFFF -
 234             (OPJ_INT64)1));
 235     return (OPJ_INT32)(temp >> (13 + 11 - T1_NMSEDEC_FRACBITS)) ;
 236 }
 237
 238 /* ----------------------------------------------------------------------- */
 239 /*@}*/
 240
 241 /*@}*/
 242
 243 #endif