Separated the normal (integer frequency) calls from the fractional frequency
[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 #define spx_int16_t short
45 #ifdef FIXED_POINT
46 #define spx_word16_t short
47 #define spx_word32_t int
48 #else
49 #define spx_word16_t float
50 #define spx_word32_t float
51 #define MULT16_16(a,b) ((a)*(b))
52 #define PSHR32(a,b) (a)
53 #endif
54
55 #else
56
57 #include "speex/speex_types.h"
58
59 #endif
60
61 #ifdef __cplusplus
62 extern "C" {
63 #endif
64
65 #define SPEEX_RESAMPLER_QUALITY_MAX 10
66 #define SPEEX_RESAMPLER_QUALITY_MIN 0
67 #define SPEEX_RESAMPLER_QUALITY_DEFAULT 4
68 #define SPEEX_RESAMPLER_QUALITY_VOIP 3
69 #define SPEEX_RESAMPLER_QUALITY_DESKTOP 5
70    
71 struct SpeexResamplerState_;
72 typedef struct SpeexResamplerState_ SpeexResamplerState;
73
74 /** Create a new resampler with integer input and output rates.
75  * @param nb_channels Number of channels to be processed
76  * @param in_rate Nominal input sampling rate rounded to the nearest integer (in Hz). This does not need to be accurate.
77  * @param out_rate Nominal output sampling rate rounded to the nearest integer (in Hz). This does not need to be accurate.
78  * @param quality Resampling quality between 0 and 10, where 0 has poor quality and 10 has very high quality.
79  * @return Newly created resampler state
80  */
81 SpeexResamplerState *speex_resampler_init(int nb_channels, int in_rate, int out_rate, int quality);
82
83 /** Create a new resampler with fractional input/output rates. The sampling rate ratio is 
84  * an arbitrary rational number with both the numerator and denominator being 32-bit integers.
85  * @param nb_channels Number of channels to be processed
86  * @param ratio_num Numerator of the sampling rate ratio
87  * @param ratio_den Denominator of the sampling rate ratio
88  * @param in_rate Nominal input sampling rate rounded to the nearest integer (in Hz). This does not need to be accurate.
89  * @param out_rate Nominal output sampling rate rounded to the nearest integer (in Hz). This does not need to be accurate.
90  * @param quality Resampling quality between 0 and 10, where 0 has poor quality and 10 has very high quality.
91  * @return Newly created resampler state
92  */
93 SpeexResamplerState *speex_resampler_init_frac(int nb_channels, int ratio_num, int ratio_den, int in_rate, int out_rate, int quality);
94
95 /** Destroy a resampler state.
96  * @param st Resampler state
97  */
98 void speex_resampler_destroy(SpeexResamplerState *st);
99
100 /** Resample a float array. The input and output buffers must *not* overlap.
101  * @param st Resampler state
102  * @param channel_index Index of the channel to process for the multi-channel base (0 otherwise)
103  * @param in Input buffer
104  * @param in_len Number of input samples in the input buffer. Returns the number of samples processed
105  * @param out Output buffer
106  * @param out_len Size of the output buffer. Returns the number of samples written
107  */
108 void speex_resampler_process_float(SpeexResamplerState *st, int channel_index, const float *in, int *in_len, float *out, int *out_len);
109
110 /** Resample an int array. The input and output buffers must *not* overlap.
111  * @param st Resampler state
112  * @param channel_index Index of the channel to process for the multi-channel base (0 otherwise)
113  * @param in Input buffer
114  * @param in_len Number of input samples in the input buffer. Returns the number of samples processed
115  * @param out Output buffer
116  * @param out_len Size of the output buffer. Returns the number of samples written
117  */
118 void speex_resampler_process_int(SpeexResamplerState *st, int channel_index, const spx_int16_t *in, int *in_len, spx_int16_t *out, int *out_len);
119
120 /** Resample an interleaved float array. The input and output buffers must *not* overlap.
121  * @param st Resampler state
122  * @param in Input buffer
123  * @param in_len Number of input samples in the input buffer. Returns the number of samples processed. This is all per-channel.
124  * @param out Output buffer
125  * @param out_len Size of the output buffer. Returns the number of samples written. This is all per-channel.
126  */
127 void speex_resampler_process_interleaved_float(SpeexResamplerState *st, const float *in, int *in_len, float *out, int *out_len);
128
129 /** Resample an interleaved int array. The input and output buffers must *not* overlap.
130  * @param st Resampler state
131  * @param in Input buffer
132  * @param in_len Number of input samples in the input buffer. Returns the number of samples processed. This is all per-channel.
133  * @param out Output buffer
134  * @param out_len Size of the output buffer. Returns the number of samples written. This is all per-channel.
135  */
136 void speex_resampler_process_interleaved_int(SpeexResamplerState *st, const spx_int16_t *in, int *in_len, spx_int16_t *out, int *out_len);
137
138 /** Set (change) the input/output sampling rates (integer value).
139  * @param st Resampler state
140  * @param in_rate Nominal input sampling rate rounded to the nearest integer (in Hz). This does not need to be accurate.
141  * @param out_rate Nominal output sampling rate rounded to the nearest integer (in Hz). This does not need to be accurate.
142  */
143 void speex_resampler_set_rate(SpeexResamplerState *st, int in_rate, int out_rate);
144
145 /** Set (change) the input/output sampling rates and resampling ratio (fractional values in Hz supported).
146  * @param st Resampler state
147  * @param ratio_num Numerator of the sampling rate ratio
148  * @param ratio_den Denominator of the sampling rate ratio
149  * @param in_rate Nominal input sampling rate rounded to the nearest integer (in Hz). This does not need to be accurate.
150  * @param out_rate Nominal output sampling rate rounded to the nearest integer (in Hz). This does not need to be accurate.
151  */
152 void speex_resampler_set_rate_frac(SpeexResamplerState *st, int ratio_num, int ratio_den, int in_rate, int out_rate);
153
154 /** Set (change) the conversion quality.
155  * @param st Resampler state
156  * @param quality Resampling quality between 0 and 10, where 0 has poor quality and 10 has very high quality.
157  */
158 void speex_resampler_set_quality(SpeexResamplerState *st, int quality);
159
160 /** Set (change) the input stride.
161  * @param st Resampler state
162  * @param stride Input stride
163  */
164 void speex_resampler_set_input_stride(SpeexResamplerState *st, int stride);
165
166 /** Set (change) the output stride.
167  * @param st Resampler state
168  * @param stride Output stride
169  */
170 void speex_resample_set_output_stride(SpeexResamplerState *st, int stride);
171
172 /** Make sure that the first samples to go out of the resamplers don't have leading zeros.
173  * This is only useful before starting to use a newly created resampler.
174  * @param st Resampler state
175  */
176 void speex_resampler_skip_zeros(SpeexResamplerState *st);
177
178 /** Reset a resampler so a new (unrelated) stream can be processed.
179  * @param st Resampler state
180  */
181 void speex_resampler_reset_mem(SpeexResamplerState *st);
182
183 #ifdef __cplusplus
184 }
185 #endif
186
187 #endif