From 57bc32b7528b932b7165bd913f29741916950231 Mon Sep 17 00:00:00 2001
From: qnga <32197639+qnga@users.noreply.github.com>
Date: Sat, 8 Jul 2023 16:58:24 +0200
Subject: [PATCH] Various changes on media3-based navigators (#363)

---
 ...avigator.kt => TimeBasedMediaNavigator.kt} |  6 ++---
 .../media3/audio/AudioEngineProvider.kt       |  2 +-
 ...udiobookNavigator.kt => AudioNavigator.kt} | 20 ++++++++---------
 .../media3/audio/AudioNavigatorFactory.kt     |  4 ++--
 .../media3/exoplayer/ExoPlayerAliases.kt      |  4 ++--
 ...ioNavigator.kt => GuidedMediaNavigator.kt} | 22 +++++++++----------
 .../r2/navigator/media3/tts/TtsNavigator.kt   | 10 ++++++++-
 .../media3/tts/android/AndroidTtsEngine.kt    | 22 +++++++++++--------
 .../r2/testapp/reader/AudioReaderFragment.kt  |  8 +++----
 9 files changed, 55 insertions(+), 43 deletions(-)
 rename readium/navigator/src/main/java/org/readium/r2/navigator/media3/api/{AudioNavigator.kt => TimeBasedMediaNavigator.kt} (88%)
 rename readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/{AudiobookNavigator.kt => AudioNavigator.kt} (91%)
 rename readium/navigator/src/main/java/org/readium/r2/navigator/media3/syncmedia/{GuidedAudioNavigator.kt => GuidedMediaNavigator.kt} (80%)

diff --git a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/api/AudioNavigator.kt b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/api/TimeBasedMediaNavigator.kt
similarity index 88%
rename from readium/navigator/src/main/java/org/readium/r2/navigator/media3/api/AudioNavigator.kt
rename to readium/navigator/src/main/java/org/readium/r2/navigator/media3/api/TimeBasedMediaNavigator.kt
index 41227cacb4..8c5d89e5e7 100644
--- a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/api/AudioNavigator.kt
+++ b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/api/TimeBasedMediaNavigator.kt
@@ -11,11 +11,11 @@ import kotlinx.coroutines.flow.StateFlow
 import org.readium.r2.shared.ExperimentalReadiumApi
 
 /**
- * A [MediaNavigator] which can play audio files.
+ * A [MediaNavigator] whose locations provide time offsets.
  */
 @ExperimentalReadiumApi
-interface AudioNavigator<L : AudioNavigator.Location, P : AudioNavigator.Playback,
-    R : AudioNavigator.ReadingOrder> : MediaNavigator<L, P, R> {
+interface TimeBasedMediaNavigator<L : TimeBasedMediaNavigator.Location, P : TimeBasedMediaNavigator.Playback,
+    R : TimeBasedMediaNavigator.ReadingOrder> : MediaNavigator<L, P, R> {
 
     /**
      * Location of the navigator.
diff --git a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/AudioEngineProvider.kt b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/AudioEngineProvider.kt
index 39a352c128..21ea7681a6 100644
--- a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/AudioEngineProvider.kt
+++ b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/AudioEngineProvider.kt
@@ -14,7 +14,7 @@ import org.readium.r2.shared.publication.Metadata
 import org.readium.r2.shared.publication.Publication
 
 /**
- * To be implemented by adapters for third-party audio engines which can be used with [AudiobookNavigator].
+ * To be implemented by adapters for third-party audio engines which can be used with [AudioNavigator].
  */
 @ExperimentalReadiumApi
 interface AudioEngineProvider<S : Configurable.Settings, P : Configurable.Preferences<P>,
diff --git a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/AudiobookNavigator.kt b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/AudioNavigator.kt
similarity index 91%
rename from readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/AudiobookNavigator.kt
rename to readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/AudioNavigator.kt
index 94f541cd0e..172c30c9ed 100644
--- a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/AudiobookNavigator.kt
+++ b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/AudioNavigator.kt
@@ -16,9 +16,9 @@ import kotlinx.coroutines.MainScope
 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.media3.api.TimeBasedMediaNavigator
 import org.readium.r2.navigator.preferences.Configurable
 import org.readium.r2.shared.ExperimentalReadiumApi
 import org.readium.r2.shared.extensions.mapStateIn
@@ -30,13 +30,13 @@ import timber.log.Timber
 
 @ExperimentalReadiumApi
 @OptIn(ExperimentalTime::class)
-class AudiobookNavigator<S : Configurable.Settings, P : Configurable.Preferences<P>> private constructor(
+class AudioNavigator<S : Configurable.Settings, P : Configurable.Preferences<P>> private constructor(
     override val publication: Publication,
     private val audioEngine: AudioEngine<S, P>,
     override val readingOrder: ReadingOrder,
 ) :
-    MediaNavigator<AudiobookNavigator.Location, AudiobookNavigator.Playback, AudiobookNavigator.ReadingOrder>,
-    AudioNavigator<AudiobookNavigator.Location, AudiobookNavigator.Playback, AudiobookNavigator.ReadingOrder>,
+    MediaNavigator<AudioNavigator.Location, AudioNavigator.Playback, AudioNavigator.ReadingOrder>,
+    TimeBasedMediaNavigator<AudioNavigator.Location, AudioNavigator.Playback, AudioNavigator.ReadingOrder>,
     Media3Adapter,
     Configurable<S, P> by audioEngine {
 
@@ -48,7 +48,7 @@ class AudiobookNavigator<S : Configurable.Settings, P : Configurable.Preferences
             readingOrder: List<Link> = publication.readingOrder,
             initialPreferences: P? = null,
             initialLocator: Locator? = null,
-        ): AudiobookNavigator<S, P>? {
+        ): AudioNavigator<S, P>? {
             if (readingOrder.isEmpty()) {
                 return null
             }
@@ -71,7 +71,7 @@ class AudiobookNavigator<S : Configurable.Settings, P : Configurable.Preferences
                     initialPreferences ?: audioEngineProvider.createEmptyPreferences()
                 ) ?: return null
 
-            return AudiobookNavigator(publication, audioEngine, actualReadingOrder)
+            return AudioNavigator(publication, audioEngine, actualReadingOrder)
         }
 
         private fun duration(link: Link, publication: Publication): Duration? {
@@ -90,17 +90,17 @@ class AudiobookNavigator<S : Configurable.Settings, P : Configurable.Preferences
     data class Location(
         override val href: Href,
         override val offset: Duration,
-    ) : AudioNavigator.Location
+    ) : TimeBasedMediaNavigator.Location
 
     data class ReadingOrder(
         override val duration: Duration?,
         override val items: List<Item>
-    ) : AudioNavigator.ReadingOrder {
+    ) : TimeBasedMediaNavigator.ReadingOrder {
 
         data class Item(
             val href: Href,
             override val duration: Duration?
-        ) : AudioNavigator.ReadingOrder.Item
+        ) : TimeBasedMediaNavigator.ReadingOrder.Item
     }
 
     data class Playback(
@@ -109,7 +109,7 @@ class AudiobookNavigator<S : Configurable.Settings, P : Configurable.Preferences
         override val index: Int,
         override val offset: Duration,
         override val buffered: Duration?,
-    ) : AudioNavigator.Playback
+    ) : TimeBasedMediaNavigator.Playback
 
     sealed class State {
 
diff --git a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/AudioNavigatorFactory.kt b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/AudioNavigatorFactory.kt
index 2b977e0f3e..0774d7956f 100644
--- a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/AudioNavigatorFactory.kt
+++ b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/AudioNavigatorFactory.kt
@@ -44,8 +44,8 @@ class AudioNavigatorFactory<S : Configurable.Settings, P : Configurable.Preferen
     suspend fun createNavigator(
         initialPreferences: P? = null,
         initialLocator: Locator? = null
-    ): AudiobookNavigator<S, P>? {
-        return AudiobookNavigator(
+    ): AudioNavigator<S, P>? {
+        return AudioNavigator(
             publication = publication,
             audioEngineProvider = audioEngineProvider,
             initialPreferences = initialPreferences,
diff --git a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/exoplayer/ExoPlayerAliases.kt b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/exoplayer/ExoPlayerAliases.kt
index 792af970b5..9230ce5a2f 100644
--- a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/exoplayer/ExoPlayerAliases.kt
+++ b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/exoplayer/ExoPlayerAliases.kt
@@ -6,12 +6,12 @@
 
 package org.readium.r2.navigator.media3.exoplayer
 
+import org.readium.r2.navigator.media3.audio.AudioNavigator
 import org.readium.r2.navigator.media3.audio.AudioNavigatorFactory
-import org.readium.r2.navigator.media3.audio.AudiobookNavigator
 import org.readium.r2.shared.ExperimentalReadiumApi
 
 @OptIn(ExperimentalReadiumApi::class)
 typealias ExoPlayerNavigatorFactory = AudioNavigatorFactory<ExoPlayerSettings, ExoPlayerPreferences, ExoPlayerPreferencesEditor>
 
 @OptIn(ExperimentalReadiumApi::class)
-typealias ExoPlayerNavigator = AudiobookNavigator<ExoPlayerSettings, ExoPlayerPreferences>
+typealias ExoPlayerNavigator = AudioNavigator<ExoPlayerSettings, ExoPlayerPreferences>
diff --git a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/syncmedia/GuidedAudioNavigator.kt b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/syncmedia/GuidedMediaNavigator.kt
similarity index 80%
rename from readium/navigator/src/main/java/org/readium/r2/navigator/media3/syncmedia/GuidedAudioNavigator.kt
rename to readium/navigator/src/main/java/org/readium/r2/navigator/media3/syncmedia/GuidedMediaNavigator.kt
index ea66c750f9..1c01c0c68b 100644
--- a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/syncmedia/GuidedAudioNavigator.kt
+++ b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/syncmedia/GuidedMediaNavigator.kt
@@ -9,11 +9,11 @@ package org.readium.r2.navigator.media3.syncmedia
 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
+import org.readium.r2.navigator.media3.api.TimeBasedMediaNavigator
+import org.readium.r2.navigator.media3.audio.AudioNavigator
 import org.readium.r2.navigator.preferences.Configurable
 import org.readium.r2.shared.ExperimentalReadiumApi
 import org.readium.r2.shared.publication.Link
@@ -22,12 +22,12 @@ import org.readium.r2.shared.publication.Publication
 import org.readium.r2.shared.util.Href
 
 @ExperimentalReadiumApi
-class GuidedAudioNavigator<S : Configurable.Settings, P : Configurable.Preferences<P>>(
-    private val audioNavigator: AudiobookNavigator<S, P>,
+class GuidedMediaNavigator<S : Configurable.Settings, P : Configurable.Preferences<P>>(
+    private val audioNavigator: AudioNavigator<S, P>,
 ) :
-    MediaNavigator<GuidedAudioNavigator.Location, GuidedAudioNavigator.Playback, GuidedAudioNavigator.ReadingOrder>,
-    AudioNavigator<GuidedAudioNavigator.Location, GuidedAudioNavigator.Playback, GuidedAudioNavigator.ReadingOrder>,
-    TextAwareMediaNavigator<GuidedAudioNavigator.Location, GuidedAudioNavigator.Playback, GuidedAudioNavigator.ReadingOrder>,
+    MediaNavigator<GuidedMediaNavigator.Location, GuidedMediaNavigator.Playback, GuidedMediaNavigator.ReadingOrder>,
+    TimeBasedMediaNavigator<GuidedMediaNavigator.Location, GuidedMediaNavigator.Playback, GuidedMediaNavigator.ReadingOrder>,
+    TextAwareMediaNavigator<GuidedMediaNavigator.Location, GuidedMediaNavigator.Playback, GuidedMediaNavigator.ReadingOrder>,
     Media3Adapter,
     Configurable<S, P> {
 
@@ -41,7 +41,7 @@ class GuidedAudioNavigator<S : Configurable.Settings, P : Configurable.Preferenc
         override val range: IntRange?,
         override val utteranceLocator: Locator,
         override val tokenLocator: Locator?,
-    ) : AudioNavigator.Location,
+    ) : TimeBasedMediaNavigator.Location,
         TextAwareMediaNavigator.Location
 
     data class Playback(
@@ -52,17 +52,17 @@ class GuidedAudioNavigator<S : Configurable.Settings, P : Configurable.Preferenc
         override val buffered: Duration?,
         override val utterance: String,
         override val range: IntRange?,
-    ) : AudioNavigator.Playback, TextAwareMediaNavigator.Playback
+    ) : TimeBasedMediaNavigator.Playback, TextAwareMediaNavigator.Playback
 
     data class ReadingOrder(
         override val duration: Duration?,
         override val items: List<Item>
-    ) : AudioNavigator.ReadingOrder, TextAwareMediaNavigator.ReadingOrder {
+    ) : TimeBasedMediaNavigator.ReadingOrder, TextAwareMediaNavigator.ReadingOrder {
 
         data class Item(
             val href: Href,
             override val duration: Duration?
-        ) : AudioNavigator.ReadingOrder.Item, TextAwareMediaNavigator.ReadingOrder.Item
+        ) : TimeBasedMediaNavigator.ReadingOrder.Item, TextAwareMediaNavigator.ReadingOrder.Item
     }
 
     override val publication: Publication =
diff --git a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/tts/TtsNavigator.kt b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/tts/TtsNavigator.kt
index b54fc5c4a4..a0b9953998 100644
--- a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/tts/TtsNavigator.kt
+++ b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/tts/TtsNavigator.kt
@@ -44,7 +44,7 @@ class TtsNavigator<S : TtsEngine.Settings, P : TtsEngine.Preferences<P>,
     MediaNavigator<TtsNavigator.Location, TtsNavigator.Playback, TtsNavigator.ReadingOrder>,
     TextAwareMediaNavigator<TtsNavigator.Location, TtsNavigator.Playback, TtsNavigator.ReadingOrder>,
     Media3Adapter,
-    Configurable<S, P> by player {
+    Configurable<S, P> {
 
     companion object {
 
@@ -247,6 +247,14 @@ class TtsNavigator<S : TtsEngine.Settings, P : TtsEngine.Preferences<P>,
         return true
     }
 
+    override val settings: StateFlow<S> =
+        player.settings
+
+    override fun submitPreferences(preferences: P) {
+        player.submitPreferences(preferences)
+        player.restartUtterance()
+    }
+
     private fun navigatorPlayback(playback: TtsPlayer.Playback, utterance: TtsPlayer.Utterance) =
         Playback(
             state = playback.state.toState(),
diff --git a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/tts/android/AndroidTtsEngine.kt b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/tts/android/AndroidTtsEngine.kt
index 46f2b6dfa8..f909547422 100644
--- a/readium/navigator/src/main/java/org/readium/r2/navigator/media3/tts/android/AndroidTtsEngine.kt
+++ b/readium/navigator/src/main/java/org/readium/r2/navigator/media3/tts/android/AndroidTtsEngine.kt
@@ -400,19 +400,23 @@ class AndroidTtsEngine private constructor(
         utteranceLanguage: Language?,
         voices: Set<Voice>
     ): Boolean {
-        var language = utteranceLanguage
+        val language = utteranceLanguage
             .takeUnless { settings.overrideContentLanguage }
+            // We take utterance language if data are missing but not if the language is not supported
+            ?.takeIf { isLanguageAvailable(it.locale) != LANG_NOT_SUPPORTED }
             ?: settings.language
+                .takeIf { isLanguageAvailable(it.locale) != LANG_NOT_SUPPORTED }
+            ?: defaultVoice?.locale?.let { Language(it) }
 
-        utteranceListener?.onError(id, Error.LanguageMissingData(language))
-        return false
+        if (language == null) {
+            // We don't know what to do.
+            utteranceListener?.onError(id, Error.Unknown)
+            return false
+        }
 
-        when (isLanguageAvailable(language.locale)) {
-            LANG_MISSING_DATA -> {
-                utteranceListener?.onError(id, Error.LanguageMissingData(language))
-                return false
-            }
-            LANG_NOT_SUPPORTED -> language = Language(defaultVoice.locale)
+        if (isLanguageAvailable(language.locale) < LANG_AVAILABLE) {
+            utteranceListener?.onError(id, Error.LanguageMissingData(language))
+            return false
         }
 
         val preferredVoiceWithRegion =
diff --git a/test-app/src/main/java/org/readium/r2/testapp/reader/AudioReaderFragment.kt b/test-app/src/main/java/org/readium/r2/testapp/reader/AudioReaderFragment.kt
index df5b54970c..a7322e9288 100644
--- a/test-app/src/main/java/org/readium/r2/testapp/reader/AudioReaderFragment.kt
+++ b/test-app/src/main/java/org/readium/r2/testapp/reader/AudioReaderFragment.kt
@@ -23,8 +23,8 @@ import kotlin.time.DurationUnit
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.onEach
 import kotlinx.coroutines.launch
-import org.readium.r2.navigator.media3.api.AudioNavigator
 import org.readium.r2.navigator.media3.api.MediaNavigator
+import org.readium.r2.navigator.media3.api.TimeBasedMediaNavigator
 import org.readium.r2.navigator.media3.exoplayer.ExoPlayerPreferences
 import org.readium.r2.navigator.media3.exoplayer.ExoPlayerSettings
 import org.readium.r2.navigator.preferences.Configurable
@@ -40,7 +40,7 @@ import timber.log.Timber
 @OptIn(ExperimentalReadiumApi::class)
 class AudioReaderFragment : BaseReaderFragment(), SeekBar.OnSeekBarChangeListener {
 
-    override lateinit var navigator: AudioNavigator<*, *, *>
+    override lateinit var navigator: TimeBasedMediaNavigator<*, *, *>
 
     private var binding: FragmentAudiobookBinding by viewLifecycle()
     private var seekingItem: Int? = null
@@ -88,7 +88,7 @@ class AudioReaderFragment : BaseReaderFragment(), SeekBar.OnSeekBarChangeListene
             .launchIn(viewLifecycleOwner.lifecycleScope)
     }
 
-    private fun onPlaybackChanged(playback: AudioNavigator.Playback) {
+    private fun onPlaybackChanged(playback: TimeBasedMediaNavigator.Playback) {
         Timber.v("onPlaybackChanged $playback")
         if (playback.state is MediaNavigator.State.Error) {
             onPlayerError()
@@ -111,7 +111,7 @@ class AudioReaderFragment : BaseReaderFragment(), SeekBar.OnSeekBarChangeListene
         }
     }
 
-    private fun updateTimeline(playback: AudioNavigator.Playback) {
+    private fun updateTimeline(playback: TimeBasedMediaNavigator.Playback) {
         val currentItem = navigator.readingOrder.items[playback.index]
         binding.timelineBar.max = currentItem.duration?.inWholeSeconds?.toInt() ?: 0
         binding.timelineDuration.text = currentItem.duration?.formatElapsedTime()