speechflow 1.6.5 → 1.6.6

package/speechflow-cli/src/speechflow-node-t2t-openai.ts

@@ -234,9 +234,9 @@ export default class SpeechFlowNodeT2TOpenAI extends SpeechFlowNode {
 
     /*  close node  */
     async close () {
-        /*  close stream  */
+        /*  shutdown stream  */
         if (this.stream !== null) {
-            this.stream.destroy()
+            await util.destroyStream(this.stream)
             this.stream = null
         }
 

package/speechflow-cli/src/speechflow-node-t2t-sentence.ts

@@ -33,7 +33,7 @@ export default class SpeechFlowNodeT2TSentence extends SpeechFlowNode {
     private queueRecv  = this.queue.pointerUse("recv")
     private queueSplit = this.queue.pointerUse("split")
     private queueSend  = this.queue.pointerUse("send")
-    private destroyed  = false
+    private closing  = false
     private workingOffTimer: ReturnType<typeof setTimeout> | null = null
 
     /*  construct node  */
@@ -51,12 +51,12 @@ export default class SpeechFlowNodeT2TSentence extends SpeechFlowNode {
     /*  open node  */
     async open () {
         /*  clear destruction flag  */
-        this.destroyed = false
+        this.closing = false
 
         /*  work off queued text frames  */
         let workingOff = false
         const workOffQueue = async () => {
-            if (this.destroyed)
+            if (this.closing)
                 return
 
             /*  control working off round  */
@@ -70,7 +70,7 @@ export default class SpeechFlowNodeT2TSentence extends SpeechFlowNode {
             this.queue.off("write", workOffQueue)
 
             /*  try to work off one or more chunks  */
-            while (!this.destroyed) {
+            while (!this.closing) {
                 const element = this.queueSplit.peek()
                 if (element === undefined)
                     break
@@ -134,7 +134,7 @@ export default class SpeechFlowNodeT2TSentence extends SpeechFlowNode {
 
             /*  re-initiate working off round (if still not destroyed)  */
             workingOff = false
-            if (!this.destroyed) {
+            if (!this.closing) {
                 this.workingOffTimer = setTimeout(workOffQueue, 100)
                 this.queue.once("write", workOffQueue)
             }
@@ -151,7 +151,7 @@ export default class SpeechFlowNodeT2TSentence extends SpeechFlowNode {
 
             /*  receive text chunk (writable side of stream)  */
             write (chunk: SpeechFlowChunk, encoding, callback) {
-                if (self.destroyed)
+                if (self.closing)
                     callback(new Error("stream already destroyed"))
                 else if (Buffer.isBuffer(chunk.payload))
                     callback(new Error("expected text input as string chunks"))
@@ -166,7 +166,7 @@ export default class SpeechFlowNodeT2TSentence extends SpeechFlowNode {
 
             /*  receive no more text chunks (writable side of stream)  */
             final (callback) {
-                if (self.destroyed) {
+                if (self.closing) {
                     callback()
                     return
                 }
@@ -179,7 +179,7 @@ export default class SpeechFlowNodeT2TSentence extends SpeechFlowNode {
             read (_size) {
                 /*  flush pending text chunks  */
                 const flushPendingChunks = () => {
-                    if (self.destroyed) {
+                    if (self.closing) {
                         this.push(null)
                         return
                     }
@@ -210,7 +210,7 @@ export default class SpeechFlowNodeT2TSentence extends SpeechFlowNode {
                             self.queue.trim()
                         }
                     }
-                    else if (!self.destroyed)
+                    else if (!self.closing)
                         self.queue.once("write", flushPendingChunks)
                 }
                 flushPendingChunks()
@@ -220,8 +220,8 @@ export default class SpeechFlowNodeT2TSentence extends SpeechFlowNode {
 
     /*  close node  */
     async close () {
-        /*  indicate destruction  */
-        this.destroyed = true
+        /*  indicate closing  */
+        this.closing = true
 
         /*  clean up timer  */
         if (this.workingOffTimer !== null) {
@@ -232,9 +232,9 @@ export default class SpeechFlowNodeT2TSentence extends SpeechFlowNode {
         /*  remove any pending event listeners  */
         this.queue.removeAllListeners("write")
 
-        /*  close stream  */
+        /*  shutdown stream  */
         if (this.stream !== null) {
-            this.stream.destroy()
+            await util.destroyStream(this.stream)
             this.stream = null
         }
     }

package/speechflow-cli/src/speechflow-node-t2t-subtitle.ts

@@ -257,9 +257,9 @@ export default class SpeechFlowNodeT2TSubtitle extends SpeechFlowNode {
 
     /*  close node  */
     async close () {
-        /*  close stream  */
+        /*  shutdown stream  */
         if (this.stream !== null) {
-            this.stream.destroy()
+            await util.destroyStream(this.stream)
             this.stream = null
         }
 

package/speechflow-cli/src/speechflow-node-t2t-transformers.ts

@@ -227,9 +227,9 @@ export default class SpeechFlowNodeT2TTransformers extends SpeechFlowNode {
 
     /*  close node  */
     async close () {
-        /*  close stream  */
+        /*  shutdown stream  */
         if (this.stream !== null) {
-            this.stream.destroy()
+            await util.destroyStream(this.stream)
             this.stream = null
         }
 

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

@@ -125,9 +125,9 @@ export default class SpeechFlowNodeX2XFilter extends SpeechFlowNode {
 
     /*  close node  */
     async close () {
-        /*  close stream  */
+        /*  shutdown stream  */
         if (this.stream !== null) {
-            this.stream.destroy()
+            await util.destroyStream(this.stream)
             this.stream = null
         }
     }

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

@@ -12,6 +12,7 @@ import { Duration } from "luxon"
 
 /*  internal dependencies  */
 import SpeechFlowNode, { SpeechFlowChunk } from "./speechflow-node"
+import * as util                           from "./speechflow-util"
 
 /*  SpeechFlow node for data flow tracing  */
 export default class SpeechFlowNodeX2XTrace extends SpeechFlowNode {
@@ -19,7 +20,7 @@ export default class SpeechFlowNodeX2XTrace extends SpeechFlowNode {
     public static name = "x2x-trace"
 
     /*  internal state  */
-    private destroyed = false
+    private closing = false
 
     /*  construct node  */
     constructor (id: string, cfg: { [ id: string ]: any }, opts: { [ id: string ]: any }, args: any[]) {
@@ -56,7 +57,7 @@ export default class SpeechFlowNodeX2XTrace extends SpeechFlowNode {
         }
 
         /*  clear destruction flag  */
-        this.destroyed = false
+        this.closing = false
 
         /*  helper functions for formatting  */
         const fmtTime = (t: Duration) => t.toFormat("hh:mm:ss.SSS")
@@ -84,7 +85,7 @@ export default class SpeechFlowNodeX2XTrace extends SpeechFlowNode {
             highWaterMark:      1,
             transform (chunk: SpeechFlowChunk, encoding, callback) {
                 let error: Error | undefined
-                if (self.destroyed) {
+                if (self.closing) {
                     callback(new Error("stream already destroyed"))
                     return
                 }
@@ -118,7 +119,7 @@ export default class SpeechFlowNodeX2XTrace extends SpeechFlowNode {
                 }
             },
             final (callback) {
-                if (self.destroyed || self.params.mode === "sink") {
+                if (self.closing || self.params.mode === "sink") {
                     callback()
                     return
                 }
@@ -130,13 +131,13 @@ export default class SpeechFlowNodeX2XTrace extends SpeechFlowNode {
 
     /*  close node  */
     async close () {
-        /*  close stream  */
+        /*  indicate closing  */
+        this.closing = true
+
+        /*  shutdown stream  */
         if (this.stream !== null) {
-            this.stream.destroy()
+            await util.destroyStream(this.stream)
             this.stream = null
         }
-
-        /*  indicate destruction  */
-        this.destroyed = true
     }
 }

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

@@ -36,6 +36,10 @@ export default class SpeechFlowNodeXIODevice extends SpeechFlowNode {
             chunk:  { type: "number", pos: 2, val: 200,  match: (n: number) => n >= 10 && n <= 1000 }
         })
 
+        /*  sanity check parameters  */
+        if (this.params.device === "")
+            throw new Error("required parameter \"device\" has to be given")
+
         /*  declare node input/output format  */
         if (this.params.mode === "rw") {
             this.input  = "audio"
@@ -163,9 +167,6 @@ export default class SpeechFlowNodeXIODevice extends SpeechFlowNode {
 
     /*  open node  */
     async open () {
-        if (this.params.device === "")
-            throw new Error("required parameter \"device\" has to be given")
-
         /*  determine device  */
         const device = this.audioDeviceFromURL(this.params.mode, this.params.device)
 

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

@@ -30,6 +30,10 @@ export default class SpeechFlowNodeXIOFile extends SpeechFlowNode {
             chunkt: { type: "number",         val: 65536,   match: (n: number) => n >= 1024 && n <= 131072 }
         })
 
+        /*  sanity check parameters  */
+        if (this.params.path === "")
+            throw new Error("required parameter \"path\" has to be given")
+
         /*  declare node input/output format  */
         if (this.params.mode === "rw") {
             this.input  = this.params.type
@@ -55,10 +59,6 @@ export default class SpeechFlowNodeXIOFile extends SpeechFlowNode {
         ) / (1000 / this.params.chunka)
         const highWaterMarkText = this.params.chunkt
 
-        /*  sanity check  */
-        if (this.params.path === "")
-            throw new Error("required parameter \"path\" has to be given")
-
         /*  utility function: create a writable stream as chunker that
             writes to process.stdout but properly handles finish events.
             This ensures the writable side of the composed stream below
@@ -195,24 +195,25 @@ export default class SpeechFlowNodeXIOFile extends SpeechFlowNode {
     async close () {
         /*  shutdown stream  */
         if (this.stream !== null) {
-            await Promise.race([
-                new Promise<void>((resolve, reject) => {
-                    if (this.stream instanceof Stream.Writable || this.stream instanceof Stream.Duplex) {
-                        if (this.stream.writableEnded || this.stream.destroyed)
-                            resolve()
-                        else
-                            this.stream.end((err?: Error) => {
+            /*  only destroy non-stdio streams  */
+            if (this.params.path !== "-")
+                await util.destroyStream(this.stream)
+            else {
+                /*  for stdio streams, just end without destroying  */
+                const stream = this.stream
+                if ((stream instanceof Stream.Writable || stream instanceof Stream.Duplex) &&
+                    (!stream.writableEnded && !stream.destroyed)                             ) {
+                    await Promise.race([
+                        new Promise<void>((resolve, reject) => {
+                            stream.end((err?: Error) => {
                                 if (err) reject(err)
                                 else     resolve()
                             })
-                    }
-                    else
-                        resolve()
-                }),
-                new Promise<void>((resolve) => setTimeout(() => resolve(), 5000))
-            ])
-            if (this.params.path !== "-")
-                this.stream.destroy()
+                        }),
+                        util.timeoutPromise(5000)
+                    ])
+                }
+            }
             this.stream = null
         }
     }

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

@@ -40,6 +40,18 @@ export default class SpeechFlowNodeXIOMQTT extends SpeechFlowNode {
             type:       { type: "string", pos: 6, val: "text", match: /^(?:audio|text)$/ }
         })
 
+        /*  sanity check parameters  */
+        if (this.params.url === "")
+            throw new Error("required parameter \"url\" has to be given")
+        if ((this.params.mode === "w" || this.params.mode === "rw") && this.params.topicWrite === "")
+            throw new Error("writing to MQTT requires a topicWrite parameter")
+        if ((this.params.mode === "r" || this.params.mode === "rw") && this.params.topicRead === "")
+            throw new Error("reading from MQTT requires a topicRead parameter")
+        if (this.params.username !== "" && this.params.password === "")
+            throw new Error("username provided but password is missing")
+        if (this.params.username === "" && this.params.password !== "")
+            throw new Error("password provided but username is missing")
+
         /*  declare node input/output format  */
         if (this.params.mode === "rw") {
             this.input  = this.params.type
@@ -57,18 +69,6 @@ export default class SpeechFlowNodeXIOMQTT extends SpeechFlowNode {
 
     /*  open node  */
     async open () {
-        /*  logical parameter sanity check  */
-        if (this.params.url === "")
-            throw new Error("required parameter \"url\" has to be given")
-        if ((this.params.mode === "w" || this.params.mode === "rw") && this.params.topicWrite === "")
-            throw new Error("writing to MQTT requires a topicWrite parameter")
-        if ((this.params.mode === "r" || this.params.mode === "rw") && this.params.topicRead === "")
-            throw new Error("reading from MQTT requires a topicRead parameter")
-        if (this.params.username !== "" && this.params.password === "")
-            throw new Error("username provided but password is missing")
-        if (this.params.username === "" && this.params.password !== "")
-            throw new Error("password provided but username is missing")
-
         /*  connect remotely to a MQTT broker  */
         this.broker = MQTT.connect(this.params.url, {
             protocolId:      "MQTT",
@@ -158,9 +158,9 @@ export default class SpeechFlowNodeXIOMQTT extends SpeechFlowNode {
             this.broker = null
         }
 
-        /*  close stream  */
+        /*  shutdown stream  */
         if (this.stream !== null) {
-            this.stream.destroy()
+            await util.destroyStream(this.stream)
             this.stream = null
         }
     }

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

@@ -36,6 +36,12 @@ export default class SpeechFlowNodeXIOWebSocket extends SpeechFlowNode {
             type:    { type: "string", val: "text", match: /^(?:audio|text)$/ }
         })
 
+        /*  sanity check parameters  */
+        if (this.params.listen !== "" && this.params.connect !== "")
+            throw new Error("Websocket node cannot listen and connect at the same time")
+        else if (this.params.listen === "" && this.params.connect === "")
+            throw new Error("Websocket node requires either listen or connect mode")
+
         /*  declare node input/output format  */
         if (this.params.mode === "rw") {
             this.input  = this.params.type
@@ -53,12 +59,6 @@ export default class SpeechFlowNodeXIOWebSocket extends SpeechFlowNode {
 
     /*  open node  */
     async open () {
-        /*  sanity check usage  */
-        if (this.params.listen !== "" && this.params.connect !== "")
-            throw new Error("Websocket node cannot listen and connect at the same time")
-        else if (this.params.listen === "" && this.params.connect === "")
-            throw new Error("Websocket node requires either listen or connect mode")
-
         if (this.params.listen !== "") {
             /*  listen locally on a Websocket port  */
             const url = new URL(this.params.listen)
@@ -136,8 +136,8 @@ export default class SpeechFlowNodeXIOWebSocket extends SpeechFlowNode {
                         }
                         Promise.all(results).then(() => {
                             callback()
-                        }).catch((error: Error) => {
-                            callback(error)
+                        }).catch((error: unknown) => {
+                            callback(util.ensureError(error))
                         })
                     }
                 },
@@ -240,9 +240,9 @@ export default class SpeechFlowNodeXIOWebSocket extends SpeechFlowNode {
             this.client = null
         }
 
-        /*  close stream  */
+        /*  shutdown stream  */
         if (this.stream !== null) {
-            this.stream.destroy()
+            await util.destroyStream(this.stream)
             this.stream = null
         }
     }

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

@@ -44,12 +44,12 @@ export default class SpeechFlowNode extends Events.EventEmitter {
 
     /*  general constant configuration (for reference)  */
     config = {
-        audioChannels:     1,                            /* audio mono channel        */
-        audioBitDepth:     16 as (1 | 8 | 16 | 24 | 32), /* audio PCM 16-bit integer  */
-        audioLittleEndian: true,                         /* audio PCM little-endian   */
-        audioSampleRate:   48000,                        /* audio 48kHz sample rate   */
-        textEncoding:      "utf8" as BufferEncoding,     /* UTF-8 text encoding       */
-        cacheDir:          ""                            /* directory for cache files */
+        audioChannels:     1,                            /*  audio mono channel         */
+        audioBitDepth:     16 as (1 | 8 | 16 | 24 | 32), /*  audio PCM 16-bit integer   */
+        audioLittleEndian: true,                         /*  audio PCM little-endian    */
+        audioSampleRate:   48000,                        /*  audio 48kHz sample rate    */
+        textEncoding:      "utf8" as BufferEncoding,     /*  UTF-8 text encoding        */
+        cacheDir:          ""                            /*  directory for cache files  */
     }
 
     /*  announced information  */

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

@@ -288,7 +288,7 @@ export class WebAudio {
             this.pendingPromises.clear()
         }
         catch (_err) {
-            /* ignored - cleanup during shutdown */
+            /*  ignored -- cleanup during shutdown  */
         }
 
         /*  disconnect nodes  */

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

@@ -41,7 +41,7 @@ export function createTransformStreamForReadableSide (type: "text" | "audio", ge
         readableObjectMode: true,
         writableObjectMode: true,
         decodeStrings: false,
-        highWaterMark: highWaterMark ?? (type === "audio" ? 19200 : 65536), /* audio: 400ms @ 48kHz/16bit/mono, text: 64KB */
+        highWaterMark: highWaterMark ?? (type === "audio" ? 19200 /* 400ms */: 65536 /* 64KB */),
         transform (chunk: Buffer | string, encoding, callback) {
             if (chunk === null) {
                 this.push(null)
@@ -88,7 +88,8 @@ type SpeechFlowChunkSerialized = {
     timestampEnd:   number,
     kind:           string,
     type:           string,
-    payload:        Uint8Array
+    payload:        Uint8Array,
+    meta?:          Array<[ string, any ]>
 }
 
 /*  encode/serialize chunk of data  */
@@ -100,13 +101,15 @@ export function streamChunkEncode (chunk: SpeechFlowChunk) {
         const encoder = new TextEncoder()
         payload = encoder.encode(chunk.payload)
     }
-    const data = {
+    const data: SpeechFlowChunkSerialized = {
         timestampStart: chunk.timestampStart.toMillis(),
         timestampEnd:   chunk.timestampEnd.toMillis(),
         kind:           chunk.kind,
         type:           chunk.type,
         payload
-    } satisfies SpeechFlowChunkSerialized
+    }
+    if (chunk.meta.size > 0)
+        data.meta = Array.from(chunk.meta.entries())
     const _data = CBOR.encode(data)
     return _data
 }
@@ -130,7 +133,8 @@ export function streamChunkDecode (_data: Uint8Array) {
         Duration.fromMillis(data.timestampEnd),
         data.kind as "intermediate" | "final",
         data.type as "audio" | "text",
-        payload
+        payload,
+        data.meta ? new Map(data.meta) : undefined
     )
     return chunk
 }
@@ -195,3 +199,24 @@ export class StreamWrapper extends Stream.Transform {
         super._destroy(error, callback)
     }
 }
+
+/*  helper function for destruction of a stream  */
+export async function destroyStream(
+    stream: Stream.Readable | Stream.Writable | Stream.Duplex | Stream.Transform
+) {
+    /*  signal the end for a writable stream  */
+    if ((stream instanceof Stream.Duplex    ||
+         stream instanceof Stream.Transform ||
+         stream instanceof Stream.Writable    ) &&
+        (!stream.writableEnded &&
+         !stream.destroyed       )                )
+        await Promise.race([
+            new Promise<void>((resolve) => {
+                stream.end(() => { resolve() })
+            }),
+            util.timeoutPromise(5000, "stream end timeout")
+        ])
+
+    /*  destroy the stream  */
+    stream.destroy()
+}