0.0.42

support whisper streaming

index.js

@@ -12,6 +12,7 @@ module.exports = (opts, logger) => {
     client,
     getTtsSize: require('./lib/get-tts-size').bind(null, client, logger),
     purgeTtsCache: require('./lib/purge-tts-cache').bind(null, client, logger),
+    addFileToCache: require('./lib/add-file-to-cache').bind(null, client, logger),
     synthAudio: require('./lib/synth-audio').bind(null, client, logger),
     getNuanceAccessToken: require('./lib/get-nuance-access-token').bind(null, client, logger),
     getIbmAccessToken: require('./lib/get-ibm-access-token').bind(null, client, logger),

lib/add-file-to-cache.js

@@ -0,0 +1,30 @@
+const fs = require('fs/promises');
+const {noopLogger, makeSynthKey} = require('./utils');
+const EXPIRES = (process.env.JAMBONES_TTS_CACHE_DURATION_MINS || 4 * 60) * 60; // cache tts for 4 hours
+
+async function addFileToCache(client, logger, path,
+  {account_sid, vendor, language, voice, deploymentId, engine, text}) {
+  let key;
+  logger = logger || noopLogger;
+
+  try {
+    key = makeSynthKey({
+      account_sid,
+      vendor,
+      language: language || '',
+      voice: voice || deploymentId,
+      engine,
+      text,
+    });
+    const audioBuffer = await fs.readFile(path);
+    await client.setex(key, EXPIRES, audioBuffer.toString('base64'));
+  } catch (err) {
+    logger.error(err, 'addFileToCache: Error');
+    return;
+  }
+
+  logger.debug(`addFileToCache: added ${path} to cache with key ${key}`);
+  return key;
+}
+
+module.exports = addFileToCache;

lib/synth-audio.js

@@ -143,6 +143,10 @@ async function synthAudio(client, logger, stats, { account_sid,
     (
       process.env.JAMBONES_TTS_TRIM_SILENCE &&
       ['microsoft', 'azure'].includes(vendor)
+    ) ||
+    (
+      !process.env.JAMBONES_DISABLE_TTS_STREAMING &&
+      vendor === 'elevenlabs'
     )
   ) {
     filePath = `${TMP_FOLDER}/${key.replace('tts:', `tts-${salt || ''}`)}.r8`;
@@ -206,6 +210,10 @@ async function synthAudio(client, logger, stats, { account_sid,
         }
         break;
       case 'whisper':
+        audioBuffer = await synthWhisper(logger, {credentials, stats, voice, text, renderForCaching});
+        if (typeof audioBuffer === 'object' && audioBuffer.filePath) {
+          return audioBuffer;
+        }
         audioBuffer = await synthWhisper(logger, {credentials, stats, voice, text});
         break;
       case 'deepgram':
@@ -607,12 +615,13 @@ const synthElevenlabs = async(logger, {credentials, options, stats, language, vo
   const {api_key, model_id, options: credOpts} = credentials;
   const opts = !!options && Object.keys(options).length !== 0 ? options : JSON.parse(credOpts || '{}');
 
-  /* if the env is set to stream then bag out, unless we are specifically rendering to generate a cache file */
-  if (process.env.JAMBONES_ELEVENLABS_STREAMING && !renderForCaching) {
+  /* default to using the streaming interface, unless disabled by env var OR we want just a cache file */
+  if (!process.env.JAMBONES_DISABLE_TTS_STREAMING && !renderForCaching) {
     let params = '';
     params += `{api_key=${api_key}`;
     params += `,model_id=${model_id}`;
     params += `,optimize_streaming_latency=${opts.optimize_streaming_latency || 2}`;
+    params += ',write_cache_file=1';
     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}`;
@@ -620,7 +629,7 @@ const synthElevenlabs = async(logger, {credentials, options, stats, language, vo
     params += '}';
 
     return {
-      filePath: `say:${params}${text.replace(/\n/g, ' ')}`,
+      filePath: `say:${params}${text.replace(/\n/g, ' ').replace(/\r/g, ' ')}`,
       servedFromCache: false,
       rtt: 0
     };
@@ -651,8 +660,24 @@ const synthElevenlabs = async(logger, {credentials, options, stats, language, vo
   }
 };
 
-const synthWhisper = async(logger, {credentials, stats, voice, text}) => {
-  const {api_key, model_id, baseURL, timeout} = credentials;
+const synthWhisper = async(logger, {credentials, stats, voice, text, renderForCaching}) => {
+  const {api_key, model_id, baseURL, timeout, speed} = credentials;
+  /* if the env is set to stream then bag out, unless we are specifically rendering to generate a cache file */
+  if (!process.env.JAMBONES_DISABLE_TTS_STREAMING && !renderForCaching) {
+    let params = '';
+    params += `{api_key=${api_key}`;
+    params += `,model_id=${model_id}`;
+    params += `,voice=${voice}`;
+    params += ',write_cache_file=1';
+    if (speed) params += `,speed=${speed}`;
+    params += '}';
+
+    return {
+      filePath: `say:${params}${text.replace(/\n/g, ' ')}`,
+      servedFromCache: false,
+      rtt: 0
+    };
+  }
   try {
     const openai = new OpenAI.OpenAI({
       apiKey: api_key,

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@jambonz/speech-utils",
-  "version": "0.0.35",
+  "version": "0.0.42",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@jambonz/speech-utils",
-      "version": "0.0.35",
+      "version": "0.0.42",
       "license": "MIT",
       "dependencies": {
         "@aws-sdk/client-polly": "^3.496.0",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jambonz/speech-utils",
-  "version": "0.0.35",
+  "version": "0.0.42",
   "description": "TTS-related speech utilities for jambonz",
   "main": "index.js",
   "author": "Dave Horton",

test/synth.js

@@ -20,7 +20,7 @@ const stats = {
 
 test('Google speech synth tests', async(t) => {
   const fn = require('..');
-  const {synthAudio, client} = fn(opts, logger);
+  const {synthAudio, addFileToCache, client} = fn(opts, logger);
 
   if (!process.env.GCP_FILE && !process.env.GCP_JSON_KEY) {
     t.pass('skipping google speech synth tests since neither GCP_FILE nor GCP_JSON_KEY provided');
@@ -58,6 +58,14 @@ test('Google speech synth tests', async(t) => {
     });
     t.ok(opts.servedFromCache, `successfully retrieved cached google audio from ${opts.filePath}`);
 
+    const success = await addFileToCache(opts.filePath, {
+      vendor: 'google',
+      language: 'en-GB',
+      gender: 'FEMALE',
+      text: 'This is a test.  This is only a test'
+    });
+    t.ok(success, `successfully added ${opts.filePath} to cache`);
+
     opts = await synthAudio(stats, {
       vendor: 'google',
       credentials: {