0.0.19

.github/workflows/ci.yml

@@ -24,8 +24,4 @@ jobs:
           IBM_TTS_API_KEY: ${{ secrets.IBM_TTS_API_KEY }}
           IBM_TTS_REGION: ${{ secrets.IBM_TTS_REGION }}
           MICROSOFT_API_KEY: ${{ secrets.MICROSOFT_API_KEY }}
-          MICROSOFT_REGION: ${{ secrets.MICROSOFT_REGION }}
-          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
-          ELEVENLABS_API_KEY: ${{ secrets.ELEVENLABS_API_KEY }}
-          ELEVENLABS_VOICE_ID: ${{ secrets.ELEVENLABS_VOICE_ID }}
-          ELEVENLABS_MODEL_ID: ${{ secrets.ELEVENLABS_MODEL_ID }}
+          MICROSOFT_REGION: ${{ secrets.MICROSOFT_REGION }}

README.md

@@ -1,3 +1,2 @@
 # speech-utils
-TTS-related speech utilities for jambonz.
-
+TTS-related speech utilities for jambonz

index.js

@@ -1,14 +1,33 @@
 const {noopLogger} = require('./lib/utils');
+const Redis = require('ioredis');
 
 module.exports = (opts, logger) => {
   logger = logger || noopLogger;
-  let client = opts.redis_client;
-  const {
-    client: redisClient,
-    createHash,
-    retrieveHash
-  } = require('@jambonz/realtimedb-helpers')(opts, logger);
-  client = opts.redis_client || redisClient;
+  const connectionOpts = {...opts};
+  // Support legacy app
+  if (process.env.JAMBONES_REDIS_USERNAME && process.env.JAMBONES_REDIS_PASSWORD) {
+    if (Array.isArray(connectionOpts)) {
+      for (const o of opts) {
+        o.username = process.env.JAMBONES_REDIS_USERNAME;
+        o.password = process.env.JAMBONES_REDIS_PASSWORD;
+      }
+    } else {
+      connectionOpts.username = process.env.JAMBONES_REDIS_USERNAME;
+      connectionOpts.password = process.env.JAMBONES_REDIS_PASSWORD;
+    }
+  }
+
+  const client = new Redis(connectionOpts);
+  ['ready', 'connect', 'reconnecting', 'error', 'end', 'warning']
+    .forEach((event) => {
+      client.on(event, (...args) => {
+        if ('error' === event) {
+          if (process.env.NODE_ENV === 'test' && args[0]?.code === 'ECONNREFUSED') return;
+          logger.error({...args}, '@jambonz/realtimedb-helpers - redis error');
+        }
+        else logger.debug({args}, `redis event ${event}`);
+      });
+    });
 
   return {
     client,
@@ -17,7 +36,6 @@ module.exports = (opts, 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),
-    getAwsAuthToken: require('./lib/get-aws-sts-token').bind(null, logger, createHash, retrieveHash),
     getTtsVoices: require('./lib/get-tts-voices').bind(null, client, logger),
   };
 };

lib/get-aws-sts-token.js

@@ -1,44 +0,0 @@
-const { STSClient, GetSessionTokenCommand } = require('@aws-sdk/client-sts');
-const {makeAwsKey, noopLogger} = require('./utils');
-const debug = require('debug')('jambonz:speech-utils');
-const EXPIRY = 3600;
-
-async function getAwsAuthToken(
-  logger,
-  createHash, retrieveHash,
-  awsAccessKeyId, awsSecretAccessKey, awsRegion) {
-  logger = logger || noopLogger;
-  try {
-    const key = makeAwsKey(awsAccessKeyId);
-    const obj = await retrieveHash(key);
-    if (obj) return {...obj, servedFromCache: true};
-
-    /* access token not found in cache, so generate it using STS */
-    const stsClient = new STSClient({ region: awsRegion });
-    const params = {
-      accessKeyId: awsAccessKeyId,
-      secretAccessKey: awsSecretAccessKey,
-      DurationSeconds: EXPIRY
-    };
-    const command = new GetSessionTokenCommand(params);
-    const data = await stsClient.send(command);
-
-    const credentials = {
-      accessKeyId: data.Credentials.AccessKeyId,
-      secretAccessKey: data.Credentials.SecretAccessKey,
-      sessionToken: data.Credentials.SessionToken
-    };
-
-    /* expire 10 minutes before the hour, so we don't lose the use of it during a call */
-    createHash(key, credentials, EXPIRY - 600)
-      .catch((err) => logger.error(err, `Error saving hash for key ${key}`));
-
-    return {...credentials, servedFromCache: false};
-  } catch (err) {
-    debug(err, 'getAwsAuthToken: Error retrieving AWS auth token');
-    logger.error(err, 'getAwsAuthToken: Error retrieving AWS auth token');
-    throw err;
-  }
-}
-
-module.exports = getAwsAuthToken;

lib/synth-audio.js

@@ -14,13 +14,7 @@ const {
   CancellationDetails,
   SpeechSynthesisOutputFormat
 } = sdk;
-const {
-  makeSynthKey,
-  createNuanceClient,
-  createKryptonClient,
-  createRivaClient,
-  noopLogger
-} = require('./utils');
+const {makeSynthKey, createNuanceClient, createKryptonClient, createRivaClient, noopLogger} = require('./utils');
 const getNuanceAccessToken = require('./get-nuance-access-token');
 const {
   SynthesisRequest,
@@ -38,7 +32,6 @@ const {AudioEncoding} = require('../stubs/riva/proto/riva_audio_pb');
 const debug = require('debug')('jambonz:realtimedb-helpers');
 const EXPIRES = (process.env.JAMBONES_TTS_CACHE_DURATION_MINS || 4 * 60) * 60; // cache tts for 4 hours
 const TMP_FOLDER = '/tmp';
-const OpenAI = require('openai');
 
 
 const trimTrailingSilence = (buffer) => {
@@ -83,8 +76,7 @@ async function synthAudio(client, logger, stats, { account_sid,
   let rtt;
   logger = logger || noopLogger;
 
-  assert.ok(['google', 'aws', 'polly', 'microsoft',
-    'wellsaid', 'nuance', 'nvidia', 'ibm', 'elevenlabs', 'whisper'].includes(vendor) ||
+  assert.ok(['google', 'aws', 'polly', 'microsoft', 'wellsaid', 'nuance', 'nvidia', 'ibm'].includes(vendor) ||
   vendor.startsWith('custom'),
   `synthAudio supported vendors are google, aws, microsoft, nuance, nvidia and wellsaid, not ${vendor}`);
   if ('google' === vendor) {
@@ -118,14 +110,6 @@ async function synthAudio(client, logger, stats, { account_sid,
     language = 'en-US'; // WellSaid only supports English atm
     assert.ok(voice, 'synthAudio requires voice when wellsaid is used');
     assert.ok(!text.startsWith('<speak'), 'wellsaid does not support SSML tags');
-  } else if ('elevenlabs' === vendor) {
-    assert.ok(voice, 'synthAudio requires voice when elevenlabs is used');
-    assert.ok(credentials.api_key, 'synthAudio requires api_key when elevenlabs is used');
-    assert.ok(credentials.model_id, 'synthAudio requires model_id when elevenlabs is used');
-  } else if ('whisper' === vendor) {
-    assert.ok(voice, 'synthAudio requires voice when whisper is used');
-    assert.ok(credentials.model_id, 'synthAudio requires model when whisper is used');
-    assert.ok(credentials.api_key, 'synthAudio requires api_key when whisper is used');
   } else  if (vendor.startsWith('custom')) {
     assert.ok(credentials.custom_tts_url, `synthAudio requires custom_tts_url in credentials when ${vendor} is used`);
   }
@@ -193,12 +177,6 @@ async function synthAudio(client, logger, stats, { account_sid,
       case 'wellsaid':
         audioBuffer = await synthWellSaid(logger, {credentials, stats, language, voice, text, filePath});
         break;
-      case 'elevenlabs':
-        audioBuffer = await synthElevenlabs(logger, {credentials, stats, language, voice, text, filePath});
-        break;
-      case 'whisper':
-        audioBuffer = await synthWhisper(logger, {credentials, stats, voice, text});
-        break;
       case vendor.startsWith('custom') ? vendor : 'cant_match_value':
         ({ audioBuffer, filePath } = await synthCustomVendor(logger,
           {credentials, stats, language, voice, text, filePath}));
@@ -269,8 +247,7 @@ const synthGoogle = async(logger, {credentials, stats, language, voice, gender,
   const client = new ttsGoogle.TextToSpeechClient(credentials);
   const opts = {
     voice: {
-      ...(typeof voice === 'string' && {name: voice}),
-      ...(typeof voice === 'object' && {customVoice: voice}),
+      name: voice,
       languageCode: language,
       ssmlGender: gender || 'SSML_VOICE_GENDER_UNSPECIFIED'
     },
@@ -320,48 +297,6 @@ const synthIbm = async(logger, {credentials, stats, voice, text}) => {
   }
 };
 
-async function _synthOnPremMicrosoft(logger, {
-  credentials,
-  stats,
-  language,
-  voice,
-  text,
-  filePath
-}) {
-  const {use_custom_tts, custom_tts_endpoint_url} = credentials;
-  let content = text;
-
-  if (use_custom_tts && !content.startsWith('<speak')) {
-    /**
-     * Note: it seems that to use custom voice ssml is required with the voice attribute
-     * Otherwise sending plain text we get "Voice does not match"
-     */
-    content = `<speak>${text}</speak>`;
-  }
-
-  if (content.startsWith('<speak>')) {
-    /* microsoft enforces some properties and uses voice xml element so if the user did not supply do it for them */
-    const words = content.slice(7, -8).trim().replace(/(\r\n|\n|\r)/gm, ' ');
-    // eslint-disable-next-line max-len
-    content = `<speak version="1.0" xmlns="http://www.w3.org/2001/10/synthesis" xmlns:mstts="https://www.w3.org/2001/mstts" xml:lang="${language}"><voice name="${voice}">${words}</voice></speak>`;
-    logger.info({content}, 'synthMicrosoft');
-  }
-
-  try {
-    const trimSilence = filePath.endsWith('.r8');
-    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'
-    });
-    const mp3 = await post(custom_tts_endpoint_url, content);
-    return mp3;
-  } catch (err) {
-    logger.info({err}, '_synthMicrosoftByHttp returned error');
-    throw err;
-  }
-}
-
 const synthMicrosoft = async(logger, {
   credentials,
   stats,
@@ -371,17 +306,7 @@ const synthMicrosoft = async(logger, {
   filePath
 }) => {
   try {
-    const {api_key: apiKey, region, use_custom_tts, custom_tts_endpoint, custom_tts_endpoint_url} = credentials;
-    if (use_custom_tts && custom_tts_endpoint_url) {
-      return await _synthOnPremMicrosoft(logger, {
-        credentials,
-        stats,
-        language,
-        voice,
-        text,
-        filePath
-      });
-    }
+    const {api_key: apiKey, region, use_custom_tts, custom_tts_endpoint} = credentials;
     const trimSilence = filePath.endsWith('.r8');
     let content = text;
     const speechConfig = SpeechConfig.fromSubscription(apiKey, region);
@@ -389,13 +314,12 @@ const synthMicrosoft = async(logger, {
     speechConfig.speechSynthesisVoiceName = voice;
     if (use_custom_tts && custom_tts_endpoint) {
       speechConfig.endpointId = custom_tts_endpoint;
-    }
-    if (use_custom_tts && !content.startsWith('<speak')) {
+
       /**
        * Note: it seems that to use custom voice ssml is required with the voice attribute
        * Otherwise sending plain text we get "Voice does not match"
        */
-      content = `<speak>${text}</speak>`;
+      if (!content.startsWith('<speak')) content = `<speak>${text}</speak>`;
     }
     speechConfig.speechSynthesisOutputFormat = trimSilence ?
       SpeechSynthesisOutputFormat.Raw8Khz16BitMonoPcm :
@@ -585,53 +509,6 @@ const synthCustomVendor = async(logger, {credentials, stats, language, voice, te
   }
 };
 
-const synthElevenlabs = async(logger, {credentials, stats, language, voice, text}) => {
-  const {api_key, model_id} = credentials;
-  try {
-    const post = bent('https://api.elevenlabs.io', 'POST', 'buffer', {
-      'xi-api-key': api_key,
-      'Accept': 'audio/mpeg',
-      'Content-Type': 'application/json'
-    });
-    const mp3 = await post(`/v1/text-to-speech/${voice}`, {
-      text,
-      model_id,
-      voice_settings: {
-        stability: 0.5,
-        similarity_boost: 0.5
-      }
-    });
-    return mp3;
-  } catch (err) {
-    logger.info({err}, 'synth Elevenlabs returned error');
-    stats.increment('tts.count', ['vendor:elevenlabs', 'accepted:no']);
-    throw err;
-  }
-};
-
-const synthWhisper = async(logger, {credentials, stats, voice, text}) => {
-  const {api_key, model_id, baseURL, timeout} = credentials;
-  try {
-    const openai = new OpenAI.OpenAI({
-      apiKey: api_key,
-      timeout: timeout || 5000,
-      ...(baseURL && {baseURL})
-    });
-
-    const mp3 = await openai.audio.speech.create({
-      model: model_id,
-      voice,
-      input: text,
-      response_format: 'mp3'
-    });
-    return Buffer.from(await mp3.arrayBuffer());
-  } catch (err) {
-    logger.info({err}, 'synth whisper returned error');
-    stats.increment('tts.count', ['vendor:openai', 'accepted:no']);
-    throw err;
-  }
-}
-;
 const getFileExtFromMime = (mime) => {
   switch (mime) {
     case 'audio/wav':

lib/utils.js

@@ -43,12 +43,6 @@ function makeIbmKey(apiKey) {
   return `ibm:${hash.digest('hex')}`;
 }
 
-function makeAwsKey(awsAccessKeyId) {
-  const hash = crypto.createHash('sha1');
-  hash.update(awsAccessKeyId);
-  return `aws:${hash.digest('hex')}`;
-}
-
 function makeNuanceKey(clientId, secret, scope) {
   const hash = crypto.createHash('sha1');
   hash.update(`${clientId}:${secret}:${scope}`);
@@ -112,11 +106,11 @@ const createRivaClient = async(rivaUri) => {
   return client;
 };
 
+
 module.exports = {
   makeSynthKey,
   makeNuanceKey,
   makeIbmKey,
-  makeAwsKey,
   getNuanceAccessToken,
   createNuanceClient,
   createKryptonClient,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jambonz/speech-utils",
-  "version": "0.0.27",
+  "version": "0.0.19",
   "description": "TTS-related speech utilities for jambonz",
   "main": "index.js",
   "author": "Dave Horton",
@@ -25,17 +25,15 @@
   "homepage": "https://github.com/jambonz/speech-utils#readme",
   "dependencies": {
     "@aws-sdk/client-polly": "^3.359.0",
-    "@aws-sdk/client-sts": "^3.458.0",
     "@google-cloud/text-to-speech": "^4.2.1",
     "@grpc/grpc-js": "^1.8.13",
-    "@jambonz/realtimedb-helpers": "^0.8.7",
     "bent": "^7.3.12",
     "debug": "^4.3.4",
     "form-urlencoded": "^6.1.0",
     "google-protobuf": "^3.21.2",
     "ibm-watson": "^8.0.0",
-    "microsoft-cognitiveservices-speech-sdk": "1.32.0",
-    "openai": "^4.16.2",
+    "microsoft-cognitiveservices-speech-sdk": "^1.26.0",
+    "ioredis": "^5.3.2",
     "undici": "^5.21.0"
   },
   "devDependencies": {

test/aws.js

@@ -1,40 +0,0 @@
-const test = require('tape').test ;
-const config = require('config');
-const opts = config.get('redis');
-const logger = require('pino')({level: 'error'});
-process.on('unhandledRejection', (reason, p) => {
-  console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
-});
-
-const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
-
-test('AWS - create and cache auth token', async(t) => {
-  const fn = require('..');
-  const {client, getAwsAuthToken} = fn(opts, logger);
-
-  if (!process.env.AWS_ACCESS_KEY_ID || !process.env.AWS_SECRET_ACCESS_KEY || !process.env.AWS_REGION) {
-      t.pass('skipping AWS auth token tests since no AWS credentials provided');
-      t.end();
-      client.quit();
-      return;
-  }
-  try {
-    let obj = await getAwsAuthToken(process.env.AWS_ACCESS_KEY_ID, process.env.AWS_SECRET_ACCESS_KEY, process.env.AWS_REGION);
-    //console.log({obj}, 'received auth token from AWS');
-    t.ok(obj.sessionToken && !obj.servedFromCache, 'successfullY generated auth token from AWS');
-
-    await sleep(250);
-    obj = await getAwsAuthToken(process.env.AWS_ACCESS_KEY_ID, process.env.AWS_SECRET_ACCESS_KEY, process.env.AWS_REGION);
-    //console.log({obj}, 'received auth token from AWS - second request');
-    t.ok(obj.sessionToken && obj.servedFromCache, 'successfully received access token from cache');
- 
-    await client.flushall();
-    t.end();
-  }
-  catch (err) {
-    console.error(err);
-    t.end(err);
-  }
-  client.quit();
-});
-

test/index.js

@@ -1,7 +1,4 @@
 require('./docker_start');
 require('./synth');
 require('./list-voices');
-require('./aws');
-require('./ibm');
-require('./nuance');
 require('./docker_stop');

test/synth.js

@@ -38,7 +38,7 @@ test('Google speech synth tests', async(t) => {
         },
       },
       language: 'en-GB',
-      gender: 'FEMALE',
+      gender: 'MALE',
       text: 'This is a test.  This is only a test',
       salt: 'foo.bar',
     });
@@ -53,7 +53,7 @@ test('Google speech synth tests', async(t) => {
         },
       },
       language: 'en-GB',
-      gender: 'FEMALE',
+      gender: 'MALE',
       text: 'This is a test.  This is only a test',
     });
     t.ok(opts.servedFromCache, `successfully retrieved cached google audio from ${opts.filePath}`);
@@ -68,7 +68,7 @@ test('Google speech synth tests', async(t) => {
       },
       disableTtsCache: true,
       language: 'en-GB',
-      gender: 'FEMALE',
+      gender: 'MALE',
       text: 'This is a test.  This is only a test',
     });
     t.ok(!opts.servedFromCache, `successfully synthesized google audio regardless of current cache to ${opts.filePath}`);
@@ -79,40 +79,6 @@ test('Google speech synth tests', async(t) => {
   client.quit();
 });
 
-test('Google speech Custom voice synth tests', async(t) => {
-  const fn = require('..');
-  const {synthAudio, client} = fn(opts, logger);
-
-  if (!process.env.GCP_CUSTOM_VOICE_FILE && !process.env.GCP_CUSTOM_VOICE_JSON_KEY || !process.env.GCP_CUSTOM_VOICE_MODEL) {
-    t.pass('skipping google speech synth tests since neither GCP_CUSTOM_VOICE_FILE nor GCP_CUSTOM_VOICE_JSON_KEY provided, GCP_CUSTOM_VOICE_MODEL is not provided');
-    return t.end();
-  }
-  try {
-    const str = process.env.GCP_CUSTOM_VOICE_JSON_KEY || fs.readFileSync(process.env.GCP_CUSTOM_VOICE_FILE);
-    const creds = JSON.parse(str);
-    let opts = await synthAudio(stats, {
-      vendor: 'google',
-      credentials: {
-        credentials: {
-          client_email: creds.client_email,
-          private_key: creds.private_key,
-        },
-      },
-      language: 'en-AU',
-      text: 'This is a test.  This is only a test',
-      voice: {
-        reportedUsage:"REALTIME",
-        model: process.env.GCP_CUSTOM_VOICE_MODEL
-      }
-    });
-    t.ok(!opts.servedFromCache, `successfully synthesized google custom voice audio to ${opts.filePath}`);
-  } catch (err) {
-    console.error(err);
-    t.end(err);
-  }
-  client.quit();
-});
-
 test('AWS speech synth tests', async(t) => {
   const fn = require('..');
   const {synthAudio, client} = fn(opts, logger);
@@ -445,64 +411,6 @@ test('Custom Vendor speech synth tests', async(t) => {
   client.quit();
 });
 
-test('Elevenlabs speech synth tests', async(t) => {
-  const fn = require('..');
-  const {synthAudio, client} = fn(opts, logger);
-
-  if (!process.env.ELEVENLABS_API_KEY || !process.env.ELEVENLABS_VOICE_ID || !process.env.ELEVENLABS_MODEL_ID) {
-    t.pass('skipping ElevenLabs speech synth tests since ELEVENLABS_API_KEY or ELEVENLABS_VOICE_ID or ELEVENLABS_MODEL_ID not provided');
-    return t.end();
-  }
-  const text = 'Hi there and welcome to jambones!';
-  try {
-    let opts = await synthAudio(stats, {
-      vendor: 'elevenlabs',
-      credentials: {
-        api_key: process.env.ELEVENLABS_API_KEY,
-        model_id: process.env.ELEVENLABS_MODEL_ID
-      },
-      language: 'en-US',
-      voice: process.env.ELEVENLABS_VOICE_ID,
-      text,
-    });
-    t.ok(!opts.servedFromCache, `successfully synthesized eleven 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);
-
-  if (!process.env.OPENAI_API_KEY) {
-    t.pass('skipping OPENAI speech synth tests since OPENAI_API_KEY not provided');
-    return t.end();
-  }
-  const text = 'Hi there and welcome to jambones!';
-  try {
-    let opts = await synthAudio(stats, {
-      vendor: 'whisper',
-      credentials: {
-        api_key: process.env.OPENAI_API_KEY,
-        model_id: 'tts-1'
-      },
-      language: 'en-US',
-      voice: 'alloy',
-      text,
-    });
-    t.ok(!opts.servedFromCache, `successfully synthesized whisper audio to ${opts.filePath}`);
-
-  } catch (err) {
-    console.error(JSON.stringify(err));
-    t.end(err);
-  }
-  client.quit();
-})
-
 test('TTS Cache tests', async(t) => {
   const fn = require('..');
   const {purgeTtsCache, getTtsSize, client} = fn(opts, logger);