speechflow 0.9.4 → 0.9.7

package/dst/speechflow-node-x2x-trace.js

@@ -0,0 +1,88 @@
+"use strict";
+/*
+**  SpeechFlow - Speech Processing Flow Graph
+**  Copyright (c) 2024-2025 Dr. Ralf S. Engelschall <rse@engelschall.com>
+**  Licensed under GPL 3.0 <https://spdx.org/licenses/GPL-3.0-only>
+*/
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*  standard dependencies  */
+const node_stream_1 = __importDefault(require("node:stream"));
+/*  internal dependencies  */
+const speechflow_node_1 = __importDefault(require("./speechflow-node"));
+/*  SpeechFlow node for data flow tracing  */
+class SpeechFlowNodeTrace extends speechflow_node_1.default {
+    /*  declare official node name  */
+    static name = "trace";
+    /*  construct node  */
+    constructor(id, cfg, opts, args) {
+        super(id, cfg, opts, args);
+        /*  declare node configuration parameters  */
+        this.configure({
+            type: { type: "string", pos: 0, val: "audio", match: /^(?:audio|text)$/ },
+            name: { type: "string", pos: 1 }
+        });
+        /*  declare node input/output format  */
+        this.input = this.params.type;
+        this.output = this.params.type;
+    }
+    /*  open node  */
+    async open() {
+        /*  wrapper for local logging  */
+        const log = (level, msg) => {
+            if (this.params.name !== undefined)
+                this.log(level, `[${this.params.name}]: ${msg}`);
+            else
+                this.log(level, msg);
+        };
+        /*  provide Duplex stream and internally attach to Deepgram API  */
+        const type = this.params.type;
+        this.stream = new node_stream_1.default.Transform({
+            writableObjectMode: true,
+            readableObjectMode: true,
+            decodeStrings: false,
+            transform(chunk, encoding, callback) {
+                let error;
+                const fmt = (t) => t.toFormat("hh:mm:ss.SSS");
+                if (Buffer.isBuffer(chunk.payload)) {
+                    if (type === "audio")
+                        log("info", `writing ${type} chunk: start=${fmt(chunk.timestampStart)} ` +
+                            `end=${fmt(chunk.timestampEnd)} kind=${chunk.kind} type=${chunk.type} ` +
+                            `payload-type=Buffer payload-bytes=${chunk.payload.byteLength}`);
+                    else
+                        error = new Error(`writing ${type} chunk: seen Buffer instead of String chunk type`);
+                }
+                else {
+                    if (type === "text")
+                        log("info", `writing ${type} chunk: start=${fmt(chunk.timestampStart)} ` +
+                            `end=${fmt(chunk.timestampEnd)} kind=${chunk.kind} type=${chunk.type}` +
+                            `payload-type=String payload-length=${chunk.payload.length} ` +
+                            `payload-encoding=${encoding} payload-content="${chunk.payload.toString()}"`);
+                    else
+                        error = new Error(`writing ${type} chunk: seen String instead of Buffer chunk type`);
+                }
+                if (error !== undefined)
+                    callback(error);
+                else {
+                    this.push(chunk, encoding);
+                    callback();
+                }
+            },
+            final(callback) {
+                this.push(null);
+                callback();
+            }
+        });
+    }
+    /*  close node  */
+    async close() {
+        /*  close stream  */
+        if (this.stream !== null) {
+            this.stream.destroy();
+            this.stream = null;
+        }
+    }
+}
+exports.default = SpeechFlowNodeTrace;

package/dst/speechflow-node-xio-device.d.ts

@@ -0,0 +1,13 @@
+import SpeechFlowNode from "./speechflow-node";
+export default class SpeechFlowNodeDevice extends SpeechFlowNode {
+    static name: string;
+    private io;
+    constructor(id: string, cfg: {
+        [id: string]: any;
+    }, opts: {
+        [id: string]: any;
+    }, args: any[]);
+    private audioDeviceFromURL;
+    open(): Promise<void>;
+    close(): Promise<void>;
+}

package/dst/speechflow-node-xio-device.js

@@ -0,0 +1,205 @@
+"use strict";
+/*
+**  SpeechFlow - Speech Processing Flow Graph
+**  Copyright (c) 2024-2025 Dr. Ralf S. Engelschall <rse@engelschall.com>
+**  Licensed under GPL 3.0 <https://spdx.org/licenses/GPL-3.0-only>
+*/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*  standard dependencies  */
+const node_stream_1 = __importDefault(require("node:stream"));
+/*  external dependencies  */
+const naudiodon_1 = __importDefault(require("@gpeng/naudiodon"));
+/*  internal dependencies  */
+const speechflow_node_1 = __importDefault(require("./speechflow-node"));
+const utils = __importStar(require("./speechflow-utils"));
+/*  SpeechFlow node for device access  */
+class SpeechFlowNodeDevice extends speechflow_node_1.default {
+    /*  declare official node name  */
+    static name = "device";
+    /*  internal state  */
+    io = null;
+    /*  construct node  */
+    constructor(id, cfg, opts, args) {
+        super(id, cfg, opts, args);
+        /*  declare node configuration parameters  */
+        this.configure({
+            device: { type: "string", pos: 0, match: /^(.+?):(.+)$/ },
+            mode: { type: "string", pos: 1, val: "rw", match: /^(?:r|w|rw)$/ }
+        });
+        /*  declare node input/output format  */
+        if (this.params.mode === "rw") {
+            this.input = "audio";
+            this.output = "audio";
+        }
+        else if (this.params.mode === "r") {
+            this.input = "none";
+            this.output = "audio";
+        }
+        else if (this.params.mode === "w") {
+            this.input = "audio";
+            this.output = "none";
+        }
+    }
+    /*  INTERNAL: utility function for finding audio device by pseudo-URL notation  */
+    audioDeviceFromURL(mode, url) {
+        /*  parse URL  */
+        const m = url.match(/^(.+?):(.+)$/);
+        if (m === null)
+            throw new Error(`invalid audio device URL "${url}"`);
+        const [, type, name] = m;
+        /*  determine audio API  */
+        const apis = naudiodon_1.default.getHostAPIs();
+        const api = apis.HostAPIs.find((api) => api.type.toLowerCase() === type.toLowerCase());
+        if (!api)
+            throw new Error(`invalid audio API type "${type}"`);
+        /*  determine device of audio API  */
+        const devices = naudiodon_1.default.getDevices();
+        for (const device of devices)
+            this.log("info", `found audio device "${device.name}" ` +
+                `(inputs: ${device.maxInputChannels}, outputs: ${device.maxOutputChannels}`);
+        const device = devices.find((device) => {
+            return (((mode === "r" && device.maxInputChannels > 0)
+                || (mode === "w" && device.maxOutputChannels > 0)
+                || (mode === "rw" && device.maxInputChannels > 0 && device.maxOutputChannels > 0)
+                || (mode === "any" && (device.maxInputChannels > 0 || device.maxOutputChannels > 0)))
+                && device.name.match(name)
+                && device.hostAPIName === api.name);
+        });
+        if (!device)
+            throw new Error(`invalid audio device "${name}" (of audio API type "${type}")`);
+        return device;
+    }
+    /*  open node  */
+    async open() {
+        /*  determine device  */
+        const device = this.audioDeviceFromURL(this.params.mode, this.params.device);
+        /*  sanity check sample rate compatibility
+            (we still do not resample in input/output for simplification reasons)  */
+        if (device.defaultSampleRate !== this.config.audioSampleRate)
+            throw new Error(`audio device sample rate ${device.defaultSampleRate} is ` +
+                `incompatible with required sample rate ${this.config.audioSampleRate}`);
+        /*  establish device connection
+            Notice: "naudion" actually implements Stream.{Readable,Writable,Duplex}, but
+            declares just its sub-interface NodeJS.{Readable,Writable,Duplex}Stream,
+            so it is correct to cast it back to Stream.{Readable,Writable,Duplex}  */
+        /*  FIXME: the underlying PortAudio outputs verbose/debugging messages  */
+        if (this.params.mode === "rw") {
+            /*  input/output device  */
+            if (device.maxInputChannels === 0)
+                throw new Error(`device "${device.id}" does not have any input channels (required by read/write mode)`);
+            if (device.maxOutputChannels === 0)
+                throw new Error(`device "${device.id}" does not have any output channels (required by read/write mode)`);
+            this.log("info", `resolved "${this.params.device}" to duplex device "${device.id}"`);
+            this.io = naudiodon_1.default.AudioIO({
+                inOptions: {
+                    deviceId: device.id,
+                    channelCount: this.config.audioChannels,
+                    sampleRate: this.config.audioSampleRate,
+                    sampleFormat: this.config.audioBitDepth
+                },
+                outOptions: {
+                    deviceId: device.id,
+                    channelCount: this.config.audioChannels,
+                    sampleRate: this.config.audioSampleRate,
+                    sampleFormat: this.config.audioBitDepth
+                }
+            });
+            this.stream = this.io;
+            /*  convert regular stream into object-mode stream  */
+            const wrapper1 = utils.createTransformStreamForWritableSide();
+            const wrapper2 = utils.createTransformStreamForReadableSide("audio", () => this.timeZero);
+            this.stream = node_stream_1.default.compose(wrapper1, this.stream, wrapper2);
+        }
+        else if (this.params.mode === "r") {
+            /*  input device  */
+            if (device.maxInputChannels === 0)
+                throw new Error(`device "${device.id}" does not have any input channels (required by read mode)`);
+            this.log("info", `resolved "${this.params.device}" to input device "${device.id}"`);
+            this.io = naudiodon_1.default.AudioIO({
+                inOptions: {
+                    deviceId: device.id,
+                    channelCount: this.config.audioChannels,
+                    sampleRate: this.config.audioSampleRate,
+                    sampleFormat: this.config.audioBitDepth
+                }
+            });
+            this.stream = this.io;
+            /*  convert regular stream into object-mode stream  */
+            const wrapper = utils.createTransformStreamForReadableSide("audio", () => this.timeZero);
+            this.stream.pipe(wrapper);
+            this.stream = wrapper;
+        }
+        else if (this.params.mode === "w") {
+            /*  output device  */
+            if (device.maxOutputChannels === 0)
+                throw new Error(`device "${device.id}" does not have any output channels (required by write mode)`);
+            this.log("info", `resolved "${this.params.device}" to output device "${device.id}"`);
+            this.io = naudiodon_1.default.AudioIO({
+                outOptions: {
+                    deviceId: device.id,
+                    channelCount: this.config.audioChannels,
+                    sampleRate: this.config.audioSampleRate,
+                    sampleFormat: this.config.audioBitDepth
+                }
+            });
+            this.stream = this.io;
+            /*  convert regular stream into object-mode stream  */
+            const wrapper = utils.createTransformStreamForWritableSide();
+            wrapper.pipe(this.stream);
+            this.stream = wrapper;
+        }
+        else
+            throw new Error(`device "${device.id}" does not have any input or output channels`);
+        /*  pass-through PortAudio errors  */
+        this.io.on("error", (err) => {
+            this.emit("error", err);
+        });
+        /*  start PortAudio  */
+        this.io.start();
+    }
+    /*  close node  */
+    async close() {
+        /*  shutdown PortAudio  */
+        if (this.io !== null) {
+            this.io.quit();
+            this.io = null;
+        }
+    }
+}
+exports.default = SpeechFlowNodeDevice;

package/dst/speechflow-node-xio-file.d.ts

@@ -0,0 +1,11 @@
+import SpeechFlowNode from "./speechflow-node";
+export default class SpeechFlowNodeFile extends SpeechFlowNode {
+    static name: string;
+    constructor(id: string, cfg: {
+        [id: string]: any;
+    }, opts: {
+        [id: string]: any;
+    }, args: any[]);
+    open(): Promise<void>;
+    close(): Promise<void>;
+}

package/dst/speechflow-node-xio-file.js

@@ -0,0 +1,176 @@
+"use strict";
+/*
+**  SpeechFlow - Speech Processing Flow Graph
+**  Copyright (c) 2024-2025 Dr. Ralf S. Engelschall <rse@engelschall.com>
+**  Licensed under GPL 3.0 <https://spdx.org/licenses/GPL-3.0-only>
+*/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*  standard dependencies  */
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_stream_1 = __importDefault(require("node:stream"));
+/*  internal dependencies  */
+const speechflow_node_1 = __importDefault(require("./speechflow-node"));
+const utils = __importStar(require("./speechflow-utils"));
+/*  SpeechFlow node for file access  */
+class SpeechFlowNodeFile extends speechflow_node_1.default {
+    /*  declare official node name  */
+    static name = "file";
+    /*  construct node  */
+    constructor(id, cfg, opts, args) {
+        super(id, cfg, opts, args);
+        /*  declare node configuration parameters  */
+        this.configure({
+            path: { type: "string", pos: 0 },
+            mode: { type: "string", pos: 1, val: "r", match: /^(?:r|w|rw)$/ },
+            type: { type: "string", pos: 2, val: "audio", match: /^(?:audio|text)$/ }
+        });
+        /*  declare node input/output format  */
+        if (this.params.mode === "rw") {
+            this.input = this.params.type;
+            this.output = this.params.type;
+        }
+        else if (this.params.mode === "r") {
+            this.input = "none";
+            this.output = this.params.type;
+        }
+        else if (this.params.mode === "w") {
+            this.input = this.params.type;
+            this.output = "none";
+        }
+    }
+    /*  open node  */
+    async open() {
+        if (this.params.mode === "rw") {
+            if (this.params.path === "-") {
+                /*  standard I/O  */
+                if (this.params.type === "audio") {
+                    process.stdin.setEncoding();
+                    process.stdout.setEncoding();
+                }
+                else {
+                    process.stdin.setEncoding(this.config.textEncoding);
+                    process.stdout.setEncoding(this.config.textEncoding);
+                }
+                this.stream = node_stream_1.default.Duplex.from({
+                    readable: process.stdin,
+                    writable: process.stdout
+                });
+            }
+            else {
+                /*  file I/O  */
+                if (this.params.type === "audio") {
+                    this.stream = node_stream_1.default.Duplex.from({
+                        readable: node_fs_1.default.createReadStream(this.params.path),
+                        writable: node_fs_1.default.createWriteStream(this.params.path)
+                    });
+                }
+                else {
+                    this.stream = node_stream_1.default.Duplex.from({
+                        readable: node_fs_1.default.createReadStream(this.params.path, { encoding: this.config.textEncoding }),
+                        writable: node_fs_1.default.createWriteStream(this.params.path, { encoding: this.config.textEncoding })
+                    });
+                }
+            }
+            /*  convert regular stream into object-mode stream  */
+            const wrapper1 = utils.createTransformStreamForWritableSide();
+            const wrapper2 = utils.createTransformStreamForReadableSide(this.params.type, () => this.timeZero);
+            this.stream = node_stream_1.default.compose(wrapper1, this.stream, wrapper2);
+        }
+        else if (this.params.mode === "r") {
+            if (this.params.path === "-") {
+                /*  standard I/O  */
+                if (this.params.type === "audio")
+                    process.stdin.setEncoding();
+                else
+                    process.stdin.setEncoding(this.config.textEncoding);
+                this.stream = process.stdin;
+            }
+            else {
+                /*  file I/O  */
+                if (this.params.type === "audio")
+                    this.stream = node_fs_1.default.createReadStream(this.params.path);
+                else
+                    this.stream = node_fs_1.default.createReadStream(this.params.path, { encoding: this.config.textEncoding });
+            }
+            /*  convert regular stream into object-mode stream  */
+            const wrapper = utils.createTransformStreamForReadableSide(this.params.type, () => this.timeZero);
+            this.stream.pipe(wrapper);
+            this.stream = wrapper;
+        }
+        else if (this.params.mode === "w") {
+            if (this.params.path === "-") {
+                /*  standard I/O  */
+                if (this.params.type === "audio")
+                    process.stdout.setEncoding();
+                else
+                    process.stdout.setEncoding(this.config.textEncoding);
+                this.stream = process.stdout;
+            }
+            else {
+                /*  file I/O  */
+                if (this.params.type === "audio")
+                    this.stream = node_fs_1.default.createWriteStream(this.params.path);
+                else
+                    this.stream = node_fs_1.default.createWriteStream(this.params.path, { encoding: this.config.textEncoding });
+            }
+            /*  convert regular stream into object-mode stream  */
+            const wrapper = utils.createTransformStreamForWritableSide();
+            wrapper.pipe(this.stream);
+            this.stream = wrapper;
+        }
+        else
+            throw new Error(`invalid file mode "${this.params.mode}"`);
+    }
+    /*  close node  */
+    async close() {
+        /*  shutdown stream  */
+        if (this.stream !== null) {
+            await new Promise((resolve) => {
+                if (this.stream instanceof node_stream_1.default.Writable || this.stream instanceof node_stream_1.default.Duplex)
+                    this.stream.end(() => { resolve(); });
+                else
+                    resolve();
+            });
+            if (this.params.path !== "-")
+                this.stream.destroy();
+            this.stream = null;
+        }
+    }
+}
+exports.default = SpeechFlowNodeFile;

package/dst/speechflow-node-xio-mqtt.d.ts

@@ -0,0 +1,13 @@
+import SpeechFlowNode from "./speechflow-node";
+export default class SpeechFlowNodeMQTT extends SpeechFlowNode {
+    static name: string;
+    private broker;
+    private clientId;
+    constructor(id: string, cfg: {
+        [id: string]: any;
+    }, opts: {
+        [id: string]: any;
+    }, args: any[]);
+    open(): Promise<void>;
+    close(): Promise<void>;
+}