node-red-contrib-tts-ultimate 1.0.32 → 1.0.33

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.33</b> October 2021<br/>
+- NEW VOICE ENGINE: Microsoft Azure TTS.<br/>
+<p>
 <p>
 <b>Version 1.0.32</b> September 2021<br/>
 - Fix few restore issues. Line-in restore fix and only when it was playing. Amazon Music and Spotify considered as stream instead of music queue.<br/>

package/README.md

@@ -22,10 +22,11 @@
 
 
 ## DESCRIPTION
-This node transforms a text into a speech audio. You can hear the voice through Sonos.<br/>
-Uses Amazon Polly and Google TTS voices (even without credentials nor registration), 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/>
+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/>
+Uses Amazon Polly, 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/>
-**Node v.10.0.0 or newer is needed**.
+**Node v.12.0.0 or newer is needed**.
 
 [![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square)](https://www.paypal.me/techtoday)
 
@@ -33,7 +34,8 @@ 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
-* **Amazon Voices, Gooogle Translate Voices and Google TTS Voices** are all supported, with all avaiables languages and genders.
+* **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.
 * **Automatic discovery** of your players.
 * **Automatic resume of music** queue (including radio stations, but here, some users reports problem resuming ***radio stations*** and, because of lack of Sonos API documentation, the issue cannot currently be fixed), at exact track, at exact time.
@@ -69,16 +71,11 @@ PORT USED BY THE NODE ARE 1980 (DEFAULT) AND 1400 (FOR SONOS DISCOVER). <br/>
 PLEASE ALLOW MDNS AND UDP AS WELL
 
 **TTS Service**<br/>
-You can choose between Google (without credentials), Amazon AWS (Polly) or Google TTS (require credentials and registration to google) engines.<br/>
+You can choose between Google (without credentials), Amazon AWS (Polly), Google TTS (require credentials and registration to google) or Microsoft Azure TTS engines.<br/>
 For Google TTS Engine, you can choose pitch and speed rate of the voice.
 <br/>
 <br/>
 
-* **TTS Service using Google (without credentials)**<br/>
-   This is the simplest way. Just select the voice and you're done. You don't need any credential and you don't even need to be registered to any google service. The voice list is more limited than other services, but it works without hassles.
-   
-<br/>
-
 * **TTS Service using Amazon AWS (Polly)**<br/>
     > HOW-TO in Deutsch: for german users, there is a very helpful how-to, where you can learn how to use the node and how to register to Amazon AWS Polly as well: here: https://technikkram.net/blog/2020/09/26/sonos-sprachausgabe-mit-raspberry-pi-node-red-und-amazon-polly-fuer-homematic-oder-knx-systeme
    
@@ -89,6 +86,11 @@ For Google TTS Engine, you can choose pitch and speed rate of the voice.
    AWS access Secret key. 
 <br/>
 
+* **TTS Service using Google (without credentials)**<br/>
+   This is the simplest way. Just select the voice and you're done. You don't need any credential and you don't even need to be registered to any google service. The voice list is more limited than other services, but it works without hassles.
+   
+<br/>
+
 * **TTS Service using Google TTS**<br/>
    For Google TTS Engine, you can choose pitch and speed rate of the voice.<br/>
    **Google credentials file path**<br/>
@@ -100,6 +102,14 @@ For Google TTS Engine, you can choose pitch and speed rate of the voice.
 
 <br/>
 
+* **TTS Service using Microsot Azure TTS**<br/>
+   For Microsoft Azure TTS Engine, you need to have a microsoft account and register to the Azure portal.<br/>
+   After your registration here https://portal.azure.com, you need to create a Voice Service, then click to Keys and Endpoint and copy/paste the KEY and your Location (for example westus).<br/>
+   Then paste both into the TTS-Ultimate engine configuration window and restart node-red.   
+
+<br/>
+
+
 **Node-Red IP**<br/>
 set IP of your node-red machine. Sonos will connect to this address in order to play TTS. You can also write any value you want, for example 127.0.0.1 in this field (**don't leave this field blank in any case**), if you don't want to use Sonos as player. Please see below, the section **TTS-ULTIMATE NODE**, property **Player**.
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "node-red-contrib-tts-ultimate",
-  "version": "1.0.32",
-  "description": "Transforms the text in speech and hear it using Sonos player. Works with voices from Amazon, Google (without credentials as well) or your own voice. Update of the popular SonosPollyTTS node.",
+  "version": "1.0.33",
+  "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": {
     "test": "test"
@@ -46,7 +46,8 @@
     "os": ">=0.1.1",
     "path": ">=0.12.7",
     "@google-cloud/text-to-speech": "3.3.1",
-    "google-translate-tts": ">=0.2.1"
+    "google-translate-tts": ">=0.2.1",
+    "microsoft-cognitiveservices-speech-sdk": ">=1.18.1"
   },
   "devDependencies": {
     "eslint": ">=4.18.2",

package/ttsultimate/ttsultimate-config.html

@@ -22,7 +22,9 @@
         },
         credentials: {
             accessKey: { type: "text" },
-            secretKey: { type: "password" }
+            secretKey: { type: "password" },
+            mssubscriptionKey: { type: "text" },
+            mslocation: { type: "text" }
         },
         label: function () {
             return this.name || "";
@@ -58,14 +60,21 @@
             // ##########################################################
             $("#node-config-input-ttsservice").change(function (e) {
                 if ($("#node-config-input-ttsservice").val() == "polly") {
-                    $("#pollyForm").show();
                     $("#GoogleForm").hide();
+                    $("#microsoftAzureForm").hide();                    
+                    $("#pollyForm").show();
                 } else if ($("#node-config-input-ttsservice").val() == "googletts") {
+                    $("#microsoftAzureForm").hide();                    
                     $("#pollyForm").hide();
                     $("#GoogleForm").show();
-                }else{
+                } else if ($("#node-config-input-ttsservice").val() == "googletranslate") {
                     $("#pollyForm").hide();
                     $("#GoogleForm").hide();
+                    $("#microsoftAzureForm").hide();                    
+                } else if ($("#node-config-input-ttsservice").val() == "microsoftazuretts") {
+                    $("#pollyForm").hide();
+                    $("#GoogleForm").hide();
+                    $("#microsoftAzureForm").show();
                 }
             });
             // ##########################################################
@@ -161,7 +170,8 @@
             <select id="node-config-input-ttsservice">
                 <option value="polly">Amazon Polly</option>
                 <option value="googletts">Google TTS</option>
-                <option value="googletranslate">Google without authentication</option>                
+                <option value="googletranslate">Google without authentication</option>   
+                <option value="microsoftazuretts">Microsoft Azure TTS</option>   
             </select>&nbsp&nbsp<b><span style="color:red"><i class="fa fa-question-circle"></i>&nbsp<a target="_blank" href="https://github.com/Supergiovane/node-red-contrib-tts-ultimate"><u>Help configure</u></a></span>
         </div>
         <div id="pollyForm">
@@ -180,6 +190,17 @@
                 <input style="width:180px" id="googleCredentialsPath" type="file">
             </div>
         </div>
+        <div id="microsoftAzureForm">
+            <div class="form-row">
+                <label style="width:180px" for="node-config-input-mssubscriptionKey"><i class="fa fa-user"></i> Azure subscription key</label>
+                <input style="width:200px" type="text" id="node-config-input-mssubscriptionKey">
+            </div>
+            <div class="form-row">
+                <label style="width:180px" for="node-config-input-mslocation"><i class="fa fa-user"></i> Azure location (ex:westeurope)</label>
+                <input style="width:200px" type="text" id="node-config-input-mslocation">
+            </div>
+        </div>
+
         <div class="form-row">
             <label for="node-config-input-purgediratrestart"><i class="fa fa-folder-o"></i> TTS Cache</label>
             <select id="node-config-input-purgediratrestart">

package/ttsultimate/ttsultimate-config.js

@@ -4,6 +4,7 @@ module.exports = function (RED) {
     const AWS = require('aws-sdk');
     const GoogleTTS = require('@google-cloud/text-to-speech');
     const GoogleTranslate = require('google-translate-tts'); // TTS without credentials, limited to 200 chars per row.
+    const microsoftAzureTTS = require("microsoft-cognitiveservices-speech-sdk"); // 12/10/2021
     var fs = require('fs');
     var path = require("path");
     var formidable = require('formidable');
@@ -21,7 +22,7 @@ module.exports = function (RED) {
         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 || "polly";
+        node.ttsservice = config.ttsservice || "googletranslate";
 
         // 03/06/2019 you can select the temp dir
         //#region "SETUP PATHS"
@@ -76,26 +77,114 @@ module.exports = function (RED) {
         //#endregion
 
 
-        // 23/12/2020 Set environment path of googleTTS
         //#region "INSTANTIATE SERVICE ENGINES"
+        // POLLY
         var params = {
             accessKeyId: node.credentials.accessKey,
             secretAccessKey: node.credentials.secretKey,
             apiVersion: '2016-06-10'
         };
-        node.polly = new AWS.Polly(params);
+        try {
+            node.polly = new AWS.Polly(params);
+            RED.log.info("ttsultimate.config: Polly service enabled.")
+        } catch (error) {
+            RED.log.warn("ttsultimate.config: Polly service disabled. " + error.message)
+        }
 
+        // Google TTS with authentication
         if (node.ttsservice === "googletts") {
             try {
-                // Set the environment variable
+                // 23/12/2020 Set environment path of googleTTS
                 RED.log.info("ttsultimate-config: 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");
             } catch (error) {
+                RED.log.warn("ttsultimate.config: Google Translate free service error: " + error.message)
             }
 
         }
-        node.googleTTS = new GoogleTTS.TextToSpeechClient();
-        node.googleTranslateTTS = GoogleTranslate;
+        try {
+            node.googleTTS = new GoogleTTS.TextToSpeechClient();
+            RED.log.info("ttsultimate.config: Google Translate free service enabled. ")
+        } catch (error) {
+            RED.log.warn("ttsultimate.config: Google Translate free service disabled. " + error.message)
+        }
+
+
+        // Google Translate without authentication
+        try {
+            node.googleTranslateTTS = GoogleTranslate;
+        } catch (error) {
+        }
+
+
+        // 12/10/2021 Microsoft Azure TTS SpeechConfig.fromSubscription(subscriptionKey, serviceRegion)
+        // #########################################
+        node.setMicrosoftAzureVoice = function (_voiceName) {
+            console.log ("ILSIGNOREBUONO",_voiceName)
+            let speechConfig = microsoftAzureTTS.SpeechConfig.fromSubscription(node.credentials.mssubscriptionKey, node.credentials.mslocation);
+            speechConfig.speechSynthesisVoiceName = _voiceName;
+            speechConfig.speechSynthesisOutputFormat = microsoftAzureTTS.SpeechSynthesisOutputFormat.Audio16Khz32KBitRateMonoMp3;
+            node.microsoftAzureTTS = new microsoftAzureTTS.SpeechSynthesizer(speechConfig);
+            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
+                        }
+                    }
+                    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: 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: 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: 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();
+                    })
+                    reqAzure.end();
+                };
+                RED.log.info("ttsultimate.config: Microsoft AzureTTS service enabled.")
+                try {
+                    listVoicesAzure();
+                } catch (error) {
+                    RED.log.error('ttsultimate-config: listVoices: Error getting Microsoft Azure voices: ' + error.message);
+                }
+            }
+        } catch (error) {
+            RED.log.warn("ttsultimate.config: Microsoft AzureTTS service disabled. " + error.message)
+        }
+        // #########################################
+
         //#endregion
 
 
@@ -313,6 +402,8 @@ module.exports = function (RED) {
                     RED.log.error('ttsultimate-config: listVoices: Error getting google Translate voices ' + error.message);
                 }
 
+            } else if (ttsservice === "microsoftazuretts") {
+                res.json(node.microsoftAzureTTSVoiceList);
             }
         });
 
@@ -531,7 +622,9 @@ module.exports = function (RED) {
     RED.nodes.registerType("ttsultimate-config", TTSConfigNode, {
         credentials: {
             accessKey: { type: "text" },
-            secretKey: { type: "password" }
+            secretKey: { type: "password" },
+            mssubscriptionKey: { type: "text" },
+            mslocation: { type: "text" }
         }
     });
 

package/ttsultimate/ttsultimate.js

@@ -376,7 +376,7 @@ module.exports = function (RED) {
             node.msg.connectionerror = false;
         }
 
-        node.setNodeStatus({ fill: 'green', shape: 'ring', text: 'Initialized.' });
+        node.setNodeStatus({ fill: 'grey', shape: 'ring', text: 'Initialized.' });
 
 
 
@@ -399,8 +399,8 @@ module.exports = function (RED) {
 
             if (_oTrack !== null) {
                 // Do some checks on the track.
-                if (_oTrack.hasOwnProperty("duration") && _oTrack.duration === 0 || 
-                      (_oTrack.uri.startsWith("x-sonosprog-http") || _oTrack.uri.startsWith("x-sonosapi-hls-static") || _oTrack.uri.startsWith("x-sonos-spotify"))) {
+                if (_oTrack.hasOwnProperty("duration") && _oTrack.duration === 0 ||
+                    (_oTrack.uri.startsWith("x-sonosprog-http") || _oTrack.uri.startsWith("x-sonosapi-hls-static") || _oTrack.uri.startsWith("x-sonos-spotify"))) {
                     // Stream
                     _oTrack.trackType = "stream";
                 } else if (_oTrack.hasOwnProperty("duration") && isNaN(_oTrack.duration)) {
@@ -566,6 +566,14 @@ module.exports = function (RED) {
                                         slow: false // optional
                                     };
                                     data = await synthesizeSpeechGoogleTranslate(node.server.googleTranslateTTS, params);
+                                } else if (node.server.ttsservice === "microsoftazuretts") {
+                                    node.setNodeStatus({ fill: 'green', shape: 'ring', text: 'Downloading from Microsoft Azure TTS...' });
+                                    // VoiceId is: code 
+                                    const params = {
+                                        text: msg,
+                                        voice: node.voiceId
+                                    };
+                                    data = await synthesizeSpeechMicrosoftAzureTTS(node.server.microsoftAzureTTS, params);
                                 }
                                 // Save the downloaded file into the cache
                                 fs.writeFileSync(sFileToBePlayed, data, function (error, result) {
@@ -988,6 +996,30 @@ module.exports = function (RED) {
             }
         };
 
+        // 12/10/2021 Microsoft Azure TTS Service
+        async function synthesizeSpeechMicrosoftAzureTTS(ttsService, params) {
+    
+            return new Promise(function (resolve, reject) {
+                try {
+
+                    // Microsoft fa sempre tutto diverso dagli altri, per cui mi tocca reinstanziare l'oggetto
+                    ttsService = node.server.setMicrosoftAzureVoice(params.voice);
+
+                    ttsService.speakTextAsync(
+                        params.text,
+                        result => {
+                            ttsService.close();
+                            resolve (Buffer.from(result.audioData));
+                        },
+                        error => {
+                            ttsService.close();
+                            reject (error);
+                        });
+                } catch (error) {
+                    reject (error);
+                }
+            });
+        };
 
         function getFilename(text, _sVoice, isSSML, extension, _speakingpitch, _speakingrate) {
             // Slug the text.