node-red-contrib-tts-ultimate 1.0.36 → 1.0.40

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,24 @@
 
 [![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.40</b> January 2022<br/>
+- NEW: you can now select your own folder to save the TTS cached files.<br/>
+- NEW: getting rid of file lenght issue by hashing the TTS cached files requested from TTS engines. Now the file names will be MD5 HEX hashed.<br/>
+- NEW: now the input messages are passed through to the output pin.<br/>
+- CAUTION: due to the new file management, the node will need to download again the TTS files from your TTS engine. Keep it in mind, because you can be charged by Amazon, Google or Microsoft.<br/>
+<p>
+<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/>

package/README.md

@@ -126,10 +126,11 @@ On each deploy or node-red restart, delete all tts files in the cache. This is u
 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
+**Cache root folder**
 <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 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/>
+Set your preferred output folder for the files downloaded by the TTS Engine.<br/>
+This is useful if you wish to save the TTS cached files in a folder accessible, for example, by a third party web servers to serve an AirPlay2 speaker.<br/>
+Leave this field blank for the default.<br/>
 <br/> 
 <br/>
 
@@ -141,6 +142,9 @@ Select the TTS SERVICE ENGINE NODE, as stated above.
 **Voice**<br/>
 Select your preferred voice. If you use Amazon, Polly voices will be displayed. 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).
 
@@ -236,18 +240,21 @@ The node has two output pins. The first pin is to signal play status, the second
 **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/Hailing_ComputerCall.mp3"
+         "file":"/Users/supergiovane/.node-red/sonospollyttsstorage/hailingpermanentfiles/hail.mp3"
       },
       {
-         "file":"/Users/supergiovane/.node-red/sonospollyttsstorage/ttsfiles/ille mi par esse deo videtur_pause_ ille si fas est superare divos_stop__it-IT.mp3"
+         "file":"/Users/supergiovane/.node-red/sonospollyttsstorage/ttsfiles/345938475938457.mp3"
       },
       {
-         "file":"/Users/supergiovane/.node-red/sonospollyttsstorage/ttsfiles/Banana rama_it-IT.mp3"
+         "file":"/Users/supergiovane/.node-red/sonospollyttsstorage/ttsfiles/3666HJGH565656.mp3"
       }
    ],
    "_msgid":"8b6b22a45dfd5236"
@@ -272,17 +279,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"
 };
@@ -292,6 +301,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:[
@@ -306,6 +316,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"]
@@ -339,7 +350,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>
 
@@ -348,7 +359,7 @@ This node allow you to upload your custom message and play it via ttsultimate wi
 **Name**<br/>
 Node name
 
-**File to be player** <br/>
+**File to be played** <br/>
 Select a file to be played. You can upload one or multiple files at the same time via the "upload" button.
 
 **Priority**<br/>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-tts-ultimate",
-  "version": "1.0.36",
+  "version": "1.0.40",
   "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",
@@ -38,16 +39,15 @@
   "homepage": "https://github.com/Supergiovane/node-red-contrib-tts-ultimate",
   "dependencies": {
     "aws-sdk": "2.816.0",
-    "crypto-js": "^3.1.9-1",
     "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.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

@@ -18,7 +18,7 @@
             },
             purgediratrestart: { value: "leave", required: false },
             ttsservice: { value: "googletranslate", required: false },
-            limitTTSFilenameLenght: { value: 220, required: false, validate: RED.validators.number() }
+            TTSRootFolderPath: { value: "", required: false }
 
         },
         credentials: {
@@ -33,10 +33,6 @@
         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();
@@ -215,10 +211,10 @@
         </div>
 
         <div class="form-row">
-            <label for="node-config-input-limitTTSFilenameLenght"><i class="fa fa-file"></i> Autosplit max length</label>
-            <input type="text" id="node-config-input-limitTTSFilenameLenght">
+            <label for="node-config-input-TTSRootFolderPath"><i class="fa fa-folder-o"></i> Cache root folder</label>
+            <input type="text" id="node-config-input-TTSRootFolderPath" placeholder="The folder must exist. Leave blank for default">
         </div>
-        
+              
     </div>
     
 </script>

package/ttsultimate/ttsultimate-config.js

@@ -20,10 +20,9 @@ module.exports = function (RED) {
         RED.nodes.createNode(this, config);
         var node = this;
         node.noderedipaddress = typeof config.noderedipaddress === "undefined" ? "" : config.noderedipaddress;
-        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.TTSRootFolderPath = (config.TTSRootFolderPath === undefined || config.TTSRootFolderPath === "") ? path.join(RED.settings.userDir, "sonospollyttsstorage") : path.join(config.TTSRootFolderPath, "sonospollyttsstorage");
         // node.polly = null;
         // node.googleTTS = null;
         // node.googleTranslateTTS = null;
@@ -44,38 +43,38 @@ module.exports = function (RED) {
                 return true;
             }
         }
-        if (!setupDirectory(node.userDir)) {
-            RED.log.error('ttsultimate-config ' + node.id + ': Unable to set up MAIN directory: ' + node.userDir);
+        if (!setupDirectory(node.TTSRootFolderPath)) {
+            RED.log.error('ttsultimate-config ' + node.id + ': Unable to set up MAIN directory: ' + node.TTSRootFolderPath);
         }
-        if (!setupDirectory(path.join(node.userDir, "ttsfiles"))) {
-            RED.log.error('ttsultimate-config ' + node.id + ': Unable to set up cache directory: ' + path.join(node.userDir, "ttsfiles"));
+        if (!setupDirectory(path.join(node.TTSRootFolderPath, "ttsfiles"))) {
+            RED.log.error('ttsultimate-config ' + node.id + ': Unable to set up cache directory: ' + path.join(node.TTSRootFolderPath, "ttsfiles"));
         } else {
-            RED.log.info('ttsultimate-config ' + node.id + ': TTS cache set to ' + path.join(node.userDir, "ttsfiles"));
+            RED.log.info('ttsultimate-config ' + node.id + ': TTS cache set to ' + path.join(node.TTSRootFolderPath, "ttsfiles"));
         }
-        if (!setupDirectory(path.join(node.userDir, "ttsultimategooglecredentials"))) {
-            RED.log.error('ttsultimate-config ' + node.id + ': Unable to set google creds directory: ' + path.join(node.userDir, "ttsultimategooglecredentials"));
+        if (!setupDirectory(path.join(node.TTSRootFolderPath, "ttsultimategooglecredentials"))) {
+            RED.log.error('ttsultimate-config ' + node.id + ': Unable to set google creds directory: ' + path.join(node.TTSRootFolderPath, "ttsultimategooglecredentials"));
         } else {
-            RED.log.info('ttsultimate-config ' + node.id + ': google credentials path set to ' + path.join(node.userDir, "ttsultimategooglecredentials"));
+            RED.log.info('ttsultimate-config ' + node.id + ': google credentials path set to ' + path.join(node.TTSRootFolderPath, "ttsultimategooglecredentials"));
         }
-        if (!setupDirectory(path.join(node.userDir, "hailingpermanentfiles"))) {
-            RED.log.error('ttsultimate-config ' + node.id + ': Unable to set up hailing directory: ' + path.join(node.userDir, "hailingpermanentfiles"));
+        if (!setupDirectory(path.join(node.TTSRootFolderPath, "hailingpermanentfiles"))) {
+            RED.log.error('ttsultimate-config ' + node.id + ': Unable to set up hailing directory: ' + path.join(node.TTSRootFolderPath, "hailingpermanentfiles"));
         } else {
-            RED.log.info('ttsultimate-config ' + node.id + ': hailing path set to ' + path.join(node.userDir, "hailingpermanentfiles"));
+            RED.log.info('ttsultimate-config ' + node.id + ': hailing path set to ' + path.join(node.TTSRootFolderPath, "hailingpermanentfiles"));
             // 09/03/2020 Copy defaults to the userDir
             fs.readdirSync(path.join(__dirname, "hailingpermanentfiles")).forEach(file => {
                 try {
-                    fs.copyFileSync(path.join(__dirname, "hailingpermanentfiles", file), path.join(node.userDir, "hailingpermanentfiles", file));
+                    fs.copyFileSync(path.join(__dirname, "hailingpermanentfiles", file), path.join(node.TTSRootFolderPath, "hailingpermanentfiles", file));
                 } catch (error) { }
             });
         }
-        if (!setupDirectory(path.join(node.userDir, "ttspermanentfiles"))) {
-            RED.log.error('ttsultimate-config ' + node.id + ': Unable to set up permanent files directory: ' + path.join(node.userDir, "ttspermanentfiles"));
+        if (!setupDirectory(path.join(node.TTSRootFolderPath, "ttspermanentfiles"))) {
+            RED.log.error('ttsultimate-config ' + node.id + ': Unable to set up permanent files directory: ' + path.join(node.TTSRootFolderPath, "ttspermanentfiles"));
         } else {
-            RED.log.info('ttsultimate-config ' + node.id + ': permanent files path set to ' + path.join(node.userDir, "ttspermanentfiles"));
+            RED.log.info('ttsultimate-config ' + node.id + ': permanent files path set to ' + path.join(node.TTSRootFolderPath, "ttspermanentfiles"));
             // 09/03/2020 // Copy the samples of permanent files into the userDir
             fs.readdirSync(path.join(__dirname, "ttspermanentfiles")).forEach(file => {
                 try {
-                    fs.copyFileSync(path.join(__dirname, "ttspermanentfiles", file), path.join(node.userDir, "ttspermanentfiles", file));
+                    fs.copyFileSync(path.join(__dirname, "ttspermanentfiles", file), path.join(node.TTSRootFolderPath, "ttspermanentfiles", file));
                 } catch (error) { }
             });
         }
@@ -97,7 +96,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.");
         }
 
 
@@ -105,8 +104,8 @@ module.exports = function (RED) {
         if (node.ttsservice === "googletts") {
             try {
                 // 23/12/2020 Set environment path of googleTTS
-                RED.log.info("ttsultimate-config " + node.id + ": Google credentials are stored in the file " + path.join(node.userDir, "ttsultimategooglecredentials", "googlecredentials.json"));
-                process.env.GOOGLE_APPLICATION_CREDENTIALS = path.join(node.userDir, "ttsultimategooglecredentials", "googlecredentials.json");
+                RED.log.info("ttsultimate-config " + node.id + ": Google credentials are stored in the file " + path.join(node.TTSRootFolderPath, "ttsultimategooglecredentials", "googlecredentials.json"));
+                process.env.GOOGLE_APPLICATION_CREDENTIALS = path.join(node.TTSRootFolderPath, "ttsultimategooglecredentials", "googlecredentials.json");
                 try {
                     node.googleTTS = new GoogleTTS.TextToSpeechClient();
                     RED.log.info("ttsultimate-config " + node.id + ": Google TTS service enabled. ")
@@ -118,7 +117,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.");
         }
 
 
@@ -128,10 +127,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.");
         }
 
 
@@ -180,13 +179,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();
@@ -202,7 +201,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. ");
         }
         // #########################################
 
@@ -265,7 +264,7 @@ module.exports = function (RED) {
             var jListOwnFiles = [];
             var sName = "";
             try {
-                fs.readdirSync(path.join(node.userDir, "hailingpermanentfiles")).forEach(file => {
+                fs.readdirSync(path.join(node.TTSRootFolderPath, "hailingpermanentfiles")).forEach(file => {
                     if (file.indexOf("Hailing_") > -1) {
                         sName = file.replace("Hailing_", "").replace(".mp3", "");
                         jListOwnFiles.push({ name: sName, filename: file });
@@ -280,7 +279,7 @@ module.exports = function (RED) {
         RED.httpAdmin.get("/deleteHailingFile", RED.auth.needsPermission('TTSConfigNode.read'), function (req, res) {
             // Delete the file
             try {
-                var newPath = path.join(node.userDir, "hailingpermanentfiles", req.query.FileName);
+                var newPath = path.join(node.TTSRootFolderPath, "hailingpermanentfiles", req.query.FileName);
                 fs.unlinkSync(newPath)
             } catch (error) { }
             res.json({ status: 220 });
@@ -292,7 +291,7 @@ module.exports = function (RED) {
             form.parse(req, function (err, fields, files) {
                 try {
                     if (files.customHailing.name.indexOf(".mp3") !== -1) {
-                        var newPath = path.join(node.userDir, "hailingpermanentfiles", "Hailing_" + files.customHailing.name);
+                        var newPath = path.join(node.TTSRootFolderPath, "hailingpermanentfiles", "Hailing_" + files.customHailing.name);
                         // 30/12/2020 To avoid XDEV issue: oldpath and newpath are not on the same mounted filesystem. (Linux permits a filesystem to be mounted at multiple points, 
                         // but rename() does not work across different mount points, even if the same filesystem is mounted on both.)
                         // Instead of renaming it, i must copy the file and then delete the old one.
@@ -325,7 +324,7 @@ module.exports = function (RED) {
                 if (err) { };
                 // Allow only json
                 if (files.googleCreds.name.indexOf(".json") !== -1) {
-                    var newPath = path.join(node.userDir, "ttsultimategooglecredentials", "googlecredentials.json");
+                    var newPath = path.join(node.TTSRootFolderPath, "ttsultimategooglecredentials", "googlecredentials.json");
                     // Set the environment variable
                     process.env.GOOGLE_APPLICATION_CREDENTIALS = newPath;
                     // 30/12/2020 To avoid XDEV issue: oldpath and newpath are not on the same mounted filesystem. (Linux permits a filesystem to be mounted at multiple points, 
@@ -365,7 +364,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++) {
@@ -392,15 +391,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") {
@@ -413,14 +412,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") {
@@ -442,7 +441,7 @@ module.exports = function (RED) {
                 // Allow only mp3
                 try {
                     if (files.customTTS.name.indexOf(".mp3") !== -1) {
-                        var newPath = path.join(node.userDir, "ttspermanentfiles", "OwnFile_" + files.customTTS.name);
+                        var newPath = path.join(node.TTSRootFolderPath, "ttspermanentfiles", "OwnFile_" + files.customTTS.name);
                         // 30/12/2020 To avoid XDEV issue: oldpath and newpath are not on the same mounted filesystem. (Linux permits a filesystem to be mounted at multiple points, 
                         // but rename() does not work across different mount points, even if the same filesystem is mounted on both.)
                         // Instead of renaming it, i must copy the file and then delete the old one.
@@ -472,7 +471,7 @@ module.exports = function (RED) {
             var jListOwnFiles = [];
             var sName = "";
             try {
-                fs.readdirSync(path.join(node.userDir, "ttspermanentfiles")).forEach(file => {
+                fs.readdirSync(path.join(node.TTSRootFolderPath, "ttspermanentfiles")).forEach(file => {
                     if (file.indexOf("OwnFile_") > -1) {
                         sName = file.replace("OwnFile_", '').replace(".mp3", '');
                         jListOwnFiles.push({ name: sName, filename: file });
@@ -489,12 +488,12 @@ module.exports = function (RED) {
                 if (req.query.FileName == "DELETEallFiles") {
                     // Delete all OwnFiles_
                     try {
-                        fs.readdir(path.join(node.userDir, "ttspermanentfiles"), (err, files) => {
+                        fs.readdir(path.join(node.TTSRootFolderPath, "ttspermanentfiles"), (err, files) => {
                             files.forEach(function (file) {
                                 if (file.indexOf("OwnFile_") !== -1) {
-                                    RED.log.warn("ttsultimate-config " + node.id + ": Deleted file " + path.join(node.userDir, "ttspermanentfiles", file));
+                                    RED.log.warn("ttsultimate-config " + node.id + ": Deleted file " + path.join(node.TTSRootFolderPath, "ttspermanentfiles", file));
                                     try {
-                                        fs.unlinkSync(path.join(node.userDir, "ttspermanentfiles", file));
+                                        fs.unlinkSync(path.join(node.TTSRootFolderPath, "ttspermanentfiles", file));
                                     } catch (error) { }
                                 }
                             });
@@ -504,7 +503,7 @@ module.exports = function (RED) {
                 } else {
                     // Delete only one file
                     try {
-                        var newPath = path.join(node.userDir, "ttspermanentfiles", req.query.FileName);
+                        var newPath = path.join(node.TTSRootFolderPath, "ttspermanentfiles", req.query.FileName);
                         try {
                             fs.unlinkSync(newPath)
                         } catch (error) { }
@@ -533,13 +532,13 @@ module.exports = function (RED) {
         if (node.purgediratrestart === "purge") {
             // Delete all files, that are'nt OwnFiles_
             try {
-                fs.readdirSync(path.join(node.userDir, "ttsfiles"), (err, files) => {
+                fs.readdirSync(path.join(node.TTSRootFolderPath, "ttsfiles"), (err, files) => {
                     try {
                         if (files.length > 0) {
                             files.forEach(function (file) {
-                                RED.log.info("ttsultimate-config " + node.id + ": Deleted TTS file " + path.join(node.userDir, "ttsfiles", file));
+                                RED.log.info("ttsultimate-config " + node.id + ": Deleted TTS file " + path.join(node.TTSRootFolderPath, "ttsfiles", file));
                                 try {
-                                    fs.unlinkSync(path.join(node.userDir, "ttsfiles", file));
+                                    fs.unlinkSync(path.join(node.TTSRootFolderPath, "ttsfiles", file));
                                 } catch (error) {
                                 }
                             });

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

@@ -2,11 +2,10 @@ module.exports = function (RED) {
     'use strict';
 
     var fs = require('fs');
-    var MD5 = require('crypto-js').MD5;
     var util = require('util');
     var path = require('path');
     const sonos = require('sonos');
-
+    const crypto = require("crypto");
 
     function slug(_text) {
         var sRet = _text;
@@ -64,7 +63,7 @@ module.exports = function (RED) {
         node.msg = {}; // 08/05/2019 Node message
         node.msg.completed = true;
         node.msg.connectionerror = true;
-        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.userDir = node.server.TTSRootFolderPath === undefined ? path.join(RED.settings.userDir, "sonospollyttsstorage") : node.server.TTSRootFolderPath;
         node.oAdditionalSonosPlayers = []; // 20/03/2020 Contains other players to be grouped
         node.rules = config.rules || [{}];
         node.sNoderedURL = "";
@@ -78,7 +77,8 @@ module.exports = function (RED) {
         node.speakingrate = config.speakingrate === undefined ? "1" : config.speakingrate; // 21/09/2021 AudioConfig speakingrate
         node.unmuteIfMuted = config.unmuteIfMuted === undefined ? false : config.unmuteIfMuted; // 21/10/2021 Unmute if previiously muted.
         node.sonosCoordinatorIsPreviouslyMuted = false;
-        
+        node.passThroughMessage = {};
+
         if (typeof node.server !== "undefined" && node.server !== null) {
             node.sNoderedURL = node.server.sNoderedURL || "";
         }
@@ -536,7 +536,7 @@ module.exports = function (RED) {
                     RED.log.error("ttsultimate: Error grouping speakers: " + error.message);
                 }
 
-                node.send([{ payload: node.msg.completed }, null]);
+                node.send([{ passThroughMessage: node.passThroughMessage, payload: node.msg.completed }, null]);
 
                 // 24/08/2021 If something was playing, stop the player https://github.com/Supergiovane/node-red-contrib-tts-ultimate/issues/32
                 try {
@@ -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,
@@ -777,7 +777,7 @@ module.exports = function (RED) {
                     setTimeout(() => {
                         node.msg.completed = true;
                         node.currentMSGbeingSpoken = {};
-                        node.send([{ payload: node.msg.completed }, null]);
+                        node.send([{ passThroughMessage: node.passThroughMessage, payload: node.msg.completed }, null]);
                         node.bBusyPlayingQueue = false
                         node.server.whoIsUsingTheServer = ""; // Signal to other ttsultimate node, that i'm not using the Sonos device anymore
                     }, 1000)
@@ -790,7 +790,7 @@ module.exports = function (RED) {
                     setTimeout(() => {
                         node.msg.completed = true;
                         node.currentMSGbeingSpoken = {};
-                        node.send([{ payload: node.msg.completed, filesArray: noPlayerFileArray }, null]);
+                        node.send([{ passThroughMessage: node.passThroughMessage, payload: node.msg.completed, filesArray: noPlayerFileArray }, null]);
                         node.bBusyPlayingQueue = false
                         node.server.whoIsUsingTheServer = ""; // Signal to other ttsultimate node, that i'm not using the Sonos device anymore
                     }, 1000)
@@ -811,6 +811,9 @@ module.exports = function (RED) {
             //     return;
             // }
 
+            // 05/01/2022 Set the passtrough message o come cazzo si scrive
+            node.passThroughMessage = RED.util.cloneMessage(msg);
+
             // 09/01/2021 Set the main player and groups IP on request
             // *********************************
             if (msg.hasOwnProperty("setConfig")) {
@@ -941,39 +944,46 @@ module.exports = function (RED) {
             }
             // ########################
 
-
-            // 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);
-
-            } else {
-                node.tempMSGStorage.push(msg);
-            }
+            // // 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);
+
+            //     } else {
+            //         node.tempMSGStorage.push(msg);
+            //     }
+            // } else {
+            //     // SSML enabled
+            //     node.tempMSGStorage.push(msg);
+            // }
 
             // Starts main queue watching
+            node.tempMSGStorage.push(msg);
             node.waitForQueue();
 
         });
@@ -1001,7 +1011,7 @@ module.exports = function (RED) {
             clearTimeout(node.oTimerSonosConnectionCheck);
             if (node.timerbTimeOutPlay !== null) clearTimeout(node.timerbTimeOutPlay);
             node.msg.completed = true;
-            node.send([{ payload: node.msg.completed }, null]);
+            node.send([{ passThroughMessage: node.passThroughMessage, payload: node.msg.completed }, null]);
             node.setNodeStatus({ fill: "green", shape: "ring", text: "Shutdown" });
             node.flushQueue();
             done();
@@ -1069,28 +1079,12 @@ module.exports = function (RED) {
             });
         };
 
-        function getFilename(text, _sVoice, isSSML, extension, _speakingpitch, _speakingrate) {
-            // Slug the text.
-            var basename = slug(text);
-            _sVoice = slug(_sVoice);
-
-            var ssml_text = isSSML ? '_ssml' : '';
-
-            // Filename format: "text_voice.mp3"
-            var filename = util.format('%s_%s%s%s%s.%s', basename, _sVoice, _speakingpitch, _speakingrate, ssml_text, extension);
-
-            // If filename is too long, cut it and add hash
-            if (filename.length > 250) {
-                var hash = MD5(basename);
-
-                // Filename format: "text_hash_voice.mp3"
-                var ending = util.format('_%s_%s%s%s%s.%s', hash, _sVoice, _speakingpitch, _speakingrate, ssml_text, extension);
-                var beginning = basename.slice(0, 250 - ending.length);
-
-                filename = beginning + ending;
-            }
-
-            return filename;
+        // 04/01/2021 hashing filename to avoid issues with long filenames.
+        function getFilename(_text, _sVoice, _isSSML, _extension, _speakingpitch, _speakingrate) {
+            let sTextToBeHashed = _text.concat(_sVoice, _isSSML, _speakingpitch, _speakingrate);
+            const hashSum = crypto.createHash('md5');
+            hashSum.update(sTextToBeHashed);
+            return hashSum.digest('hex') + "." + _extension;
         }
 
         function notifyError(msg, err) {
@@ -1103,7 +1097,6 @@ module.exports = function (RED) {
             });
             // Set error in message
             msg.error = errorMessage;
-
         }