Merge pull request #35 from Julius-Babies/34-app-is-stuck-loading-or-crashes-on-startup-across-android-13-grapheneos-pixel-8-and-stock-pixel-7

#34 Fix App crash if TTS engine is unavailable

Author: Belgarus

app/src/main/AndroidManifest.xml

@@ -5,6 +5,7 @@
     <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
     <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
     <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.VIBRATE" />
 
     <application
         android:allowBackup="true"
@@ -28,5 +29,4 @@
             </intent-filter>
         </activity>
     </application>
-
-</manifest>
+</manifest>

app/src/main/java/org/jugendhackt/wegweiser/tts/TTS.kt

@@ -1,21 +1,32 @@
 package org.jugendhackt.wegweiser.tts
 
 import android.content.Context
+import android.media.MediaPlayer
+import android.os.Build
+import android.os.VibrationEffect
+import android.os.Vibrator
 import android.speech.tts.TextToSpeech
 import android.speech.tts.TextToSpeech.OnInitListener
 import android.speech.tts.UtteranceProgressListener
 import android.util.Log
+import androidx.core.content.getSystemService
 import java.util.Locale
 import org.jugendhackt.wegweiser.language.language
 
 class TTS(context: Context) {
 
+    private val context = context.applicationContext
     private val textToSpeech: TextToSpeech
+    private val vibrator: Vibrator? = context.getSystemService()
+    private var fallbackPlayer: MediaPlayer? = null
     private var isSpeaking = false
-    private val language = language(context)
+    private var isInitialized = false
+    private var hasPlayedUnavailableNotice = false
+    private val language = language(this@TTS.context)
+    private val forceTtsUnavailableForTesting = false
 
     init {
-        textToSpeech = TextToSpeech(context, OnInitListener { status ->
+        textToSpeech = TextToSpeech(this@TTS.context, OnInitListener { status ->
             if (status == TextToSpeech.SUCCESS) {
                 val langResult = textToSpeech.setLanguage(
                     if (language.getLanguage() == "de") Locale.GERMAN
@@ -24,9 +35,15 @@ class TTS(context: Context) {
                 )
                 if (langResult == TextToSpeech.LANG_MISSING_DATA || langResult == TextToSpeech.LANG_NOT_SUPPORTED) {
                     Log.e("TTS", "Language not supported or data missing.")
+                    isInitialized = false
+                    announceUnavailableOnStartup()
+                } else {
+                    isInitialized = true
                 }
             } else {
-                throw RuntimeException("Failed to initialize TextToSpeech: $status")
+                Log.e("TTS", "Failed to initialize TextToSpeech: $status")
+                isInitialized = false
+                announceUnavailableOnStartup()
             }
         })
     }
@@ -35,6 +52,21 @@ class TTS(context: Context) {
      * Will not speak if an output is already in progress
      */
     fun speak(text: String, onFinished: (() -> Unit)? = null) {
+        if (forceTtsUnavailableForTesting) {
+            Log.w("TTS", "TTS unavailable (forced for testing), skipping speak request.")
+            notifyTtsUnavailable(playVoice = !hasPlayedUnavailableNotice)
+            hasPlayedUnavailableNotice = true
+            onFinished?.invoke()
+            return
+        }
+
+        if (!isInitialized) {
+            Log.w("TTS", "TTS not initialized, skipping speak request.")
+            notifyTtsUnavailable(playVoice = false)
+            onFinished?.invoke()
+            return
+        }
+
         textToSpeech.setOnUtteranceProgressListener(object : UtteranceProgressListener() {
             override fun onStart(utteranceId: String?) {}
 
@@ -56,7 +88,62 @@ class TTS(context: Context) {
     }
 
     fun stop() {
+        if (!isInitialized) {
+            return
+        }
         textToSpeech.stop()
+        fallbackPlayer?.release()
+        fallbackPlayer = null
         isSpeaking = false
     }
+
+    private fun notifyTtsUnavailable(playVoice: Boolean) {
+        if (playVoice) {
+            playUnavailableNotice()
+        }
+        try {
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
+                vibrator?.vibrate(VibrationEffect.createWaveform(longArrayOf(0, 150, 70, 150), -1))
+            } else {
+                @Suppress("DEPRECATION")
+                vibrator?.vibrate(longArrayOf(0, 150, 70, 150), -1)
+            }
+        } catch (e: SecurityException) {
+            Log.w("TTS", "Vibration unavailable", e)
+        }
+    }
+
+    private fun announceUnavailableOnStartup() {
+        notifyTtsUnavailable(playVoice = true)
+    }
+
+    private fun playUnavailableNotice() {
+        val resourceName = if (language.getLanguage() == "de") "tts_unavailable_de" else "tts_unavailable_en"
+        val rawResId = context.resources.getIdentifier(resourceName, "raw", context.packageName)
+        if (rawResId == 0) {
+            Log.w("TTS", "Fallback voice message missing: res/raw/$resourceName")
+            return
+        }
+
+        try {
+            fallbackPlayer?.release()
+            fallbackPlayer = null
+            val player = MediaPlayer.create(context, rawResId) ?: return
+            fallbackPlayer = player
+            player.setOnCompletionListener {
+                it.release()
+                if (fallbackPlayer === it) fallbackPlayer = null
+            }
+            player.setOnErrorListener { mp, _, _ ->
+                mp.release()
+                if (fallbackPlayer === mp) fallbackPlayer = null
+                true
+            }
+            player.start()
+        } catch (e: Exception) {
+            Log.w("TTS", "Could not play fallback voice message", e)
+            fallbackPlayer?.release()
+            fallbackPlayer = null
+        }
+    }
 }

app/src/main/res/raw/generate_tts_resources.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python3
+from __future__ import annotations
+
+import json
+from pathlib import Path
+
+from gtts import gTTS
+
+MESSAGES_PATH = Path("tts_unavailable_messages.json")
+OUTPUT_DIR = Path(".")
+FILE_PREFIX = "tts_unavailable"
+SLOW = False
+
+
+def main() -> int:
+    # utf-8-sig handles normal UTF-8 files and UTF-8 with BOM.
+    data = json.loads(MESSAGES_PATH.read_text(encoding="utf-8-sig"))
+    OUTPUT_DIR.mkdir(parents=True, exist_ok=True)
+
+    for lang, text in data.items():
+        # Output example: tts_unavailable_de.mp3
+        out_file = OUTPUT_DIR / f"{FILE_PREFIX}_{lang}.mp3"
+        tts = gTTS(text=text.strip(), lang=lang, slow=SLOW)
+        tts.save(str(out_file))
+        print(f"Generated: {out_file}")
+
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

app/src/main/res/raw/tts_unavailable_de.mp3

@@ -0,0 +1,4 @@
+{
+  "de": "Hallo. Die Sprachausgabe ist auf diesem Gerät gerade nicht verfügbar.",
+  "en": "Hi there. Text to speech is currently unavailable on this device."
+}

app/src/main/res/raw/tts_unavailable_en.mp3

@@ -1,5 +1,5 @@
 [versions]
-agp = "9.2.0"
+agp = "9.2.1"
 kotlin = "2.3.21"
 coreKtx = "1.18.0"
 junit = "4.13.2"