speechflow 1.0.0 → 1.2.0

package/src/speechflow.ts

@@ -5,31 +5,33 @@
 */
 
 /*  standard dependencies  */
-import path                     from "node:path"
-import Stream                   from "node:stream"
-import { EventEmitter }         from "node:events"
-import http                     from "node:http"
-import * as HAPI                from "@hapi/hapi"
-import WebSocket                from "ws"
-import HAPIWebSocket            from "hapi-plugin-websocket"
-import HAPIHeader               from "hapi-plugin-header"
+import path              from "node:path"
+import Stream            from "node:stream"
+import { EventEmitter }  from "node:events"
+import http              from "node:http"
+import * as HAPI         from "@hapi/hapi"
+import WebSocket         from "ws"
+import HAPIWebSocket     from "hapi-plugin-websocket"
+import HAPIHeader        from "hapi-plugin-header"
 
 /*  external dependencies  */
-import { DateTime }             from "luxon"
-import CLIio                    from "cli-io"
-import yargs                    from "yargs"
-import { hideBin }              from "yargs/helpers"
-import jsYAML                   from "js-yaml"
-import FlowLink                 from "flowlink"
-import objectPath               from "object-path"
-import installedPackages        from "installed-packages"
-import dotenvx                  from "@dotenvx/dotenvx"
-import syspath                  from "syspath"
-import * as arktype             from "arktype"
+import { DateTime }      from "luxon"
+import CLIio             from "cli-io"
+import yargs             from "yargs"
+import { hideBin }       from "yargs/helpers"
+import jsYAML            from "js-yaml"
+import FlowLink          from "flowlink"
+import objectPath        from "object-path"
+import installedPackages from "installed-packages"
+import dotenvx           from "@dotenvx/dotenvx"
+import syspath           from "syspath"
+import * as arktype      from "arktype"
+import Table             from "cli-table3"
+import chalk             from "chalk"
 
 /*  internal dependencies  */
-import SpeechFlowNode           from "./speechflow-node"
-import pkg                      from "../package.json"
+import SpeechFlowNode    from "./speechflow-node"
+import pkg               from "../package.json"
 
 /*  central CLI context  */
 let cli: CLIio | null = null
@@ -63,11 +65,13 @@ type wsPeerInfo = {
             "[-a|--address <ip-address>] " +
             "[-p|--port <tcp-port>] " +
             "[-C|--cache <directory>] " +
+            "[-S|--status] " +
             "[-e|--expression <expression>] " +
             "[-f|--file <file>] " +
             "[-c|--config <id>@<yaml-config-file>] " +
             "[<argument> [...]]"
         )
+        .version(false)
         .option("V", {
             alias:    "version",
             type:     "boolean",
@@ -112,6 +116,14 @@ type wsPeerInfo = {
             default:  path.join(dataDir, "cache"),
             describe: "directory for cached files (primarily AI model files)"
         })
+        .option("S", {
+            alias:    "status",
+            type:     "boolean",
+            array:    false,
+            coerce,
+            default:  false,
+            describe: "show one-time status of nodes"
+        })
         .option("e", {
             alias:    "expression",
             type:     "string",
@@ -142,7 +154,6 @@ type wsPeerInfo = {
         .help("h", "show usage help")
         .alias("h", "help")
         .showHelpOnFail(true)
-        .version(false)
         .strict()
         .demand(0)
         .parse(hideBin(process.argv))
@@ -223,6 +234,7 @@ type wsPeerInfo = {
         "./speechflow-node-a2a-wav.js",
         "./speechflow-node-a2a-mute.js",
         "./speechflow-node-a2a-meter.js",
+        "./speechflow-node-a2a-gender.js",
         "./speechflow-node-a2a-vad.js",
         "./speechflow-node-a2t-deepgram.js",
         "./speechflow-node-t2a-elevenlabs.js",
@@ -233,6 +245,7 @@ type wsPeerInfo = {
         "./speechflow-node-t2t-transformers.js",
         "./speechflow-node-t2t-subtitle.js",
         "./speechflow-node-t2t-format.js",
+        "./speechflow-node-x2x-filter.js",
         "./speechflow-node-x2x-trace.js",
         "./speechflow-node-xio-device.js",
         "./speechflow-node-xio-file.js",
@@ -268,6 +281,45 @@ type wsPeerInfo = {
         }
     }
 
+    /*  static configuration  */
+    const cfg = {
+        audioChannels:     1,
+        audioBitDepth:     16,
+        audioLittleEndian: true,
+        audioSampleRate:   48000,
+        textEncoding:      "utf8",
+        cacheDir:          args.C
+    }
+
+    /*  handle one-time status query of nodes  */
+    if (args.S) {
+        const table = new Table({
+            head: [
+                chalk.reset.bold("NODE"),
+                chalk.reset.bold("PROPERTY"),
+                chalk.reset.bold("VALUE")
+            ],
+            colWidths: [ 15, 15, 50 - (2 * 2 + 2 * 3) ],
+            style: { "padding-left": 1, "padding-right": 1, border: [ "grey" ], compact: true },
+            chars: { "left-mid": "", mid: "", "mid-mid": "", "right-mid": "" }
+        })
+        for (const name of Object.keys(nodes)) {
+            cli!.log("info", `gathering status of node <${name}>`)
+            const node = new nodes[name](name, cfg, {}, [])
+            const status = await node.status()
+            if (Object.keys(status).length > 0) {
+                let first = true
+                for (const key of Object.keys(status)) {
+                    table.push([ first ? chalk.bold(name) : "", key, chalk.blue(status[key]) ])
+                    first = false
+                }
+            }
+        }
+        const output = table.toString()
+        process.stdout.write(output + "\n")
+        process.exit(0)
+    }
+
     /*  graph processing: PASS 1: parse DSL and create and connect nodes  */
     const flowlink = new FlowLink<SpeechFlowNode>({
         trace: (msg: string) => {
@@ -277,14 +329,6 @@ type wsPeerInfo = {
     const variables = { argv: args._, env: process.env }
     const graphNodes = new Set<SpeechFlowNode>()
     const nodeNums = new Map<typeof SpeechFlowNode, number>()
-    const cfg = {
-        audioChannels:     1,
-        audioBitDepth:     16,
-        audioLittleEndian: true,
-        audioSampleRate:   48000,
-        textEncoding:      "utf8",
-        cacheDir:          args.C
-    }
     let ast: unknown
     try {
         ast = flowlink.compile(config)
@@ -429,9 +473,22 @@ type wsPeerInfo = {
             throw new Error(`stream of node "${node.id}" still not initialized`)
         cli!.log("info", `observe stream of node "${node.id}" for finish event`)
         activeNodes.add(node)
+        node.stream.on("end", () => {
+            if (activeNodes.has(node))
+                activeNodes.delete(node)
+            cli!.log("info", `readable stream of node "${node.id}" ended (${activeNodes.size} nodes remaining active)`)
+            if (activeNodes.size === 0) {
+                const timeFinished = DateTime.now()
+                const duration = timeFinished.diff(timeZero)
+                cli!.log("info", "everything finished -- stream processing in SpeechFlow graph stops " +
+                    `(total duration: ${duration.toFormat("hh:mm:ss.SSS")})`)
+                finishEvents.emit("finished")
+            }
+        })
         node.stream.on("finish", () => {
-            activeNodes.delete(node)
-            cli!.log("info", `stream of node "${node.id}" finished (${activeNodes.size} nodes remaining active)`)
+            if (activeNodes.has(node))
+                activeNodes.delete(node)
+            cli!.log("info", `writable stream of node "${node.id}" finished (${activeNodes.size} nodes remaining active)`)
             if (activeNodes.size === 0) {
                 const timeFinished = DateTime.now()
                 const duration = timeFinished.diff(timeZero)
@@ -654,10 +711,14 @@ type wsPeerInfo = {
         }
 
         /*  terminate process  */
-        if (signal === "finished")
+        if (signal === "finished") {
+            cli!.log("info", "terminate process (exit code 0)")
             process.exit(0)
-        else
+        }
+        else {
+            cli!.log("info", "terminate process (exit code 1)")
             process.exit(1)
+        }
     }
     finishEvents.on("finished", () => {
         shutdown("finished")
@@ -678,7 +739,7 @@ type wsPeerInfo = {
     if (cli !== null)
         cli.log("error", err.message)
     else
-        process.stderr.write(`${pkg.name}: ERROR: ${err.message}\n`)
+        process.stderr.write(`${pkg.name}: ${chalk.red("ERROR")}: ${err.message} ${err.stack}\n`)
     process.exit(1)
 })