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

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 [![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.35</b> October 2021<br/>
+- NEW: You can force unmuting all players, then restore their previous state once finished playing.<br/>
+<p>
 <p>
 <b>Version 1.0.34</b> October 2021<br/>
 - FIX: fixed an issue in retrieving voices if you have more than one TTS engine enabled at the same time.<br/>

package/README.md

@@ -151,6 +151,9 @@ In case you select ***No player, only output file name***, you'll get a message
 **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.
@@ -164,6 +167,10 @@ Here you can add all additional players that will be grouped toghether to the *M
 **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>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-tts-ultimate",
-  "version": "1.0.34",
+  "version": "1.0.35",
   "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": {

package/ttsultimate/ttsultimate-config.js

@@ -145,59 +145,58 @@ module.exports = function (RED) {
                 return node.microsoftAzureTTS;
             }
             try {
-                
+
                 let speechConfig = microsoftAzureTTS.SpeechConfig.fromSubscription(node.credentials.mssubscriptionKey, node.credentials.mslocation);
                 //speechConfig.speechSynthesisLanguage = "it-IT";
                 //speechConfig.speechSynthesisVoiceName = "it-IT-IsabellaNeural";
                 speechConfig.speechSynthesisOutputFormat = microsoftAzureTTS.SpeechSynthesisOutputFormat.Audio16Khz32KBitRateMonoMp3;
                 node.microsoftAzureTTS = new microsoftAzureTTS.SpeechSynthesizer(speechConfig);
                 node.microsoftAzureTTSVoiceList = [];
-                if (node.ttsservice === "microsoftazuretts") {
-                    // Get the voices
-                    async function listVoicesAzure() {
-                        const httpsAzure = require('https')
-                        let options = {
-                            hostname: node.credentials.mslocation + '.tts.speech.microsoft.com',
-                            port: 443,
-                            path: '/cognitiveservices/voices/list',
-                            method: 'GET',
-                            headers: {
-                                'Ocp-Apim-Subscription-Key': node.credentials.mssubscriptionKey
-                            }
+                // Get the voices
+                async function listVoicesAzure() {
+                    const httpsAzure = require('https')
+                    let options = {
+                        hostname: node.credentials.mslocation + '.tts.speech.microsoft.com',
+                        port: 443,
+                        path: '/cognitiveservices/voices/list',
+                        method: 'GET',
+                        headers: {
+                            'Ocp-Apim-Subscription-Key': node.credentials.mssubscriptionKey
                         }
-                        const reqAzure = httpsAzure.request(options, resVoices => {
-                            var sChunkResponse = "";
-                            resVoices.on('data', d => {
-                                sChunkResponse += d.toString();
-                            })
-                            resVoices.on('end', () => {
-                                try {
-                                    let oVoices = JSON.parse(sChunkResponse);
-                                    RED.log.info('ttsultimate-config ' + node.id + ': Microsoft Azure voices count: ' + oVoices.length);
-                                    for (let index = 0; index < oVoices.length; index++) {
-                                        const element = oVoices[index];
-                                        node.microsoftAzureTTSVoiceList.push({ name: element.ShortName + " (" + element.Gender + ")", id: element.ShortName })
-                                    }
-                                } 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" });
-                                }
-                            })
+                    }
+                    const reqAzure = httpsAzure.request(options, resVoices => {
+                        var sChunkResponse = "";
+                        resVoices.on('data', d => {
+                            sChunkResponse += d.toString();
                         })
-                        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" })
-                            reqAzure.end();
+                        resVoices.on('end', () => {
+                            try {
+                                let oVoices = JSON.parse(sChunkResponse);
+                                RED.log.info('ttsultimate-config ' + node.id + ': Microsoft Azure voices count: ' + oVoices.length);
+                                for (let index = 0; index < oVoices.length; index++) {
+                                    const element = oVoices[index];
+                                    node.microsoftAzureTTSVoiceList.push({ name: element.ShortName + " (" + element.Gender + ")", id: element.ShortName })
+                                }
+                            } 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" });
+                            }
                         })
+                    })
+                    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" })
                         reqAzure.end();
-                    };
-                    RED.log.info("ttsultimate-config " + node.id + ": Microsoft AzureTTS service enabled.")
-                    try {
-                        listVoicesAzure();
-                    } catch (error) {
-                        RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error getting Microsoft Azure voices: ' + error.message);
-                    }
+                    })
+                    reqAzure.end();
+                };
+                RED.log.info("ttsultimate-config " + node.id + ": Microsoft AzureTTS service enabled.")
+                try {
+                    listVoicesAzure();
+                } catch (error) {
+                    RED.log.error('ttsultimate-config ' + node.id + ': listVoices: Error getting Microsoft Azure voices: ' + error.message);
                 }
+
             } catch (error) {
                 RED.log.warn("ttsultimate-config " + node.id + ": Microsoft AzureTTS service disabled. " + error.message)
             }

package/ttsultimate/ttsultimate.html

@@ -58,6 +58,11 @@
             <label for="node-input-sonosvolume"><i class="fa fa-volume-up"></i> Volume</label>
             <input type="text" id="node-input-sonosvolume" style="width:150px"> 
         </div>
+        <div class="form-row">
+            <label for="node-input-unmuteIfMuted"><i class="fa fa-bell-slash-o"></i> Unmute</label>
+            <input type="checkbox" id="node-input-unmuteIfMuted" style="margin-left: 0px; vertical-align: top; width: auto !important;"> <label style="width:auto !important;"> Unmute, then restore previous state after play.</label>
+        </div>
+        
         <div class="form-row">
             <label><i class="fa fa-upload"></i> Upload hail</label>
             <input id="ownFileUpload" type="file" multiple="multiple">
@@ -128,7 +133,9 @@
                 rules: { value: [] },
                 playertype: { value: "sonos", required: false },
                 speakingrate: { value: "1", required: false },
-                speakingpitch: { value: "0", required: false }
+                speakingpitch: { value: "0", required: false },
+                unmuteIfMuted: { value: true }
+
             },
             inputs: 1,
             outputs: 2,

package/ttsultimate/ttsultimate.js

@@ -76,6 +76,8 @@ module.exports = function (RED) {
         node.playertype = config.playertype === undefined ? "sonos" : config.playertype; // 20/09/2021 Player type
         node.speakingpitch = config.speakingpitch === undefined ? "0" : config.speakingpitch; // 21/09/2021 AudioConfig speakingpitch
         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;
 
         if (typeof node.server !== "undefined" && node.server !== null) {
             node.sNoderedURL = node.server.sNoderedURL || "";
@@ -243,18 +245,29 @@ module.exports = function (RED) {
             });
         }
 
-        // 28/08/2021 Sync wrapper
-        // function removeTracksFromQueueSync() {
-        //     return new Promise((resolve, reject) => {
-        //         // To remove current item from the queue
-        //         node.SonosClient.removeTracksFromQueue(1,1).then(result => {
-        //             resolve(result);
-        //         }).catch(err => {
-        //             RED.log.error("ttsultimate: Error removeTracksFromQueueSync: " + err.message);
-        //             reject(err);
-        //         });
-        //     });
-        // }
+        // 21/10/2021 Sync wrapper
+        function GETMutedSync() {
+            return new Promise((resolve, reject) => {
+                node.SonosClient.getMuted().then(state => {
+                    resolve(state);
+                }).catch(err => {
+                    RED.log.error("ttsultimate: Error GETMutedSync: " + err.message);
+                    reject(err);
+                });
+            });
+        }
+
+        // 21/10/2021 Sync wrapper
+        function SETMutedSync(_muted) {
+            return new Promise((resolve, reject) => {
+                node.SonosClient.setMuted(_muted).then(state => {
+                    resolve(state);
+                }).catch(err => {
+                    RED.log.error("ttsultimate: Error SETMutedSync: " + err.message);
+                    reject(err);
+                });
+            });
+        }
 
         // 20/03/2020 Join Coordinator queue
         // ######################################################
@@ -262,11 +275,12 @@ module.exports = function (RED) {
             // 05/07/2021 Get the main coordinator player previous volume set by app
             try {
                 node.sonosCoordinatorPreviousVolumeSetByApp = await GETVOLUMESync();
+                node.sonosCoordinatorIsPreviouslyMuted = await GETMutedSync();
             } catch (error) {
                 node.sonosCoordinatorPreviousVolumeSetByApp = node.sSonosVolume;
+                node.sonosCoordinatorIsPreviouslyMuted = false;
             }
             // 30/03/2020 in the middle of coronavirus emergency. Group Speakers
-            // You don't have to worry about who is the coordinator.
             for (let index = 0; index < node.oAdditionalSonosPlayers.length; index++) {
                 const element = node.oAdditionalSonosPlayers[index];
                 try {
@@ -280,6 +294,12 @@ module.exports = function (RED) {
                 } catch (error) {
                     RED.log.warn("ttsultimate: Error setting volume of joined device " + error.message);
                 }
+                // 21/10/2021 set the previous mute/unmute state
+                try {
+                    element.isPreviouslyMuted = await element.getMuted();
+                } catch (error) {
+                    RED.log.warn("ttsultimate: Error getMuted of joined device " + error.message);
+                }
             };
         }
 
@@ -291,6 +311,14 @@ module.exports = function (RED) {
             } catch (error) {
                 RED.log.warn("ttsultimate: Error set preious volume on main coordinator in ungroupSpeakers " + error.message);
             }
+            // 21/10/2021 Unmute?
+            if (node.unmuteIfMuted && node.sonosCoordinatorIsPreviouslyMuted) {
+                try {
+                    await SETMutedSync(true);
+                } catch (error) {
+                    RED.log.warn("ttsultimate: Error set preivous mute state on main coordinator in ungroupSpeakers " + error.message);
+                }
+            }
 
             for (let index = 0; index < node.oAdditionalSonosPlayers.length; index++) {
                 const element = node.oAdditionalSonosPlayers[index];
@@ -307,6 +335,14 @@ module.exports = function (RED) {
                         RED.log.warn("ttsultimate: Error set previous volume on group device " + error.message);
                     }
                 }
+                // 21/10/2021 Unmute?
+                if (node.unmuteIfMuted && element.isPreviouslyMuted) {
+                    try {
+                        await element.setMuted(true);
+                    } catch (error) {
+                        RED.log.warn("ttsultimate: Error set previous mute state on group device " + error.message);
+                    }
+                }
             }
         }
         // ######################################################
@@ -617,12 +653,15 @@ module.exports = function (RED) {
                                     volTemp = node.sSonosVolume;
                                 }
                                 await SETVOLUMESync(volTemp);
+                                if (node.unmuteIfMuted) await SETMutedSync(false); // 21/10/2021 Unmute
+
                                 if (node.oAdditionalSonosPlayers.length > 0) {
                                     // 05/07/2021 set the volume of additional coordinatores
                                     for (let index = 0; index < node.oAdditionalSonosPlayers.length; index++) {
                                         const element = node.oAdditionalSonosPlayers[index];
                                         try {
                                             await element.setVolume(volTemp);
+                                            if (node.unmuteIfMuted) await element.setMuted(false); // 21/10/2021 Unmute
                                         } catch (error) {
                                             RED.log.error("ttsultimate: Handlequeue: Unable to set the volume on additional player " + error.message);
                                         }
@@ -767,6 +806,10 @@ module.exports = function (RED) {
         }
 
         node.on('input', function (msg) {
+            // if (msg.hasOwnProperty("banana")) {
+            //     node.SonosClient.setMuted(msg.banana);
+            //     return;
+            // }
 
             // 09/01/2021 Set the main player and groups IP on request
             // *********************************
@@ -819,6 +862,12 @@ module.exports = function (RED) {
                 return;
             }
 
+
+            // 21/10/2021 force unmute
+            if (msg.hasOwnProperty("unmute")) {
+                node.unmuteIfMuted = msg.unmute;
+            }
+
             // 05/12/2020 handling Hailing
             var hailingMSG = null;
             if (msg.hasOwnProperty("nohailing") && (msg.nohailing == "1" || msg.nohailing.toLowerCase() == "true")) {
@@ -998,7 +1047,7 @@ module.exports = function (RED) {
 
         // 12/10/2021 Microsoft Azure TTS Service
         async function synthesizeSpeechMicrosoftAzureTTS(ttsService, params) {
-    
+
             return new Promise(function (resolve, reject) {
                 try {
 
@@ -1009,14 +1058,14 @@ module.exports = function (RED) {
                         params.text,
                         result => {
                             ttsService.close();
-                            resolve (Buffer.from(result.audioData));
+                            resolve(Buffer.from(result.audioData));
                         },
                         error => {
                             ttsService.close();
-                            reject (error);
+                            reject(error);
                         });
                 } catch (error) {
-                    reject (error);
+                    reject(error);
                 }
             });
         };