Merge branch 'kerollosy-musixmatch'

Lambada10 · Nov 28, 2024 · dcd538b · dcd538b
2 parents b72e3a2 + b324b63
commit dcd538b
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 17 deletions.
diff --git a/...n/java/pl/lambada/songsync/activities/quicksearch/viewmodel/QuickLyricsSearchViewModel.kt b/...n/java/pl/lambada/songsync/activities/quicksearch/viewmodel/QuickLyricsSearchViewModel.kt
@@ -113,7 +113,7 @@ class QuickLyricsSearchViewModel(
             userSettingsController.selectedProvider,
             userSettingsController.includeTranslation,
             userSettingsController.multiPersonWordByWord,
-            userSettingsController.syncedMusixmatch
+            userSettingsController.unsyncedFallbackMusixmatch
         )
 
     private fun updateScreenState(screenState: ScreenState<SongInfo>) {

diff --git a/app/src/main/java/pl/lambada/songsync/data/UserSettingsController.kt b/app/src/main/java/pl/lambada/songsync/data/UserSettingsController.kt
@@ -37,7 +37,7 @@ class UserSettingsController(private val dataStore: DataStore<Preferences>) {
     var multiPersonWordByWord by mutableStateOf(dataStore.get(multiPersonWordByWordKey, true))
         private set
 
-    var syncedMusixmatch by mutableStateOf(dataStore.get(syncedMusixmatchKey, true))
+    var unsyncedFallbackMusixmatch by mutableStateOf(dataStore.get(unsyncedFallbackMusixmatchKey, true))
         private set
 
     var pureBlack by mutableStateOf(dataStore.get(pureBlackKey, false))
@@ -97,9 +97,9 @@ class UserSettingsController(private val dataStore: DataStore<Preferences>) {
         multiPersonWordByWord = to
     }
 
-    fun updateSyncedMusixmatch(to: Boolean) {
-        dataStore.set(syncedMusixmatchKey, to)
-        syncedMusixmatch = to
+    fun updateUnsyncedFallbackMusixmatch(to: Boolean) {
+        dataStore.set(unsyncedFallbackMusixmatchKey, to)
+        unsyncedFallbackMusixmatch = to
     }
 
     fun updateDisableMarquee(to: Boolean) {
@@ -144,7 +144,7 @@ private val blacklistedFoldersKey = stringPreferencesKey("blacklist")
 private val hideLyricsKey = booleanPreferencesKey("hide_lyrics")
 private val includeTranslationKey = booleanPreferencesKey("include_translation")
 private val multiPersonWordByWordKey = booleanPreferencesKey("multi_person_word_by_word")
-private val syncedMusixmatchKey = booleanPreferencesKey("synced_lyrics")
+private val unsyncedFallbackMusixmatchKey = booleanPreferencesKey("unsynced_lyrics_fallback")
 private val disableMarqueeKey = booleanPreferencesKey("marquee_disable")
 private val pureBlackKey = booleanPreferencesKey("pure_black")
 private val sdCardPathKey = stringPreferencesKey("sd_card_path")

diff --git a/app/src/main/java/pl/lambada/songsync/data/remote/lyrics_providers/LyricsProviderService.kt b/app/src/main/java/pl/lambada/songsync/data/remote/lyrics_providers/LyricsProviderService.kt
@@ -95,7 +95,7 @@ class LyricsProviderService {
         // TODO providers could be a sealed interface to include such parameters
         includeTranslationNetEase: Boolean = false,
         multiPersonWordByWord: Boolean = false,
-        syncedMusixmatch: Boolean = true
+        unsyncedFallbackMusixmatch: Boolean = true
     ): String? {
         return when (provider) {
             Providers.SPOTIFY -> SpotifyLyricsAPI().getSyncedLyrics(songLink!!, version)
@@ -109,7 +109,8 @@ class LyricsProviderService {
             )
 
             Providers.MUSIXMATCH -> MusixmatchAPI().getLyrics(
-                musixmatchSongInfo, syncedMusixmatch
+                musixmatchSongInfo,
+                unsyncedFallbackMusixmatch
             )
         }
     }

diff --git a/app/src/main/java/pl/lambada/songsync/data/remote/lyrics_providers/others/MusixmatchAPI.kt b/app/src/main/java/pl/lambada/songsync/data/remote/lyrics_providers/others/MusixmatchAPI.kt
@@ -63,10 +63,10 @@ class MusixmatchAPI {
     /**
      * Returns the lyrics.
      * @param songInfo The SongInfo of the song from search results.
+     * @param preferUnsynced Flag to prefer unsynced lyrics when synced lyrics are not available.
      * @return The lyrics as a string or null if the lyrics were not found.
      */
-    fun getLyrics(songInfo: SongInfo?, synced: Boolean = true): String? {
-        return if(synced) songInfo?.syncedLyrics
-        else songInfo?.unsyncedLyrics
+    fun getLyrics(songInfo: SongInfo?, preferUnsynced: Boolean = true): String? {
+        return songInfo?.syncedLyrics ?: if (preferUnsynced) songInfo?.unsyncedLyrics else null
     }
 }
diff --git a/app/src/main/java/pl/lambada/songsync/ui/screens/home/HomeViewModel.kt b/app/src/main/java/pl/lambada/songsync/ui/screens/home/HomeViewModel.kt
@@ -283,7 +283,7 @@ class HomeViewModel(
                 provider = userSettingsController.selectedProvider,
                 includeTranslationNetEase = userSettingsController.includeTranslation,
                 multiPersonWordByWord = userSettingsController.multiPersonWordByWord,
-                syncedMusixmatch = userSettingsController.syncedMusixmatch
+                unsyncedFallbackMusixmatch = userSettingsController.unsyncedFallbackMusixmatch
             )
         } catch (e: Exception) {
             null

diff --git a/app/src/main/java/pl/lambada/songsync/ui/screens/lyricsFetch/LyricsFetchViewModel.kt b/app/src/main/java/pl/lambada/songsync/ui/screens/lyricsFetch/LyricsFetchViewModel.kt
@@ -50,7 +50,7 @@ class LyricsFetchViewModel(
             userSettingsController.selectedProvider,
             userSettingsController.includeTranslation,
             userSettingsController.multiPersonWordByWord,
-            userSettingsController.syncedMusixmatch
+            userSettingsController.unsyncedFallbackMusixmatch
         )
 
     fun loadSongInfo(context: Context, tryingAgain: Boolean = false) {

diff --git a/app/src/main/java/pl/lambada/songsync/ui/screens/settings/SettingsScreen.kt b/app/src/main/java/pl/lambada/songsync/ui/screens/settings/SettingsScreen.kt
@@ -102,8 +102,8 @@ fun SettingsScreen(
 
             item {
                 SyncedLyricsSwitch(
-                    selected = userSettingsController.syncedMusixmatch,
-                    onToggle = { userSettingsController.updateSyncedMusixmatch(it) }
+                    selected = userSettingsController.unsyncedFallbackMusixmatch,
+                    onToggle = { userSettingsController.updateUnsyncedFallbackMusixmatch(it) }
                 )
             }
 

diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -128,8 +128,8 @@
     <string name="offset">Offset</string>
     <string name="song_path">Show song path</string>
     <string name="song_path_description">Show the path of a song file on song list</string>
-    <string name="synced_lyrics">Get Synced Lyrics</string>
-    <string name="synced_lyrics_summary">Toggle to switch between synced and unsynced lyrics from Musixmatch.</string>
+    <string name="synced_lyrics">Get Unsynced Lyrics</string>
+    <string name="synced_lyrics_summary">Toggle to get unsynced lyrics from Musixmatch when synced lyrics aren\'t found.</string>
     <string name="title">Title</string>
     <string name="artist">Artist</string>
     <string name="album">Album</string>