Skip to content

Commit 38c42db

Browse files
committed
Update README.md
1 parent 886dbd8 commit 38c42db

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@ A compilation of pitch detection algorithms for Javascript. Supports both the br
77
## Provided pitch-finding algorithms
88

99
- **YIN** - The best balance of accuracy and speed, in my experience. Occasionally provides values that are wildly incorrect.
10+
- **Mcleod** - Also works well. Some have reported better performance on lower frequencies.
1011
- **AMDF** - Slow and only accurate to around +/- 2%, but finds a frequency more consistenly than others.
1112
- **Dynamic Wavelet** - Very fast, but struggles to identify lower frequencies.
1213
- **YIN w/ FFT** _(coming soon)_
1314
- **Goertzel** _(coming soon)_
14-
- **Mcleod** _(coming soon)_
15+
1516

1617
## Installation
1718

@@ -87,6 +88,11 @@ const moreAccurateFrequencies = Pitchfinder.frequencies(
8788
- `threshold` - used by the algorithm
8889
- `probabilityThreshold` - don't return a pitch if probability estimate is below this number.
8990

91+
### McLeod
92+
93+
- `bufferSize` - The expected buffer size in samples. Defaults to 1024.
94+
- `cutoff` - Defines the relative size the chosen peak (pitch) has. 0.93 means: choose the first peak that is higher than 93% of the highest peak detected. 93% is the default value used in the Tartini user interface.
95+
9096
### AMDF
9197

9298
- `minFrequency` - Lowest frequency detectable

0 commit comments

Comments
 (0)