Unofficial YouTube Music / Spotify Premium client for Android, built in Liquid Glass. Audio effects, Spotify Connect, listening history, 8 languages. Rust core on librespot.
Kotlin alternativeandroidandroid-applicationclientglassmorphisminnertubelibrespotliquid-glassspotifyspotify-connectspotifyapiyoutube-musicyoutube-playerytdlnis
package dev.lelonio.square.backend.lyrics
import dev.lelonio.square.data.Catalog
import dev.lelonio.square.data.Lyrics
import dev.lelonio.square.download.DownloadExtras
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.withContext
import kotlinx.serialization.json.Json
/**
* The words behind a Spotify track, and the copy kept beside a download.
*
* The chain itself is not new — the TTML archive, then lossless.wtf, then
* Spotify's own — but it now has two callers rather than one: the player, which
* asks when a song starts, and the download queue, which asks so that the same
* song has its words in a tunnel. One function so the two cannot drift: a
* listener who downloads a song and then plays it offline must be shown the
* lyrics they would have been shown online, not a different source's.
*
* Storing is part of asking, for the same reason. Every answer that arrives for
* a downloaded track is written down on the way past — [DownloadExtras] decides
* which tracks those are — so nothing else has to remember to do it, and a song
* whose words were fetched while the player was showing them is a song that
* keeps them.
*/
object SpotifyLyrics {
private val json = Json { ignoreUnknownKeys = true }
/**
* @param allowNetwork false offline, where the only lyrics are the kept ones.
*/
suspend fun lyrics(
uri: String,
title: String,
artist: String,
durationMs: Long,
allowNetwork: Boolean = true,
): Lyrics? {
// Offline: the copy beside a download, or words this phone has shown
// before, which LyricsLibrary kept.
// Either only from the source the listener prefers, if they named one.
if (!allowNetwork) return kept(uri)?.takeIf { LyricsLibrary.shows(uri, it) } ?: LyricsLibrary.cachedLyrics(uri)
// Repeat views cost nothing: LyricsLibrary keeps its answers in memory
// as well as on disk, and a source picked by the listener with them.
kept(uri)?.takeIf { LyricsLibrary.shows(uri, it) }?.let { downloaded ->
// A download's own copy first, at once; and if it is not timed to
// the word, the sources are asked whether one is now.
// Asked too when it does not say which source it is; see
// LyricsLibrary.name.
if (LyricsLibrary.worthAskingAgain(uri, downloaded)) {
LyricsLibrary.improveLater(LyricsQuery(uri, title, artist, durationMs), downloaded)
}
return downloaded
}
// The order, and every source in it, lives in LyricsLibrary, which
// also keeps what it found and the source the listener chose.
val found = LyricsLibrary.lyrics(LyricsQuery(uri, title, artist, durationMs))
return withContext(Dispatchers.IO) {
// Nothing found is an answer worth keeping too, so a downloaded
// song with no words is not looked up again on every turn of the
// queue; see DownloadExtras.note.
if (found == null) {
DownloadExtras.note("lyrics", uri)
return@withContext null
}
if (LyricsLibrary.keptForGood(found)) {
runCatching { DownloadExtras.rememberLyrics(uri, json.encodeToString(found)) }
}
found
}
}
/** What was written down for this track, if it was ever asked about. */
suspend fun kept(uri: String): Lyrics? = withContext(Dispatchers.IO) {
val raw = DownloadExtras.lyrics(uri) ?: return@withContext null
runCatching { json.decodeFromString<Lyrics>(raw) }.getOrNull()
}
}