Native Android client for Spotify, built with Jetpack Compose
Kotlin ad-freeadblockandroidjetpack-composekotlinlyricsmusic-playermusic-videomyspotispotifyspotify-adblockerspotify-clientspotify-connectspotui
Playlists, albums and Liked Songs can be queued whole: Play next and Add to queue in their options and in the Library's long press, each song through the player that can play it
kota-zofee4c5cc4f07
diff --git a/base/app/src/main/java/com/music/spotui/di/CollectionQueue.kt b/base/app/src/main/java/com/music/spotui/di/CollectionQueue.ktnew file mode 100644index 00000000..a002f23c--- /dev/null+++ b/base/app/src/main/java/com/music/spotui/di/CollectionQueue.kt@@ -0,0 +1,63 @@+package com.music.spotui.di++import android.widget.Toast+import app.myspoti.engine.R+import com.music.spotui.data.entity.ContextPageModel+import com.music.spotui.data.entity.SongsModel+import com.music.spotui.data.api.Response+import com.music.spotui.ui.screens.TrackOrder+import kotlinx.coroutines.CoroutineScope+import kotlinx.coroutines.Dispatchers+import kotlinx.coroutines.SupervisorJob+import kotlinx.coroutines.flow.first+import kotlinx.coroutines.launch+import kotlinx.coroutines.withContext+import kotlinx.coroutines.withTimeoutOrNull++/**+ * "Play next" / "Add to queue" on a playlist, an album or Liked Songs. The songs are the whole+ * list (a big playlist that has not finished loading is read to its end first), in the order the+ * list is played in (the user's sort for it), and [SongPlayer.queueSongs] sends each to the queue+ * that can play it. Runs in the app's own scope: closing the menu does not cancel it.+ *+ * Like the single-song action, nothing is started when nothing plays: Spotify keeps the queued+ * songs for the next play.+ */+object CollectionQueue {+ private val scope = CoroutineScope(SupervisorJob() + Dispatchers.Default)+ private const val READ_MS = 120_000L++ /** [known]: the page on screen; used as it is when complete, else the list is read from [uri]. */+ fun queue(uri: String, next: Boolean, known: ContextPageModel? = null) {+ val app = Graph.app+ scope.launch {+ val shown = known?.takeIf { it.complete }+ if (shown == null) withContext(Dispatchers.Main) { Toast.makeText(app, R.string.add_collection_reading, Toast.LENGTH_SHORT).show() }+ val songs = shown?.tracks ?: read(uri)+ val list = songs?.let { TrackOrder.load(app, uri).apply(it) }.orEmpty()+ if (list.isEmpty()) {+ withContext(Dispatchers.Main) { Toast.makeText(app, if (songs == null) R.string.page_load_failed else R.string.queue_list_none, Toast.LENGTH_SHORT).show() }+ return@launch+ }+ SongPlayer.queueSongs(list, next) { count ->+ val text = if (count == 0) app.getString(R.string.queue_list_none)+ else app.resources.getQuantityString(if (next) R.plurals.queue_list_next else R.plurals.queue_list_added, count, count)+ Toast.makeText(app, text, Toast.LENGTH_SHORT).show()+ }+ }+ }++ /** Every song of the playlist, album or Liked Songs [uri]; null when it cannot be read. */+ private suspend fun read(uri: String): List<SongsModel>? {+ val api = Graph.api+ val id = uri.substringAfterLast(':')+ val flow = when {+ uri.startsWith("spotify:album:") -> api.getAlbumPage(id)+ uri == "spotify:collection:tracks" -> api.getLikedPage()+ uri.startsWith("spotify:playlist:") -> api.getPlaylistPage(id)+ else -> return null+ }+ val last = withTimeoutOrNull(READ_MS) { flow.first { it is Response.Error || (it is Response.Success && it.data.complete) } }+ return (last as? Response.Success)?.data?.tracks+ }+}diff --git a/base/app/src/main/java/com/music/spotui/di/LocalPlayer.kt b/base/app/src/main/java/com/music/spotui/di/LocalPlayer.ktindex 119a0bb3..1f2a5ec3 100644--- a/base/app/src/main/java/com/music/spotui/di/LocalPlayer.kt+++ b/base/app/src/main/java/com/music/spotui/di/LocalPlayer.kt@@ -454,6 +454,22 @@ object LocalPlayer {publish()}+ /**+ * [enqueue] for a whole list, in the list's order: one insertion and one report (a long list+ * added song by song re-published the queue for each). Copies, so a song twice in [list] is two+ * queue rows ([queued] holds items by identity).+ */+ fun enqueueAll(list: List<LocalTrack>, next: Boolean) {+ val p = exo ?: return+ if (list.isEmpty()) return+ val songs = list.map { it.copy() }+ val at = LocalQueueOrder.insertIndex(tracks, p.currentMediaItemIndex, next, isQueued)+ queued += songs+ p.addMediaItems(at, songs.map(::item))+ tracks.addAll(at, songs)+ publish()+ }+/** "Clear queue": the songs the user queued go; the list's own stay. */fun clearQueued() {val p = exo ?: returndiff --git a/base/app/src/main/java/com/music/spotui/di/SongPlayer.kt b/base/app/src/main/java/com/music/spotui/di/SongPlayer.ktindex 93df4330..4a82e8a9 100644--- a/base/app/src/main/java/com/music/spotui/di/SongPlayer.kt+++ b/base/app/src/main/java/com/music/spotui/di/SongPlayer.kt@@ -15,7 +15,11 @@ import app.myspoti.host.android.MyspotiRuntimeimport app.myspoti.host.android.NowPlayingInfoimport app.myspoti.host.android.PlaybackServiceimport com.music.spotui.data.entity.SongsModel+import com.music.spotui.data.local.LocalFileMatch.isDeviceFile+import com.music.spotui.data.local.LocalFileMatch.isUnmatchedLocalimport kotlinx.coroutines.Deferred+import kotlinx.coroutines.Dispatchers+import kotlinx.coroutines.withContextimport kotlinx.coroutines.asyncimport kotlinx.coroutines.launchimport kotlinx.coroutines.flow.collectLatest@@ -2149,6 +2153,57 @@ object SongPlayer {}}+ /** Songs per call of Spotify's queue: a whole playlist in one call is a long wait for the page. */+ private const val QUEUE_BATCH = 100++ /**+ * "Play next" / "Add to queue" for a whole list, in the list's order; [done] is told how many+ * songs joined a queue (on the main thread). Every song goes where its single-song action+ * would send it: while the local player plays, a device file, a download or an extension's song+ * joins the local queue and the others Spotify's; otherwise Spotify's queue takes everything it+ * can stream (tracks and episodes). A device file cannot be streamed by Spotify: it is left+ * out then, as a Spotify local file nothing matched and a greyed song are. The two queues+ * are separate, so a mixed list is split between them, each part in order.+ */+ fun queueSongs(songs: List<SongsModel>, next: Boolean, done: (Int) -> Unit) {+ Haptics.confirm()+ scope.launch {+ val local = LocalPlayer.active.value+ val rows = songs.filter { it.playable && !it.isUnmatchedLocal }+ val files = if (local && rows.any { it.isDeviceFile })+ runCatching { com.music.spotui.data.local.LocalMusic.tracks(Graph.app) }.getOrDefault(emptyList()).associateBy { com.music.spotui.data.local.LocalFileMatch.key(it) }+ else emptyMap()+ val toLocal = ArrayList<com.music.spotui.data.local.LocalTrack>()+ val toSpotify = ArrayList<String>()+ for (s in rows) {+ val uri = when {+ s.isDeviceFile -> { if (local) files[s.url]?.let { toLocal += it }; continue }+ s.url.startsWith("episode:") -> "spotify:episode:" + s.url.removePrefix("episode:")+ s.spotifyTrackId.isNotBlank() -> SPOTIFY_TRACK_PREFIX + s.spotifyTrackId+ else -> continue+ }+ val own = if (local && !s.url.startsWith("episode:")) com.music.spotui.extensions.ExtensionAudio.queueTrack(s) else null+ if (own != null) toLocal += own else toSpotify += uri+ }+ if (toLocal.isNotEmpty()) withContext(Dispatchers.Main) { LocalPlayer.enqueueAll(toLocal, next) }+ if (toSpotify.isNotEmpty()) {+ val batches = toSpotify.chunked(QUEUE_BATCH)+ queueCommand {+ if (!next) batches.forEach { api.player.addToQueue(it) }+ // Each batch goes in front of the one sent before it, so the last is sent first;+ // Spotify's queue is shown again between two (playNext reads its first row).+ else batches.asReversed().forEachIndexed { i, batch ->+ val before = api.player.queue.value+ api.player.playNext(batch)+ if (i < batches.lastIndex) awaitQueue { it !== before }+ }+ }+ }+ val count = toLocal.size + toSpotify.size+ withContext(Dispatchers.Main) { done(count) }+ }+ }+fun skipTo(item: QueueItem) {if (item.provider == LOCAL) { item.uid.toIntOrNull()?.let(LocalPlayer::skipTo); return }cancelBurst()diff --git a/base/app/src/main/java/com/music/spotui/extensions/ExtensionAudio.kt b/base/app/src/main/java/com/music/spotui/extensions/ExtensionAudio.ktindex 6f5bb70c..953c7084 100644--- a/base/app/src/main/java/com/music/spotui/extensions/ExtensionAudio.kt+++ b/base/app/src/main/java/com/music/spotui/extensions/ExtensionAudio.kt@@ -207,6 +207,14 @@ object ExtensionAudio {return true}+ /**+ * [enqueue] for a song the caller already has (a list being queued): no look-up. Its download,+ * else the extension's stream; null when neither has it, Spotify's queue takes it then.+ */+ fun queueTrack(s: SongsModel): LocalTrack? =+ OfflineStore.tracks[s.spotifyTrackId]?.takeIf { OfflineStore.isDownloaded(s.spotifyTrackId) }?.let(OfflineStore::toLocalTrack)+ ?: if (Extensions.hasAudioSource()) localTrack(s) else null+/** The song's title, artists, album and length from Spotify, for a play that knows only its uri. */private suspend fun lookup(trackId: String): SongsModel? = runCatching {kotlinx.coroutines.withTimeout(LOOKUP_MS) {diff --git a/base/app/src/main/java/com/music/spotui/ui/components/AddCollectionToPlaylistSheet.kt b/base/app/src/main/java/com/music/spotui/ui/components/AddCollectionToPlaylistSheet.ktindex a7124893..7f6cdb84 100644--- a/base/app/src/main/java/com/music/spotui/ui/components/AddCollectionToPlaylistSheet.kt+++ b/base/app/src/main/java/com/music/spotui/ui/components/AddCollectionToPlaylistSheet.kt@@ -143,17 +143,19 @@ fun AddCollectionToPlaylistSheet(sourceUri: String, title: String, onDismiss: ()}}-/** The ⋯ menu of an album page: the album's "Add to playlist". */+/** The ⋯ menu of an album page (or Liked Songs): play it next, queue it, and the album's "Add to playlist". */@OptIn(ExperimentalMaterial3Api::class)@Composable-fun AlbumOptionsSheet(albumUri: String, name: String, onDismiss: () -> Unit) {+fun AlbumOptionsSheet(albumUri: String, name: String, known: com.music.spotui.data.entity.ContextPageModel? = null, onDismiss: () -> Unit) {var adding by remember { mutableStateOf(false) }if (adding) { AddCollectionToPlaylistSheet(albumUri, name, onDismiss); return }com.music.spotui.ui.components.LookSheet(onDismissRequest = onDismiss, containerColor = tone(0xFF282828)) {Column(Modifier.navigationBarsPadding().padding(bottom = 12.dp)) {Text(name, color = AppText, fontSize = 18.sp, fontWeight = FontWeight.Bold, maxLines = 1, overflow = TextOverflow.Ellipsis,modifier = Modifier.padding(20.dp, 0.dp, 20.dp, 8.dp))- OptionRow(Icons.Outlined.AddCircleOutline, stringResource(R.string.context_menu_add_to_playlist)) { adding = true }+ QueueListRows(albumUri, known, onDismiss)+ // Liked Songs has no playlist to copy from: only the albums.+ if (albumUri.startsWith("spotify:album:")) OptionRow(Icons.Outlined.AddCircleOutline, stringResource(R.string.context_menu_add_to_playlist)) { adding = true }}}}diff --git a/base/app/src/main/java/com/music/spotui/ui/components/PlaylistOptionsSheet.kt b/base/app/src/main/java/com/music/spotui/ui/components/PlaylistOptionsSheet.ktindex 34286195..960d4c7e 100644--- a/base/app/src/main/java/com/music/spotui/ui/components/PlaylistOptionsSheet.kt+++ b/base/app/src/main/java/com/music/spotui/ui/components/PlaylistOptionsSheet.kt@@ -27,6 +27,8 @@ import androidx.compose.foundation.layout.widthimport androidx.compose.foundation.shape.RoundedCornerShapeimport androidx.compose.material.icons.Iconsimport androidx.compose.material.icons.filled.Check+import androidx.compose.material.icons.automirrored.outlined.PlaylistPlay+import androidx.compose.material.icons.automirrored.outlined.QueueMusicimport androidx.compose.material.icons.outlined.Deleteimport androidx.compose.material.icons.outlined.Editimport androidx.compose.material.icons.outlined.Group@@ -165,6 +167,8 @@ fun PlaylistOptionsSheet(androidx.compose.material3.HorizontalDivider(color = AppText.copy(alpha = 0.08f))Spacer(Modifier.height(6.dp))val share = { SpotifyCode.show(ShareTarget(page.uri, page.name, page.ownerName, page.coverUri)); onDismiss() }+ // The whole playlist into the queue, in its order (a long one is read to its end first).+ QueueListRows(page.uri, page, onDismiss)// Every song of this playlist into another one of yours (Web Player: "Add playlist to other playlist").if (page.uri.startsWith("spotify:playlist:")) OptionRow(Icons.Outlined.AddCircleOutline, stringResource(R.string.add_playlist_to_playlist)) { mergingInto = true }if (page.isBlend) {@@ -442,3 +446,15 @@ internal fun OptionRow(icon: ImageVector, label: String, enabled: Boolean = true}}+/** "Play next" and "Add to queue" for the whole list [uri]; [known] is its page when the screen has it. */+@Composable+internal fun QueueListRows(uri: String, known: ContextPageModel?, onDismiss: () -> Unit) {+ OptionRow(Icons.AutoMirrored.Outlined.PlaylistPlay, stringResource(R.string.context_menu_play_next)) {+ com.music.spotui.di.CollectionQueue.queue(uri, next = true, known = known)+ onDismiss()+ }+ OptionRow(Icons.AutoMirrored.Outlined.QueueMusic, stringResource(R.string.context_menu_add_to_queue)) {+ com.music.spotui.di.CollectionQueue.queue(uri, next = false, known = known)+ onDismiss()+ }+}diff --git a/base/app/src/main/java/com/music/spotui/ui/immersive/screens/ImmersiveContextScreen.kt b/base/app/src/main/java/com/music/spotui/ui/immersive/screens/ImmersiveContextScreen.ktindex dcf15daa..415cac92 100644--- a/base/app/src/main/java/com/music/spotui/ui/immersive/screens/ImmersiveContextScreen.kt+++ b/base/app/src/main/java/com/music/spotui/ui/immersive/screens/ImmersiveContextScreen.kt@@ -319,7 +319,7 @@ private fun ImmersiveContextContent(navController: NavController, vm: ContextVie}if (addingSongs) com.music.spotui.ui.components.AddSongsScreen(p) { added -> addingSongs = false; if (added) vm.reload() }- if (albumMenu) com.music.spotui.ui.components.AlbumOptionsSheet(p.uri, p.name) { albumMenu = false }+ if (albumMenu) com.music.spotui.ui.components.AlbumOptionsSheet(p.uri, p.name, known = p) { albumMenu = false }if (playlistMenu) com.music.spotui.ui.components.PlaylistOptionsSheet(page = p,onAddSongs = if (p.type == "playlist" && vm.editableContext.value && !p.isBlend) ({ addingSongs = true }) else null,@@ -592,7 +592,7 @@ private fun ImmersiveContextContent(navController: NavController, vm: ContextVieonSort = { sort = it; TrackOrder.save(context, p.uri, it) },)}- if (p.type == "playlist" || p.type == "album") ImmersiveBarAction(+ if (p.type == "playlist" || p.type == "album" || p.type == "liked" || p.type == "liked-artist") ImmersiveBarAction(icon = Icons.Rounded.MoreHoriz,contentDescription = stringResource(R.string.content_description_context_menu),onClick = { if (p.type == "playlist") playlistMenu = true else albumMenu = true },diff --git a/base/app/src/main/java/com/music/spotui/ui/screens/ContextScreen.kt b/base/app/src/main/java/com/music/spotui/ui/screens/ContextScreen.ktindex da37e178..2526f36f 100644--- a/base/app/src/main/java/com/music/spotui/ui/screens/ContextScreen.kt+++ b/base/app/src/main/java/com/music/spotui/ui/screens/ContextScreen.kt@@ -616,7 +616,7 @@ private fun ContextContent(navController: NavController, vm: ContextViewModel, pdismissButton = { androidx.compose.material3.TextButton(onClick = { leaveAsk = false }) { Text(stringResource(R.string.cancel), color = AppText) } },)if (addingSongs) com.music.spotui.ui.components.AddSongsScreen(p) { added -> addingSongs = false; if (added) vm.reload() }- if (albumMenu) com.music.spotui.ui.components.AlbumOptionsSheet(p.uri, p.name) { albumMenu = false }+ if (albumMenu) com.music.spotui.ui.components.AlbumOptionsSheet(p.uri, p.name, known = p) { albumMenu = false }if (playlistMenu) com.music.spotui.ui.components.PlaylistOptionsSheet(page = p,onAddSongs = if (p.type == "playlist" && vm.editableContext.value && !p.isBlend) ({ addingSongs = true }) else null,@@ -876,7 +876,7 @@ private fun ContextContent(navController: NavController, vm: ContextViewModel, p}}}- if (p.type == "playlist" || p.type == "album") {+ if (p.type == "playlist" || p.type == "album" || p.type == "liked" || p.type == "liked-artist") {Spacer(Modifier.width(16.dp))Icon(Icons.Default.MoreVert, stringResource(R.string.content_description_context_menu), tint = AppText.copy(alpha = 0.8f),modifier = Modifier.size(26.dp).pressable(0.9f) { if (p.type == "playlist") playlistMenu = true else albumMenu = true })diff --git a/base/app/src/main/java/com/music/spotui/ui/screens/LibraryExtras.kt b/base/app/src/main/java/com/music/spotui/ui/screens/LibraryExtras.ktindex 82fb1c3f..87923bff 100644--- a/base/app/src/main/java/com/music/spotui/ui/screens/LibraryExtras.kt+++ b/base/app/src/main/java/com/music/spotui/ui/screens/LibraryExtras.kt@@ -35,6 +35,8 @@ import androidx.compose.foundation.shape.RoundedCornerShapeimport androidx.compose.material.icons.Iconsimport androidx.compose.material.icons.automirrored.filled.ArrowBackimport androidx.compose.material.icons.automirrored.filled.PlaylistAdd+import androidx.compose.material.icons.automirrored.outlined.PlaylistPlay+import androidx.compose.material.icons.automirrored.outlined.QueueMusicimport androidx.compose.material.icons.filled.MoreVertimport androidx.compose.material.icons.outlined.CreateNewFolderimport androidx.compose.material.icons.outlined.Delete@@ -608,6 +610,15 @@ fun LibraryItemSheet(entry: LibraryEntry, onDismiss: () -> Unit, onChanged: () -Text(entry.name, color = AppText, fontSize = 18.sp, fontWeight = FontWeight.Bold, maxLines = 1, overflow = androidx.compose.ui.text.style.TextOverflow.Ellipsis,modifier = Modifier.padding(20.dp, 0.dp, 20.dp, 8.dp))if (!moving) {+ // A saved playlist or album: all its songs into the queue (read to the end first).+ if (entry.uri.startsWith("spotify:playlist:") || entry.uri.startsWith("spotify:album:")) {+ SheetRow(Icons.AutoMirrored.Outlined.PlaylistPlay, stringResource(R.string.context_menu_play_next)) {+ com.music.spotui.di.CollectionQueue.queue(entry.uri, next = true); onDismiss()+ }+ SheetRow(Icons.AutoMirrored.Outlined.QueueMusic, stringResource(R.string.context_menu_add_to_queue)) {+ com.music.spotui.di.CollectionQueue.queue(entry.uri, next = false); onDismiss()+ }+ }SheetRow(Icons.Outlined.PushPin, stringResource(if (entry.pinned) R.string.library_unpin else R.string.library_pin)) {act(LibraryEdits.Pin(entry.uri, !entry.pinned)) { if (entry.pinned) api.library.unpin(entry.uri) else api.library.pin(entry.uri) }}diff --git a/base/app/src/main/res/values/myspoti_strings.xml b/base/app/src/main/res/values/myspoti_strings.xmlindex 19294af1..d394c0f5 100644--- a/base/app/src/main/res/values/myspoti_strings.xml+++ b/base/app/src/main/res/values/myspoti_strings.xml@@ -520,6 +520,15 @@<string name="add_collection_reading">Reading the songs…</string><string name="add_collection_nothing">Nothing to add</string><string name="add_collection_done">Added %1$d songs to %2$s</string>+ <plurals name="queue_list_added">+ <item quantity="one">%d song added to queue</item>+ <item quantity="other">%d songs added to queue</item>+ </plurals>+ <plurals name="queue_list_next">+ <item quantity="one">%d song will play next</item>+ <item quantity="other">%d songs will play next</item>+ </plurals>+ <string name="queue_list_none">None of these songs can be queued</string><string name="duplicate_title_some">Some are already added</string><string name="duplicate_title_all">Already added</string><string name="duplicate_text_some">Some of these songs are already in %1$s.</string>