@lumiastream/wakeword 1.0.1-alpha.6 → 1.0.1-alpha.7

package/lib/record.js

@@ -0,0 +1,119 @@
+"use strict";
+
+const assert = require("assert");
+const debug = require("debug")("record");
+const { spawn } = require("child_process");
+const recorders = require("./recorders");
+
+class Recording {
+	constructor(options = {}) {
+		const defaults = {
+			sampleRate: 16000,
+			channels: 1,
+			compress: false,
+			threshold: 0.5,
+			thresholdStart: null,
+			thresholdEnd: null,
+			silence: "1.0",
+			recorder: "sox",
+			endOnSilence: false,
+			audioType: "wav",
+			binPath: null,
+			bufferSize: null,
+			arguments: [],
+		};
+
+		this.options = Object.assign(defaults, options);
+
+		const recorder = recorders.load(this.options.recorder);
+		const { cmd, args, spawnOptions = {} } = recorder(this.options);
+
+		this.cmd = cmd;
+		this.args = args;
+		this.cmdOptions = Object.assign(
+			{ encoding: "binary", stdio: "pipe" },
+			spawnOptions
+		);
+
+		debug(`Started recording`);
+		debug(this.options);
+
+		const command = ` ${this.cmd} ${this.args.join(" ")}`;
+		debug(command);
+
+		return this.start();
+	}
+
+	start() {
+		const { cmd, args, cmdOptions } = this;
+
+		const cp = spawn(cmd, args, cmdOptions);
+		const rec = cp.stdout;
+		const err = cp.stderr;
+
+		this.process = cp; // expose child process
+		this._stream = rec; // expose output stream
+
+		cp.on("close", (code) => {
+			if (code === 0) return;
+			rec.emit(
+				"error",
+				`${this.cmd} has exited with error code ${code}.
+
+Enable debugging with the environment variable DEBUG=record.`
+			);
+		});
+
+		err.on("data", (chunk) => {
+			debug(`STDERR: ${chunk}`);
+		});
+
+		rec.on("data", (chunk) => {
+			debug(`Recording ${chunk.length} bytes`);
+		});
+
+		rec.on("end", () => {
+			debug("Recording ended");
+		});
+
+		return this;
+	}
+
+	stop() {
+		assert(this.process, "Recording not yet started");
+
+		this.process.kill();
+	}
+
+	pause() {
+		assert(this.process, "Recording not yet started");
+
+		this.process.kill("SIGSTOP");
+		this._stream.pause();
+		debug("Paused recording");
+	}
+
+	resume() {
+		assert(this.process, "Recording not yet started");
+
+		this.process.kill("SIGCONT");
+		this._stream.resume();
+		debug("Resumed recording");
+	}
+
+	isPaused() {
+		assert(this.process, "Recording not yet started");
+
+		return this._stream.isPaused();
+	}
+
+	stream() {
+		assert(this._stream, "Recording not yet started");
+
+		return this._stream;
+	}
+}
+
+module.exports = {
+	record: (...args) => new Recording(...args),
+};

package/lib/recorders/arecord.js

@@ -0,0 +1,27 @@
+// On some systems (RasPi), arecord is the prefered recording binary
+module.exports = (options) => {
+	let cmd = "arecord";
+
+	if (options.binPath) {
+		cmd = options.binPath;
+	}
+
+	const args = [
+		"-q", // show no progress
+		"-r",
+		options.sampleRate, // sample rate
+		"-c",
+		options.channels, // channels
+		"-t",
+		options.audioType, // audio type
+		"-f",
+		"S16_LE", // Sample format
+		"-", // pipe
+	];
+
+	if (options.device) {
+		args.unshift("-D", options.device);
+	}
+
+	return { cmd, args };
+};

package/lib/recorders/index.js

@@ -0,0 +1,18 @@
+const path = require('path')
+
+function load (recorderName) {
+  try {
+    const recoderPath = path.resolve(__dirname, recorderName)
+    return require(recoderPath)
+  } catch (err) {
+    if (err.code === 'MODULE_NOT_FOUND') {
+      throw new Error(`No such recorder found: ${recorderName}`)
+    }
+
+    throw err
+  }
+}
+
+module.exports = {
+  load
+}

package/lib/recorders/rec.js

@@ -0,0 +1,36 @@
+module.exports = (options) => {
+	let cmd = "rec";
+
+	if (options.binPath) {
+		cmd = options.binPath;
+	}
+
+	let args = [
+		"-q", // show no progress
+		"-r",
+		options.sampleRate, // sample rate
+		"-c",
+		options.channels, // channels
+		"-e",
+		"signed-integer", // sample encoding
+		"-b",
+		"16", // precision (bits)
+		"-t",
+		options.audioType, // audio type
+		"-", // pipe
+	];
+
+	if (options.endOnSilence) {
+		args = args.concat([
+			"silence",
+			"1",
+			"0.1",
+			options.thresholdStart || options.threshold + "%",
+			"1",
+			options.silence,
+			options.thresholdEnd || options.threshold + "%",
+		]);
+	}
+
+	return { cmd, args };
+};

package/lib/recorders/sox.js

@@ -0,0 +1,51 @@
+module.exports = (options) => {
+	let cmd = "sox";
+
+	if (options.binPath) {
+		cmd = options.binPath;
+	}
+
+	let args = [
+		"--default-device",
+		"--no-show-progress", // show no progress
+		"--rate",
+		options.sampleRate, // sample rate
+		"--channels",
+		options.channels, // channels
+		"--encoding",
+		"signed-integer", // sample encoding
+		"--bits",
+		"16", // precision (bits)
+		"--type",
+		options.audioType, // audio type
+		"-", // pipe
+	];
+
+	if (options.bufferSize) {
+		args.push("--buffer", options.bufferSize);
+	}
+
+	if (options.endOnSilence) {
+		args = args.concat([
+			"silence",
+			"1",
+			"0.1",
+			options.thresholdStart || options.threshold + "%",
+			"1",
+			options.silence,
+			options.thresholdEnd || options.threshold + "%",
+		]);
+	}
+
+	if (options.arguments) {
+		args = args.concat(options.arguments);
+	}
+
+	const spawnOptions = {};
+
+	if (options.device) {
+		spawnOptions.env = { ...process.env, AUDIODEV: options.device };
+	}
+
+	return { cmd, args, spawnOptions };
+};

package/lib/voice.mjs

@@ -1,5 +1,5 @@
 import { Model, Recognizer, setLogLevel } from "vosk";
-import record from "@lumiastream/record";
+import record from "./record";
 import { join } from "node:path";
 
 const binPath = join(

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@lumiastream/wakeword",
-	"version": "1.0.1-alpha.6",
+	"version": "1.0.1-alpha.7",
 	"type": "module",
 	"main": "lib/voice.mjs",
 	"bin": {
@@ -16,7 +16,6 @@
 		"postinstall": "chmod +x binaries/soxmac binaries/soxlinux binaries/sox.exe || true"
 	},
 	"dependencies": {
-		"@lumiastream/record": "^1.0.1",
 		"vosk": "^0.3.39"
 	}
 }