Skip to content

Unofficial YouTube Music / Spotify Premium client for Android, built in Liquid Glass. Audio effects, Spotify Connect, listening history, 8 languages. Rust core on librespot.

Local files in Spotify playlists play from the phone

Lelonio5757dd2e9e80
diff --git a/app/src/main/java/dev/lelonio/square/data/GatewayTracks.kt b/app/src/main/java/dev/lelonio/square/data/GatewayTracks.kt
index 2db0ac3..b2a7f22 100644
--- a/app/src/main/java/dev/lelonio/square/data/GatewayTracks.kt
+++ b/app/src/main/java/dev/lelonio/square/data/GatewayTracks.kt
@@ -19,8 +19,26 @@ internal object GatewayTracks {
* local file, something this market has no licensed copy of. Keeping those
* would put items in the queue that the engine could only skip.
*/
+ /**
+ * A local file in a playlist: its tags as the computer that added it had
+ * them, and a `spotify:local:` URI that only describes it. Which file on
+ * this phone it is, if any, is decided later; see LocalLibrary.match.
+ */
+ private fun localTrack(data: JSONObject, addedAt: String?): CatalogTrack? {
+ val uri = data.optString("uri").takeIf(LocalLibrary::isSpotifyLocal) ?: return null
+ return CatalogTrack(
+ uri = uri,
+ name = data.optString("name"),
+ artist = data.optString("artistName"),
+ album = data.optString("albumName"),
+ durationMs = data.optJSONObject("localTrackDuration")?.optLong("totalMilliseconds") ?: 0L,
+ addedAt = addedAt,
+ )
+ }
+
fun track(data: JSONObject?, addedAt: String?): CatalogTrack? {
if (data == null) return null
+ if (data.optString("__typename") == "LocalTrack") return localTrack(data, addedAt)
val uri = data.optString("uri").takeIf { it.startsWith("spotify:track:") } ?: return null
if (data.optJSONObject("playability")?.optBoolean("playable", true) == false) return null
diff --git a/app/src/main/java/dev/lelonio/square/data/LocalLibrary.kt b/app/src/main/java/dev/lelonio/square/data/LocalLibrary.kt
index 81afad7..8d952d9 100644
--- a/app/src/main/java/dev/lelonio/square/data/LocalLibrary.kt
+++ b/app/src/main/java/dev/lelonio/square/data/LocalLibrary.kt
@@ -73,6 +73,51 @@ object LocalLibrary {
fun isLocal(uri: String): Boolean = uri.startsWith(PREFIX)
+ /**
+ * How Spotify writes a local file into a playlist:
+ * `spotify:local:artist:album:title:seconds`.
+ *
+ * Not a file anywhere, only a description of one: every device looks for
+ * a file of its own that fits it, and shows the entry greyed out when it
+ * has none. See [match].
+ */
+ const val SPOTIFY_PREFIX = "spotify:local:"
+
+ fun isSpotifyLocal(uri: String): Boolean = uri.startsWith(SPOTIFY_PREFIX)
+
+ /**
+ * The file on this phone that a playlist's local entry describes, or null.
+ *
+ * By title and artist first, then by title alone, then by the title without
+ * what is in brackets: the entry carries the tags of the file on the
+ * computer it was added from, and the copy on the phone is often tagged a
+ * little differently — "Max Pezzali" where the computer had "Max Pezzali /
+ * 883", "Domo Mia" without the "(Feat. …)". Every step also wants the length
+ * within a few seconds, so a song does not land on its live version.
+ */
+ fun match(entry: CatalogTrack, files: List<CatalogTrack>): CatalogTrack? {
+ fun close(file: CatalogTrack) = entry.durationMs <= 0 || file.durationMs <= 0 ||
+ kotlin.math.abs(file.durationMs - entry.durationMs) <= MATCH_SLACK_MS
+ val title = normal(entry.name)
+ val artist = normal(entry.artist)
+ val base = normal(bare(entry.name))
+ return files.firstOrNull { normal(it.name) == title && normal(it.artist) == artist && close(it) }
+ ?: files.firstOrNull { normal(it.name) == title && close(it) }
+ ?: files.firstOrNull { normal(bare(it.name)) == base && close(it) }
+ }
+
+ /** Letters and digits only, without accents and case. */
+ private fun normal(text: String): String =
+ java.text.Normalizer.normalize(text, java.text.Normalizer.Form.NFD)
+ .filter { it.isLetterOrDigit() }
+ .lowercase()
+
+ /** The title before any bracket or " - ", where versions and guests go. */
+ private fun bare(title: String): String =
+ title.substringBefore('(').substringBefore('[').substringBefore(" - ")
+
+ private const val MATCH_SLACK_MS = 3_000L
+
/**
* The content URI a player can open.
*
diff --git a/app/src/main/java/dev/lelonio/square/data/PlaylistContents.kt b/app/src/main/java/dev/lelonio/square/data/PlaylistContents.kt
index b5fa55c..46028ba 100644
--- a/app/src/main/java/dev/lelonio/square/data/PlaylistContents.kt
+++ b/app/src/main/java/dev/lelonio/square/data/PlaylistContents.kt
@@ -27,7 +27,8 @@ object PlaylistContents {
val read = (0 until items.length()).mapNotNull { index ->
val item = items.optJSONObject(index) ?: return@mapNotNull null
// Episodes come through here too, wrapped in a different type, and
- // GatewayTracks turns down anything without a track URI anyway.
+ // GatewayTracks turns down anything that is neither a track nor a
+ // local file.
GatewayTracks.track(
item.optJSONObject("itemV2")?.optJSONObject("data"),
addedAt = item.optJSONObject("addedAt")
diff --git a/app/src/main/java/dev/lelonio/square/ui/MainActivity.kt b/app/src/main/java/dev/lelonio/square/ui/MainActivity.kt
index 80e4528..8dc46bd 100644
--- a/app/src/main/java/dev/lelonio/square/ui/MainActivity.kt
+++ b/app/src/main/java/dev/lelonio/square/ui/MainActivity.kt
@@ -325,13 +325,21 @@ class MainActivity : ComponentActivity() {
// like the download had failed rather than like the song after it was
// never here. Files on the phone play in every mode; they were never
// coming over the network.
- val playable = if (!dev.lelonio.square.playback.OfflineMode.active.value) {
+ val reachable = if (!dev.lelonio.square.playback.OfflineMode.active.value) {
tracks
} else {
val here = (application as dev.lelonio.square.SquareApplication)
.downloads.files.value
tracks.filter { it.uri.startsWith("local:") || it.uri in here }
}
+
+ // One player plays a queue: Spotify's engine or the phone's own files,
+ // not both. A Spotify playlist with local files in it plays whichever
+ // kind was tapped, and the other kind waits for its own tap; an entry
+ // with no file on this phone plays as neither.
+ val local = dev.lelonio.square.data.LocalLibrary
+ val tappedLocal = tracks.getOrNull(index)?.uri?.let(local::isLocal) == true
+ val playable = reachable.filter { !local.isSpotifyLocal(it.uri) && local.isLocal(it.uri) == tappedLocal }
if (playable.isEmpty()) return
// The song that was tapped keeps its place, wherever the filtering left
@@ -341,7 +349,13 @@ class MainActivity : ComponentActivity() {
val start = playable.indexOfFirst { it.uri == wanted }.coerceAtLeast(0)
player.setMediaItems(
- playable.map { toMediaItem(it, contextUri, asContext, contextLabel) },
+ // The phone's files out of a Spotify playlist are not that
+ // playlist to the engine, which would load the context from
+ // Spotify and play its tracks instead.
+ playable.map {
+ val spotifyContext = tappedLocal && contextUri?.startsWith("spotify:") == true
+ toMediaItem(it, contextUri.takeUnless { spotifyContext }, asContext && !spotifyContext, contextLabel)
+ },
start,
positionMs,
)
diff --git a/app/src/main/java/dev/lelonio/square/ui/MainViewModel.kt b/app/src/main/java/dev/lelonio/square/ui/MainViewModel.kt
index c5bf12c..4c332e0 100644
--- a/app/src/main/java/dev/lelonio/square/ui/MainViewModel.kt
+++ b/app/src/main/java/dev/lelonio/square/ui/MainViewModel.kt
@@ -2443,7 +2443,8 @@ class MainViewModel(app: Application) : AndroidViewModel(app) {
* half a second and vanishing. Neither field is ever cleared here: an empty
* name and a missing picture mean "not known yet", never "gone".
*/
- private fun publishPlaylist(state: PlaylistState) {
+ private fun publishPlaylist(published: PlaylistState) {
+ val state = published.copy(tracks = withDeviceFiles(published.tracks))
val current = _playlist.value
_playlist.value = if (current.uri != state.uri) {
state
@@ -3427,7 +3428,38 @@ class MainViewModel(app: Application) : AndroidViewModel(app) {
_pageDepth.value = 0
}
+ /**
+ * The phone's own music, read when a page opens, for the local files a
+ * Spotify playlist names; see [withDeviceFiles].
+ */
+ @Volatile
+ private var deviceFiles: List<CatalogTrack> = emptyList()
+
+ /**
+ * A playlist's local entries, swapped for the files on this phone they
+ * describe. The playlist's own name for each is kept, and the file's URI
+ * is what plays; an entry with no file here stays as it came, and the page
+ * shows it greyed out, as Spotify's own apps do.
+ */
+ private fun withDeviceFiles(tracks: List<CatalogTrack>): List<CatalogTrack> {
+ if (tracks.none { LocalLibrary.isSpotifyLocal(it.uri) }) return tracks
+ val files = deviceFiles
+ return tracks.map { track ->
+ if (!LocalLibrary.isSpotifyLocal(track.uri)) return@map track
+ LocalLibrary.match(track, files)
+ ?.let { file -> track.copy(uri = file.uri, artworkUrl = track.artworkUrl ?: file.artworkUrl) }
+ ?: track
+ }
+ }
+
fun openPlaylist(playlist: CatalogPlaylist) {
+ // Read again on every page: a file copied to the phone since the last
+ // one should be found the next time its playlist is opened.
+ viewModelScope.launch {
+ deviceFiles = LocalLibrary.tracks(getApplication())
+ val shown = _playlist.value
+ if (shown.tracks.any { LocalLibrary.isSpotifyLocal(it.uri) }) publishPlaylist(shown)
+ }
// What is on screen now, if it is a different page and a real one. The
// list is kept whole rather than re-resolved on the way back: an artist
// page is four requests and a discography, and walking back into it
@@ -4080,7 +4112,7 @@ class MainViewModel(app: Application) : AndroidViewModel(app) {
val backend = container.activeBackend
return backend.owns(it) && when (backend.id) {
// The official SDK streams and keeps nothing; see WebSdkRecovery.inUse.
- BackendId.SPOTIFY -> it.startsWith("spotify:") &&
+ BackendId.SPOTIFY -> it.startsWith("spotify:") && !LocalLibrary.isSpotifyLocal(it) &&
!dev.lelonio.square.playback.websdk.WebSdkRecovery.inUse.value
BackendId.YOUTUBE_MUSIC -> true
}
@@ -4297,7 +4329,10 @@ class MainViewModel(app: Application) : AndroidViewModel(app) {
// that the engine can only skip.
loaded += page.items.mapNotNull { item ->
item.track
- ?.takeIf { it.isPlayable != false && it.uri.startsWith("spotify:track:") }
+ ?.takeIf {
+ (it.isPlayable != false && it.uri.startsWith("spotify:track:")) ||
+ LocalLibrary.isSpotifyLocal(it.uri)
+ }
?.toCatalogTrack(item.addedAt)
}
offset += page.items.size
diff --git a/app/src/main/java/dev/lelonio/square/ui/library/PlaylistScreen.kt b/app/src/main/java/dev/lelonio/square/ui/library/PlaylistScreen.kt
index 8ee3797..fb48362 100644
--- a/app/src/main/java/dev/lelonio/square/ui/library/PlaylistScreen.kt
+++ b/app/src/main/java/dev/lelonio/square/ui/library/PlaylistScreen.kt
@@ -127,6 +127,7 @@ import com.adamglin.phosphoricons.Bold
import com.adamglin.phosphoricons.Regular
import com.adamglin.phosphoricons.regular.CaretRight
import com.adamglin.phosphoricons.fill.ArrowCircleDown
+import com.adamglin.phosphoricons.fill.FloppyDisk
import com.adamglin.phosphoricons.fill.Check
import com.adamglin.phosphoricons.fill.MagnifyingGlass
import com.adamglin.phosphoricons.fill.Play
@@ -934,7 +935,10 @@ fun PlaylistScreen(
download = trackDownload(track),
// The phone's own files play offline like anything
// else — they were never coming over the network.
- unavailable = offline &&
+ // A local file the playlist names and this phone
+ // does not have is greyed out, as on Spotify.
+ unavailable = dev.lelonio.square.data.LocalLibrary.isSpotifyLocal(track.uri) ||
+ offline &&
!track.uri.startsWith("local:") &&
trackDownload(track) !=
dev.lelonio.square.data.DownloadState.Done,
@@ -2894,7 +2898,22 @@ private fun TrackRow(
// downloads existed — no greyed-out placeholder, nothing to
// read past. Starting a download is the row menu's job, so this
// never needs to be a target.
- DownloadMark(download)
+ // A file on the phone, or one a Spotify playlist names: never
+ // downloaded, so it gets its own mark rather than the arrow.
+ if (dev.lelonio.square.data.LocalLibrary.isLocal(track.uri) ||
+ dev.lelonio.square.data.LocalLibrary.isSpotifyLocal(track.uri)
+ ) {
+ Icon(
+ PhosphorIcons.Fill.FloppyDisk,
+ contentDescription = stringResource(R.string.local_file),
+ tint = MaterialTheme.colorScheme.onSurfaceVariant,
+ modifier = Modifier
+ .padding(end = 6.dp)
+ .size(14.dp),
+ )
+ } else {
+ DownloadMark(download)
+ }
// The rating before the names, where every other client puts
// it, and only on the rows that carry one.
if (track.explicit) {
diff --git a/app/src/main/res/values-de/strings.xml b/app/src/main/res/values-de/strings.xml
index b6530a2..00b49b4 100644
--- a/app/src/main/res/values-de/strings.xml
+++ b/app/src/main/res/values-de/strings.xml
@@ -394,6 +394,7 @@
<string name="playback_refused">Spotify lässt gerade keine Songs abspielen. Versuch es in ein paar Minuten noch einmal. Wenn es weiter passiert, melde dich ab und wieder an.</string>
<string name="playback_refused_account">Spotify lässt dieses Konto in Apps wie Square keine Songs abspielen. Das liegt nicht an der App; mit einem anderen Premium-Konto kann es funktionieren.</string>
<string name="downloaded">Heruntergeladen</string>
+ <string name="local_file">Lokale Datei</string>
<string name="downloading">Wird heruntergeladen</string>
<string name="downloads">Downloads</string>
<string name="download_count">%1$d heruntergeladen</string>
diff --git a/app/src/main/res/values-es/strings.xml b/app/src/main/res/values-es/strings.xml
index 1b86009..40c8bab 100644
--- a/app/src/main/res/values-es/strings.xml
+++ b/app/src/main/res/values-es/strings.xml
@@ -394,6 +394,7 @@
<string name="playback_refused">Spotify no permite reproducir canciones en este momento. Vuelve a intentarlo en unos minutos. Si sigue pasando, cierra sesión y vuelve a entrar.</string>
<string name="playback_refused_account">Spotify no permite que esta cuenta reproduzca canciones en apps como Square. No depende de la app; con otra cuenta Premium puede funcionar.</string>
<string name="downloaded">Descargado</string>
+ <string name="local_file">Archivo local</string>
<string name="downloading">Descargando</string>
<string name="downloads">Descargas</string>
<string name="download_count">%1$d descargados</string>
diff --git a/app/src/main/res/values-fr/strings.xml b/app/src/main/res/values-fr/strings.xml
index 9d54554..4e99014 100644
--- a/app/src/main/res/values-fr/strings.xml
+++ b/app/src/main/res/values-fr/strings.xml
@@ -394,6 +394,7 @@
<string name="playback_refused">Spotify ne permet pas de lire des titres pour le moment. Réessaie dans quelques minutes. Si ça continue, déconnecte-toi puis reconnecte-toi.</string>
<string name="playback_refused_account">Spotify ne permet pas à ce compte de lire des titres dans des applis comme Square. Cela ne dépend pas de l\'appli ; un autre compte Premium peut fonctionner.</string>
<string name="downloaded">Téléchargé</string>
+ <string name="local_file">Fichier local</string>
<string name="downloading">Téléchargement</string>
<string name="downloads">Téléchargements</string>
<string name="download_count">%1$d téléchargés</string>
diff --git a/app/src/main/res/values-hi/strings.xml b/app/src/main/res/values-hi/strings.xml
index 7b38864..3d0ec55 100644
--- a/app/src/main/res/values-hi/strings.xml
+++ b/app/src/main/res/values-hi/strings.xml
@@ -409,6 +409,7 @@
<string name="playback_refused">Spotify अभी गाने चलाने नहीं दे रहा है। कुछ मिनट बाद फिर कोशिश करें। अगर ऐसा होता रहे, तो साइन आउट करके फिर से साइन इन करें।</string>
<string name="playback_refused_account">Spotify इस खाते को Square जैसे ऐप में गाने चलाने नहीं देता। यह ऐप की वजह से नहीं है; किसी दूसरे Premium खाते से चल सकता है।</string>
<string name="downloaded">डाउनलोड किया</string>
+ <string name="local_file">स्थानीय फ़ाइल</string>
<string name="downloading">डाउनलोड हो रहा है</string>
<string name="downloads">डाउनलोड</string>
<string name="download_count">%1$d डाउनलोड</string>
diff --git a/app/src/main/res/values-it/strings.xml b/app/src/main/res/values-it/strings.xml
index 08cb2c4..c6f3c21 100644
--- a/app/src/main/res/values-it/strings.xml
+++ b/app/src/main/res/values-it/strings.xml
@@ -395,6 +395,7 @@
<string name="playback_refused">Spotify al momento non permette di riprodurre i brani. Riprova tra qualche minuto. Se continua, esci e accedi di nuovo.</string>
<string name="playback_refused_account">Spotify non permette a questo account di riprodurre brani in app come Square. Non dipende dall\'app: con un altro account Premium potrebbe funzionare.</string>
<string name="downloaded">Scaricato</string>
+ <string name="local_file">File locale</string>
<string name="downloading">Download in corso</string>
<string name="downloads">Download</string>
<string name="download_count">%1$d scaricati</string>
diff --git a/app/src/main/res/values-pt/strings.xml b/app/src/main/res/values-pt/strings.xml
index 17db49e..d9c4f3d 100644
--- a/app/src/main/res/values-pt/strings.xml
+++ b/app/src/main/res/values-pt/strings.xml
@@ -394,6 +394,7 @@
<string name="playback_refused">O Spotify não está deixando tocar músicas agora. Tente de novo em alguns minutos. Se continuar, saia e entre de novo na conta.</string>
<string name="playback_refused_account">O Spotify não deixa esta conta tocar músicas em apps como o Square. Isso não depende do app; com outra conta Premium pode funcionar.</string>
<string name="downloaded">Baixado</string>
+ <string name="local_file">Arquivo local</string>
<string name="downloading">Baixando</string>
<string name="downloads">Downloads</string>
<string name="download_count">%1$d baixados</string>
diff --git a/app/src/main/res/values-ru/strings.xml b/app/src/main/res/values-ru/strings.xml
index 6226fc1..8424baf 100644
--- a/app/src/main/res/values-ru/strings.xml
+++ b/app/src/main/res/values-ru/strings.xml
@@ -411,6 +411,7 @@
<string name="playback_refused">Сейчас Spotify не даёт воспроизводить треки. Попробуйте ещё раз через несколько минут. Если не поможет, выйдите из аккаунта и войдите снова.</string>
<string name="playback_refused_account">Spotify не разрешает этому аккаунту воспроизводить треки в приложениях вроде Square. Приложение тут ни при чём; с другим аккаунтом Premium может работать.</string>
<string name="downloaded">Скачано</string>
+ <string name="local_file">Локальный файл</string>
<string name="downloading">Загрузка</string>
<string name="downloads">Загрузки</string>
<string name="download_count">Скачано: %1$d</string>
diff --git a/app/src/main/res/values-tr/strings.xml b/app/src/main/res/values-tr/strings.xml
index 028de90..9684b59 100644
--- a/app/src/main/res/values-tr/strings.xml
+++ b/app/src/main/res/values-tr/strings.xml
@@ -409,6 +409,7 @@
<string name="playback_refused">Spotify şu anda şarkı çalmaya izin vermiyor. Birkaç dakika sonra tekrar dene. Devam ederse çıkış yapıp yeniden giriş yap.</string>
<string name="playback_refused_account">Spotify bu hesabın Square gibi uygulamalarda şarkı çalmasına izin vermiyor. Bu uygulamadan kaynaklanmıyor; başka bir Premium hesapla çalışabilir.</string>
<string name="downloaded">İndirildi</string>
+ <string name="local_file">Yerel dosya</string>
<string name="downloading">İndiriliyor</string>
<string name="downloads">İndirilenler</string>
<string name="download_count">%1$d indirildi</string>
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
index ed478dc..f781fcd 100644
--- a/app/src/main/res/values/strings.xml
+++ b/app/src/main/res/values/strings.xml
@@ -415,6 +415,7 @@
<string name="playback_refused">Spotify isn\'t letting songs play right now. Try again in a few minutes. If it keeps happening, sign out and sign in again.</string>
<string name="playback_refused_account">Spotify doesn\'t let this account play songs in apps like Square. It isn\'t something the app can fix; another Premium account may work.</string>
<string name="downloaded">Downloaded</string>
+ <string name="local_file">Local file</string>
<string name="downloading">Downloading</string>
<string name="downloads">Downloads</string>
<string name="download_count">%1$d downloaded</string>