jpc_fix.h - vx32 - Local 9vx git repository for patches.
 (HTM) git clone git://r-36.net/vx32
 (DIR) Log
 (DIR) Files
 (DIR) Refs
       ---
       jpc_fix.h (6723B)
       ---
            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) 1999-2000 Image Power, Inc.
           13  * Copyright (c) 1999-2000 The University of British Columbia
           14  * Copyright (c) 2001-2003 Michael David Adams
           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: jpc_fix.h 1918 2005-07-24 14:12:08Z baford $
           68  */
           69 
           70 #ifndef JPC_FIX_H
           71 #define JPC_FIX_H
           72 
           73 /******************************************************************************\
           74 * Includes.
           75 \******************************************************************************/
           76 
           77 #include "jasper/jas_types.h"
           78 #include "jasper/jas_fix.h"
           79 
           80 /******************************************************************************\
           81 * Basic parameters of the fixed-point type.
           82 \******************************************************************************/
           83 
           84 /* The integral type used to represent a fixed-point number.  This
           85   type must be capable of representing values from -(2^31) to 2^31-1
           86   (inclusive). */
           87 typedef int32_t jpc_fix_t;
           88 
           89 /* The integral type used to respresent higher-precision intermediate results.
           90   This type should be capable of representing values from -(2^63) to 2^63-1
           91   (inclusive). */
           92 typedef int_fast64_t jpc_fix_big_t;
           93 
           94 /* The number of bits used for the fractional part of a fixed-point number. */
           95 #define JPC_FIX_FRACBITS        13
           96 
           97 /******************************************************************************\
           98 * Instantiations of the generic fixed-point number macros for the
           99 * parameters given above.  (Too bad C does not support templates, eh?)
          100 * The purpose of these macros is self-evident if one examines the
          101 * corresponding macros in the jasper/jas_fix.h header file.
          102 \******************************************************************************/
          103 
          104 #define        JPC_FIX_ZERO        JAS_FIX_ZERO(jpc_fix_t, JPC_FIX_FRACBITS)
          105 #define        JPC_FIX_ONE                JAS_FIX_ONE(jpc_fix_t, JPC_FIX_FRACBITS)
          106 #define        JPC_FIX_HALF        JAS_FIX_HALF(jpc_fix_t, JPC_FIX_FRACBITS)
          107 
          108 #define jpc_inttofix(x)        JAS_INTTOFIX(jpc_fix_t, JPC_FIX_FRACBITS, x)
          109 #define jpc_fixtoint(x)        JAS_FIXTOINT(jpc_fix_t, JPC_FIX_FRACBITS, x)
          110 #define jpc_fixtodbl(x)        JAS_FIXTODBL(jpc_fix_t, JPC_FIX_FRACBITS, x)
          111 #define jpc_dbltofix(x)        JAS_DBLTOFIX(jpc_fix_t, JPC_FIX_FRACBITS, x)
          112 
          113 #define        jpc_fix_add(x, y)        JAS_FIX_ADD(jpc_fix_t, JPC_FIX_FRACBITS, x, y)
          114 #define        jpc_fix_sub(x, y)        JAS_FIX_SUB(jpc_fix_t, JPC_FIX_FRACBITS, x, y)
          115 #define        jpc_fix_mul(x, y) \
          116         JAS_FIX_MUL(jpc_fix_t, JPC_FIX_FRACBITS, jpc_fix_big_t, x, y)
          117 #define        jpc_fix_mulbyint(x, y) \
          118         JAS_FIX_MULBYINT(jpc_fix_t, JPC_FIX_FRACBITS, x, y)
          119 #define        jpc_fix_div(x, y) \
          120         JAS_FIX_DIV(jpc_fix_t, JPC_FIX_FRACBITS, jpc_fix_big_t, x, y)
          121 #define        jpc_fix_neg(x)                JAS_FIX_NEG(jpc_fix_t, JPC_FIX_FRACBITS, x)
          122 #define        jpc_fix_asl(x, n)        JAS_FIX_ASL(jpc_fix_t, JPC_FIX_FRACBITS, x, n)
          123 #define        jpc_fix_asr(x, n)        JAS_FIX_ASR(jpc_fix_t, JPC_FIX_FRACBITS, x, n)
          124 
          125 #define jpc_fix_pluseq(x, y)        JAS_FIX_PLUSEQ(jpc_fix_t, JPC_FIX_FRACBITS, x, y)
          126 #define jpc_fix_minuseq(x, y)        JAS_FIX_MINUSEQ(jpc_fix_t, JPC_FIX_FRACBITS, x, y)
          127 #define        jpc_fix_muleq(x, y)        \
          128         JAS_FIX_MULEQ(jpc_fix_t, JPC_FIX_FRACBITS, jpc_fix_big_t, x, y)
          129 
          130 #define        jpc_fix_abs(x)                JAS_FIX_ABS(jpc_fix_t, JPC_FIX_FRACBITS, x)
          131 #define        jpc_fix_isint(x)        JAS_FIX_ISINT(jpc_fix_t, JPC_FIX_FRACBITS, x)
          132 #define jpc_fix_sgn(x)                JAS_FIX_SGN(jpc_fix_t, JPC_FIX_FRACBITS, x)
          133 #define        jpc_fix_round(x)        JAS_FIX_ROUND(jpc_fix_t, JPC_FIX_FRACBITS, x)
          134 #define        jpc_fix_floor(x)        JAS_FIX_FLOOR(jpc_fix_t, JPC_FIX_FRACBITS, x)
          135 #define jpc_fix_trunc(x)        JAS_FIX_TRUNC(jpc_fix_t, JPC_FIX_FRACBITS, x)
          136 
          137 /******************************************************************************\
          138 * Extra macros for convenience.
          139 \******************************************************************************/
          140 
          141 /* Compute the sum of three fixed-point numbers. */
          142 #define jpc_fix_add3(x, y, z)        jpc_fix_add(jpc_fix_add(x, y), z)
          143 
          144 #endif