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) {
61 Get the minimum of two integers
62 @return Returns a if a < b else b
64 static INLINE OPJ_UINT32 opj_uint_min(OPJ_UINT32 a, OPJ_UINT32 b) {
69 Get the maximum of two integers
70 @return Returns a if a > b else b
72 static INLINE OPJ_INT32 opj_int_max(OPJ_INT32 a, OPJ_INT32 b) {
73 return (a > b) ? a : b;
77 Get the maximum of two integers
78 @return Returns a if a > b else b
80 static INLINE OPJ_UINT32 opj_uint_max(OPJ_UINT32 a, OPJ_UINT32 b) {
81 return (a > b) ? a : b;
85 Clamp an integer inside an interval
88 <li>Returns a if (min < a < max)
89 <li>Returns max if (a > max)
90 <li>Returns min if (a < min)
93 static INLINE OPJ_INT32 opj_int_clamp(OPJ_INT32 a, OPJ_INT32 min, OPJ_INT32 max) {
101 @return Get absolute value of integer
103 static INLINE OPJ_INT32 opj_int_abs(OPJ_INT32 a) {
104 return a < 0 ? -a : a;
107 Divide an integer and round upwards
108 @return Returns a divided by b
110 static INLINE OPJ_INT32 opj_int_ceildiv(OPJ_INT32 a, OPJ_INT32 b) {
112 return (a + b - 1) / b;
116 Divide an integer and round upwards
117 @return Returns a divided by b
119 static INLINE OPJ_UINT32 opj_uint_ceildiv(OPJ_UINT32 a, OPJ_UINT32 b) {
121 return (a + b - 1) / b;
125 Divide an integer by a power of 2 and round upwards
126 @return Returns a divided by 2^b
128 static INLINE OPJ_INT32 opj_int_ceildivpow2(OPJ_INT32 a, OPJ_INT32 b) {
129 return (OPJ_INT32)((a + (OPJ_INT64)(1 << b) - 1) >> b);
132 Divide an integer by a power of 2 and round downwards
133 @return Returns a divided by 2^b
135 static INLINE OPJ_INT32 opj_int_floordivpow2(OPJ_INT32 a, OPJ_INT32 b) {
139 Get logarithm of an integer and round downwards
140 @return Returns log2(a)
142 static INLINE OPJ_INT32 opj_int_floorlog2(OPJ_INT32 a) {
144 for (l = 0; a > 1; l++) {
150 Get logarithm of an integer and round downwards
151 @return Returns log2(a)
153 static INLINE OPJ_UINT32 opj_uint_floorlog2(OPJ_UINT32 a) {
155 for (l = 0; a > 1; ++l)
163 Multiply two fixed-precision rational numbers.
166 @return Returns a * b
168 static INLINE OPJ_INT32 opj_int_fix_mul(OPJ_INT32 a, OPJ_INT32 b) {
169 OPJ_INT64 temp = (OPJ_INT64) a * (OPJ_INT64) b ;
171 assert((temp >> 13) <= (OPJ_INT64)0x7FFFFFFF);
172 assert((temp >> 13) >= (-(OPJ_INT64)0x7FFFFFFF - (OPJ_INT64)1));
173 return (OPJ_INT32) (temp >> 13);
176 static INLINE OPJ_INT32 opj_int_fix_mul_t1(OPJ_INT32 a, OPJ_INT32 b) {
177 OPJ_INT64 temp = (OPJ_INT64) a * (OPJ_INT64) b ;
179 assert((temp >> (13 + 11 - T1_NMSEDEC_FRACBITS)) <= (OPJ_INT64)0x7FFFFFFF);
180 assert((temp >> (13 + 11 - T1_NMSEDEC_FRACBITS)) >= (-(OPJ_INT64)0x7FFFFFFF - (OPJ_INT64)1));
181 return (OPJ_INT32) (temp >> (13 + 11 - T1_NMSEDEC_FRACBITS)) ;
184 /* ----------------------------------------------------------------------- */