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