fixed-point: converted all signals to spx_sig_t
[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 extern int fixed_point_on;
45 #define FIXED_SIGNAL fixed_point_on=1;
46 #define FLOAT_SIGNAL fixed_point_on=0;
47
48 typedef short        spx_word16_t;
49 typedef int          spx_word32_t;
50 typedef spx_word32_t spx_mem_t;
51 typedef spx_word16_t spx_coef_t;
52 typedef float   spx_sig_t;
53
54 #define LPC_SCALING  8192.
55 #define SIG_SCALING  16384.
56
57 #define LPC_SHIFT    13
58 #define SIG_SHIFT    14
59
60 #define SHR(a,shift) ((a) >> (shift))
61
62 #define MULT16_16(a,b)     (((signed int)(a))*(b))
63 #define MULT16_32_Q14(a,b) (((a)*((b)>>14)) + ((a)*((signed int)((b)&0x00003fff))>>14))
64 #define MULT16_32_Q15(a,b) (((a)*((b)>>15)) + ((a)*((signed int)((b)&0x00007fff))>>15))
65
66 #define MULT16_16_Q13(a,b) (((signed int)(a))*(b)>>13)
67 #define MULT16_16_Q14(a,b) (((signed int)(a))*(b)>>14)
68 #define MULT16_16_Q15(a,b) (((signed int)(a))*(b)>>15)
69
70 #define MULT16_16_P14(a,b) ((8192+((signed int)(a))*(b))>>14)
71
72
73 #define DIV32_16(a,b) (((signed int)(a))/(b))
74
75 #else
76
77 #define FIXED_SIGNAL
78 #define FLOAT_SIGNAL
79
80 typedef float spx_mem_t;
81 typedef float spx_coef_t;
82 typedef float spx_sig_t;
83 typedef float spx_word16_t;
84 typedef float spx_word32_t;
85
86 #define LPC_SCALING  1.
87 #define SIG_SCALING  1.
88
89 #define LPC_SHIFT    0
90 #define SIG_SHIFT    0
91
92 #define SHR(a,shift)       (a)
93 #define MULT16_16(a,b)     ((a)*(b))
94
95
96 #endif
97
98 #ifndef RELEASE
99 void print_vec(float *vec, int len, char *name);
100 #endif
101
102 unsigned int be_int(unsigned int i);
103 unsigned int le_int(unsigned int i);
104
105
106 unsigned short be_short(unsigned short s);
107 unsigned short le_short(unsigned short s);
108
109 /** Speex wrapper for calloc. To do your own dynamic allocation, all you need to do is replace this function, speex_realloc and speex_free */
110 void *speex_alloc (int size);
111
112 /** Speex wrapper for realloc. To do your own dynamic allocation, all you need to do is replace this function, speex_alloc and speex_free */
113 void *speex_realloc (void *ptr, int size);
114
115 /** Speex wrapper for calloc. To do your own dynamic allocation, all you need to do is replace this function, speex_realloc and speex_alloc */
116 void speex_free (void *ptr);
117
118 /** Speex wrapper for mem_move */
119 void *speex_move (void *dest, void *src, int n);
120
121 void speex_error(char *str);
122
123 void speex_warning(char *str);
124
125 void speex_warning_int(char *str, int val);
126
127 void speex_rand_vec(float std, spx_sig_t *data, int len);
128
129 float speex_rand(float std);
130
131 void _speex_putc(int ch, void *file);
132
133 #endif