0.2.8

support rimelabs arcana

lib/add-file-to-cache.js

@@ -3,8 +3,29 @@ const {noopLogger, makeSynthKey} = require('./utils');
 const {JAMBONES_TTS_CACHE_DURATION_MINS} = require('./config');
 const EXPIRES = JAMBONES_TTS_CACHE_DURATION_MINS;
 
+function getExtensionAndSampleRate(path) {
+  const match = path.match(/\.([^.]*)$/);
+  if (!match) {
+    //default should be wav file.
+    return ['wav', 8000];
+  }
+
+  const extension = match[1];
+  const sampleRateMap = {
+    r8: 8000,
+    r16: 16000,
+    r24: 24000,
+    r44: 44100,
+    r48: 48000,
+    r96: 96000,
+  };
+
+  const sampleRate = sampleRateMap[extension] || 8000;
+  return [extension, sampleRate];
+}
+
 async function addFileToCache(client, logger, path,
-  {account_sid, vendor, language, voice, deploymentId, engine, text}) {
+  {account_sid, vendor, language, voice, deploymentId, engine, model, text}) {
   let key;
   logger = logger || noopLogger;
 
@@ -15,10 +36,18 @@ async function addFileToCache(client, logger, path,
       language: language || '',
       voice: voice || deploymentId,
       engine,
+      model,
       text,
     });
+    const [extension, sampleRate] = getExtensionAndSampleRate(path);
     const audioBuffer = await fs.readFile(path);
-    await client.setex(key, EXPIRES, audioBuffer.toString('base64'));
+    await client.setex(key, EXPIRES, JSON.stringify(
+      {
+        audioContent: audioBuffer.toString('base64'),
+        extension,
+        sampleRate
+      }
+    ));
   } catch (err) {
     logger.error(err, 'addFileToCache: Error');
     return;

lib/purge-tts-cache.js

@@ -12,7 +12,7 @@ const debug = require('debug')('jambonz:realtimedb-helpers');
  * @returns {object} result - {error, purgedCount}
  */
 async function purgeTtsCache(client, logger, {all, account_sid, vendor,
-  language, voice, deploymentId, engine, text} = {all: true}) {
+  language, voice, deploymentId, engine, model, text} = {all: true}) {
   logger = logger || noopLogger;
 
   let purgedCount = 0, error;
@@ -33,6 +33,7 @@ async function purgeTtsCache(client, logger, {all, account_sid, vendor,
         language: language || '',
         voice: voice || deploymentId,
         engine,
+        model,
         text,
       });
       purgedCount = await client.del(key);

lib/synth-audio.js

@@ -46,7 +46,7 @@ const {
   JAMBONES_HTTP_PROXY_IP,
   JAMBONES_HTTP_PROXY_PORT,
   JAMBONES_TTS_CACHE_DURATION_MINS,
-  JAMBONES_EAGERLY_PRE_CACHE_AUDIO,
+  JAMBONES_TTS_TRIM_SILENCE,
 } = require('./config');
 const EXPIRES = JAMBONES_TTS_CACHE_DURATION_MINS;
 const OpenAI = require('openai');
@@ -91,7 +91,7 @@ async function synthAudio(client, createHash, retrieveHash, logger, stats, { acc
   vendor, language, voice, gender, text, engine, salt, model, credentials, deploymentId,
   disableTtsCache, renderForCaching = false, disableTtsStreaming, options
 }) {
-  let audioBuffer;
+  let audioData;
   let servedFromCache = false;
   let rtt;
   logger = logger || noopLogger;
@@ -169,57 +169,26 @@ async function synthAudio(client, createHash, retrieveHash, logger, stats, { acc
     language: language || '',
     voice: voice || deploymentId,
     engine,
-    text,
+    // model or model_id is used to identify the tts cache.
-    renderForCaching
+    model: model || credentials.model_id,
+    text
   });
-  let filePath;
+
-  // used only for custom vendor
-  let fileExtension;
-  filePath = makeFilePath({vendor, voice, key, salt, renderForCaching});
   debug(`synth key is ${key}`);
   let cached;
   if (!disableTtsCache) {
     cached = await client.get(key);
-    /**
-    *  If we are using tts streaming and also precaching audio, audio could have been cached by streaming (r8)
-    * or here in speech-utils due to precaching (mp3), so we need to check for both keys.
-    */
-    if (!cached && JAMBONES_EAGERLY_PRE_CACHE_AUDIO) {
-      const preCachekey = makeSynthKey({
-        account_sid,
-        vendor,
-        language: language || '',
-        voice: voice || deploymentId,
-        engine,
-        text,
-        renderForCaching: true
-      });
-      cached = await client.get(preCachekey);
-      if (cached) {
-        // Precache audio is available update filpath with precache file extension.
-        filePath = makeFilePath({vendor, voice, key, salt, renderForCaching: true});
-      }
-    }
   }
   if (cached) {
     // found in cache - extend the expiry and use it
     debug('result WAS found in cache');
     servedFromCache = true;
     stats.increment('tts.cache.requests', ['found:yes']);
-    if (vendor.startsWith('custom')) {
+    audioData = JSON.parse(cached);
-      // custom vendors support multiple mime types such as: mp3, wav, r8, r16 ...etc,
+    // convert base64 audio to buffer
-      // mime type/file extension is available when http response has header Content-type.
+    audioData.audioContent = Buffer.from(audioData.audioContent, 'base64');
-      // In cache, file extension is store together with audiBuffer in a json.
-      // Normal cache audio will be base64 string
-      const payload = JSON.parse(cached);
-      filePath = filePath.replace(/\.[^\.]*$/g, payload.fileExtension);
-      audioBuffer = Buffer.from(payload.audioBuffer, 'base64');
-    } else {
-      audioBuffer = Buffer.from(cached, 'base64');
-    }
     client.expire(key, EXPIRES).catch((err) => logger.info(err, 'Error setting expires'));
-  }
+  } else {
-  if (!cached) {
     // not found in cache - go get it from speech vendor and add to cache
     debug('result was NOT found in cache');
     stats.increment('tts.cache.requests', ['found:no']);
@@ -227,94 +196,93 @@ async function synthAudio(client, createHash, retrieveHash, logger, stats, { acc
     const startAt = process.hrtime();
     switch (vendor) {
       case 'google':
-        audioBuffer = await synthGoogle(logger, {credentials, stats, language, voice, gender, text});
+        audioData = await synthGoogle(logger, {credentials, stats, language, voice, gender, text});
         break;
       case 'aws':
       case 'polly':
         vendorLabel = 'aws';
-        audioBuffer = await synthPolly(createHash, retrieveHash, logger,
+        audioData = await synthPolly(createHash, retrieveHash, logger,
           {credentials, stats, language, voice, text, engine});
         break;
       case 'azure':
       case 'microsoft':
         vendorLabel = 'microsoft';
-        audioBuffer = await synthMicrosoft(logger, {credentials, stats, language, voice, text, deploymentId,
+        audioData = await synthMicrosoft(logger, {credentials, stats, language, voice, text, deploymentId,
-          filePath, renderForCaching, disableTtsStreaming});
+          renderForCaching, disableTtsStreaming});
         break;
       case 'nuance':
         model = model || 'enhanced';
-        audioBuffer = await synthNuance(client, logger, {credentials, stats, voice, model, text});
+        audioData = await synthNuance(client, logger, {credentials, stats, voice, model, text});
         break;
       case 'nvidia':
-        audioBuffer = await synthNvidia(client, logger, {credentials, stats, language, voice, model, text});
+        audioData = await synthNvidia(client, logger, {credentials, stats, language, voice, model, text,
+          renderForCaching, disableTtsStreaming});
         break;
       case 'ibm':
-        audioBuffer = await synthIbm(logger, {credentials, stats, voice, text});
+        audioData = await synthIbm(logger, {credentials, stats, voice, text});
         break;
       case 'wellsaid':
-        audioBuffer = await synthWellSaid(logger, {credentials, stats, language, voice, text, filePath});
+        audioData = await synthWellSaid(logger, {credentials, stats, language, voice, text});
         break;
       case 'elevenlabs':
-        audioBuffer = await synthElevenlabs(logger, {
+        audioData = await synthElevenlabs(logger, {
-          credentials, options, stats, language, voice, text, renderForCaching, disableTtsStreaming, filePath
+          credentials, options, stats, language, voice, text, renderForCaching, disableTtsStreaming});
-        });
         break;
       case 'playht':
-        audioBuffer = await synthPlayHT(client, logger, {
+        audioData = await synthPlayHT(client, logger, {
-          credentials, options, stats, language, voice, text, renderForCaching, disableTtsStreaming, filePath
+          credentials, options, stats, language, voice, text, renderForCaching, disableTtsStreaming});
-        });
         break;
       case 'cartesia':
-        audioBuffer = await synthCartesia(logger, {
+        audioData = await synthCartesia(logger, {
-          credentials, options, stats, language, voice, text, renderForCaching, disableTtsStreaming, filePath
+          credentials, options, stats, language, voice, text, renderForCaching, disableTtsStreaming});
-        });
         break;
       case 'rimelabs':
-        audioBuffer = await synthRimelabs(logger, {
+        audioData = await synthRimelabs(logger, {
-          credentials, options, stats, language, voice, text, renderForCaching, disableTtsStreaming, filePath
+          credentials, options, stats, language, voice, text, renderForCaching, disableTtsStreaming});
-        });
         break;
       case 'whisper':
-        audioBuffer = await synthWhisper(logger, {
+        audioData = await synthWhisper(logger, {
           credentials, stats, voice, text, renderForCaching, disableTtsStreaming});
         break;
       case 'verbio':
-        audioBuffer = await synthVerbio(client, logger, {
+        audioData = await synthVerbio(client, logger, {
           credentials, stats, voice, text, renderForCaching, disableTtsStreaming});
-        if (audioBuffer?.filePath) return audioBuffer;
+        if (audioData?.filePath) return audioData;
         break;
       case 'deepgram':
-        audioBuffer = await synthDeepgram(logger, {credentials, stats, model, text,
+        audioData = await synthDeepgram(logger, {credentials, stats, model, text,
           renderForCaching, disableTtsStreaming});
         break;
       case vendor.startsWith('custom') ? vendor : 'cant_match_value':
-        ({ audioBuffer, filePath, fileExtension } = await synthCustomVendor(logger,
+        audioData = await synthCustomVendor(logger,
-          {credentials, stats, language, voice, text, filePath}));
+          {credentials, stats, language, voice, text});
         break;
       default:
         assert(`synthAudio: unsupported speech vendor ${vendor}`);
     }
-    if ('filePath' in audioBuffer) return audioBuffer;
+    if ('filePath' in audioData) return audioData;
     const diff = process.hrtime(startAt);
     const time = diff[0] * 1e3 + diff[1] * 1e-6;
     rtt = time.toFixed(0);
     stats.histogram('tts.response_time', rtt, [`vendor:${vendorLabel}`]);
     debug(`tts rtt time for ${text.length} chars on ${vendorLabel}: ${rtt}`);
     logger.info(`tts rtt time for ${text.length} chars on ${vendorLabel}: ${rtt}`);
-
+    // Save audio json to cache
-    const base64Audio = audioBuffer.toString('base64');
+    client.setex(key, EXPIRES, JSON.stringify({
-    const cacheContent = vendor.startsWith('custom') ?
+      ...audioData,
-      JSON.stringify({
+      audioContent: audioData.audioContent?.toString('base64')
-        audioBuffer: base64Audio,
+    }))
-        fileExtension
-      }) : base64Audio;
-
-    client.setex(key, EXPIRES, cacheContent)
       .catch((err) => logger.error(err, `error calling setex on key ${key}`));
   }
 
   return new Promise((resolve, reject) => {
-    fs.writeFile(filePath, audioBuffer, (err) => {
+    const { audioContent, extension } = audioData;
+    const filePath = makeFilePath({
+      key,
+      salt,
+      extension
+    });
+    fs.writeFile(filePath, audioContent, (err) => {
       if (err) return reject(err);
       resolve({filePath, servedFromCache, rtt});
     });
@@ -369,7 +337,13 @@ const synthPolly = async(createHash, retrieveHash, logger,
         .on('data', (chunk) => {
           chunks.push(chunk);
         })
-        .on('end', () => resolve(Buffer.concat(chunks)));
+        .on('end', () => resolve(
+          {
+            audioContent: Buffer.concat(chunks),
+            extension: 'mp3',
+            sampleRate: 8000
+          }
+        ));
     });
   } catch (err) {
     logger.info({err}, 'synthAudio: Error synthesizing speech using aws polly');
@@ -411,7 +385,11 @@ const synthGoogle = async(logger, {credentials, stats, language, voice, gender,
       };
 
       const wav = await post('/v1beta1/text:synthesize', payload);
-      return Buffer.from(wav.audioContent, 'base64');
+      return {
+        audioContent: Buffer.from(wav.audioContent, 'base64'),
+        extension: 'wav',
+        sampleRate: 24000
+      };
     } catch (err) {
       logger.info({err: await err.text()}, 'synthGoogle returned error');
       throw err;
@@ -432,7 +410,11 @@ const synthGoogle = async(logger, {credentials, stats, language, voice, gender,
     const responses = await client.synthesizeSpeech(opts);
     stats.increment('tts.count', ['vendor:google', 'accepted:yes']);
     client.close();
-    return responses[0].audioContent;
+    return {
+      audioContent: responses[0].audioContent,
+      extension: 'mp3',
+      sampleRate: 8000
+    };
   } catch (err) {
     console.error(err);
     logger.info({err, opts}, 'synthAudio: Error synthesizing speech using google');
@@ -463,7 +445,11 @@ const synthIbm = async(logger, {credentials, stats, voice, text}) => {
     for await (const chunk of r.result) {
       chunks.push(chunk);
     }
-    return Buffer.concat(chunks);
+    return {
+      audioContent: Buffer.concat(chunks),
+      extension: 'mp3',
+      sampleRate: 8000
+    };
   } catch (err) {
     logger.info({err, params}, 'synthAudio: Error synthesizing speech using ibm');
     stats.increment('tts.count', ['vendor:ibm', 'accepted:no']);
@@ -473,11 +459,9 @@ const synthIbm = async(logger, {credentials, stats, voice, text}) => {
 
 async function _synthOnPremMicrosoft(logger, {
   credentials,
-  stats,
   language,
   voice,
-  text,
+  text
-  filePath
 }) {
   const {use_custom_tts, custom_tts_endpoint_url, api_key} = credentials;
   let content = text;
@@ -499,15 +483,19 @@ async function _synthOnPremMicrosoft(logger, {
   }
 
   try {
-    const trimSilence = filePath.endsWith('.r8');
+    const trimSilence = JAMBONES_TTS_TRIM_SILENCE;
     const post = bent('POST', 'buffer', {
       'X-Microsoft-OutputFormat': trimSilence ? 'raw-8khz-16bit-mono-pcm' : 'audio-16khz-32kbitrate-mono-mp3',
       'Content-Type': 'application/ssml+xml',
       'User-Agent': 'Jambonz',
       ...(api_key && {'Ocp-Apim-Subscription-Key': api_key})
     });
-    const mp3 = await post(custom_tts_endpoint_url, content);
+    const audioContent = await post(custom_tts_endpoint_url, content);
-    return mp3;
+    return {
+      audioContent,
+      extension: trimSilence ? 'r8' : 'mp3',
+      sampleRate: 8000
+    };
   } catch (err) {
     logger.info({err}, '_synthMicrosoftByHttp returned error');
     throw err;
@@ -520,7 +508,6 @@ const synthMicrosoft = async(logger, {
   language,
   voice,
   text,
-  filePath,
   renderForCaching,
   disableTtsStreaming
 }) => {
@@ -563,17 +550,18 @@ const synthMicrosoft = async(logger, {
         rtt: 0
       };
     }
+    // Azure Onprem
     if (use_custom_tts && custom_tts_endpoint_url) {
       return await _synthOnPremMicrosoft(logger, {
         credentials,
         stats,
         language,
         voice,
-        text,
+        text
-        filePath
       });
     }
-    const trimSilence = filePath.endsWith('.r8');
+    // Azure hosted service
+    const trimSilence = JAMBONES_TTS_TRIM_SILENCE;
     const speechConfig = SpeechConfig.fromSubscription(apiKey, region);
     speechConfig.speechSynthesisLanguage = language;
     speechConfig.speechSynthesisVoiceName = voice;
@@ -608,7 +596,11 @@ const synthMicrosoft = async(logger, {
             case ResultReason.SynthesizingAudioCompleted:
               let buffer = Buffer.from(result.audioData);
               if (trimSilence) buffer = trimTrailingSilence(buffer);
-              resolve(buffer);
+              resolve({
+                audioContent: buffer,
+                extension: trimSilence ? 'r8' : 'mp3',
+                sampleRate: 8000
+              });
               synthesizer.close();
               stats.increment('tts.count', ['vendor:microsoft', 'accepted:yes']);
               break;
@@ -638,11 +630,15 @@ const synthWellSaid = async(logger, {credentials, stats, language, voice, gender
       'Accept': 'audio/mpeg',
       'Content-Type': 'application/json'
     });
-    const mp3 = await post('/v1/tts/stream', {
+    const audioContent = await post('/v1/tts/stream', {
       text,
       speaker_id: voice
     });
-    return mp3;
+    return {
+      audioContent,
+      extension: 'mp3',
+      sampleRate: 8000
+    };
   } catch (err) {
     logger.info({err}, 'testWellSaidTts returned error');
     throw err;
@@ -679,8 +675,8 @@ const synthNuance = async(client, logger, {credentials, stats, voice, model, tex
     t.setText(text);
     input.setText(t);
   }
-
+  const sampleRate = 8000;
-  pcm.setSampleRateHz(8000);
+  pcm.setSampleRateHz(sampleRate);
   f.setPcm(pcm);
   p.setAudioFormat(f);
   v.setName(voice);
@@ -704,20 +700,41 @@ const synthNuance = async(client, logger, {credentials, stats, voice, model, tex
         const details = status.getDetails();
         return reject({code, message, details});
       }
-      resolve(Buffer.from(response.getAudio()));
+      resolve({
+        audioContent: Buffer.from(response.getAudio()),
+        extension: 'r8',
+        sampleRate
+      });
     });
   });
 };
 
-const synthNvidia = async(client, logger, {credentials, stats, language,  voice, model, text}) => {
+const synthNvidia = async(client, logger, {
+  credentials, stats, language,  voice, model, text, renderForCaching, disableTtsStreaming
+}) => {
   const {riva_server_uri} = credentials;
+  if (!JAMBONES_DISABLE_TTS_STREAMING && !renderForCaching && !disableTtsStreaming) {
+    let params = '';
+    params += `{riva_server_uri=${riva_server_uri}`;
+    params += `,voice=${voice}`;
+    params += `,language=${language}`;
+    params += ',write_cache_file=1';
+    params += '}';
+
+    return {
+      filePath: `say:${params}${text.replace(/\n/g, ' ')}`,
+      servedFromCache: false,
+      rtt: 0
+    };
+  }
   let rivaClient, request;
+  const sampleRate = 8000;
   try {
     rivaClient = await createRivaClient(riva_server_uri);
     request = new SynthesizeSpeechRequest();
     request.setVoiceName(voice);
     request.setLanguageCode(language);
-    request.setSampleRateHz(8000);
+    request.setSampleRateHz(sampleRate);
     request.setEncoding(AudioEncoding.LINEAR_PCM);
     request.setText(text);
   } catch (err) {
@@ -731,7 +748,11 @@ const synthNvidia = async(client, logger, {credentials, stats, language,  voice,
         logger.info({err, voice, language}, 'error synthesizing speech using Nvidia');
         return reject(err);
       }
-      resolve(Buffer.from(response.getAudio()));
+      resolve({
+        audioContent: Buffer.from(response.getAudio()),
+        extension: 'r8',
+        sampleRate
+      });
     });
   });
 };
@@ -753,14 +774,13 @@ const synthCustomVendor = async(logger, {credentials, stats, language, voice, te
       text
     });
 
-    const regex = /\.[^\.]*$/g;
     const mime = response.headers['content-type'];
     const buffer = await response.arrayBuffer();
-    const fileExtension = getFileExtFromMime(mime);
+    const [extension, sampleRate] = getFileExtFromMime(mime);
     return {
-      audioBuffer: buffer,
+      audioContent: buffer,
-      filePath: filePath.replace(regex, fileExtension),
+      extension,
-      fileExtension
+      sampleRate
     };
   } catch (err) {
     logger.info({err}, `Vendor ${vendor} returned error`);
@@ -786,9 +806,13 @@ const synthElevenlabs = async(logger, {
     if (opts.voice_settings?.similarity_boost) params += `,similarity_boost=${opts.voice_settings.similarity_boost}`;
     if (opts.voice_settings?.stability) params += `,stability=${opts.voice_settings.stability}`;
     if (opts.voice_settings?.style) params += `,style=${opts.voice_settings.style}`;
+    if (opts.voice_settings?.speed !== null && opts.voice_settings?.speed !== undefined)
+      params += `,speed=${opts.voice_settings.speed}`;
     if (opts.voice_settings?.use_speaker_boost === false) params += ',use_speaker_boost=false';
     if (opts.previous_text) params += `,previous_text=${opts.previous_text}`;
     if (opts.next_text) params += `,next_text=${opts.next_text}`;
+    if (opts.pronunciation_dictionary_locators && Array.isArray(opts.pronunciation_dictionary_locators))
+      params += `,pronunciation_dictionary_locators=${JSON.stringify(opts.pronunciation_dictionary_locators)}`;
     params += '}';
 
     return {
@@ -806,7 +830,7 @@ const synthElevenlabs = async(logger, {
       'Accept': 'audio/mpeg',
       'Content-Type': 'application/json'
     });
-    const mp3 = await post(`/v1/text-to-speech/${voice}${optimize_streaming_latency}`, {
+    const audioContent = await post(`/v1/text-to-speech/${voice}${optimize_streaming_latency}`, {
       text,
       model_id,
       voice_settings: {
@@ -815,7 +839,11 @@ const synthElevenlabs = async(logger, {
       },
       ...opts
     });
-    return mp3;
+    return {
+      audioContent,
+      extension: 'mp3',
+      sampleRate: 8000
+    };
   } catch (err) {
     logger.info({err}, 'synth Elevenlabs returned error');
     stats.increment('tts.count', ['vendor:elevenlabs', 'accepted:no']);
@@ -897,7 +925,7 @@ const synthPlayHT = async(client, logger, {
       'Content-Type': 'application/json'
     });
 
-    const mp3 = await post(synthesizeUrl, {
+    const audioContent = await post(synthesizeUrl, {
       text,
       ...(voice_engine === 'Play3.0' && { language }),
       voice,
@@ -906,7 +934,11 @@ const synthPlayHT = async(client, logger, {
       sample_rate: 8000,
       ...opts
     });
-    return mp3;
+    return {
+      audioContent,
+      extension: 'mp3',
+      sampleRate: 8000
+    };
   } catch (err) {
     logger.info({err}, 'synth PlayHT returned error');
     stats.increment('tts.count', ['vendor:playht', 'accepted:no']);
@@ -915,7 +947,7 @@ const synthPlayHT = async(client, logger, {
 };
 
 const synthRimelabs = async(logger, {
-  credentials, options, stats, voice, text, renderForCaching, disableTtsStreaming
+  credentials, options, stats, language, voice, text, renderForCaching, disableTtsStreaming
 }) => {
   const {api_key, model_id, options: credOpts} = credentials;
   const opts = !!options && Object.keys(options).length !== 0 ? options : JSON.parse(credOpts || '{}');
@@ -926,10 +958,16 @@ const synthRimelabs = async(logger, {
     params += `{api_key=${api_key}`;
     params += `,model_id=${model_id}`;
     params += ',vendor=rimelabs';
+    params += `,language=${language}`;
     params += `,voice=${voice}`;
     params += ',write_cache_file=1';
     if (opts.speedAlpha) params += `,speed_alpha=${opts.speedAlpha}`;
     if (opts.reduceLatency) params += `,reduce_latency=${opts.reduceLatency}`;
+    // Arcana model parameters
+    if (opts.temperature) params += `,temperature=${opts.temperature}`;
+    if (opts.repetition_penalty) params += `,repetition_penalty=${opts.repetition_penalty}`;
+    if (opts.top_p) params += `,top_p=${opts.top_p}`;
+    if (opts.max_tokens) params += `,max_tokens=${opts.max_tokens}`;
     params += '}';
 
     return {
@@ -945,14 +983,20 @@ const synthRimelabs = async(logger, {
       'Accept': 'audio/mp3',
       'Content-Type': 'application/json'
     });
-    const mp3 = await post('/v1/rime-tts', {
+    const sampleRate = 8000;
+    const audioContent = await post('/v1/rime-tts', {
       speaker: voice,
       text,
       modelId: model_id,
-      samplingRate: 8000,
+      samplingRate: sampleRate,
+      lang: language,
       ...opts
     });
-    return mp3;
+    return {
+      audioContent,
+      extension: 'mp3',
+      sampleRate
+    };
   } catch (err) {
     logger.info({err}, 'synth rimelabs returned error');
     stats.increment('tts.count', ['vendor:rimelabs', 'accepted:no']);
@@ -986,13 +1030,17 @@ const synthVerbio = async(client, logger, {credentials, stats, voice, text, rend
       'User-Agent': 'jambonz',
       'Content-Type': 'application/json'
     });
-    const r8 = await post('/api/v1/synthesize', {
+    const audioContent = await post('/api/v1/synthesize', {
       voice_id: voice,
       output_sample_rate: '8k',
       output_encoding: 'pcm16',
       text
     });
-    return r8;
+    return {
+      audioContent,
+      extension: 'r8',
+      sampleRate: 8000
+    };
   } catch (err) {
     logger.info({err}, 'synth Verbio returned error');
     stats.increment('tts.count', ['vendor:verbio', 'accepted:no']);
@@ -1032,7 +1080,11 @@ const synthWhisper = async(logger, {credentials, stats, voice, text, renderForCa
       input: text,
       response_format: 'mp3'
     });
-    return Buffer.from(await mp3.arrayBuffer());
+    return {
+      audioContent: Buffer.from(await mp3.arrayBuffer()),
+      extension: 'mp3',
+      sampleRate: 8000
+    };
   } catch (err) {
     logger.info({err}, 'synth whisper returned error');
     stats.increment('tts.count', ['vendor:openai', 'accepted:no']);
@@ -1064,10 +1116,14 @@ const synthDeepgram = async(logger, {credentials, stats, model, text, renderForC
       'Accept': 'audio/mpeg',
       'Content-Type': 'application/json'
     });
-    const mp3 = await post(`/v1/speak?model=${model}`, {
+    const audioContent = await post(`/v1/speak?model=${model}`, {
       text
     });
-    return mp3;
+    return {
+      audioContent,
+      extension: 'mp3',
+      sampleRate: 8000
+    };
   } catch (err) {
     logger.info({err}, 'synth Deepgram returned error');
     stats.increment('tts.count', ['vendor:deepgram', 'accepted:no']);
@@ -1104,6 +1160,7 @@ const synthCartesia = async(logger, {
 
   try {
     const client = new CartesiaClient({ apiKey: api_key });
+    const sampleRate = 48000;
     const mp3 = await client.tts.bytes({
       modelId: model_id,
       transcript: text,
@@ -1119,7 +1176,7 @@ const synthCartesia = async(logger, {
         ),
         ...(opts.speed || opts.emotion && {
           experimentalControls: {
-            ...(opts.speed && {speed: opts.speed}),
+            ...(opts.speed !== null && opts.speed !== undefined && {speed: opts.speed}),
             ...(opts.emotion && {emotion: opts.emotion}),
           }
         })
@@ -1128,10 +1185,14 @@ const synthCartesia = async(logger, {
       outputFormat: {
         container: 'mp3',
         bitRate: 128000,
-        sampleRate: 8000
+        sampleRate
       },
     });
-    return Buffer.from(mp3);
+    return {
+      audioContent: Buffer.from(mp3),
+      extension: 'mp3',
+      sampleRate
+    };
   } catch (err) {
     logger.info({err}, 'synth Cartesia returned error');
     stats.increment('tts.count', ['vendor:cartesia', 'accepted:no']);
@@ -1144,22 +1205,22 @@ const getFileExtFromMime = (mime) => {
   switch (mime) {
     case 'audio/wav':
     case 'audio/x-wav':
-      return '.wav';
+      return ['wav', 8000];
     case /audio\/l16.*rate=8000/.test(mime) ? mime : 'cant match value':
-      return '.r8';
+      return ['r8', 8000];
     case /audio\/l16.*rate=16000/.test(mime) ? mime : 'cant match value':
-      return '.r16';
+      return ['r16', 16000];
     case /audio\/l16.*rate=24000/.test(mime) ? mime : 'cant match value':
-      return '.r24';
+      return ['r24', 24000];
     case /audio\/l16.*rate=32000/.test(mime) ? mime : 'cant match value':
-      return '.r32';
+      return ['r32', 32000];
     case /audio\/l16.*rate=48000/.test(mime) ? mime : 'cant match value':
-      return '.r48';
+      return ['r48', 48000];
     case 'audio/mpeg':
     case 'audio/mp3':
-      return '.mp3';
+      return ['mp3', 8000];
     default:
-      return '.wav';
+      return ['wav', 8000];
   }
 };
 

lib/utils.js

@@ -6,7 +6,7 @@ const pool = new Pool('https://auth.crt.nuance.com');
 const NUANCE_AUTH_ENDPOINT = 'tts.api.nuance.com:443';
 const grpc = require('@grpc/grpc-js');
 const formurlencoded = require('form-urlencoded');
-const { JAMBONES_DISABLE_TTS_STREAMING, JAMBONES_TTS_TRIM_SILENCE, TMP_FOLDER, HTTP_TIMEOUT } = require('./config');
+const { TMP_FOLDER, HTTP_TIMEOUT } = require('./config');
 
 const debug = require('debug')('jambonz:realtimedb-helpers');
 /**
@@ -17,68 +17,26 @@ const debug = require('debug')('jambonz:realtimedb-helpers');
 //const nuanceClientMap = new Map();
 
 function makeSynthKey({
-  account_sid = '', vendor, language, voice, engine = '', text,
+  account_sid = '',
-  renderForCaching = false}) {
+  vendor,
+  language,
+  voice,
+  engine = '',
+  model = '',
+  text
+}) {
   const hash = crypto.createHash('sha1');
-  hash.update(`${language}:${vendor}:${voice}:${engine}:${text}`);
+  hash.update(`${language}:${vendor}:${voice}:${engine}:${model}:${text}`);
   const hexHashKey = hash.digest('hex');
   const accountKey = account_sid ? `:${account_sid}` : '';
-  const namespace = vendor.startsWith('custom') ? vendor : getFileExtension({vendor, voice, renderForCaching});
+  const key = `tts${accountKey}:${hexHashKey}`;
-  const key = `tts${accountKey}:${namespace}:${hexHashKey}`;
   return key;
 }
 
-function makeFilePath({vendor, voice, key, salt = '', renderForCaching = false}) {
+function makeFilePath({key, salt = '', extension}) {
-  const extension = getFileExtension({vendor, renderForCaching, voice});
   return `${TMP_FOLDER}/${key.replace('tts:', `tts-${salt}`)}.${extension}`;
 }
 
-function getFileExtension({vendor, voice, renderForCaching = false}) {
-  const mp3Extension = 'mp3';
-  const r8Extension = 'r8';
-  const wavExtension = 'wav';
-
-  switch (vendor) {
-    case 'azure':
-    case 'microsoft':
-      if (!renderForCaching && !JAMBONES_DISABLE_TTS_STREAMING || JAMBONES_TTS_TRIM_SILENCE) {
-        return r8Extension;
-      } else {
-        return mp3Extension;
-      }
-    case 'deepgram':
-    case 'elevenlabs':
-    case 'rimelabs':
-    case 'playht':
-    case 'cartesia':
-      if (renderForCaching || JAMBONES_DISABLE_TTS_STREAMING) {
-        return mp3Extension;
-      } else {
-        return r8Extension;
-      }
-    case 'nuance':
-    case 'nvidia':
-    case 'verbio':
-      return r8Extension;
-    case 'google':
-      // google voice cloning just support wav.
-      if (typeof voice === 'object' && voice.voice_cloning_key) {
-        return wavExtension;
-      } else {
-        return mp3Extension;
-      }
-    default:
-      // If vendor is custom
-      if (vendor.startsWith('custom')) {
-        if (renderForCaching || JAMBONES_DISABLE_TTS_STREAMING) {
-          return mp3Extension;
-        } else {
-          return r8Extension;
-        }
-      }
-      return mp3Extension;
-  }
-}
 
 const noopLogger = {
   info: () => {},

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jambonz/speech-utils",
-  "version": "0.1.24",
+  "version": "0.2.8",
   "description": "TTS-related speech utilities for jambonz",
   "main": "index.js",
   "author": "Dave Horton",
@@ -39,7 +39,7 @@
     "ibm-watson": "^8.0.0",
     "microsoft-cognitiveservices-speech-sdk": "1.38.0",
     "openai": "^4.25.0",
-    "undici": "^6.4.0"
+    "undici": "^7.5.0"
   },
   "devDependencies": {
     "config": "^3.3.11",

test/synth.js

@@ -5,7 +5,7 @@ const fs = require('fs');
 const {makeSynthKey} = require('../lib/utils');
 const logger = require('pino')();
 const bent = require('bent');
-const getJSON = bent('json')
+const getJSON = bent('json');
 
 process.on('unhandledRejection', (reason, p) => {
   console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
@@ -720,7 +720,7 @@ test('Cartesia speech synth tests', async(t) => {
   client.quit();
 });
 
-test('rimelabs speech synth tests', async(t) => {
+test('rimelabs speech synth tests mist', async(t) => {
   const fn = require('..');
   const {synthAudio, client} = fn(opts, logger);
 
@@ -730,7 +730,7 @@ test('rimelabs speech synth tests', async(t) => {
   }
   const text = 'Hi there and welcome to jambones!';
   try {
-    let opts = await synthAudio(stats, {
+    const opts = await synthAudio(stats, {
       vendor: 'rimelabs',
       credentials: {
         api_key: process.env.RIMELABS_API_KEY,
@@ -740,7 +740,7 @@ test('rimelabs speech synth tests', async(t) => {
           reduceLatency: false
         })
       },
-      language: 'en-US',
+      language: 'eng',
       voice: 'amber',
       text,
       renderForCaching: true
@@ -754,6 +754,40 @@ test('rimelabs speech synth tests', async(t) => {
   client.quit();
 });
 
+test('rimelabs speech synth tests mistv2', async(t) => {
+  const fn = require('..');
+  const {synthAudio, client} = fn(opts, logger);
+
+  if (!process.env.RIMELABS_API_KEY) {
+    t.pass('skipping rimelabs speech synth tests since RIMELABS_API_KEY is not provided');
+    return t.end();
+  }
+  const text = 'Hi there and welcome to jambones!';
+  try {
+    const opts = await synthAudio(stats, {
+      vendor: 'rimelabs',
+      credentials: {
+        api_key: process.env.RIMELABS_API_KEY,
+        model_id: 'mistv2',
+        options: JSON.stringify({
+          speedAlpha: 1.0,
+          reduceLatency: false
+        })
+      },
+      language: 'spa',
+      voice: 'pablo',
+      text,
+      renderForCaching: true
+    });
+    t.ok(!opts.servedFromCache, `successfully synthesized rimelabs mistv2 audio to ${opts.filePath}`);
+
+  } catch (err) {
+    console.error(JSON.stringify(err));
+    t.end(err);
+  }
+  client.quit();
+});
+
 test('whisper speech synth tests', async(t) => {
   const fn = require('..');
   const {synthAudio, client} = fn(opts, logger);
@@ -853,11 +887,11 @@ test('TTS Cache tests', async(t) => {
     // save some random tts keys to cache
     const minRecords = 8;
     for (const i in Array(minRecords).fill(0)) {
-      await client.set(makeSynthKey({vendor: i, language: i, voice: i, engine: i, text: i}), i);
+      await client.set(makeSynthKey({vendor: i, language: i, voice: i, engine: i, model: i, text: i}), i);
     }
     const count = await getTtsSize();
     t.ok(count >= minRecords, 'getTtsSize worked.');
-    
+
     const {purgedCount} = await purgeTtsCache();
     t.ok(purgedCount >= minRecords, `successfully purged at least ${minRecords} tts records from cache`);
 
@@ -888,24 +922,15 @@ test('TTS Cache tests', async(t) => {
       language: 'non-existing',
       voice: 'non-existing',
     });
-    t.ok(purgedCountWhenErrored === 0, `purged no records when specified key was not found`);
+    t.ok(purgedCountWhenErrored === 0, 'purged no records when specified key was not found');
-    t.ok(error, `error returned when specified key was not found`);
+    t.ok(error, 'error returned when specified key was not found');
 
     // make sure other tts keys are still there
-    const cached = await client.keys('tts:*')
+    const cached = await client.keys('tts:*');
-    t.ok(cached.length >= 1, `successfully kept all non-specified tts records in cache`);
+    t.ok(cached.length >= 1, 'successfully kept all non-specified tts records in cache');
 
-    // retrieve keys from cache and check the key contains the file extension    
+    process.env.VG_TRIM_TTS_SILENCE = 'true';
-    let key = cached[0];
-    t.ok(key.includes('mp3'), `tts cache extension shoult be part of the key and equal mp3`);
-
-    process.env.VG_TRIM_TTS_SILENCE = 'true';    
     await client.set(makeSynthKey({ vendor: 'azure' }), 'value');
-
-    const r8Keys = await client.keys('tts:r8*');
-    key = r8Keys[0];
-    t.ok(key.includes('r8'), `tts cache extension shoult be part of the key and equal r8`);
-
   } catch (err) {
     console.error(JSON.stringify(err));
     t.end(err);