Feature: Support simple media-overlay books

flutter_readium/android/build.gradle

@@ -26,6 +26,8 @@ rootProject.allprojects {
 apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
 android {
   if (project.android.hasProperty('namespace')) {
     namespace 'dk.nota.flutter_readium'
@@ -36,11 +38,13 @@ android {
     targetCompatibility JavaVersion.VERSION_18
   }
 
-  kotlinOptions {
-    jvmTarget = '18'
+  kotlin {
+    compilerOptions {
+      jvmTarget = JvmTarget.JVM_18
+    }
   }
 
-  compileSdk 35
+  compileSdkVersion 35
   ndkVersion = "26.3.11579264"
 
   sourceSets {
@@ -73,12 +77,12 @@ dependencies {
   //implementation "org.readium.kotlin-toolkit:readium-lcp:$readium_version"
 
   // Used for media-session controls
-  def media_version = "1.7.1"
+  def media_version = "1.8.0"
   implementation "androidx.media3:media3-common:$media_version"
   implementation "androidx.media3:media3-session:$media_version"
   implementation "androidx.media3:media3-exoplayer:$media_version"
 
   implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.10.2'
-  implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.8.1"
+  implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.9.0"
   implementation 'androidx.constraintlayout:constraintlayout:2.2.1'
 }

flutter_readium/android/src/main/kotlin/dk/nota/flutter_readium/FlutterAudioPreferences.kt

@@ -5,6 +5,9 @@ import org.json.JSONObject
 import org.readium.adapter.exoplayer.audio.ExoPlayerPreferences
 import org.readium.r2.navigator.preferences.Configurable
 
+/**
+ * Audio preferences for Flutter Readium with extra properties.
+ */
 @Serializable
 data class FlutterAudioPreferences(
     val volume: Double? = null,
@@ -23,6 +26,9 @@ data class FlutterAudioPreferences(
             controlPanelInfoType = other.controlPanelInfoType
         )
 
+    /**
+     * Converts FlutterAudioPreferences to ExoPlayerPreferences.
+     */
     fun toExoPlayerPreferences(): ExoPlayerPreferences {
         return ExoPlayerPreferences(
             pitch = this.pitch,
@@ -31,10 +37,16 @@ data class FlutterAudioPreferences(
     }
 
     companion object {
+        /**
+         * Creates FlutterAudioPreferences from a JSON string.
+         */
         fun fromJSON(json: String): FlutterAudioPreferences {
             return fromJSON(JSONObject(json))
         }
 
+        /**
+         * Creates FlutterAudioPreferences from a JSON object.
+         */
         fun fromJSON(jsonObject: JSONObject): FlutterAudioPreferences {
             return FlutterAudioPreferences(
                 volume = jsonObject.getDouble("volume"),
@@ -45,6 +57,9 @@ data class FlutterAudioPreferences(
             )
         }
 
+        /**
+         * Converts FlutterAudioPreferences to a JSON object.
+         */
         fun toJSON(preferences: FlutterAudioPreferences): JSONObject {
             val jsonObject = JSONObject()
             jsonObject.put("volume", preferences.volume)
@@ -55,6 +70,9 @@ data class FlutterAudioPreferences(
             return jsonObject
         }
 
+        /**
+         * Creates FlutterAudioPreferences from a Map.
+         */
         fun fromMap(prefs: Map<*, *>): FlutterAudioPreferences {
             return FlutterAudioPreferences(
                 volume = prefs["volume"] as? Double ?: 1.0,
@@ -67,3 +85,4 @@ data class FlutterAudioPreferences(
         }
     }
 }
+

flutter_readium/android/src/main/kotlin/dk/nota/flutter_readium/FlutterDecorationPreferences.kt

@@ -0,0 +1,41 @@
+package dk.nota.flutter_readium
+
+import android.graphics.Color
+import org.readium.r2.navigator.Decoration
+import java.io.Serializable
+
+// TODO: Decision on appropriate defaults
+// TODO: Can this be made configurable at built time?
+// TODO: More complex styles? Like bold or italic plus background and text colors?
+private val defaultUtteranceStyle = Decoration.Style.Highlight(tint = Color.YELLOW)
+private val defaultCurrentRangeStyle = Decoration.Style.Underline(tint = Color.RED)
+
+/**
+ * Decoration preferences used in the Flutter Readium plugin.
+ */
+data class FlutterDecorationPreferences(
+    /**
+     * Style for utterance decoration.
+     */
+    var utteranceStyle: Decoration.Style? = defaultUtteranceStyle,
+
+    /**
+     * Style for current reading range decoration.
+     */
+    var currentRangeStyle: Decoration.Style? = defaultCurrentRangeStyle
+) : Serializable {
+    companion object {
+        /**
+         * Create Decoration.Style from map.
+         */
+        fun fromMap(
+            uttDecoMap: Map<*, *>?,
+            rangeDecoMap: Map<*, *>?
+        ): FlutterDecorationPreferences {
+            return FlutterDecorationPreferences(
+                decorationStyleFromMap(uttDecoMap) ?: defaultUtteranceStyle,
+                decorationStyleFromMap(rangeDecoMap) ?: defaultCurrentRangeStyle,
+            )
+        }
+    }
+}

flutter_readium/android/src/main/kotlin/dk/nota/flutter_readium/FlutterReadiumPlugin.kt

@@ -19,11 +19,14 @@ private const val TAG = "FlutterReadiumPlugin"
 
 @ExperimentalCoroutinesApi
 class FlutterReadiumPlugin : FlutterPlugin, ActivityAware, MethodCallHandler {
-    /// The MethodChannel that will the communication between Flutter and native Android
-    ///
-    /// This local reference serves to register the plugin with the Flutter Engine and unregister it
-    /// when the Flutter Engine is detached from the Activity
+    /**
+      * The MethodChannel that will the communication between Flutter and native Android
+      *
+      * This local reference serves to register the plugin with the Flutter Engine and unregister it
+      * when the Flutter Engine is detached from the Activity
+      */
     private lateinit var publicationChannel: MethodChannel
+
     private lateinit var publicationMethodCallHandler: PublicationMethodCallHandler
 
     private lateinit var binaryMessenger: BinaryMessenger
@@ -64,6 +67,9 @@ class FlutterReadiumPlugin : FlutterPlugin, ActivityAware, MethodCallHandler {
         publicationChannel.setMethodCallHandler(null)
     }
 
+    /**
+     * Recursively list all asset files in the given root path.
+     */
     private fun listAssetFiles(c: Context, rootPath: String): List<String> {
         Log.i("ListAssetFiles", "Listing assets in $rootPath")
         val files: MutableList<String> = ArrayList()

flutter_readium/android/src/main/kotlin/dk/nota/flutter_readium/FlutterTtsPreferences.kt

@@ -7,6 +7,9 @@ import org.readium.navigator.media.tts.android.AndroidTtsPreferences
 import org.readium.r2.shared.ExperimentalReadiumApi
 import org.readium.r2.shared.util.Language
 
+/**
+ * TTS preferences used in the Flutter Readium plugin.
+ */
 @Serializable
 data class FlutterTtsPreferences(
     val language: String? = null,
@@ -15,6 +18,9 @@ data class FlutterTtsPreferences(
     val voices: Map<String, String>? = null,
     val controlPanelInfoType: ControlPanelInfoType? = ControlPanelInfoType.STANDARD,
 ) {
+    /**
+     * Convert to AndroidTtsPreferences.
+     */
     @OptIn(ExperimentalReadiumApi::class)
     fun toAndroidTtsPreferences(): AndroidTtsPreferences {
         return AndroidTtsPreferences(
@@ -36,10 +42,16 @@ data class FlutterTtsPreferences(
         )
 
     companion object {
+        /**
+         * Create FlutterTtsPreferences from JSON string.
+         */
         fun fromJSON(json: String): FlutterTtsPreferences {
             return fromJSON(JSONObject(json))
         }
 
+        /**
+         * Create FlutterTtsPreferences from JSON object.
+         */
         fun fromJSON(jsonObject: JSONObject): FlutterTtsPreferences {
             val voicesMap = mutableMapOf<String, String>()
             if (jsonObject.has("voices")) {
@@ -62,6 +74,9 @@ data class FlutterTtsPreferences(
             )
         }
 
+        /**
+         * Convert FlutterTtsPreferences to JSON object.
+         */
         fun toJSON(preferences: FlutterTtsPreferences): JSONObject {
             val jsonObject = JSONObject()
             jsonObject.put("language", preferences.language)
@@ -76,6 +91,9 @@ data class FlutterTtsPreferences(
             return jsonObject
         }
 
+        /**
+         * Create FlutterTtsPreferences from a map.
+         */
         fun fromMap(prefs: Map<*, *>?): FlutterTtsPreferences {
             val voices = (prefs?.get("voices") as? Map<*, *>)?.mapNotNull {
                 val key = it.key as? String

flutter_readium/android/src/main/kotlin/dk/nota/flutter_readium/PluginMediaService.kt

@@ -48,7 +48,6 @@ import kotlinx.coroutines.flow.asStateFlow
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.onEach
 import kotlinx.coroutines.flow.sample
-import kotlinx.coroutines.launch
 import org.readium.navigator.media.common.Media3Adapter
 import org.readium.navigator.media.common.MediaNavigator
 import org.readium.r2.shared.ExperimentalReadiumApi
@@ -365,7 +364,7 @@ class PluginSimpleBasePlayer(player: Player) : ForwardingSimpleBasePlayer(player
         positionMs: Long,
         seekCommand: Int
     ): ListenableFuture<*> {
-        // NOTE: Maps seek to next/previous track, to seek forward/backward.
+        // NOTE: Maps seek to next/previous track, to seek forward/backward in current track.
         if (seekCommand == COMMAND_SEEK_TO_NEXT) {
             return super.handleSeek(mediaItemIndex, positionMs, COMMAND_SEEK_FORWARD)
         } else if (seekCommand == COMMAND_SEEK_TO_PREVIOUS) {
@@ -376,73 +375,67 @@ class PluginSimpleBasePlayer(player: Player) : ForwardingSimpleBasePlayer(player
 
     // FIX: Hacky way to fix missing COMMAND_GET_TIMELINE from TtsSessionAdapter
     override fun getState(): State {
+        // This is a copy & override of the super implementation, due to assert on empty playlist,
+        // which Readium TTSPlayer sometimes provides during active states.
+        // See https://github.com/readium/kotlin-toolkit/pull/716
+
         // Ordered alphabetically by State.Builder setters.
         val state = State.Builder()
-        //val positionSuppliers = livePositionSuppliers
-//        if (player.isCommandAvailable(COMMAND_GET_CURRENT_MEDIA_ITEM)) {
-//            state.setAdBufferedPositionMs(positionSuppliers.bufferedPositionSupplier)
-//            state.setAdPositionMs(positionSuppliers.currentPositionSupplier)
-//        }
+//      val positionSuppliers = livePositionSuppliers
         if (player.isCommandAvailable(COMMAND_GET_AUDIO_ATTRIBUTES)) {
-            state.setAudioAttributes(player.getAudioAttributes())
+            state.setAudioAttributes(player.audioAttributes)
         }
-        state.setAvailableCommands(player.getAvailableCommands())
+        state.setAvailableCommands(player.availableCommands)
         if (player.isCommandAvailable(COMMAND_GET_CURRENT_MEDIA_ITEM)) {
             state.setContentPositionMs { player.contentPosition }
             state.setContentBufferedPositionMs { player.contentBufferedPosition }
 //          state.setContentBufferedPositionMs(positionSuppliers.contentBufferedPositionSupplier)
 //          state.setContentPositionMs(positionSuppliers.contentPositionSupplier)
         }
         if (player.isCommandAvailable(COMMAND_GET_TEXT)) {
-            state.setCurrentCues(player.getCurrentCues())
+            state.setCurrentCues(player.currentCues)
         }
         //if (player.isCommandAvailable(COMMAND_GET_TIMELINE)) {
-        state.setCurrentMediaItemIndex(player.getCurrentMediaItemIndex())
+        state.setCurrentMediaItemIndex(player.currentMediaItemIndex)
         //}
         state.setDeviceInfo(player.getDeviceInfo())
         if (player.isCommandAvailable(COMMAND_GET_DEVICE_VOLUME)) {
-            state.setDeviceVolume(player.getDeviceVolume())
-            state.setIsDeviceMuted(player.isDeviceMuted())
+            state.setDeviceVolume(player.deviceVolume)
+            state.setIsDeviceMuted(player.isDeviceMuted)
         }
-        state.setIsLoading(player.isLoading())
-        state.setMaxSeekToPreviousPositionMs(player.getMaxSeekToPreviousPosition())
-        state.setPlaybackParameters(player.getPlaybackParameters())
-        state.setPlaybackState(player.getPlaybackState())
-        state.setPlaybackSuppressionReason(player.getPlaybackSuppressionReason())
-        state.setPlayerError(player.getPlayerError())
+        state.setIsLoading(player.isLoading)
+        state.setMaxSeekToPreviousPositionMs(player.maxSeekToPreviousPosition)
+        state.setPlaybackParameters(player.playbackParameters)
+        state.setPlaybackState(player.playbackState)
+        state.setPlaybackSuppressionReason(player.playbackSuppressionReason)
+        state.setPlayerError(player.playerError)
         //if (player.isCommandAvailable(COMMAND_GET_TIMELINE)) {
         val tracks =
             if (player.isCommandAvailable(COMMAND_GET_TRACKS))
-                player.getCurrentTracks()
+                player.currentTracks
             else
                 Tracks.EMPTY
         val mediaMetadata =
-            if (player.isCommandAvailable(COMMAND_GET_METADATA)) player.getMediaMetadata() else null
-        state.setPlaylist(player.getCurrentTimeline(), tracks, mediaMetadata)
+            if (player.isCommandAvailable(COMMAND_GET_METADATA)) player.mediaMetadata else null
+        state.setPlaylist(player.currentTimeline, tracks, mediaMetadata)
         //}
         if (player.isCommandAvailable(COMMAND_GET_METADATA)) {
-            state.setPlaylistMetadata(player.getPlaylistMetadata())
+            state.setPlaylistMetadata(player.playlistMetadata)
         }
-        state.setPlayWhenReady(player.getPlayWhenReady(), PLAY_WHEN_READY_CHANGE_REASON_END_OF_MEDIA_ITEM)
-//        if (pendingPositionDiscontinuityNewPositionMs != C.TIME_UNSET) {
-//            state.setPositionDiscontinuity(
-//                pendingDiscontinuityReason, pendingPositionDiscontinuityNewPositionMs
-//            )
-//            pendingPositionDiscontinuityNewPositionMs = C.TIME_UNSET
-//        }
-        state.setRepeatMode(player.getRepeatMode())
-        state.setSeekBackIncrementMs(player.getSeekBackIncrement())
-        state.setSeekForwardIncrementMs(player.getSeekForwardIncrement())
-        state.setShuffleModeEnabled(player.getShuffleModeEnabled())
-        state.setSurfaceSize(player.getSurfaceSize())
+        state.setPlayWhenReady(player.playWhenReady, PLAY_WHEN_READY_CHANGE_REASON_END_OF_MEDIA_ITEM)
+        state.setRepeatMode(player.repeatMode)
+        state.setSeekBackIncrementMs(player.seekBackIncrement)
+        state.setSeekForwardIncrementMs(player.seekForwardIncrement)
+        state.setShuffleModeEnabled(player.shuffleModeEnabled)
+        state.setSurfaceSize(player.surfaceSize)
         //state.setTimedMetadata(lastTimedMetadata)
         if (player.isCommandAvailable(COMMAND_GET_CURRENT_MEDIA_ITEM)) {
             state.setTotalBufferedDurationMs { player.totalBufferedDuration }
         }
-        state.setTrackSelectionParameters(player.getTrackSelectionParameters())
-        state.setVideoSize(player.getVideoSize())
+        state.setTrackSelectionParameters(player.trackSelectionParameters)
+        state.setVideoSize(player.videoSize)
         if (player.isCommandAvailable(COMMAND_GET_VOLUME)) {
-            state.setVolume(player.getVolume())
+            state.setVolume(player.volume)
         }
         return state.build()
     }