1 files changed, 134 insertions, 87 deletions
diff --git a/pd/extra/bonk~/bonk~-help.pd b/pd/extra/bonk~/bonk~-help.pd
index e4bbb827..b1b93f62 100644
--- a/pd/extra/bonk~/bonk~-help.pd
+++ b/pd/extra/bonk~/bonk~-help.pd
@@ -1,13 +1,11 @@
-#N canvas 304 143 967 599 12;
-#X obj 358 544 spigot;
-#X msg 442 397 bang;
-#X obj 428 508 bonk~;
-#X msg 442 214 learn 1;
-#X msg 442 274 learn 0;
-#X msg 446 451 print;
-#X obj 390 437 adc~;
-#X msg 613 558 \; pd dsp 1;
-#X obj 276 544 spigot;
+#N canvas 33 37 964 579 12;
+#X obj 382 492 spigot;
+#X msg 452 292 bang;
+#X obj 452 456 bonk~;
+#X msg 452 359 print;
+#X obj 396 429 adc~;
+#X msg 637 506 \; pd dsp 1;
+#X obj 300 492 spigot;
 #N canvas 366 126 604 404 synth 0;
 #X obj 112 24 r bonk-cooked;
 #X obj 112 49 unpack;
@@ -59,67 +57,36 @@
 #X connect 21 0 1 0;
 #X connect 22 0 6 0;
 #X connect 23 0 9 0;
-#X restore 845 575 pd synth;
-#X floatatom 845 552 0 0 0 0 - - -;
-#X msg 845 522 0;
-#X msg 442 244 learn 10;
-#X msg 442 304 forget;
-#X msg 442 334 write templates.txt;
-#X msg 442 364 read templates.txt;
-#X msg 876 522 90;
-#X msg 442 81 thresh 6 50;
-#X text 8 56 The Bonk object takes an audio signal input and looks
-for "attacks" defined as sharp changes in the spectral envelope of
-the incoming sound. Optionally \, and less reliably \, you can have
-Bonk check the attack against a collection of stored templates to try
-to guess which of two or more instruments was hit. Bonk is described
-theoretically in the 1998 ICMC proceedings \, reprinted on http://man104nfs.ucsd.edu/~mpuckett.
-;
-#X text 601 524 click here;
-#X text 602 537 to start DSP;
-#X text 8 377 In this patch \, after starting DSP \, you can print
+#X restore 869 523 pd synth;
+#X floatatom 869 500 0 0 0 0 - - -;
+#X msg 869 470 0;
+#X msg 900 470 90;
+#X text 625 472 click here;
+#X text 626 485 to start DSP;
+#X text 5 284 In this patch \, after starting DSP \, you can print
 out the raw or cooked output using the two "spigots" or listen to a
 synthesizer output by raising its volume.;
-#X text 746 521 output volume;
-#X text 760 539 (0-100);
-#X msg 442 150 mask 4 0.7;
-#X msg 442 184 debounce 0;
-#X text 8 309 Bonk's analysis is carried out on a 256-point window
-(6 msec at 44.1 kHz) and by default the analysis period is 128 samples.
-The analysis period can be specified as Bonk's creation argument but
-must be a multiple of 64;
-#X text 532 185 Minimum time (msec) between attacks;
-#X text 526 136 Describes how energy in each frequency band masks later
+#X text 770 469 output volume;
+#X text 784 487 (0-100);
+#X msg 452 140 mask 4 0.7;
+#X text 547 122 Describes how energy in each frequency band masks later
 energy in the band. Here the masking is total for 4 analysis periods
 and then drops by 0.7 each period.;
-#X text 530 214 Forget all templates and start learning new ones. The
-argument gives the number of times you will hit each instrument (10
-recommended.) Turn on the output volume above for audible feedback
-as you train Bonk. "Learn 0" exits learn mode.;
-#X text 530 298 Forget the last template. In Learn mode \, use "forget"
-to erase and record over a template.;
-#X text 595 334 Write templates to a file in text-editable format.
-;
-#X text 596 364 Read templates from a file.;
-#X text 514 450 Print out all settings and templates.;
-#X msg 442 120 minvel 10;
-#X text 514 392 Poll the current spectrum via "raw" outlet \, You can
+#X text 497 288 Poll the current spectrum via "raw" outlet \, You can
 set a very high threshold if you don't want attacks mixed in.;
-#X msg 437 426 debug 0;
-#X text 514 426 turn debugging on or off.;
-#X obj 325 545 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0
+#X msg 452 333 debug 0;
+#X text 530 333 turn debugging on or off.;
+#X obj 349 493 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0
 1;
-#X obj 407 545 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0
+#X obj 431 493 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0
 1;
-#X obj 358 574 print cooked;
-#X obj 276 574 print raw;
-#X text 158 545 enable printout:;
-#X text 530 121 Minimum "velocity" to output (quieter notes are ignored.)
-;
-#X obj 461 533 s bonk-cooked;
-#X text 218 12 BONK~ - an attack detector for small percussion instruments
+#X obj 382 522 print cooked;
+#X obj 300 522 print raw;
+#X text 182 493 enable printout:;
+#X text 529 204 Minimum "velocity" to output (quieter notes are ignored.)
 ;
-#X text 8 174 Bonk's two outputs are the raw spectrum of the attack
+#X obj 485 481 s bonk-cooked;
+#X text 8 144 Bonk's two outputs are the raw spectrum of the attack
 (provided as a list of 11 numbers giving the signal "loudness" in the
 11 frequency bands used) \, and the "cooked" output which gives only
 an instrument number (counting up from zero) and a "velocity". This
@@ -127,36 +94,116 @@ an instrument number (counting up from zero) and a "velocity". This
 bands \, normalized so that 100 is an attack of amplitude of about
 1 The instrument number is significant only if Bonk has a "template
 set" in memory.;
-#X text 531 47 Set low and high thresholds. Signal growth must exceed
+#X text 549 37 Set low and high thresholds. Signal growth must exceed
 the high one and then fall to the low one to make an attack. The unit
 is the sum of the proportional growth in the 11 filter bands. Proportional
 growth is essentially the logarithmic time derivative.;
-#X text 238 27 (NOTE: this documentation does not yet describe new
-features for Pd 0.42).;
-#X msg 446 479 print 1;
-#X text 514 481 print out filterbank settings;
-#X connect 0 0 40 0;
+#X msg 452 386 print 1;
+#X text 520 388 print out filterbank settings;
+#X text 9 32 The Bonk object takes an audio signal input and looks
+for "attacks" defined as sharp changes in the spectral envelope of
+the incoming sound. Optionally \, and less reliably \, you can have
+Bonk check the attack against a collection of stored templates to try
+to guess which of two or more instruments was hit. Bonk is described
+theoretically in the 1998 ICMC proceedings \, reprinted on crca.ucsd.edu/~msp
+.;
+#N canvas 422 63 701 719 creation-arguments 0;
+#X text 228 14 creation arguments for bonk~;
+#X text 70 272 -npts 256;
+#X text 44 244 default value:;
+#X text 70 308 -hop 128;
+#X text 70 342 -nfilters 11;
+#X text 68 380 -halftones 6;
+#X text 76 514 -overlap 1;
+#X text 79 567 -firstbin 1;
+#X text 71 454 -minbandwidth 1.5;
+#X text 122 147 All frequency parameters are specified in 'bins'. One
+bin is the sample rate divided by the window size. The minimum possible
+bandwidth is 1.5 bins. Higher bandwidths give numerically more robust
+outputs.;
+#X text 43 229 Arguments and;
+#X text 212 270 window size in points;
+#X text 210 306 analysis period ("hop size") in points;
+#X text 212 340 number of filters to use;
+#X text 212 379 desired bandwidth of filters in halftones \, effective
+in the exponentially spaced region. (At lower center frequencies the
+bandwidth is supported by the "minbandwidth" parameter below).;
+#X text 212 511 overlap factor between filters. If 1 \, the filters
+are spaced to line up at their half-power points. Other values specify
+more or fewer filters proportionally.;
+#X text 121 49 bonk~ uses a filterbank whose center frequencies are
+spaced equally at low frequencies and proportionally at high ones -
+i.e. \, they increase linearly \, then exponentially. They are determined
+by the filters' bandwidths and overlap. The bandwidths are specified
+proportionally to frequency but bounded below by a specified minimum.
+;
+#X text 210 455 minimum bandwidth in bins. If the bandwidth specified
+by "halftones" is smaller than this \, this value is used. This must
+be at least 1.5.;
+#X text 212 567 center frequency \, in bins \, of the lowest filter.
+The others are computed from this.;
+#X restore 147 414 pd creation-arguments;
+#N canvas 660 173 579 589 templates 0;
+#X msg 76 197 learn 0;
+#X msg 76 227 forget;
+#X msg 76 257 write templates.txt;
+#X msg 76 287 read templates.txt;
+#X msg 76 107 debounce 0;
+#X msg 76 137 learn 10;
+#X obj 62 431 outlet;
+#X text 155 133 Forget all templates and start learning new ones. The
+argument gives the number of times you will hit each instrument (10
+recommended.) Turn on the output volume above for audible feedback
+as you train Bonk. "Learn 0" exits learn mode.;
+#X text 155 217 Forget the last template. In Learn mode \, use "forget"
+to erase and record over a template.;
+#X text 220 253 Write templates to a file in text-editable format.
+;
+#X text 221 283 Read templates from a file.;
+#X text 157 104 Minimum time (msec) between attacks in learn mode;
+#X connect 0 0 6 0;
+#X connect 1 0 6 0;
+#X connect 2 0 6 0;
+#X connect 3 0 6 0;
+#X connect 4 0 6 0;
+#X connect 5 0 6 0;
+#X restore 469 423 pd templates;
+#X msg 452 70 thresh 2.5 5;
+#X msg 452 175 attack-frames 1;
+#X text 574 176 number of frames over which to measure growth;
+#X text 564 423 more messages for managing templates;
+#X msg 452 203 minvel 7;
+#X msg 452 230 spew 0;
+#X text 519 232 Turn spew mode on/off;
+#X msg 452 257 useloudness 0;
+#X text 558 265 experimental: use alternative loudness units;
+#X text 212 9 BONK~ - attack detection and spectral envelope measurement
+;
+#X text 734 552 Updated for Pd version 0.42;
+#X text 5 343 By default bonk's analysis is carried out on a 256-point
+window (6 msec at 44.1 kHz) and the analysis period is 128 samples.
+These and other parameters may be overridden using creation arguments
+as shown in the subpatch below:;
+#X text 521 358 Print out settings and templates.;
+#X connect 0 0 23 0;
 #X connect 1 0 2 0;
-#X connect 2 0 8 0;
+#X connect 2 0 6 0;
 #X connect 2 1 0 0;
-#X connect 2 1 44 0;
+#X connect 2 1 27 0;
 #X connect 3 0 2 0;
 #X connect 4 0 2 0;
-#X connect 5 0 2 0;
-#X connect 6 0 2 0;
-#X connect 8 0 41 0;
-#X connect 10 0 9 0;
-#X connect 11 0 10 0;
-#X connect 12 0 2 0;
-#X connect 13 0 2 0;
-#X connect 14 0 2 0;
-#X connect 15 0 2 0;
-#X connect 16 0 10 0;
-#X connect 17 0 2 0;
-#X connect 24 0 2 0;
-#X connect 25 0 2 0;
+#X connect 6 0 24 0;
+#X connect 8 0 7 0;
+#X connect 9 0 8 0;
+#X connect 10 0 8 0;
+#X connect 16 0 2 0;
+#X connect 19 0 2 0;
+#X connect 21 0 6 1;
+#X connect 22 0 0 1;
+#X connect 30 0 2 0;
 #X connect 34 0 2 0;
+#X connect 35 0 2 0;
 #X connect 36 0 2 0;
-#X connect 38 0 8 1;
-#X connect 39 0 0 1;
-#X connect 49 0 2 0;
+#X connect 39 0 2 0;
+#X connect 40 0 2 0;
+#X connect 42 0 2 0;