feat: add Chinese lyrics romanization (supports Simplified and Traditional Chinese)

Author: RealNath

app/build.gradle.kts

@@ -206,6 +206,7 @@ dependencies {
 
     implementation(libs.room.runtime)
     implementation(libs.kuromoji.ipadic)
+    implementation(libs.tinypinyin)
     ksp(libs.room.compiler)
     implementation(libs.room.ktx)
 

app/src/main/kotlin/com/metrolist/music/constants/PreferenceKeys.kt

@@ -299,6 +299,7 @@ val LyricsClickKey = booleanPreferencesKey("lyricsClick")
 val LyricsScrollKey = booleanPreferencesKey("lyricsScrollKey")
 val LyricsRomanizeJapaneseKey = booleanPreferencesKey("lyricsRomanizeJapanese")
 val LyricsRomanizeKoreanKey = booleanPreferencesKey("lyricsRomanizeKorean")
+val LyricsRomanizeChineseKey = booleanPreferencesKey("lyricsRomanizeChinese")
 val LyricsRomanizeRussianKey = booleanPreferencesKey("lyricsRomanizeRussian")
 val LyricsRomanizeUkrainianKey = booleanPreferencesKey("lyricsRomanizeUkrainian")
 val LyricsRomanizeSerbianKey = booleanPreferencesKey("lyricsRomanizeSerbian")

app/src/main/kotlin/com/metrolist/music/lyrics/LyricsUtils.kt

@@ -2,6 +2,8 @@ package com.metrolist.music.lyrics
 
 import android.text.format.DateUtils
 import com.atilika.kuromoji.ipadic.Tokenizer
+import com.github.promeg.pinyinhelper.Pinyin
+import java.util.Locale
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
 
@@ -458,7 +460,23 @@ object LyricsUtils {
         romajaBuilder.toString()
     }
 
-
+    suspend fun romanizeChinese(text: String): String = withContext(Dispatchers.Default) {
+        if (text.isEmpty()) return@withContext ""
+        val builder = StringBuilder(text.length * 2)
+        for (ch in text) {
+            if (ch in '\u4E00'..'\u9FFF') {
+                val py = Pinyin.toPinyin(ch).lowercase(Locale.getDefault())
+                builder.append(py).append(' ')
+            } else {
+                builder.append(ch)
+            }
+        }
+        // Remove whitespaces before ASCII and CJK punctuations
+        builder.toString()
+            .replace(Regex("\\s+([,.!?;:])"), "$1")
+            .replace(Regex("\\s+([，。！？；：、（）《》〈〉【】『』「」])"), "$1")
+            .trim()
+    }
 
     suspend fun romanizeCyrillic(text: String): String? = withContext(Dispatchers.Default) {
         if (text.isEmpty()) return@withContext null

app/src/main/kotlin/com/metrolist/music/ui/component/Lyrics.kt

@@ -100,6 +100,7 @@ import com.metrolist.music.constants.LyricsClickKey
 import com.metrolist.music.constants.LyricsRomanizeBelarusianKey
 import com.metrolist.music.constants.LyricsRomanizeBulgarianKey
 import com.metrolist.music.constants.LyricsRomanizeCyrillicByLineKey
+import com.metrolist.music.constants.LyricsRomanizeChineseKey
 import com.metrolist.music.constants.LyricsRomanizeJapaneseKey
 import com.metrolist.music.constants.LyricsRomanizeKoreanKey
 import com.metrolist.music.constants.LyricsRomanizeKyrgyzKey
@@ -128,6 +129,7 @@ import com.metrolist.music.lyrics.LyricsUtils.parseLyrics
 import com.metrolist.music.lyrics.LyricsUtils.romanizeCyrillic
 import com.metrolist.music.lyrics.LyricsUtils.romanizeJapanese
 import com.metrolist.music.lyrics.LyricsUtils.romanizeKorean
+import com.metrolist.music.lyrics.LyricsUtils.romanizeChinese
 import com.metrolist.music.ui.component.shimmer.ShimmerHost
 import com.metrolist.music.ui.component.shimmer.TextPlaceholder
 import com.metrolist.music.ui.screens.settings.DarkMode
@@ -173,6 +175,7 @@ fun Lyrics(
     val romanizeKyrgyzLyrics by rememberPreference(LyricsRomanizeKyrgyzKey, true)
     val romanizeMacedonianLyrics by rememberPreference(LyricsRomanizeMacedonianKey, true)
     val romanizeCyrillicByLine by rememberPreference(LyricsRomanizeCyrillicByLineKey, false)
+    val romanizeChineseLyrics by rememberPreference(LyricsRomanizeChineseKey, true)
     val scope = rememberCoroutineScope()
 
     val mediaMetadata by playerConnection.mediaMetadata.collectAsState()
@@ -262,6 +265,12 @@ fun Lyrics(
                     }
                 }
 
+                else if (romanizeChineseLyrics && isChinese(entry.text)) {
+                    scope.launch {
+                        newEntry.romanizedTextFlow.value = romanizeChinese(entry.text)
+                    }
+                }
+
                 newEntry
             }.let {
                 listOf(LyricsEntry.HEAD_LYRICS_ENTRY) + it
@@ -332,6 +341,12 @@ fun Lyrics(
                     }
                 }
 
+                else if (romanizeChineseLyrics && isChinese(line)) {
+                    scope.launch {
+                        newEntry.romanizedTextFlow.value = romanizeChinese(line)
+                    }
+                }
+
                 newEntry
             }
         }
@@ -758,7 +773,8 @@ fun Lyrics(
                                     romanizeBulgarianLyrics ||
                                     romanizeBelarusianLyrics ||
                                     romanizeKyrgyzLyrics ||
-                                    romanizeMacedonianLyrics)) {
+                                    romanizeMacedonianLyrics ||
+                                    romanizeChineseLyrics)) {
                             // Show romanized text if available
                             val romanizedText by item.romanizedTextFlow.collectAsState()
                             romanizedText?.let { romanized ->

app/src/main/kotlin/com/metrolist/music/ui/screens/settings/RomanizationSettings.kt

@@ -56,6 +56,7 @@ fun RomanizationSettings(
 
     val (lyricsRomanizeJapanese, onLyricsRomanizeJapaneseChange) = rememberPreference(LyricsRomanizeJapaneseKey, defaultValue = true)
     val (lyricsRomanizeKorean, onLyricsRomanizeKoreanChange) = rememberPreference(LyricsRomanizeKoreanKey, defaultValue = true)
+    val (lyricsRomanizeChinese, onLyricsRomanizeChineseChange) = rememberPreference(LyricsRomanizeChineseKey, defaultValue = true)
     val (lyricsRomanizeRussian, onLyricsRomanizeRussianChange) = rememberPreference(LyricsRomanizeRussianKey, defaultValue = true)
     val (lyricsRomanizeUkrainian, onLyricsRomanizeUkrainianChange) = rememberPreference(LyricsRomanizeUkrainianKey, defaultValue = true)
     val (lyricsRomanizeSerbian, onLyricsRomanizeSerbianChange) = rememberPreference(LyricsRomanizeSerbianKey, defaultValue = true)
@@ -87,6 +88,13 @@ fun RomanizationSettings(
             onCheckedChange = onLyricsRomanizeKoreanChange,
         )
 
+        SwitchPreference(
+            title = { Text(stringResource(R.string.lyrics_romanize_chinese)) },
+            icon = { Icon(painterResource(R.drawable.language), null) },
+            checked = lyricsRomanizeChinese,
+            onCheckedChange = onLyricsRomanizeChineseChange,
+        )
+
         PreferenceGroupTitle(title = stringResource(R.string.lyrics_romanization_cyrillic))
         SwitchPreference(
             title = { Text(stringResource(R.string.lyrics_romanize_russian)) },

app/src/main/res/values/metrolist_strings.xml

@@ -217,6 +217,7 @@
     <string name="romanization">Romanization</string>
     <string name="lyrics_romanize_japanese">Romanize Japanese lyrics</string>
     <string name="lyrics_romanize_korean">Romanize Korean lyrics</string>
+    <string name="lyrics_romanize_chinese">Romanize Chinese lyrics</string>
     <string name="lyrics_romanize_russian">Romanize Russian lyrics</string>
     <string name="lyrics_romanize_ukrainian">Romanize Ukrainian lyrics</string>
     <string name="lyrics_romanize_belarusian">Romanize Belarusian lyrics</string>

build.gradle.kts

@@ -8,6 +8,7 @@ buildscript {
         google()
         mavenCentral()
         maven { setUrl("https://jitpack.io") }
+        maven { setUrl("https://maven.aliyun.com/repository/public") }
     }
     dependencies {
         classpath(libs.gradle)

gradle/libs.versions.toml

@@ -35,6 +35,7 @@ timber = "5.0.1"
 materialKolor = "4.0.5"
 kuromojiIpadic = "0.9.0"
 extractor = "a194151"
+tinypinyin = "2.0.3"
 
 [libraries]
 annotation = { module = "androidx.annotation:annotation", version.ref = "annotation" }
@@ -113,6 +114,7 @@ multidex = { module = "androidx.multidex:multidex", version.ref = "multidex" }
 extractor = { module = "com.github.mostafaalagamy:MetrolistExtractor", version.ref = "extractor" }
 
 kuromoji-ipadic = { module = "com.atilika.kuromoji:kuromoji-ipadic", version.ref = "kuromojiIpadic" }
+tinypinyin = { module = "com.github.promeG:tinypinyin", version.ref = "tinypinyin" }
 
 [plugins]
 compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }

settings.gradle.kts

@@ -7,6 +7,7 @@ dependencyResolutionManagement {
         google()
         mavenCentral()
         maven { setUrl("https://jitpack.io") }
+        maven { setUrl("https://maven.aliyun.com/repository/public") }
     }
 }