fixed_generic.h (10083B)
1 /* Copyright (C) 2007-2009 Xiph.Org Foundation 2 Copyright (C) 2003-2008 Jean-Marc Valin 3 Copyright (C) 2007-2008 CSIRO */ 4 /** 5 @file fixed_generic.h 6 @brief Generic fixed-point operations 7 */ 8 /* 9 Redistribution and use in source and binary forms, with or without 10 modification, are permitted provided that the following conditions 11 are met: 12 13 - Redistributions of source code must retain the above copyright 14 notice, this list of conditions and the following disclaimer. 15 16 - Redistributions in binary form must reproduce the above copyright 17 notice, this list of conditions and the following disclaimer in the 18 documentation and/or other materials provided with the distribution. 19 20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 23 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 24 OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 26 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 27 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 28 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 29 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 30 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 #ifndef FIXED_GENERIC_H 34 #define FIXED_GENERIC_H 35 36 /** Multiply a 16-bit signed value by a 16-bit unsigned value. The result is a 32-bit signed value */ 37 #define MULT16_16SU(a,b) ((opus_val32)(opus_val16)(a)*(opus_val32)(opus_uint16)(b)) 38 39 /** 16x32 multiplication, followed by a 16-bit shift right. Results fits in 32 bits */ 40 #if OPUS_FAST_INT64 41 #define MULT16_32_Q16(a,b) ((opus_val32)SHR((opus_int64)((opus_val16)(a))*(b),16)) 42 #else 43 #define MULT16_32_Q16(a,b) ADD32(MULT16_16((a),SHR((b),16)), SHR(MULT16_16SU((a),((b)&0x0000ffff)),16)) 44 #endif 45 46 /** 16x32 multiplication, followed by a 16-bit shift right (round-to-nearest). Results fits in 32 bits */ 47 #if OPUS_FAST_INT64 48 #define MULT16_32_P16(a,b) ((opus_val32)PSHR((opus_int64)((opus_val16)(a))*(b),16)) 49 #else 50 #define MULT16_32_P16(a,b) ADD32(MULT16_16((a),SHR((b),16)), PSHR(MULT16_16SU((a),((b)&0x0000ffff)),16)) 51 #endif 52 53 /** 16x32 multiplication, followed by a 15-bit shift right. Results fits in 32 bits */ 54 #if OPUS_FAST_INT64 55 #define MULT16_32_Q15(a,b) ((opus_val32)SHR((opus_int64)((opus_val16)(a))*(b),15)) 56 #else 57 #define MULT16_32_Q15(a,b) ADD32(SHL(MULT16_16((a),SHR((b),16)),1), SHR(MULT16_16SU((a),((b)&0x0000ffff)),15)) 58 #endif 59 60 /** 32x32 multiplication, followed by a 16-bit shift right. Results fits in 32 bits */ 61 #if OPUS_FAST_INT64 62 #define MULT32_32_Q16(a,b) ((opus_val32)SHR((opus_int64)(a)*(opus_int64)(b),16)) 63 #else 64 #define MULT32_32_Q16(a,b) (ADD32(ADD32(ADD32((opus_val32)(SHR32(((opus_uint32)((a)&0x0000ffff)*(opus_uint32)((b)&0x0000ffff)),16)), MULT16_16SU(SHR32(a,16),((b)&0x0000ffff))), MULT16_16SU(SHR32(b,16),((a)&0x0000ffff))), SHL32(MULT16_16(SHR32(a,16),SHR32(b,16)),16))) 65 #endif 66 67 /** 32x32 multiplication, followed by a 31-bit shift right. Results fits in 32 bits */ 68 #if OPUS_FAST_INT64 69 #define MULT32_32_Q31(a,b) ((opus_val32)SHR((opus_int64)(a)*(opus_int64)(b),31)) 70 #else 71 #define MULT32_32_Q31(a,b) ADD32(ADD32(SHL(MULT16_16(SHR((a),16),SHR((b),16)),1), SHR(MULT16_16SU(SHR((a),16),((b)&0x0000ffff)),15)), SHR(MULT16_16SU(SHR((b),16),((a)&0x0000ffff)),15)) 72 #endif 73 74 /** 32x32 multiplication, followed by a 31-bit shift right (with rounding). Results fits in 32 bits */ 75 #if OPUS_FAST_INT64 76 #define MULT32_32_P31(a,b) ((opus_val32)SHR(1073741824+(opus_int64)(a)*(opus_int64)(b),31)) 77 #else 78 #define MULT16_16U(a,b) ((opus_uint32)(a)*(opus_uint32)(b)) 79 #define MULT32_32_P31(a,b) ADD32(SHL(MULT16_16(SHR((a),16),SHR((b),16)),1), SHR32(128+(opus_int32)SHR(MULT16_16U(((a)&0x0000ffff),((b)&0x0000ffff)),16+7) + SHR32(MULT16_16SU(SHR((a),16),((b)&0x0000ffff)),7) + SHR32(MULT16_16SU(SHR((b),16),((a)&0x0000ffff)),7), 8) ) 80 #endif 81 82 /** 32x32 multiplication, followed by a 32-bit shift right. Results fits in 32 bits */ 83 #if OPUS_FAST_INT64 84 #define MULT32_32_Q32(a,b) ((opus_val32)SHR((opus_int64)(a)*(opus_int64)(b),32)) 85 #else 86 #define MULT32_32_Q32(a,b) ADD32(ADD32(MULT16_16(SHR((a),16),SHR((b),16)), SHR(MULT16_16SU(SHR((a),16),((b)&0x0000ffff)),16)), SHR(MULT16_16SU(SHR((b),16),((a)&0x0000ffff)),16)) 87 #endif 88 89 /** Compile-time conversion of float constant to 16-bit value */ 90 #define QCONST16(x,bits) ((opus_val16)(.5+(x)*(((opus_val32)1)<<(bits)))) 91 92 /** Compile-time conversion of float constant to 32-bit value */ 93 #define QCONST32(x,bits) ((opus_val32)(.5+(x)*(((opus_int64)1)<<(bits)))) 94 95 /** Compile-time conversion of float constant to log gain value */ 96 #define GCONST2(x,bits) ((celt_glog)(.5+(x)*(((celt_glog)1)<<(bits)))) 97 98 /** Compile-time conversion of float constant to DB_SHIFT log gain value */ 99 #define GCONST(x) GCONST2((x),DB_SHIFT) 100 101 /** Negate a 16-bit value */ 102 #define NEG16(x) (-(x)) 103 /** Negate a 32-bit value */ 104 #define NEG32(x) (-(x)) 105 106 /** Change a 32-bit value into a 16-bit value. The value is assumed to fit in 16-bit, otherwise the result is undefined */ 107 #define EXTRACT16(x) ((opus_val16)(x)) 108 /** Change a 16-bit value into a 32-bit value */ 109 #define EXTEND32(x) ((opus_val32)(x)) 110 111 /** Arithmetic shift-right of a 16-bit value */ 112 #define SHR16(a,shift) ((a) >> (shift)) 113 /** Arithmetic shift-left of a 16-bit value */ 114 #define SHL16(a,shift) ((opus_int16)((opus_uint16)(a)<<(shift))) 115 /** Arithmetic shift-right of a 32-bit value */ 116 #define SHR32(a,shift) ((a) >> (shift)) 117 /** Arithmetic shift-left of a 32-bit value */ 118 #define SHL32(a,shift) ((opus_int32)((opus_uint32)(a)<<(shift))) 119 120 /** 32-bit arithmetic shift right with rounding-to-nearest instead of rounding down */ 121 #define PSHR32(a,shift) (SHR32((a)+((EXTEND32(1)<<((shift))>>1)),shift)) 122 /** 32-bit arithmetic shift right where the argument can be negative */ 123 #define VSHR32(a, shift) (((shift)>0) ? SHR32(a, shift) : SHL32(a, -(shift))) 124 125 /** Arithmetic shift-right of a 64-bit value */ 126 #define SHR64(a,shift) ((a) >> (shift)) 127 128 /** "RAW" macros, should not be used outside of this header file */ 129 #define SHR(a,shift) ((a) >> (shift)) 130 #define SHL(a,shift) SHL32(a,shift) 131 #define PSHR(a,shift) (SHR((a)+((EXTEND32(1)<<((shift))>>1)),shift)) 132 #define SATURATE(x,a) (((x)>(a) ? (a) : (x)<-(a) ? -(a) : (x))) 133 134 #define SATURATE16(x) (EXTRACT16((x)>32767 ? 32767 : (x)<-32768 ? -32768 : (x))) 135 136 /** Shift by a and round-to-nearest 32-bit value. Result is a 16-bit value */ 137 #define ROUND16(x,a) (EXTRACT16(PSHR32((x),(a)))) 138 /** Shift by a and round-to-nearest 32-bit value. Result is a saturated 16-bit value */ 139 #define SROUND16(x,a) EXTRACT16(SATURATE(PSHR32(x,a), 32767)); 140 141 /** Divide by two */ 142 #define HALF16(x) (SHR16(x,1)) 143 #define HALF32(x) (SHR32(x,1)) 144 145 /** Add two 16-bit values */ 146 #define ADD16(a,b) ((opus_val16)((opus_val16)(a)+(opus_val16)(b))) 147 /** Subtract two 16-bit values */ 148 #define SUB16(a,b) ((opus_val16)(a)-(opus_val16)(b)) 149 /** Add two 32-bit values */ 150 #define ADD32(a,b) ((opus_val32)(a)+(opus_val32)(b)) 151 /** Subtract two 32-bit values */ 152 #define SUB32(a,b) ((opus_val32)(a)-(opus_val32)(b)) 153 154 /** Add two 32-bit values, ignore any overflows */ 155 #define ADD32_ovflw(a,b) ((opus_val32)((opus_uint32)(a)+(opus_uint32)(b))) 156 /** Subtract two 32-bit values, ignore any overflows */ 157 #define SUB32_ovflw(a,b) ((opus_val32)((opus_uint32)(a)-(opus_uint32)(b))) 158 /* Avoid MSVC warning C4146: unary minus operator applied to unsigned type */ 159 /** Negate 32-bit value, ignore any overflows */ 160 #define NEG32_ovflw(a) ((opus_val32)(0-(opus_uint32)(a))) 161 /** 32-bit shift left, ignoring overflows */ 162 #define SHL32_ovflw(a,shift) SHL32(a,shift) 163 /** 32-bit arithmetic shift right with rounding-to-nearest, ignoring overflows */ 164 #define PSHR32_ovflw(a,shift) (SHR32(ADD32_ovflw(a, (EXTEND32(1)<<(shift)>>1)),shift)) 165 166 /** 16x16 multiplication where the result fits in 16 bits */ 167 #define MULT16_16_16(a,b) ((((opus_val16)(a))*((opus_val16)(b)))) 168 169 /** 32x32 multiplication where the result fits in 32 bits */ 170 #define MULT32_32_32(a,b) ((((opus_val32)(a))*((opus_val32)(b)))) 171 172 /* (opus_val32)(opus_val16) gives TI compiler a hint that it's 16x16->32 multiply */ 173 /** 16x16 multiplication where the result fits in 32 bits */ 174 #define MULT16_16(a,b) (((opus_val32)(opus_val16)(a))*((opus_val32)(opus_val16)(b))) 175 176 /** 16x16 multiply-add where the result fits in 32 bits */ 177 #define MAC16_16(c,a,b) (ADD32((c),MULT16_16((a),(b)))) 178 /** 16x32 multiply, followed by a 15-bit shift right and 32-bit add. 179 b must fit in 31 bits. 180 Result fits in 32 bits. */ 181 #define MAC16_32_Q15(c,a,b) ADD32((c),ADD32(MULT16_16((a),SHR((b),15)), SHR(MULT16_16((a),((b)&0x00007fff)),15))) 182 183 /** 16x32 multiplication, followed by a 16-bit shift right and 32-bit add. 184 Results fits in 32 bits */ 185 #define MAC16_32_Q16(c,a,b) ADD32((c),ADD32(MULT16_16((a),SHR((b),16)), SHR(MULT16_16SU((a),((b)&0x0000ffff)),16))) 186 187 #define MULT16_16_Q11_32(a,b) (SHR(MULT16_16((a),(b)),11)) 188 #define MULT16_16_Q11(a,b) (SHR(MULT16_16((a),(b)),11)) 189 #define MULT16_16_Q13(a,b) (SHR(MULT16_16((a),(b)),13)) 190 #define MULT16_16_Q14(a,b) (SHR(MULT16_16((a),(b)),14)) 191 #define MULT16_16_Q15(a,b) (SHR(MULT16_16((a),(b)),15)) 192 193 #define MULT16_16_P13(a,b) (SHR(ADD32(4096,MULT16_16((a),(b))),13)) 194 #define MULT16_16_P14(a,b) (SHR(ADD32(8192,MULT16_16((a),(b))),14)) 195 #define MULT16_16_P15(a,b) (SHR(ADD32(16384,MULT16_16((a),(b))),15)) 196 197 /** Divide a 32-bit value by a 16-bit value. Result fits in 16 bits */ 198 #define DIV32_16(a,b) ((opus_val16)(((opus_val32)(a))/((opus_val16)(b)))) 199 200 /** Divide a 32-bit value by a 32-bit value. Result fits in 32 bits */ 201 #define DIV32(a,b) (((opus_val32)(a))/((opus_val32)(b))) 202 203 #if defined(__mips) 204 #include "mips/fixed_generic_mipsr1.h" 205 #endif 206 207 static OPUS_INLINE opus_val16 SIG2WORD16_generic(celt_sig x) 208 { 209 x = PSHR32(x, SIG_SHIFT); 210 x = MAX32(x, -32768); 211 x = MIN32(x, 32767); 212 return EXTRACT16(x); 213 } 214 #define SIG2WORD16(x) (SIG2WORD16_generic(x)) 215 216 #endif