@readium/navigator 2.4.0-alpha.9 → 2.4.0-beta.1

package/types/src/audio/engine/PreservePitchWorklet.d.ts

@@ -0,0 +1,18 @@
+interface PreservePitchWorkletOptions {
+    ctx: AudioContext;
+    mediaElement?: HTMLMediaElement;
+    pitchFactor?: number;
+    modulePath?: string;
+}
+export declare class PreservePitchWorklet {
+    mediaElement: HTMLMediaElement | null;
+    source: MediaElementAudioSourceNode | null;
+    ctx: AudioContext;
+    workletNode: AudioWorkletNode | null;
+    url: string | null;
+    static createWorklet(options: PreservePitchWorkletOptions): Promise<PreservePitchWorklet>;
+    constructor(ctx: AudioContext);
+    updatePitchFactor(factor: number): void;
+    destroy(): void;
+}
+export {};

package/types/src/audio/engine/WebAudioEngine.d.ts

@@ -1,6 +1,4 @@
 import { AudioEngine, Playback } from "./AudioEngine";
-import { Publication } from "@readium/shared";
-import { Locator } from "@readium/shared";
 type EventCallback = (data: any) => void;
 export declare class WebAudioEngine implements AudioEngine {
     readonly playback: Playback;
@@ -9,15 +7,33 @@ export declare class WebAudioEngine implements AudioEngine {
     private sourceNode;
     private gainNode;
     private listeners;
+    private currentPlaybackRate;
     private isMutedValue;
     private isPlayingValue;
     private isPausedValue;
     private isLoadingValue;
     private isLoadedValue;
     private isEndedValue;
+    private isStoppedValue;
+    private worklet;
+    private webAudioActive;
+    private readonly boundOnCanPlayThrough;
+    private readonly boundOnTimeUpdate;
+    private readonly boundOnError;
+    private readonly boundOnEnded;
+    private readonly boundOnStalled;
+    private readonly boundOnEmptied;
+    private readonly boundOnSuspend;
+    private readonly boundOnWaiting;
+    private readonly boundOnLoadedMetadata;
+    private readonly boundOnSeeking;
+    private readonly boundOnSeeked;
+    private readonly boundOnPlay;
+    private readonly boundOnPlaying;
+    private readonly boundOnPause;
+    private readonly boundOnProgress;
     constructor(values: {
         playback: Playback;
-        audioContext: AudioContext;
     });
     /**
      * Adds an event listener to the audio engine.
@@ -36,16 +52,30 @@ export declare class WebAudioEngine implements AudioEngine {
      * @param url The URL of the audio resource.
      * */
     loadAudio(url: string): void;
+    private deactivateWebAudio;
+    /**
+     * Sets the media element for playback.
+     * @param element The HTML audio element to use.
+     */
+    setMediaElement(element: HTMLAudioElement): void;
     private ensureAudioContextRunning;
+    private getOrCreateAudioContext;
     private onTimeUpdate;
     private onCanPlayThrough;
     private onError;
     private onEnded;
+    private onStalled;
+    private onEmptied;
+    private onSuspend;
+    private onWaiting;
+    private onLoadedMetadata;
+    private onSeeking;
+    private onSeeked;
+    private onPlay;
+    private onPlaying;
+    private onPause;
+    private onProgress;
     private emit;
-    /**
-     * Plays the audio resource at the given locator.
-     */
-    playLocator(_publication: Publication, _locator: Locator): Promise<void>;
     /**
      * Plays the current audio resource.
      */
@@ -103,5 +133,20 @@ export declare class WebAudioEngine implements AudioEngine {
      * Returns whether the audio resource is currently muted.
      */
     isMuted(): boolean;
+    /**
+     * Sets the playback rate of the audio resource with pitch preservation.
+     */
+    setPlaybackRate(rate: number, preservePitch: boolean): void;
+    /**
+     * Activates the Web Audio graph for the current media element.
+     * Sets crossOrigin = "anonymous" and reloads so MediaElementAudioSourceNode can be used.
+     * No-ops if Web Audio is already active.
+     */
+    private activateWebAudio;
+    get isWebAudioActive(): boolean;
+    /**
+     * Returns the HTML media element used for playback.
+     */
+    getMediaElement(): HTMLMediaElement;
 }
 export {};

package/types/src/audio/index.d.ts

@@ -1 +1,3 @@
 export * from './engine';
+export * from './preferences';
+export * from './AudioNavigator';

package/types/src/audio/preferences/AudioDefaults.d.ts

@@ -0,0 +1,21 @@
+export interface IAudioDefaults {
+    volume?: number | null;
+    playbackRate?: number | null;
+    preservePitch?: boolean | null;
+    skipBackwardInterval?: number | null;
+    skipForwardInterval?: number | null;
+    pollInterval?: number | null;
+    autoPlay?: boolean | null;
+    enableMediaSession?: boolean | null;
+}
+export declare class AudioDefaults {
+    readonly volume: number;
+    readonly playbackRate: number;
+    readonly preservePitch: boolean;
+    readonly skipBackwardInterval: number;
+    readonly skipForwardInterval: number;
+    readonly pollInterval: number;
+    readonly autoPlay: boolean;
+    readonly enableMediaSession: boolean;
+    constructor(defaults?: IAudioDefaults);
+}

package/types/src/audio/preferences/AudioPreferences.d.ts

@@ -0,0 +1,23 @@
+import { ConfigurablePreferences } from "../../preferences/Configurable";
+export interface IAudioPreferences {
+    volume?: number | null;
+    playbackRate?: number | null;
+    preservePitch?: boolean | null;
+    skipBackwardInterval?: number | null;
+    skipForwardInterval?: number | null;
+    pollInterval?: number | null;
+    autoPlay?: boolean | null;
+    enableMediaSession?: boolean | null;
+}
+export declare class AudioPreferences implements ConfigurablePreferences<AudioPreferences> {
+    readonly volume: number | null | undefined;
+    readonly playbackRate: number | null | undefined;
+    readonly preservePitch: boolean | null | undefined;
+    readonly skipBackwardInterval: number | null | undefined;
+    readonly skipForwardInterval: number | null | undefined;
+    readonly pollInterval: number | null | undefined;
+    readonly autoPlay: boolean | null | undefined;
+    readonly enableMediaSession: boolean | null | undefined;
+    constructor(preferences?: IAudioPreferences);
+    merging(other: AudioPreferences): AudioPreferences;
+}

package/types/src/audio/preferences/AudioPreferencesEditor.d.ts

@@ -0,0 +1,19 @@
+import { IPreferencesEditor } from "../../preferences/PreferencesEditor";
+import { AudioPreferences } from "./AudioPreferences";
+import { AudioSettings } from "./AudioSettings";
+import { Preference, BooleanPreference, RangePreference } from "../../preferences/Preference";
+export declare class AudioPreferencesEditor implements IPreferencesEditor {
+    preferences: AudioPreferences;
+    private settings;
+    constructor(initialPreferences: AudioPreferences, settings: AudioSettings);
+    clear(): void;
+    private updatePreference;
+    get volume(): RangePreference<number>;
+    get playbackRate(): RangePreference<number>;
+    get preservePitch(): BooleanPreference;
+    get skipBackwardInterval(): RangePreference<number>;
+    get skipForwardInterval(): RangePreference<number>;
+    get pollInterval(): Preference<number>;
+    get autoPlay(): BooleanPreference;
+    get enableMediaSession(): BooleanPreference;
+}

package/types/src/audio/preferences/AudioSettings.d.ts

@@ -0,0 +1,24 @@
+import { AudioPreferences } from "./AudioPreferences";
+import { AudioDefaults } from "./AudioDefaults";
+import { ConfigurableSettings } from "../../preferences/Configurable";
+export interface IAudioSettings extends ConfigurableSettings {
+    volume: number;
+    playbackRate: number;
+    preservePitch: boolean;
+    skipBackwardInterval: number;
+    skipForwardInterval: number;
+    pollInterval: number;
+    autoPlay: boolean;
+    enableMediaSession: boolean;
+}
+export declare class AudioSettings implements IAudioSettings, ConfigurableSettings {
+    readonly volume: number;
+    readonly playbackRate: number;
+    readonly preservePitch: boolean;
+    readonly skipBackwardInterval: number;
+    readonly skipForwardInterval: number;
+    readonly pollInterval: number;
+    readonly autoPlay: boolean;
+    readonly enableMediaSession: boolean;
+    constructor(preferences: AudioPreferences, defaults: AudioDefaults);
+}

package/types/src/audio/preferences/index.d.ts

@@ -0,0 +1,4 @@
+export * from './AudioPreferences';
+export * from './AudioDefaults';
+export * from './AudioSettings';
+export * from './AudioPreferencesEditor';

package/types/src/epub/EpubNavigator.d.ts

@@ -1,5 +1,5 @@
 import { Layout, Link, Locator, Publication, ReadingProgression } from "@readium/shared";
-import { Configurable, ConfigurablePreferences, ConfigurableSettings, VisualNavigator, VisualNavigatorViewport } from "../";
+import { Configurable, ConfigurableSettings, VisualNavigator, VisualNavigatorViewport } from "../";
 import { FramePoolManager } from "./frame/FramePoolManager";
 import { FXLFramePoolManager } from "./fxl/FXLFramePoolManager";
 import { CommsEventKey, ContextMenuEvent, KeyboardEventData } from "@readium/navigator-html-injectables";
@@ -35,7 +35,7 @@ export interface EpubNavigatorListeners {
     contextMenu: (data: ContextMenuEvent) => void;
     peripheral: (data: KeyboardEventData) => void;
 }
-export declare class EpubNavigator extends VisualNavigator implements Configurable<ConfigurableSettings, ConfigurablePreferences> {
+export declare class EpubNavigator extends VisualNavigator implements Configurable<ConfigurableSettings, EpubPreferences> {
     private readonly pub;
     private readonly container;
     private readonly listeners;

package/types/src/epub/frame/FrameBlobBuilder.d.ts

@@ -1,20 +1,17 @@
 import { Link, Publication } from "@readium/shared";
 import { Injector } from "../../injection/Injector";
-export default class FrameBlobBuilder {
-    private readonly pub;
-    private readonly baseURL;
+export default class FrameBlobBuider {
     private readonly item;
+    private readonly burl;
+    private readonly pub;
     private readonly cssProperties?;
     private readonly injector;
-    private currentUrl?;
-    private currentResource?;
     constructor(pub: Publication, baseURL: string, item: Link, options: {
         cssProperties?: {
             [key: string]: string;
         };
         injector?: Injector | null;
     });
-    reset(): void;
     build(fxl?: boolean): Promise<string>;
     private buildHtmlFrame;
     private buildImageFrame;

package/types/src/epub/fxl/FXLFrameManager.d.ts

@@ -5,7 +5,6 @@ import { FXLPeripherals } from "./FXLPeripherals";
 import { IContentProtectionConfig, IKeyboardPeripheralsConfig } from "../../Navigator";
 export declare class FXLFrameManager {
     private frame;
-    private frameIsAppended;
     private loader;
     source: string;
     private comms;
@@ -17,7 +16,6 @@ export declare class FXLFrameManager {
     debugHref: string;
     private loadPromise;
     private showPromise;
-    private viewportSize;
     constructor(peripherals: FXLPeripherals, direction: ReadingProgression, debugHref: string, contentProtectionConfig?: IContentProtectionConfig, keyboardPeripheralsConfig?: IKeyboardPeripheralsConfig);
     load(modules: ModuleName[], source: string): Promise<Window>;
     loadPageSize(): {

package/types/src/epub/preferences/EpubPreferences.d.ts

@@ -42,7 +42,7 @@ export interface IEpubPreferences {
     visitedColor?: string | null;
     wordSpacing?: number | null;
 }
-export declare class EpubPreferences implements ConfigurablePreferences {
+export declare class EpubPreferences implements ConfigurablePreferences<EpubPreferences> {
     backgroundColor?: string | null;
     blendFilter?: boolean | null;
     constraint?: number | null;
@@ -86,5 +86,5 @@ export declare class EpubPreferences implements ConfigurablePreferences {
     constructor(preferences?: IEpubPreferences);
     static serialize(preferences: EpubPreferences): string;
     static deserialize(preferences: string): EpubPreferences | null;
-    merging(other: ConfigurablePreferences): ConfigurablePreferences;
+    merging(other: EpubPreferences): EpubPreferences;
 }

package/types/src/preferences/Configurable.d.ts

@@ -2,9 +2,8 @@ import { IPreferencesEditor } from "./PreferencesEditor";
 export interface ConfigurableSettings {
     [key: string]: any;
 }
-export interface ConfigurablePreferences {
-    [key: string]: any;
-    merging(other: ConfigurablePreferences): ConfigurablePreferences;
+export interface ConfigurablePreferences<T> {
+    merging(other: T): T;
 }
 export interface Configurable<ConfigurableSettings, ConfigurablePreferences> {
     settings: ConfigurableSettings;

package/types/src/preferences/PreferencesEditor.d.ts

@@ -1,5 +1,5 @@
 import { ConfigurablePreferences } from "./Configurable";
 export interface IPreferencesEditor {
-    preferences: ConfigurablePreferences;
+    preferences: ConfigurablePreferences<unknown>;
     clear(): void;
 }

package/types/src/preferences/Types.d.ts

@@ -33,3 +33,6 @@ export declare const paragraphIndentRangeConfig: RangeConfig;
 export declare const paragraphSpacingRangeConfig: RangeConfig;
 export declare const wordSpacingRangeConfig: RangeConfig;
 export declare const zoomRangeConfig: RangeConfig;
+export declare const volumeRangeConfig: RangeConfig;
+export declare const playbackRateRangeConfig: RangeConfig;
+export declare const skipIntervalRangeConfig: RangeConfig;

package/types/src/webpub/WebPubNavigator.d.ts

@@ -7,7 +7,7 @@ import { ManagerEventKey } from "../epub/EpubNavigator";
 import { IWebPubPreferences, WebPubPreferences } from "./preferences/WebPubPreferences";
 import { IWebPubDefaults } from "./preferences/WebPubDefaults";
 import { WebPubSettings } from "./preferences/WebPubSettings";
-import { IPreferencesEditor } from "../preferences/PreferencesEditor";
+import { WebPubPreferencesEditor } from "./preferences/WebPubPreferencesEditor";
 import { IInjectablesConfig } from "../injection/Injectable";
 import { IContentProtectionConfig, IKeyboardPeripheralsConfig } from "../Navigator";
 export interface WebPubNavigatorConfiguration {
@@ -54,7 +54,7 @@ export declare class WebPubNavigator extends VisualNavigator implements Configur
     constructor(container: HTMLElement, pub: Publication, listeners: WebPubNavigatorListeners, initialPosition?: Locator | undefined, configuration?: WebPubNavigatorConfiguration);
     load(): Promise<void>;
     get settings(): Readonly<WebPubSettings>;
-    get preferencesEditor(): IPreferencesEditor;
+    get preferencesEditor(): WebPubPreferencesEditor;
     submitPreferences(preferences: WebPubPreferences): Promise<void>;
     private applyPreferences;
     private updateCSS;

package/types/src/webpub/preferences/WebPubPreferences.d.ts

@@ -17,7 +17,7 @@ export interface IWebPubPreferences {
     wordSpacing?: number | null;
     zoom?: number | null;
 }
-export declare class WebPubPreferences implements ConfigurablePreferences {
+export declare class WebPubPreferences implements ConfigurablePreferences<WebPubPreferences> {
     fontFamily?: string | null;
     fontWeight?: number | null;
     hyphens?: boolean | null;
@@ -36,5 +36,5 @@ export declare class WebPubPreferences implements ConfigurablePreferences {
     constructor(preferences?: IWebPubPreferences);
     static serialize(preferences: WebPubPreferences): string;
     static deserialize(preferences: string): WebPubPreferences | null;
-    merging(other: ConfigurablePreferences): ConfigurablePreferences;
+    merging(other: WebPubPreferences): WebPubPreferences;
 }

package/LICENSE

@@ -1,28 +0,0 @@
-BSD 3-Clause License
-
-Copyright (c) 2022, Readium Foundation
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.