Persist TTS voice and improve display

adriantache · adriantache · commit f6890c235d0a · 2025-06-06T21:38:40.000+01:00
diff --git a/composeApp/build.gradle.kts b/composeApp/build.gradle.kts
@@ -2,7 +2,7 @@
 import org.jetbrains.compose.desktop.application.dsl.TargetFormat
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 
-val version = "1.0.42"
+val version = "1.0.43"
 val versionNumber = getVersionInt()
 
 plugins {
diff --git a/composeApp/src/androidMain/kotlin/platformSpecific/tts/TtsHelperImpl.kt b/composeApp/src/androidMain/kotlin/platformSpecific/tts/TtsHelperImpl.kt
@@ -7,12 +7,10 @@ import android.media.AudioManager
 import android.speech.tts.TextToSpeech
 import android.util.Log
 import com.adriantache.ContextProvider
-import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.Dispatchers
-import kotlinx.coroutines.delay
+import data.settings.SettingsRepositoryImpl
+import kotlinx.coroutines.*
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
-import kotlinx.coroutines.launch
 import platformSpecific.tts.model.TtsVoice
 import java.util.*
 
@@ -22,6 +20,7 @@ object TtsHelperImpl : TtsHelper {
     private val audioManager: AudioManager
     private val audioFocusRequest
         get() = AudioFocusRequest.Builder(AudioManager.AUDIOFOCUS_GAIN_TRANSIENT).build()
+    private val settingsRepository = SettingsRepositoryImpl() // TODO: definitely don't access this like this
 
     init {
         val context = requireNotNull(ContextProvider.context.get())
@@ -41,19 +40,23 @@ object TtsHelperImpl : TtsHelper {
     }
 
     override fun setVoice(voice: TtsVoice) {
-        val expectedVoice = tts.voices.find { it.name == voice.name }
+        val expectedVoice = tts.voices.find { it.name == voice.id }
 
         if (expectedVoice == null) Log.e(this::class.simpleName, "Cannot find voice $voice!")
+        else runBlocking { settingsRepository.setTtsVoice(voice.id) }
 
         tts.voice = expectedVoice ?: tts.defaultVoice
     }
 
     override fun getVoice(): TtsVoice? {
-        return tts.voice?.let { TtsVoice(it.name) }
+        return tts.voice?.let { getTtsVoice(it.name) }
     }
 
     override fun getVoices(): List<TtsVoice> {
-        return tts.voices?.map { TtsVoice(it.name) }.orEmpty()
+        return tts.voices.orEmpty()
+            .sortedBy { it.name }
+            .map { getTtsVoice(it.name) }
+            .filter { it.locale?.language == "en" }
     }
 
     private fun getTts(context: Context): TextToSpeech {
@@ -71,9 +74,17 @@ object TtsHelperImpl : TtsHelper {
         tts.apply {
             setPitch(1f)
             setSpeechRate(1f)
-            setLanguage(Locale.US).apply {
-                if (this in listOf(TextToSpeech.LANG_MISSING_DATA, TextToSpeech.LANG_NOT_SUPPORTED)) {
-                    Log.e("TTS", "This Language is not supported")
+
+            runBlocking {  // TODO: really improve this part...
+                val settings = settingsRepository.getSettings()
+                if (settings.ttsVoice != null) {
+                    voice = voices.find { it.name == settings.ttsVoice }
+                } else {
+                    setLanguage(Locale.US).apply {
+                        if (this in listOf(TextToSpeech.LANG_MISSING_DATA, TextToSpeech.LANG_NOT_SUPPORTED)) {
+                            Log.e("TTS", "This Language is not supported")
+                        }
+                    }
                 }
             }
         }
@@ -97,4 +108,20 @@ object TtsHelperImpl : TtsHelper {
 
         return statusFlow
     }
+
+    private fun getTtsVoice(id: String): TtsVoice {
+        val sections = id.split("-")
+        val locale = Locale(
+            sections[0],
+            sections[1]
+        )
+        val description = sections.drop(2).filter { it.length > 1 }.joinToString(" ")
+        val name = "${locale.displayName} $description"
+
+        return TtsVoice(
+            id = id,
+            name = name,
+            locale = locale,
+        )
+    }
 }
diff --git a/composeApp/src/commonMain/kotlin/data/settings/SettingsRepositoryImpl.kt b/composeApp/src/commonMain/kotlin/data/settings/SettingsRepositoryImpl.kt
@@ -16,4 +16,8 @@ class SettingsRepositoryImpl(
     override suspend fun setApiKey(key: String?) {
         settingsDataSource.setApiKey(key)
     }
+
+    override suspend fun setTtsVoice(voiceId: String?) {
+        settingsDataSource.setTtsVoice(voiceId)
+    }
 }
diff --git a/composeApp/src/commonMain/kotlin/data/settings/dataSource/SettingsDataSource.kt b/composeApp/src/commonMain/kotlin/data/settings/dataSource/SettingsDataSource.kt
@@ -6,4 +6,6 @@ interface SettingsDataSource {
     suspend fun getSettings(): SettingsData
 
     suspend fun setApiKey(key: String?)
+
+    suspend fun setTtsVoice(voiceId: String?)
 }
diff --git a/composeApp/src/commonMain/kotlin/data/settings/dataSource/SettingsDataSourceImpl.kt b/composeApp/src/commonMain/kotlin/data/settings/dataSource/SettingsDataSourceImpl.kt
@@ -8,15 +8,18 @@ import domain.settings.data.model.SettingsData
 import kotlinx.coroutines.flow.firstOrNull
 
 private val API_KEY_KEY = stringPreferencesKey("API_KEY_KEY_NEW")
+private val TTS_VOICE_KEY = stringPreferencesKey("TTS_VOICE_KEY")
 
 class SettingsDataSourceImpl(
     private val store: DataStore<Preferences> = DataStoreHelper.instance,
 ) : SettingsDataSource {
     override suspend fun getSettings(): SettingsData {
         val apiKey = store.data.firstOrNull()?.get(API_KEY_KEY)
+        val ttsVoice = store.data.firstOrNull()?.get(TTS_VOICE_KEY)
 
         return SettingsData(
             apiKey = apiKey,
+            ttsVoice = ttsVoice,
         )
     }
 
@@ -31,4 +34,16 @@ class SettingsDataSourceImpl(
             }
         }
     }
+
+    override suspend fun setTtsVoice(voiceId: String?) {
+        store.updateData {
+            it.toMutablePreferences().apply {
+                if (voiceId == null) {
+                    remove(TTS_VOICE_KEY)
+                } else {
+                    set(TTS_VOICE_KEY, voiceId)
+                }
+            }
+        }
+    }
 }
diff --git a/composeApp/src/commonMain/kotlin/domain/settings/data/SettingsRepository.kt b/composeApp/src/commonMain/kotlin/domain/settings/data/SettingsRepository.kt
@@ -6,4 +6,6 @@ interface SettingsRepository {
     suspend fun getSettings(): SettingsData
 
     suspend fun setApiKey(key: String?)
+
+    suspend fun setTtsVoice(voiceId: String?)
 }
diff --git a/composeApp/src/commonMain/kotlin/domain/settings/data/model/SettingsData.kt b/composeApp/src/commonMain/kotlin/domain/settings/data/model/SettingsData.kt
@@ -2,4 +2,5 @@ package domain.settings.data.model
 
 data class SettingsData(
     val apiKey: String?,
+    val ttsVoice: String?,
 )
diff --git a/composeApp/src/commonMain/kotlin/platformSpecific/tts/model/TtsVoice.kt b/composeApp/src/commonMain/kotlin/platformSpecific/tts/model/TtsVoice.kt
@@ -1,3 +1,9 @@
 package platformSpecific.tts.model
 
-data class TtsVoice(val name: String)
+import java.util.*
+
+data class TtsVoice(
+    val id: String,
+    val name: String?,
+    val locale: Locale?
+)
diff --git a/composeApp/src/commonMain/kotlin/presentation/navigation/view/SettingsScreen.kt b/composeApp/src/commonMain/kotlin/presentation/navigation/view/SettingsScreen.kt
@@ -8,6 +8,7 @@ import androidx.compose.runtime.*
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.unit.dp
 import androidx.compose.ui.window.Dialog
+import androidx.compose.ui.window.DialogProperties
 import domain.settings.state.SettingsState
 import platformSpecific.tts.getTtsHelper
 import presentation.settings.tts.TtsVoiceSelectionView
@@ -44,7 +45,10 @@ fun SettingsScreen(
             )
 
             if (displayTtsSelector) {
-                Dialog(onDismissRequest = { displayTtsSelector = false }) {
+                Dialog(
+                    onDismissRequest = { displayTtsSelector = false },
+                    properties = DialogProperties(usePlatformDefaultWidth = false),
+                ) {
                     TtsVoiceSelectionView(
                         modifier = Modifier.padding(16.dp),
                         onDismiss = { displayTtsSelector = false },
diff --git a/composeApp/src/commonMain/kotlin/presentation/settings/tts/TtsVoiceSelectionView.kt b/composeApp/src/commonMain/kotlin/presentation/settings/tts/TtsVoiceSelectionView.kt
@@ -10,6 +10,7 @@ import androidx.compose.material.MaterialTheme
 import androidx.compose.material.RadioButton
 import androidx.compose.material.Text
 import androidx.compose.runtime.*
+import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.unit.dp
 import platformSpecific.tts.getTtsHelper
@@ -21,7 +22,7 @@ fun TtsVoiceSelectionView(
     modifier: Modifier = Modifier,
     onDismiss: () -> Unit,
 ) {
-    val ttsHelper by remember { lazy { getTtsHelper() } }
+    val ttsHelper by remember { lazy { getTtsHelper() } } // TODO: replace direct access with usecase
     var selectedTtsVoice: TtsVoice? by remember { mutableStateOf(null) }
     var voices: List<TtsVoice> by remember { mutableStateOf(emptyList()) }
 
@@ -36,7 +37,7 @@ fun TtsVoiceSelectionView(
         ttsHelper?.let { ttsHelper ->
             selectedTtsVoice = voice
             ttsHelper.setVoice(voice)
-            ttsHelper.speak("Hello! This is ${voice.name} speaking.")
+            ttsHelper.speak("Hello! This is ${voice.id} speaking.")
         } ?: onDismiss()
     }
 
@@ -64,16 +65,28 @@ fun VoiceRow(
             .padding(16.dp),
         horizontalArrangement = Arrangement.SpaceBetween
     ) {
-        Row {
+        Row(
+            verticalAlignment = Alignment.CenterVertically,
+        ) {
             RadioButton(
                 selected = selected,
                 onClick = null,
             )
             Spacer(modifier = Modifier.width(8.dp))
             Column {
-                Text(text = voice.name, style = MaterialTheme.typography.subtitle1, color = AppColor.onCard())
-                Text(text = voice.name, style = MaterialTheme.typography.caption, color = AppColor.onCard())
+                Text(
+                    text = voice.name ?: voice.id,
+                    style = MaterialTheme.typography.subtitle1,
+                    color = AppColor.onCard()
+                )
+                Text(text = voice.id, style = MaterialTheme.typography.caption, color = AppColor.onCard())
             }
+            Spacer(modifier = Modifier.width(8.dp))
+            Text(
+                text = voice.locale?.displayName.orEmpty(),
+                style = MaterialTheme.typography.subtitle2,
+                color = AppColor.onCard()
+            )
         }
     }
     Divider()
diff --git a/composeApp/src/commonTest/kotlin/data/dataSource/conversation/service/StreamingApiCallerImplTest.kt b/composeApp/src/commonTest/kotlin/data/dataSource/conversation/service/StreamingApiCallerImplTest.kt
@@ -53,7 +53,7 @@ class StreamingApiCallerImplTest {
             install(SSE)
         }
 
-        val settings = SettingsDataSourceFake(settings = SettingsData(apiKey = "testKey"))
+        val settings = SettingsDataSourceFake(settings = SettingsData(apiKey = "testKey", ttsVoice = null))
         val streamingApiCaller = StreamingApiCallerImpl(
             settingsDataSource = settings,
             client = client,
@@ -111,7 +111,7 @@ class StreamingApiCallerImplTest {
             }
         }
 
-        val settings = SettingsDataSourceFake(settings = SettingsData(apiKey = "testKey"))
+        val settings = SettingsDataSourceFake(settings = SettingsData(apiKey = "testKey", ttsVoice = null))
         val streamingApiCaller = StreamingApiCallerImpl(
             settingsDataSource = settings,
             client = client,
@@ -142,7 +142,7 @@ class StreamingApiCallerImplTest {
             }
         }
 
-        val settings = SettingsDataSourceFake(settings = SettingsData(apiKey = "testKey"))
+        val settings = SettingsDataSourceFake(settings = SettingsData(apiKey = "testKey", ttsVoice = null))
         val streamingApiCaller = StreamingApiCallerImpl(
             settingsDataSource = settings,
             client = client,
@@ -224,7 +224,6 @@ class StreamingApiCallerImplTest {
         }
     }
 
-    @Suppress("SpellCheckingInspection")
     private val expectedOpenAiResponse = listOf(
         "{\"id\":\"chatcmpl-AEdm9ovhO3SpdEF1oJIi9DCcUdsIz\",\"object\":\"chat.completion.chunk\",\"created\":1728052853,\"model\":\"gpt-4o-2024-08-06\",\"system_fingerprint\":\"fp_e5e4913e83\",\"choices\":[{\"index\":0,\"delta\":{\"role\":\"assistant\",\"content\":\"\",\"refusal\":\"\"},\"logprobs\":\"\",\"finish_reason\":\"\"}]}",
         "",
diff --git a/composeApp/src/commonTest/kotlin/data/settings/dataSource/SettingsDataSourceFake.kt b/composeApp/src/commonTest/kotlin/data/settings/dataSource/SettingsDataSourceFake.kt
@@ -3,7 +3,7 @@ package data.settings.dataSource
 import domain.settings.data.model.SettingsData
 
 class SettingsDataSourceFake(
-    private var settings: SettingsData = SettingsData(apiKey = null),
+    private var settings: SettingsData = SettingsData(apiKey = null, ttsVoice = null),
 ) : SettingsDataSource {
     override suspend fun getSettings(): SettingsData {
         return settings
@@ -14,4 +14,10 @@ class SettingsDataSourceFake(
             apiKey = key
         )
     }
+
+    override suspend fun setTtsVoice(voiceId: String?) {
+        settings = settings.copy(
+            ttsVoice = voiceId
+        )
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -16,4 +16,8 @@ class SettingsRepositoryImpl(`
`16`	`16`	`override suspend fun setApiKey(key: String?) {`
`17`	`17`	`settingsDataSource.setApiKey(key)`
`18`	`18`	`}`
	`19`	`+`
	`20`	`+ override suspend fun setTtsVoice(voiceId: String?) {`
	`21`	`+ settingsDataSource.setTtsVoice(voiceId)`
	`22`	`+ }`
`19`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,4 +6,6 @@ interface SettingsDataSource {`
`6`	`6`	`suspend fun getSettings(): SettingsData`
`7`	`7`
`8`	`8`	`suspend fun setApiKey(key: String?)`
	`9`	`+`
	`10`	`+ suspend fun setTtsVoice(voiceId: String?)`
`9`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,15 +8,18 @@ import domain.settings.data.model.SettingsData`
`8`	`8`	`import kotlinx.coroutines.flow.firstOrNull`
`9`	`9`
`10`	`10`	`private val API_KEY_KEY = stringPreferencesKey("API_KEY_KEY_NEW")`
	`11`	`+private val TTS_VOICE_KEY = stringPreferencesKey("TTS_VOICE_KEY")`
`11`	`12`
`12`	`13`	`class SettingsDataSourceImpl(`
`13`	`14`	`private val store: DataStore<Preferences> = DataStoreHelper.instance,`
`14`	`15`	`) : SettingsDataSource {`
`15`	`16`	`override suspend fun getSettings(): SettingsData {`
`16`	`17`	`val apiKey = store.data.firstOrNull()?.get(API_KEY_KEY)`
	`18`	`+ val ttsVoice = store.data.firstOrNull()?.get(TTS_VOICE_KEY)`
`17`	`19`
`18`	`20`	`return SettingsData(`
`19`	`21`	`apiKey = apiKey,`
	`22`	`+ ttsVoice = ttsVoice,`
`20`	`23`	`)`
`21`	`24`	`}`
`22`	`25`
`@@ -31,4 +34,16 @@ class SettingsDataSourceImpl(`
`31`	`34`	`}`
`32`	`35`	`}`
`33`	`36`	`}`
	`37`	`+`
	`38`	`+ override suspend fun setTtsVoice(voiceId: String?) {`
	`39`	`+ store.updateData {`
	`40`	`+ it.toMutablePreferences().apply {`
	`41`	`+ if (voiceId == null) {`
	`42`	`+ remove(TTS_VOICE_KEY)`
	`43`	`+ } else {`
	`44`	`+ set(TTS_VOICE_KEY, voiceId)`
	`45`	`+ }`
	`46`	`+ }`
	`47`	`+ }`
	`48`	`+ }`
`34`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,4 +6,6 @@ interface SettingsRepository {`
`6`	`6`	`suspend fun getSettings(): SettingsData`
`7`	`7`
`8`	`8`	`suspend fun setApiKey(key: String?)`
	`9`	`+`
	`10`	`+ suspend fun setTtsVoice(voiceId: String?)`
`9`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,5 @@ package domain.settings.data.model`
`2`	`2`
`3`	`3`	`data class SettingsData(`
`4`	`4`	`val apiKey: String?,`
	`5`	`+ val ttsVoice: String?,`
`5`	`6`	`)`