fixed-point: some ARM work
[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 spx_word32_t spx_mem_t;
47 typedef spx_word16_t spx_coef_t;
48 typedef spx_word16_t spx_lsp_t;
49 typedef spx_word32_t spx_sig_t;
50
51 #define LPC_SCALING  8192.
52 #define SIG_SCALING  16384
53 #define LSP_SCALING  8192.
54
55 #define LPC_SHIFT    13
56 #define SIG_SHIFT    14
57
58 #ifdef COUNT_MIPS
59 extern long long spx_mips;
60 #endif
61
62 #define PSHR(a,shift) (((a)+(1<<((shift)-1))) >> (shift))
63 #define SHR(a,shift) ((a) >> (shift))
64 #define SHL(a,shift) ((a) << (shift))
65
66 #ifdef COUNT_MIPS
67 /*Modified to count operations*/
68 #define ADD16(a,b) (spx_mips++,(a)+(b))
69 #define SUB16(a,b) (spx_mips++,(a)-(b))
70 #define ADD32(a,b) (spx_mips++,(a)+(b))
71 #define SUB32(a,b) (spx_mips++,(a)-(b))
72 #define MULT16_16_16(a,b)     (spx_mips++,((short)(a))*((short)(b)))
73
74 #ifdef ARM_ASM
75 static inline spx_word32_t MULT16_16(spx_word16_t x, spx_word16_t y) {
76   int res;
77   spx_mips++;
78   asm volatile("smulbb  %0,%1,%2;\n"
79                : "=&r"(res)
80                : "%r"(x),"r"(y));
81   return(res);
82 }
83 #else
84 #define MULT16_16(a,b)     (spx_mips++,((short)(a))*((short)(b)))
85 #endif
86
87 #else
88
89 #define ADD16(a,b) ((a)+(b))
90 #define SUB16(a,b) ((a)-(b))
91 #define ADD32(a,b) ((a)+(b))
92 #define SUB32(a,b) ((a)-(b))
93
94 /* result fits in 16 bits */
95 #define MULT16_16_16(a,b)     (((short)(a))*((short)(b)))
96 /* Kludge: just making sure results are on 32 bits */
97 #ifdef ARM_ASM
98 static inline spx_word32_t MULT16_16(spx_word16_t x, spx_word16_t y) {
99   int res;
100   asm volatile("smulbb  %0,%1,%2;\n"
101               : "=&r"(res)
102               : "%r"(x),"r"(y));
103   return(res);
104 }
105 #else
106 #define MULT16_16(a,b)     (((short)(a))*((short)(b)))
107 #endif
108
109 #endif
110
111 #define MULT16_32_Q11(a,b) ADD32(MULT16_16((a),SHR((b),11)), SHR(MULT16_16((a),((b)&0x000007ff)),11))
112 #define MULT16_32_Q13(a,b) ADD32(MULT16_16((a),SHR((b),13)), SHR(MULT16_16((a),((b)&0x00001fff)),13))
113 #define MULT16_32_Q14(a,b) ADD32(MULT16_16((a),SHR((b),14)), SHR(MULT16_16((a),((b)&0x00003fff)),14))
114 #define MULT16_32_Q15(a,b) ADD32(MULT16_16((a),SHR((b),15)), SHR(MULT16_16((a),((b)&0x00007fff)),15))
115
116 #define MULT16_16_Q13(a,b) (SHR(MULT16_16((a),(b)),13))
117 #define MULT16_16_Q14(a,b) (SHR(MULT16_16((a),(b)),14))
118 #define MULT16_16_Q15(a,b) (SHR(MULT16_16((a),(b)),15))
119
120 #define MULT16_16_P14(a,b) (SHR(ADD16(8192,MULT16_16((a),(b))),14))
121
122 #define MUL_16_32_R15(a,bh,bl) ADD32(MULT16_16((a),(bh)), SHR(MULT16_16((a),(bl)),15))
123
124
125
126 #define DIV32_16(a,b) (((signed int)(a))/((short)(b)))
127
128 #else
129
130 typedef float spx_mem_t;
131 typedef float spx_coef_t;
132 typedef float spx_lsp_t;
133 typedef float spx_sig_t;
134 typedef float spx_word16_t;
135 typedef float spx_word32_t;
136
137 #define LPC_SCALING  1.
138 #define SIG_SCALING  1.
139 #define LSP_SCALING  1.
140
141 #define LPC_SHIFT    0
142 #define SIG_SHIFT    0
143
144 #define PSHR(a,shift)       (a)
145 #define SHR(a,shift)       (a)
146 #define SHL(a,shift)       (a)
147 #define ADD16(a,b) ((a)+(b))
148 #define SUB16(a,b) ((a)-(b))
149 #define ADD32(a,b) ((a)+(b))
150 #define SUB32(a,b) ((a)-(b))
151 #define MULT16_16_16(a,b)     ((a)*(b))
152 #define MULT16_16(a,b)     ((a)*(b))
153
154 #define MULT16_32_Q11(a,b)     ((a)*(b))
155 #define MULT16_32_Q13(a,b)     ((a)*(b))
156 #define MULT16_32_Q14(a,b)     ((a)*(b))
157 #define MULT16_32_Q15(a,b)     ((a)*(b))
158
159 #define MULT16_16_Q13(a,b)     ((a)*(b))
160 #define MULT16_16_Q14(a,b)     ((a)*(b))
161 #define MULT16_16_Q15(a,b)     ((a)*(b))
162
163 #define DIV32_16(a,b)     ((a)/(b))
164
165
166 #endif
167
168 #ifndef RELEASE
169 void print_vec(float *vec, int len, char *name);
170 #endif
171
172 unsigned int be_int(unsigned int i);
173 unsigned int le_int(unsigned int i);
174
175
176 unsigned short be_short(unsigned short s);
177 unsigned short le_short(unsigned short s);
178
179 /** Speex wrapper for calloc. To do your own dynamic allocation, all you need to do is replace this function, speex_realloc and speex_free */
180 void *speex_alloc (int size);
181
182 /** Speex wrapper for realloc. To do your own dynamic allocation, all you need to do is replace this function, speex_alloc and speex_free */
183 void *speex_realloc (void *ptr, int size);
184
185 /** Speex wrapper for calloc. To do your own dynamic allocation, all you need to do is replace this function, speex_realloc and speex_alloc */
186 void speex_free (void *ptr);
187
188 /** Speex wrapper for mem_move */
189 void *speex_move (void *dest, void *src, int n);
190
191 void speex_error(char *str);
192
193 void speex_warning(char *str);
194
195 void speex_warning_int(char *str, int val);
196
197 void speex_rand_vec(float std, spx_sig_t *data, int len);
198
199 float speex_rand(float std);
200
201 void _speex_putc(int ch, void *file);
202
203 #endif