README.md: improve instructions
[pd-aubio.git] / help / aubiopitch~-help.pd
1 #N canvas 543 255 812 435 10;
2 #X floatatom 141 194 5 0 0 0 - - -, f 5;
3 #X obj 14 138 osc~ 440;
4 #X obj 17 81 hsl 128 15 0 127 0 1 empty empty empty -2 -6 0 8 -262144
5 -1 -1 5700 1;
6 #X obj 14 101 mtof;
7 #X floatatom 14 121 5 0 0 0 - - -, f 5;
8 #X obj 13 244 dac~;
9 #X obj 141 215 osc~;
10 #X msg 211 76 tolerance 0.2;
11 #X msg 211 100 tol 0.7;
12 #X msg 211 123 tol;
13 #X text 14 21 aubiopitch~ tracks the 'pitch' or fundamental frequency
14 of the input signal.;
15 #X msg 48 59 69;
16 #X msg 82 59 72.1;
17 #X text 185 193 detected pitch (Hz);
18 #X text 59 119 test pitch (Hz);
19 #X text 69 324 - bufsize: length of fft window [1024];
20 #X text 69 344 - hopsize: block size of each analysis [bufsize/2];
21 #X text 329 73 For yin and yinfft methods \, a 'tolerance' message
22 can be sent to change the default tolerance value.;
23 #X msg 557 233 debug;
24 #X obj 141 170 aubiopitch~ fcomb 1024 128;
25 #X text 483 256 Examples:;
26 #X text 70 292 - method: can be 'yin' \, 'yinfft' \, 'mcomb' \, 'fcomb'
27 \, 'schmitt' \, or 'default' [default];
28 #X msg 14 59 57;
29 #X obj 557 255 aubiopitch~ yinfft;
30 #X obj 557 276 aubiopitch~ yin 1024;
31 #X text 329 108 Values in the range [0. \, 1.] are expected. Higher
32 values will avoid incorrect detections \, but also discard some correct
33 ones.;
34 #X obj 557 298 aubiopitch~ fcomb 256 32;
35 #X text 65 387 If not specified \, hopsize will be set to half of bufsize.
36 Otherwise it should be at most 'bufsize'.;
37 #X obj 557 321 aubiopitch~ schmitt 64 64;
38 #X obj 557 344 aubiopitch~ mcomb 4096 4000;
39 #X text 65 366 All arguments are optional.;
40 #X text 66 257 The creation arguments can be used to set the pitch
41 detection parameters.;
42 #X connect 0 0 6 0;
43 #X connect 1 0 5 0;
44 #X connect 1 0 19 0;
45 #X connect 2 0 3 0;
46 #X connect 3 0 4 0;
47 #X connect 4 0 1 0;
48 #X connect 6 0 5 1;
49 #X connect 7 0 19 0;
50 #X connect 8 0 19 0;
51 #X connect 9 0 19 0;
52 #X connect 11 0 2 0;
53 #X connect 12 0 2 0;
54 #X connect 18 0 23 0;
55 #X connect 18 0 24 0;
56 #X connect 18 0 26 0;
57 #X connect 18 0 28 0;
58 #X connect 18 0 29 0;
59 #X connect 19 0 0 0;
60 #X connect 22 0 2 0;