note-listener 1.0.0 → 1.1.1

package/README.md

@@ -0,0 +1,116 @@
+# note-listener
+
+A lightweight JavaScript/TypeScript library for detecting pitch from any audio input. Works in the browser and supports selecting specific microphones or sound cards. Perfect for guitar practice, music apps, or live pitch detection.
+
+---
+
+## Features
+
+* Detect musical notes (C0–B8) in real-time.
+* Smooths out note jitter with a configurable buffer.
+* Supports multiple audio inputs and allows choosing a specific device.
+* Pure browser-based — no backend required.
+* Minimal dependencies (`pitchy`).
+
+---
+
+## Installation
+
+```bash
+npm install note-listener
+# or
+yarn add note-listener
+```
+
+## Usage
+
+### Plain JavaScript
+
+```js
+import { listAudioInputs, createPitchListener } from "note-listener";
+
+// List all available audio inputs
+const inputs = await listAudioInputs();
+console.log(inputs); // [{ deviceId, label }, ...]
+
+const listener = await createPitchListener({
+  deviceId: inputs[0].deviceId, // select a device
+  minEnergy: 0.03,
+  onNote: (note, freq, clarity) => {
+    console.log(`Detected note: ${note} (${freq.toFixed(2)} Hz), clarity: ${clarity.toFixed(2)}`);
+  },
+});
+
+listener.start();
+
+// Stop when needed
+// listener.stop();
+```
+
+### Vue 3 Example
+
+```vue
+<template>
+  <div>
+    <h2>Select audio input</h2>
+    <select v-model="selectedId">
+      <option disabled value="">-- choose input --</option>
+      <option v-for="d in inputs" :key="d.deviceId" :value="d.deviceId">
+        {{ d.label }}
+      </option>
+    </select>
+
+    <button @click="start" :disabled="!selectedId">Start listening</button>
+    <p>Last note: {{ lastNote || "—" }}</p>
+  </div>
+</template>
+
+<script setup>
+import { ref, onMounted, onBeforeUnmount } from "vue"
+import { listAudioInputs, createPitchListener } from "note-listener"
+
+const inputs = ref([])
+const selectedId = ref("")
+const lastNote = ref(null)
+let listener = null
+
+onMounted(async () => {
+  await navigator.mediaDevices.getUserMedia({ audio: true })
+  inputs.value = await listAudioInputs()
+})
+
+async function start() {
+  if (listener) listener.stop()
+
+  listener = await createPitchListener({
+    deviceId: selectedId.value,
+    minEnergy: 0.03,
+    onNote(note) {
+      lastNote.value = note
+      console.log("🎵", note)
+    },
+  })
+
+  listener.start()
+}
+
+onBeforeUnmount(() => {
+  if (listener) listener.stop()
+})
+</script>
+```
+
+## Options
+
+| Option           | Type     | Default   | Description                                                         |
+| ---------------- | -------- | --------- | ------------------------------------------------------------------- |
+| deviceId         | string   | undefined | Audio input device ID to use.                                       |
+| minEnergy        | number   | 0.03      | Minimum RMS energy to consider a signal as valid.                   |
+| clarityThreshold | number   | 0.88      | Minimum clarity from pitchy to register a note.                     |
+| minFreq          | number   | 82        | Minimum frequency to detect (Hz).                                   |
+| maxFreq          | number   | 1319      | Maximum frequency to detect (Hz).                                   |
+| onNote           | function | required  | Callback when a new note is detected: `(note, freq, clarity) => {}` |
+
+## License
+
+MIT © Donald Edwin

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "note-listener",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "simple pitch detection library for instruments using pitchy",
   "main": "src/index.js",
   "scripts": {

package/src/index.js

@@ -1,7 +1,12 @@
 import { PitchDetector } from "pitchy";
 
-/* ====== Utilities (unchanged) ====== */
+export async function listAudioInputs() {
+  const devices = await navigator.mediaDevices.enumerateDevices();
+  return devices.filter((d) => d.kind === "audioinput");
+}
+
 
+/* ====== Utilities ====== */
 function freqToNote(freq) {
   const A4 = 440;
   const notes = [
@@ -34,9 +39,10 @@ function rms(buffer) {
   return Math.sqrt(sum / buffer.length);
 }
 
-function getGuitar() {
+function getGuitar(deviceId) {
   return navigator.mediaDevices.getUserMedia({
     audio: {
+      ...(deviceId ? { deviceId: { exact: deviceId } } : {}),
       echoCancellation: false,
       autoGainControl: false,
       noiseSuppression: false,
@@ -49,6 +55,7 @@ function getGuitar() {
 
 export async function createPitchListener({
   onNote,
+  deviceId,
   minEnergy = 0.03,
   clarityThreshold = 0.88,
   minFreq = 82,
@@ -64,7 +71,7 @@ export async function createPitchListener({
   const context = new AudioContext();
   let guitar;
   try {
-    guitar = await getGuitar();
+    guitar = await getGuitar(deviceId);
   } catch (e) {
     console.warn("Microphone access not granted:", e.message);
     return {