@audio/pitch-mcleod 1.0.0

package/mcleod.js

@@ -0,0 +1,68 @@
+/**
+ * McLeod Pitch Method (McLeod & Wyvill, 2005).
+ * Normalized square difference function → peak picking → parabolic interpolation.
+ *
+ * @param {Float32Array | Float64Array} data - audio samples (single window)
+ * @param {{fs?: number, threshold?: number}} params
+ * @returns {{freq: number, clarity: number} | null}
+ */
+export default function mcleod(data, params) {
+  let fs = params?.fs || 44100
+  let threshold = params?.threshold ?? 0.9
+  let len = data.length
+  let half = len >> 1
+
+  // normalized square difference function (NSDF)
+  // e1 = Σ x[i]² (constant); e2(τ) = Σ x[i+τ]² computed incrementally
+  let nsdf = new Float64Array(half)
+  let e1 = 0
+  for (let i = 0; i < half; i++) e1 += data[i] * data[i]
+  let e2 = e1
+  for (let tau = 0; tau < half; tau++) {
+    let acf = 0
+    for (let i = 0; i < half; i++) acf += data[i] * data[i + tau]
+    nsdf[tau] = e1 + e2 > 0 ? 2 * acf / (e1 + e2) : 0
+    // slide window: drop x[τ], add x[τ+half]
+    let drop = data[tau], add = data[tau + half] || 0
+    e2 += add * add - drop * drop
+  }
+
+  // find peaks: skip initial positive region, then collect local maxima after each zero crossing
+  let peaks = []
+  let wasNeg = false
+
+  for (let tau = 1; tau < half; tau++) {
+    if (nsdf[tau] < 0) wasNeg = true
+    if (!wasNeg || nsdf[tau] <= 0) continue
+
+    // entered a positive region after a negative — find local max
+    let maxVal = nsdf[tau], maxTau = tau
+    while (tau + 1 < half && nsdf[tau + 1] > 0) {
+      tau++
+      if (nsdf[tau] > maxVal) { maxVal = nsdf[tau]; maxTau = tau }
+    }
+    peaks.push({ tau: maxTau, val: maxVal })
+  }
+
+  if (!peaks.length) return null
+
+  // pick highest peak above threshold * max
+  let best = peaks[0]
+  let maxPeak = Math.max(...peaks.map(p => p.val))
+  let cutoff = threshold * maxPeak
+
+  for (let p of peaks) {
+    if (p.val >= cutoff) { best = p; break }
+  }
+
+  // parabolic interpolation
+  let tau = best.tau
+  if (tau < 1 || tau >= half - 1) return { freq: fs / tau, clarity: best.val }
+
+  let s0 = nsdf[tau - 1], s1 = nsdf[tau], s2 = nsdf[tau + 1]
+  let denom = s0 - 2 * s1 + s2
+  let shift = denom !== 0 ? (s0 - s2) / (2 * denom) : 0
+  let period = tau + shift
+
+  return { freq: fs / period, clarity: best.val }
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@audio/pitch-mcleod",
+  "version": "1.0.0",
+  "description": "McLeod Pitch Method (McLeod & Wyvill, 2005)",
+  "type": "module",
+  "sideEffects": false,
+  "main": "mcleod.js",
+  "exports": {
+    ".": "./mcleod.js",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "mcleod.js"
+  ],
+  "keywords": [
+    "audio",
+    "dsp",
+    "pitch",
+    "pitch-detection",
+    "f0",
+    "mcleod"
+  ],
+  "license": "MIT",
+  "author": "Dmitry Iv. <dfcreative@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/audiojs/pitch.git",
+    "directory": "packages/pitch-mcleod"
+  },
+  "homepage": "https://github.com/audiojs/pitch/tree/main/packages/pitch-mcleod",
+  "bugs": {
+    "url": "https://github.com/audiojs/pitch/issues"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}