node-red-contrib-tts-ultimate 2.0.6 → 2.0.8

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 [![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square)](https://www.paypal.me/techtoday) 
 
+<p>
+<b>Version 2.0.8</b> November 2024<br/>
+- NEW: ElevenLabs V2 Multilingual TTS Engine has been added.<br/>
+- ElevenLabs V1 is now in legacy/deprecation state.<br/>
+</p>
+<p>
+<b>Version 2.0.7</b> January 2024<br/>
+- NEW: input messages can override selected voice.<br/>
+</p>
 <p>
 <b>Version 2.0.6</b> January 2024<br/>
 - Minor fixes.<br/>

package/README.md

@@ -42,11 +42,10 @@ This is a major ***upgrade from the previously popular node SonosPollyTTS*** (So
 * **Amazon Voices, Gooogle Translate Voices, Google TTS Voices, Microsoft TTS Azure voices and Elevenlabs.io voices** are all supported, with all avaiables languages and genders.
 * **Automatic grouping** is supported. You can group all players you want to play your announcements.
 * **Automatic discovery** of your players.
-* **Automatic resume of music** queue (including radio stations, but here, some users reports problem resuming ***radio stations*** and, because of lack of Sonos API documentation, the issue cannot currently be fixed), at exact track, at exact time.
-* **TTS caching**. Amazon AWS and Google charges you if you use they tts service for a high rate of text to speech requests. TTS-Ultimate caches the TTS files. It downloads the TTS audio from Amazon or Google only once. The second time, the node will read it from the cache. The caches is resilient, that means it survives reboots and updates.
-* **UPLOAD your own audio files**. You can upload your own audio files with OwnFile node.
+* **Automatic resume of music** queue (including radio stations, but here, some users reports problem resuming ***radio stations*** and, because of lack of Sonos API documentation, the issue cannot currently be fixed), at exact track, at exact time. **Be aware that this could not work with all music queues**.
+* **TTS caching**. Elevenlabs, Amazon AWS and Google charges you if you use they tts service for a high rate of text to speech requests. TTS-Ultimate caches the TTS files. It downloads the TTS audio from Amazon or Google only once. The second time, the node will read it from the cache. The caches is resilient, that means it survives reboots and updates.
 * **Can work offline**. You can use your own audio files (with OwnFile node) to make the node works offline.
-* Send a simple payload with the text you want to speech out. For example <code>node.send({payload:"Hello there!"});</code>.
+* **UPLOAD your own audio files**. You can also upload your own audio files with OwnFile node.
 
 >
 > ***UPDATE PATH FROM SONOSPOLLYTTS TO TTS-ULTIMATE***
@@ -75,7 +74,7 @@ PORT USED BY THE NODE ARE 1980 (DEFAULT) AND 1400 (FOR SONOS DISCOVER). <br/>
 PLEASE ALLOW MDNS AND UDP AS WELL
 
 **TTS Service**<br/>
-You can choose between Google (without credentials), Amazon AWS (Polly), Google TTS (require credentials and registration to google) or Microsoft Azure TTS engines.<br/>
+You can choose between Elevenlabs.io, Google (without credentials), Amazon AWS (Polly), Google TTS (require credentials and registration to google) or Microsoft Azure TTS engines.<br/>
 For Google TTS Engine, you can choose pitch and speed rate of the voice.
 <br/>
 <br/>
@@ -114,6 +113,11 @@ For Google TTS Engine, you can choose pitch and speed rate of the voice.
    
 <br/>
 
+* **TTS Service using ElevenLabs**<br/>
+    Please use the V2 engine, as the V1 is deprecated and will not longer be supported. The V2 has multilingual voices and is more powerful.  
+    You have two choiches: To register to eventlabs, or not to register. If you don't register to elevenlabs.io, you will either have access on a limited amount of voices, or no access at all.  
+    After registration at elevenlabs.io, you can add any language to your personal list. The personal list will be then show in the node voice's list.<br/>    
+<br/>
 
 **Node-Red IP**<br/>
 set IP of your node-red machine. Write **AUTODISCOVER** to allow the node to auto discover your IP.
@@ -157,6 +161,13 @@ msg.payload = "I won't disturb with my hailing, this time.";
 return msg;
 ```
 
+```js
+// Play a message with custom voice ID
+msg.payload = "Hello, the current temperature is 12°";
+msg.voiceId = 2
+return msg;
+```
+
 ```js
 // Play smoke detection
 msg.sonoshailing = "SmokeAlert";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-tts-ultimate",
-  "version": "2.0.6",
+  "version": "2.0.8",
   "description": "Transforms the text in speech and hear it using Sonos player or generate an audio file to be used with third parties nodes. Works with voices from Amazon, Google (without credentials as well), Microsoft TTS Azure, ElevenLabs.io TTS or your own voice. You can also only create a TTS file to be read by third party nodes. Update of the popular SonosPollyTTS node.",
   "main": "index.js",
   "scripts": {
@@ -41,14 +41,14 @@
   "homepage": "https://github.com/Supergiovane/node-red-contrib-tts-ultimate",
   "dependencies": {
     "aws-sdk": "2.1444.0",
-    "fs": "0.0.1-security",
     "sonos": "1.14.1",
     "formidable": "1.2.2",
     "path": ">=0.12.7",
     "@google-cloud/text-to-speech": "4.2.2",
     "google-translate-tts": ">=0.3.0",
     "microsoft-cognitiveservices-speech-sdk": "1.29.0",
-    "elevenlabs-node": "1.1.3"
+    "elevenlabs-node": "1.1.3",
+    "elevenlabs": "0.18.0"
   },
   "devDependencies": {
     "eslint": ">=4.18.2",

package/ttsultimate/ttsultimate-config.html

@@ -63,27 +63,27 @@
             // 22/12/2020 Hide parts of the ui
             // ##########################################################
             $("#node-config-input-ttsservice").change(function (e) {
-                if ($("#node-config-input-ttsservice").val() == "polly") {
+                if ($("#node-config-input-ttsservice").val() === "polly") {
                     $("#GoogleForm").hide();
                     $("#microsoftAzureForm").hide();
                     $("#elevenlabsForm").hide();
                     $("#pollyForm").show();
-                } else if ($("#node-config-input-ttsservice").val() == "googletts") {
+                } else if ($("#node-config-input-ttsservice").val() === "googletts") {
                     $("#microsoftAzureForm").hide();
                     $("#pollyForm").hide();
                     $("#elevenlabsForm").hide();
                     $("#GoogleForm").show();
-                } else if ($("#node-config-input-ttsservice").val() == "googletranslate") {
+                } else if ($("#node-config-input-ttsservice").val() === "googletranslate") {
                     $("#pollyForm").hide();
                     $("#GoogleForm").hide();
                     $("#microsoftAzureForm").hide();
                     $("#elevenlabsForm").hide();
-                } else if ($("#node-config-input-ttsservice").val() == "microsoftazuretts") {
+                } else if ($("#node-config-input-ttsservice").val() === "microsoftazuretts") {
                     $("#pollyForm").hide();
                     $("#GoogleForm").hide();
                     $("#elevenlabsForm").hide();
                     $("#microsoftAzureForm").show();
-                } else if ($("#node-config-input-ttsservice").val() == "elevenlabs") {
+                } else if ($("#node-config-input-ttsservice").val().includes("elevenlabs")) {
                     $("#pollyForm").hide();
                     $("#GoogleForm").hide();
                     $("#microsoftAzureForm").hide();
@@ -182,9 +182,10 @@
             <select id="node-config-input-ttsservice">
                 <option value="polly">Amazon Polly</option>
                 <option value="googletts">Google TTS</option>
-                <option value="googletranslate">Google without authentication</option>   
+                <option value="googletranslate">Google free TTS</option>   
                 <option value="microsoftazuretts">Microsoft Azure TTS</option>
-                <option value="elevenlabs">ElevenLabs TTS (elevenlabs.io)</option>
+                <option value="elevenlabs">ElevenLabs TTS V1 (deprecated)</option>
+                <option value="elevenlabsv2">ElevenLabs TTS V2 Multilingual</option>
             </select>&nbsp&nbsp<b><span style="color:red"><i class="fa fa-question-circle"></i>&nbsp<a target="_blank" href="https://github.com/Supergiovane/node-red-contrib-tts-ultimate"><u>Help configure</u></a></span>
         </div>
         <div id="pollyForm">
@@ -252,7 +253,8 @@ For Google TTS Engine, you can choose pitch and speed rate of the voice.
 <br/>
 <br/>
 
-* **TTS Service using Amazon AWS (Polly)**<br/>
+* **TTS Service using Amazon AWS (Polly)**
+
     > HOW-TO in Deutsch: for german users, there is a very helpful how-to, where you can learn how to use the node and how to register to Amazon AWS Polly as well: here: https://technikkram.net/blog/2020/09/26/sonos-sprachausgabe-mit-raspberry-pi-node-red-und-amazon-polly-fuer-homematic-oder-knx-systeme
     
     **AWS Access key**<br/>
@@ -262,12 +264,14 @@ For Google TTS Engine, you can choose pitch and speed rate of the voice.
     AWS access Secret key. 
 <br/>
 
-* **TTS Service using Google (without credentials)**<br/>
+* **TTS Service using Google (without credentials)**
+
     This is the simplest way. Just select the voice and you're done. You don't need any credential and you don't even need to be registered to any google service. The voice list is more limited than other services, but it works without hassles.
     
 <br/>
 
-* **TTS Service using Google TTS**<br/>
+* **TTS Service using Google TTS**
+
     For Google TTS Engine, you can choose pitch and speed rate of the voice.<br/>
     **Google credentials file path**<br/>
     Here you must select your credential file, previously downloaded from Google, [with these steps](https://www.npmjs.com/package/@google-cloud/text-to-speech):
@@ -275,10 +279,10 @@ For Google TTS Engine, you can choose pitch and speed rate of the voice.
     > [Enable billing for your project](https://support.google.com/cloud/answer/6293499#enable-billing)<br/>
     > [Enable the Google Cloud Text-to-Speech API](https://console.cloud.google.com/flows/enableapi?apiid=texttospeech.googleapis.com)<br/>
     
-
 <br/>
 
-* **TTS Service using Microsot Azure TTS**<br/>
+* **TTS Service using Microsot Azure TTS**
+
     For Microsoft Azure TTS Engine, you need to have a microsoft account and register to the Azure portal.<br/>
     See my **YOUTUBE video**, here! https://youtu.be/asXajNpRWME<br/>
     You need to register here https://portal.azure.com, then ceate a Voice Service (please click here https://portal.azure.com/#create/Microsoft.CognitiveServicesSpeechServices), then click on the left "Keys and Endpoint" menu and copy/paste the KEY and your Location (for example westus).<br/>
@@ -286,6 +290,13 @@ For Google TTS Engine, you can choose pitch and speed rate of the voice.
     
 <br/>
 
+* **TTS Service using ElevenLabs**
+
+    Please use the V2 engine, as the V1 is deprecated and will not longer be supported. The V2 has multilingual voices and is more powerful.  
+    You have two choiches: To register to eventlabs, or not to register. If you don't register to elevenlabs.io, you will either have access on a limited amount of voices, or no access at all.  
+    After registration at elevenlabs.io, you can add any language to your personal list. The personal list will be then show in the node voice's list.<br/>    
+<br/>
+
 
 **Node-Red IP**<br/>
 set IP of your node-red machine. Write **AUTODISCOVER** to allow the node to auto discover your IP.

package/ttsultimate/ttsultimate-config.js

@@ -16,6 +16,7 @@ module.exports = function (RED) {
     const GoogleTranslate = require('google-translate-tts'); // TTS without credentials, limited to 200 chars per row.
     const microsoftAzureTTS = require("microsoft-cognitiveservices-speech-sdk"); // 12/10/2021
     const elevenlabsTTS = require("elevenlabs-node"); // 03/08/2023
+    const ElevenLabsClient = require("elevenlabs").ElevenLabsClient;
 
     var fs = require('fs');
     var path = require("path");
@@ -217,7 +218,7 @@ module.exports = function (RED) {
         }
         // #########################################
 
-        // elevenlabsTTS
+        // elevenlabsTTS v1 deprecated
         if (node.ttsservice === "elevenlabs") {
             node.elevenlabsTTSVoiceList = []
             try {
@@ -234,12 +235,12 @@ module.exports = function (RED) {
                                 if (x < y) { return -1; }
                                 if (x > y) { return 1; }
                                 return 0;
-                            }); 
+                            });
                         } catch (error) {
                             RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error getting elevenlabs 2 voices: ' + error.message);
                             node.elevenlabsTTSVoiceList.push({ name: "Error getting elevenlabs 2 voices: " + error.message + " Check cretentials, deploy and restart node-red.", id: "Ivy" })
                         }
-                        
+
                     });
                 } catch (error) {
                     RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error getting elevenlabs voices: ' + error.message);
@@ -254,6 +255,46 @@ module.exports = function (RED) {
             //RED.log.info("ttsultimate-config " + node.id + ": Google Translate free service not used.");
         }
 
+        // elevenlabsTTS v2
+        if (node.ttsservice === "elevenlabsv2") {
+            const elevenlabsv2 = new ElevenLabsClient({
+                apiKey: node.credentials.elevenlabsKey
+            });
+            node.elevenlabsTTSVoiceList = []
+            try {
+                node.elevenlabsTTS = elevenlabsv2;
+                try {
+                    node.elevenlabsTTS.voices.getAll().then((res) => {
+                        try {
+                            res.voices.forEach(element => {
+                                node.elevenlabsTTSVoiceList.push({ name: element.labels.accent + (element.labels.language !== undefined ? " (" + element.labels.language + ")" : "") + " - " + element.name + " (" + element.labels.gender + ")", id: element.voice_id })
+                            });
+                            node.elevenlabsTTSVoiceList.sort(function (a, b) {
+                                let x = a.name.toLowerCase();
+                                let y = b.name.toLowerCase();
+                                if (x < y) { return -1; }
+                                if (x > y) { return 1; }
+                                return 0;
+                            });
+                        } catch (error) {
+                            RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error getting elevenlabsv2 voices: ' + error.message);
+                            node.elevenlabsTTSVoiceList.push({ name: "Error getting elevenlabsv2  voices: " + error.message + " Check cretentials, deploy and restart node-red.", id: "Ivy" })
+                        }
+
+                    });
+                } catch (error) {
+                    RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error getting elevenlabsv2 voices: ' + error.message);
+                    node.elevenlabsTTSVoiceList.push({ name: "Error getting elevenlabsv2 voices: " + error.message + " Check cretentials, deploy and restart node-red.", id: "Ivy" })
+                }
+                RED.log.info("ttsultimate-config " + node.id + ": elevenlabsTTS servicev2 enabled.")
+            } catch (error) {
+                RED.log.warn("ttsultimate-config " + node.id + ": elevenlabsTTS servicev2 disabled. " + error.message)
+            }
+
+        } else {
+            //RED.log.info("ttsultimate-config " + node.id + ": Google Translate free service not used.");
+        }
+
 
         //#endregion
 
@@ -494,7 +535,7 @@ module.exports = function (RED) {
 
             } else if (ttsservice === "microsoftazuretts") {
                 res.json(node.microsoftAzureTTSVoiceList);
-            } else if (ttsservice === "elevenlabs") {
+            } else if (ttsservice.includes("elevenlabs")) {
                 res.json(node.elevenlabsTTSVoiceList);
             }