codeoverflow-org · hlxid · Aug 21, 2023 · Aug 21, 2023
diff --git a/package-lock.json b/package-lock.json
diff --git a/samples/gametts/extension/index.ts b/samples/gametts/extension/index.ts
@@ -0,0 +1,41 @@
+import NodeCG from "@nodecg/types";
+import { requireService } from "nodecg-io-core";
+import { GameTTSClient } from "nodecg-io-gametts";
+
+/**
+ * Plays a hello world tts message inside the graphic of this sample bundle.
+ */
+async function playTTSInGraphic(client: GameTTSClient, nodecg: NodeCG.ServerAPI) {
+    const voices = client.getVoices();
+
+    // Get random voice
+    const voiceId = Object.values(voices)[Math.floor(Math.random() * Object.keys(voices).length)];
+    if (voiceId === undefined) throw new Error("no voice available");
+
+    const helloWorldUrl = client.generateWavUrl("Hallo aus Noud Zeh Geh: Ei Oh!", voiceId);
+    nodecg.sendMessage("setSrc", helloWorldUrl);
+}
+
+module.exports = function (nodecg: NodeCG.ServerAPI) {
+    nodecg.log.info("Sample bundle for the GameTTS service started.");
+
+    const gametts = requireService<GameTTSClient>(nodecg, "gametts");
+
+    nodecg.listenFor("ready", () => {
+        const client = gametts?.getClient();
+        if (client !== undefined) {
+            playTTSInGraphic(client, nodecg).catch((err) =>
+                nodecg.log.error(`Error while trying to play tts message: ${err.messages}`),
+            );
+        }
+    });
+
+    gametts?.onAvailable(async (client) => {
+        nodecg.log.info("GameTTS service available.");
+        await playTTSInGraphic(client, nodecg);
+    });
+
+    gametts?.onUnavailable(() => {
+        nodecg.log.info("GameTTS service unavailable.");
+    });
+};
diff --git a/samples/gametts/extension/tsconfig.json b/samples/gametts/extension/tsconfig.json
@@ -0,0 +1,11 @@
+{
+    "extends": "nodecg-io-tsconfig",
+    "references": [
+        {
+            "path": "../../../nodecg-io-core"
+        },
+        {
+            "path": "../../../services/nodecg-io-gametts"
+        }
+    ]
+}
diff --git a/samples/gametts/graphics/index.html b/samples/gametts/graphics/index.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <title>GameTTS Sample</title>
+    </head>
+    <body>
+        <audio controls id="gametts-audio"></audio>
+        <script type="module" src="index.js"></script>
+    </body>
+</html>
diff --git a/samples/gametts/graphics/index.ts b/samples/gametts/graphics/index.ts
@@ -0,0 +1,19 @@
+import { NodeCGAPIClient } from "@nodecg/types/client/api/api.client";
+
+declare global {
+    const nodecg: NodeCGAPIClient;
+    const NodeCG: typeof NodeCGAPIClient;
+}
+
+// Listens for event from gametts sample and plays the audio by the provided url.
+
+const audioElement = document.getElementById("gametts-audio") as HTMLAudioElement;
+
+// Play audio when the graphic is newly opened
+nodecg.sendMessage("ready");
+
+nodecg.listenFor("setSrc", (newSrc) => {
+    audioElement.src = newSrc;
+    audioElement.currentTime = 0;
+    audioElement.play();
+});
diff --git a/samples/gametts/graphics/tsconfig.json b/samples/gametts/graphics/tsconfig.json
@@ -0,0 +1,7 @@
+{
+    "extends": "nodecg-io-tsconfig",
+    "compilerOptions": {
+        "lib": ["ES2015", "dom"],
+        "module": "ES2015"
+    }
+}
diff --git a/samples/gametts/package.json b/samples/gametts/package.json
@@ -0,0 +1,27 @@
+{
+    "name": "gametts",
+    "version": "0.3.0",
+    "private": true,
+    "nodecg": {
+        "compatibleRange": ">=1.1.1 <3.0.0",
+        "bundleDependencies": {
+            "nodecg-io-gametts": "^0.3.0"
+        },
+        "graphics": [
+            {
+                "file": "index.html",
+                "width": "1920",
+                "height": "1080"
+            }
+        ]
+    },
+    "license": "MIT",
+    "dependencies": {
+        "@types/node": "^20.4.7",
+        "@nodecg/types": "^2.1.11",
+        "nodecg-io-core": "^0.3.0",
+        "nodecg-io-gametts": "^0.3.0",
+        "typescript": "^5.1.6",
+        "nodecg-io-tsconfig": "^1.0.0"
+    }
+}
diff --git a/samples/gametts/tsconfig.json b/samples/gametts/tsconfig.json
@@ -0,0 +1,14 @@
+{
+    "files": [],
+    "compilerOptions": {
+        "composite": true
+    },
+    "references": [
+        {
+            "path": "./extension"
+        },
+        {
+            "path": "./graphics"
+        }
+    ]
+}
diff --git a/samples/opentts/extension/tsconfig.json b/samples/opentts/extension/tsconfig.json
@@ -0,0 +1,11 @@
+{
+    "extends": "nodecg-io-tsconfig",
+    "references": [
+        {
+            "path": "../../../nodecg-io-core"
+        },
+        {
+            "path": "../../../services/nodecg-io-opentts"
+        }
+    ]
+}
diff --git a/samples/opentts/graphics/index.html b/samples/opentts/graphics/index.html
@@ -5,6 +5,6 @@
     </head>
     <body>
         <audio controls id="opentts-audio"></audio>
-        <script src="index.js"></script>
+        <script type="module" src="index.js"></script>
     </body>
 </html>
diff --git a/samples/opentts/graphics/tsconfig.json b/samples/opentts/graphics/tsconfig.json
@@ -0,0 +1,7 @@
+{
+    "extends": "nodecg-io-tsconfig",
+    "compilerOptions": {
+        "lib": ["ES2015", "dom"],
+        "module": "ES2015"
+    }
+}
diff --git a/samples/opentts/package.json b/samples/opentts/package.json
@@ -5,7 +5,7 @@
     "nodecg": {
         "compatibleRange": ">=1.1.1 <3.0.0",
         "bundleDependencies": {
-            "nodecg-io-template": "^0.3.0"
+            "nodecg-io-opentts": "^0.3.0"
         },
         "graphics": [
             {

diff --git a/samples/opentts/tsconfig.json b/samples/opentts/tsconfig.json
@@ -1,14 +1,14 @@
 {
-    "extends": "nodecg-io-tsconfig",
+    "files": [],
     "compilerOptions": {
-        "lib": ["dom"]
+        "composite": true
     },
     "references": [
         {
-            "path": "../../nodecg-io-core"
+            "path": "./extension"
         },
         {
-            "path": "../../services/nodecg-io-opentts"
+            "path": "./graphics"
         }
     ]
 }
diff --git a/services/nodecg-io-gametts/extension/gameTtsClient.ts b/services/nodecg-io-gametts/extension/gameTtsClient.ts
@@ -0,0 +1,61 @@
+import { GameTTSConfig } from "./index";
+import fetch, { Response } from "node-fetch";
+import { emptySuccess, error, ObjectMap, Result } from "nodecg-io-core";
+import { voiceMap } from "./voiceMap";
+
+export class GameTTSClient {
+    constructor(private readonly config: GameTTSConfig) {}
+
+    private buildBaseURL(): string {
+        const protocol = this.config.useHttps ? "https" : "http";
+        return `${protocol}://${this.config.host}`;
+    }
+
+    private async executeRequest(path: string): Promise<Response> {
+        const response = await fetch(this.buildBaseURL() + path);
+        if (!response.ok) {
+            throw new Error(`Failed to execute gametts request: ${await response.text()}`);
+        }
+
+        return response;
+    }
+
+    /**
+     * Get all the ids of all voices that gametts supports with a voice name as the object key.
+     */
+    getVoices(): ObjectMap<number> {
+        const voiceEntries = Object.entries(voiceMap).map(([key, value]) => [key, parseInt(value)]);
+        return Object.fromEntries(voiceEntries);
+    }
+
+    /**
+     * Generates a URL to a .wav file with the spoken text that is generated using GameTTS:
+     */
+    generateWavUrl(text: string, voiceId: number): string {
+        const params = new URLSearchParams({ text, speaker_id: voiceId.toString() });
+        return `${this.buildBaseURL()}/?${params}`;
+    }
+
+    /**
+     * Downloads the .wav file from the given URL and returns it as a Buffer.
+     * @param url the url generated by {@link generateWavUrl}
+     * @returns the wav file
+     */
+    async getWavData(url: string): Promise<ArrayBuffer> {
+        const response = await fetch(url);
+        if (!response.ok) {
+            throw new Error(`Failed to fetch wav audio data: ${await response.text()}`);
+        }
+
+        return await response.arrayBuffer();
+    }
+
+    async isGameTTSAvailable(): Promise<Result<void>> {
+        try {
+            await this.executeRequest("");
+            return emptySuccess();
+        } catch (err) {
+            return error(`Failed to connect to gametts instance at ${this.buildBaseURL()}: ${err}`);
+        }
+    }
+}