ext/, examples/, swig/, python/, tests/: remove libaubioext, make libsamplerate optional
[aubio.git] / swig / aubio.i
1 %module aubiowrapper
2
3 %{
4 #include "aubio.h"
5 %}
6
7 /* type aliases */
8 typedef unsigned int uint_t;
9 typedef int sint_t;
10 typedef float smpl_t;
11
12 /* fvec */
13 extern fvec_t * new_fvec(uint_t length, uint_t channels);
14 extern void del_fvec(fvec_t *s);
15 smpl_t fvec_read_sample(fvec_t *s, uint_t channel, uint_t position);
16 void fvec_write_sample(fvec_t *s, smpl_t data, uint_t channel, uint_t position);
17 smpl_t * fvec_get_channel(fvec_t *s, uint_t channel);
18 void fvec_put_channel(fvec_t *s, smpl_t * data, uint_t channel);
19 smpl_t ** fvec_get_data(fvec_t *s);
20
21 /* another way, passing -c++ option to swig */
22 /*
23 class fvec_t{
24 public:
25     %extend {
26         fvec_t(uint_t length, uint_t channels){
27             return new_fvec(length, channels);
28         }
29         ~fvec_t() {
30             del_fvec(self);
31         }
32         smpl_t get( uint_t channel, uint_t position) {
33             return fvec_read_sample(self,channel,position);
34         }
35         void set( smpl_t data, uint_t channel, uint_t position) {
36             fvec_write_sample(self, data, channel, position); 
37         }
38         #smpl_t * fvec_get_channel(fvec_t *s, uint_t channel);
39         #void fvec_put_channel(fvec_t *s, smpl_t * data, uint_t channel);
40     }
41 };
42 */
43
44 /* cvec */
45 extern cvec_t * new_cvec(uint_t length, uint_t channels);
46 extern void del_cvec(cvec_t *s);
47 extern void cvec_write_norm(cvec_t *s, smpl_t data, uint_t channel, uint_t position);
48 extern void cvec_write_phas(cvec_t *s, smpl_t data, uint_t channel, uint_t position);
49 extern smpl_t cvec_read_norm(cvec_t *s, uint_t channel, uint_t position);
50 extern smpl_t cvec_read_phas(cvec_t *s, uint_t channel, uint_t position);
51 extern void cvec_put_norm_channel(cvec_t *s, smpl_t * data, uint_t channel);
52 extern void cvec_put_phas_channel(cvec_t *s, smpl_t * data, uint_t channel);
53 extern smpl_t * cvec_get_norm_channel(cvec_t *s, uint_t channel);
54 extern smpl_t * cvec_get_phas_channel(cvec_t *s, uint_t channel);
55 extern smpl_t ** cvec_get_norm(cvec_t *s);
56 extern smpl_t ** cvec_get_phas(cvec_t *s);
57
58
59 /* fft */
60 extern aubio_fft_t * new_aubio_fft(uint_t size, uint_t channels);
61 extern void del_aubio_fft(aubio_fft_t * s);
62 extern void aubio_fft_do (aubio_fft_t *s, fvec_t * input, cvec_t * spectrum);
63 extern void aubio_fft_rdo (aubio_fft_t *s, cvec_t * spectrum, fvec_t * output);
64 extern void aubio_fft_do_complex (aubio_fft_t *s, fvec_t * input, fvec_t * compspec);
65 extern void aubio_fft_rdo_complex (aubio_fft_t *s, fvec_t * compspec, fvec_t * output);
66 extern void aubio_fft_get_spectrum(fvec_t * compspec, cvec_t * spectrum);
67 extern void aubio_fft_get_realimag(cvec_t * spectrum, fvec_t * compspec);
68 extern void aubio_fft_get_phas(fvec_t * compspec, cvec_t * spectrum);
69 extern void aubio_fft_get_imag(cvec_t * spectrum, fvec_t * compspec);
70 extern void aubio_fft_get_norm(fvec_t * compspec, cvec_t * spectrum);
71 extern void aubio_fft_get_real(cvec_t * spectrum, fvec_t * compspec);
72
73 /* filter */
74 extern aubio_filter_t * new_aubio_filter(uint_t samplerate, uint_t order, uint_t channels);
75 extern void aubio_filter_do(aubio_filter_t * b, fvec_t * in);
76 extern void aubio_filter_do_outplace(aubio_filter_t * b, fvec_t * in, fvec_t * out);
77 extern void aubio_filter_do_filtfilt(aubio_filter_t * b, fvec_t * in, fvec_t * tmp);
78 extern void del_aubio_filter(aubio_filter_t * b);
79
80 extern aubio_filter_t * new_aubio_filter_a_weighting (uint_t samplerate, uint_t channels);
81 extern uint_t aubio_filter_set_a_weighting (aubio_filter_t * b);
82
83 extern aubio_filter_t * new_aubio_filter_c_weighting (uint_t samplerate, uint_t channels);
84 extern uint_t aubio_filter_set_c_weighting (aubio_filter_t * b);
85
86 /* biquad */
87 extern aubio_biquad_t * new_aubio_biquad(lsmp_t b1, lsmp_t b2, lsmp_t b3, lsmp_t a2, lsmp_t a3);
88 extern void aubio_biquad_do(aubio_biquad_t * b, fvec_t * in);
89 extern void aubio_biquad_do_filtfilt(aubio_biquad_t * b, fvec_t * in, fvec_t * tmp);
90 extern void del_aubio_biquad(aubio_biquad_t * b);
91
92 /* hist */
93 extern aubio_hist_t * new_aubio_hist(smpl_t flow, smpl_t fhig, uint_t nelems, uint_t channels);
94 extern void del_aubio_hist(aubio_hist_t *s);
95 extern void aubio_hist_do(aubio_hist_t *s, fvec_t * input);
96 extern void aubio_hist_do_notnull(aubio_hist_t *s, fvec_t * input);
97 extern void aubio_hist_dyn_notnull(aubio_hist_t *s, fvec_t *input);
98 extern void aubio_hist_weight(aubio_hist_t *s);
99 extern smpl_t aubio_hist_mean(aubio_hist_t *s);
100
101 /* mathutils */
102 typedef enum {
103         aubio_win_rectangle,
104         aubio_win_hamming,
105         aubio_win_hanning,
106         aubio_win_hanningz,
107         aubio_win_blackman,
108         aubio_win_blackman_harris,
109         aubio_win_gaussian,
110         aubio_win_welch,
111         aubio_win_parzen
112 } aubio_window_type;
113
114 fvec_t * new_aubio_window(uint_t size, aubio_window_type wintype);
115 smpl_t aubio_unwrap2pi (smpl_t phase);
116 smpl_t fvec_mean(fvec_t *s);
117 smpl_t fvec_max(fvec_t *s);
118 smpl_t fvec_min(fvec_t *s);
119 uint_t fvec_min_elem(fvec_t *s);
120 uint_t fvec_max_elem(fvec_t *s);
121 void fvec_shift(fvec_t *s);
122 smpl_t fvec_sum(fvec_t *s);
123 smpl_t fvec_local_energy(fvec_t * f);
124 smpl_t fvec_local_hfc(fvec_t * f);
125 smpl_t fvec_alpha_norm(fvec_t * DF, smpl_t alpha);
126 void fvec_min_removal(fvec_t * mag);
127 void fvec_alpha_normalise(fvec_t * mag, uint_t alpha);
128 void fvec_add(fvec_t * mag, smpl_t threshold);
129 void fvec_adapt_thres(fvec_t * vec, fvec_t * tmp, uint_t post, uint_t pre);
130 smpl_t fvec_moving_thres(fvec_t * vec, fvec_t * tmp, uint_t post, uint_t pre, uint_t pos);
131 smpl_t fvec_median(fvec_t * input);
132 smpl_t fvec_quadint(fvec_t * x,uint_t pos, uint_t span);
133 smpl_t aubio_quadfrac(smpl_t s0, smpl_t s1, smpl_t s2, smpl_t pf);
134 uint_t fvec_peakpick(fvec_t * input, uint_t pos);
135 smpl_t aubio_bintomidi(smpl_t bin, smpl_t samplerate, smpl_t fftsize);
136 smpl_t aubio_miditobin(smpl_t midi, smpl_t samplerate, smpl_t fftsize);
137 smpl_t aubio_bintofreq(smpl_t bin, smpl_t samplerate, smpl_t fftsize);
138 smpl_t aubio_freqtobin(smpl_t freq, smpl_t samplerate, smpl_t fftsize);
139 smpl_t aubio_freqtomidi(smpl_t freq);
140 smpl_t aubio_miditofreq(smpl_t midi);
141 uint_t aubio_silence_detection(fvec_t * ibuf, smpl_t threshold);
142 smpl_t aubio_level_detection(fvec_t * ibuf, smpl_t threshold);
143 void aubio_autocorr(fvec_t * in, fvec_t * acf);
144 smpl_t aubio_zero_crossing_rate(fvec_t * input);
145 smpl_t aubio_spectral_centroid(cvec_t * spectrum, smpl_t samplerate);
146
147 /* filterbank */
148 aubio_filterbank_t * new_aubio_filterbank(uint_t win_s, uint_t channels);
149 void aubio_filterbank_set_triangle_bands (aubio_filterbank_t *fb, uint_t samplerate, fvec_t *freqs);
150 void aubio_filterbank_set_mel_coeffs_slaney(aubio_filterbank_t *fb, uint_t samplerate);
151 void del_aubio_filterbank(aubio_filterbank_t * fb);
152 void aubio_filterbank_do(aubio_filterbank_t * fb, cvec_t * in, fvec_t *out);
153 fvec_t * aubio_filterbank_get_coeffs(aubio_filterbank_t * fb);
154
155 /* mfcc */
156 aubio_mfcc_t * new_aubio_mfcc (uint_t win_s, uint_t samplerate, uint_t n_filters, uint_t n_coefs);
157 void del_aubio_mfcc(aubio_mfcc_t *mf);
158 void aubio_mfcc_do(aubio_mfcc_t *mf, cvec_t *in, fvec_t *out);
159
160 /* scale */
161 extern aubio_scale_t * new_aubio_scale(smpl_t flow, smpl_t fhig, smpl_t ilow, smpl_t ihig);
162 extern uint_t aubio_scale_set_limits (aubio_scale_t *s, smpl_t ilow, smpl_t ihig, smpl_t olow, smpl_t ohig);
163 extern void aubio_scale_do(aubio_scale_t *s, fvec_t * input);
164 extern void del_aubio_scale(aubio_scale_t *s);
165
166 /* resampling */
167 #if HAVE_SAMPLERATE
168 extern aubio_resampler_t * new_aubio_resampler(float ratio, uint_t type);
169 extern void aubio_resampler_do (aubio_resampler_t *s, fvec_t * input,  fvec_t * output);
170 extern void del_aubio_resampler(aubio_resampler_t *s);
171 #endif /* HAVE_SAMPLERATE */
172
173 /* onset detection */
174 aubio_onsetdetection_t * new_aubio_onsetdetection(char * onset_mode, uint_t size, uint_t channels);
175 void aubio_onsetdetection_do (aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
176 void del_aubio_onsetdetection(aubio_onsetdetection_t *o);
177
178 /* pvoc */
179 aubio_pvoc_t * new_aubio_pvoc (uint_t win_s, uint_t hop_s, uint_t channels);
180 void del_aubio_pvoc(aubio_pvoc_t *pv);
181 void aubio_pvoc_do(aubio_pvoc_t *pv, fvec_t *in, cvec_t * fftgrain);
182 void aubio_pvoc_rdo(aubio_pvoc_t *pv, cvec_t * fftgrain, fvec_t *out);
183
184 /* pitch detection */
185 aubio_pitchdetection_t *new_aubio_pitchdetection (char *pitch_mode,
186     uint_t bufsize, uint_t hopsize, uint_t channels, uint_t samplerate);
187 void aubio_pitchdetection_do (aubio_pitchdetection_t * p, fvec_t * ibuf, fvec_t * obuf);
188 uint_t aubio_pitchdetection_set_tolerance(aubio_pitchdetection_t *p, smpl_t thres);
189 uint_t aubio_pitchdetection_set_unit(aubio_pitchdetection_t *p, char * pitch_unit);
190 void del_aubio_pitchdetection(aubio_pitchdetection_t * p);
191
192 /* pitch mcomb */
193 aubio_pitchmcomb_t * new_aubio_pitchmcomb(uint_t bufsize, uint_t hopsize, uint_t channels);
194 void aubio_pitchmcomb_do (aubio_pitchmcomb_t * p, cvec_t * fftgrain, fvec_t * out);
195 void del_aubio_pitchmcomb (aubio_pitchmcomb_t *p);
196
197 /* pitch yin */
198 aubio_pitchyin_t * new_aubio_pitchyin(uint_t bufsize);
199 void aubio_pitchyin_do (aubio_pitchyin_t *o, fvec_t * in, fvec_t *out);
200 void del_aubio_pitchyin (aubio_pitchyin_t *p);
201
202 /* pitch schmitt */
203 aubio_pitchschmitt_t * new_aubio_pitchschmitt (uint_t size);
204 void aubio_pitchschmitt_do (aubio_pitchschmitt_t *p, fvec_t * input, fvec_t *out);
205 void del_aubio_pitchschmitt (aubio_pitchschmitt_t *p);
206
207 /* pitch fcomb */
208 aubio_pitchfcomb_t * new_aubio_pitchfcomb (uint_t size, uint_t hopsize, uint_t samplerate);
209 void aubio_pitchfcomb_do (aubio_pitchfcomb_t *p, fvec_t * input, fvec_t *out);
210 void del_aubio_pitchfcomb (aubio_pitchfcomb_t *p);
211
212 /* peakpicker */
213 aubio_peakpicker_t * new_aubio_peakpicker(smpl_t threshold);
214 smpl_t aubio_peakpicker_do(aubio_peakpicker_t * p, fvec_t * df);
215 smpl_t aubio_peakpicker_get_thresholded_input(aubio_peakpicker_t* p);
216 void del_aubio_peakpicker(aubio_peakpicker_t * p);
217 uint_t aubio_peakpicker_set_threshold(aubio_peakpicker_t * p, smpl_t threshold);
218 smpl_t aubio_peakpicker_get_threshold(aubio_peakpicker_t * p);
219
220 /* transient/steady state separation */
221 aubio_tss_t *new_aubio_tss (uint_t win_s, uint_t hop_s, uint_t channels);
222 void del_aubio_tss (aubio_tss_t * s);
223 void aubio_tss_do (aubio_tss_t * s, cvec_t * input, cvec_t * trans,
224     cvec_t * stead);
225 uint_t aubio_tss_set_threshold (aubio_tss_t * o, smpl_t thrs);
226 uint_t aubio_tss_set_alpha (aubio_tss_t * o, smpl_t alpha);
227 uint_t aubio_tss_set_beta (aubio_tss_t * o, smpl_t beta);
228
229 /* beattracking */
230 aubio_beattracking_t * new_aubio_beattracking(uint_t winlen, uint_t channels);
231 void aubio_beattracking_do(aubio_beattracking_t * bt, fvec_t * dfframes, fvec_t * out);
232 void del_aubio_beattracking(aubio_beattracking_t * p);
233 smpl_t aubio_beattracking_get_bpm(aubio_beattracking_t * p);
234 smpl_t aubio_beattracking_get_confidence(aubio_beattracking_t * p);
235
236 /* tempo */
237 typedef struct _aubio_tempo_t aubio_tempo_t;
238 aubio_tempo_t * new_aubio_tempo (char_t * mode,
239     uint_t buf_size, uint_t hop_size, uint_t channels, uint_t samplerate);
240 void aubio_tempo_do (aubio_tempo_t *o, fvec_t * input, fvec_t * tempo);
241 uint_t aubio_tempo_set_silence(aubio_tempo_t * o, smpl_t silence);
242 uint_t aubio_tempo_set_threshold(aubio_tempo_t * o, smpl_t threshold);
243 smpl_t aubio_tempo_get_bpm(aubio_tempo_t * bt);
244 smpl_t aubio_tempo_get_confidence(aubio_tempo_t * bt);
245 void del_aubio_tempo(aubio_tempo_t * o);
246
247 /* sndfile */
248 %{
249 #if HAVE_SNDFILE
250 #include "sndfileio.h"
251 %}
252 extern aubio_sndfile_t * new_aubio_sndfile_ro (const char * inputfile);
253 extern aubio_sndfile_t * new_aubio_sndfile_wo(aubio_sndfile_t * existingfile, const char * outputname);
254 extern void aubio_sndfile_info(aubio_sndfile_t * file);
255 extern int aubio_sndfile_write(aubio_sndfile_t * file, int frames, fvec_t * write);
256 extern int aubio_sndfile_read(aubio_sndfile_t * file, int frames, fvec_t * read);
257 extern int del_aubio_sndfile(aubio_sndfile_t * file);
258 extern uint_t aubio_sndfile_channels(aubio_sndfile_t * file);
259 extern uint_t aubio_sndfile_samplerate(aubio_sndfile_t * file);
260 %{
261 #endif /* HAVE_SNDFILE */
262 %}