Resampler can now compile outside of Speex in fixed-point too.
[speexdsp.git] / include / speex / speex_resampler.h
1 /* Copyright (C) 2007 Jean-Marc Valin
2       
3    File: speex_resampler.h
4    Resampling code
5       
6    The design goals of this code are:
7       - Very fast algorithm
8       - Low memory requirement
9       - Good *perceptual* quality (and not best SNR)
10
11    Redistribution and use in source and binary forms, with or without
12    modification, are permitted provided that the following conditions are
13    met:
14
15    1. Redistributions of source code must retain the above copyright notice,
16    this list of conditions and the following disclaimer.
17
18    2. Redistributions in binary form must reproduce the above copyright
19    notice, this list of conditions and the following disclaimer in the
20    documentation and/or other materials provided with the distribution.
21
22    3. The name of the author may not be used to endorse or promote products
23    derived from this software without specific prior written permission.
24
25    THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
28    DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
29    INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
30    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
31    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
33    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
34    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35    POSSIBILITY OF SUCH DAMAGE.
36 */
37
38
39 #ifndef SPEEX_RESAMPLER_H
40 #define SPEEX_RESAMPLER_H
41
42 #ifdef OUTSIDE_SPEEX
43
44 /********* WARNING: MENTAL SANITY ENDS HERE *************/
45
46 /* If the resampler is defined outside of Speex, we change the symbol names so that 
47    there won't be any clash if linking with Speex later on. */
48
49 /* #define RANDOM_PREFIX your software name here */
50 #ifndef RANDOM_PREFIX
51 #error "Please define RANDOM_PREFIX (above) to something specific to your project to prevent symbol name clashes"
52 #endif
53
54 #define CAT_PREFIX2(a,b) a ## b
55 #define CAT_PREFIX(a,b) CAT_PREFIX2(a, b)
56       
57 #define speex_resampler_init CAT_PREFIX(RANDOM_PREFIX,_resampler_init)
58 #define speex_resampler_init_frac CAT_PREFIX(RANDOM_PREFIX,_resampler_init_frac)
59 #define speex_resampler_destroy CAT_PREFIX(RANDOM_PREFIX,_resampler_destroy)
60 #define speex_resampler_process_float CAT_PREFIX(RANDOM_PREFIX,_resampler_process_float)
61 #define speex_resampler_process_int CAT_PREFIX(RANDOM_PREFIX,_resampler_process_int)
62 #define speex_resampler_process_interleaved_float CAT_PREFIX(RANDOM_PREFIX,_resampler_process_interleaved_float)
63 #define speex_resampler_process_interleaved_int CAT_PREFIX(RANDOM_PREFIX,_resampler_process_interleaved_int)
64 #define speex_resampler_set_rate CAT_PREFIX(RANDOM_PREFIX,_resampler_set_rate)
65 #define speex_resampler_get_rate CAT_PREFIX(RANDOM_PREFIX,_resampler_get_rate)
66 #define speex_resampler_set_rate_frac CAT_PREFIX(RANDOM_PREFIX,_resampler_set_rate_frac)
67 #define speex_resampler_get_ratio CAT_PREFIX(RANDOM_PREFIX,_resampler_get_ratio)
68 #define speex_resampler_set_quality CAT_PREFIX(RANDOM_PREFIX,_resampler_set_quality)
69 #define speex_resampler_get_quality CAT_PREFIX(RANDOM_PREFIX,_resampler_get_quality)
70 #define speex_resampler_set_input_stride CAT_PREFIX(RANDOM_PREFIX,_resampler_set_input_stride)
71 #define speex_resampler_get_input_stride CAT_PREFIX(RANDOM_PREFIX,_resampler_get_input_stride)
72 #define speex_resample_set_output_stride CAT_PREFIX(RANDOM_PREFIX,_resample_set_output_stride)
73 #define speex_resample_get_output_stride CAT_PREFIX(RANDOM_PREFIX,_resample_get_output_stride)
74 #define speex_resampler_skip_zeros CAT_PREFIX(RANDOM_PREFIX,_resampler_skip_zeros)
75 #define speex_resampler_reset_mem CAT_PREFIX(RANDOM_PREFIX,_resampler_reset_mem)
76
77 #define spx_int16_t short
78 #define spx_int32_t int
79 #define spx_uint16_t unsigned short
80 #define spx_uint32_t unsigned int
81       
82 #else /* OUTSIDE_SPEEX */
83
84 #include "speex/speex_types.h"
85
86 #endif /* OUTSIDE_SPEEX */
87
88 #ifdef __cplusplus
89 extern "C" {
90 #endif
91
92 #define SPEEX_RESAMPLER_QUALITY_MAX 10
93 #define SPEEX_RESAMPLER_QUALITY_MIN 0
94 #define SPEEX_RESAMPLER_QUALITY_DEFAULT 4
95 #define SPEEX_RESAMPLER_QUALITY_VOIP 3
96 #define SPEEX_RESAMPLER_QUALITY_DESKTOP 5
97    
98 struct SpeexResamplerState_;
99 typedef struct SpeexResamplerState_ SpeexResamplerState;
100
101 /** Create a new resampler with integer input and output rates.
102  * @param nb_channels Number of channels to be processed
103  * @param in_rate Input sampling rate (integer number of Hz).
104  * @param out_rate Output sampling rate (integer number of Hz).
105  * @param quality Resampling quality between 0 and 10, where 0 has poor quality
106  * and 10 has very high quality.
107  * @return Newly created resampler state
108  * @retval NULL Error: not enough memory
109  */
110 SpeexResamplerState *speex_resampler_init(spx_uint32_t nb_channels, 
111                                           spx_uint32_t in_rate, 
112                                           spx_uint32_t out_rate, 
113                                           int quality);
114
115 /** Create a new resampler with fractional input/output rates. The sampling 
116  * rate ratio is an arbitrary rational number with both the numerator and 
117  * denominator being 32-bit integers.
118  * @param nb_channels Number of channels to be processed
119  * @param ratio_num Numerator of the sampling rate ratio
120  * @param ratio_den Denominator of the sampling rate ratio
121  * @param in_rate Input sampling rate rounded to the nearest integer (in Hz).
122  * @param out_rate Output sampling rate rounded to the nearest integer (in Hz).
123  * @param quality Resampling quality between 0 and 10, where 0 has poor quality
124  * and 10 has very high quality.
125  * @return Newly created resampler state
126  * @retval NULL Error: not enough memory
127  */
128 SpeexResamplerState *speex_resampler_init_frac(spx_uint32_t nb_channels, 
129                                                spx_uint32_t ratio_num, 
130                                                spx_uint32_t ratio_den, 
131                                                spx_uint32_t in_rate, 
132                                                spx_uint32_t out_rate, 
133                                                int quality);
134
135 /** Destroy a resampler state.
136  * @param st Resampler state
137  */
138 void speex_resampler_destroy(SpeexResamplerState *st);
139
140 /** Resample a float array. The input and output buffers must *not* overlap.
141  * @param st Resampler state
142  * @param channel_index Index of the channel to process for the multi-channel 
143  * base (0 otherwise)
144  * @param in Input buffer
145  * @param in_len Number of input samples in the input buffer. Returns the 
146  * number of samples processed
147  * @param out Output buffer
148  * @param out_len Size of the output buffer. Returns the number of samples written
149  */
150 void speex_resampler_process_float(SpeexResamplerState *st, 
151                                    spx_uint32_t channel_index, 
152                                    const float *in, 
153                                    spx_uint32_t *in_len, 
154                                    float *out, 
155                                    spx_uint32_t *out_len);
156
157 /** Resample an int array. The input and output buffers must *not* overlap.
158  * @param st Resampler state
159  * @param channel_index Index of the channel to process for the multi-channel 
160  * base (0 otherwise)
161  * @param in Input buffer
162  * @param in_len Number of input samples in the input buffer. Returns the number
163  * of samples processed
164  * @param out Output buffer
165  * @param out_len Size of the output buffer. Returns the number of samples written
166  */
167 void speex_resampler_process_int(SpeexResamplerState *st, 
168                                  spx_uint32_t channel_index, 
169                                  const spx_int16_t *in, 
170                                  spx_uint32_t *in_len, 
171                                  spx_int16_t *out, 
172                                  spx_uint32_t *out_len);
173
174 /** Resample an interleaved float array. The input and output buffers must *not* overlap.
175  * @param st Resampler state
176  * @param in Input buffer
177  * @param in_len Number of input samples in the input buffer. Returns the number
178  * of samples processed. This is all per-channel.
179  * @param out Output buffer
180  * @param out_len Size of the output buffer. Returns the number of samples written.
181  * This is all per-channel.
182  */
183 void speex_resampler_process_interleaved_float(SpeexResamplerState *st, 
184                                                const float *in, 
185                                                spx_uint32_t *in_len, 
186                                                float *out, 
187                                                spx_uint32_t *out_len);
188
189 /** Resample an interleaved int array. The input and output buffers must *not* overlap.
190  * @param st Resampler state
191  * @param in Input buffer
192  * @param in_len Number of input samples in the input buffer. Returns the number
193  * of samples processed. This is all per-channel.
194  * @param out Output buffer
195  * @param out_len Size of the output buffer. Returns the number of samples written.
196  * This is all per-channel.
197  */
198 void speex_resampler_process_interleaved_int(SpeexResamplerState *st, 
199                                              const spx_int16_t *in, 
200                                              spx_uint32_t *in_len, 
201                                              spx_int16_t *out, 
202                                              spx_uint32_t *out_len);
203
204 /** Set (change) the input/output sampling rates (integer value).
205  * @param st Resampler state
206  * @param in_rate Input sampling rate (integer number of Hz).
207  * @param out_rate Output sampling rate (integer number of Hz).
208  */
209 void speex_resampler_set_rate(SpeexResamplerState *st, 
210                               spx_uint32_t in_rate, 
211                               spx_uint32_t out_rate);
212
213 /** Get the current input/output sampling rates (integer value).
214  * @param st Resampler state
215  * @param in_rate Input sampling rate (integer number of Hz) copied.
216  * @param out_rate Output sampling rate (integer number of Hz) copied.
217  */
218 void speex_resampler_get_rate(SpeexResamplerState *st, 
219                               spx_uint32_t *in_rate, 
220                               spx_uint32_t *out_rate);
221
222 /** Set (change) the input/output sampling rates and resampling ratio 
223  * (fractional values in Hz supported).
224  * @param st Resampler state
225  * @param ratio_num Numerator of the sampling rate ratio
226  * @param ratio_den Denominator of the sampling rate ratio
227  * @param in_rate Input sampling rate rounded to the nearest integer (in Hz).
228  * @param out_rate Output sampling rate rounded to the nearest integer (in Hz).
229  */
230 void speex_resampler_set_rate_frac(SpeexResamplerState *st, 
231                                    spx_uint32_t ratio_num, 
232                                    spx_uint32_t ratio_den, 
233                                    spx_uint32_t in_rate, 
234                                    spx_uint32_t out_rate);
235
236 /** Get the current resampling ratio. This will be reduced to the least
237  * common denominator.
238  * @param st Resampler state
239  * @param ratio_num Numerator of the sampling rate ratio copied
240  * @param ratio_den Denominator of the sampling rate ratio copied
241  */
242 void speex_resampler_get_ratio(SpeexResamplerState *st, 
243                                spx_uint32_t *ratio_num, 
244                                spx_uint32_t *ratio_den);
245
246 /** Set (change) the conversion quality.
247  * @param st Resampler state
248  * @param quality Resampling quality between 0 and 10, where 0 has poor 
249  * quality and 10 has very high quality.
250  */
251 void speex_resampler_set_quality(SpeexResamplerState *st, 
252                                  int quality);
253
254 /** Get the conversion quality.
255  * @param st Resampler state
256  * @param quality Resampling quality between 0 and 10, where 0 has poor 
257  * quality and 10 has very high quality.
258  */
259 void speex_resampler_get_quality(SpeexResamplerState *st, 
260                                  int *quality);
261
262 /** Set (change) the input stride.
263  * @param st Resampler state
264  * @param stride Input stride
265  */
266 void speex_resampler_set_input_stride(SpeexResamplerState *st, 
267                                       spx_uint32_t stride);
268
269 /** Get the input stride.
270  * @param st Resampler state
271  * @param stride Input stride copied
272  */
273 void speex_resampler_get_input_stride(SpeexResamplerState *st, 
274                                       spx_uint32_t *stride);
275
276 /** Set (change) the output stride.
277  * @param st Resampler state
278  * @param stride Output stride
279  */
280 void speex_resample_set_output_stride(SpeexResamplerState *st, 
281                                       spx_uint32_t stride);
282
283 /** Get the output stride.
284  * @param st Resampler state copied
285  * @param stride Output stride
286  */
287 void speex_resample_get_output_stride(SpeexResamplerState *st, 
288                                       spx_uint32_t *stride);
289
290 /** Make sure that the first samples to go out of the resamplers don't have 
291  * leading zeros. This is only useful before starting to use a newly created 
292  * resampler. It is recommended to use that when resampling an audio file, as
293  * it will generate a file with the same length. For real-time processing,
294  * it is probably easier not to use this call (so that the output duration
295  * is the same for the first frame).
296  * @param st Resampler state
297  */
298 void speex_resampler_skip_zeros(SpeexResamplerState *st);
299
300 /** Reset a resampler so a new (unrelated) stream can be processed.
301  * @param st Resampler state
302  */
303 void speex_resampler_reset_mem(SpeexResamplerState *st);
304
305 #ifdef __cplusplus
306 }
307 #endif
308
309 #endif