fixed-point: Defined fused multiply-add operators and some ARM assembly to
[speexdsp.git] / libspeex / misc.h
1 /* Copyright (C) 2002 Jean-Marc Valin */
2 /**
3    @file misc.h
4    @brief Various compatibility routines for Speex
5 */
6 /*
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions
9    are met:
10    
11    - Redistributions of source code must retain the above copyright
12    notice, this list of conditions and the following disclaimer.
13    
14    - Redistributions in binary form must reproduce the above copyright
15    notice, this list of conditions and the following disclaimer in the
16    documentation and/or other materials provided with the distribution.
17    
18    - Neither the name of the Xiph.org Foundation nor the names of its
19    contributors may be used to endorse or promote products derived from
20    this software without specific prior written permission.
21    
22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
26    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 #ifndef MISC_H
36 #define MISC_H
37
38 #ifndef VERSION
39 #define VERSION "speex-1.1"
40 #endif
41
42 #ifdef FIXED_POINT
43
44 typedef signed short spx_word16_t;
45 typedef signed int   spx_word32_t;
46 typedef long long    spx_word64_t;
47 typedef spx_word32_t spx_mem_t;
48 typedef spx_word16_t spx_coef_t;
49 typedef spx_word16_t spx_lsp_t;
50 typedef spx_word32_t spx_sig_t;
51
52 #define LPC_SCALING  8192
53 #define SIG_SCALING  16384
54 #define LSP_SCALING  8192.
55
56 #define LPC_SHIFT    13
57 #define SIG_SHIFT    14
58
59 #ifdef COUNT_MIPS
60 extern long long spx_mips;
61 #endif
62
63 #define PSHR(a,shift) (((a)+(1<<((shift)-1))) >> (shift))
64 #define SHR(a,shift) ((a) >> (shift))
65 #define SHL(a,shift) ((a) << (shift))
66
67 #ifdef COUNT_MIPS
68 /*Modified to count operations*/
69 #define ADD16(a,b) (spx_mips++,(a)+(b))
70 #define SUB16(a,b) (spx_mips++,(a)-(b))
71 #define ADD32(a,b) (spx_mips++,(a)+(b))
72 #define ADD64(a,b) (spx_mips++,(a)+(b))
73 #define SUB32(a,b) (spx_mips++,(a)-(b))
74 #define MULT16_16_16(a,b)     (spx_mips++,((short)(a))*((short)(b)))
75
76 #ifdef ARM_ASM
77 static inline spx_word32_t MULT16_16(spx_word16_t x, spx_word16_t y) {
78   int res;
79   spx_mips++;
80   asm volatile("smulbb  %0,%1,%2;\n"
81                : "=&r"(res)
82                : "%r"(x),"r"(y));
83   return(res);
84 }
85 #else
86 #define MULT16_16(a,b)     (spx_mips++,((short)(a))*((short)(b)))
87 #endif
88
89 #else
90
91 #define ADD16(a,b) ((a)+(b))
92 #define SUB16(a,b) ((a)-(b))
93 #define ADD32(a,b) ((a)+(b))
94 #define SUB32(a,b) ((a)-(b))
95 #define ADD64(a,b) ((a)+(b))
96
97 /* result fits in 16 bits */
98 #define MULT16_16_16(a,b)     (((short)(a))*((short)(b)))
99 /* Kludge: just making sure results are on 32 bits */
100 #ifdef ARM_ASM
101 static inline spx_word32_t MULT16_16(spx_word16_t x, spx_word16_t y) {
102   int res;
103   asm volatile("smulbb  %0,%1,%2;\n"
104               : "=&r"(res)
105               : "%r"(x),"r"(y));
106   return(res);
107 }
108 #else
109 #define MULT16_16(a,b)     (((short)(a))*((short)(b)))
110 #endif
111
112 #endif
113
114 #ifdef ARM_ASM
115
116 static inline spx_word32_t MAC16_16(spx_word32_t a, spx_word16_t x, spx_word32_t y) {
117   int res;
118   asm volatile("smlabb  %0,%1,%2,%3;\n"
119               : "=&r"(res)
120                : "%r"(x),"r"(y),"r"(a));
121   return(res);
122 }
123
124 #else
125
126 #define MAC16_16(c,a,b)     (ADD32((c),MULT16_16((a),(b))))
127
128 #endif
129
130 #define MULT16_32_Q11(a,b) ADD32(MULT16_16((a),SHR((b),11)), SHR(MULT16_16((a),((b)&0x000007ff)),11))
131 #define MULT16_32_Q12(a,b) ADD32(MULT16_16((a),SHR((b),12)), SHR(MULT16_16((a),((b)&0x00000fff)),11))
132 #define MULT16_32_Q13(a,b) ADD32(MULT16_16((a),SHR((b),13)), SHR(MULT16_16((a),((b)&0x00001fff)),13))
133 #define MULT16_32_Q14(a,b) ADD32(MULT16_16((a),SHR((b),14)), SHR(MULT16_16((a),((b)&0x00003fff)),14))
134
135 #ifdef ARM_ASM
136 static inline spx_word32_t MULT16_32_Q15(spx_word16_t x, spx_word32_t y) {
137   int res;
138   asm volatile("smulwb  %0,%1,%2;\n"
139               : "=&r"(res)
140                : "%r"(y<<1),"r"(x));
141   return(res);
142 }
143 static inline spx_word32_t MAC16_32_Q15(spx_word32_t a, spx_word16_t x, spx_word32_t y) {
144   int res;
145   asm volatile("smlawb  %0,%1,%2,%3;\n"
146               : "=&r"(res)
147                : "%r"(y<<1),"r"(x),"r"(a));
148   return(res);
149 }
150
151 #else
152 #define MULT16_32_Q15(a,b) ADD32(MULT16_16((a),SHR((b),15)), SHR(MULT16_16((a),((b)&0x00007fff)),15))
153 #define MAC16_32_Q15(c,a,b) ADD32(c,ADD32(MULT16_16((a),SHR((b),15)), SHR(MULT16_16((a),((b)&0x00007fff)),15)))
154 #endif
155
156
157 #define MULT16_16_Q13(a,b) (SHR(MULT16_16((a),(b)),13))
158 #define MULT16_16_Q14(a,b) (SHR(MULT16_16((a),(b)),14))
159 #define MULT16_16_Q15(a,b) (SHR(MULT16_16((a),(b)),15))
160
161 #define MULT16_16_P13(a,b) (SHR(ADD16(4096,MULT16_16((a),(b))),13))
162 #define MULT16_16_P14(a,b) (SHR(ADD16(8192,MULT16_16((a),(b))),14))
163 #define MULT16_16_P15(a,b) (SHR(ADD16(16384,MULT16_16((a),(b))),15))
164
165 #define MUL_16_32_R15(a,bh,bl) ADD32(MULT16_16((a),(bh)), SHR(MULT16_16((a),(bl)),15))
166
167
168
169 #define DIV32_16(a,b) (((signed int)(a))/((short)(b)))
170
171 #else
172
173 typedef float spx_mem_t;
174 typedef float spx_coef_t;
175 typedef float spx_lsp_t;
176 typedef float spx_sig_t;
177 typedef float spx_word16_t;
178 typedef float spx_word32_t;
179 typedef float spx_word64_t;
180
181 #define LPC_SCALING  1.
182 #define SIG_SCALING  1.
183 #define LSP_SCALING  1.
184
185 #define LPC_SHIFT    0
186 #define SIG_SHIFT    0
187
188 #define PSHR(a,shift)       (a)
189 #define SHR(a,shift)       (a)
190 #define SHL(a,shift)       (a)
191 #define ADD16(a,b) ((a)+(b))
192 #define SUB16(a,b) ((a)-(b))
193 #define ADD32(a,b) ((a)+(b))
194 #define SUB32(a,b) ((a)-(b))
195 #define ADD64(a,b) ((a)+(b))
196 #define MULT16_16_16(a,b)     ((a)*(b))
197 #define MULT16_16(a,b)     ((a)*(b))
198 #define MAC16_16(c,a,b)     ((c)+(a)*(b))
199
200 #define MULT16_32_Q11(a,b)     ((a)*(b))
201 #define MULT16_32_Q13(a,b)     ((a)*(b))
202 #define MULT16_32_Q14(a,b)     ((a)*(b))
203 #define MULT16_32_Q15(a,b)     ((a)*(b))
204
205 #define MAC16_32_Q15(c,a,b)     ((c)+(a)*(b))
206
207 #define MULT16_16_Q13(a,b)     ((a)*(b))
208 #define MULT16_16_Q14(a,b)     ((a)*(b))
209 #define MULT16_16_Q15(a,b)     ((a)*(b))
210
211 #define DIV32_16(a,b)     ((a)/(b))
212
213
214 #endif
215
216 #ifndef RELEASE
217 void print_vec(float *vec, int len, char *name);
218 #endif
219
220 unsigned int be_int(unsigned int i);
221 unsigned int le_int(unsigned int i);
222
223
224 unsigned short be_short(unsigned short s);
225 unsigned short le_short(unsigned short s);
226
227 /** Speex wrapper for calloc. To do your own dynamic allocation, all you need to do is replace this function, speex_realloc and speex_free */
228 void *speex_alloc (int size);
229
230 /** Speex wrapper for realloc. To do your own dynamic allocation, all you need to do is replace this function, speex_alloc and speex_free */
231 void *speex_realloc (void *ptr, int size);
232
233 /** Speex wrapper for calloc. To do your own dynamic allocation, all you need to do is replace this function, speex_realloc and speex_alloc */
234 void speex_free (void *ptr);
235
236 /** Speex wrapper for mem_move */
237 void *speex_move (void *dest, void *src, int n);
238
239 void speex_error(char *str);
240
241 void speex_warning(char *str);
242
243 void speex_warning_int(char *str, int val);
244
245 void speex_rand_vec(float std, spx_sig_t *data, int len);
246
247 float speex_rand(float std);
248
249 void _speex_putc(int ch, void *file);
250
251 #endif