fix(tts): get tts engine name from the endpoint

Use the engine's name as reported by `/ws/tts-engines` in the engines and voices screens of the settings dialog. #228
daisy · Jun 28, 2024 · d1475f4 · d1475f4
1 parent a588f77
commit d1475f4
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 25 deletions.
diff --git a/src/renderer/components/TtsEnginesConfig/index.tsx b/src/renderer/components/TtsEnginesConfig/index.tsx
@@ -18,6 +18,11 @@ const enginePropertyKeys = [
     'org.daisy.pipeline.tts.azure.region',
     'org.daisy.pipeline.tts.google.apikey',
 ]
+const engineIds = [
+    'org.daisy.pipeline.tts.azure',
+    'org.daisy.pipeline.tts.google',
+]
+
 const engineNames = {
     'org.daisy.pipeline.tts.azure': 'Azure',
     'org.daisy.pipeline.tts.google': 'Google',
@@ -148,22 +153,24 @@ export function TtsEnginesConfigPane({
                 they will be available under 'Voices'.
             </p>
             <ul>
-                {Object.keys(engineNames).map((engineKeyPrefix, idx) => (
-                    <li key={engineKeyPrefix + '-' + idx}>
-                        {engineNames[engineKeyPrefix]}
+                {/* {Object.keys(engineNames).map((engineKeyPrefix, idx) => ( */}
+                {engineIds.map((engineId, idx) => (
+                    <li key={engineId + '-' + idx}>
+                        {pipeline.ttsEnginesStates[
+                            engineId.split('.').reverse()[0]
+                        ]?.name ?? engineId}
+
                         <ul>
                             {enginePropertyKeys
-                                .filter((propkey) =>
-                                    propkey.includes(engineKeyPrefix)
-                                )
+                                .filter((propkey) => propkey.includes(engineId))
                                 .map((propkey, idx) => (
                                     <li key={propkey + '-' + idx}>
                                         <label htmlFor={propkey}>
                                             {(() => {
                                                 // the propkey looks like org.daisy.pipeline.tts.enginename.propkeyname
                                                 // label the form field as "Propkeyname"
                                                 let propkey_ = propkey.replace(
-                                                    engineKeyPrefix + '.',
+                                                    engineId + '.',
                                                     ''
                                                 )
                                                 return (
@@ -188,23 +195,21 @@ export function TtsEnginesConfigPane({
                                         />
                                     </li>
                                 ))}
-                            {engineMessage[engineKeyPrefix] && (
+                            {engineMessage[engineId] && (
                                 <li className="error">
-                                    {engineMessage[engineKeyPrefix].split('\n')
+                                    {engineMessage[engineId].split('\n')
                                         .length === 1 ? (
-                                        <span>
-                                            {engineMessage[engineKeyPrefix]}
-                                        </span>
+                                        <span>{engineMessage[engineId]}</span>
                                     ) : (
                                         <details>
                                             <summary>
                                                 {
                                                     engineMessage[
-                                                        engineKeyPrefix
+                                                        engineId
                                                     ].split('\n')[0]
                                                 }
                                             </summary>
-                                            {engineMessage[engineKeyPrefix]
+                                            {engineMessage[engineId]
                                                 .split('\n')
                                                 .slice(1)
                                                 .join('\n')}
@@ -213,29 +218,25 @@ export function TtsEnginesConfigPane({
                                 </li>
                             )}
                             {['azure', 'google'].includes(
-                                engineKeyPrefix.split('.').slice(-1)[0]
+                                engineId.split('.').slice(-1)[0]
                             ) && (
                                 <li>
-                                    {!isConnectedToTTSEngine(engineKeyPrefix) ||
-                                    enginePropsChanged[engineKeyPrefix] ? (
+                                    {!isConnectedToTTSEngine(engineId) ||
+                                    enginePropsChanged[engineId] ? (
                                         <button
                                             onClick={(e) => {
                                                 e.preventDefault()
-                                                connectToTTSEngine(
-                                                    engineKeyPrefix
-                                                )
+                                                connectToTTSEngine(engineId)
                                             }}
                                         >
                                             Connect
                                         </button>
-                                    ) : isConnectedToTTSEngine(
-                                          engineKeyPrefix
-                                      ) ? (
+                                    ) : isConnectedToTTSEngine(engineId) ? (
                                         <button
                                             onClick={(e) => {
                                                 e.preventDefault()
                                                 disconnectFromTTSEngine(
-                                                    engineKeyPrefix
+                                                    engineId
                                                 )
                                             }}
                                         >

diff --git a/src/renderer/components/TtsVoicesConfig/index.tsx b/src/renderer/components/TtsVoicesConfig/index.tsx
@@ -14,6 +14,8 @@ export function TtsVoicesConfigPane({
     onChangePreferredVoices,
     onChangeDefaultVoices,
 }) {
+    const { pipeline } = useWindowStore()
+
     const [preferredVoices, setPreferredVoices] = useState([
         ...userPreferredVoices,
     ])
@@ -418,7 +420,13 @@ export function TtsVoicesConfigPane({
                                             {voicesTransliterations[v.name] ??
                                                 v.name}
                                         </td>
-                                        <td>{v.engine}</td>
+                                        <td>
+                                            {
+                                                pipeline.ttsEnginesStates[
+                                                    v.engine
+                                                ].name
+                                            }
+                                        </td>
                                         <td>{languageNames.of(v.lang)}</td>
                                         <td>{v.gender}</td>
                                         <td className="actions">

diff --git a/src/shared/parser/pipelineXmlConverter/ttsEnginesToJson.ts b/src/shared/parser/pipelineXmlConverter/ttsEnginesToJson.ts
@@ -23,6 +23,12 @@ function ttsEnginesToJson(
                 if (ttsEngineElem.getAttribute('message').length > 0) {
                     acc[key].message = ttsEngineElem.getAttribute('message')
                 }
+                if (ttsEngineElem.getAttribute('voices').length > 0) {
+                    acc[key].voicesUrl = ttsEngineElem.getAttribute('voices')
+                }
+                if (ttsEngineElem.getAttribute('nicename').length > 0) {
+                    acc[key].name = ttsEngineElem.getAttribute('nicename')
+                }
             }
             return acc
         }, {})

diff --git a/src/shared/types/ttsConfig.ts b/src/shared/types/ttsConfig.ts
@@ -22,4 +22,6 @@ export type TtsEngineState = {
     status?: 'disabled' | 'connecting' | 'available' | 'disconnecting' | 'error'
     features?: Array<string>
     message?: string
+    name?: string
+    voicesUrl?: string
 }