JasPer: jpc_fix.h Source File

JasPer 3.0.6 |

jpc_fix.h
1/*
2 * Copyright (c) 1999-2000 Image Power, Inc. and the University of
3 * British Columbia.
4 * Copyright (c) 2001-2002 Michael David Adams.
5 * All rights reserved.
6 */
7
8/* __START_OF_JASPER_LICENSE__
9 *
10 * JasPer License Version 2.0
11 *
12 * Copyright (c) 2001-2006 Michael David Adams
13 * Copyright (c) 1999-2000 Image Power, Inc.
14 * Copyright (c) 1999-2000 The University of British Columbia
15 *
16 * All rights reserved.
17 *
18 * Permission is hereby granted, free of charge, to any person (the
19 * "User") obtaining a copy of this software and associated documentation
20 * files (the "Software"), to deal in the Software without restriction,
21 * including without limitation the rights to use, copy, modify, merge,
22 * publish, distribute, and/or sell copies of the Software, and to permit
23 * persons to whom the Software is furnished to do so, subject to the
24 * following conditions:
25 *
26 * 1. The above copyright notices and this permission notice (which
27 * includes the disclaimer below) shall be included in all copies or
28 * substantial portions of the Software.
29 *
30 * 2. The name of a copyright holder shall not be used to endorse or
31 * promote products derived from the Software without specific prior
32 * written permission.
33 *
34 * THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
35 * LICENSE. NO USE OF THE SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER
36 * THIS DISCLAIMER. THE SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS
37 * "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
38 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
39 * PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO
40 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
41 * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
42 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
43 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
44 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. NO ASSURANCES ARE
45 * PROVIDED BY THE COPYRIGHT HOLDERS THAT THE SOFTWARE DOES NOT INFRINGE
46 * THE PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS OF ANY OTHER ENTITY.
47 * EACH COPYRIGHT HOLDER DISCLAIMS ANY LIABILITY TO THE USER FOR CLAIMS
48 * BROUGHT BY ANY OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL
49 * PROPERTY RIGHTS OR OTHERWISE. AS A CONDITION TO EXERCISING THE RIGHTS
50 * GRANTED HEREUNDER, EACH USER HEREBY ASSUMES SOLE RESPONSIBILITY TO SECURE
51 * ANY OTHER INTELLECTUAL PROPERTY RIGHTS NEEDED, IF ANY. THE SOFTWARE
52 * IS NOT FAULT-TOLERANT AND IS NOT INTENDED FOR USE IN MISSION-CRITICAL
53 * SYSTEMS, SUCH AS THOSE USED IN THE OPERATION OF NUCLEAR FACILITIES,
54 * AIRCRAFT NAVIGATION OR COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL
55 * SYSTEMS, DIRECT LIFE SUPPORT MACHINES, OR WEAPONS SYSTEMS, IN WHICH
56 * THE FAILURE OF THE SOFTWARE OR SYSTEM COULD LEAD DIRECTLY TO DEATH,
57 * PERSONAL INJURY, OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE ("HIGH
58 * RISK ACTIVITIES"). THE COPYRIGHT HOLDERS SPECIFICALLY DISCLAIM ANY
59 * EXPRESS OR IMPLIED WARRANTY OF FITNESS FOR HIGH RISK ACTIVITIES.
60 *
61 * __END_OF_JASPER_LICENSE__
62 */
63
64/*
65 * Fixed-Point Number Class
66 *
67 * $Id$
68 */
69
70#ifndef JPC_FIX_H
71#define JPC_FIX_H
72
73/******************************************************************************\
74* Includes.
75\******************************************************************************/
76
77#include "jasper/jas_config.h"
78#include "jasper/jas_types.h"
79#include "jasper/jas_fix.h"
80#include "jasper/jas_math.h"
81
82/******************************************************************************\
83* Basic parameters of the fixed-point type.
84\******************************************************************************/
85
86/* The integral type used to represent a fixed-point number. This
87 type must be capable of representing values from -(2^31) to 2^31-1
88 (inclusive). */
89#ifdef JAS_ENABLE_32BIT
90typedef int_least32_t jpc_fix_t;
91#else
92typedef int_fast32_t jpc_fix_t;
93#endif
94
95/* The integral type used to respresent higher-precision intermediate results.
96 This type should be capable of representing values from -(2^63) to 2^63-1
97 (inclusive). */
98typedef int_fast64_t jpc_fix_big_t;
99
100/* The number of bits used for the fractional part of a fixed-point number. */
101#define JPC_FIX_FRACBITS 13
102
103/******************************************************************************\
104* Instantiations of the generic fixed-point number macros for the
105* parameters given above. (Too bad C does not support templates, eh?)
106* The purpose of these macros is self-evident if one examines the
107* corresponding macros in the jasper/jas_fix.h header file.
108\******************************************************************************/
109
110#define JPC_FIX_ZERO JAS_FIX_ZERO(jpc_fix_t, JPC_FIX_FRACBITS)
111#define JPC_FIX_ONE JAS_FIX_ONE(jpc_fix_t, JPC_FIX_FRACBITS)
112#define JPC_FIX_HALF JAS_FIX_HALF(jpc_fix_t, JPC_FIX_FRACBITS)
113
114JAS_ATTRIBUTE_CONST
115static inline jpc_fix_t jpc_inttofix(int x)
116{
117 return JAS_INTTOFIX(jpc_fix_t, JPC_FIX_FRACBITS, x);
118}
119
120JAS_ATTRIBUTE_CONST
121static inline int jpc_fixtoint(jpc_fix_t x)
122{
123 return JAS_FIXTOINT(jpc_fix_t, JPC_FIX_FRACBITS, x);
124}
125
126JAS_ATTRIBUTE_CONST
127static inline double jpc_fixtodbl(jpc_fix_t x)
128{
129 return JAS_FIXTODBL(jpc_fix_t, JPC_FIX_FRACBITS, x);
130}
131
132JAS_ATTRIBUTE_CONST
133static inline jpc_fix_t jpc_dbltofix(double x)
134{
135 return JAS_DBLTOFIX(jpc_fix_t, JPC_FIX_FRACBITS, x);
136}
137
138JAS_ATTRIBUTE_CONST
139static inline jpc_fix_t jpc_fix_add(jpc_fix_t x, jpc_fix_t y)
140{
141 return JAS_FIX_ADD(jpc_fix_t, JPC_FIX_FRACBITS, x, y);
142}
143
144JAS_ATTRIBUTE_CONST
145static inline jpc_fix_t jpc_fix_sub(jpc_fix_t x, jpc_fix_t y)
146{
147 return JAS_FIX_SUB(jpc_fix_t, JPC_FIX_FRACBITS, x, y);
148}
149
150JAS_ATTRIBUTE_CONST
151static inline jpc_fix_t jpc_fix_mul(jpc_fix_big_t x, jpc_fix_big_t y)
152{
153 return JAS_FIX_MUL(jpc_fix_t, JPC_FIX_FRACBITS, jpc_fix_big_t, x, y);
154}
155
156JAS_ATTRIBUTE_CONST
157static inline jpc_fix_big_t jpc_fix_mulbyint(jpc_fix_big_t x, int y)
158{
159 return JAS_FIX_MUL(jpc_fix_t, JPC_FIX_FRACBITS, jpc_fix_big_t, x, y);
160}
161
162JAS_ATTRIBUTE_CONST
163static inline jpc_fix_t jpc_fix_div(jpc_fix_big_t x, jpc_fix_t y)
164{
165 return JAS_FIX_DIV(jpc_fix_t, JPC_FIX_FRACBITS, jpc_fix_big_t, x, y);
166}
167
168JAS_ATTRIBUTE_CONST
169static inline jpc_fix_t jpc_fix_neg(jpc_fix_t x)
170{
171 return JAS_FIX_NEG(jpc_fix_t, JPC_FIX_FRACBITS, x);
172}
173
174//#define jpc_fix_asl(x, n) JAS_FIX_ASL(jpc_fix_t, JPC_FIX_FRACBITS, x, n)
175//#define jpc_fix_asr(x, n) JAS_FIX_ASR(jpc_fix_t, JPC_FIX_FRACBITS, x, n)
176
177#ifdef JAS_ENABLE_32BIT
178#define jpc_fix_asl jas_least32_asl
179#define jpc_fix_asr jas_least32_asr
180#else
181#define jpc_fix_asl jas_fast32_asl
182#define jpc_fix_asr jas_fast32_asr
183#endif
184
185#define jpc_fix_pluseq(x, y) JAS_FIX_PLUSEQ(jpc_fix_t, JPC_FIX_FRACBITS, x, y)
186#define jpc_fix_minuseq(x, y) JAS_FIX_MINUSEQ(jpc_fix_t, JPC_FIX_FRACBITS, x, y)
187#define jpc_fix_muleq(x, y) \
188 JAS_FIX_MULEQ(jpc_fix_t, JPC_FIX_FRACBITS, jpc_fix_big_t, x, y)
189
190JAS_ATTRIBUTE_CONST
191static inline jpc_fix_t jpc_fix_abs(jpc_fix_t x)
192{
193 return JAS_FIX_ABS(jpc_fix_t, JPC_FIX_FRACBITS, x);
194}
195
196JAS_ATTRIBUTE_CONST
197static inline bool jpc_fix_isint(jpc_fix_t x)
198{
199 return JAS_FIX_ISINT(jpc_fix_t, JPC_FIX_FRACBITS, x);
200}
201
202JAS_ATTRIBUTE_CONST
203static inline int jpc_fix_sgn(jpc_fix_t x)
204{
205 return JAS_FIX_SGN(jpc_fix_t, JPC_FIX_FRACBITS, x);
206}
207
208JAS_ATTRIBUTE_CONST
209static inline jpc_fix_t jpc_fix_round(jpc_fix_t x)
210{
211 return JAS_FIX_ROUND(jpc_fix_t, JPC_FIX_FRACBITS, x);
212}
213
214JAS_ATTRIBUTE_CONST
215static inline jpc_fix_t jpc_fix_floor(jpc_fix_t x)
216{
217 return JAS_FIX_FLOOR(jpc_fix_t, JPC_FIX_FRACBITS, x);
218}
219
220/******************************************************************************\
221* Extra macros for convenience.
222\******************************************************************************/
223
224/* Compute the sum of three fixed-point numbers. */
225JAS_ATTRIBUTE_CONST
226static inline jpc_fix_t jpc_fix_add3(jpc_fix_t x, jpc_fix_t y, jpc_fix_t z)
227{
228 return jpc_fix_add(jpc_fix_add(x, y), z);
229}
230
231#endif
JAS_INTTOFIX
#define JAS_INTTOFIX(fix_t, fracbits, x)
Definition: jas_fix.h:111
JAS_FIX_SUB
#define JAS_FIX_SUB(fix_t, fracbits, x, y)
Definition: jas_fix.h:266
JAS_FIX_ABS
#define JAS_FIX_ABS(fix_t, fracbits, x)
Definition: jas_fix.h:286
JAS_FIX_SGN
#define JAS_FIX_SGN(fix_t, fracbits, x)
Definition: jas_fix.h:294
JAS_FIX_FLOOR
#define JAS_FIX_FLOOR(fix_t, fracbits, x)
Definition: jas_fix.h:334
JAS_FIXTOINT
#define JAS_FIXTOINT(fix_t, fracbits, x)
Definition: jas_fix.h:115
JAS_FIX_ISINT
#define JAS_FIX_ISINT(fix_t, fracbits, x)
Definition: jas_fix.h:290
JAS_FIX_NEG
#define JAS_FIX_NEG
Definition: jas_fix.h:212
JAS_FIX_ROUND
#define JAS_FIX_ROUND(fix_t, fracbits, x)
Definition: jas_fix.h:326
JAS_FIXTODBL
#define JAS_FIXTODBL(fix_t, fracbits, x)
Definition: jas_fix.h:119
JAS_DBLTOFIX
#define JAS_DBLTOFIX(fix_t, fracbits, x)
Definition: jas_fix.h:123
JAS_FIX_ADD
#define JAS_FIX_ADD
Definition: jas_fix.h:138
JAS_FIX_MUL
#define JAS_FIX_MUL
Definition: jas_fix.h:156
JAS_FIX_DIV
#define JAS_FIX_DIV
Definition: jas_fix.h:195
jas_fix.h
JasPer Fixed-Point Number Class.
jas_math.h
Math-Related Code.
jas_types.h
Primitive Types.