Refactor QueueEntry design

app/src/main/java/org/jellyfin/androidtv/ui/playback/rewrite/RewriteMediaManager.kt

@@ -25,8 +25,9 @@ import org.jellyfin.playback.core.model.PlayState
 import org.jellyfin.playback.core.model.PlaybackOrder
 import org.jellyfin.playback.core.model.RepeatMode
 import org.jellyfin.playback.core.queue.Queue
-import org.jellyfin.playback.core.queue.item.QueueEntry
-import org.jellyfin.playback.jellyfin.queue.item.BaseItemDtoUserQueueEntry
+import org.jellyfin.playback.core.queue.QueueEntry
+import org.jellyfin.playback.jellyfin.queue.baseItem
+import org.jellyfin.playback.jellyfin.queue.createBaseItemQueueEntry
 import org.jellyfin.sdk.api.client.ApiClient
 import org.jellyfin.sdk.model.api.BaseItemDto
 import kotlin.math.max
@@ -59,7 +60,7 @@ class RewriteMediaManager(
 			?: currentAudioQueue.size()).toString()
 
 	override val currentAudioItem: BaseItemDto?
-		get() = (playbackManager.state.queue.entry.value as? BaseItemDtoUserQueueEntry)?.baseItem
+		get() = playbackManager.state.queue.entry.value?.baseItem
 
 	override fun toggleRepeat(): Boolean {
 		val newMode = when (playbackManager.state.repeatMode.value) {
@@ -277,7 +278,7 @@ class RewriteMediaManager(
 
 		override suspend fun getItem(index: Int): QueueEntry? {
 			val item = items.getOrNull(index) ?: return null
-			return BaseItemDtoUserQueueEntry.build(api, item)
+			return createBaseItemQueueEntry(api, item)
 		}
 	}
 }

playback/core/src/main/kotlin/element/ElementKey.kt

@@ -0,0 +1,8 @@
+package org.jellyfin.playback.core.element
+
+/**
+ * A key to identify the type of an element.
+ */
+class ElementKey<T : Any>(val name: String) {
+	override fun toString(): String = "ElementKey $name"
+}

playback/core/src/main/kotlin/element/ElementsContainer.kt

@@ -0,0 +1,26 @@
+package org.jellyfin.playback.core.element
+
+import java.util.concurrent.ConcurrentHashMap
+
+/**
+ * Container to hold elements identified with an [ElementKey].
+ */
+open class ElementsContainer {
+	private val elements = ConcurrentHashMap<ElementKey<*>, Any?>()
+
+	fun <T : Any> get(key: ElementKey<T>): T = getOrNull(key)
+		?: error("No element found for key $key.")
+
+	@Suppress("UNCHECKED_CAST")
+	fun <T : Any> getOrNull(key: ElementKey<T>): T? = elements[key] as T?
+
+	operator fun <T : Any> contains(key: ElementKey<T>): Boolean = elements.containsKey(key)
+
+	fun <T : Any> put(key: ElementKey<T>, value: T) {
+		elements[key] = value
+	}
+
+	fun <T : Any> remove(key: ElementKey<T>) {
+		elements.remove(key)
+	}
+}

playback/core/src/main/kotlin/element/delegates.kt

@@ -0,0 +1,40 @@
+package org.jellyfin.playback.core.element
+
+import kotlin.properties.ReadWriteProperty
+import kotlin.reflect.KProperty
+
+/**
+ * Delegate for an optional element.
+ */
+fun <T : Any> element(
+	key: ElementKey<T>
+) = object : ReadWriteProperty<ElementsContainer, T?> {
+	override fun getValue(thisRef: ElementsContainer, property: KProperty<*>): T? =
+		thisRef.getOrNull(key)
+
+	override fun setValue(thisRef: ElementsContainer, property: KProperty<*>, value: T?) {
+		if (value == null) thisRef.remove(key)
+		else thisRef.put(key, value)
+	}
+}
+
+/**
+ * Delegate for an required element.
+ */
+fun <T : Any> requiredElement(
+	key: ElementKey<T>,
+	computeDefault: () -> T,
+) = object : ReadWriteProperty<ElementsContainer, T> {
+	override fun getValue(thisRef: ElementsContainer, property: KProperty<*>): T {
+		val value = thisRef.getOrNull(key)
+		if (value != null) return value
+
+		val default = computeDefault()
+		thisRef.put(key, default)
+		return default
+	}
+
+	override fun setValue(thisRef: ElementsContainer, property: KProperty<*>, value: T) {
+		thisRef.put(key, value)
+	}
+}

playback/core/src/main/kotlin/mediasession/MediaSessionPlayer.kt

@@ -22,6 +22,7 @@ import org.jellyfin.playback.core.PlaybackManager
 import org.jellyfin.playback.core.model.PlayState
 import org.jellyfin.playback.core.model.PlaybackOrder
 import org.jellyfin.playback.core.model.RepeatMode
+import org.jellyfin.playback.core.queue.metadata
 import timber.log.Timber
 import kotlin.time.Duration
 import kotlin.time.Duration.Companion.milliseconds

playback/core/src/main/kotlin/mediasession/MediaSessionService.kt

@@ -12,7 +12,8 @@ import androidx.media3.session.MediaStyleNotificationHelper
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.onEach
 import org.jellyfin.playback.core.plugin.PlayerService
-import org.jellyfin.playback.core.queue.item.QueueEntry
+import org.jellyfin.playback.core.queue.QueueEntry
+import org.jellyfin.playback.core.queue.metadata
 
 class MediaSessionService(
 	private val androidContext: Context,

playback/core/src/main/kotlin/mediasession/MetadataExtensions.kt

@@ -3,7 +3,7 @@ package org.jellyfin.playback.core.mediasession
 import androidx.core.net.toUri
 import androidx.media3.common.MediaItem
 import androidx.media3.common.MediaMetadata
-import org.jellyfin.playback.core.queue.item.QueueEntryMetadata
+import org.jellyfin.playback.core.queue.QueueEntryMetadata
 
 fun QueueEntryMetadata.toMediaItem() = MediaItem.Builder().apply {
 	if (mediaId != null) setMediaId(mediaId)

playback/core/src/main/kotlin/mediastream/MediaStream.kt

@@ -1,6 +1,6 @@
 package org.jellyfin.playback.core.mediastream
 
-import org.jellyfin.playback.core.queue.item.QueueEntry
+import org.jellyfin.playback.core.queue.QueueEntry
 
 interface MediaStream {
 	val identifier: String

playback/core/src/main/kotlin/mediastream/MediaStreamResolver.kt

@@ -1,6 +1,6 @@
 package org.jellyfin.playback.core.mediastream
 
-import org.jellyfin.playback.core.queue.item.QueueEntry
+import org.jellyfin.playback.core.queue.QueueEntry
 import org.jellyfin.playback.core.support.PlaySupportReport
 
 /**

playback/core/src/main/kotlin/queue/EmptyQueue.kt

@@ -1,7 +1,5 @@
 package org.jellyfin.playback.core.queue
 
-import org.jellyfin.playback.core.queue.item.QueueEntry
-
 data object EmptyQueue : Queue {
 	override val size: Int = 0
 	override suspend fun getItem(index: Int): QueueEntry? = null

playback/core/src/main/kotlin/queue/PagedQueue.kt

@@ -1,7 +1,5 @@
 package org.jellyfin.playback.core.queue
 
-import org.jellyfin.playback.core.queue.item.QueueEntry
-
 abstract class PagedQueue(
 	private val pageSize: Int = 10,
 ) : Queue {

playback/core/src/main/kotlin/queue/PlayerQueueState.kt

@@ -14,7 +14,6 @@ import org.jellyfin.playback.core.mediastream.PlayableMediaStream
 import org.jellyfin.playback.core.model.PlayState
 import org.jellyfin.playback.core.model.PlaybackOrder
 import org.jellyfin.playback.core.model.RepeatMode
-import org.jellyfin.playback.core.queue.item.QueueEntry
 import org.jellyfin.playback.core.queue.order.DefaultOrderIndexProvider
 import org.jellyfin.playback.core.queue.order.OrderIndexProvider
 import org.jellyfin.playback.core.queue.order.RandomOrderIndexProvider

playback/core/src/main/kotlin/queue/Queue.kt

@@ -1,7 +1,5 @@
 package org.jellyfin.playback.core.queue
 
-import org.jellyfin.playback.core.queue.item.QueueEntry
-
 /**
  * A queue contains all items in the current playback session. This includes already played items,
  * the currently playing item and future items.

playback/core/src/main/kotlin/queue/QueueEntry.kt

@@ -0,0 +1,9 @@
+package org.jellyfin.playback.core.queue
+
+import org.jellyfin.playback.core.element.ElementsContainer
+
+/**
+ * The QueueEntry is a single item in a queue and can represent any supported media type.
+ * All related data is stored in elements via the [ElementsContainer].
+ */
+class QueueEntry : ElementsContainer()

playback/core/src/main/kotlin/queue/item/QueueEntryMetadata.kt → playback/core/src/main/kotlin/queue/QueueEntryMetadata.kt

@@ -1,5 +1,7 @@
-package org.jellyfin.playback.core.queue.item
+package org.jellyfin.playback.core.queue
 
+import org.jellyfin.playback.core.element.ElementKey
+import org.jellyfin.playback.core.element.requiredElement
 import java.time.LocalDate
 import kotlin.time.Duration
 
@@ -33,3 +35,10 @@ data class QueueEntryMetadata(
 		val Empty = QueueEntryMetadata()
 	}
 }
+
+private val metadataKey = ElementKey<QueueEntryMetadata>("QueueEntryMetadata")
+
+/**
+ * Get or set the [QueueEntryMetadata] for this [QueueEntry]. Defaults to [QueueEntryMetadata.Empty].
+ */
+var QueueEntry.metadata by requiredElement(metadataKey) { QueueEntryMetadata.Empty }

playback/core/src/main/kotlin/queue/SequenceQueue.kt

@@ -1,7 +1,5 @@
 package org.jellyfin.playback.core.queue
 
-import org.jellyfin.playback.core.queue.item.QueueEntry
-
 abstract class SequenceQueue : Queue {
 	companion object {
 		const val MAX_SIZE = 100

playback/jellyfin/src/main/kotlin/mediastream/AudioMediaStreamResolver.kt

@@ -5,9 +5,9 @@ import org.jellyfin.playback.core.mediastream.MediaConversionMethod
 import org.jellyfin.playback.core.mediastream.MediaStream
 import org.jellyfin.playback.core.mediastream.MediaStreamContainer
 import org.jellyfin.playback.core.mediastream.PlayableMediaStream
-import org.jellyfin.playback.core.queue.item.QueueEntry
+import org.jellyfin.playback.core.queue.QueueEntry
 import org.jellyfin.playback.core.support.PlaySupportReport
-import org.jellyfin.playback.jellyfin.queue.item.BaseItemDtoUserQueueEntry
+import org.jellyfin.playback.jellyfin.queue.baseItem
 import org.jellyfin.sdk.api.client.ApiClient
 import org.jellyfin.sdk.api.client.extensions.audioApi
 import org.jellyfin.sdk.api.client.extensions.dynamicHlsApi
@@ -51,18 +51,18 @@ class AudioMediaStreamResolver(
 		queueEntry: QueueEntry,
 		testStream: (stream: MediaStream) -> PlaySupportReport,
 	): PlayableMediaStream? {
-		if (queueEntry !is BaseItemDtoUserQueueEntry) return null
-		if (queueEntry.baseItem.type != BaseItemKind.AUDIO) return null
+		val baseItem = queueEntry.baseItem
+		if (baseItem == null || baseItem.type != BaseItemKind.AUDIO) return null
 
-		val mediaInfo = getPlaybackInfo(queueEntry.baseItem)
+		val mediaInfo = getPlaybackInfo(baseItem)
 
 		// Test for direct play support
 		val directPlayStream = mediaInfo.getDirectPlayStream()
 		if (testStream(directPlayStream).canPlay) {
 			return directPlayStream.toPlayableMediaStream(
 				queueEntry = queueEntry,
 				url = api.audioApi.getAudioStreamUrl(
-					itemId = queueEntry.baseItem.id,
+					itemId = baseItem.id,
 					mediaSourceId = mediaInfo.mediaSource.id,
 					playSessionId = mediaInfo.playSessionId,
 					static = true,
@@ -78,7 +78,7 @@ class AudioMediaStreamResolver(
 					return remuxStream.toPlayableMediaStream(
 						queueEntry = queueEntry,
 						url = api.audioApi.getAudioStreamByContainerUrl(
-							itemId = queueEntry.baseItem.id,
+							itemId = baseItem.id,
 							mediaSourceId = mediaInfo.mediaSource.id,
 							playSessionId = mediaInfo.playSessionId,
 							container = container,
@@ -96,7 +96,7 @@ class AudioMediaStreamResolver(
 			return transcodeStream.toPlayableMediaStream(
 				queueEntry = queueEntry,
 				url = api.dynamicHlsApi.getMasterHlsAudioPlaylistUrl(
-					itemId = queueEntry.baseItem.id,
+					itemId = baseItem.id,
 					mediaSourceId = requireNotNull(mediaInfo.mediaSource.id),
 					playSessionId = mediaInfo.playSessionId,
 					tag = mediaInfo.mediaSource.eTag,

playback/jellyfin/src/main/kotlin/mediastream/UniversalAudioMediaStreamResolver.kt

@@ -3,9 +3,9 @@ package org.jellyfin.playback.jellyfin.mediastream
 import org.jellyfin.playback.core.mediastream.MediaConversionMethod
 import org.jellyfin.playback.core.mediastream.MediaStream
 import org.jellyfin.playback.core.mediastream.PlayableMediaStream
-import org.jellyfin.playback.core.queue.item.QueueEntry
+import org.jellyfin.playback.core.queue.QueueEntry
 import org.jellyfin.playback.core.support.PlaySupportReport
-import org.jellyfin.playback.jellyfin.queue.item.BaseItemDtoUserQueueEntry
+import org.jellyfin.playback.jellyfin.queue.baseItem
 import org.jellyfin.sdk.api.client.ApiClient
 import org.jellyfin.sdk.api.client.extensions.universalAudioApi
 import org.jellyfin.sdk.model.api.BaseItemKind
@@ -19,13 +19,13 @@ class UniversalAudioMediaStreamResolver(
 		queueEntry: QueueEntry,
 		testStream: (stream: MediaStream) -> PlaySupportReport,
 	): PlayableMediaStream? {
-		if (queueEntry !is BaseItemDtoUserQueueEntry) return null
-		if (queueEntry.baseItem.type != BaseItemKind.AUDIO) return null
+		val baseItem = queueEntry.baseItem
+		if (baseItem == null || baseItem.type != BaseItemKind.AUDIO) return null
 
-		val mediaInfo = getPlaybackInfo(queueEntry.baseItem)
+		val mediaInfo = getPlaybackInfo(baseItem)
 
 		val url = api.universalAudioApi.getUniversalAudioStreamUrl(
-			itemId = queueEntry.baseItem.id,
+			itemId = baseItem.id,
 			mediaSourceId = mediaInfo.mediaSource.id,
 			enableRedirection = false,
 			enableRemoteMedia = false,

playback/jellyfin/src/main/kotlin/playsession/PlaySessionService.kt

@@ -10,7 +10,7 @@ import org.jellyfin.playback.core.mediastream.PlayableMediaStream
 import org.jellyfin.playback.core.model.PlayState
 import org.jellyfin.playback.core.model.RepeatMode
 import org.jellyfin.playback.core.plugin.PlayerService
-import org.jellyfin.playback.jellyfin.queue.item.BaseItemDtoUserQueueEntry
+import org.jellyfin.playback.jellyfin.queue.baseItem
 import org.jellyfin.sdk.api.client.ApiClient
 import org.jellyfin.sdk.api.client.extensions.playStateApi
 import org.jellyfin.sdk.model.api.PlayMethod
@@ -40,12 +40,6 @@ class PlaySessionService(
 		}.launchIn(coroutineScope)
 	}
 
-	private val PlayableMediaStream.baseItem
-		get() = when (val entry = queueEntry) {
-			is BaseItemDtoUserQueueEntry -> entry.baseItem
-			else -> null
-		}
-
 	private val MediaConversionMethod.playMethod
 		get() = when (this) {
 			MediaConversionMethod.None -> PlayMethod.DIRECT_PLAY
@@ -94,12 +88,12 @@ class PlaySessionService(
 		// backend.
 		return state.queue
 			.peekNext(15)
-			.filterIsInstance<BaseItemDtoUserQueueEntry>()
-			.map { QueueItem(id = it.baseItem.id, playlistItemId = it.baseItem.playlistItemId) }
+			.mapNotNull { it.baseItem }
+			.map { QueueItem(id = it.id, playlistItemId = it.playlistItemId) }
 	}
 
 	private suspend fun sendStreamStart(stream: PlayableMediaStream) {
-		val item = stream.baseItem ?: return
+		val item = stream.queueEntry.baseItem ?: return
 		api.playStateApi.reportPlaybackStart(PlaybackStartInfo(
 			itemId = item.id,
 			playSessionId = stream.identifier,
@@ -117,7 +111,7 @@ class PlaySessionService(
 	}
 
 	private suspend fun sendStreamUpdate(stream: PlayableMediaStream) {
-		val item = stream.baseItem ?: return
+		val item = stream.queueEntry.baseItem ?: return
 		api.playStateApi.reportPlaybackProgress(PlaybackProgressInfo(
 			itemId = item.id,
 			playSessionId = stream.identifier,
@@ -135,7 +129,7 @@ class PlaySessionService(
 	}
 
 	private suspend fun sendStreamStop(stream: PlayableMediaStream) {
-		val item = stream.baseItem ?: return
+		val item = stream.queueEntry.baseItem ?: return
 		api.playStateApi.reportPlaybackStopped(PlaybackStopInfo(
 			itemId = item.id,
 			playSessionId = stream.identifier,