node-red-contrib-tts-ultimate 1.0.35 → 1.0.39

package/.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+    // Usare IntelliSense per informazioni sui possibili attributi.
+    // Al passaggio del mouse vengono visualizzate le descrizioni degli attributi esistenti.
+    // Per altre informazioni, visitare: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "pwa-node",
+            "request": "launch",
+            "name": "Launch Program",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/ttsultimate/ttsultimate.js"
+        }
+    ]
+}

package/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 [![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square)](https://www.paypal.me/techtoday) 
 
+<p>
+<b>Version 1.0.39</b> January 2022<br/>
+- SSML: fixed an issue prevent using it.<br/>
+- SSML: if SSML is enabled, the text auto split function is disabled, to avoid splitting SSML XML text.<br/>
+- Microsoft Azure: update TTS engine to 1.19.0<br/>
+- Google paid TTS: update TTS engine to 3.4.0<br/>
+<p>
+<b>Version 1.0.38</b> December 2021<br/>
+- Removed some unwanted startup logs.<br/>
+- Fixed ownfile sample code. Thanks to plats98.<br/>
+<p>
+<p>
+<b>Version 1.0.36</b> November 2021<br/>
+- NEW: Autosplit function: you can now set the maximum lenght of the text-parts, in case your spoken text is too long for the allowed TTS Engine limits.<br/>
+<p>
 <p>
 <b>Version 1.0.35</b> October 2021<br/>
 - NEW: You can force unmuting all players, then restore their previous state once finished playing.<br/>

package/README.md

@@ -125,6 +125,12 @@ On each deploy or node-red restart, delete all tts files in the cache. This is u
 ***Leave the TTS cache folder untouched*** (suggested only if you have enough disk space)<br/>
 Don't delete the files cached. Useful if you wish to keep the tts files, even in case of internet outages, node-red restart or reboots.
 <br/> 
+
+**Autosplit max length
+<br/>
+Due to some limitations in text lenght, applied by the online TTS Engines, TTS-Ultimate is capable to split your long text to be spoken, in shorter texts in an intelligent way.<br/>
+This field allow you to set the maximum lenght (**in chars**) of each splitted text part. The default is **220** and is OK for most cases. You can change this valut to whatever you want but keep in mind, that your TTS engine can either cut the text or return an error, if the text is too long. As the cached filename is equal to the text being spoken, you could also hit the maximum filename lenght of your filesystem. So keep the default value, unless you absolute need to change it.<br/>
+<br/> 
 <br/>
 
 # TTS-ULTIMATE NODE
@@ -266,17 +272,19 @@ 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 an Object.
+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/>
 
-**setMainPlayerIP**<br/>
-Sets the main player IP. This will also be the coordinator if you have a group of players
+ >  **property setMainPlayerIP**<br/>
+   Sets the main player IP. This will also be the coordinator if you have a group of players.
 
-**setPlayerGroupArray**<br/>
-Sets the array of players beloging to the group, if any.<br/>
-If you have only one additional player, you need to ever put it into an array. See below.
+ >  **property setPlayerGroupArray**<br/>
+   Sets the array of players beloging to the group, if any.<br/>
+   If you have only one additional player, you need to ever put it into an array. See below.
 
 ```js
-// Set player IP
+// Set main player IP
+// The setting is retained until the node receives another msg.setConfig or until node-red is restarted.
 var config= {
     setMainPlayerIP:"192.168.1.109"
 };
@@ -286,6 +294,7 @@ return msg;
 
 ```js
 // Set player IP and additional players
+// The setting is retained until the node receives another msg.setConfig or until node-red is restarted.
 var config= {
     setMainPlayerIP:"192.168.1.109",
     setPlayerGroupArray:[
@@ -300,6 +309,7 @@ return msg;
 
 ```js
 // If you have only one additional player
+// The setting is retained until the node receives another msg.setConfig or until node-red is restarted.
 var config= {
     setMainPlayerIP:"192.168.1.109",
     setPlayerGroupArray:["192.168.1.110"]
@@ -333,7 +343,7 @@ return msg;
 > Adjust the nodes according to your setup
 
 ```js
-[{"id":"db0ea33.f1186e","type":"ttsultimate","z":"c6efd2b6.ab02e8","name":"","voice":"en-AU-Standard-A#en-AU#FEMALE","ssml":false,"sonosipaddress":"192.168.1.109","sonosvolume":"25","sonoshailing":"Hailing_Hailing.mp3","config":"4f941d61.f52c4c","propertyType":{},"rules":[],"x":670,"y":240,"wires":[[]]},{"id":"c7fb2970.271978","type":"ownfile","z":"c6efd2b6.ab02e8","name":"","selectedFile":"OwnFile_Tur geoeffnet.mp3","x":490,"y":220,"wires":[["db0ea33.f1186e"]]},{"id":"fef80c5b.49f9e","type":"inject","z":"c6efd2b6.ab02e8","name":"","topic":"","payload":"true","payloadType":"bool","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":130,"y":220,"wires":[["c7fb2970.271978"]]},{"id":"807f0f6c.6d59c","type":"comment","z":"c6efd2b6.ab02e8","name":"You can upload your own voice messages and use it with ttsultimate","info":"","x":310,"y":180,"wires":[]},{"id":"536e58b3.bb8468","type":"ownfile","z":"c6efd2b6.ab02e8","name":"","selectedFile":"OwnFile_Tur geoeffnet.mp3","x":490,"y":260,"wires":[["db0ea33.f1186e"]]},{"id":"26c339f9.346fbe","type":"inject","z":"c6efd2b6.ab02e8","name":"","topic":"","payload":"true","payloadType":"bool","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":130,"y":260,"wires":[["25016441.6447bc"]]},{"id":"25016441.6447bc","type":"function","z":"c6efd2b6.ab02e8","name":"Dynamically Select file","func":"// Override the selected file.\nmsg.selectedFile=\"Porta aperta\"\nreturn msg;","outputs":1,"noerr":0,"x":300,"y":260,"wires":[["536e58b3.bb8468"]]},{"id":"4f941d61.f52c4c","type":"ttsultimate-config","z":"","name":"GoogleTTS","noderedipaddress":"192.168.1.219","noderedport":"1980","purgediratrestart":"leave","ttsservice":"googletts"}]
+[{"id":"db0ea33.f1186e","type":"ttsultimate","z":"c6efd2b6.ab02e8","name":"","voice":"en-AU-Standard-A#en-AU#FEMALE","ssml":false,"sonosipaddress":"192.168.1.109","sonosvolume":"25","sonoshailing":"Hailing_Hailing.mp3","config":"4f941d61.f52c4c","propertyType":{},"rules":[],"x":670,"y":240,"wires":[[]]},{"id":"c7fb2970.271978","type":"ownfileultimate","z":"c6efd2b6.ab02e8","name":"","selectedFile":"OwnFile_Tur geoeffnet.mp3","x":490,"y":220,"wires":[["db0ea33.f1186e"]]},{"id":"fef80c5b.49f9e","type":"inject","z":"c6efd2b6.ab02e8","name":"","topic":"","payload":"true","payloadType":"bool","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":130,"y":220,"wires":[["c7fb2970.271978"]]},{"id":"807f0f6c.6d59c","type":"comment","z":"c6efd2b6.ab02e8","name":"You can upload your own voice messages and use it with ttsultimate","info":"","x":310,"y":180,"wires":[]},{"id":"536e58b3.bb8468","type":"ownfileultimate","z":"c6efd2b6.ab02e8","name":"","selectedFile":"OwnFile_Tur geoeffnet.mp3","x":490,"y":260,"wires":[["db0ea33.f1186e"]]},{"id":"26c339f9.346fbe","type":"inject","z":"c6efd2b6.ab02e8","name":"","topic":"","payload":"true","payloadType":"bool","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":130,"y":260,"wires":[["25016441.6447bc"]]},{"id":"25016441.6447bc","type":"function","z":"c6efd2b6.ab02e8","name":"Dynamically Select file","func":"// Override the selected file.\nmsg.selectedFile=\"Porta aperta\"\nreturn msg;","outputs":1,"noerr":0,"x":300,"y":260,"wires":[["536e58b3.bb8468"]]},{"id":"4f941d61.f52c4c","type":"ttsultimate-config","z":"","name":"GoogleTTS","noderedipaddress":"192.168.1.219","noderedport":"1980","purgediratrestart":"leave","ttsservice":"googletts"}]
 ```
 </details>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-tts-ultimate",
-  "version": "1.0.35",
+  "version": "1.0.39",
   "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.",
   "main": "index.js",
   "scripts": {
@@ -16,6 +16,7 @@
     "google",
     "voice",
     "amazon",
+    "azure",
     "tts",
     "sonos",
     "IOT",
@@ -45,9 +46,9 @@
     "formidable": "1.2.2",
     "os": ">=0.1.1",
     "path": ">=0.12.7",
-    "@google-cloud/text-to-speech": "3.3.1",
+    "@google-cloud/text-to-speech": "3.4.0",
     "google-translate-tts": ">=0.2.1",
-    "microsoft-cognitiveservices-speech-sdk": ">=1.18.1"
+    "microsoft-cognitiveservices-speech-sdk": ">=1.19.0"
   },
   "devDependencies": {
     "eslint": ">=4.18.2",

package/ttsultimate/ttsultimate-config.html

@@ -17,7 +17,8 @@
                 type: "text"
             },
             purgediratrestart: { value: "leave", required: false },
-            ttsservice: { value: "googletranslate", required: false }
+            ttsservice: { value: "googletranslate", required: false },
+            limitTTSFilenameLenght: { value: 220, required: false, validate: RED.validators.number() }
 
         },
         credentials: {
@@ -32,6 +33,10 @@
         oneditprepare: function () {
             var node = this;
 
+            // 01/11/2021
+            //if (node.limitTTSFilenameLenght === undefined) {
+            //    $("#node-config-input-limitTTSFilenameLenght").val(220);
+            //}
             // 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();
@@ -61,16 +66,16 @@
             $("#node-config-input-ttsservice").change(function (e) {
                 if ($("#node-config-input-ttsservice").val() == "polly") {
                     $("#GoogleForm").hide();
-                    $("#microsoftAzureForm").hide();                    
+                    $("#microsoftAzureForm").hide();
                     $("#pollyForm").show();
                 } else if ($("#node-config-input-ttsservice").val() == "googletts") {
-                    $("#microsoftAzureForm").hide();                    
+                    $("#microsoftAzureForm").hide();
                     $("#pollyForm").hide();
                     $("#GoogleForm").show();
                 } else if ($("#node-config-input-ttsservice").val() == "googletranslate") {
                     $("#pollyForm").hide();
                     $("#GoogleForm").hide();
-                    $("#microsoftAzureForm").hide();                    
+                    $("#microsoftAzureForm").hide();
                 } else if ($("#node-config-input-ttsservice").val() == "microsoftazuretts") {
                     $("#pollyForm").hide();
                     $("#GoogleForm").hide();
@@ -208,6 +213,12 @@
                 <option value="leave">Leave the TTS cache folder untouched (not suggested if you have less disk space)</option>
             </select>
         </div>
+
+        <div class="form-row">
+            <label for="node-config-input-limitTTSFilenameLenght"><i class="fa fa-file"></i> Autosplit max length (chars)</label>
+            <input type="text" id="node-config-input-limitTTSFilenameLenght">
+        </div>
+        
     </div>
     
 </script>

package/ttsultimate/ttsultimate-config.js

@@ -23,6 +23,7 @@ module.exports = function (RED) {
         node.userDir = path.join(RED.settings.userDir, "sonospollyttsstorage"); // 09/03/2020 Storage of ttsultimate (otherwise, at each upgrade to a newer version, the node path is wiped out and recreated, loosing all custom files)
         node.whoIsUsingTheServer = ""; // Client node.id using the server, because only a ttsultimate node can use the serve at once.
         node.ttsservice = config.ttsservice || "googletranslate";
+        node.limitTTSFilenameLenght = config.limitTTSFilenameLenght === undefined ? 220 : config.limitTTSFilenameLenght;
         // node.polly = null;
         // node.googleTTS = null;
         // node.googleTranslateTTS = null;
@@ -96,7 +97,7 @@ module.exports = function (RED) {
                 RED.log.warn("ttsultimate-config " + node.id + ": Polly service disabled. " + error.message)
             }
         } else {
-            RED.log.warn("ttsultimate-config " + node.id + ": Polly service not used.");
+            //RED.log.info("ttsultimate-config " + node.id + ": Polly service not used.");
         }
 
 
@@ -117,7 +118,7 @@ module.exports = function (RED) {
             }
 
         } else {
-            RED.log.warn("ttsultimate-config " + node.id + ": Google TTS service not used.");
+            // RED.log.info("ttsultimate-config " + node.id + ": Google TTS service not used.");
         }
 
 
@@ -127,10 +128,10 @@ module.exports = function (RED) {
             try {
                 node.googleTranslateTTS = GoogleTranslate;
             } catch (error) {
-                RED.log.warn("ttsultimate-config " + node.id + ": Google Translate free service not used.");
+                //RED.log.info("ttsultimate-config " + node.id + ": Google Translate free service not used.");
             }
         } else {
-            RED.log.warn("ttsultimate-config " + node.id + ": Google Translate free service not used.");
+            //RED.log.info("ttsultimate-config " + node.id + ": Google Translate free service not used.");
         }
 
 
@@ -179,13 +180,13 @@ module.exports = function (RED) {
                                 }
                             } catch (error) {
                                 RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error parsing Microsoft Azure TTS voices: ' + error.message);
-                                node.microsoftAzureTTSVoiceList.push({ name: "Error parsing Microsoft Azure voices: " + error.message, id: "Ivy" });
+                                node.microsoftAzureTTSVoiceList.push({ name: "Error parsing Microsoft Azure voices: " + error.message + " Check cretentials, deploy and restart node-red.", id: "Ivy" });
                             }
                         })
                     })
                     reqAzure.on('error', error => {
                         RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error contacting Azure for getting the voices list: ' + error.message);
-                        node.microsoftAzureTTSVoiceList.push({ name: "Error getting Microsoft Azure voices: " + error.message, id: "Ivy" })
+                        node.microsoftAzureTTSVoiceList.push({ name: "Error getting Microsoft Azure voices: " + error.message + " Check cretentials, deploy and restart node-red.", id: "Ivy" })
                         reqAzure.end();
                     })
                     reqAzure.end();
@@ -201,7 +202,7 @@ module.exports = function (RED) {
                 RED.log.warn("ttsultimate-config " + node.id + ": Microsoft AzureTTS service disabled. " + error.message)
             }
         } else {
-            RED.log.warn("ttsultimate-config " + node.id + ": Microsoft AzureTTS service not used. ");
+            //RED.log.info("ttsultimate-config " + node.id + ": Microsoft AzureTTS service not used. ");
         }
         // #########################################
 
@@ -364,7 +365,7 @@ module.exports = function (RED) {
                     node.polly.describeVoices(jfiltroVoci, function (err, data) {
                         if (err) {
                             RED.log.warn('ttsultimate-config ' + node.id + ': Error getting polly voices ' + err);
-                            jListVoices.push({ name: "Error retrieving voices. " + err, id: "Ivy" })
+                            jListVoices.push({ name: "Error retrieving voices. " + err + " Check cretentials, deploy and restart node-red.", id: "Ivy" })
                             res.json(jListVoices)
                         } else {
                             for (let index = 0; index < data.Voices.length; index++) {
@@ -391,15 +392,15 @@ module.exports = function (RED) {
                         });
                         res.json(jListVoices)
                     } catch (error) {
-                        RED.log.error('ttsultimate-config ' + node.id + ': Error getting google TTS voices ' + error.message);
-                        jListVoices.push({ name: "Error getting Google TTS voices. " + error.message, id: "Ivy" })
+                        RED.log.error('ttsultimate-config ' + node.id + ': Error getting google TTS voices ' + error.message + " Please deploy and restart node-red.");
+                        jListVoices.push({ name: "Error getting Google TTS voices. " + error.message + " Check credentials, deploy and restart node-red.", id: "Ivy" })
                         res.json(jListVoices)
                     }
                 };
                 try {
                     listVoices();
                 } catch (error) {
-                    RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error getting google TTS voices ' + error.message);
+                    RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error getting google TTS voices ' + error.message + " Please deploy and restart node-red.");
                 }
 
             } else if (ttsservice === "googletranslate") {
@@ -412,14 +413,14 @@ module.exports = function (RED) {
                         res.json(jListVoices)
                     } catch (error) {
                         RED.log.error('ttsultimate-config ' + node.id + ': Error getting google Translate voices ' + error.message);
-                        jListVoices.push({ name: "Error getting Google Translate voices. " + error.message, id: "Ivy" })
+                        jListVoices.push({ name: "Error getting Google Translate voices. " + error.message + " Deploy and restart node-red.", id: "Ivy" })
                         res.json(jListVoices)
                     }
                 };
                 try {
                     listVoices();
                 } catch (error) {
-                    RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error getting google Translate voices ' + error.message);
+                    RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error getting google Translate voices ' + error.message + " Please deploy and restart node-red.");
                 }
 
             } else if (ttsservice === "microsoftazuretts") {

package/ttsultimate/ttsultimate.html

@@ -39,7 +39,7 @@
     </div>
     <div class="form-row">
         <label></label>
-        <input type="checkbox" id="node-input-ssml" style="margin-left: 0px; vertical-align: top; width: auto !important;"> <label style="width:auto !important;"> Enable SSML</label>
+        <input type="checkbox" id="node-input-ssml" style="margin-left: 0px; vertical-align: top; width: auto !important;"> <label style="width:auto !important;"> Enable SSML (unsupported by Google without authentication)</label>
     </div>
     <div class="form-row">
         <label for="node-input-sonoshailing"><i class="fa fa-bell"></i> Hailing</label>

package/ttsultimate/ttsultimate.js

@@ -591,11 +591,11 @@ module.exports = function (RED) {
                                         voice: { name: node.voiceId.split("#")[0], languageCode: node.voiceId.split("#")[1], ssmlGender: node.voiceId.split("#")[2] },
                                         audioConfig: { audioEncoding: "MP3", speakingRate: parseFloat(node.speakingrate), pitch: parseFloat(node.speakingpitch), },
                                     };
-                                    params.input = node.ssml === "text" ? { text: msg } : { ssml: msg };
+                                    params.input = node.ssml === false ? { text: msg } : { ssml: msg };
                                     data = await synthesizeSpeechGoogleTTS([node.server.googleTTS, params]);
                                 } else if (node.server.ttsservice === "googletranslate") {
                                     node.setNodeStatus({ fill: 'green', shape: 'ring', text: 'Downloading from Google Translate...' });
-                                    // VoiceId is: code 
+                                    // VoiceId is: code. SSML is not supported by google translate
                                     const params = {
                                         text: msg,
                                         voice: node.voiceId,
@@ -941,36 +941,41 @@ module.exports = function (RED) {
             }
             // ########################
 
-
-            // 30/01/2021 split the text if it's too long, otherwies i'll have issues with filename too long.
-            const iLimitTTSFilenameLenght = 220;
-            if (msg.payload.length >= iLimitTTSFilenameLenght) {
-                let sTemp = "";
-                let aSeps = [".", ",", ":", ";", "!", "?"];
-                let sPayload = msg.payload.replace(/[\r\n]+/gm, "");
-                for (let index = 0; index < sPayload.length; index++) {
-                    const element = sPayload.substr(index, 1);
-                    sTemp += element;
-                    if (aSeps.indexOf(element) > -1 && sTemp.length > 20) {
-                        const oMsg = RED.util.cloneMessage(msg);
-                        oMsg.payload = sTemp;
-                        node.tempMSGStorage.push(oMsg);
-                        sTemp = "";
-                    }
-                    if (sTemp.length > iLimitTTSFilenameLenght && element === " ") {
-                        // Split using space
-                        const oMsg = RED.util.cloneMessage(msg);
-                        oMsg.payload = sTemp;
-                        node.tempMSGStorage.push(oMsg);
-                        sTemp = "";
+            // 03/01/2022 if ssml is enabled, disable the auto split function
+            if (!node.ssml) {
+                // SSML disabled
+                // 30/01/2021 split the text if it's too long, otherwies i'll have issues with filename too long.
+                if (msg.payload.length >= node.server.limitTTSFilenameLenght) {
+                    let sTemp = "";
+                    let aSeps = [".", ",", ":", ";", "!", "?"];
+                    let sPayload = msg.payload.replace(/[\r\n]+/gm, "");
+                    for (let index = 0; index < sPayload.length; index++) {
+                        const element = sPayload.substr(index, 1);
+                        sTemp += element;
+                        if (aSeps.indexOf(element) > -1 && sTemp.length > 20) {
+                            const oMsg = RED.util.cloneMessage(msg);
+                            oMsg.payload = sTemp;
+                            node.tempMSGStorage.push(oMsg);
+                            sTemp = "";
+                        }
+                        if (sTemp.length > node.server.limitTTSFilenameLenght && element === " ") {
+                            // Split using space
+                            const oMsg = RED.util.cloneMessage(msg);
+                            oMsg.payload = sTemp;
+                            node.tempMSGStorage.push(oMsg);
+                            sTemp = "";
+                        }
                     }
-                }
-                // Remaining
-                const oMsg = RED.util.cloneMessage(msg);
-                oMsg.payload = sTemp;
-                node.tempMSGStorage.push(oMsg);
+                    // Remaining
+                    const oMsg = RED.util.cloneMessage(msg);
+                    oMsg.payload = sTemp;
+                    node.tempMSGStorage.push(oMsg);
 
+                } else {
+                    node.tempMSGStorage.push(msg);
+                }
             } else {
+                // SSML enabled
                 node.tempMSGStorage.push(msg);
             }