fixed-point: added code to count MIPS
[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 #define MULT16_16(a,b)     (spx_mips++,((int)(a))*((short)(b)))
74
75 #else
76
77 #define ADD16(a,b) ((a)+(b))
78 #define SUB16(a,b) ((a)-(b))
79 #define ADD32(a,b) ((a)+(b))
80 #define SUB32(a,b) ((a)-(b))
81
82 /* result fits in 16 bits */
83 #define MULT16_16_16(a,b)     (((short)(a))*((short)(b)))
84 /* Kludge: just making sure results are on 32 bits */
85 #define MULT16_16(a,b)     (((int)(a))*((short)(b)))
86
87 #endif
88
89 #define MULT16_32_Q11(a,b) ADD32(MULT16_16((a),SHR((b),11)), SHR(MULT16_16((a),((b)&0x000007ff)),11))
90 #define MULT16_32_Q13(a,b) ADD32(MULT16_16((a),SHR((b),13)), SHR(MULT16_16((a),((b)&0x00001fff)),13))
91 #define MULT16_32_Q14(a,b) ADD32(MULT16_16((a),SHR((b),14)), SHR(MULT16_16((a),((b)&0x00003fff)),14))
92 #define MULT16_32_Q15(a,b) ADD32(MULT16_16((a),SHR((b),15)), SHR(MULT16_16((a),((b)&0x00007fff)),15))
93
94 #define MULT16_16_Q13(a,b) (SHR(MULT16_16((a),(b)),13))
95 #define MULT16_16_Q14(a,b) (SHR(MULT16_16((a),(b)),14))
96 #define MULT16_16_Q15(a,b) (SHR(MULT16_16((a),(b)),15))
97
98 #define MULT16_16_P14(a,b) (SHR(ADD16(8192,MULT16_16((a),(b))),14))
99
100 #define MUL_16_32_R15(a,bh,bl) ADD32(MULT16_16((a),(bh)), SHR(MULT16_16((a),(bl)),15))
101
102
103
104 #define DIV32_16(a,b) (((signed int)(a))/((short)(b)))
105
106 #else
107
108 typedef float spx_mem_t;
109 typedef float spx_coef_t;
110 typedef float spx_lsp_t;
111 typedef float spx_sig_t;
112 typedef float spx_word16_t;
113 typedef float spx_word32_t;
114
115 #define LPC_SCALING  1.
116 #define SIG_SCALING  1.
117 #define LSP_SCALING  1.
118
119 #define LPC_SHIFT    0
120 #define SIG_SHIFT    0
121
122 #define PSHR(a,shift)       (a)
123 #define SHR(a,shift)       (a)
124 #define SHL(a,shift)       (a)
125 #define ADD16(a,b) ((a)+(b))
126 #define SUB16(a,b) ((a)-(b))
127 #define ADD32(a,b) ((a)+(b))
128 #define SUB32(a,b) ((a)-(b))
129 #define MULT16_16_16(a,b)     ((a)*(b))
130 #define MULT16_16(a,b)     ((a)*(b))
131
132 #define MULT16_32_Q11(a,b)     ((a)*(b))
133 #define MULT16_32_Q13(a,b)     ((a)*(b))
134 #define MULT16_32_Q14(a,b)     ((a)*(b))
135 #define MULT16_32_Q15(a,b)     ((a)*(b))
136
137 #define MULT16_16_Q13(a,b)     ((a)*(b))
138 #define MULT16_16_Q14(a,b)     ((a)*(b))
139 #define MULT16_16_Q15(a,b)     ((a)*(b))
140
141 #define DIV32_16(a,b)     ((a)/(b))
142
143
144 #endif
145
146 #ifndef RELEASE
147 void print_vec(float *vec, int len, char *name);
148 #endif
149
150 unsigned int be_int(unsigned int i);
151 unsigned int le_int(unsigned int i);
152
153
154 unsigned short be_short(unsigned short s);
155 unsigned short le_short(unsigned short s);
156
157 /** Speex wrapper for calloc. To do your own dynamic allocation, all you need to do is replace this function, speex_realloc and speex_free */
158 void *speex_alloc (int size);
159
160 /** Speex wrapper for realloc. To do your own dynamic allocation, all you need to do is replace this function, speex_alloc and speex_free */
161 void *speex_realloc (void *ptr, int size);
162
163 /** Speex wrapper for calloc. To do your own dynamic allocation, all you need to do is replace this function, speex_realloc and speex_alloc */
164 void speex_free (void *ptr);
165
166 /** Speex wrapper for mem_move */
167 void *speex_move (void *dest, void *src, int n);
168
169 void speex_error(char *str);
170
171 void speex_warning(char *str);
172
173 void speex_warning_int(char *str, int val);
174
175 void speex_rand_vec(float std, spx_sig_t *data, int len);
176
177 float speex_rand(float std);
178
179 void _speex_putc(int ch, void *file);
180
181 #endif