refactor,fix(data,ime,ui,res): enhance key sound theme management

- Add preference to enable/disable to use custom sound theme (package)
- Utilize kaml library to parse sound theme configurations
- Ship stuffs of parsing the configurations to SoundManager
- Ship stuffs of playing the custom key effect to InputFeedbackManager

Author: WhiredPlanck

app/src/main/java/com/osfans/trime/data/AppPrefs.kt

@@ -145,7 +145,8 @@ class AppPrefs(
 
             const val SOUND_ENABLED = "keyboard__key_sound"
             const val SOUND_VOLUME = "keyboard__key_sound_volume"
-            const val SOUND_PACKAGE = "keyboard__key_sound_package"
+            const val CUSTOM_SOUND_ENABLED = "keyboard__custom_key_sound"
+            const val CUSTOM_SOUND_PACKAGE = "keyboard__key_sound_package"
 
             const val VIBRATION_ENABLED = "keyboard__key_vibration"
             const val VIBRATION_DURATION = "keyboard__key_vibration_duration"
@@ -224,9 +225,12 @@ class AppPrefs(
         var soundEnabled: Boolean = false
             get() = prefs.getPref(SOUND_ENABLED, false)
             private set
-        var soundPackage: String
-            get() = prefs.getPref(SOUND_PACKAGE, "")
-            set(v) = prefs.setPref(SOUND_PACKAGE, v)
+        var customSoundEnabled: Boolean
+            get() = prefs.getPref(CUSTOM_SOUND_ENABLED, false)
+            set(v) = prefs.setPref(CUSTOM_SOUND_ENABLED, v)
+        var customSoundPackage: String
+            get() = prefs.getPref(CUSTOM_SOUND_PACKAGE, "")
+            set(v) = prefs.setPref(CUSTOM_SOUND_PACKAGE, v)
         var soundVolume: Int = 0
             get() = prefs.getPref(SOUND_VOLUME, 100)
             private set

app/src/main/java/com/osfans/trime/data/sound/SoundManager.kt

@@ -0,0 +1,42 @@
+package com.osfans.trime.data.sound
+
+import android.view.KeyEvent
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.Transient
+
+@Serializable
+data class SoundTheme(
+    @Transient var name: String? = null,
+    val sound: List<String>,
+    val folder: String,
+    val melody: List<String>? = null,
+    val keyset: List<Key>
+) {
+    @Serializable
+    data class Key(
+        val min: String? = null,
+        val max: String? = null,
+        val keys: List<String>? = null,
+        val inOrder: Boolean,
+        val sounds: List<Int>
+    ) {
+        val sysKeys = keys?.map(String::uppercase)?.map(KeyEvent::keyCodeFromString)
+
+        fun soundId(keycode: Int): Int {
+            if (sounds.isEmpty()) return -1
+            if (sysKeys.isNullOrEmpty()) {
+                val min = KeyEvent.keyCodeFromString(min?.uppercase() ?: "UNKNOWN")
+                val max = KeyEvent.keyCodeFromString(max?.uppercase() ?: "UNKNOWN")
+                if (keycode in min..max) {
+                    return sounds[if (inOrder) (keycode - min) % sounds.size else sounds.indices.random()]
+                }
+            } else {
+                val sysKey = sysKeys.indexOf(keycode)
+                if (sysKey > -1) {
+                    return sounds[if (inOrder) sysKey % sounds.size else sounds.indices.random()]
+                }
+            }
+            return -1
+        }
+    }
+}

app/src/main/java/com/osfans/trime/data/sound/SoundTheme.kt

@@ -0,0 +1,64 @@
+package com.osfans.trime.data.sound
+
+import com.charleskorn.kaml.Yaml
+import com.charleskorn.kaml.YamlConfiguration
+import com.osfans.trime.data.AppPrefs
+import com.osfans.trime.data.DataManager
+import timber.log.Timber
+import java.io.File
+
+object SoundThemeManager {
+
+    val userDir = File(DataManager.userDataDir, "sound")
+
+    private val yaml = Yaml(
+        configuration = YamlConfiguration(
+            strictMode = false
+        )
+    )
+
+    private fun listSounds(): MutableList<SoundTheme> {
+        val files = userDir.listFiles { f -> f.name.endsWith("sound.yaml") }
+        return files
+            ?.mapNotNull decode@{ f ->
+                val theme = runCatching {
+                    yaml.decodeFromString(SoundTheme.serializer(), f.readText()).also {
+                        it.name = f.name.substringBefore('.')
+                    }
+                }.getOrElse { e ->
+                    Timber.w("Failed to decode sound theme file ${f.absolutePath}: ${e.message}")
+                    return@decode null
+                }
+                return@decode theme
+            }
+            ?.toMutableList() ?: mutableListOf()
+    }
+
+    private fun getSound(name: String) = userSounds.find { it.name == name }
+
+    val userSounds: MutableList<SoundTheme> = listSounds()
+
+    @JvmStatic
+    fun switchSound(name: String) {
+        if (getSound(name) == null) {
+            Timber.w("Unknown sound package name: $name")
+            return
+        }
+        AppPrefs.defaultInstance().keyboard.customSoundPackage = name
+        currentSoundTheme = getSound(name)!!
+    }
+
+    fun init() {
+        currentSoundTheme = getSound(AppPrefs.defaultInstance().keyboard.customSoundPackage) ?: return
+    }
+
+    private lateinit var currentSoundTheme: SoundTheme
+
+    fun getAllSoundThemes(): List<SoundTheme> = userSounds
+
+    fun getActiveSoundTheme() = runCatching { currentSoundTheme }
+
+    fun getActiveSoundFilePaths() = runCatching {
+        currentSoundTheme.let { t -> t.sound.map { "${userDir.path}/${t.folder}/$it" } }
+    }
+}

app/src/main/java/com/osfans/trime/data/sound/SoundThemeManager.kt

@@ -27,7 +27,7 @@
 import com.osfans.trime.core.Rime;
 import com.osfans.trime.data.AppPrefs;
 import com.osfans.trime.data.DataManager;
-import com.osfans.trime.data.sound.SoundManager;
+import com.osfans.trime.data.sound.SoundThemeManager;
 import com.osfans.trime.ime.keyboard.Key;
 import com.osfans.trime.util.CollectionUtils;
 import com.osfans.trime.util.ColorUtils;
@@ -80,7 +80,7 @@ public Config() {
     init();
 
     Timber.d("Setting sound from color ...");
-    SoundManager.switchSound(colors.getString("sound"));
+    SoundThemeManager.switchSound(colors.getString("sound"));
 
     Timber.d("Initialization finished");
   }

app/src/main/java/com/osfans/trime/data/theme/Config.java

@@ -58,7 +58,7 @@
 import com.osfans.trime.core.Rime;
 import com.osfans.trime.data.AppPrefs;
 import com.osfans.trime.data.db.DraftHelper;
-import com.osfans.trime.data.sound.SoundManager;
+import com.osfans.trime.data.sound.SoundThemeManager;
 import com.osfans.trime.data.theme.Config;
 import com.osfans.trime.databinding.CompositionRootBinding;
 import com.osfans.trime.databinding.InputRootBinding;
@@ -72,7 +72,6 @@
 import com.osfans.trime.ime.keyboard.Keyboard;
 import com.osfans.trime.ime.keyboard.KeyboardSwitcher;
 import com.osfans.trime.ime.keyboard.KeyboardView;
-import com.osfans.trime.ime.keyboard.Sound;
 import com.osfans.trime.ime.lifecycle.LifecycleInputMethodService;
 import com.osfans.trime.ime.symbol.LiquidKeyboard;
 import com.osfans.trime.ime.symbol.TabManager;
@@ -555,7 +554,7 @@ private void reset() {
     inputRootBinding.main.mainInput.setVisibility(View.VISIBLE);
     loadConfig();
     getImeConfig().initCurrentColors();
-    SoundManager.switchSound(getImeConfig().colors.getString("sound"));
+    SoundThemeManager.switchSound(getImeConfig().colors.getString("sound"));
     KeyboardSwitcher.newOrReset();
     resetCandidate();
     hideCompositionView();
@@ -576,7 +575,7 @@ public void initKeyboardDarkMode(boolean darkMode) {
     if (getImeConfig().hasDarkLight()) {
       loadConfig();
       getImeConfig().initCurrentColors(darkMode);
-      SoundManager.switchSound(getImeConfig().colors.getString("sound"));
+      SoundThemeManager.switchSound(getImeConfig().colors.getString("sound"));
       KeyboardSwitcher.newOrReset();
       resetCandidate();
       hideCompositionView();
@@ -752,7 +751,8 @@ public void onStartInputView(EditorInfo attribute, boolean restarting) {
       Timber.i("auto dark off");
     }
 
-    Sound.resetProgress();
+    inputFeedbackManager.resumeSoundPool();
+    inputFeedbackManager.resetPlayProgress();
     for (EventListener listener : eventListeners) {
       if (listener != null) listener.onStartInputView(activeEditorInstance, restarting);
     }
@@ -839,6 +839,7 @@ public void onFinishInputView(boolean finishingInput) {
     // Dismiss any pop-ups when the input-view is being finished and hidden.
     mainKeyboardView.closing();
     performEscape();
+    inputFeedbackManager.releaseSoundPool();
     try {
       hideCompositionView();
     } catch (Exception e) {