src/types.h: add some documentation, use HAVE_AUBIO_DOUBLE, not AUBIO_SINGLE_PRECISION
[aubio.git] / swig / aubio.i
1 %module aubiowrapper
2
3 %{
4         #include "aubio.h"
5         #include "aubioext.h"
6 %}
7
8 #include "aubio.h"
9 #include "aubioext.h"
10
11 /* type aliases */
12 typedef unsigned int uint_t;
13 typedef int sint_t;
14 typedef float smpl_t;
15
16 /* fvec */
17 extern fvec_t * new_fvec(uint_t length, uint_t channels);
18 extern void del_fvec(fvec_t *s);
19 smpl_t fvec_read_sample(fvec_t *s, uint_t channel, uint_t position);
20 void fvec_write_sample(fvec_t *s, smpl_t data, uint_t channel, uint_t position);
21 smpl_t * fvec_get_channel(fvec_t *s, uint_t channel);
22 void fvec_put_channel(fvec_t *s, smpl_t * data, uint_t channel);
23 smpl_t ** fvec_get_data(fvec_t *s);
24
25 /* another way, passing -c++ option to swig */
26 /*
27 class fvec_t{
28 public:
29     %extend {
30         fvec_t(uint_t length, uint_t channels){
31             return new_fvec(length, channels);
32         }
33         ~fvec_t() {
34             del_fvec(self);
35         }
36         smpl_t get( uint_t channel, uint_t position) {
37             return fvec_read_sample(self,channel,position);
38         }
39         void set( smpl_t data, uint_t channel, uint_t position) {
40             fvec_write_sample(self, data, channel, position); 
41         }
42         #smpl_t * fvec_get_channel(fvec_t *s, uint_t channel);
43         #void fvec_put_channel(fvec_t *s, smpl_t * data, uint_t channel);
44     }
45 };
46 */
47
48 /* cvec */
49 extern cvec_t * new_cvec(uint_t length, uint_t channels);
50 extern void del_cvec(cvec_t *s);
51 extern void cvec_write_norm(cvec_t *s, smpl_t data, uint_t channel, uint_t position);
52 extern void cvec_write_phas(cvec_t *s, smpl_t data, uint_t channel, uint_t position);
53 extern smpl_t cvec_read_norm(cvec_t *s, uint_t channel, uint_t position);
54 extern smpl_t cvec_read_phas(cvec_t *s, uint_t channel, uint_t position);
55 extern void cvec_put_norm_channel(cvec_t *s, smpl_t * data, uint_t channel);
56 extern void cvec_put_phas_channel(cvec_t *s, smpl_t * data, uint_t channel);
57 extern smpl_t * cvec_get_norm_channel(cvec_t *s, uint_t channel);
58 extern smpl_t * cvec_get_phas_channel(cvec_t *s, uint_t channel);
59 extern smpl_t ** cvec_get_norm(cvec_t *s);
60 extern smpl_t ** cvec_get_phas(cvec_t *s);
61
62
63 /* sndfile */
64 extern aubio_sndfile_t * new_aubio_sndfile_ro (const char * inputfile);
65 extern aubio_sndfile_t * new_aubio_sndfile_wo(aubio_sndfile_t * existingfile, const char * outputname);
66 extern void aubio_sndfile_info(aubio_sndfile_t * file);
67 extern int aubio_sndfile_write(aubio_sndfile_t * file, int frames, fvec_t * write);
68 extern int aubio_sndfile_read(aubio_sndfile_t * file, int frames, fvec_t * read);
69 extern int del_aubio_sndfile(aubio_sndfile_t * file);
70 extern uint_t aubio_sndfile_channels(aubio_sndfile_t * file);
71 extern uint_t aubio_sndfile_samplerate(aubio_sndfile_t * file);
72
73 /* fft */
74 extern aubio_fft_t * new_aubio_fft(uint_t size, uint_t channels);
75 extern void del_aubio_fft(aubio_fft_t * s);
76 extern void aubio_fft_do (aubio_fft_t *s, fvec_t * input, cvec_t * spectrum);
77 extern void aubio_fft_rdo (aubio_fft_t *s, cvec_t * spectrum, fvec_t * output);
78 extern void aubio_fft_do_complex (aubio_fft_t *s, fvec_t * input, fvec_t * compspec);
79 extern void aubio_fft_rdo_complex (aubio_fft_t *s, fvec_t * compspec, fvec_t * output);
80 extern void aubio_fft_get_spectrum(fvec_t * compspec, cvec_t * spectrum);
81 extern void aubio_fft_get_realimag(cvec_t * spectrum, fvec_t * compspec);
82 extern void aubio_fft_get_phas(fvec_t * compspec, cvec_t * spectrum);
83 extern void aubio_fft_get_imag(cvec_t * spectrum, fvec_t * compspec);
84 extern void aubio_fft_get_norm(fvec_t * compspec, cvec_t * spectrum);
85 extern void aubio_fft_get_real(cvec_t * spectrum, fvec_t * compspec);
86
87 /* filter */
88 extern aubio_filter_t * new_aubio_filter(uint_t samplerate, uint_t order, uint_t channels);
89 extern void aubio_filter_do(aubio_filter_t * b, fvec_t * in);
90 extern void aubio_filter_do_outplace(aubio_filter_t * b, fvec_t * in, fvec_t * out);
91 extern void aubio_filter_do_filtfilt(aubio_filter_t * b, fvec_t * in, fvec_t * tmp);
92 extern void del_aubio_filter(aubio_filter_t * b);
93
94 extern aubio_filter_t * new_aubio_adsgn_filter(uint_t samplerate, uint_t channels);
95 extern void aubio_adsgn_filter_do(aubio_filter_t * b, fvec_t * in);
96 extern void del_aubio_adsgn_filter(aubio_filter_t * b);
97
98 extern aubio_filter_t * new_aubio_cdsgn_filter(uint_t samplerate, uint_t channels);
99 extern void aubio_cdsgn_filter_do(aubio_filter_t * b, fvec_t * in);
100 extern void del_aubio_cdsgn_filter(aubio_filter_t * b);
101
102 /* biquad */
103 extern aubio_biquad_t * new_aubio_biquad(lsmp_t b1, lsmp_t b2, lsmp_t b3, lsmp_t a2, lsmp_t a3);
104 extern void aubio_biquad_do(aubio_biquad_t * b, fvec_t * in);
105 extern void aubio_biquad_do_filtfilt(aubio_biquad_t * b, fvec_t * in, fvec_t * tmp);
106 extern void del_aubio_biquad(aubio_biquad_t * b);
107
108 /* hist */
109 extern aubio_hist_t * new_aubio_hist(smpl_t flow, smpl_t fhig, uint_t nelems, uint_t channels);
110 extern void del_aubio_hist(aubio_hist_t *s);
111 extern void aubio_hist_do(aubio_hist_t *s, fvec_t * input);
112 extern void aubio_hist_do_notnull(aubio_hist_t *s, fvec_t * input);
113 extern void aubio_hist_dyn_notnull(aubio_hist_t *s, fvec_t *input);
114 extern void aubio_hist_weight(aubio_hist_t *s);
115 extern smpl_t aubio_hist_mean(aubio_hist_t *s);
116
117 /* mathutils */
118 typedef enum {
119         aubio_win_rectangle,
120         aubio_win_hamming,
121         aubio_win_hanning,
122         aubio_win_hanningz,
123         aubio_win_blackman,
124         aubio_win_blackman_harris,
125         aubio_win_gaussian,
126         aubio_win_welch,
127         aubio_win_parzen
128 } aubio_window_type;
129
130 fvec_t * new_aubio_window(uint_t size, aubio_window_type wintype);
131 smpl_t aubio_unwrap2pi (smpl_t phase);
132 smpl_t vec_mean(fvec_t *s);
133 smpl_t vec_max(fvec_t *s);
134 smpl_t vec_min(fvec_t *s);
135 uint_t vec_min_elem(fvec_t *s);
136 uint_t vec_max_elem(fvec_t *s);
137 void vec_shift(fvec_t *s);
138 smpl_t vec_sum(fvec_t *s);
139 smpl_t vec_local_energy(fvec_t * f);
140 smpl_t vec_local_hfc(fvec_t * f);
141 smpl_t vec_alpha_norm(fvec_t * DF, smpl_t alpha);
142 void vec_dc_removal(fvec_t * mag);
143 void vec_alpha_normalise(fvec_t * mag, uint_t alpha);
144 void vec_add(fvec_t * mag, smpl_t threshold);
145 void vec_adapt_thres(fvec_t * vec, fvec_t * tmp, uint_t post, uint_t pre);
146 smpl_t vec_moving_thres(fvec_t * vec, fvec_t * tmp, uint_t post, uint_t pre, uint_t pos);
147 smpl_t vec_median(fvec_t * input);
148 smpl_t vec_quadint(fvec_t * x,uint_t pos, uint_t span);
149 smpl_t aubio_quadfrac(smpl_t s0, smpl_t s1, smpl_t s2, smpl_t pf);
150 uint_t vec_peakpick(fvec_t * input, uint_t pos);
151 smpl_t aubio_bintomidi(smpl_t bin, smpl_t samplerate, smpl_t fftsize);
152 smpl_t aubio_miditobin(smpl_t midi, smpl_t samplerate, smpl_t fftsize);
153 smpl_t aubio_bintofreq(smpl_t bin, smpl_t samplerate, smpl_t fftsize);
154 smpl_t aubio_freqtobin(smpl_t freq, smpl_t samplerate, smpl_t fftsize);
155 smpl_t aubio_freqtomidi(smpl_t freq);
156 smpl_t aubio_miditofreq(smpl_t midi);
157 uint_t aubio_silence_detection(fvec_t * ibuf, smpl_t threshold);
158 smpl_t aubio_level_detection(fvec_t * ibuf, smpl_t threshold);
159 void aubio_autocorr(fvec_t * in, fvec_t * acf);
160 smpl_t aubio_zero_crossing_rate(fvec_t * input);
161 smpl_t aubio_spectral_centroid(cvec_t * spectrum, smpl_t samplerate);
162
163 /* filterbank */
164 aubio_filterbank_t * new_aubio_filterbank(uint_t win_s, uint_t channels);
165 void aubio_filterbank_set_mel_coeffs(aubio_filterbank_t *fb, fvec_t *freqs, uint_t samplerate);
166 void aubio_filterbank_set_mel_coeffs_slaney(aubio_filterbank_t *fb, uint_t samplerate);
167 void del_aubio_filterbank(aubio_filterbank_t * fb);
168 void aubio_filterbank_do(aubio_filterbank_t * fb, cvec_t * in, fvec_t *out);
169 fvec_t * aubio_filterbank_get_coeffs(aubio_filterbank_t * fb);
170
171 /* mfcc */
172 aubio_mfcc_t * new_aubio_mfcc (uint_t win_s, uint_t samplerate, uint_t n_filters, uint_t n_coefs);
173 void del_aubio_mfcc(aubio_mfcc_t *mf);
174 void aubio_mfcc_do(aubio_mfcc_t *mf, cvec_t *in, fvec_t *out);
175
176 /* scale */
177 extern aubio_scale_t * new_aubio_scale(smpl_t flow, smpl_t fhig, smpl_t ilow, smpl_t ihig);
178 extern void aubio_scale_set (aubio_scale_t *s, smpl_t ilow, smpl_t ihig, smpl_t olow, smpl_t ohig);
179 extern void aubio_scale_do(aubio_scale_t *s, fvec_t * input);
180 extern void del_aubio_scale(aubio_scale_t *s);
181
182 /* resampling */
183 extern aubio_resampler_t * new_aubio_resampler(float ratio, uint_t type);
184 extern uint_t aubio_resampler_process(aubio_resampler_t *s, fvec_t * input,  fvec_t * output);
185 extern void del_aubio_resampler(aubio_resampler_t *s);
186
187 /* onset detection */
188 typedef enum { 
189         aubio_onset_energy, 
190         aubio_onset_specdiff, 
191         aubio_onset_hfc, 
192         aubio_onset_complex, 
193         aubio_onset_phase, 
194         aubio_onset_kl, 
195         aubio_onset_mkl, 
196         aubio_onset_specflux,
197 } aubio_onsetdetection_type;
198 aubio_onsetdetection_t * new_aubio_onsetdetection(aubio_onsetdetection_type type, uint_t size, uint_t channels);
199 void aubio_onsetdetection(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
200 void del_aubio_onsetdetection(aubio_onsetdetection_t *o);
201
202 /* should these still be exposed ? */
203 void aubio_onsetdetection_energy  (aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
204 void aubio_onsetdetection_hfc     (aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
205 void aubio_onsetdetection_complex (aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
206 void aubio_onsetdetection_phase   (aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
207 void aubio_onsetdetection_specdiff(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
208 void aubio_onsetdetection_kl      (aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
209 void aubio_onsetdetection_mkl     (aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
210
211 /* pvoc */
212 aubio_pvoc_t * new_aubio_pvoc (uint_t win_s, uint_t hop_s, uint_t channels);
213 void del_aubio_pvoc(aubio_pvoc_t *pv);
214 void aubio_pvoc_do(aubio_pvoc_t *pv, fvec_t *in, cvec_t * fftgrain);
215 void aubio_pvoc_rdo(aubio_pvoc_t *pv, cvec_t * fftgrain, fvec_t *out);
216
217 /* pitch detection */
218 typedef enum {
219         aubio_pitch_yin,
220         aubio_pitch_mcomb,
221         aubio_pitch_schmitt,
222         aubio_pitch_fcomb,
223         aubio_pitch_yinfft
224 } aubio_pitchdetection_type;
225
226 typedef enum {
227         aubio_pitchm_freq,
228         aubio_pitchm_midi,
229         aubio_pitchm_cent,
230         aubio_pitchm_bin
231 } aubio_pitchdetection_mode;
232
233 smpl_t aubio_pitchdetection(aubio_pitchdetection_t * p, fvec_t * ibuf);
234
235 void aubio_pitchdetection_set_yinthresh(aubio_pitchdetection_t *p, smpl_t thres);
236
237 void del_aubio_pitchdetection(aubio_pitchdetection_t * p);
238
239 aubio_pitchdetection_t * new_aubio_pitchdetection(uint_t bufsize, 
240     uint_t hopsize, 
241     uint_t channels,
242     uint_t samplerate,
243     aubio_pitchdetection_type type,
244     aubio_pitchdetection_mode mode);
245
246
247 /* pitch mcomb */
248 aubio_pitchmcomb_t * new_aubio_pitchmcomb(uint_t bufsize, uint_t hopsize, uint_t channels, uint_t samplerate);
249 smpl_t aubio_pitchmcomb_detect(aubio_pitchmcomb_t * p, cvec_t * fftgrain);
250 uint_t aubio_pitch_cands(aubio_pitchmcomb_t * p, cvec_t * fftgrain, smpl_t * cands);
251 void del_aubio_pitchmcomb (aubio_pitchmcomb_t *p);
252
253 /* pitch yin */
254 void aubio_pitchyin_diff(fvec_t *input, fvec_t *yin);
255 void aubio_pitchyin_getcum(fvec_t *yin);
256 uint_t aubio_pitchyin_getpitch(fvec_t *yin);
257 smpl_t aubio_pitchyin_getpitchfast(fvec_t * input, fvec_t *yin, smpl_t tol);
258
259 /* pitch schmitt */
260 aubio_pitchschmitt_t * new_aubio_pitchschmitt (uint_t size, uint_t samplerate);
261 smpl_t aubio_pitchschmitt_detect (aubio_pitchschmitt_t *p, fvec_t * input);
262 void del_aubio_pitchschmitt (aubio_pitchschmitt_t *p);
263
264 /* pitch fcomb */
265 aubio_pitchfcomb_t * new_aubio_pitchfcomb (uint_t size, uint_t hopsize, uint_t samplerate);
266 smpl_t aubio_pitchfcomb_detect (aubio_pitchfcomb_t *p, fvec_t * input);
267 void del_aubio_pitchfcomb (aubio_pitchfcomb_t *p);
268
269 /* peakpicker */
270 aubio_pickpeak_t * new_aubio_peakpicker(smpl_t threshold);
271 uint_t aubio_peakpick_pimrt(fvec_t * DF, aubio_pickpeak_t * p);
272 uint_t aubio_peakpick_pimrt_wt( fvec_t* DF, aubio_pickpeak_t* p, smpl_t* peakval );
273 smpl_t aubio_peakpick_pimrt_getval(aubio_pickpeak_t* p);
274 void del_aubio_peakpicker(aubio_pickpeak_t * p);
275 void aubio_peakpicker_set_threshold(aubio_pickpeak_t * p, smpl_t threshold);
276 smpl_t aubio_peakpicker_get_threshold(aubio_pickpeak_t * p);
277
278 /* transient/steady state separation */
279 aubio_tss_t * new_aubio_tss(smpl_t thrs, smpl_t alfa, smpl_t beta,
280     uint_t size, uint_t overlap,uint_t channels);
281 void del_aubio_tss(aubio_tss_t *s);
282 void aubio_tss_do(aubio_tss_t *s, cvec_t * input, cvec_t * trans, cvec_t * stead);
283
284 /* beattracking */
285 aubio_beattracking_t * new_aubio_beattracking(uint_t winlen, uint_t channels);
286 void aubio_beattracking_do(aubio_beattracking_t * bt, fvec_t * dfframes, fvec_t * out);
287 void del_aubio_beattracking(aubio_beattracking_t * p);
288 smpl_t aubio_beattracking_get_bpm(aubio_beattracking_t * p);
289 smpl_t aubio_beattracking_get_confidence(aubio_beattracking_t * p);
290