speechflow 1.7.0 → 1.7.1

package/speechflow-cli/src/speechflow-node-x2x-trace.ts

@@ -28,10 +28,10 @@ export default class SpeechFlowNodeX2XTrace extends SpeechFlowNode {
 
         /*  declare node configuration parameters  */
         this.configure({
-            type:      { type: "string", pos: 0, val: "audio", match: /^(?:audio|text)$/ },
-            name:      { type: "string", pos: 1, val: "trace" },
+            type:      { type: "string", pos: 0, val: "audio",  match: /^(?:audio|text)$/  },
+            name:      { type: "string", pos: 1, val: "trace"                              },
             mode:      { type: "string", pos: 2, val: "filter", match: /^(?:filter|sink)$/ },
-            dashboard: { type: "string",         val: "" }
+            dashboard: { type: "string",         val: ""                                   }
         })
 
         /*  sanity check parameters  */

package/speechflow-cli/src/speechflow-node-xio-device.ts

@@ -20,10 +20,7 @@ export default class SpeechFlowNodeXIODevice extends SpeechFlowNode {
     public static name = "xio-device"
 
     /*  internal state  */
-    private io: PortAudio.IoStreamRead
-        | PortAudio.IoStreamWrite
-        | PortAudio.IoStreamDuplex
-        | null = null
+    private io: PortAudio.IoStreamRead | PortAudio.IoStreamWrite | PortAudio.IoStreamDuplex | null = null
 
     /*  construct node  */
     constructor (id: string, cfg: { [ id: string ]: any }, opts: { [ id: string ]: any }, args: any[]) {
@@ -87,7 +84,7 @@ export default class SpeechFlowNodeXIODevice extends SpeechFlowNode {
         return device
     }
 
-    /*  NOTICE: "naudion" actually implements Stream.{Readable,Writable,Duplex}, but
+    /*  NOTICE: "naudiodon" 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}
         in the following device stream setup functions!  */
@@ -211,7 +208,7 @@ export default class SpeechFlowNodeXIODevice extends SpeechFlowNode {
                     throw error
             }
             await Promise.race([
-                util.timeoutPromise(2 * 1000, "PortAudio abort timeout"),
+                util.timeout(2 * 1000, "PortAudio abort timeout"),
                 new Promise<void>((resolve) => {
                     this.io!.abort(() => {
                         resolve()
@@ -219,7 +216,7 @@ export default class SpeechFlowNodeXIODevice extends SpeechFlowNode {
                 }).catch(catchHandler)
             ])
             await Promise.race([
-                util.timeoutPromise(2 * 1000, "PortAudio quit timeout"),
+                util.timeout(2 * 1000, "PortAudio quit timeout"),
                 new Promise<void>((resolve) => {
                     this.io!.quit(() => {
                         resolve()

package/speechflow-cli/src/speechflow-node-xio-file.ts

@@ -210,7 +210,7 @@ export default class SpeechFlowNodeXIOFile extends SpeechFlowNode {
                                 else     resolve()
                             })
                         }),
-                        util.timeoutPromise(5000)
+                        util.timeout(5000)
                     ])
                 }
             }

package/speechflow-cli/src/speechflow-node-xio-mqtt.ts

@@ -97,7 +97,8 @@ export default class SpeechFlowNodeXIOMQTT extends SpeechFlowNode {
             this.log("info", `connection re-opened to MQTT ${this.params.url}`)
         })
         this.broker.on("disconnect", (packet: MQTT.IDisconnectPacket) => {
-            this.log("info", `connection closed to MQTT ${this.params.url}`)
+            const reasonCode = packet.reasonCode ?? 0
+            this.log("info", `connection closed to MQTT ${this.params.url} (reason code: ${reasonCode})`)
         })
         this.chunkQueue = new util.SingleQueue<SpeechFlowChunk>()
         this.broker.on("message", (topic: string, payload: Buffer, packet: MQTT.IPublishPacket) => {
@@ -107,7 +108,7 @@ export default class SpeechFlowNodeXIOMQTT extends SpeechFlowNode {
                 const chunk = util.streamChunkDecode(payload)
                 this.chunkQueue!.write(chunk)
             }
-            catch (_err: any) {
+            catch (_err: unknown) {
                 this.log("warning", `received invalid CBOR chunk from MQTT ${this.params.url}`)
             }
         })

package/speechflow-cli/src/speechflow-node-xio-websocket.ts

@@ -175,7 +175,8 @@ export default class SpeechFlowNodeXIOWebSocket extends SpeechFlowNode {
                 this.log("info", `connection closed to URL ${this.params.connect}`)
             })
             this.client.addEventListener("error", (ev: ErrorEvent) => {
-                this.log("error", `error of connection on URL ${this.params.connect}: ${ev.error.message}`)
+                const error = util.ensureError(ev.error)
+                this.log("error", `error of connection on URL ${this.params.connect}: ${error.message}`)
             })
             const chunkQueue = new util.SingleQueue<SpeechFlowChunk>()
             this.client.addEventListener("message", (ev: MessageEvent) => {

package/speechflow-cli/src/speechflow-util-audio-wt.ts

@@ -38,7 +38,7 @@ class AudioSourceProcessor extends AudioWorkletProcessor {
     private currentOffset = 0
 
     /*  node construction  */
-    constructor() {
+    constructor () {
         super()
 
         /*  receive input chunks  */
@@ -50,7 +50,7 @@ class AudioSourceProcessor extends AudioWorkletProcessor {
     }
 
     /*  process audio frame  */
-    process(
+    process (
         inputs:     Float32Array[][],            /* unused */
         outputs:    Float32Array[][],
         parameters: Record<string, Float32Array> /* unused */
@@ -117,7 +117,7 @@ class AudioCaptureProcessor extends AudioWorkletProcessor {
     private activeCaptures = new Map<string, { data: number[], expectedSamples: number }>()
 
     /*  node construction  */
-    constructor() {
+    constructor () {
         super()
 
         /*  receive start of capturing command  */
@@ -133,7 +133,7 @@ class AudioCaptureProcessor extends AudioWorkletProcessor {
     }
 
     /*  process audio frame  */
-    process(
+    process (
         inputs:     Float32Array[][],
         outputs:    Float32Array[][],             /* unused */
         parameters: Record<string, Float32Array>  /* unused */

package/speechflow-cli/src/speechflow-util-audio.ts

@@ -133,7 +133,7 @@ export async function processInt16ArrayInSegments (
 }
 
 /*  update envelope (smoothed amplitude contour) for single channel  */
-export function updateEnvelopeForChannel(
+export function updateEnvelopeForChannel (
     env:            number[],
     sampleRate:     number,
     chan:           number,
@@ -182,7 +182,7 @@ export class WebAudio {
     }>()
 
     /*  construct object  */
-    constructor(
+    constructor (
         public sampleRate: number,
         public channels: number
     ) {
@@ -215,7 +215,7 @@ export class WebAudio {
             numberOfInputs:  1,
             numberOfOutputs: 0
         })
-        this.captureNode!.port.addEventListener("message", (event) => {
+        this.captureNode.port.addEventListener("message", (event) => {
             const { type, chunkId, data } = event.data ?? {}
             if (type === "capture-complete") {
                 const promise = this.pendingPromises.get(chunkId)
@@ -232,7 +232,7 @@ export class WebAudio {
 
         /*  start ports  */
         this.sourceNode.port.start()
-        this.captureNode!.port.start()
+        this.captureNode.port.start()
     }
 
     /*  process single audio chunk  */
@@ -242,7 +242,7 @@ export class WebAudio {
             const timeout = setTimeout(() => {
                 this.pendingPromises.delete(chunkId)
                 reject(new Error("processing timeout"))
-            }, (int16Array.length / this.audioContext.sampleRate) * 1000 + 250)
+            }, (int16Array.length / this.channels / this.audioContext.sampleRate) * 1000 + 250)
             if (this.captureNode !== null)
                 this.pendingPromises.set(chunkId, { resolve, reject, timeout })
             try {

package/speechflow-cli/src/speechflow-util-error.ts

@@ -4,13 +4,6 @@
 **  Licensed under GPL 3.0 <https://spdx.org/licenses/GPL-3.0-only>
 */
 
-/*  helper function for promise-based timeout  */
-export function timeoutPromise<T = void> (duration: number = 10 * 1000, info = "timeout") {
-    return new Promise<T>((resolve, reject) => {
-        setTimeout(() => { reject(new Error(info)) }, duration)
-    })
-}
-
 /*  helper function for retrieving an Error object  */
 export function ensureError (error: unknown, prefix?: string, debug = false): Error {
     if (error instanceof Error && prefix === undefined && debug === false)

package/speechflow-cli/src/speechflow-util-misc.ts

@@ -6,7 +6,7 @@
 
 /*  sleep: wait a duration of time and then resolve  */
 export function sleep (durationMs: number) {
-    return new Promise<void>((resolve, reject) => {
+    return new Promise<void>((resolve) => {
         setTimeout(() => {
             resolve()
         }, durationMs)
@@ -14,10 +14,10 @@ export function sleep (durationMs: number) {
 }
 
 /*  timeout: wait a duration of time and then reject  */
-export function timeout (durationMs: number) {
-    return new Promise<never>((resolve, reject) => {
+export function timeout (durationMs: number, info = "timeout") {
+    return new Promise<never>((_resolve, reject) => {
         setTimeout(() => {
-            reject(new Error("timeout"))
+            reject(new Error(info))
         }, durationMs)
     })
 }

package/speechflow-cli/src/speechflow-util-queue.ts

@@ -34,7 +34,7 @@ export class SingleQueue<T> extends EventEmitter {
         this.emit("dequeue")
     }
     read () {
-        return new Promise<T>((resolve, reject) => {
+        return new Promise<T>((resolve) => {
             const tryToConsume = () => {
                 const item = this.queue.pop()
                 if (item !== undefined)
@@ -69,7 +69,7 @@ export class DoubleQueue<T0, T1> extends EventEmitter {
         this.notify()
     }
     read () {
-        return new Promise<[ T0, T1 ]>((resolve, reject) => {
+        return new Promise<[ T0, T1 ]>((resolve) => {
             const consume = (): [ T0, T1 ] | undefined => {
                 if (this.queue0.length > 0 && this.queue1.length > 0) {
                     const item0 = this.queue0.pop() as T0
@@ -90,7 +90,7 @@ export class DoubleQueue<T0, T1> extends EventEmitter {
     }
 }
 
-/*  queue element */
+/*  queue element  */
 export type QueueElement = { type: string }
 
 /*  queue pointer  */
@@ -228,7 +228,7 @@ export class Queue<T extends QueueElement> extends EventEmitter {
     }
     pointerDelete (name: string): void {
         if (!this.pointers.has(name))
-            throw new Error("pointer not exists")
+            throw new Error("pointer does not exist")
         this.pointers.delete(name)
     }
     trim (): void {

package/speechflow-cli/src/speechflow-util-stream.ts

@@ -204,7 +204,7 @@ export class StreamWrapper extends Stream.Transform {
 }
 
 /*  helper function for destruction of a stream  */
-export async function destroyStream(
+export async function destroyStream (
     stream: Stream.Readable | Stream.Writable | Stream.Duplex | Stream.Transform
 ) {
     /*  signal the end for a writable stream  */
@@ -217,8 +217,10 @@ export async function destroyStream(
             new Promise<void>((resolve) => {
                 stream.end(() => { resolve() })
             }),
-            util.timeoutPromise(5000, "stream end timeout")
-        ])
+            util.timeout(5000, "stream end timeout")
+        ]).catch(() => {
+            /*  ignore timeout -- stream will be destroyed anyway  */
+        })
 
     /*  destroy the stream  */
     stream.destroy()