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