moved jack and sndfile to aubioext
[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
52
53 /* sndfile */
54 extern aubio_file_t * new_file_ro (const char * inputfile);
55 extern aubio_file_t * new_file_wo(aubio_file_t * existingfile, const char * outputname);
56 extern void file_info(aubio_file_t * file);
57 extern int file_write(aubio_file_t * file, int frames, fvec_t * write);
58 extern int file_read(aubio_file_t * file, int frames, fvec_t * read);
59 extern int del_file(aubio_file_t * file);
60 extern uint_t aubio_file_channels(aubio_file_t * file);
61 extern uint_t aubio_file_samplerate(aubio_file_t * file);
62
63 /* fft */
64 extern void aubio_fft_getnorm(smpl_t * norm, fft_data_t * spectrum, uint_t size);
65 extern void aubio_fft_getphas(smpl_t * phase, fft_data_t * spectrum, uint_t size);
66
67 /* filter */
68 extern aubio_filter_t * new_aubio_filter(uint_t samplerate, uint_t order);
69 extern aubio_filter_t * new_aubio_adsgn_filter(uint_t samplerate);
70 extern aubio_filter_t * new_aubio_cdsgn_filter(uint_t samplerate);
71 extern void aubio_filter_do(aubio_filter_t * b, fvec_t * in);
72 extern void aubio_filter_do_outplace(aubio_filter_t * b, fvec_t * in, fvec_t * out);
73 extern void aubio_filter_do_filtfilt(aubio_filter_t * b, fvec_t * in, fvec_t * tmp);
74 /*extern int del_aubio_filter(aubio_filter_t * b);*/
75
76 /* biquad */
77 extern aubio_biquad_t * new_aubio_biquad(lsmp_t b1, lsmp_t b2, lsmp_t b3, lsmp_t a2, lsmp_t a3);
78 extern void aubio_biquad_do(aubio_biquad_t * b, fvec_t * in);
79 extern void aubio_biquad_do_filtfilt(aubio_biquad_t * b, fvec_t * in, fvec_t * tmp);
80 /*extern int del_aubio_biquad(aubio_biquad_t * b);*/
81
82 /* hist */
83 extern aubio_hist_t * new_aubio_hist(smpl_t flow, smpl_t fhig, uint_t nelems, uint_t channels);
84 extern void del_aubio_hist(aubio_hist_t *s);
85 extern void aubio_hist_do(aubio_hist_t *s, fvec_t * input);
86 extern void aubio_hist_do_notnull(aubio_hist_t *s, fvec_t * input);
87 extern void aubio_hist_dyn_notnull (aubio_hist_t *s, fvec_t *input);
88
89 /* mathutils */
90 typedef enum {
91         rectangle,
92         hamming,
93         hanning,
94         hanningz,
95         blackman,
96         blackman_harris,
97         gaussian,
98         welch,
99         parzen
100 } window_type_t;
101
102 void window(smpl_t *w, uint_t size, window_type_t wintype);
103 smpl_t unwrap2pi (smpl_t phase);
104 smpl_t vec_mean(fvec_t *s);
105 smpl_t vec_max(fvec_t *s);
106 smpl_t vec_min(fvec_t *s);
107 uint_t vec_min_elem(fvec_t *s);
108 uint_t vec_max_elem(fvec_t *s);
109 void vec_shift(fvec_t *s);
110 smpl_t vec_sum(fvec_t *s);
111 smpl_t vec_local_energy(fvec_t * f);
112 smpl_t vec_local_hfc(fvec_t * f);
113 smpl_t vec_alpha_norm(fvec_t * DF, smpl_t alpha);
114 void vec_dc_removal(fvec_t * mag);
115 void vec_alpha_normalise(fvec_t * mag, uint_t alpha);
116 void vec_add(fvec_t * mag, smpl_t threshold);
117 void vec_adapt_thres(fvec_t * vec, fvec_t * tmp, uint_t post, uint_t pre);
118 smpl_t vec_moving_thres(fvec_t * vec, fvec_t * tmp, uint_t post, uint_t pre, uint_t pos);
119 smpl_t vec_median(fvec_t * input);
120 smpl_t vec_quadint(fvec_t * x,uint_t pos);
121 smpl_t quadfrac(smpl_t s0, smpl_t s1, smpl_t s2, smpl_t pf);
122 uint_t vec_peakpick(fvec_t * input, uint_t pos);
123 smpl_t bintomidi(smpl_t bin, smpl_t samplerate, smpl_t fftsize);
124 smpl_t bintofreq(smpl_t bin, smpl_t samplerate, smpl_t fftsize);
125 smpl_t freqtomidi(smpl_t freq);
126 uint_t aubio_silence_detection(fvec_t * ibuf, smpl_t threshold);
127 smpl_t aubio_level_detection(fvec_t * ibuf, smpl_t threshold);
128
129 /* scale */
130 extern aubio_scale_t * new_aubio_scale(smpl_t flow, smpl_t fhig, smpl_t ilow, smpl_t ihig       );
131 extern void aubio_scale_set (aubio_scale_t *s, smpl_t ilow, smpl_t ihig, smpl_t olow, smpl_t ohig);
132 extern void aubio_scale_do(aubio_scale_t *s, fvec_t * input);
133 extern void del_aubio_scale(aubio_scale_t *s);
134
135 /* resampling */
136 extern aubio_resampler_t * new_aubio_resampler(float ratio, uint_t type);
137 extern uint_t aubio_resampler_process(aubio_resampler_t *s, fvec_t * input,  fvec_t * output);
138 extern void del_aubio_resampler(aubio_resampler_t *s);
139
140 /* onset detection */
141 typedef enum { energy, specdiff, hfc, complexdomain, phase } aubio_onsetdetection_type;
142 aubio_onsetdetection_t * new_aubio_onsetdetection(aubio_onsetdetection_type type, uint_t size, uint_t channels);
143 void aubio_onsetdetection(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
144 void aubio_onsetdetection_free(aubio_onsetdetection_t *o);
145
146 /* should these still be exposed ? */
147 void aubio_onsetdetection_energy  (aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
148 void aubio_onsetdetection_hfc    (aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
149 void aubio_onsetdetection_complex (aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
150 void aubio_onsetdetection_phase   (aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
151 void aubio_onsetdetection_specdiff(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
152
153 /* pvoc */
154 aubio_pvoc_t * new_aubio_pvoc (uint_t win_s, uint_t hop_s, uint_t channels);
155 void del_aubio_pvoc(aubio_pvoc_t *pv);
156 void aubio_pvoc_do(aubio_pvoc_t *pv, fvec_t *in, cvec_t * fftgrain);
157 void aubio_pvoc_rdo(aubio_pvoc_t *pv, cvec_t * fftgrain, fvec_t *out);
158
159 /* pitch detection */
160
161 /* pitch mcomb */
162 aubio_pitchmcomb_t * new_aubio_pitchmcomb(uint_t size, uint_t channels);
163 smpl_t aubio_pitchmcomb_detect(aubio_pitchmcomb_t * p, cvec_t * fftgrain);
164 uint_t aubio_pitch_cands(aubio_pitchmcomb_t * p, cvec_t * fftgrain, smpl_t * cands);
165
166 /* pitch yin */
167 void aubio_pitchyin_diff(fvec_t *input, fvec_t *yin);
168 void aubio_pitchyin_getcum(fvec_t *yin);
169 uint_t aubio_pitchyin_getpitch(fvec_t *yin);
170
171 /* peakpicker */
172 aubio_pickpeak_t * new_aubio_peakpicker(smpl_t threshold);
173 uint_t aubio_peakpick_pimrt(fvec_t * DF, aubio_pickpeak_t * p);
174 uint_t aubio_peakpick_pimrt_wt( fvec_t* DF, aubio_pickpeak_t* p, smpl_t* peakval );
175 void del_aubio_peakpicker(aubio_pickpeak_t * p);
176
177 /* transient/steady state separation */
178 aubio_tss_t * new_aubio_tss(smpl_t thrs, smpl_t alfa, smpl_t beta,
179     uint_t size, uint_t overlap,uint_t channels);
180 void del_aubio_tss(aubio_tss_t *s);
181 void aubio_tss_do(aubio_tss_t *s, cvec_t * input, cvec_t * trans, cvec_t * stead);
182
183
184 /* jack */
185 #ifdef JACK_SUPPORT
186 extern aubio_jack_t * new_aubio_jack (uint_t inchannels, uint_t outchannels, aubio_process_func_t callback); 
187 typedef int (*aubio_process_func_t)(smpl_t **input, smpl_t **output, int nframes);
188 extern uint_t aubio_jack_activate(aubio_jack_t *jack_setup);
189 extern void aubio_jack_close(aubio_jack_t *jack_setup);
190 #endif 
191
192 /* midi */
193 enum aubio_midi_event_type {
194   /* channel messages */
195   NOTE_OFF = 0x80,
196   NOTE_ON = 0x90,
197   KEY_PRESSURE = 0xa0,
198   CONTROL_CHANGE = 0xb0,
199   PROGRAM_CHANGE = 0xc0,
200   CHANNEL_PRESSURE = 0xd0,
201   PITCH_BEND = 0xe0,
202   /* system exclusive */
203   MIDI_SYSEX = 0xf0,
204   /* system common - never in midi files */
205   MIDI_TIME_CODE = 0xf1,
206   MIDI_SONG_POSITION = 0xf2,
207   MIDI_SONG_SELECT = 0xf3,
208   MIDI_TUNE_REQUEST = 0xf6,
209   MIDI_EOX = 0xf7,
210   /* system real-time - never in midi files */
211   MIDI_SYNC = 0xf8,
212   MIDI_TICK = 0xf9,
213   MIDI_START = 0xfa,
214   MIDI_CONTINUE = 0xfb,
215   MIDI_STOP = 0xfc,
216   MIDI_ACTIVE_SENSING = 0xfe,
217   MIDI_SYSTEM_RESET = 0xff,
218   /* meta event - for midi files only */
219   MIDI_META_EVENT = 0xff
220 };
221
222 enum aubio_midi_control_change {
223   BANK_SELECT_MSB = 0x00,
224   MODULATION_MSB = 0x01,
225   BREATH_MSB = 0x02,
226   FOOT_MSB = 0x04,
227   PORTAMENTO_TIME_MSB = 0x05,
228   DATA_ENTRY_MSB = 0x06,
229   VOLUME_MSB = 0x07,
230   BALANCE_MSB = 0x08,
231   PAN_MSB = 0x0A,
232   EXPRESSION_MSB = 0x0B,
233   EFFECTS1_MSB = 0x0C,
234   EFFECTS2_MSB = 0x0D,
235   GPC1_MSB = 0x10, /* general purpose controller */
236   GPC2_MSB = 0x11,
237   GPC3_MSB = 0x12,
238   GPC4_MSB = 0x13,
239   BANK_SELECT_LSB = 0x20,
240   MODULATION_WHEEL_LSB = 0x21,
241   BREATH_LSB = 0x22,
242   FOOT_LSB = 0x24,
243   PORTAMENTO_TIME_LSB = 0x25,
244   DATA_ENTRY_LSB = 0x26,
245   VOLUME_LSB = 0x27,
246   BALANCE_LSB = 0x28,
247   PAN_LSB = 0x2A,
248   EXPRESSION_LSB = 0x2B,
249   EFFECTS1_LSB = 0x2C,
250   EFFECTS2_LSB = 0x2D,
251   GPC1_LSB = 0x30,
252   GPC2_LSB = 0x31,
253   GPC3_LSB = 0x32,
254   GPC4_LSB = 0x33,
255   SUSTAIN_SWITCH = 0x40,
256   PORTAMENTO_SWITCH = 0x41,
257   SOSTENUTO_SWITCH = 0x42,
258   SOFT_PEDAL_SWITCH = 0x43,
259   LEGATO_SWITCH = 0x45,
260   HOLD2_SWITCH = 0x45,
261   SOUND_CTRL1 = 0x46,
262   SOUND_CTRL2 = 0x47,
263   SOUND_CTRL3 = 0x48,
264   SOUND_CTRL4 = 0x49,
265   SOUND_CTRL5 = 0x4A,
266   SOUND_CTRL6 = 0x4B,
267   SOUND_CTRL7 = 0x4C,
268   SOUND_CTRL8 = 0x4D,
269   SOUND_CTRL9 = 0x4E,
270   SOUND_CTRL10 = 0x4F,
271   GPC5 = 0x50,
272   GPC6 = 0x51,
273   GPC7 = 0x52,
274   GPC8 = 0x53,
275   PORTAMENTO_CTRL = 0x54,
276   EFFECTS_DEPTH1 = 0x5B,
277   EFFECTS_DEPTH2 = 0x5C,
278   EFFECTS_DEPTH3 = 0x5D,
279   EFFECTS_DEPTH4 = 0x5E,
280   EFFECTS_DEPTH5 = 0x5F,
281   DATA_ENTRY_INCR = 0x60,
282   DATA_ENTRY_DECR = 0x61,
283   NRPN_LSB = 0x62,
284   NRPN_MSB = 0x63,
285   RPN_LSB = 0x64,
286   RPN_MSB = 0x65,
287   ALL_SOUND_OFF = 0x78,
288   ALL_CTRL_OFF = 0x79,
289   LOCAL_CONTROL = 0x7A,
290   ALL_NOTES_OFF = 0x7B,
291   OMNI_OFF = 0x7C,
292   OMNI_ON = 0x7D,
293   POLY_OFF = 0x7E,
294   POLY_ON = 0x7F
295 };
296
297 enum midi_meta_event {
298   MIDI_COPYRIGHT = 0x02,
299   MIDI_TRACK_NAME = 0x03,
300   MIDI_INST_NAME = 0x04,
301   MIDI_LYRIC = 0x05,
302   MIDI_MARKER = 0x06,
303   MIDI_CUE_POINT = 0x07,
304   MIDI_EOT = 0x2f,
305   MIDI_SET_TEMPO = 0x51,
306   MIDI_SMPTE_OFFSET = 0x54,
307   MIDI_TIME_SIGNATURE = 0x58,
308   MIDI_KEY_SIGNATURE = 0x59,
309   MIDI_SEQUENCER_EVENT = 0x7f
310 };
311
312 enum aubio_player_status 
313 {
314   AUBIO_MIDI_PLAYER_READY,
315   AUBIO_MIDI_PLAYER_PLAYING,
316   AUBIO_MIDI_PLAYER_DONE
317 };
318
319 enum aubio_driver_status 
320 {
321   AUBIO_MIDI_READY,
322   AUBIO_MIDI_LISTENING,
323   AUBIO_MIDI_DONE
324 };
325
326 /* midi event */
327 aubio_midi_event_t* new_aubio_midi_event(void);
328 int del_aubio_midi_event(aubio_midi_event_t* event);
329 int aubio_midi_event_set_type(aubio_midi_event_t* evt, int type);
330 int aubio_midi_event_get_type(aubio_midi_event_t* evt);
331 int aubio_midi_event_set_channel(aubio_midi_event_t* evt, int chan);
332 int aubio_midi_event_get_channel(aubio_midi_event_t* evt);
333 int aubio_midi_event_get_key(aubio_midi_event_t* evt);
334 int aubio_midi_event_set_key(aubio_midi_event_t* evt, int key);
335 int aubio_midi_event_get_velocity(aubio_midi_event_t* evt);
336 int aubio_midi_event_set_velocity(aubio_midi_event_t* evt, int vel);
337 int aubio_midi_event_get_control(aubio_midi_event_t* evt);
338 int aubio_midi_event_set_control(aubio_midi_event_t* evt, int ctrl);
339 int aubio_midi_event_get_value(aubio_midi_event_t* evt);
340 int aubio_midi_event_set_value(aubio_midi_event_t* evt, int val);
341 int aubio_midi_event_get_program(aubio_midi_event_t* evt);
342 int aubio_midi_event_set_program(aubio_midi_event_t* evt, int val);
343 int aubio_midi_event_get_pitch(aubio_midi_event_t* evt);
344 int aubio_midi_event_set_pitch(aubio_midi_event_t* evt, int val);
345 int aubio_midi_event_length(unsigned char status);
346
347 /* midi track */
348 aubio_track_t* new_aubio_track(int num);
349 int del_aubio_track(aubio_track_t* track);
350 int aubio_track_set_name(aubio_track_t* track, char* name);
351 char* aubio_track_get_name(aubio_track_t* track);
352 int aubio_track_add_event(aubio_track_t* track, aubio_midi_event_t* evt);
353 aubio_midi_event_t* aubio_track_first_event(aubio_track_t* track);
354 aubio_midi_event_t* aubio_track_next_event(aubio_track_t* track);
355 int aubio_track_get_duration(aubio_track_t* track);
356 int aubio_track_reset(aubio_track_t* track);
357 int aubio_track_count_events(aubio_track_t* track, int* on, int* off);
358
359 /* midi player */
360 aubio_midi_player_t* new_aubio_midi_player(void);
361 sint_t del_aubio_midi_player(aubio_midi_player_t* player);
362 sint_t aubio_midi_player_reset(aubio_midi_player_t* player);
363 sint_t aubio_midi_player_add_track(aubio_midi_player_t* player, aubio_track_t* track);
364 sint_t aubio_midi_player_count_tracks(aubio_midi_player_t* player);
365 aubio_track_t* aubio_midi_player_get_track(aubio_midi_player_t* player, sint_t i);
366 sint_t aubio_midi_player_add(aubio_midi_player_t* player, char* midifile);
367 sint_t aubio_midi_player_load(aubio_midi_player_t* player, char *filename);
368 sint_t aubio_midi_player_callback(void* data, uint_t msec);
369 sint_t aubio_midi_player_play(aubio_midi_player_t* player);
370 sint_t aubio_midi_player_play_offline(aubio_midi_player_t* player);
371 sint_t aubio_midi_player_stop(aubio_midi_player_t* player);
372 sint_t aubio_midi_player_set_loop(aubio_midi_player_t* player, sint_t loop);
373 sint_t aubio_midi_player_set_midi_tempo(aubio_midi_player_t* player, sint_t tempo);
374 sint_t aubio_midi_player_set_bpm(aubio_midi_player_t* player, sint_t bpm);
375 sint_t aubio_midi_player_join(aubio_midi_player_t* player);
376 sint_t aubio_track_send_events(aubio_track_t* track, 
377 /*  aubio_synth_t* synth, */
378                            aubio_midi_player_t* player,
379                            uint_t ticks);
380 sint_t aubio_midi_send_event(aubio_midi_player_t* player, aubio_midi_event_t* event);
381
382 /* midi parser */
383 aubio_midi_parser_t* new_aubio_midi_parser(void);
384 int del_aubio_midi_parser(aubio_midi_parser_t* parser);
385 aubio_midi_event_t* aubio_midi_parser_parse(aubio_midi_parser_t* parser, unsigned char c);
386
387 /* midi file */
388 aubio_midi_file_t* new_aubio_midi_file(char* filename);
389 void del_aubio_midi_file(aubio_midi_file_t* mf);
390 int aubio_midi_file_read_mthd(aubio_midi_file_t* midifile);
391 int aubio_midi_file_load_tracks(aubio_midi_file_t* midifile, aubio_midi_player_t* player);
392 int aubio_midi_file_read_track(aubio_midi_file_t* mf, aubio_midi_player_t* player, int num);
393 int aubio_midi_file_read_event(aubio_midi_file_t* mf, aubio_track_t* track);
394 int aubio_midi_file_read_varlen(aubio_midi_file_t* mf);
395 int aubio_midi_file_getc(aubio_midi_file_t* mf);
396 int aubio_midi_file_push(aubio_midi_file_t* mf, int c);
397 int aubio_midi_file_read(aubio_midi_file_t* mf, void* buf, int len);
398 int aubio_midi_file_skip(aubio_midi_file_t* mf, int len);
399 int aubio_midi_file_read_tracklen(aubio_midi_file_t* mf);
400 int aubio_midi_file_eot(aubio_midi_file_t* mf);
401 int aubio_midi_file_get_division(aubio_midi_file_t* midifile);
402
403
404 /* midi driver */
405 aubio_midi_driver_t* new_aubio_midi_driver(char * name,
406         handle_midi_event_func_t handler, void* event_handler_data);
407 typedef int* (handle_midi_event_func_t) (void* data, aubio_midi_event_t* event);
408 void del_aubio_midi_driver(aubio_midi_driver_t* driver);
409 void aubio_midi_driver_settings(aubio_settings_t* settings);
410
411 /* timer */
412 /*
413 extern aubio_timer_t* new_aubio_timer(int msec, int * callback, 
414                         void* data, int new_thread, int auto_destroy);
415 extern int aubio_timer_join(aubio_timer_t* timer);
416 extern int aubio_timer_stop(aubio_timer_t* timer);
417 extern int delete_aubio_timer(aubio_timer_t* timer);
418 extern void * aubio_timer_start(void * data);
419 extern void aubio_time_config(void);
420 */
421
422 /* list */
423 /*
424 extern struct aubio_list_t* new_aubio_list(void);
425 extern void del_aubio_list(struct aubio_list_t *list);
426 extern void del_aubio_list1(struct aubio_list_t *list);
427 #extern struct aubio_list_t* aubio_list_sort(struct aubio_list_t *list, aubio_compare_func_t compare_func);
428 extern struct aubio_list_t* aubio_list_append(struct aubio_list_t *list, void* data);
429 extern struct aubio_list_t* aubio_list_prepend(struct aubio_list_t *list, void* data);
430 extern struct aubio_list_t* aubio_list_remove(struct aubio_list_t *list, void* data);
431 extern struct aubio_list_t* aubio_list_remove_link(struct aubio_list_t *list, struct aubio_list_t *llink);
432 extern struct aubio_list_t* aubio_list_nth(struct aubio_list_t *list, int n);
433 extern struct aubio_list_t* aubio_list_last(struct aubio_list_t *list);
434 extern struct aubio_list_t* aubio_list_insert_at(struct aubio_list_t *list, int n, void* data);
435 */