Extract the Media3Adapter (#354)

Author: mickael-menu

readium/navigator/src/main/java/org/readium/r2/navigator/media3/api/Media3Adapter.kt

@@ -0,0 +1,12 @@
+package org.readium.r2.navigator.media3.api
+
+import androidx.media3.common.Player
+import org.readium.r2.shared.ExperimentalReadiumApi
+
+/**
+ * An object able to pass as a Jetpack media3 [Player].
+ */
+@ExperimentalReadiumApi
+interface Media3Adapter {
+    fun asMedia3Player(): Player
+}

readium/navigator/src/main/java/org/readium/r2/navigator/media3/api/MediaNavigator.kt

@@ -17,8 +17,11 @@ import org.readium.r2.shared.util.Href
  * A [Navigator] which can play multimedia content.
  */
 @ExperimentalReadiumApi
-interface MediaNavigator<L : MediaNavigator.Location, P : MediaNavigator.Playback,
-    R : MediaNavigator.ReadingOrder> : Navigator, Closeable {
+interface MediaNavigator<
+    L : MediaNavigator.Location,
+    P : MediaNavigator.Playback,
+    R : MediaNavigator.ReadingOrder
+    > : Navigator, Closeable {
 
     /**
      *  Location of the navigator.
@@ -115,9 +118,4 @@ interface MediaNavigator<L : MediaNavigator.Location, P : MediaNavigator.Playbac
      * Pauses the playback.
      */
     fun pause()
-
-    /**
-     * Adapts this navigator to the media3 [Player] interface.
-     */
-    fun asPlayer(): Player
 }

readium/navigator/src/main/java/org/readium/r2/navigator/media3/api/TextAwareMediaNavigator.kt

@@ -14,8 +14,11 @@ import org.readium.r2.shared.publication.Locator
  * A [MediaNavigator] aware of the utterances being read aloud.
  */
 @ExperimentalReadiumApi
-interface TextAwareMediaNavigator<L : TextAwareMediaNavigator.Location, P : TextAwareMediaNavigator.Playback,
-    R : TextAwareMediaNavigator.ReadingOrder> : MediaNavigator<L, P, R> {
+interface TextAwareMediaNavigator<
+    L : TextAwareMediaNavigator.Location,
+    P : TextAwareMediaNavigator.Playback,
+    R : TextAwareMediaNavigator.ReadingOrder
+    > : MediaNavigator<L, P, R> {
 
     /**
      * Location of the navigator.

readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/AudiobookNavigator.kt

@@ -17,6 +17,7 @@ import kotlinx.coroutines.flow.StateFlow
 import org.readium.r2.navigator.extensions.sum
 import org.readium.r2.navigator.extensions.time
 import org.readium.r2.navigator.media3.api.AudioNavigator
+import org.readium.r2.navigator.media3.api.Media3Adapter
 import org.readium.r2.navigator.media3.api.MediaNavigator
 import org.readium.r2.navigator.preferences.Configurable
 import org.readium.r2.shared.ExperimentalReadiumApi
@@ -33,7 +34,10 @@ class AudiobookNavigator<S : Configurable.Settings, P : Configurable.Preferences
     override val publication: Publication,
     private val audioEngine: AudioEngine<S, P>,
     override val readingOrder: ReadingOrder,
-) : AudioNavigator<AudiobookNavigator.Location, AudiobookNavigator.Playback, AudiobookNavigator.ReadingOrder>,
+) :
+    MediaNavigator<AudiobookNavigator.Location, AudiobookNavigator.Playback, AudiobookNavigator.ReadingOrder>,
+    AudioNavigator<AudiobookNavigator.Location, AudiobookNavigator.Playback, AudiobookNavigator.ReadingOrder>,
+    Media3Adapter,
     Configurable<S, P> by audioEngine {
 
     companion object {
@@ -188,9 +192,8 @@ class AudiobookNavigator<S : Configurable.Settings, P : Configurable.Preferences
         audioEngine.close()
     }
 
-    override fun asPlayer(): Player {
-        return audioEngine.asPlayer()
-    }
+    override fun asMedia3Player(): Player =
+        audioEngine.asPlayer()
 
     override fun go(locator: Locator, animated: Boolean, completion: () -> Unit): Boolean {
         val itemIndex = readingOrder.items.indexOfFirst { it.href.string == locator.href }

readium/navigator/src/main/java/org/readium/r2/navigator/media3/syncmedia/GuidedAudioNavigator.kt

@@ -10,6 +10,7 @@ import androidx.media3.common.Player
 import kotlin.time.Duration
 import kotlinx.coroutines.flow.StateFlow
 import org.readium.r2.navigator.media3.api.AudioNavigator
+import org.readium.r2.navigator.media3.api.Media3Adapter
 import org.readium.r2.navigator.media3.api.MediaNavigator
 import org.readium.r2.navigator.media3.api.TextAwareMediaNavigator
 import org.readium.r2.navigator.media3.audio.AudiobookNavigator
@@ -23,8 +24,11 @@ import org.readium.r2.shared.util.Href
 @ExperimentalReadiumApi
 class GuidedAudioNavigator<S : Configurable.Settings, P : Configurable.Preferences<P>>(
     private val audioNavigator: AudiobookNavigator<S, P>,
-) : AudioNavigator<GuidedAudioNavigator.Location, GuidedAudioNavigator.Playback, GuidedAudioNavigator.ReadingOrder>,
+) :
+    MediaNavigator<GuidedAudioNavigator.Location, GuidedAudioNavigator.Playback, GuidedAudioNavigator.ReadingOrder>,
+    AudioNavigator<GuidedAudioNavigator.Location, GuidedAudioNavigator.Playback, GuidedAudioNavigator.ReadingOrder>,
     TextAwareMediaNavigator<GuidedAudioNavigator.Location, GuidedAudioNavigator.Playback, GuidedAudioNavigator.ReadingOrder>,
+    Media3Adapter,
     Configurable<S, P> {
 
     data class Location(
@@ -84,9 +88,8 @@ class GuidedAudioNavigator<S : Configurable.Settings, P : Configurable.Preferenc
         audioNavigator.pause()
     }
 
-    override fun asPlayer(): Player {
-        return audioNavigator.asPlayer()
-    }
+    override fun asMedia3Player(): Player =
+        audioNavigator.asMedia3Player()
 
     override val settings: StateFlow<S> =
         audioNavigator.settings

readium/navigator/src/main/java/org/readium/r2/navigator/media3/tts/TtsNavigator.kt

@@ -13,6 +13,7 @@ import androidx.media3.common.Player
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.MainScope
 import kotlinx.coroutines.flow.StateFlow
+import org.readium.r2.navigator.media3.api.Media3Adapter
 import org.readium.r2.navigator.media3.api.MediaMetadataProvider
 import org.readium.r2.navigator.media3.api.MediaNavigator
 import org.readium.r2.navigator.media3.api.TextAwareMediaNavigator
@@ -39,7 +40,10 @@ class TtsNavigator<S : TtsEngine.Settings, P : TtsEngine.Preferences<P>,
     override val publication: Publication,
     private val player: TtsPlayer<S, P, E, V>,
     private val sessionAdapter: TtsSessionAdapter<E>,
-) : TextAwareMediaNavigator<TtsNavigator.Location, TtsNavigator.Playback, TtsNavigator.ReadingOrder>,
+) :
+    MediaNavigator<TtsNavigator.Location, TtsNavigator.Playback, TtsNavigator.ReadingOrder>,
+    TextAwareMediaNavigator<TtsNavigator.Location, TtsNavigator.Playback, TtsNavigator.ReadingOrder>,
+    Media3Adapter,
     Configurable<S, P> by player {
 
     companion object {
@@ -214,7 +218,7 @@ class TtsNavigator<S : TtsEngine.Settings, P : TtsEngine.Preferences<P>,
         return player.hasNextUtterance()
     }
 
-    override fun asPlayer(): Player =
+    override fun asMedia3Player(): Player =
         sessionAdapter
 
     override fun close() {

test-app/src/main/java/org/readium/r2/testapp/reader/MediaService.kt

@@ -18,6 +18,7 @@ import androidx.media3.session.MediaSession
 import androidx.media3.session.MediaSessionService
 import kotlinx.coroutines.*
 import kotlinx.coroutines.flow.*
+import org.readium.r2.navigator.media3.api.Media3Adapter
 import org.readium.r2.navigator.media3.api.MediaNavigator
 import org.readium.r2.shared.ExperimentalReadiumApi
 import timber.log.Timber
@@ -59,12 +60,12 @@ class MediaService : MediaSessionService() {
             sessionMutable.value = null
         }
 
-        fun openSession(
-            navigator: AnyMediaNavigator,
+        fun <N> openSession(
+            navigator: N,
             bookId: Long
-        ) {
+        ) where N : AnyMediaNavigator, N : Media3Adapter {
             val activityIntent = createSessionActivityIntent()
-            val mediaSession = MediaSession.Builder(applicationContext, navigator.asPlayer())
+            val mediaSession = MediaSession.Builder(applicationContext, navigator.asMedia3Player())
                 .setSessionActivity(activityIntent)
                 .setId(bookId.toString())
                 .build()