README.md: improve instructions
[pd-aubio.git] / help / aubioonset~-help.pd
1 #N canvas 59 183 770 398 10;
2 #X obj 20 53 adc~;
3 #X obj 20 137 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
4 -1;
5 #X floatatom 94 65 5 0 0 0 - - -, f 5;
6 #X obj 20 107 aubioonset~;
7 #X text 156 94 Low values will increase the number of detections. High
8 values will reduce them.;
9 #X text 50 134 This is somewhat similar to the bonk~ object \, though
10 it may work on non-percussive attacks.;
11 #X msg 516 188 debug;
12 #X obj 516 250 aubioonset~ mkl;
13 #X obj 516 230 aubioonset~ 0.7;
14 #X obj 516 270 aubioonset~ specdiff 0.8;
15 #X obj 516 290 aubioonset~ 0.6 specflux;
16 #X obj 516 310 aubioonset~ 9 centroid 1024;
17 #X text 156 64 The right inlet can be used to set the onset detection
18 threshold. Values between 0 and 10 are accepted.;
19 #X text 51 309 All arguments are optional. 'threshold' and 'method'
20 \, the first and second arguments \, can be swapped.;
21 #X obj 516 330 aubioonset~ complex 0.9 512 32;
22 #X obj 516 351 aubioonset~ 0.3 phase 4096 2048;
23 #X text 55 258 - bufsize: length of fft window [1024];
24 #X text 55 237 - method: could be any specdesc [default];
25 #X text 54 217 - threshold: initial threshold [0.3];
26 #X text 52 181 The creation arguments can be used to set the onset
27 detection parameters.;
28 #X text 51 16 aubioonset~ takes an input signal and outputs a bang
29 when an 'onset' has been detected.;
30 #X text 55 278 - hopsize: block size of each analysis [bufsize/2];
31 #X text 440 232 Examples:;
32 #X text 50 348 If not specified \, hopsize will be set to half of bufsize.
33 Otherwise it should be at most 'bufsize'.;
34 #X connect 0 0 3 0;
35 #X connect 0 1 3 0;
36 #X connect 2 0 3 1;
37 #X connect 3 0 1 0;
38 #X connect 6 0 8 0;
39 #X connect 6 0 7 0;
40 #X connect 6 0 9 0;
41 #X connect 6 0 10 0;
42 #X connect 6 0 11 0;
43 #X connect 6 0 14 0;
44 #X connect 6 0 15 0;