Adds 3rd clause to CELT license
[opus.git] / celt / fixed_generic.h
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    - Neither the name of Internet Society, IETF or IETF Trust, nor the
21    names of specific contributors, may be used to endorse or promote
22    products derived from this software without specific prior written
23    permission.
24
25    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
29    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 */
37
38 #ifndef FIXED_GENERIC_H
39 #define FIXED_GENERIC_H
40
41 /** Multiply a 16-bit signed value by a 16-bit unsigned value. The result is a 32-bit signed value */
42 #define MULT16_16SU(a,b) ((opus_val32)(opus_val16)(a)*(opus_val32)(opus_uint16)(b))
43
44 /** 16x32 multiplication, followed by a 16-bit shift right. Results fits in 32 bits */
45 #define MULT16_32_Q16(a,b) ADD32(MULT16_16((a),SHR((b),16)), SHR(MULT16_16SU((a),((b)&0x0000ffff)),16))
46
47 /** 16x32 multiplication, followed by a 15-bit shift right. Results fits in 32 bits */
48 #define MULT16_32_Q15(a,b) ADD32(SHL(MULT16_16((a),SHR((b),16)),1), SHR(MULT16_16SU((a),((b)&0x0000ffff)),15))
49
50 /** 32x32 multiplication, followed by a 31-bit shift right. Results fits in 32 bits */
51 #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))
52
53 /** Compile-time conversion of float constant to 16-bit value */
54 #define QCONST16(x,bits) ((opus_val16)(.5+(x)*(((opus_val32)1)<<(bits))))
55
56 /** Compile-time conversion of float constant to 32-bit value */
57 #define QCONST32(x,bits) ((opus_val32)(.5+(x)*(((opus_val32)1)<<(bits))))
58
59 /** Negate a 16-bit value */
60 #define NEG16(x) (-(x))
61 /** Negate a 32-bit value */
62 #define NEG32(x) (-(x))
63
64 /** Change a 32-bit value into a 16-bit value. The value is assumed to fit in 16-bit, otherwise the result is undefined */
65 #define EXTRACT16(x) ((opus_val16)(x))
66 /** Change a 16-bit value into a 32-bit value */
67 #define EXTEND32(x) ((opus_val32)(x))
68
69 /** Arithmetic shift-right of a 16-bit value */
70 #define SHR16(a,shift) ((a) >> (shift))
71 /** Arithmetic shift-left of a 16-bit value */
72 #define SHL16(a,shift) ((opus_int16)((opus_uint16)(a)<<(shift)))
73 /** Arithmetic shift-right of a 32-bit value */
74 #define SHR32(a,shift) ((a) >> (shift))
75 /** Arithmetic shift-left of a 32-bit value */
76 #define SHL32(a,shift) ((opus_int32)((opus_uint32)(a)<<(shift)))
77
78 /** 32-bit arithmetic shift right with rounding-to-nearest instead of rounding down */
79 #define PSHR32(a,shift) (SHR32((a)+((EXTEND32(1)<<((shift))>>1)),shift))
80 /** 32-bit arithmetic shift right where the argument can be negative */
81 #define VSHR32(a, shift) (((shift)>0) ? SHR32(a, shift) : SHL32(a, -(shift)))
82
83 /** "RAW" macros, should not be used outside of this header file */
84 #define SHR(a,shift) ((a) >> (shift))
85 #define SHL(a,shift) SHL32(a,shift)
86 #define PSHR(a,shift) (SHR((a)+((EXTEND32(1)<<((shift))>>1)),shift))
87 #define SATURATE(x,a) (((x)>(a) ? (a) : (x)<-(a) ? -(a) : (x)))
88
89 /** Shift by a and round-to-neareast 32-bit value. Result is a 16-bit value */
90 #define ROUND16(x,a) (EXTRACT16(PSHR32((x),(a))))
91 /** Divide by two */
92 #define HALF16(x)  (SHR16(x,1))
93 #define HALF32(x)  (SHR32(x,1))
94
95 /** Add two 16-bit values */
96 #define ADD16(a,b) ((opus_val16)((opus_val16)(a)+(opus_val16)(b)))
97 /** Subtract two 16-bit values */
98 #define SUB16(a,b) ((opus_val16)(a)-(opus_val16)(b))
99 /** Add two 32-bit values */
100 #define ADD32(a,b) ((opus_val32)(a)+(opus_val32)(b))
101 /** Subtract two 32-bit values */
102 #define SUB32(a,b) ((opus_val32)(a)-(opus_val32)(b))
103
104 /** 16x16 multiplication where the result fits in 16 bits */
105 #define MULT16_16_16(a,b)     ((((opus_val16)(a))*((opus_val16)(b))))
106
107 /* (opus_val32)(opus_val16) gives TI compiler a hint that it's 16x16->32 multiply */
108 /** 16x16 multiplication where the result fits in 32 bits */
109 #define MULT16_16(a,b)     (((opus_val32)(opus_val16)(a))*((opus_val32)(opus_val16)(b)))
110
111 /** 16x16 multiply-add where the result fits in 32 bits */
112 #define MAC16_16(c,a,b) (ADD32((c),MULT16_16((a),(b))))
113 /** 16x32 multiply-add, followed by a 15-bit shift right. Results fits in 32 bits */
114 #define MAC16_32_Q15(c,a,b) ADD32(c,ADD32(MULT16_16((a),SHR((b),15)), SHR(MULT16_16((a),((b)&0x00007fff)),15)))
115
116 #define MULT16_16_Q11_32(a,b) (SHR(MULT16_16((a),(b)),11))
117 #define MULT16_16_Q13(a,b) (SHR(MULT16_16((a),(b)),13))
118 #define MULT16_16_Q14(a,b) (SHR(MULT16_16((a),(b)),14))
119 #define MULT16_16_Q15(a,b) (SHR(MULT16_16((a),(b)),15))
120
121 #define MULT16_16_P13(a,b) (SHR(ADD32(4096,MULT16_16((a),(b))),13))
122 #define MULT16_16_P14(a,b) (SHR(ADD32(8192,MULT16_16((a),(b))),14))
123 #define MULT16_16_P15(a,b) (SHR(ADD32(16384,MULT16_16((a),(b))),15))
124
125 /** Divide a 32-bit value by a 16-bit value. Result fits in 16 bits */
126 #define DIV32_16(a,b) ((opus_val16)(((opus_val32)(a))/((opus_val16)(b))))
127
128 /** Divide a 32-bit value by a 32-bit value. Result fits in 32 bits */
129 #define DIV32(a,b) (((opus_val32)(a))/((opus_val32)(b)))
130
131 #endif