echogarden 0.12.2 → 1.0.0

package/src/synthesis/FliteTTS.ts

@@ -1,34 +1,34 @@
-import { SynthesisVoice } from "../api/API.js"
-import { decodeWaveBuffer } from "../audio/AudioUtilities.js"
-import { Logger } from "../utilities/Logger.js"
-import { getRandomHexString, logToStderr, resolveModuleMainPath } from "../utilities/Utilities.js"
-import { readFile, open, close, remove, ensureDir } from "../utilities/FileSystem.js"
-import path from "node:path"
+import { SynthesisVoice } from '../api/API.js'
+import { decodeWaveToRawAudio } from '../audio/AudioUtilities.js'
+import { Logger } from '../utilities/Logger.js'
+import { getRandomHexString, logToStderr, resolveModuleMainPath } from '../utilities/Utilities.js'
+import { readFile, open, close, remove, ensureDir } from '../utilities/FileSystem.js'
+import path from 'node:path'
 import { escape } from 'html-escaper'
-import { getAppTempDir } from "../utilities/PathUtilities.js"
+import { getAppTempDir } from '../utilities/PathUtilities.js'
 
 const log = logToStderr
 
-export type FliteVoiceName = "kal" | "kal16" | "awb" | "rms" | "slt" | string
+export type FliteVoiceName = 'kal' | 'kal16' | 'awb' | 'rms' | 'slt' | string
 
 let fliteModuleObject: WebAssembly.Module
 
 export async function synthesize(text: string, voice: FliteVoiceName, voiceDir: string | undefined, rate: number, pitchMeanHz?: number, pitchStdDev?: number) {
 	const logger = new Logger()
-	logger.start("Get Flite WASI instance")
+	logger.start('Get Flite WASI instance')
 
 	const randomId = getRandomHexString(16)
 
 	const outFileName = `${randomId}.out.wav`
 	const stdOutFileName = `${randomId}.stdout`
 
-	const tempDir = getAppTempDir("flite")
+	const tempDir = getAppTempDir('flite')
 	await ensureDir(tempDir)
 
 	const tempAudioFilePath = path.join(tempDir, outFileName)
 	const tempStdOutFilePath = path.join(tempDir, stdOutFileName)
 
-	const stdOutFileFd = await open(tempStdOutFilePath, "w+")
+	const stdOutFileFd = await open(tempStdOutFilePath, 'w+')
 
 	if (voiceDir) {
 		voice = `voices/${voice}.flitevox`
@@ -85,7 +85,7 @@ export async function synthesize(text: string, voice: FliteVoiceName, voiceDir:
 	const moduleObject = await getModuleObject()
 	const instance = await WebAssembly.instantiate(moduleObject, importObject)
 
-	logger.start("Synthesize with flite")
+	logger.start('Synthesize with flite')
 	const exitCode: number = wasi.start(instance) as any
 
 	await close(stdOutFileFd)
@@ -101,13 +101,13 @@ export async function synthesize(text: string, voice: FliteVoiceName, voiceDir:
 	}
 
 	const waveData = await readFile(tempAudioFilePath)
-	const stdOutString = await readFile(tempStdOutFilePath, "utf8")
+	const stdOutString = await readFile(tempStdOutFilePath, 'utf8')
 
 	await cleanup()
 
 	const events = parseEventsFromTrace(stdOutString)
 
-	const { rawAudio } = decodeWaveBuffer(waveData)
+	const { rawAudio } = decodeWaveToRawAudio(waveData)
 
 	logger.end()
 
@@ -127,7 +127,7 @@ async function getModuleObject() {
 function parseEventsFromTrace(eventTrace: string) {
 	//log(eventTrace)
 
-	const eventStrings = eventTrace.trim().split(" ")
+	const eventStrings = eventTrace.trim().split(' ')
 	const eventCount = eventStrings.length
 
 	const events: FliteEvent[] = []
@@ -135,21 +135,21 @@ function parseEventsFromTrace(eventTrace: string) {
 
 	for (let i = 0; i < eventCount; i++) {
 		const eventString = eventStrings[i]
-		const splitPoint = eventString.lastIndexOf(":")
+		const splitPoint = eventString.lastIndexOf(':')
 
 		const id = eventString.substring(0, splitPoint)
 		const startTime = events.length > 0 ? events[events.length - 1].endTime : 0
 
 		let eventType: FliteEventType
 
-		if (id == "pau") {
-			eventType = "pause"
-		} else if (id == "\npau") {
-			eventType = "phrasePause"
+		if (id == 'pau') {
+			eventType = 'pause'
+		} else if (id == '\npau') {
+			eventType = 'phrasePause'
 
 			phraseStartOffset = startTime
 		} else {
-			eventType = "phone"
+			eventType = 'phone'
 		}
 
 		const endTime = phraseStartOffset + parseFloat(eventString.substring(splitPoint + 1))
@@ -165,7 +165,7 @@ function parseEventsFromTrace(eventTrace: string) {
 	return events
 }
 
-export type FliteEventType = "phone" | "pause" | "phrasePause"
+export type FliteEventType = 'phone' | 'pause' | 'phrasePause'
 
 export type FliteEvent = {
 	type: FliteEventType,
@@ -177,214 +177,214 @@ export type FliteEvent = {
 export const voiceList: SynthesisVoice[] = [
 	// Built-in voices
 	{
-		name: "slt",
-		languages: ["en-US", "en"],
-		gender: "female"
+		name: 'slt',
+		languages: ['en-US', 'en'],
+		gender: 'female'
 	},
 	{
-		name: "kal16",
-		languages: ["en-US", "en"],
-		gender: "male"
+		name: 'kal16',
+		languages: ['en-US', 'en'],
+		gender: 'male'
 	},
 	{
-		name: "rms",
-		languages: ["en-US", "en"],
-		gender: "male"
+		name: 'rms',
+		languages: ['en-US', 'en'],
+		gender: 'male'
 	},
 	{
-		name: "awb",
-		languages: ["en-GB-SCOTLAND", "en-GB", "en"],
-		gender: "male"
+		name: 'awb',
+		languages: ['en-GB-SCOTLAND', 'en-GB', 'en'],
+		gender: 'male'
 	},
 	{
-		name: "kal",
-		languages: ["en-US", "en"],
-		gender: "male"
+		name: 'kal',
+		languages: ['en-US', 'en'],
+		gender: 'male'
 	},
 
 
 	// Voices loaded from packages
 	// US English voices
 	{
-		name: "cmu_us_aew",
-		languages: ["en-US", "en"],
-		gender: "male",
-		packageName: "flite-cmu_us_aew"
+		name: 'cmu_us_aew',
+		languages: ['en-US', 'en'],
+		gender: 'male',
+		packageName: 'flite-cmu_us_aew'
 	},
 	{
-		name: "cmu_us_ahw",
-		languages: ["en-US", "en"],
-		gender: "male",
-		packageName: "flite-cmu_us_ahw"
+		name: 'cmu_us_ahw',
+		languages: ['en-US', 'en'],
+		gender: 'male',
+		packageName: 'flite-cmu_us_ahw'
 	},
 	{
-		name: "cmu_us_aup",
-		languages: ["en-US", "en"],
-		gender: "male",
-		packageName: "flite-cmu_us_aup"
+		name: 'cmu_us_aup',
+		languages: ['en-US', 'en'],
+		gender: 'male',
+		packageName: 'flite-cmu_us_aup'
 	},
 	{
-		name: "cmu_us_awb",
-		languages: ["en-US", "en"],
-		gender: "male",
-		packageName: "flite-cmu_us_awb"
+		name: 'cmu_us_awb',
+		languages: ['en-US', 'en'],
+		gender: 'male',
+		packageName: 'flite-cmu_us_awb'
 	},
 	{
-		name: "cmu_us_axb",
-		languages: ["en-US", "en"],
-		gender: "female",
-		packageName: "flite-cmu_us_axb"
+		name: 'cmu_us_axb',
+		languages: ['en-US', 'en'],
+		gender: 'female',
+		packageName: 'flite-cmu_us_axb'
 	},
 	{
-		name: "cmu_us_bdl",
-		languages: ["en-US", "en"],
-		gender: "male",
-		packageName: "flite-cmu_us_bdl"
+		name: 'cmu_us_bdl',
+		languages: ['en-US', 'en'],
+		gender: 'male',
+		packageName: 'flite-cmu_us_bdl'
 	},
 	{
-		name: "cmu_us_clb",
-		languages: ["en-US", "en"],
-		gender: "female",
-		packageName: "flite-cmu_us_clb"
+		name: 'cmu_us_clb',
+		languages: ['en-US', 'en'],
+		gender: 'female',
+		packageName: 'flite-cmu_us_clb'
 	},
 	{
-		name: "cmu_us_eey",
-		languages: ["en-US", "en"],
-		gender: "female",
-		packageName: "flite-cmu_us_eey"
+		name: 'cmu_us_eey',
+		languages: ['en-US', 'en'],
+		gender: 'female',
+		packageName: 'flite-cmu_us_eey'
 	},
 	{
-		name: "cmu_us_fem",
-		languages: ["en-US", "en"],
-		gender: "male",
-		packageName: "flite-cmu_us_fem"
+		name: 'cmu_us_fem',
+		languages: ['en-US', 'en'],
+		gender: 'male',
+		packageName: 'flite-cmu_us_fem'
 	},
 	{
-		name: "cmu_us_gka",
-		languages: ["en-US", "en"],
-		gender: "male",
-		packageName: "flite-cmu_us_gka"
+		name: 'cmu_us_gka',
+		languages: ['en-US', 'en'],
+		gender: 'male',
+		packageName: 'flite-cmu_us_gka'
 	},
 	{
-		name: "cmu_us_jmk",
-		languages: ["en-US", "en"],
-		gender: "male",
-		packageName: "flite-cmu_us_jmk"
+		name: 'cmu_us_jmk',
+		languages: ['en-US', 'en'],
+		gender: 'male',
+		packageName: 'flite-cmu_us_jmk'
 	},
 	{
-		name: "cmu_us_ksp",
-		languages: ["en-US", "en"],
-		gender: "male",
-		packageName: "flite-cmu_us_ksp"
+		name: 'cmu_us_ksp',
+		languages: ['en-US', 'en'],
+		gender: 'male',
+		packageName: 'flite-cmu_us_ksp'
 	},
 	{
-		name: "cmu_us_ljm",
-		languages: ["en-US", "en"],
-		gender: "female",
-		packageName: "flite-cmu_us_ljm"
+		name: 'cmu_us_ljm',
+		languages: ['en-US', 'en'],
+		gender: 'female',
+		packageName: 'flite-cmu_us_ljm'
 	},
 	{
-		name: "cmu_us_lnh",
-		languages: ["en-US", "en"],
-		gender: "female",
-		packageName: "flite-cmu_us_lnh"
+		name: 'cmu_us_lnh',
+		languages: ['en-US', 'en'],
+		gender: 'female',
+		packageName: 'flite-cmu_us_lnh'
 	},
 	{
-		name: "cmu_us_rms",
-		languages: ["en-US", "en"],
-		gender: "male",
-		packageName: "flite-cmu_us_rms"
+		name: 'cmu_us_rms',
+		languages: ['en-US', 'en'],
+		gender: 'male',
+		packageName: 'flite-cmu_us_rms'
 	},
 	{
-		name: "cmu_us_rxr",
-		languages: ["en-US", "en"],
-		gender: "male",
-		packageName: "flite-cmu_us_rxr"
+		name: 'cmu_us_rxr',
+		languages: ['en-US', 'en'],
+		gender: 'male',
+		packageName: 'flite-cmu_us_rxr'
 	},
 	{
-		name: "cmu_us_slp",
-		languages: ["en-US", "en"],
-		gender: "female",
-		packageName: "flite-cmu_us_slp"
+		name: 'cmu_us_slp',
+		languages: ['en-US', 'en'],
+		gender: 'female',
+		packageName: 'flite-cmu_us_slp'
 	},
 	{
-		name: "cmu_us_slt",
-		languages: ["en-US", "en"],
-		gender: "female",
-		packageName: "flite-cmu_us_slt"
+		name: 'cmu_us_slt',
+		languages: ['en-US', 'en'],
+		gender: 'female',
+		packageName: 'flite-cmu_us_slt'
 	},
 
 	// Indic voices
 	{
-		name: "cmu_indic_ben_rm",
-		languages: ["be", "bn"],// Bengali
-		gender: "female",
-		packageName: "flite-cmu_indic_ben_rm"
+		name: 'cmu_indic_ben_rm',
+		languages: ['be', 'bn'],// Bengali
+		gender: 'female',
+		packageName: 'flite-cmu_indic_ben_rm'
 	},
 	{
-		name: "cmu_indic_guj_ad",
-		languages: ["gu"],// Gujarati
-		gender: "male",
-		packageName: "flite-cmu_indic_guj_ad"
+		name: 'cmu_indic_guj_ad',
+		languages: ['gu'],// Gujarati
+		gender: 'male',
+		packageName: 'flite-cmu_indic_guj_ad'
 	},
 	{
-		name: "cmu_indic_guj_dp",
-		languages: ["gu"],// Gujarati
-		gender: "female",
-		packageName: "flite-cmu_indic_guj_dp"
+		name: 'cmu_indic_guj_dp',
+		languages: ['gu'],// Gujarati
+		gender: 'female',
+		packageName: 'flite-cmu_indic_guj_dp'
 	},
 	{
-		name: "cmu_indic_guj_kt",
-		languages: ["gu"],// Gujarati
-		gender: "female",
-		packageName: "flite-cmu_indic_guj_kt"
+		name: 'cmu_indic_guj_kt',
+		languages: ['gu'],// Gujarati
+		gender: 'female',
+		packageName: 'flite-cmu_indic_guj_kt'
 	},
 	{
-		name: "cmu_indic_hin_ab",
-		languages: ["hi"],// Hindi
-		gender: "female",
-		packageName: "flite-cmu_indic_hin_ab"
+		name: 'cmu_indic_hin_ab',
+		languages: ['hi'],// Hindi
+		gender: 'female',
+		packageName: 'flite-cmu_indic_hin_ab'
 	},
 	{
-		name: "cmu_indic_kan_plv",
-		languages: ["ka"],// Kannada
-		gender: "female",
-		packageName: "flite-cmu_indic_kan_plv"
+		name: 'cmu_indic_kan_plv',
+		languages: ['ka'],// Kannada
+		gender: 'female',
+		packageName: 'flite-cmu_indic_kan_plv'
 	},
 	{
-		name: "cmu_indic_mar_aup",
-		languages: ["mr"],// Marathi
-		gender: "male",
-		packageName: "flite-cmu_indic_mar_aup"
+		name: 'cmu_indic_mar_aup',
+		languages: ['mr'],// Marathi
+		gender: 'male',
+		packageName: 'flite-cmu_indic_mar_aup'
 	},
 	{
-		name: "cmu_indic_mar_slp",
-		languages: ["mr"],// Marathi
-		gender: "female",
-		packageName: "flite-cmu_indic_mar_slp"
+		name: 'cmu_indic_mar_slp',
+		languages: ['mr'],// Marathi
+		gender: 'female',
+		packageName: 'flite-cmu_indic_mar_slp'
 	},
 	{
-		name: "cmu_indic_pan_amp",
-		languages: ["pa"],// Punjabi
-		gender: "female",
-		packageName: "flite-cmu_indic_pan_amp"
+		name: 'cmu_indic_pan_amp',
+		languages: ['pa'],// Punjabi
+		gender: 'female',
+		packageName: 'flite-cmu_indic_pan_amp'
 	},
 	{
-		name: "cmu_indic_tel_kpn",
-		languages: ["te"],// Telugu
-		gender: "female",
-		packageName: "flite-cmu_indic_tel_kpn"
+		name: 'cmu_indic_tel_kpn',
+		languages: ['te'],// Telugu
+		gender: 'female',
+		packageName: 'flite-cmu_indic_tel_kpn'
 	},
 	{
-		name: "cmu_indic_tel_sk",
-		languages: ["te"],// Telugu
-		gender: "male",
-		packageName: "flite-cmu_indic_tel_sk"
+		name: 'cmu_indic_tel_sk',
+		languages: ['te'],// Telugu
+		gender: 'male',
+		packageName: 'flite-cmu_indic_tel_sk'
 	},
 	{
-		name: "cmu_indic_tel_ss",
-		languages: ["te"],// Telugu
-		gender: "female",
-		packageName: "flite-cmu_indic_tel_ss"
+		name: 'cmu_indic_tel_ss',
+		languages: ['te'],// Telugu
+		gender: 'female',
+		packageName: 'flite-cmu_indic_tel_ss'
 	},
 ]

package/src/synthesis/GoogleCloudTTS.ts

@@ -1,12 +1,12 @@
-import { request } from "gaxios"
-import { Logger } from "../utilities/Logger.js"
-import { logToStderr } from "../utilities/Utilities.js"
+import { request } from 'gaxios'
+import { Logger } from '../utilities/Logger.js'
+import { logToStderr } from '../utilities/Utilities.js'
 
 const log = logToStderr
 
-export async function synthesize(text: string, apiKey: string, languageCode = "en-US", voice = "en-US-Wavenet-C", speakingRate = 1.0, pitchDeltaSemitones = 0.0, volumeGainDb = 0.0, ssml = false, audioEncoding: AudioEncoding = "MP3_64_KBPS", sampleRate = 24000) {
+export async function synthesize(text: string, apiKey: string, languageCode = 'en-US', voice = 'en-US-Wavenet-C', speakingRate = 1.0, pitchDeltaSemitones = 0.0, volumeGainDecibels = 0.0, ssml = false, audioEncoding: AudioEncoding = 'MP3_64_KBPS', sampleRate = 24000) {
 	const logger = new Logger()
-	logger.start("Request synthesis from Google Cloud")
+	logger.start('Request synthesis from Google Cloud')
 
 	const requestBody = {
 		input: {
@@ -23,11 +23,11 @@ export async function synthesize(text: string, apiKey: string, languageCode = "e
 			audioEncoding,
 			speakingRate,
 			pitch: pitchDeltaSemitones,
-			volumeGainDb,
+			volumeGainDb: volumeGainDecibels,
 			sampleRateHertz: sampleRate
 		},
 
-		enableTimePointing: ["SSML_MARK"]
+		enableTimePointing: ['SSML_MARK']
 	}
 
 	if (ssml) {
@@ -37,24 +37,24 @@ export async function synthesize(text: string, apiKey: string, languageCode = "e
 	}
 
 	const response = await request<any>({
-		method: "POST",
+		method: 'POST',
 
 		url: `https://texttospeech.googleapis.com/v1beta1/text:synthesize`,
 
 		params: {
-			"key": apiKey
+			'key': apiKey
 		},
 
 		headers: {
-			"User-Agent": ""
+			'User-Agent': ''
 		},
 
 		data: requestBody,
 
-		responseType: "json"
+		responseType: 'json'
 	})
 
-	logger.start("Parse result")
+	logger.start('Parse result')
 
 	const result = parseResponseBody(response.data)
 
@@ -64,7 +64,7 @@ export async function synthesize(text: string, apiKey: string, languageCode = "e
 }
 
 function parseResponseBody(responseBody: any) {
-	const audioData = Buffer.from(responseBody.audioContent, "base64")
+	const audioData = Buffer.from(responseBody.audioContent, 'base64')
 	const timepoints: timePoint[] = responseBody.timepoints
 
 	return { audioData, timepoints }
@@ -75,19 +75,19 @@ export async function getVoiceList(apiKey: string) {
 	const requestURL = `https://texttospeech.googleapis.com/v1beta1/voices`
 
 	const response = await request<any>({
-		method: "GET",
+		method: 'GET',
 
 		url: requestURL,
 
 		params: {
-			"key": apiKey
+			'key': apiKey
 		},
 
 		headers: {
-			"User-Agent": ""
+			'User-Agent': ''
 		},
 
-		responseType: "json"
+		responseType: 'json'
 	})
 
 	const responseData = response.data
@@ -100,11 +100,11 @@ export async function getVoiceList(apiKey: string) {
 export type GoogleCloudVoice = {
 	name: string
 	languageCodes: string[]
-	ssmlGender: "MALE" | "FEMALE"
+	ssmlGender: 'MALE' | 'FEMALE'
 	naturalSampleRateHertz: number
 }
 
-export type AudioEncoding = "LINEAR16" | "MP3" | "MP3_64_KBPS" | "OGG_OPUS" | "MULAW" | "ALAW"
+export type AudioEncoding = 'LINEAR16' | 'MP3' | 'MP3_64_KBPS' | 'OGG_OPUS' | 'MULAW' | 'ALAW'
 
 export type timePoint = {
 	markName: string,