node-red-contrib-tts-ultimate 3.0.0 → 3.0.2

package/CHANGELOG.md

@@ -2,11 +2,16 @@
 
 [![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square)](https://www.paypal.me/techtoday) 
 
-## BREAKING CHANGE ! BREAKING CHANGE ! BREAKING CHANGE ! BREAKING CHANGE !
 
 <p>
-<b>Version 3.0.0</b> April 2025<br/>
+<b>Version 3.0.1</b> October 2025<br/>
+- Elevenlabs Engine: added more option to personalize the voice.<br/>
+</p>
+
+<p>
+<b>Version 3.0.0</b> June 2025<br/>
 - BREAKING CHANGE: Amazon Polly and Microsoft Azure TTS have been removed due to lack of time to update the old and complex API's. Anyone can add these again by forking the project and do a PR. Thank you!. If you still need those TTS, please stay or revert to 2.0.10.<br/>
+- NEW: Added option to avoid resuming music if it was playing before TTS messages.<br/>
 </p>
 
 -----------------------------------------------------------------------

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-tts-ultimate",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "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, ElevenLabs.io TTS 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.html

@@ -49,6 +49,47 @@
           <label></label>
           <input type="checkbox" id="node-input-elevenlabsUse_speaker_boost" style="margin-left: 0px; vertical-align: top; width: auto !important;"> <label style="width:auto !important;"> Speaker boost</label>
         </div>
+        <div class="form-row">
+          <label for="node-input-elevenlabsModel"><i class="fa fa-cubes"></i> Model</label>
+          <select id="node-input-elevenlabsModel" style="width:60%">
+            <option value="">Automatic</option>
+            <option value="eleven_monolingual_v1">Eleven Monolingual v1</option>
+            <option value="eleven_multilingual_v1">Eleven Multilingual v1</option>
+            <option value="eleven_multilingual_v2">Eleven Multilingual v2</option>
+            <option value="eleven_turbo_v2">Eleven Turbo v2</option>
+            <option value="eleven_turbo_v2_5">Eleven Turbo v2.5</option>
+          </select>
+        </div>
+        <div class="form-row">
+          <label for="node-input-elevenlabsOptimizeLatency"><i class="fa fa-tachometer"></i> Latency preset</label>
+          <select id="node-input-elevenlabsOptimizeLatency" style="width:60%">
+            <option value="">Default</option>
+            <option value="0">0 - Best quality</option>
+            <option value="1">1</option>
+            <option value="2">2</option>
+            <option value="3">3</option>
+            <option value="4">4 - Lowest latency</option>
+          </select>
+        </div>
+        <div class="form-row">
+          <label for="node-input-elevenlabsOutputFormat"><i class="fa fa-file-audio-o"></i> Output format</label>
+          <select id="node-input-elevenlabsOutputFormat" style="width:60%">
+            <option value="">Default (mp3_44100_128)</option>
+            <option value="mp3_44100_192">mp3_44100_192</option>
+            <option value="mp3_44100_128">mp3_44100_128</option>
+            <option value="mp3_44100_64">mp3_44100_64</option>
+            <option value="mp3_44100_32">mp3_44100_32</option>
+            <option value="mp3_22050_128">mp3_22050_128</option>
+            <option value="mp3_22050_64">mp3_22050_64</option>
+            <option value="pcm_16000">pcm_16000</option>
+            <option value="pcm_22050">pcm_22050</option>
+            <option value="ulaw_8000">ulaw_8000</option>
+          </select>
+        </div>
+        <div class="form-row">
+          <label for="node-input-elevenlabsSeed"><i class="fa fa-random"></i> Seed</label>
+          <input type="text" id="node-input-elevenlabsSeed" style="width:120px" placeholder="Leave blank for random">
+        </div>
     </div>
     <div class="form-row" id="divSSML">
         <label></label>
@@ -79,7 +120,10 @@
             <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 for="node-input-doNotResumeMusic"><i class="fa fa-bell-slash-o"></i> Resume</label>
+            <input type="checkbox" id="node-input-doNotResumeMusic" style="margin-left: 0px; vertical-align: top; width: auto !important;"> <label style="width:auto !important;"> Do not resume previous music.</label>
+        </div>
         <div class="form-row">
             <label for="node-input-sonosipaddress"><i class="fa fa-globe"></i> Main Sonos Player</label>
             <label style="width:200px;" id="node-input-sonosipaddress">Discovering.... wait...</label>
@@ -136,6 +180,12 @@
           value: "Hailing_Hailing.mp3",
           required: false,
         },
+        doNotResumeMusic:
+        {
+          value: true,
+          required: false,
+        },
+
         config:
         {
           type: "ttsultimate-config",
@@ -152,6 +202,10 @@
         elevenlabsSimilarity_boost: { value: "0.5", required: false },
         elevenlabsStyle: { value: "0.0", required: false },
         elevenlabsUse_speaker_boost: { value: true, required: false },
+        elevenlabsModel: { value: "", required: false },
+        elevenlabsOptimizeLatency: { value: "", required: false },
+        elevenlabsOutputFormat: { value: "", required: false },
+        elevenlabsSeed: { value: "", required: false },
       },
       inputs: 1,
       outputs: 2,
@@ -175,6 +229,10 @@
       oneditprepare: function () {
         var node = this;
         var oNodeServer = RED.nodes.node($("#node-input-config").val()); // Store the config-node
+        if (node.elevenlabsModel !== undefined) $("#node-input-elevenlabsModel").val(node.elevenlabsModel);
+        if (node.elevenlabsOptimizeLatency !== undefined) $("#node-input-elevenlabsOptimizeLatency").val(node.elevenlabsOptimizeLatency);
+        if (node.elevenlabsOutputFormat !== undefined) $("#node-input-elevenlabsOutputFormat").val(node.elevenlabsOutputFormat);
+        if (node.elevenlabsSeed !== undefined) $("#node-input-elevenlabsSeed").val(node.elevenlabsSeed);
 
         // 19/02/2020 Used to alert the user if the CSV file has not been loaded and to get the server sooner als deploy
         // ###########################
@@ -549,6 +607,7 @@
 | Player | Select the player. If you select not to use a player, the node will output a msg with an array of files, ready to be played by third party nodes. In case you select No player, only output file name, 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. Please see below the OUTPUT MESSAGES FROM THE NODE section. |
 | Volume | Set the preferred TTS volume, from "0" to "100" (can be overridden by passing msg.volume = "40"; to the node). |
 | Unmute | Unmute the main and the addotional players, then restore the previous mute state once finished. (Can be overridden by passing msg.unmute = true; to the node). |
+| Resume | If music was playing prior to TTS messages, the node will try to resume it, but can fail in some cases. Enabla this option to avoid resuming music after TTS message. |
 | Main Sonos Player | 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). 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. |
 | Additional Players | Here you can add all additional players that will be grouped toghether to the Main Sonos Player coordinator group. You can add a player using the "ADD" button, below the list. For each additional player, you can adjust their volume, based on the Main Sonos Player volume -+100. |
 
@@ -602,4 +661,4 @@ The node has two output pins. The first pin is to signal play status, the second
 [Find it useful?](https://www.paypal.me/techtoday)
 
 <br/>
-</script>
+</script>

package/ttsultimate/ttsultimate.js

@@ -80,7 +80,7 @@ module.exports = function (RED) {
     node.sonosCoordinatorIsPreviouslyMuted = false;
     node.passThroughMessage = {};
     node.bTimeOutPlay = false;
-
+    node.doNotResumeMusic = config.doNotResumeMusic === undefined ? false : config.doNotResumeMusic; // 06/2025 Do not resume previous music after TTS, if playing.
     if (typeof node.server !== "undefined" && node.server !== null) {
       node.sNoderedURL = node.server.sNoderedURL || "";
     }
@@ -660,15 +660,18 @@ module.exports = function (RED) {
                 }
               } else if (node.server.ttsservice === "elevenlabs") {
                 // VoiceId is: code 
+                const stability = config.elevenlabsStability !== undefined && config.elevenlabsStability !== "" ? Number(config.elevenlabsStability) : undefined;
+                const similarity = config.elevenlabsSimilarity_boost !== undefined && config.elevenlabsSimilarity_boost !== "" ? Number(config.elevenlabsSimilarity_boost) : undefined;
+                const resolvedModel = config.elevenlabsModel && config.elevenlabsModel !== "" ? config.elevenlabsModel : "eleven_monolingual_v1";
                 const params = {
                   text: msg,
                   voice: node.voiceId,
-                  model_id: "eleven_monolingual_v1",
-                  voice_settings: {
-                    stability: config.elevenlabsStability,
-                    similarity_boost: config.elevenlabsSimilarity_boost
-                  }
+                  model_id: resolvedModel,
+                  voice_settings: {}
                 };
+                if (stability !== undefined && !Number.isNaN(stability)) params.voice_settings.stability = stability;
+                if (similarity !== undefined && !Number.isNaN(similarity)) params.voice_settings.similarity_boost = similarity;
+                if (Object.keys(params.voice_settings).length === 0) delete params.voice_settings;
                 // Download or read from cache
                 node.sFileToBePlayed = getFilename(msg, params);
                 node.sFileToBePlayed = path.join(node.userDir, "ttsfiles", node.sFileToBePlayed);
@@ -680,18 +683,29 @@ module.exports = function (RED) {
                 }
               } else if (node.server.ttsservice === "elevenlabsv2") {
                 // VoiceId is: code 
+                const stability = config.elevenlabsStability !== undefined && config.elevenlabsStability !== "" ? Number(config.elevenlabsStability) : undefined;
+                const similarity = config.elevenlabsSimilarity_boost !== undefined && config.elevenlabsSimilarity_boost !== "" ? Number(config.elevenlabsSimilarity_boost) : undefined;
+                const style = config.elevenlabsStyle !== undefined && config.elevenlabsStyle !== "" ? Number(config.elevenlabsStyle) : undefined;
+                const resolvedModel = config.elevenlabsModel && config.elevenlabsModel !== "" ? config.elevenlabsModel : "eleven_multilingual_v2";
+                const latencyPreset = config.elevenlabsOptimizeLatency && config.elevenlabsOptimizeLatency !== "" ? config.elevenlabsOptimizeLatency : undefined;
+                const outputFormat = config.elevenlabsOutputFormat && config.elevenlabsOutputFormat !== "" ? config.elevenlabsOutputFormat : undefined;
+                const seed = config.elevenlabsSeed && config.elevenlabsSeed !== "" ? Number(config.elevenlabsSeed) : undefined;
+                const useSpeakerBoost = config.elevenlabsUse_speaker_boost === undefined ? true : config.elevenlabsUse_speaker_boost;
                 const params = {
                   stream: false,
                   text: msg,
                   voice: node.voiceId,
-                  model_id: "eleven_multilingual_v2",
-                  voice_settings: {
-                    stability: config.elevenlabsStability,
-                    similarity_boost: config.elevenlabsSimilarity_boost,
-                    style: config.elevenlabsStyle || 0,
-                    use_speaker_boost: config.elevenlabsUse_speaker_boost === undefined ? true : config.elevenlabsUse_speaker_boost
-                  }
+                  model_id: resolvedModel,
+                  voice_settings: {}
                 };
+                if (stability !== undefined && !Number.isNaN(stability)) params.voice_settings.stability = stability;
+                if (similarity !== undefined && !Number.isNaN(similarity)) params.voice_settings.similarity_boost = similarity;
+                if (style !== undefined && !Number.isNaN(style)) params.voice_settings.style = style;
+                params.voice_settings.use_speaker_boost = useSpeakerBoost;
+                if (Object.keys(params.voice_settings).length === 0) delete params.voice_settings;
+                if (latencyPreset !== undefined) params.optimize_streaming_latency = latencyPreset;
+                if (outputFormat !== undefined) params.output_format = outputFormat;
+                if (seed !== undefined && !Number.isNaN(seed)) params.seed = seed;
                 // Download or read from cache
                 node.sFileToBePlayed = getFilename(msg, params);
                 node.sFileToBePlayed = path.join(node.userDir, "ttsfiles", node.sFileToBePlayed);
@@ -857,37 +871,39 @@ module.exports = function (RED) {
           await delay(2000);
 
           // Resume music
-          try {
-            if (oCurTrack !== null && (!oCurTrack.hasOwnProperty("title") || oCurTrack.title.indexOf(".mp3") === -1)) {
-              node.setNodeStatus({ fill: 'grey', shape: 'ring', text: "Resuming original queue..." });
-              await resumeMusicQueue(oCurTrack);
-              node.setNodeStatus({ fill: 'green', shape: 'ring', text: "Done resuming queue." });
-            } else {
-              // 28/08/2021 There was no queue playing. Delete the TTS from the queue
-              node.setNodeStatus({ fill: 'green', shape: 'ring', text: "No queue to resume." });
+          if (!node.doNotResumeMusic) {
+            try {
+              if (oCurTrack !== null && (!oCurTrack.hasOwnProperty("title") || oCurTrack.title.indexOf(".mp3") === -1)) {
+                node.setNodeStatus({ fill: 'grey', shape: 'ring', text: "Resuming original queue..." });
+                await resumeMusicQueue(oCurTrack);
+                node.setNodeStatus({ fill: 'green', shape: 'ring', text: "Done resuming queue." });
+              } else {
+                // 28/08/2021 There was no queue playing. Delete the TTS from the queue
+                node.setNodeStatus({ fill: 'green', shape: 'ring', text: "No queue to resume." });
+              }
+            } catch (error) {
+              node.setNodeStatus({ fill: 'red', shape: 'ring', text: "Error resuming queue: " + error.message });
             }
-          } catch (error) {
-            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 || "");
+          if (!node.doNotResumeMusic) {
+            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 || "" });
               }
-            } 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;
@@ -1192,7 +1208,10 @@ module.exports = function (RED) {
       }
       return new Promise((resolve, reject) => {
         // "model_id": "eleven_multilingual_v1",
-        ttsService.textToSpeechStream(node.server.credentials.elevenlabsKey, params.voice, params.text, null, null, "eleven_multilingual_v1").then((res) => {
+        const stability = params.voice_settings && params.voice_settings.stability !== undefined ? params.voice_settings.stability : null;
+        const similarity = params.voice_settings && params.voice_settings.similarity_boost !== undefined ? params.voice_settings.similarity_boost : null;
+        const model = params.model_id !== undefined && params.model_id !== "" ? params.model_id : "eleven_monolingual_v1";
+        ttsService.textToSpeechStream(node.server.credentials.elevenlabsKey, params.voice, params.text, stability, similarity, model).then((res) => {
           try {
             if (res !== undefined) {
               resolve(stream2buffer(res));