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