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.
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.
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
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.
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.
41 @brief Implementation of operations on integers (INT)
43 The functions in OPJ_INTMATH.H have for goal to realize operations on integers.
46 /** @defgroup OPJ_INTMATH OPJ_INTMATH - Implementation of operations on integers */
49 /** @name Exported functions (see also openjpeg.h) */
51 /* ----------------------------------------------------------------------- */
53 Get the minimum of two integers
54 @return Returns a if a < b else b
56 static INLINE OPJ_INT32 opj_int_min(OPJ_INT32 a, OPJ_INT32 b)
62 Get the minimum of two integers
63 @return Returns a if a < b else b
65 static INLINE OPJ_UINT32 opj_uint_min(OPJ_UINT32 a, OPJ_UINT32 b)
71 Get the maximum of two integers
72 @return Returns a if a > b else b
74 static INLINE OPJ_INT32 opj_int_max(OPJ_INT32 a, OPJ_INT32 b)
76 return (a > b) ? a : b;
80 Get the maximum of two integers
81 @return Returns a if a > b else b
83 static INLINE OPJ_UINT32 opj_uint_max(OPJ_UINT32 a, OPJ_UINT32 b)
85 return (a > b) ? a : b;
89 Get the saturated sum of two unsigned integers
90 @return Returns saturated sum of a+b
92 static INLINE OPJ_UINT32 opj_uint_adds(OPJ_UINT32 a, OPJ_UINT32 b)
94 OPJ_UINT64 sum = (OPJ_UINT64)a + (OPJ_UINT64)b;
95 return (OPJ_UINT32)(-(OPJ_INT32)(sum >> 32)) | (OPJ_UINT32)sum;
99 Get the saturated difference of two unsigned integers
100 @return Returns saturated sum of a-b
102 static INLINE OPJ_UINT32 opj_uint_subs(OPJ_UINT32 a, OPJ_UINT32 b)
104 return (a >= b) ? a - b : 0;
108 Clamp an integer inside an interval
111 <li>Returns a if (min < a < max)
112 <li>Returns max if (a > max)
113 <li>Returns min if (a < min)
116 static INLINE OPJ_INT32 opj_int_clamp(OPJ_INT32 a, OPJ_INT32 min,
129 Clamp an integer inside an interval
132 <li>Returns a if (min < a < max)
133 <li>Returns max if (a > max)
134 <li>Returns min if (a < min)
137 static INLINE OPJ_INT64 opj_int64_clamp(OPJ_INT64 a, OPJ_INT64 min,
150 @return Get absolute value of integer
152 static INLINE OPJ_INT32 opj_int_abs(OPJ_INT32 a)
154 return a < 0 ? -a : a;
157 Divide an integer and round upwards
158 @return Returns a divided by b
160 static INLINE OPJ_INT32 opj_int_ceildiv(OPJ_INT32 a, OPJ_INT32 b)
163 return (OPJ_INT32)(((OPJ_INT64)a + b - 1) / b);
167 Divide an integer and round upwards
168 @return Returns a divided by b
170 static INLINE OPJ_UINT32 opj_uint_ceildiv(OPJ_UINT32 a, OPJ_UINT32 b)
173 return (OPJ_UINT32)(((OPJ_UINT64)a + b - 1) / b);
177 Divide an integer and round upwards
178 @return Returns a divided by b
180 static INLINE OPJ_UINT32 opj_uint64_ceildiv_res_uint32(OPJ_UINT64 a,
184 return (OPJ_UINT32)((a + b - 1) / b);
188 Divide an integer by a power of 2 and round upwards
189 @return Returns a divided by 2^b
191 static INLINE OPJ_INT32 opj_int_ceildivpow2(OPJ_INT32 a, OPJ_INT32 b)
193 return (OPJ_INT32)((a + ((OPJ_INT64)1 << b) - 1) >> b);
197 Divide a 64bits integer by a power of 2 and round upwards
198 @return Returns a divided by 2^b
200 static INLINE OPJ_INT32 opj_int64_ceildivpow2(OPJ_INT64 a, OPJ_INT32 b)
202 return (OPJ_INT32)((a + ((OPJ_INT64)1 << b) - 1) >> b);
206 Divide an integer by a power of 2 and round upwards
207 @return Returns a divided by 2^b
209 static INLINE OPJ_UINT32 opj_uint_ceildivpow2(OPJ_UINT32 a, OPJ_UINT32 b)
211 return (OPJ_UINT32)((a + ((OPJ_UINT64)1U << b) - 1U) >> b);
215 Divide an integer by a power of 2 and round downwards
216 @return Returns a divided by 2^b
218 static INLINE OPJ_INT32 opj_int_floordivpow2(OPJ_INT32 a, OPJ_INT32 b)
224 Divide an integer by a power of 2 and round downwards
225 @return Returns a divided by 2^b
227 static INLINE OPJ_UINT32 opj_uint_floordivpow2(OPJ_UINT32 a, OPJ_UINT32 b)
233 Get logarithm of an integer and round downwards
234 @return Returns log2(a)
236 static INLINE OPJ_INT32 opj_int_floorlog2(OPJ_INT32 a)
239 for (l = 0; a > 1; l++) {
245 Get logarithm of an integer and round downwards
246 @return Returns log2(a)
248 static INLINE OPJ_UINT32 opj_uint_floorlog2(OPJ_UINT32 a)
251 for (l = 0; a > 1; ++l) {
258 Multiply two fixed-precision rational numbers.
261 @return Returns a * b
263 static INLINE OPJ_INT32 opj_int_fix_mul(OPJ_INT32 a, OPJ_INT32 b)
265 #if defined(_MSC_VER) && (_MSC_VER >= 1400) && !defined(__INTEL_COMPILER) && defined(_M_IX86)
266 OPJ_INT64 temp = __emul(a, b);
268 OPJ_INT64 temp = (OPJ_INT64) a * (OPJ_INT64) b ;
271 assert((temp >> 13) <= (OPJ_INT64)0x7FFFFFFF);
272 assert((temp >> 13) >= (-(OPJ_INT64)0x7FFFFFFF - (OPJ_INT64)1));
273 return (OPJ_INT32)(temp >> 13);
276 static INLINE OPJ_INT32 opj_int_fix_mul_t1(OPJ_INT32 a, OPJ_INT32 b)
278 #if defined(_MSC_VER) && (_MSC_VER >= 1400) && !defined(__INTEL_COMPILER) && defined(_M_IX86)
279 OPJ_INT64 temp = __emul(a, b);
281 OPJ_INT64 temp = (OPJ_INT64) a * (OPJ_INT64) b ;
284 assert((temp >> (13 + 11 - T1_NMSEDEC_FRACBITS)) <= (OPJ_INT64)0x7FFFFFFF);
285 assert((temp >> (13 + 11 - T1_NMSEDEC_FRACBITS)) >= (-(OPJ_INT64)0x7FFFFFFF -
287 return (OPJ_INT32)(temp >> (13 + 11 - T1_NMSEDEC_FRACBITS)) ;
291 Addition two signed integers with a wrap-around behaviour.
292 Assumes complement-to-two signed integers.
295 @return Returns a + b
297 static INLINE OPJ_INT32 opj_int_add_no_overflow(OPJ_INT32 a, OPJ_INT32 b)
301 OPJ_UINT32* upa = (OPJ_UINT32*)pa;
302 OPJ_UINT32* upb = (OPJ_UINT32*)pb;
303 OPJ_UINT32 ures = *upa + *upb;
305 OPJ_INT32* ipres = (OPJ_INT32*)pures;
310 Subtract two signed integers with a wrap-around behaviour.
311 Assumes complement-to-two signed integers.
314 @return Returns a - b
316 static INLINE OPJ_INT32 opj_int_sub_no_overflow(OPJ_INT32 a, OPJ_INT32 b)
320 OPJ_UINT32* upa = (OPJ_UINT32*)pa;
321 OPJ_UINT32* upb = (OPJ_UINT32*)pb;
322 OPJ_UINT32 ures = *upa - *upb;
324 OPJ_INT32* ipres = (OPJ_INT32*)pures;
328 /* ----------------------------------------------------------------------- */
333 #endif /* OPJ_INTMATH_H */