Speex  1.2~beta4
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_resampler_set_output_stride CAT_PREFIX(RANDOM_PREFIX,_resampler_set_output_stride)
73 #define speex_resampler_get_output_stride CAT_PREFIX(RANDOM_PREFIX,_resampler_get_output_stride)
74 #define speex_resampler_get_input_latency CAT_PREFIX(RANDOM_PREFIX,_resampler_get_input_latency)
75 #define speex_resampler_get_output_latency CAT_PREFIX(RANDOM_PREFIX,_resampler_get_output_latency)
76 #define speex_resampler_skip_zeros CAT_PREFIX(RANDOM_PREFIX,_resampler_skip_zeros)
77 #define speex_resampler_reset_mem CAT_PREFIX(RANDOM_PREFIX,_resampler_reset_mem)
78 #define speex_resampler_strerror CAT_PREFIX(RANDOM_PREFIX,_resampler_strerror)
79 
80 #define spx_int16_t short
81 #define spx_int32_t int
82 #define spx_uint16_t unsigned short
83 #define spx_uint32_t unsigned int
84 
85 #else /* OUTSIDE_SPEEX */
86 
87 #include "speex/speex_types.h"
88 
89 #endif /* OUTSIDE_SPEEX */
90 
91 #ifdef __cplusplus
92 extern "C" {
93 #endif
94 
95 #define SPEEX_RESAMPLER_QUALITY_MAX 10
96 #define SPEEX_RESAMPLER_QUALITY_MIN 0
97 #define SPEEX_RESAMPLER_QUALITY_DEFAULT 4
98 #define SPEEX_RESAMPLER_QUALITY_VOIP 3
99 #define SPEEX_RESAMPLER_QUALITY_DESKTOP 5
100 
101 enum {
102  RESAMPLER_ERR_SUCCESS = 0,
103  RESAMPLER_ERR_ALLOC_FAILED = 1,
104  RESAMPLER_ERR_BAD_STATE = 2,
105  RESAMPLER_ERR_INVALID_ARG = 3,
106  RESAMPLER_ERR_PTR_OVERLAP = 4,
107 
108  RESAMPLER_ERR_MAX_ERROR
109 };
110 
111 struct SpeexResamplerState_;
112 typedef struct SpeexResamplerState_ SpeexResamplerState;
113 
123 SpeexResamplerState *speex_resampler_init(spx_uint32_t nb_channels,
124  spx_uint32_t in_rate,
125  spx_uint32_t out_rate,
126  int quality,
127  int *err);
128 
142 SpeexResamplerState *speex_resampler_init_frac(spx_uint32_t nb_channels,
143  spx_uint32_t ratio_num,
144  spx_uint32_t ratio_den,
145  spx_uint32_t in_rate,
146  spx_uint32_t out_rate,
147  int quality,
148  int *err);
149 
153 void speex_resampler_destroy(SpeexResamplerState *st);
154 
165 int speex_resampler_process_float(SpeexResamplerState *st,
166  spx_uint32_t channel_index,
167  const float *in,
168  spx_uint32_t *in_len,
169  float *out,
170  spx_uint32_t *out_len);
171 
182 int speex_resampler_process_int(SpeexResamplerState *st,
183  spx_uint32_t channel_index,
184  const spx_int16_t *in,
185  spx_uint32_t *in_len,
186  spx_int16_t *out,
187  spx_uint32_t *out_len);
188 
198 int speex_resampler_process_interleaved_float(SpeexResamplerState *st,
199  const float *in,
200  spx_uint32_t *in_len,
201  float *out,
202  spx_uint32_t *out_len);
203 
213 int speex_resampler_process_interleaved_int(SpeexResamplerState *st,
214  const spx_int16_t *in,
215  spx_uint32_t *in_len,
216  spx_int16_t *out,
217  spx_uint32_t *out_len);
218 
224 int speex_resampler_set_rate(SpeexResamplerState *st,
225  spx_uint32_t in_rate,
226  spx_uint32_t out_rate);
227 
233 void speex_resampler_get_rate(SpeexResamplerState *st,
234  spx_uint32_t *in_rate,
235  spx_uint32_t *out_rate);
236 
245 int speex_resampler_set_rate_frac(SpeexResamplerState *st,
246  spx_uint32_t ratio_num,
247  spx_uint32_t ratio_den,
248  spx_uint32_t in_rate,
249  spx_uint32_t out_rate);
250 
257 void speex_resampler_get_ratio(SpeexResamplerState *st,
258  spx_uint32_t *ratio_num,
259  spx_uint32_t *ratio_den);
260 
266 int speex_resampler_set_quality(SpeexResamplerState *st,
267  int quality);
268 
274 void speex_resampler_get_quality(SpeexResamplerState *st,
275  int *quality);
276 
281 void speex_resampler_set_input_stride(SpeexResamplerState *st,
282  spx_uint32_t stride);
283 
288 void speex_resampler_get_input_stride(SpeexResamplerState *st,
289  spx_uint32_t *stride);
290 
295 void speex_resampler_set_output_stride(SpeexResamplerState *st,
296  spx_uint32_t stride);
297 
302 void speex_resampler_get_output_stride(SpeexResamplerState *st,
303  spx_uint32_t *stride);
304 
308 int speex_resampler_get_input_latency(SpeexResamplerState *st);
309 
313 int speex_resampler_get_output_latency(SpeexResamplerState *st);
314 
323 int speex_resampler_skip_zeros(SpeexResamplerState *st);
324 
328 int speex_resampler_reset_mem(SpeexResamplerState *st);
329 
334 const char *speex_resampler_strerror(int err);
335 
336 #ifdef __cplusplus
337 }
338 #endif
339 
340 #endif
Speex types.