Compare commits

...
Author SHA1 Message Date
Dave Horton 4cfa286242 1.0.8 2026-07-05 17:42:09 -04:00
Hoan Luu Huu 42ac63adc6 support xaiTTS (#147) 2026-07-05 17:41:36 -04:00
Dave Horton 12a121672d 1.0.7 2026-07-03 07:12:20 -04:00
Hoan Luu HuuandClaude Opus 4.8 7b94a5a969 feat(murf): add Murf.ai TTS support to synthAudio (#146)
* feat(murf): add Murf.ai TTS support to synthAudio

Add synthMurf() following the rimelabs/cartesia pattern:
- streaming path returns a say:{vendor=murf,...} filePath consumed by the
  FreeSWITCH mod_murf_tts module
- non-streaming path calls POST /v1/speech/stream (api-key header) and returns
  WAV audio for cache rendering

Register murf in the supported-vendor assert list and the synth switch.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(murf): drop Accept: audio/basic header (caused 406 Not Acceptable)

Murf's /v1/speech/stream rejects an unmatched Accept header with 406; the
response container is chosen by the `format` body field instead. Verified a
WAV request now returns 200 (valid RIFF/WAVE).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-03 07:11:39 -04:00
4 changed files with 186 additions and 4 deletions
+148 -1
View File
@@ -80,7 +80,7 @@ async function synthAudio(client, createHash, retrieveHash, logger, stats, { acc
logger = logger || noopLogger;
assert.ok(['google', 'aws', 'polly', 'microsoft', 'wellsaid', 'nvidia', 'elevenlabs',
'whisper', 'deepgram', 'rimelabs', 'cartesia', 'inworld', 'resemble'].includes(vendor) ||
'whisper', 'deepgram', 'rimelabs', 'cartesia', 'inworld', 'resemble', 'murf', 'xai'].includes(vendor) ||
vendor.startsWith('custom'),
`synthAudio supported vendors are google, aws, microsoft, nvidia and wellsaid ..etc, not ${vendor}`);
if ('google' === vendor) {
@@ -124,9 +124,14 @@ async function synthAudio(client, createHash, retrieveHash, logger, stats, { acc
if (!credentials.deepgram_tts_uri) {
assert.ok(credentials.api_key, 'synthAudio requires api_key when deepgram is used');
}
} else if ('xai' === vendor) {
assert.ok(credentials.api_key, 'synthAudio requires api_key when xai is used');
} else if ('cartesia' === vendor) {
assert.ok(credentials.api_key, 'synthAudio requires api_key when cartesia is used');
assert.ok(credentials.model_id, 'synthAudio requires model_id when cartesia is used');
} else if ('murf' === vendor) {
assert.ok(voice, 'synthAudio requires voice when murf is used');
assert.ok(credentials.api_key, 'synthAudio requires api_key when murf is used');
} else if (vendor === 'resemble') {
assert.ok(voice, 'synthAudio requires voice when resemble is used');
assert.ok(credentials.api_key, 'synthAudio requires api_key when resemble is used');
@@ -211,6 +216,11 @@ async function synthAudio(client, createHash, retrieveHash, logger, stats, { acc
credentials, options, stats, language, voice, key, text, renderForCaching, disableTtsStreaming,
disableTtsCache});
break;
case 'murf':
audioData = await synthMurf(logger, {
credentials, options, stats, language, voice, key, text, renderForCaching, disableTtsStreaming,
disableTtsCache});
break;
case 'whisper':
audioData = await synthWhisper(logger, {
credentials, stats, voice, key, text, instructions, renderForCaching, disableTtsStreaming,
@@ -220,6 +230,11 @@ async function synthAudio(client, createHash, retrieveHash, logger, stats, { acc
audioData = await synthDeepgram(logger, {credentials, stats, model, key, text,
renderForCaching, disableTtsStreaming, disableTtsCache});
break;
case 'xai':
audioData = await synthXai(logger, {
credentials, options, stats, language, voice, key, text, renderForCaching, disableTtsStreaming,
disableTtsCache});
break;
case 'resemble':
audioData = await synthResemble(logger, {
credentials, stats, voice, key, text, options, renderForCaching, disableTtsStreaming, disableTtsCache});
@@ -969,6 +984,72 @@ const synthRimelabs = async(logger, {
throw err;
}
};
const synthMurf = async(logger, {
credentials, options, stats, language, voice, key, text, renderForCaching, disableTtsStreaming, disableTtsCache
}) => {
const {api_key, model_id, api_uri, options: credOpts} = credentials;
const opts = !!options && Object.keys(options).length !== 0 ? options : JSON.parse(credOpts || '{}');
/* default to using the streaming interface, unless disabled by env var OR we want just a cache file */
if (!JAMBONES_DISABLE_TTS_STREAMING && !renderForCaching && !disableTtsStreaming) {
/* param keys here must match mod_murf_tts's text_param handler */
let params = '{';
params += `api_key=${api_key}`;
params += `,playback_id=${key}`;
params += ',vendor=murf';
params += `,voice=${voice}`;
if (model_id) params += `,model_id=${model_id}`;
if (language) params += `,language=${language}`;
if (api_uri) params += `,api_uri=${api_uri}`;
if (opts.style) params += `,style=${opts.style}`;
if (opts.rate !== undefined && opts.rate !== null) params += `,rate=${opts.rate}`;
if (opts.pitch !== undefined && opts.pitch !== null) params += `,pitch=${opts.pitch}`;
if (opts.variation !== undefined && opts.variation !== null) params += `,variation=${opts.variation}`;
params += `,write_cache_file=${disableTtsCache ? 0 : 1}`;
params += '}';
return {
filePath: `say:${params}${text.replace(/\n/g, ' ').replace(/\r/g, ' ')}`,
servedFromCache: false,
rtt: 0
};
}
try {
const sampleRate = 8000;
/* no Accept header: murf returns 406 if it doesn't match; the response
container is selected by the `format` field in the body instead */
const post = bent(api_uri || 'https://global.api.murf.ai', 'POST', 'buffer', {
'api-key': api_key,
'Content-Type': 'application/json'
});
/* murf REST schema is documented loosely; field names follow the SDK params
(voice_id/model/format/sample_rate) plus the websocket voice fields. */
const audioContent = await post('/v1/speech/stream', {
text,
voice_id: voice,
...(model_id && {model: model_id}),
...(language && {locale: language}),
...(opts.style && {style: opts.style}),
...(opts.rate !== undefined && opts.rate !== null && {rate: opts.rate}),
...(opts.pitch !== undefined && opts.pitch !== null && {pitch: opts.pitch}),
...(opts.variation !== undefined && opts.variation !== null && {variation: opts.variation}),
format: 'WAV',
sample_rate: sampleRate,
channel_type: 'MONO'
});
return {
audioContent,
extension: 'wav',
sampleRate
};
} catch (err) {
logger.info({err}, 'synth murf returned error');
stats.increment('tts.count', ['vendor:murf', 'accepted:no']);
throw err;
}
};
const synthWhisper = async(logger, {credentials, stats, voice, key, text, instructions,
renderForCaching, disableTtsStreaming, disableTtsCache}) => {
const {api_key, model_id, baseURL, timeout, speed} = credentials;
@@ -1059,6 +1140,72 @@ const synthDeepgram = async(logger, {credentials, stats, model, key, text, rende
}
};
const synthXai = async(logger, {
credentials, options, stats, language, voice, key, text, renderForCaching, disableTtsStreaming, disableTtsCache
}) => {
const {api_key, api_uri, options: credOpts} = credentials;
const opts = !!options && Object.keys(options).length !== 0 ? options : JSON.parse(credOpts || '{}');
const speed = opts.speed;
if (!JAMBONES_DISABLE_TTS_STREAMING && !renderForCaching && !disableTtsStreaming) {
let params = '{';
params += `api_key=${api_key}`;
params += `,playback_id=${key}`;
params += ',vendor=xai';
if (voice) params += `,voice=${voice}`;
if (language) params += `,language=${language}`;
if (speed !== null && speed !== undefined) params += `,speed=${speed}`;
if (opts.optimize_streaming_latency != null) {
params += `,optimize_streaming_latency=${opts.optimize_streaming_latency}`;
}
if (opts.text_normalization != null) params += `,text_normalization=${opts.text_normalization}`;
params += `,write_cache_file=${disableTtsCache ? 0 : 1}`;
if (api_uri) params += `,endpoint=${api_uri}`;
params += '}';
return {
filePath: `say:${params}${text.replace(/\n/g, ' ').replace(/\r/g, ' ')}`,
servedFromCache: false,
rtt: 0
};
}
try {
const post = bent(`https://${api_uri || 'api.x.ai'}`, 'POST', 'buffer', {
'Authorization': `Bearer ${api_key}`,
'Content-Type': 'application/json'
});
const audioContent = await post('/v1/tts', {
text,
language: language || 'auto',
...(voice && {voice_id: voice}),
...(speed !== null && speed !== undefined && {speed}),
...(opts.optimize_streaming_latency != null && {optimize_streaming_latency: opts.optimize_streaming_latency}),
...(opts.text_normalization != null && {text_normalization: opts.text_normalization}),
output_format: {
codec: 'wav',
sample_rate: 8000
}
});
return {
audioContent,
extension: 'wav',
sampleRate: 8000
};
} catch (err) {
// xAI errors are JSON {code, error} - read the body so the surfaced message isn't 'undefined'
if (err.name === 'StatusError' && typeof err.text === 'function') {
try {
const body = await err.text();
if (body) err.message = body;
} catch (readErr) {
logger.info({readErr}, 'synth xai: failed to read error response body');
}
}
logger.info({err}, 'synth xai returned error');
stats.increment('tts.count', ['vendor:xai', 'accepted:no']);
throw err;
}
};
const synthCartesia = async(logger, {
credentials, options, stats, voice, language, key, text, renderForCaching, disableTtsStreaming, disableTtsCache
}) => {
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "@jambonz/speech-utils",
"version": "1.0.6",
"version": "1.0.8",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "@jambonz/speech-utils",
"version": "1.0.6",
"version": "1.0.8",
"license": "MIT",
"dependencies": {
"23": "^0.0.0",
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@jambonz/speech-utils",
"version": "1.0.6",
"version": "1.0.8",
"description": "TTS-related speech utilities for jambonz",
"main": "index.js",
"author": "Dave Horton",
+35
View File
@@ -1118,6 +1118,41 @@ test('Deepgram speech synth tests', async(t) => {
client.quit();
})
test('xai speech synth tests', async(t) => {
const fn = require('..');
const {synthAudio, client} = fn(opts, logger);
if (!process.env.XAI_API_KEY) {
t.pass('skipping xai speech synth tests - no XAI_API_KEY');
return t.end();
}
const text = 'Hi there and welcome to jambones!';
try {
const opts = await synthAudio(stats, {
vendor: 'xai',
credentials: {
api_key: process.env.XAI_API_KEY,
options: JSON.stringify({
voice: process.env.XAI_VOICE || 'eve',
speed: 1.0,
optimize_streaming_latency: 1,
text_normalization: true
})
},
language: 'en',
voice: process.env.XAI_VOICE || 'eve',
text,
renderForCaching: true
});
t.ok(!opts.servedFromCache && opts.filePath, `successfully synthesized xai 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);