michael@0: /* Copyright (C) 2003 Jean-Marc Valin */
michael@0: /**
michael@0:    @file fixed_generic.h
michael@0:    @brief Generic fixed-point operations
michael@0: */
michael@0: /*
michael@0:    Redistribution and use in source and binary forms, with or without
michael@0:    modification, are permitted provided that the following conditions
michael@0:    are met:
michael@0:    
michael@0:    - Redistributions of source code must retain the above copyright
michael@0:    notice, this list of conditions and the following disclaimer.
michael@0:    
michael@0:    - Redistributions in binary form must reproduce the above copyright
michael@0:    notice, this list of conditions and the following disclaimer in the
michael@0:    documentation and/or other materials provided with the distribution.
michael@0:    
michael@0:    - Neither the name of the Xiph.org Foundation nor the names of its
michael@0:    contributors may be used to endorse or promote products derived from
michael@0:    this software without specific prior written permission.
michael@0:    
michael@0:    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
michael@0:    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0: */
michael@0: 
michael@0: #ifndef FIXED_GENERIC_H
michael@0: #define FIXED_GENERIC_H
michael@0: 
michael@0: #define QCONST16(x,bits) ((spx_word16_t)(.5+(x)*(((spx_word32_t)1)<<(bits))))
michael@0: #define QCONST32(x,bits) ((spx_word32_t)(.5+(x)*(((spx_word32_t)1)<<(bits))))
michael@0: 
michael@0: #define NEG16(x) (-(x))
michael@0: #define NEG32(x) (-(x))
michael@0: #define EXTRACT16(x) ((spx_word16_t)(x))
michael@0: #define EXTEND32(x) ((spx_word32_t)(x))
michael@0: #define SHR16(a,shift) ((a) >> (shift))
michael@0: #define SHL16(a,shift) ((a) << (shift))
michael@0: #define SHR32(a,shift) ((a) >> (shift))
michael@0: #define SHL32(a,shift) ((a) << (shift))
michael@0: #define PSHR16(a,shift) (SHR16((a)+((1<<((shift))>>1)),shift))
michael@0: #define PSHR32(a,shift) (SHR32((a)+((EXTEND32(1)<<((shift))>>1)),shift))
michael@0: #define VSHR32(a, shift) (((shift)>0) ? SHR32(a, shift) : SHL32(a, -(shift)))
michael@0: #define SATURATE16(x,a) (((x)>(a) ? (a) : (x)<-(a) ? -(a) : (x)))
michael@0: #define SATURATE32(x,a) (((x)>(a) ? (a) : (x)<-(a) ? -(a) : (x)))
michael@0: 
michael@0: #define SHR(a,shift) ((a) >> (shift))
michael@0: #define SHL(a,shift) ((spx_word32_t)(a) << (shift))
michael@0: #define PSHR(a,shift) (SHR((a)+((EXTEND32(1)<<((shift))>>1)),shift))
michael@0: #define SATURATE(x,a) (((x)>(a) ? (a) : (x)<-(a) ? -(a) : (x)))
michael@0: 
michael@0: 
michael@0: #define ADD16(a,b) ((spx_word16_t)((spx_word16_t)(a)+(spx_word16_t)(b)))
michael@0: #define SUB16(a,b) ((spx_word16_t)(a)-(spx_word16_t)(b))
michael@0: #define ADD32(a,b) ((spx_word32_t)(a)+(spx_word32_t)(b))
michael@0: #define SUB32(a,b) ((spx_word32_t)(a)-(spx_word32_t)(b))
michael@0: 
michael@0: 
michael@0: /* result fits in 16 bits */
michael@0: #define MULT16_16_16(a,b)     ((((spx_word16_t)(a))*((spx_word16_t)(b))))
michael@0: 
michael@0: /* (spx_word32_t)(spx_word16_t) gives TI compiler a hint that it's 16x16->32 multiply */
michael@0: #define MULT16_16(a,b)     (((spx_word32_t)(spx_word16_t)(a))*((spx_word32_t)(spx_word16_t)(b)))
michael@0: 
michael@0: #define MAC16_16(c,a,b) (ADD32((c),MULT16_16((a),(b))))
michael@0: #define MULT16_32_Q12(a,b) ADD32(MULT16_16((a),SHR((b),12)), SHR(MULT16_16((a),((b)&0x00000fff)),12))
michael@0: #define MULT16_32_Q13(a,b) ADD32(MULT16_16((a),SHR((b),13)), SHR(MULT16_16((a),((b)&0x00001fff)),13))
michael@0: #define MULT16_32_Q14(a,b) ADD32(MULT16_16((a),SHR((b),14)), SHR(MULT16_16((a),((b)&0x00003fff)),14))
michael@0: 
michael@0: #define MULT16_32_Q11(a,b) ADD32(MULT16_16((a),SHR((b),11)), SHR(MULT16_16((a),((b)&0x000007ff)),11))
michael@0: #define MAC16_32_Q11(c,a,b) ADD32(c,ADD32(MULT16_16((a),SHR((b),11)), SHR(MULT16_16((a),((b)&0x000007ff)),11)))
michael@0: 
michael@0: #define MULT16_32_P15(a,b) ADD32(MULT16_16((a),SHR((b),15)), PSHR(MULT16_16((a),((b)&0x00007fff)),15))
michael@0: #define MULT16_32_Q15(a,b) ADD32(MULT16_16((a),SHR((b),15)), SHR(MULT16_16((a),((b)&0x00007fff)),15))
michael@0: #define MAC16_32_Q15(c,a,b) ADD32(c,ADD32(MULT16_16((a),SHR((b),15)), SHR(MULT16_16((a),((b)&0x00007fff)),15)))
michael@0: 
michael@0: 
michael@0: #define MAC16_16_Q11(c,a,b)     (ADD32((c),SHR(MULT16_16((a),(b)),11)))
michael@0: #define MAC16_16_Q13(c,a,b)     (ADD32((c),SHR(MULT16_16((a),(b)),13)))
michael@0: #define MAC16_16_P13(c,a,b)     (ADD32((c),SHR(ADD32(4096,MULT16_16((a),(b))),13)))
michael@0: 
michael@0: #define MULT16_16_Q11_32(a,b) (SHR(MULT16_16((a),(b)),11))
michael@0: #define MULT16_16_Q13(a,b) (SHR(MULT16_16((a),(b)),13))
michael@0: #define MULT16_16_Q14(a,b) (SHR(MULT16_16((a),(b)),14))
michael@0: #define MULT16_16_Q15(a,b) (SHR(MULT16_16((a),(b)),15))
michael@0: 
michael@0: #define MULT16_16_P13(a,b) (SHR(ADD32(4096,MULT16_16((a),(b))),13))
michael@0: #define MULT16_16_P14(a,b) (SHR(ADD32(8192,MULT16_16((a),(b))),14))
michael@0: #define MULT16_16_P15(a,b) (SHR(ADD32(16384,MULT16_16((a),(b))),15))
michael@0: 
michael@0: #define MUL_16_32_R15(a,bh,bl) ADD32(MULT16_16((a),(bh)), SHR(MULT16_16((a),(bl)),15))
michael@0: 
michael@0: #define DIV32_16(a,b) ((spx_word16_t)(((spx_word32_t)(a))/((spx_word16_t)(b))))
michael@0: #define PDIV32_16(a,b) ((spx_word16_t)(((spx_word32_t)(a)+((spx_word16_t)(b)>>1))/((spx_word16_t)(b))))
michael@0: #define DIV32(a,b) (((spx_word32_t)(a))/((spx_word32_t)(b)))
michael@0: #define PDIV32(a,b) (((spx_word32_t)(a)+((spx_word16_t)(b)>>1))/((spx_word32_t)(b)))
michael@0: 
michael@0: #endif