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