node-red-contrib-tts-ultimate 1.0.44 → 1.0.48

package/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 [![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.48</b> Mai 2022<br/>
+- Try to fixe a clunky issue with microsoft azure package, on nodejs versions that are not supported by Microsoft.<br/>
+</p>
+<p>
+<b>Version 1.0.47</b> Mai 2022<br/>
+- Fixed other compatibility issue with some Node version.<br/>
+</p>
+<p>
+<b>Version 1.0.46</b> Mai 2022<br/>
+- Fixed a compatibility issue with Node 18, where a breaking change has been introduced.<br/>
+</p>
+<p>
+<b>Version 1.0.45</b> April 2022<br/>
+- NEW: Additional players now resumes the queue as well (previously, only the main player was doing so).<br/>
+</p>
 <p>
 <b>Version 1.0.44</b> April 2022<br/>
 - NEW: you can now adjust the additional player's volume, adapting it to the main sonos player volume. This is useful in case you've some recessed speakers, "speaking" too low or some too near speakers, "speaking" too high. You can adapt the volume in the config window or dinamically via msg input.<br/>

package/README.md

@@ -22,7 +22,8 @@
 
 
 ## DESCRIPTION
-This node transforms a text into a speech audio. You can generate an audio file, or hear the voice through Sonos, bluetooth speakers, web pages, etc.<br/>
+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/>
 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/>
@@ -34,6 +35,7 @@ This is a major ***upgrade from the previously popular node SonosPollyTTS*** (So
 * See <a href="https://github.com/Supergiovane/node-red-contrib-tts-ultimate/blob/master/CHANGELOG.md">here the changelog</a>
 
 ## 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.
 * **Automatic grouping** is supported. You can group all players you want to play your announcements.
@@ -215,9 +217,16 @@ return msg;
 ```
 
 ```js
-// Play custom hailing and custom mp3 taken from anywhere
-msg.sonoshailing = "IntruderAlert";
-msg.payload = "http://192.125.22.44/intruderalarm.mp3";
+// Play smoke detection
+msg.sonoshailing = "SmokeAlert";
+msg.payload = "Warning, smoke detected. Fire extinguishers are in the kitchen, hall and garage.";
+return msg;
+```
+
+```js
+// Play an mp3
+msg.sonoshailing = "MeteoJingle";
+msg.payload = "http://192.125.22.44/meteotoday.mp3";
 return msg;
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-tts-ultimate",
-  "version": "1.0.44",
+  "version": "1.0.48",
   "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": {
@@ -48,7 +48,7 @@
     "path": ">=0.12.7",
     "@google-cloud/text-to-speech": "3.4.0",
     "google-translate-tts": ">=0.2.1",
-    "microsoft-cognitiveservices-speech-sdk": ">=1.19.0"
+    "microsoft-cognitiveservices-speech-sdk": "1.19.0"
   },
   "devDependencies": {
     "eslint": ">=4.18.2",

package/ttsultimate/ttsultimate-config.js

@@ -229,7 +229,7 @@ module.exports = function (RED) {
                     } else {
                         var sAddresses = "";
                         oiFaces[ifname].forEach(function (iface) {
-                            if (iface.internal == false && iface.family === "IPv4") sAddresses = iface.address;
+                            if (iface.internal == false && iface.family !== undefined && iface.family.toString().includes("4")) sAddresses = iface.address;
                         });
                         if (sAddresses !== "") jListInterfaces.push({ name: ifname, address: sAddresses });
                     }

package/ttsultimate/ttsultimate.js

@@ -95,12 +95,12 @@ module.exports = function (RED) {
 
         //#region ASYNC DECLARATIONS
         // 30/12/2020 we are at the end of this crazy 2020
-        function getMusicQueue() {
+        function getMusicQueue(_oPlayer = node.SonosClient) {
             return new Promise(function (resolve, reject) {
                 var oRet = null;
-                node.SonosClient.currentTrack().then(track => {
+                _oPlayer.currentTrack().then(track => {
                     oRet = track;// .queuePosition || 1; // Get the current track  in the queue.
-                    node.SonosClient.getCurrentState().then(state => {
+                    _oPlayer.getCurrentState().then(state => {
                         // A music queue is playing and no TTS is speaking?
                         oRet.state = state;
                         resolve(oRet);
@@ -115,11 +115,12 @@ module.exports = function (RED) {
             });
         };
 
+
         let iWaitAfterSync = 500;
         // 24/08/2021 Sync wrapper
-        function PLAYSync(_toPlay) {
+        function PLAYSync(_toPlay, _oPlayer = node.SonosClient) {
             return new Promise((resolve, reject) => {
-                node.SonosClient.play(_toPlay).then(result => {
+                _oPlayer.play(_toPlay).then(result => {
                     if (iWaitAfterSync > 2000) console.log("PLAYSYNC")
                     let t = setTimeout(() => {
                         resolve(true);
@@ -132,9 +133,9 @@ module.exports = function (RED) {
         }
 
         // 24/08/2021 Sync wrapper
-        function SEEKSync(_Position) {
+        function SEEKSync(_Position, _oPlayer = node.SonosClient) {
             return new Promise((resolve, reject) => {
-                node.SonosClient.seek(_Position).then(result => {
+                _oPlayer.seek(_Position).then(result => {
                     if (iWaitAfterSync > 2000) console.log("SEEKSync", _Position)
                     let t = setTimeout(() => {
                         resolve(true);
@@ -147,9 +148,9 @@ module.exports = function (RED) {
         }
 
         // 24/08/2021 Sync wrapper
-        function SELECTQUEUESync() {
+        function SELECTQUEUESync(_oPlayer = node.SonosClient) {
             return new Promise((resolve, reject) => {
-                node.SonosClient.selectQueue().then(result => {
+                _oPlayer.selectQueue().then(result => {
                     if (iWaitAfterSync > 2000) console.log("SELECTQUEUESync")
                     try {
                         STOPSync(); // The SetQueue automatically starts playing, so i need to stop it now!
@@ -166,10 +167,10 @@ module.exports = function (RED) {
         }
 
         // 24/08/2021 Sync wrapper
-        function SELECTTRACKSync(_queuePositiom) {
+        function SELECTTRACKSync(_queuePosition, _oPlayer = node.SonosClient) {
             return new Promise((resolve, reject) => {
-                node.SonosClient.selectTrack(_queuePositiom).then(result => {
-                    if (iWaitAfterSync > 2000) console.log("SELECTTRACKSync", _queuePositiom)
+                _oPlayer.selectTrack(_queuePosition).then(result => {
+                    if (iWaitAfterSync > 2000) console.log("SELECTTRACKSync", _queuePosition)
                     let t = setTimeout(() => {
                         resolve(true);
                     }, iWaitAfterSync);
@@ -181,9 +182,9 @@ module.exports = function (RED) {
         }
 
         // 24/08/2021 Sync wrapper
-        function STOPSync() {
+        function STOPSync(_oPlayer = node.SonosClient) {
             return new Promise((resolve, reject) => {
-                node.SonosClient.stop().then(result => {
+                _oPlayer.stop().then(result => {
                     if (iWaitAfterSync > 2000) console.log("STOPSync")
                     let t = setTimeout(() => {
                         resolve(true);
@@ -196,9 +197,9 @@ module.exports = function (RED) {
         }
 
         // 24/08/2021 Sync wrapper
-        function GETVOLUMESync() {
+        function GETVOLUMESync(_oPlayer = node.SonosClient) {
             return new Promise((resolve, reject) => {
-                node.SonosClient.getVolume().then(volume => {
+                _oPlayer.getVolume().then(volume => {
                     if (iWaitAfterSync > 2000) console.log("GETVOLUMESync", volume)
                     resolve(volume);
                 }).catch(err => {
@@ -209,9 +210,9 @@ module.exports = function (RED) {
         }
 
         // 24/08/2021 Sync wrapper
-        function SETVOLUMESync(_volume) {
+        function SETVOLUMESync(_volume, _oPlayer = node.SonosClient) {
             return new Promise((resolve, reject) => {
-                node.SonosClient.setVolume(_volume).then(result => {
+                _oPlayer.setVolume(_volume).then(result => {
                     if (iWaitAfterSync > 2000) console.log("SETVOLUMESync", _volume)
                     resolve(true);
                 }).catch(err => {
@@ -222,9 +223,9 @@ module.exports = function (RED) {
         }
 
         // 24/08/2021 Sync wrapper
-        function setAVTransportURISync(_Uri) {
+        function setAVTransportURISync(_Uri, _oPlayer = node.SonosClient) {
             return new Promise((resolve, reject) => {
-                node.SonosClient.setAVTransportURI(_Uri).then(volume => {
+                _oPlayer.setAVTransportURI(_Uri).then(volume => {
                     if (iWaitAfterSync > 2000) console.log("setAVTransportURISync", _Uri)
                     resolve(true);
                 }).catch(err => {
@@ -235,9 +236,9 @@ module.exports = function (RED) {
         }
 
         // 24/08/2021 Sync wrapper
-        function getCurrentStateSync() {
+        function getCurrentStateSync(_oPlayer = node.SonosClient) {
             return new Promise((resolve, reject) => {
-                node.SonosClient.getCurrentState().then(state => {
+                _oPlayer.getCurrentState().then(state => {
                     resolve(state);
                 }).catch(err => {
                     RED.log.error("ttsultimate: Error getCurrentStateSync: " + err.message);
@@ -247,9 +248,9 @@ module.exports = function (RED) {
         }
 
         // 21/10/2021 Sync wrapper
-        function GETMutedSync() {
+        function GETMutedSync(_oPlayer = node.SonosClient) {
             return new Promise((resolve, reject) => {
-                node.SonosClient.getMuted().then(state => {
+                _oPlayer.getMuted().then(state => {
                     resolve(state);
                 }).catch(err => {
                     RED.log.error("ttsultimate: Error GETMutedSync: " + err.message);
@@ -259,9 +260,9 @@ module.exports = function (RED) {
         }
 
         // 21/10/2021 Sync wrapper
-        function SETMutedSync(_muted) {
+        function SETMutedSync(_muted, _oPlayer = node.SonosClient) {
             return new Promise((resolve, reject) => {
-                node.SonosClient.setMuted(_muted).then(state => {
+                _oPlayer.setMuted(_muted).then(state => {
                     resolve(state);
                 }).catch(err => {
                     RED.log.error("ttsultimate: Error SETMutedSync: " + err.message);
@@ -283,15 +284,12 @@ module.exports = function (RED) {
             }
             // 30/03/2020 in the middle of coronavirus emergency. Group Speakers
             for (let index = 0; index < node.oAdditionalSonosPlayers.length; index++) {
-                const element = node.oAdditionalSonosPlayers[index].oPlayer;
-                try {
-                    await element.joinGroup(node.sonosCoordinatorGroupName);
-                } catch (error) {
-                    RED.log.warn("ttsultimate: Error joining device " + error.message);
-                }
-                // 02/07/2021 Get the player's volume set by app, to be set again in ungroupspealers
+                let element = node.oAdditionalSonosPlayers[index].oPlayer;
+               
+                // 02/07/2021 Get the additional's player's volume set by app and the current track, to be set again in ungroupspealers
                 try {
                     element.additionalPlayerPreviousVolumeSetByApp = await element.getVolume();
+                    element.additionalPlayerCurrentTrack = await getMusicQueue(element);
                 } catch (error) {
                     RED.log.warn("ttsultimate: Error setting volume of joined device " + error.message);
                 }
@@ -301,6 +299,12 @@ module.exports = function (RED) {
                 } catch (error) {
                     RED.log.warn("ttsultimate: Error getMuted of joined device " + error.message);
                 }
+
+                try {
+                    await element.joinGroup(node.sonosCoordinatorGroupName);
+                } catch (error) {
+                    RED.log.warn("ttsultimate: Error joining device " + error.message);
+                }
             };
         }
 
@@ -322,7 +326,7 @@ module.exports = function (RED) {
             }
 
             for (let index = 0; index < node.oAdditionalSonosPlayers.length; index++) {
-                const element = node.oAdditionalSonosPlayers[index].oPlayer;
+                let element = node.oAdditionalSonosPlayers[index].oPlayer;
                 try {
                     await element.leaveGroup();
                 } catch (error) {
@@ -401,7 +405,7 @@ module.exports = function (RED) {
             });
             // Fill the node.oAdditionalSonosPlayers with all sonos object in the rules
             for (let index = 0; index < node.rules.length; index++) {
-                const element = node.rules[index]; // Rule row is {host:"192.168.1.12,hostVolumeAdjust:0}
+                let element = node.rules[index]; // Rule row is {host:"192.168.1.12,hostVolumeAdjust:0}
                 // 12/04/2022 Create an object containing the addidtional player and the adapted volume
                 node.oAdditionalSonosPlayers.push({ oPlayer: new sonos.Sonos(element.host), hostVolumeAdjust: Number(element.hostVolumeAdjust) });
                 RED.log.info("ttsultimate: FOUND ADDITIONAL PLAYER " + element.host + " Adjusted volume: " + element.hostVolumeAdjust);
@@ -433,7 +437,7 @@ module.exports = function (RED) {
 
 
         // 30/12/2020 Supergiovane resume queue for radio, queue music, TV in , line in etc.
-        async function resumeMusicQueue(_oTrack) {
+        async function resumeMusicQueue(_oTrack, _oPlayer = node.SonosClient) {
 
             if (_oTrack !== null) {
                 // Do some checks on the track.
@@ -458,12 +462,13 @@ module.exports = function (RED) {
                 if (_oTrack.state === "playing") {
                     // 03/09/2021 Play if it was playing
                     try {
-                        await PLAYSync(_oTrack.uri);
+                        await PLAYSync(_oTrack.uri, _oPlayer);
                     } catch (error) {
                         return error;
                     }
                     try {
-                        await SEEKSync(_oTrack.position);
+                        await delay(1000);
+                        await SEEKSync(_oTrack.position, _oPlayer);
                     } catch (error) {
                         // Don't care
                     }
@@ -471,31 +476,33 @@ module.exports = function (RED) {
             } else {
                 if (_oTrack.trackType === "musicqueue") { // This indicates that is an audio file or stream station
                     try {
-                        await SELECTQUEUESync();
+                        await SELECTQUEUESync(_oPlayer);
                     } catch (error) {
                         return error;
                     }
                     try {
-                        await SELECTTRACKSync(_oTrack.queuePosition);
+                        await delay(1000);
+                        await SELECTTRACKSync(_oTrack.queuePosition, _oPlayer);
                     } catch (error) {
                         return error;
                     }
                     try {
-                        await SEEKSync(_oTrack.position);
+                        await delay(1000);
+                        await SEEKSync(_oTrack.position, _oPlayer);
                     } catch (error) {
                         // Don't care
                     }
                     if (_oTrack.state === "playing") {
                         // 24/08/2021 Play if it was playing
                         try {
-                            await PLAYSync();
+                            await PLAYSync(_oPlayer);
                         } catch (error) {
                             return error;
                         }
                     } else {
                         /// 03/09/2021
                         try {
-                            await STOPSync();
+                            await STOPSync(_oPlayer);
                         } catch (error) {
                             return error;
                         }
@@ -504,7 +511,7 @@ module.exports = function (RED) {
                     // Line in, TV in, etc...
                     if (_oTrack.state === "playing") {
                         try {
-                            await setAVTransportURISync(_oTrack.uri);
+                            await setAVTransportURISync(_oTrack.uri, _oPlayer);
                         } catch (error) {
                             return error;
                         }
@@ -514,6 +521,7 @@ module.exports = function (RED) {
             let t = setTimeout(() => { return true; }, 5000); // Wait some seconds 
         };
 
+
         // Handle the queue
         async function HandleQueue() {
             node.bBusyPlayingQueue = true;
@@ -524,6 +532,7 @@ module.exports = function (RED) {
                 var oCurTrack = null;
                 try {
                     oCurTrack = await getMusicQueue();
+                    // 19/04/2022 The current track of additional players is read in the groupSpeakerySync function
                 } catch (error) {
                     oCurTrack = null;
                 }
@@ -531,7 +540,7 @@ module.exports = function (RED) {
                 // 05/12/2020 Set "completed" to false and send it
                 node.msg.completed = false;
                 try {
-                    await groupSpeakersSync(); // 20/03/2020 Group Speakers toghether    
+                    await groupSpeakersSync(); // 20/03/2020 Group Speakers toghether and reads each current track   
                 } catch (error) {
                     // Don't care.
                     node.setNodeStatus({ fill: "red", shape: "ring", text: "Error grouping speakers: " + error.message });
@@ -668,7 +677,7 @@ module.exports = function (RED) {
                                 if (node.oAdditionalSonosPlayers.length > 0) {
                                     // 05/07/2021 set the volume of additional coordinators
                                     for (let index = 0; index < node.oAdditionalSonosPlayers.length; index++) {
-                                        const element = node.oAdditionalSonosPlayers[index].oPlayer;
+                                        let element = node.oAdditionalSonosPlayers[index].oPlayer;
                                         //node.oAdditionalSonosPlayers.push({ oPlayer: new sonos.Sonos(element.host), hostVolumeAdjust: element.hostVolumeAdjust });
                                         try {
                                             // 12/04/20222 Set the adjusted volume, based on the main player volume + the adjusted volume in %
@@ -766,7 +775,7 @@ module.exports = function (RED) {
 
                     // Ungroup speaker
                     try {
-                        await ungroupSpeakersSync();
+                        await ungroupSpeakersSync(); // Ungroup speakers 
                     } catch (error) {
                         // Don't care.
                         node.setNodeStatus({ fill: "red", shape: "ring", text: "Error ungrouping speakers: " + error.message });
@@ -788,6 +797,24 @@ module.exports = function (RED) {
                         node.setNodeStatus({ fill: 'red', shape: 'ring', text: "Error resuming queue: " + error.message });
                     }
 
+
+                    // 19/04/2022 Resume music queue of additional players
+                    for (let index = 0; index < node.oAdditionalSonosPlayers.length; index++) {
+                        let addPlayer = node.oAdditionalSonosPlayers[index].oPlayer;
+                        let trackAddPlayer = addPlayer.additionalPlayerCurrentTrack;
+                        if (trackAddPlayer !== null) {
+                            try {
+                                await resumeMusicQueue(trackAddPlayer, addPlayer);
+                                node.setNodeStatus({ fill: 'green', shape: 'ring', text: "Done resuming queue additional player " + addPlayer.host || "" });
+                            } catch (error) {
+                                // Dont care
+                                RED.log.warn("ttsultimate: Error resuming music queue of additional player " + error.message + " " + addPlayer.host || "");
+                            }
+                        } else {
+                            node.setNodeStatus({ fill: 'green', shape: 'ring', text: "No queue to resume for " + addPlayer.host || "" });
+                        }
+                    }
+
                     // Signal end playing
                     let t = setTimeout(() => {
                         node.msg.completed = true;