node-red-contrib-tts-ultimate 1.0.56 → 2.0.1

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.1</b> August 2023<br/>
+- NEW: added Elevenlabs TTS engine https://elevenlabs.io.<br/>
+</p>
+<p>
+<b>Version 2.0.0</b> June 2023<br/>
+- Bumped paid Google TTS, free google TTS and Ms TTS dependencies.<br/>
+- Moved help to the node-red's help pane.<br/>
+</p>
 <p>
 <b>Version 1.0.56</b> March 2023<br/>
 - NEW: Added Node Name property, in the TTS Ultimate node.<br/>

package/README.md

@@ -26,7 +26,7 @@
 ## DESCRIPTION
 This node transforms a text into a speech audio that you can hear natively via <b>SONOS</b> speakers.<br/>
 You can also generate an audio file for bluetooth speakers, web pages, etc.<br/>
-Uses Amazon Polly (standard and neural engines), Google TTS voices (even without credentials nor registration) and Microsoft TTS Azure voices, and you can use it with **your own audio file** as well and it can be used **totally offline** even without the use of TTS, without internet connection.<br/>
+Uses Amazon Polly (standard and neural engines), Google TTS voices (even without credentials nor registration) and Microsoft TTS Azure voices, ElevenLabs.io TTS voices and you can use it with **your own audio file** as well and it can be used **totally offline** even without the use of TTS, without internet connection.<br/>
 The node can also create a ***TTS file (without the use of any Sonos device)***, to be read by third parties nodes.<br/>
 This is a major ***upgrade from the previously popular node SonosPollyTTS*** (SonosPollyTTS is not developed anymore).<br/>
 
@@ -39,7 +39,7 @@ This is a major ***upgrade from the previously popular node SonosPollyTTS*** (So
 ## FEATURES
 * **Native Sonos support**: hear the TTS audio directly via Sonos. You can also group speakers, set an hailing sound, choose the volume of each speaker etc.
 * **Output audio file**: the node can just create the TTS file to be used by other nodes. In this case, you doesn't need to use Sonos as player.
-* **Amazon Voices, Gooogle Translate Voices, Google TTS Voices and Microsoft TTS Azure voices** are all supported, with all avaiables languages and genders.
+* **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.
@@ -140,69 +140,8 @@ Leave this field blank for the default.<br/>
 
 # TTS-ULTIMATE NODE
 
-**TTS Service**<br/>
-Select the TTS SERVICE ENGINE NODE, as stated above.
-
-**Voice**<br/>
-Select your preferred voice. If you use Amazon, Polly voices will be displayed (standard and neural). If you use Google, google voices will be displayed. Google service without authentication, has a limited set of voices.
-
-**Enable SSML**<br/>
-Enable the SSML XML notation. Please be aware, not all the TTS engines supports that.
-
-**Rate**<br/>
-Only avaiable if you choose Google TTS Engine (with credentials). Specifies the speech speed (Between 0.25 and 4.0, default 1).
-
-**Pitch**<br/>
-Only avaiable if you choose Google TTS Engine (with credentials). Specifies the speech pitch (Between -20.0 and 20.0,  default 0).
-
-**Hailing**<br/>
-Before the first TTS message of the message queues, Sonos will play an "hailing" sound. You can select the hailing or totally disable it.
-
-**Player**<br/>
-Select the player. If you select not to use a player, the node will output a msg with an array of files, ready to be played by third party nodes.<br/>
-In case you select ***No player, only output file name***, you'll get a message with an additional property *filesArray*, containing an array of all mp3 files ready to be played with third party nodes. Please see below the **OUTPUT MESSAGES FROM THE NODE** section.
-
-**Volume** <br/>
-Set the preferred TTS volume, from "0" to "100" (can be overridden by passing <code>msg.volume = "40";</code> to the node)
-
-**Unmute** <br/>
-Unmute the main and the addotional players, then restore the previous mute state once finished. (Can be overridden by passing <code>msg.unmute = true;</code> to the node)
-
-**Main Sonos Player** <br/>
-Select your Sonos primary player. (It's strongly suggested to set a fixed IP for this player; you can reserve an IP using the DHCP Reservation function of your router/firewall's DHCP Server).<br/>
-It's possibile to group players, so your announcement can be played on all selected players. For this to happen, you need to select your primary coordinator player. All other players will be then controlled by this coordinator.
-
-**Additional Players** <br/>
-Here you can add all additional players that will be grouped toghether to the *Main Sonos Player* coordinator group. You can add a player using the "ADD" button, below the list.<br/>
-For each additional player, you can adjust their volume, based on the **Main Sonos Player** volume -+100.
-
-
 ## INPUT MESSAGES TO THE NODE <br/>
 
-**msg.volume**<br/>
-Set the volume (values between "0" and "100" with quotes)</br>
-
-**msg.unmute**<br/>
-*true*: Unmute all players then mutes it again once finished playing.</br>
-*false*: Leave the player as they are.</br>
-
-**msg.nohailing**<br/>
-Temporarely doesn't play the Hailing sound prior to the message (values "true" or "1" with quotes)</br>
-
-**msg.payload** <br/>
-The text to be spoken (for example msg.payload = "Hello World!";). You can also play an mp3 stored on an http server, by passing the URL to the payload ( <code>msg.payload = "http://www.myserver.com/alarm.mp3"</code>)</br>
-
-**msg.sonoshailing**<br/>
-Overrides the selected hailing and plays the filename you passed in. Please double check the spelling of the filename (must be the same as you can see in the dropdown list of your hailing files, in the ttsultimate config window) and do not include the <b>.mp3</b> extenson. For example *node.sonoshailing="ComputerCall"*<br/>
-
-**msg.priority**<br/>
-If set to <b>true</b>, the inbound flow message will cancel the current TTS queue, will stop the current phrase being spoken and the node will play this priority message.<br/>
-If there are other priority messages in the queue, they will be retained and the inbound priority flow message is added to the queue.<br/>
-If the inbound priority flow message is the first in the priority queue, the hailing is played first (if the hailing has been enabled or if the hailing has been overridden by *node.sonoshailing*)<br/>
-
-**msg.stop**<br/>
-If set to <b>true</b>, stops whatever is playing and clears the TTS queue.<br/>
-
 *Examples*
 
 ```js
@@ -245,44 +184,6 @@ msg.stop = true;
 return msg;
 ```
 
-## OUTPUT MESSAGES FROM THE NODE
-
-The node has two output pins. The first pin is to signal play status, the second one, is to signal an error.
-
-**OUTPUT PIN 1**<br/>
-Payload is ***true*** when the node has finished playing, ***false*** if the node is playing<br/>
-In case you selected ***No player, only output file name.*** in the **Player** property, you'll get a message with an additional property *filesArray*, containing an array of all mp3 files ready to be played with third party nodes.<br/>
-The property ***passThroughMessage*** contains the input msg passed through the output.<br/>
-
-```js
-{
-   "payload":true,
-   "passThroughMessage" : {original message object}
-   "filesArray":[
-      {
-         "file":"/Users/supergiovane/.node-red/sonospollyttsstorage/hailingpermanentfiles/hail.mp3"
-      },
-      {
-         "file":"/Users/supergiovane/.node-red/sonospollyttsstorage/ttsfiles/345938475938457.mp3"
-      },
-      {
-         "file":"/Users/supergiovane/.node-red/sonospollyttsstorage/ttsfiles/3666HJGH565656.mp3"
-      }
-   ],
-   "_msgid":"8b6b22a45dfd5236"
-}
-```
-
-**OUTPUT PIN 2**<br/>
-Payload is ***true*** when error occurs (for example, lost connection with Sonos Player), otherwise ***false***.<br/>
-
-In this sample, you see the TTS-Ultimate node connected with two debug nodes, to catch the errors.
-
-<img src='https://github.com/Supergiovane/node-red-contrib-tts-ultimate/raw/master/img/error.png' width="80%">
-
-<br/>
-<br/>
-
 ## CHANGE CONFIGURATION VIA MSG PROPERTY
 
 You can change the configuration of tts-ultimate, *via msg.setConfig* property.<br/>
@@ -290,18 +191,6 @@ The property is a JSON object.
 
 <img src='https://github.com/Supergiovane/node-red-contrib-tts-ultimate/raw/master/img/setConfig.png' width="80%">
 
-**msg.setConfig**<br/>
-This is the property where you can set all the things. It must be a JSON Object with the below specified properties.<br/>
-The setting is retained until the node receives another msg.setConfig or until node-red is restarted.<br/>
-
- >  **property setMainPlayerIP**<br/>
-   Sets the main player IP. This will also be the coordinator if you have a group of players.
-
- >  **property setPlayerGroupArray**<br/>
-   Sets the array of players beloging to the group, if any.<br/>
-   You can also specify the volume variation from the main volume player, to adapt the additional player's perceived volume to the main sonos player volume.<br/>
-   For example, if you have a speaker mounted in celiling, having less perceived volume, you can "push" the volume up, to match the whole perceived volume. Just add **#** after the IP and a number from -100 to 100 to subtract or add volume ***compared to the main sonos volume***. For example, if the sonos main player volume is 40, you can push this celing speaker's volume to further 10, so it'll have the real volume of 50. See below, the example.<br/>
-   Note: Even if you have only one additional player, you need to put it into an array.
 
 ```js
 // Set main player IP

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "node-red-contrib-tts-ultimate",
-  "version": "1.0.56",
-  "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, 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.",
+  "version": "2.0.1",
+  "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": {
     "test": "test"
@@ -23,7 +23,8 @@
     "speech",
     "ttsultimate",
     "sonospollytts",
-    "neural"
+    "neural",
+    "elevenlabs"
   ],
   "node-red": {
     "nodes": {
@@ -39,22 +40,22 @@
   },
   "homepage": "https://github.com/Supergiovane/node-red-contrib-tts-ultimate",
   "dependencies": {
-    "aws-sdk": "2.816.0",
+    "aws-sdk": "2.1404.0",
+    "@aws-sdk/client-polly":"3.215.0",
     "fs": "0.0.1-security",
     "sonos": "1.14.1",
-    "util": ">=0.10.1",
     "formidable": "1.2.2",
-    "os": ">=0.1.1",
     "path": ">=0.12.7",
-    "@google-cloud/text-to-speech": "3.4.0",
+    "@google-cloud/text-to-speech": "4.2.2",
     "google-translate-tts": ">=0.3.0",
-    "microsoft-cognitiveservices-speech-sdk": "1.24.1"
+    "microsoft-cognitiveservices-speech-sdk": "1.29.0",
+    "elevenlabs-node":"1.1.3"
   },
   "devDependencies": {
     "eslint": ">=4.18.2",
     "eslint-config-google": "^0.7.1"
   },
   "engines": {
-    "node": ">=8.9.4"
+    "node": ">=14.0.0"
   }
 }

package/ttsultimate/ownfileultimate.html

@@ -181,7 +181,7 @@
 </script>
 
 
-<script type="text/x-red" data-template-name="ownfileultimate">
+<script type="text/html" data-template-name="ownfileultimate">
     <div class="form-row">
         <b>OwnFile configuration</b>&nbsp&nbsp&nbsp&nbsp<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 online</u></a></span>
         <br/>
@@ -209,7 +209,7 @@
     </div>
 </script>
 
-<script type="text/x-red" data-help-name="ownfileultimate">
+<script type="text/markdown" data-help-name="ownfileultimate">
     <p>
         <a href="https://www.paypal.me/techtoday" target="_blank"><img src='https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square' width='30%'></a>
     </p>

package/ttsultimate/ownfileultimate.js

@@ -2,7 +2,7 @@
 
 
 module.exports = function (RED) {
-    var formidable = require('formidable');
+    var formidable = import('formidable');
     var fs = require('fs');
     var path = require('path');
 

package/ttsultimate/ttsultimate-config.html

@@ -1,5 +1,5 @@
 <script type="text/javascript">
-    
+
     RED.nodes.registerType("ttsultimate-config", {
         category: 'config',
         defaults:
@@ -26,24 +26,25 @@
             accessKey: { type: "text" },
             secretKey: { type: "password" },
             mssubscriptionKey: { type: "text" },
-            mslocation: { type: "text" }
+            mslocation: { type: "text" },
+            elevenlabsKey:{ type: "text" }
         },
         label: function () {
             return this.name || "";
         },
         oneditprepare: function () {
             var node = this;
-     
+
             // 21/03/2020 Check if the node is the absolute first in the flow. In this case, it has no http server instatiaced
             // $.getJSON('ttsultimateGetEthAddress', (data) => {
-                 $("#pleaseDeploy").hide();
-                $("#allGUI").show();
+            $("#pleaseDeploy").hide();
+            $("#allGUI").show();
             // }).fail(function (jqxhr) {
             //     $("#pleaseDeploy").show();
             //     $("#allGUI").hide();
             // });
 
-            
+
             if (node.noderedipaddress === undefined) {
                 // Put the default address of the machine
                 $.getJSON('ttsultimateGetEthAddress', (data) => {
@@ -65,19 +66,28 @@
                 if ($("#node-config-input-ttsservice").val() == "polly") {
                     $("#GoogleForm").hide();
                     $("#microsoftAzureForm").hide();
+                    $("#elevenlabsForm").hide(); 
                     $("#pollyForm").show();
                 } else if ($("#node-config-input-ttsservice").val() == "googletts") {
                     $("#microsoftAzureForm").hide();
                     $("#pollyForm").hide();
+                    $("#elevenlabsForm").hide(); 
                     $("#GoogleForm").show();
                 } else if ($("#node-config-input-ttsservice").val() == "googletranslate") {
                     $("#pollyForm").hide();
                     $("#GoogleForm").hide();
                     $("#microsoftAzureForm").hide();
+                    $("#elevenlabsForm").hide(); 
                 } else if ($("#node-config-input-ttsservice").val() == "microsoftazuretts") {
                     $("#pollyForm").hide();
                     $("#GoogleForm").hide();
+                    $("#elevenlabsForm").hide();    
                     $("#microsoftAzureForm").show();
+                } else if ($("#node-config-input-ttsservice").val() == "elevenlabs") {
+                    $("#pollyForm").hide();
+                    $("#GoogleForm").hide();
+                    $("#microsoftAzureForm").hide();
+                    $("#elevenlabsForm").show();                    
                 }
             });
             // ##########################################################
@@ -136,7 +146,7 @@
 </script>
 
 
-<script type="text/x-red" data-template-name="ttsultimate-config">
+<script type="text/html" data-template-name="ttsultimate-config">
     <div id="pleaseDeploy">
         <p align="center"> THIS IS YOUR FIRST CONFIG-NODE<br/> AND I NEED TO CREATE SOME THINGS<br/> BEFORE LETTING YOU PROCEED.<br/><b>PLEASE SAVE, FULL DEPLOY <br/>AND RE-OPEN THIS WINDOW</b><br/>
             TO BE ABLE TO FINISH THE CONFIGURATION SETUP<br/>
@@ -173,7 +183,8 @@
                 <option value="polly">Amazon Polly</option>
                 <option value="googletts">Google TTS</option>
                 <option value="googletranslate">Google without authentication</option>   
-                <option value="microsoftazuretts">Microsoft Azure TTS</option>   
+                <option value="microsoftazuretts">Microsoft Azure TTS</option>
+                <option value="elevenlabs">ElevenLabs TTS (elevenlabs.io)</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">
@@ -202,7 +213,12 @@
                 <input style="width:58%" type="text" id="node-config-input-mslocation">
             </div>
         </div>
-
+    <div id="elevenlabsForm">
+        <div class="form-row">
+            <label style="width:35%" for="node-config-input-elevenlabsKey"><i class="fa fa-user"></i> <a href="https://elevenlabs.io" target="_new">Elevenlabs</a>API key</label>
+            <input style="width:58%" type="text" id="node-config-input-elevenlabsKey">
+        </div>        
+    </div>
         <div class="form-row">
             <label for="node-config-input-purgediratrestart"><i class="fa fa-folder-o"></i> TTS Cache</label>
             <select id="node-config-input-purgediratrestart">
@@ -221,7 +237,7 @@
 </script>
 
 
-<script type="text/x-red" data-help-name="ttsultimate-config">
+<script type="text/markdown" data-help-name="ttsultimate-config">
     <p>
         <a href="https://www.paypal.me/techtoday" target="_blank"><img src='https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square' width='30%'></a>
     </p>

package/ttsultimate/ttsultimate-config.js

@@ -10,11 +10,13 @@ module.exports = function (RED) {
     }
 
 
-
+    // Setting up the engines
     const AWS = require('aws-sdk');
     const GoogleTTS = require('@google-cloud/text-to-speech');
     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
+
     var fs = require('fs');
     var path = require("path");
     var formidable = require('formidable');
@@ -144,7 +146,6 @@ module.exports = function (RED) {
             //RED.log.info("ttsultimate-config " + node.id + ": Google Translate free service not used.");
         }
 
-
         // 12/10/2021 Microsoft Azure TTS SpeechConfig.fromSubscription(subscriptionKey, serviceRegion) 
         if (node.ttsservice === "microsoftazuretts") {
             // #########################################
@@ -216,6 +217,44 @@ module.exports = function (RED) {
         }
         // #########################################
 
+        // elevenlabsTTS
+        if (node.ttsservice === "elevenlabs") {
+            node.elevenlabsTTSVoiceList = []
+            try {
+                node.elevenlabsTTS = elevenlabsTTS;
+                try {
+                    node.elevenlabsTTS.getVoices(node.credentials.elevenlabsKey).then((res) => {
+                        try {
+                            res.voices.forEach(element => {
+                                node.elevenlabsTTSVoiceList.push({ name: element.labels.accent + " - " + 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 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);
+                    node.elevenlabsTTSVoiceList.push({ name: "Error getting elevenlabs voices: " + error.message + " Check cretentials, deploy and restart node-red.", id: "Ivy" })
+                }
+                RED.log.info("ttsultimate-config " + node.id + ": elevenlabsTTS service enabled.")
+            } catch (error) {
+                RED.log.warn("ttsultimate-config " + node.id + ": elevenlabsTTS service disabled. " + error.message)
+            }
+
+        } else {
+            //RED.log.info("ttsultimate-config " + node.id + ": Google Translate free service not used.");
+        }
+
+
         //#endregion
 
 
@@ -455,7 +494,10 @@ module.exports = function (RED) {
 
             } else if (ttsservice === "microsoftazuretts") {
                 res.json(node.microsoftAzureTTSVoiceList);
+            } else if (ttsservice === "elevenlabs") {
+                res.json(node.elevenlabsTTSVoiceList);
             }
+
         });
 
         // ########################################################
@@ -673,7 +715,8 @@ module.exports = function (RED) {
             accessKey: { type: "text" },
             secretKey: { type: "password" },
             mssubscriptionKey: { type: "text" },
-            mslocation: { type: "text" }
+            mslocation: { type: "text" },
+            elevenlabsKey: { type: "text" }
         }
     });
 

package/ttsultimate/ttsultimate.html

@@ -1,14 +1,4 @@
-<script type="text/x-red" data-help-name="ttsultimate">
-    <p>
-        <a href="https://www.paypal.me/techtoday" target="_blank"><img src='https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square' width='30%'></a>
-    </p>
-     <p>
-      Configuration help is in the <a href="https://github.com/Supergiovane/node-red-contrib-tts-ultimate/blob/master/README.md">README</a><br/>
-    </p>
-
-</script>
-
-<script type="text/x-red" data-template-name="ttsultimate">
+<script type="text/html" data-template-name="ttsultimate">
     <div class="form-row">
         <b>TTS Ultimate configuration</b>&nbsp&nbsp&nbsp&nbsp<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 online</u></a></span>
         <br/>
@@ -415,7 +405,7 @@
                     for (let index = -100; index < 100; index += 5) {
                         let sTesto = "";
                         if (index === 0) sTesto = "Same volume as Main Sonos Player";
-                        if (index < 0) sTesto = "Decrease volume by " + Math.abs(index) ;
+                        if (index < 0) sTesto = "Decrease volume by " + Math.abs(index);
                         if (index > 0) sTesto = "Increase volume by " + index;
                         oAdjustVolume.append($("<option></option>")
                             .attr("value", index)
@@ -516,4 +506,58 @@
                 $("#node-input-rule-container").editableList('height', height);
             }
         });
+</script>
+
+<script type="text/markdown" data-help-name="ttsultimate">
+<p>This node transforms a text into a speech audio that you can hear natively via SONOS speakers, or save it to a file.</p>
+
+**General**
+|Property|Description|
+|--|--|
+| TTS Service | Select the TTS SERVICE ENGINE NODE. |
+| Voice | Select your preferred voice. If you use Amazon, Polly voices will be displayed (standard and neural). If you use Google, google voices will be displayed. Google service without authentication, has a limited set of voices. |
+| Enable SSML | Enable the SSML XML notation. Please be aware, not all the TTS engines supports that.|
+| Rate | Only avaiable if you choose Google TTS Engine (with credentials). Specifies the speech speed (Between 0.25 and 4.0, default 1). |
+| Pitch | Only avaiable if you choose Google TTS Engine (with credentials). Specifies the speech pitch (Between -20.0 and 20.0, default 0). |
+| Hailing | Before the first TTS message of the message queues, Sonos will play an "hailing" sound. You can select the hailing or totally disable it. |
+| Player | Select the player. If you select not to use a player, the node will output a msg with an array of files, ready to be played by third party nodes. In case you select No player, only output file name, you'll get a message with an additional property filesArray, containing an array of all mp3 files ready to be played with third party nodes. Please see below the OUTPUT MESSAGES FROM THE NODE section. |
+| Volume | Set the preferred TTS volume, from "0" to "100" (can be overridden by passing msg.volume = "40"; to the node). |
+| Unmute | Unmute the main and the addotional players, then restore the previous mute state once finished. (Can be overridden by passing msg.unmute = true; to the node). |
+| Main Sonos Player | Select your Sonos primary player. (It's strongly suggested to set a fixed IP for this player; you can reserve an IP using the DHCP Reservation function of your router/firewall's DHCP Server). It's possibile to group players, so your announcement can be played on all selected players. For this to happen, you need to select your primary coordinator player. All other players will be then controlled by this coordinator. |
+| Additional Players | Here you can add all additional players that will be grouped toghether to the Main Sonos Player coordinator group. You can add a player using the "ADD" button, below the list. For each additional player, you can adjust their volume, based on the Main Sonos Player volume -+100. |
+
+<br/>
+
+### Inputs
+
+: volume (string) : Set the volume (values between "0" and "100").
+: unmute (boolean) : *true* Unmute all players then mutes it again once finished playing. *false* Leaves the player as they are.
+: nohailing (string) : Temporary stop playing the Hailing sound prior to the message (values "true" or "1" with quotes).
+: payload (string | file) : The text to be spoken (for example msg.payload = "Hello World!"). You can also play an mp3 stored on an http server, by passing the URL to the payload ( msg.payload = "www.myserver.com/alarm.mp3").
+: sonoshailing (string) : Overrides the selected hailing and plays the filename you passed in. Please double check the spelling of the filename (must be the same as you can see in the dropdown list of your hailing files, in the ttsultimate config window) and do not include the .mp3 extenson. For example node.sonoshailing="ComputerCall".
+: priority (boolean) : If set to true, the inbound flow message will cancel the current TTS queue, will stop the current phrase being spoken and the node will play this priority message. If there are other priority messages in the queue, they will be retained and the inbound priority flow message is added to the queue. If the inbound priority flow message is the first in the priority queue, the hailing is played first (if the hailing has been enabled or if the hailing has been overridden by node.sonoshailing).
+: stop (boolean) : If set to true, stops whatever is playing and clears the TTS queue.
+: setConfig (json) : This is the property where you can set all the things. It must be a JSON Object with the below specified properties. The setting is retained until the node receives another msg.setConfig or until node-red is restarted.
+: setConfig {setMainPlayerIP} (string) : Sets the main player IP. This will also be the coordinator if you have a group of players.
+: setConfig {setPlayerGroupArray} (array) : Sets the array of players beloging to the group, if any. You can also specify the volume variation from the main volume player, to adapt the additional player's perceived volume to the main sonos player volume. For example, if you have a speaker mounted in celiling, having less perceived volume, you can "push" the volume up, to match the whole perceived volume. Just add # after the IP and a number from -100 to 100 to subtract or add volume compared to the main sonos volume. For example, if the sonos main player volume is 40, you can push this celing speaker's volume to further 10, so it'll have the real volume of 50. See below, the example. Even if you have only one additional player, you need to put it into an array.
+
+### Output
+
+The node has two output pins. The first pin is to signal play status, the second one, is to signal an error
+
+1. Standard output
+: payload (boolean) : Payload is true when the node has finished playing, false if the node is playing. In case you selected No player, only output file name. in the Player property, you'll get a message with an additional property filesArray, containing an array of all mp3 files ready to be played with third party nodes. The property passThroughMessage contains the input msg passed through the output.
+: passThroughMessage (json) : Original message object.
+: filesArray (array of string) : Arrays of generated files name, including paths.
+
+2. Error
+: payload (boolean) : Payload is true when error occurs (for example, lost connection with Sonos Player), otherwise false.
+
+### Samples
+
+[You'll find useful samples here](https://github.com/Supergiovane/node-red-contrib-tts-ultimate)
+
+[Find it useful?](https://www.paypal.me/techtoday)
+
+<br/>
 </script>

package/ttsultimate/ttsultimate.js

@@ -1,8 +1,9 @@
+const { Readable } = require('stream');
+
 module.exports = function (RED) {
     'use strict';
 
     var fs = require('fs');
-    var util = require('util');
     var path = require('path');
     const sonos = require('sonos');
     const crypto = require("crypto");
@@ -427,8 +428,6 @@ module.exports = function (RED) {
         node.setNodeStatus({ fill: 'grey', shape: 'ring', text: 'Initialized.' });
 
 
-
-
         // 22/09/2020 Flush Queue and set to stopped
         node.flushQueue = () => {
             // 10/04/2018 Remove the TTS message from the queue
@@ -635,7 +634,16 @@ module.exports = function (RED) {
                                         voice: node.voiceId
                                     };
                                     data = await synthesizeSpeechMicrosoftAzureTTS(node.server.microsoftAzureTTS, params);
+                                } else if (node.server.ttsservice === "elevenlabs") {
+                                    node.setNodeStatus({ fill: 'green', shape: 'ring', text: 'Downloading from elevenLabs TTS...' });
+                                    // VoiceId is: code 
+                                    const params = {
+                                        text: msg,
+                                        voice: node.voiceId
+                                    };
+                                    data = await synthesizeSpeechElevenLabs(node.server.elevenlabsTTS, params);
                                 }
+
                                 // Save the downloaded file into the cache
                                 try {
                                     fs.writeFileSync(sFileToBePlayed, data);
@@ -739,7 +747,7 @@ module.exports = function (RED) {
                                 state = "";
                                 node.timerbTimeOutPlay = setTimeout(() => {
                                     node.bTimeOutPlay = true;
-                                }, 60000*10); // 10 minutes timeout
+                                }, 60000 * 10); // 10 minutes timeout
                                 while (state !== "stopped" && !node.bTimeOutPlay) {
                                     try {
                                         state = await getCurrentStateSync();
@@ -1111,7 +1119,6 @@ module.exports = function (RED) {
                 throw (error);
             }
         };
-
         // 12/10/2021 Microsoft Azure TTS Service
         async function synthesizeSpeechMicrosoftAzureTTS(ttsService, params) {
 
@@ -1136,6 +1143,39 @@ module.exports = function (RED) {
                 }
             });
         };
+        // elevenLabs TTS Service
+        function synthesizeSpeechElevenLabs(ttsService, params) {
+            // const params = {
+            //     text: msg,
+            //     voice: node.voiceId
+            // };
+            function stream2buffer(stream) {
+                return new Promise((resolve, reject) => {
+                    try {
+                        const _buf = [];
+
+                        stream.on("data", (chunk) => _buf.push(chunk));
+                        stream.on("end", () => resolve(Buffer.concat(_buf)));
+                        stream.on("error", (err) => reject(err));
+                    } catch (error) {
+                    }
+                });
+            }
+            return new Promise((resolve, reject) => {
+                // "model_id": "eleven_multilingual_v1",
+                ttsService.textToSpeechStream(node.server.credentials.elevenlabsKey, params.voice, params.text, null,null,"eleven_multilingual_v1").then((res) => {
+                    try {
+                        if (res !== undefined) {
+                            resolve(stream2buffer(res));
+                        } else {
+                            reject(new Error("Please check credentials. The stream cannot be read from the elevenlabs TTS server"))
+                        }
+                    } catch (error) {
+                        reject(error)
+                    }
+                });
+            });
+        }
 
         // 04/01/2021 hashing filename to avoid issues with long filenames.
         function getFilename(_text, _sVoice, _isSSML, _extension, _speakingpitch, _speakingrate) {