help/aubioonset~-help.pd: document new parameters

[pd-aubio.git] / help / aubioonset~-help.pd

diff --git a/help/aubioonset~-help.pd b/help/aubioonset~-help.pd
index 5c2fb9d..776aa37 100644 (file)
--- a/help/aubioonset~-help.pd
+++ b/help/aubioonset~-help.pd
@@ -1,18 +1,44 @@
-#N canvas 245 501 672 291 10;
-#X obj 50 33 adc~;
-#X text 181 26 aubioonset~ takes an input signal and outputs a bang
-when an onset has been detected;
-#X text 180 64 this is somewhat similar to the bonk~ object \, except
-it should work on non-percussive attacks too.;
-#X obj 50 97 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
+#N canvas 341 200 770 398 10;
+#X obj 20 53 adc~;
+#X obj 20 137 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
 -1;
-#X text 182 111 the creation argument and right input can be used to
-set the detection threshold. values between 0 and 10 are accepted.
-low values favorise over-detection. higher values will reduce the number
-of onset detected.;
-#X obj 50 65 aubioonset~ 0.3;
-#X floatatom 128 29 5 0 0 0 - - -;
-#X connect 0 0 5 0;
-#X connect 0 1 5 0;
-#X connect 5 0 3 0;
-#X connect 6 0 5 1;
+#X floatatom 94 65 5 0 0 0 - - -, f 5;
+#X obj 20 107 aubioonset~;
+#X text 55 278 - hopsize: block size of each analysis;
+#X text 156 94 Low values will increase the number of detections. High
+values will reduce them.;
+#X text 50 134 This is somewhat similar to the bonk~ object \, though
+it may work on non-percussive attacks.;
+#X msg 516 188 debug;
+#X obj 516 250 aubioonset~ mkl;
+#X obj 516 230 aubioonset~ 0.7;
+#X obj 516 270 aubioonset~ specdiff 0.8;
+#X obj 516 290 aubioonset~ 0.6 specflux;
+#X obj 516 310 aubioonset~ 9 centroid 1024;
+#X text 50 348 If hopsize is not specified \, it will be set to half
+of bufsize.;
+#X text 156 64 The right inlet can be used to set the onset detection
+threshold. Values between 0 and 10 are accepted.;
+#X text 51 309 All arguments are optional. 'threshold' and 'method'
+\, the first and second arguments \, can be swapped.;
+#X text 416 232 Some examples;
+#X obj 516 330 aubioonset~ complex 0.9 512 32;
+#X obj 516 351 aubioonset~ 0.3 phase 4096 2048;
+#X text 55 258 - bufsize: length of fft window [1024];
+#X text 55 237 - method: could be any specdesc [default];
+#X text 54 217 - threshold: initial threshold [0.3];
+#X text 52 181 The creation arguments can be used to set the onset
+detection parameters.;
+#X text 51 16 aubioonset~ takes an input signal and outputs a bang
+when an 'onset' has been detected.;
+#X connect 0 0 3 0;
+#X connect 0 1 3 0;
+#X connect 2 0 3 1;
+#X connect 3 0 1 0;
+#X connect 7 0 9 0;
+#X connect 7 0 8 0;
+#X connect 7 0 10 0;
+#X connect 7 0 11 0;
+#X connect 7 0 12 0;
+#X connect 7 0 17 0;
+#X connect 7 0 18 0;