Merge branch 'v3' into fix/opds-models

CHANGELOG.md

@@ -17,6 +17,10 @@ All notable changes to this project will be documented in this file. Take a look
 * Scroll mode: jumping between two EPUB resources with a horizontal swipe triggers the `Navigator.Listener.onJumpToLocator()` callback.
     * This can be used to allow the user to go back to their previous location if they swiped across chapters by mistake.
 * Support for keyboard events in the EPUB, PDF and image navigators. See `VisualNavigator.addInputListener()`.
+* Support for non-linear EPUB resources with an opt-in in reading apps (contributed by @chrfalch in [#375](https://github.com/readium/kotlin-toolkit/pull/375) and [#376](https://github.com/readium/kotlin-toolkit/pull/376)).
+     1. Override loading non-linear resources with `VisualNavigator.Listener.shouldJumpToLink()`.
+     2. Present a new `EpubNavigatorFragment` by providing a custom `readingOrder` with only this resource to the constructor.
+
 
 #### Streamer
 

docs/migration-guide.md

@@ -78,10 +78,28 @@ val MIGRATION_HREF = object : Migration(1, 2) {
 }
 ```
 
+### LcpDialogAuthentication now supports configuration changes.
+
+You no longer need to pass an activity, fragment or view as `sender` to `retrievePassphrase`.
+Instead, call `onParentViewAttachedToWindow` every time you have a
+view attached to a window available as anchor and `onParentViewDetachedFromWindow` every time it
+gets detached. You can monitor these events by setting a `View.OnAttachStateChangeListener` on your
+view.
+
+See the [test-app](https://github.com/readium/kotlin-toolkit/blob/01d6c7936accea2d6b953d435e669260676e8c99/test-app/src/main/java/org/readium/r2/testapp/bookshelf/BookshelfFragment.kt#L68)
+for an example.
+
 ### All resources now have the prefix `readium_`.
 
 To avoid conflicts when merging your app resources, all resources declared in the Readium toolkit now have the prefix `readium_`. This means that you must rename any layouts or strings you have overridden. Here is a comprehensive list of the changes.
 
+### Pdfium and PSPDFKit adapters' namespaces slightly changed
+
+`org.readium.adapters.pspdfkit.document` moved to `org.readium.adapter.pdspdfKit.document`
+`org.readium.adapters.pspdfkit.navigator` moved to `org.readium.adapter.pdspdfKit.navigator`
+`org.readium.adapters.pdfium.document` moved to `org.readium.adapter.pdfium.document`
+`org.readium.adapters.pdfium.navigator` moved to `org.readium.adapter.pdfium.navigator`
+
 #### Layouts
 
 | Deprecated                  | New                                           |

readium/adapters/exoplayer/audio/build.gradle.kts

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2022 Readium Foundation. All rights reserved.
+ * Use of this source code is governed by the BSD-style license
+ * available in the top-level LICENSE file of the project.
+ */
+
+plugins {
+    id("com.android.library")
+    kotlin("android")
+    kotlin("plugin.parcelize")
+    kotlin("plugin.serialization")
+}
+
+android {
+    resourcePrefix = "readium_"
+
+    compileSdk = 34
+
+    defaultConfig {
+        minSdk = 21
+        targetSdk = 34
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_17
+        targetCompatibility = JavaVersion.VERSION_17
+    }
+    kotlinOptions {
+        jvmTarget = JavaVersion.VERSION_17.toString()
+        freeCompilerArgs = freeCompilerArgs + listOf(
+            "-opt-in=kotlin.RequiresOptIn",
+            "-opt-in=org.readium.r2.shared.InternalReadiumApi"
+        )
+    }
+    buildTypes {
+        getByName("release") {
+            isMinifyEnabled = false
+            proguardFiles(getDefaultProguardFile("proguard-android.txt"))
+        }
+    }
+    buildFeatures {
+        viewBinding = true
+    }
+    namespace = "org.readium.adapter.exoplayer.audio"
+}
+
+kotlin {
+    explicitApi()
+}
+
+rootProject.ext["publish.artifactId"] = "readium-navigator-exoplayer-audio"
+apply(from = "$rootDir/scripts/publish-module.gradle")
+
+dependencies {
+    api(project(":readium:readium-shared"))
+    api(project(":readium:navigators:media:readium-navigator-media-audio"))
+
+    implementation(libs.androidx.media3.common)
+    implementation(libs.androidx.media3.exoplayer)
+    implementation(libs.timber)
+    implementation(libs.bundles.coroutines)
+    implementation(libs.kotlinx.serialization.json)
+
+    // Tests
+    testImplementation(libs.junit)
+}

readium/navigator/src/main/java/org/readium/r2/navigator/media3/exoplayer/ExoAudiobookPlayer.kt → readium/adapters/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoAudiobookPlayer.kt

@@ -4,15 +4,14 @@
  * available in the top-level LICENSE file of the project.
  */
 
-package org.readium.r2.navigator.media3.exoplayer
+package org.readium.adapter.exoplayer.audio
 
 import androidx.media3.common.ForwardingPlayer
 import androidx.media3.exoplayer.ExoPlaybackException
 import androidx.media3.exoplayer.ExoPlayer
 import kotlin.time.Duration
 import kotlin.time.Duration.Companion.milliseconds
 import kotlin.time.ExperimentalTime
-import org.readium.r2.navigator.media3.audio.SmartSeeker
 import timber.log.Timber
 
 /**

readium/navigator/src/main/java/org/readium/r2/navigator/media3/exoplayer/ExoPlayerAliases.kt → readium/adapters/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerAliases.kt

@@ -4,10 +4,10 @@
  * available in the top-level LICENSE file of the project.
  */
 
-package org.readium.r2.navigator.media3.exoplayer
+package org.readium.adapter.exoplayer.audio
 
-import org.readium.r2.navigator.media3.audio.AudioNavigator
-import org.readium.r2.navigator.media3.audio.AudioNavigatorFactory
+import org.readium.navigator.media.audio.AudioNavigator
+import org.readium.navigator.media.audio.AudioNavigatorFactory
 import org.readium.r2.shared.ExperimentalReadiumApi
 
 @OptIn(ExperimentalReadiumApi::class)

readium/navigator/src/main/java/org/readium/r2/navigator/media3/exoplayer/ExoPlayerDataSource.kt → readium/adapters/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerDataSource.kt

@@ -4,7 +4,7 @@
  * available in the top-level LICENSE file of the project.
  */
 
-package org.readium.r2.navigator.media3.exoplayer
+package org.readium.adapter.exoplayer.audio
 
 import android.net.Uri
 import androidx.media3.common.C.LENGTH_UNSET
@@ -16,18 +16,18 @@ import androidx.media3.datasource.TransferListener
 import java.io.IOException
 import kotlinx.coroutines.runBlocking
 import org.readium.r2.shared.publication.Publication
-import org.readium.r2.shared.resource.Resource
-import org.readium.r2.shared.resource.buffered
 import org.readium.r2.shared.util.getOrThrow
+import org.readium.r2.shared.util.resource.Resource
+import org.readium.r2.shared.util.resource.buffered
 import org.readium.r2.shared.util.toUrl
 
-public sealed class ExoPlayerDataSourceException(message: String, cause: Throwable?) : IOException(
+internal sealed class ExoPlayerDataSourceException(message: String, cause: Throwable?) : IOException(
     message,
     cause
 ) {
-    public class NotOpened(message: String) : ExoPlayerDataSourceException(message, null)
-    public class NotFound(message: String) : ExoPlayerDataSourceException(message, null)
-    public class ReadFailed(uri: Uri, offset: Int, readLength: Int, cause: Throwable) : ExoPlayerDataSourceException(
+    class NotOpened(message: String) : ExoPlayerDataSourceException(message, null)
+    class NotFound(message: String) : ExoPlayerDataSourceException(message, null)
+    class ReadFailed(uri: Uri, offset: Int, readLength: Int, cause: Throwable) : ExoPlayerDataSourceException(
         "Failed to read $readLength bytes of URI $uri at offset $offset.",
         cause
     )

readium/navigator/src/main/java/org/readium/r2/navigator/media3/exoplayer/ExoPlayerDefaults.kt → readium/adapters/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerDefaults.kt

@@ -4,7 +4,7 @@
  * available in the top-level LICENSE file of the project.
  */
 
-package org.readium.r2.navigator.media3.exoplayer
+package org.readium.adapter.exoplayer.audio
 
 import org.readium.r2.shared.ExperimentalReadiumApi
 

readium/navigator/src/main/java/org/readium/r2/navigator/media3/exoplayer/ExoPlayerEngine.kt → readium/adapters/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerEngine.kt

@@ -4,7 +4,7 @@
  * available in the top-level LICENSE file of the project.
  */
 
-package org.readium.r2.navigator.media3.exoplayer
+package org.readium.adapter.exoplayer.audio
 
 import android.app.Application
 import androidx.media3.common.*
@@ -19,12 +19,12 @@ import kotlinx.coroutines.*
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.asStateFlow
-import org.readium.r2.navigator.media3.audio.AudioEngine
+import org.readium.navigator.media.audio.AudioEngine
 import org.readium.r2.shared.ExperimentalReadiumApi
-import org.readium.r2.shared.units.Hz
-import org.readium.r2.shared.units.hz
 import org.readium.r2.shared.util.Url
 import org.readium.r2.shared.util.toUri
+import org.readium.r2.shared.util.units.Hz
+import org.readium.r2.shared.util.units.hz
 
 /**
  * An [AudioEngine] based on Media3 ExoPlayer.

readium/navigator/src/main/java/org/readium/r2/navigator/media3/exoplayer/ExoPlayerEngineProvider.kt → readium/adapters/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerEngineProvider.kt

@@ -4,16 +4,16 @@
  * available in the top-level LICENSE file of the project.
  */
 
-package org.readium.r2.navigator.media3.exoplayer
+package org.readium.adapter.exoplayer.audio
 
 import android.app.Application
 import androidx.media3.datasource.DataSource
 import kotlin.time.Duration
 import kotlin.time.Duration.Companion.seconds
+import org.readium.navigator.media.audio.AudioEngineProvider
+import org.readium.navigator.media.common.DefaultMediaMetadataProvider
+import org.readium.navigator.media.common.MediaMetadataProvider
 import org.readium.r2.navigator.extensions.time
-import org.readium.r2.navigator.media3.api.DefaultMediaMetadataProvider
-import org.readium.r2.navigator.media3.api.MediaMetadataProvider
-import org.readium.r2.navigator.media3.audio.AudioEngineProvider
 import org.readium.r2.shared.ExperimentalReadiumApi
 import org.readium.r2.shared.publication.Locator
 import org.readium.r2.shared.publication.Publication

readium/navigator/src/main/java/org/readium/r2/navigator/media3/exoplayer/ExoPlayerPreferences.kt → readium/adapters/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerPreferences.kt

@@ -4,7 +4,7 @@
  * available in the top-level LICENSE file of the project.
  */
 
-package org.readium.r2.navigator.media3.exoplayer
+package org.readium.adapter.exoplayer.audio
 
 import org.readium.r2.navigator.preferences.Configurable
 import org.readium.r2.shared.ExperimentalReadiumApi

readium/navigator/src/main/java/org/readium/r2/navigator/media3/exoplayer/ExoPlayerPreferencesEditor.kt → readium/adapters/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerPreferencesEditor.kt

@@ -4,7 +4,7 @@
  * available in the top-level LICENSE file of the project.
  */
 
-package org.readium.r2.navigator.media3.exoplayer
+package org.readium.adapter.exoplayer.audio
 
 import org.readium.r2.navigator.extensions.format
 import org.readium.r2.navigator.preferences.DoubleIncrement

readium/navigator/src/main/java/org/readium/r2/navigator/media3/exoplayer/ExoPlayerPreferencesSerializer.kt → readium/adapters/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerPreferencesSerializer.kt

@@ -4,7 +4,7 @@
  * available in the top-level LICENSE file of the project.
  */
 
-package org.readium.r2.navigator.media3.exoplayer
+package org.readium.adapter.exoplayer.audio
 
 import kotlinx.serialization.json.Json
 import org.readium.r2.navigator.preferences.PreferencesSerializer

readium/navigator/src/main/java/org/readium/r2/navigator/media3/exoplayer/ExoPlayerSettings.kt → readium/adapters/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerSettings.kt

@@ -4,7 +4,7 @@
  * available in the top-level LICENSE file of the project.
  */
 
-package org.readium.r2.navigator.media3.exoplayer
+package org.readium.adapter.exoplayer.audio
 
 import org.readium.r2.navigator.preferences.Configurable
 import org.readium.r2.shared.ExperimentalReadiumApi

readium/navigator/src/main/java/org/readium/r2/navigator/media3/exoplayer/ExoPlayerSettingsResolver.kt → readium/adapters/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerSettingsResolver.kt

@@ -4,7 +4,7 @@
  * available in the top-level LICENSE file of the project.
  */
 
-package org.readium.r2.navigator.media3.exoplayer
+package org.readium.adapter.exoplayer.audio
 
 import org.readium.r2.shared.ExperimentalReadiumApi
 

readium/navigator/src/main/java/org/readium/r2/navigator/media3/audio/SmartSeeker.kt → readium/adapters/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/SmartSeeker.kt

@@ -4,7 +4,7 @@
  * available in the top-level LICENSE file of the project.
  */
 
-package org.readium.r2.navigator.media3.audio
+package org.readium.adapter.exoplayer.audio
 
 import kotlin.time.Duration
 import kotlin.time.ExperimentalTime

readium/navigator/src/test/java/org/readium/r2/navigator/audio/SmartSeekerTest.kt → readium/adapters/exoplayer/audio/src/test/java/org/readium/adapter/exoplayer/audio/SmartSeekerTest.kt

@@ -1,11 +1,10 @@
-package org.readium.r2.navigator.audio
+package org.readium.adapter.exoplayer.audio
 
 import kotlin.time.Duration
 import kotlin.time.Duration.Companion.seconds
 import kotlin.time.ExperimentalTime
 import org.junit.Assert.assertEquals
 import org.junit.Test
-import org.readium.r2.navigator.media3.audio.SmartSeeker
 
 @OptIn(ExperimentalTime::class)
 class SmartSeekerTest {

readium/adapters/exoplayer/build.gradle.kts

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2022 Readium Foundation. All rights reserved.
+ * Use of this source code is governed by the BSD-style license
+ * available in the top-level LICENSE file of the project.
+ */
+
+plugins {
+    id("com.android.library")
+    kotlin("android")
+    kotlin("plugin.parcelize")
+}
+
+android {
+    resourcePrefix = "readium_"
+
+    compileSdk = 34
+
+    defaultConfig {
+        minSdk = 21
+        targetSdk = 34
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_17
+        targetCompatibility = JavaVersion.VERSION_17
+    }
+    kotlinOptions {
+        jvmTarget = JavaVersion.VERSION_17.toString()
+        freeCompilerArgs = freeCompilerArgs + listOf(
+            "-opt-in=kotlin.RequiresOptIn",
+            "-opt-in=org.readium.r2.shared.InternalReadiumApi"
+        )
+    }
+    buildTypes {
+        getByName("release") {
+            isMinifyEnabled = false
+            proguardFiles(getDefaultProguardFile("proguard-android.txt"))
+        }
+    }
+    namespace = "org.readium.adapter.exoplayer"
+}
+
+kotlin {
+    explicitApi()
+}
+
+rootProject.ext["publish.artifactId"] = "readium-adapter-exoplayer"
+apply(from = "$rootDir/scripts/publish-module.gradle")
+
+dependencies {
+    api(project(":readium:adapters:exoplayer:readium-adapter-exoplayer-audio"))
+}

readium/adapters/pdfium/build.gradle.kts

@@ -37,7 +37,7 @@ android {
             proguardFiles(getDefaultProguardFile("proguard-android.txt"))
         }
     }
-    namespace = "org.readium.adapters.pdfium"
+    namespace = "org.readium.adapter.pdfium"
 }
 
 kotlin {

readium/adapters/pdfium/pdfium-document/build.gradle.kts → readium/adapters/pdfium/document/build.gradle.kts

@@ -40,7 +40,7 @@ android {
     buildFeatures {
         viewBinding = true
     }
-    namespace = "org.readium.adapters.pdfium.document"
+    namespace = "org.readium.adapter.pdfium.document"
 }
 
 kotlin {

readium/adapters/pdfium/document/src/main/AndroidManifest.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest />
+

readium/adapters/pdfium/pdfium-document/src/main/java/org/readium/adapters/pdfium/document/PdfiumDocument.kt → readium/adapters/pdfium/document/src/main/java/org/readium/adapter/pdfium/document/PdfiumDocument.kt

@@ -4,7 +4,7 @@
  * available in the top-level LICENSE file of the project.
  */
 
-package org.readium.adapters.pdfium.document
+package org.readium.adapter.pdfium.document
 
 import android.content.Context
 import android.graphics.Bitmap
@@ -18,12 +18,12 @@ import kotlinx.coroutines.withContext
 import org.readium.r2.shared.InternalReadiumApi
 import org.readium.r2.shared.extensions.md5
 import org.readium.r2.shared.extensions.tryOrNull
-import org.readium.r2.shared.resource.Resource
-import org.readium.r2.shared.resource.ResourceTry
-import org.readium.r2.shared.resource.mapCatching
 import org.readium.r2.shared.util.Try
 import org.readium.r2.shared.util.pdf.PdfDocument
 import org.readium.r2.shared.util.pdf.PdfDocumentFactory
+import org.readium.r2.shared.util.resource.Resource
+import org.readium.r2.shared.util.resource.ResourceTry
+import org.readium.r2.shared.util.resource.mapCatching
 import org.readium.r2.shared.util.use
 import timber.log.Timber