senza-sdk 4.4.0 → 4.4.1-4ca75a1.0

package/dist/bundle.js.LICENSE.txt

@@ -10,6 +10,31 @@
  SPDX-License-Identifier: Apache-2.0
 */
 
+/*
+ @license
+ Copyright 2013 Ali Al Dallal
+
+ Licensed under the MIT license.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.
+*/
+
 /*
  @license
  EME Encryption Scheme Polyfill
@@ -45,6 +70,13 @@
  SPDX-License-Identifier: Apache-2.0
 */
 
+/*
+ @license
+ glMatrix: https://github.com/toji/gl-matrix/
+ Copyright 2015-2021, Brandon Jones, Colin MacKenzie IV
+ SPDX-License-Identifier: MIT
+*/
+
 /*
  @license
  tXml

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.4.0",
+    "version": "4.4.1-4ca75a1.0",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",

package/src/implementation/api.js

@@ -130,7 +130,7 @@ export async function init(interfaceApiVersion, showSequenceFunc, initSequenceFu
 
         // Initialize lifecycle first to make sure the state is updated.
         await lifecycle._init(sessionInfoObj?.settings?.["ui-streamer"], triggerEvent);
-        await remotePlayer._init(sessionInfoObj?.settings?.["ui-streamer"], triggerEvent);
+        await remotePlayer._init(sessionInfoObj, triggerEvent);
         alarmManager._init();
         messageManager._init();
         sdkLogger.log("All submodules initialized");

package/src/implementation/lifecycle.js

@@ -29,7 +29,9 @@ class Lifecycle extends LifecycleInterface {
          * @private
          */
         this._isInitialized = false;
-        this._inTransition = false;
+        this._inTransitionToForeground = false;
+        this._inTransitionToBackground = false;
+        this._inTransitionToStandby = false;
 
         /**
          * Event listeners manager for the userdisconnected event
@@ -310,7 +312,7 @@ class Lifecycle extends LifecycleInterface {
     // This api is part of epic HSDEV-713
     _moveToUiStandby() {
         if (window.cefQuery) {
-            this._inTransition = true;
+            this._inTransitionToStandby = true;
             return new Promise((resolve, reject) => {
                 const FCID = getFCID();
                 const request = { target: "TC", waitForResponse: false, internalAction: "uiExit", message: JSON.stringify({ type: "uiStandbyRequest", fcid: FCID }) };
@@ -321,12 +323,12 @@ class Lifecycle extends LifecycleInterface {
                     persistent: false,
                     onSuccess: () => {
                         logger.log("[ moveToUiStandby ] moveToUiStandby successfully sent");
-                        this._inTransition = false;
+                        this._inTransitionToStandby = false;
                         resolve(true);
                     },
                     onFailure: (code, msg) => {
                         logger.error(`[ moveToUiStandby ] moveToUiStandby failed: ${code} ${msg}`);
-                        this._inTransition = false;
+                        this._inTransitionToStandby = false;
                         reject(`moveToUiStandby failed: ${code} ${msg}`);
                     }
                 });
@@ -423,6 +425,14 @@ class Lifecycle extends LifecycleInterface {
         this._countdown = null;
     }
 
+    /**
+     * @private
+     */
+    _isInTransition() {
+        return this._inTransitionToForeground || this._inTransitionToBackground || this._inTransitionToStandby;
+    }
+
+
     getState() {
         if (window.cefQuery) {
             return new Promise((resolve, reject) => {
@@ -445,14 +455,19 @@ class Lifecycle extends LifecycleInterface {
 
     moveToForeground() {
         if (window.cefQuery) {
-            if (this._inTransition || this._state === this.UiState.FOREGROUND || this._state === this.UiState.IN_TRANSITION_TO_FOREGROUND) {
-                sdkLogger.warn(`lifecycle moveToForeground: No need to transition to foreground, state: ${this._state} transition: ${this._inTransition}`);
+            const inTransition = this._isInTransition();
+            if (inTransition || this._state === this.UiState.FOREGROUND || this._state === this.UiState.IN_TRANSITION_TO_FOREGROUND) {
+                sdkLogger.warn(`lifecycle moveToForeground: No need to transition to foreground, state: ${this._state} transition: ${inTransition}`);
                 return Promise.resolve(false);
             }
-            this._inTransition = true;
+            this._inTransitionToForeground = true;
             alarmManager._moveToForegroundCalled();
             const FCID = getFCID();
             if (this._remotePlayerApiVersion >= 2) {
+                // Only update to playing UI if we started seeking in ABR. But, if we are seeking while already paused, keep the target seek state as is.
+                if (remotePlayer._isSeekingByApplication && remotePlayer._targetSeekPlayingState === TargetPlayingState.PLAYING_ABR) {
+                    remotePlayer._targetSeekPlayingState = TargetPlayingState.PLAYING_UI;
+                }
                 return new Promise((resolve, reject) => {
                     const FCID = getFCID();
                     const logger = sdkLogger.withFields({ FCID });
@@ -472,14 +487,14 @@ class Lifecycle extends LifecycleInterface {
                         onSuccess: () => {
                             const duration = Date.now() - timeBeforeSendingRequest;
                             logger.withFields({ duration }).log(`stop completed successfully after ${duration} ms`);
-                            this._inTransition = false;
+                            this._inTransitionToForeground = false;
                             timerId = clearTimer(timerId);
                             resolve(true);
                         },
                         onFailure: (code, msg) => {
                             const duration = Date.now() - timeBeforeSendingRequest;
                             logger.withFields({ duration }).log(`stop failed after ${duration} ms. Error code: ${code}, error message: ${msg}`);
-                            this._inTransition = false;
+                            this._inTransitionToForeground = false;
                             timerId = clearTimer(timerId);
                             reject(new SenzaError(code, msg));
                         }
@@ -488,7 +503,7 @@ class Lifecycle extends LifecycleInterface {
                     const timeout = this._remotePlayerConfirmationTimeout + 1000;
                     timerId = setTimeout(() => {
                         logger.log(`stop reached timeout of ${timeout} ms, canceling query id ${queryId}`);
-                        this._inTransition = false;
+                        this._inTransitionToForeground = false;
                         window.cefQueryCancel(queryId);
                         reject(new SenzaError(6000, `stop reached timeout of ${timeout} ms`));
                     }, timeout, queryId);
@@ -503,11 +518,11 @@ class Lifecycle extends LifecycleInterface {
                     persistent: false,
                     onSuccess: () => {
                         logger.log("uiActiveRequest successfully sent");
-                        this._inTransition = false;
+                        this._inTransitionToForeground = false;
                         resolve(true);
                     },
                     onFailure: (code, msg) => {
-                        this._inTransition = false;
+                        this._inTransitionToForeground = false;
                         logger.error(`uiActiveRequest failed: ${code} ${msg}`);
                         reject(`uiActiveRequest failed: ${code} ${msg}`);
                     }
@@ -520,10 +535,6 @@ class Lifecycle extends LifecycleInterface {
 
     _moveToBackground() {
         if (window.cefQuery) {
-            if (this._inTransition || this._state === this.UiState.BACKGROUND || this._state === this.UiState.IN_TRANSITION_TO_BACKGROUND) {
-                sdkLogger.warn(`lifecycle moveToBackground: No need to transition to background, state: ${this._state} transition: ${this._inTransition}`);
-                return Promise.resolve(false);
-            }
             // If audio sync is disabled, we only need to sync before remote player starts playing
             if (!isAudioSyncConfigured()) {
                 remotePlayer._syncRemotePlayerWithLocalPlayer();
@@ -534,8 +545,8 @@ class Lifecycle extends LifecycleInterface {
             if (!remotePlayer._isPlaying) {
                 return this._moveToUiStandby();
             }
-
-            this._inTransition = true;
+            remotePlayer._changePlayMode(true);
+            this._inTransitionToBackground = true;
             return new Promise((resolve, reject) => {
                 const FCID = getFCID();
                 const logger = sdkLogger.withFields({ FCID });
@@ -553,7 +564,8 @@ class Lifecycle extends LifecycleInterface {
                 if (this._remotePlayerApiVersion >= 2) {
                     message.type = "remotePlayer.play";
                     message.class = "remotePlayer";
-                    message.switchMode = remotePlayer._isAudioSyncEnabled() ? SwitchMode.SEAMLESS : SwitchMode.NON_SEAMLESS;
+                    // in background, client expects to get NON_SEAMLESS switch mode.
+                    message.switchMode = remotePlayer._isAudioSyncEnabled() && this._state !== this.UiState.BACKGROUND ? SwitchMode.SEAMLESS : SwitchMode.NON_SEAMLESS;
                     message.streamType = remotePlayer.textTrackVisibility ? (StreamType.AUDIO | StreamType.VIDEO | StreamType.SUBTITLE) : (StreamType.AUDIO | StreamType.VIDEO);
                     request = {
                         target: "TC",
@@ -576,14 +588,14 @@ class Lifecycle extends LifecycleInterface {
                     onSuccess: () => {
                         const duration = Date.now() - timeBeforeSendingRequest;
                         logger.withFields({ duration }).log(`play completed successfully after ${duration} ms`);
-                        this._inTransition = false;
+                        this._inTransitionToBackground = false;
                         timerId = clearTimer(timerId);
                         resolve();
                     },
                     onFailure: (code, msg) => {
                         const duration = Date.now() - timeBeforeSendingRequest;
                         logger.withFields({ duration }).log(`play failed after ${duration} ms. Error code: ${code}, error message: ${msg}`);
-                        this._inTransition = false;
+                        this._inTransitionToBackground = false;
                         timerId = clearTimer(timerId);
                         reject(new SenzaError(code, msg));
                     }
@@ -593,7 +605,7 @@ class Lifecycle extends LifecycleInterface {
                     const timeout = this._remotePlayerConfirmationTimeout + 1000;
                     timerId = setTimeout(() => {
                         logger.log(`play reached timeout of ${timeout} ms, canceling query id ${queryId}`);
-                        this._inTransition = false;
+                        this._inTransitionToBackground = false;
                         window.cefQueryCancel(queryId);
                         reject(new SenzaError(6000, `play reached timeout of ${timeout} ms`));
                     }, timeout, queryId);
@@ -606,11 +618,11 @@ class Lifecycle extends LifecycleInterface {
 
     moveToBackground() {
         if (window.cefQuery) {
-            if (this._inTransition || this._state === this.UiState.BACKGROUND || this._state === this.UiState.IN_TRANSITION_TO_BACKGROUND) {
-                sdkLogger.warn(`lifecycle moveToBackground: No need to transition to background, state: ${this._state} transition: ${this._inTransition}`);
+            const inTransition = this._isInTransition();
+            if (inTransition || this._state === this.UiState.BACKGROUND || this._state === this.UiState.IN_TRANSITION_TO_BACKGROUND) {
+                sdkLogger.warn(`lifecycle moveToBackground: No need to transition to background, state: ${this._state} transition: ${inTransition}`);
                 return Promise.resolve(false);
             }
-
             if (remotePlayer._isSeekingByApplication) {
                 remotePlayer._targetSeekPlayingState = TargetPlayingState.PLAYING_ABR;
                 return Promise.resolve(true);

package/src/implementation/remotePlayer.js

@@ -11,7 +11,8 @@ import {
     SeekState,
     TargetPlayingState,
     isSubtitlesTranslationAllowed,
-    isSubtitlesTranslationPattern
+    isSubtitlesTranslationPattern,
+    isAppVersionAboveOrEqual
 } from "./utils";
 import { lifecycle } from "./lifecycle";
 import { writeLicenseResponse } from "./api";
@@ -143,10 +144,12 @@ class RemotePlayer extends RemotePlayerInterface {
     }
 
     /** @private Initialize the remote player
-     * @param {Object} uiStreamerSettings ui-streamer portion of the settings taken from session info
+     * @param {Object} sessionObj session information object
+     * @param {Object} triggerEvent trigger event object
      * */
-    async _init(uiStreamerSettings, triggerEvent) {
+    async _init(sessionObj, triggerEvent) {
         sdkLogger.info("Initializing RemotePlayer");
+        const uiStreamerSettings = sessionObj?.settings?.["ui-streamer"];
         let playerState = {
             isLoaded: false,
             playbackUrl: ""
@@ -193,6 +196,7 @@ class RemotePlayer extends RemotePlayerInterface {
         this._remotePlayerConfirmationTimeout = uiStreamerSettings?.remotePlayerConfirmationTimeout ?? DEFAULT_REMOTE_PLAYER_CONFIRMATION_TIMEOUT;
         this._remotePlayerApiVersion = uiStreamerSettings?.remotePlayerApiVersion || 1;
         this._multiSeekDelay = uiStreamerSettings?.multiSeekDelay || MULTI_SEEK_DELAY_MSEC;
+        this._deviceAppVersion = sessionObj?.manifest?.["device-app"] || "";
 
         sdkLogger.info(`remotePLayer isPlaying=${this._isPlaying}`);
 
@@ -527,7 +531,8 @@ class RemotePlayer extends RemotePlayerInterface {
             };
             let waitForResponse = false;
             if (this._remotePlayerApiVersion >= 2) {
-                message.switchMode = this._isAudioSyncEnabled() ? SwitchMode.SEAMLESS : SwitchMode.NON_SEAMLESS;
+                // in background, client expects to get NON_SEAMLESS switch mode.
+                message.switchMode = this._isAudioSyncEnabled() && lifecycle.state !== lifecycle.UiState.BACKGROUND ? SwitchMode.SEAMLESS : SwitchMode.NON_SEAMLESS;
                 message.streamType = streamType;
                 waitForResponse = true;
 
@@ -948,8 +953,13 @@ class RemotePlayer extends RemotePlayerInterface {
 
         // If seeking in progress, wait for seek to complete before playing
         if (this._isSeekingByApplication) {
-            sdkLogger.info("application requesting play during seek");
-            this._targetSeekPlayingState = TargetPlayingState.PLAYING_UI;
+            if (this._inTransitionToForeground || lifecycle.state === lifecycle.UiState.FOREGROUND || lifecycle.state === lifecycle.UiState.IN_TRANSITION_TO_FOREGROUND) {
+                sdkLogger.info("application requesting play during seek. setting targetSeekPlayingState to PLAYING_UI");
+                this._targetSeekPlayingState = TargetPlayingState.PLAYING_UI;
+            } else {
+                sdkLogger.info("application requesting play during seek. setting targetSeekPlayingState to PLAYING_ABR");
+                this._targetSeekPlayingState = TargetPlayingState.PLAYING_ABR;
+            }
             return Promise.resolve(true);
         }
         /*
@@ -1510,6 +1520,8 @@ class RemotePlayer extends RemotePlayerInterface {
      * @private
      */
     async _startSeeking(playbackPosition) {
+        const backgroundSeekMinClientAppVersion = "25.27.8";
+
         if (this._isSetAudioInProgress || this._isSetSubtitlesInProgress) {
             sdkLogger.info("Seeking not supported while setAudioLanguage or setSubtitleLanguage are in progress.");
             return;
@@ -1525,10 +1537,12 @@ class RemotePlayer extends RemotePlayerInterface {
                 return;
             }
         }
-
-        // Only allow seeking in foreground. Still ignore the initialized local player seeking event above
-        if (this._remotePlayerApiVersion >= 2 && !this._isSeekingByPlatform && !this._isSeekingByApplication &&
-            (lifecycle.state === lifecycle.UiState.FOREGROUND || lifecycle.state === lifecycle.UiState.IN_TRANSITION_TO_FOREGROUND)) {
+        const backgroundSeekSupported = isAppVersionAboveOrEqual(this._deviceAppVersion, backgroundSeekMinClientAppVersion);
+        if (!backgroundSeekSupported && (lifecycle.state === lifecycle.UiState.BACKGROUND || lifecycle.state === lifecycle.UiState.IN_TRANSITION_TO_BACKGROUND)) {
+            sdkLogger.warn(`Seeking: background seek not supported for device app version: ${this._deviceAppVersion}`);
+        }
+        if (this._remotePlayerApiVersion >= 2 && !this._isSeekingByPlatform && !this._isSeekingByApplication
+            && (lifecycle.state === lifecycle.UiState.FOREGROUND || lifecycle.state === lifecycle.UiState.IN_TRANSITION_TO_FOREGROUND || backgroundSeekSupported)) {
             this._atomicSeek();
         } else {
             sdkLogger.info(`Seeking: skipping seeking event to currentTime: ${playbackPosition}, internalSeek: ${this._isSeekingByPlatform}, localPlayerSeek: ${this._isSeekingByApplication}, state: ${lifecycle.state}`);
@@ -1547,16 +1561,16 @@ class RemotePlayer extends RemotePlayerInterface {
      * */
     async _atomicSeek() {
         sdkLogger.info("Seeking: local video element seeking start while isPlaying: ", this._isPlaying);
-
-        // Initialize the target playing state unless changed during the seek process
-        // In the future, we should allow for seeking in background. Currently, there's no
-        // way to know when the web application will call moveToForeground (i.e Before/After seek)
-        // Therefore, for now, we will assume the target is either paused or playing in ui unless
-        // specifically receiving a moveToBackground during the process.
-        // if (this._isPlaying && (lifecycle.state === lifecycle.UiState.BACKGROUND || lifecycle.state === lifecycle.UiState.IN_TRANSITION_TO_BACKGROUND)) {
-        //     this._targetSeekPlayingState = TargetPlayingState.PLAYING_ABR;
-        // }
-        this._targetSeekPlayingState = this._isPlaying ? TargetPlayingState.PLAYING_UI : TargetPlayingState.PAUSED;
+        if (this._isPlaying) {
+            if (!(lifecycle._inTransitionToForeground || lifecycle.state === lifecycle.UiState.IN_TRANSITION_TO_FOREGROUND) && (lifecycle.state === lifecycle.UiState.BACKGROUND || lifecycle.state === lifecycle.UiState.IN_TRANSITION_TO_BACKGROUND)) {
+                sdkLogger.info("seek in background", this._isPlaying);
+                this._targetSeekPlayingState = TargetPlayingState.PLAYING_ABR;
+            } else {
+                this._targetSeekPlayingState = TargetPlayingState.PLAYING_UI;
+            }
+        } else {
+            this._targetSeekPlayingState = TargetPlayingState.PAUSED;
+        }
 
         // The platform could be currently syncing audio/video using playback rate. Reset when performing seek.
         if (this._videoElement) {
@@ -1623,7 +1637,7 @@ class RemotePlayer extends RemotePlayerInterface {
 
         // If in TargetPlayingState.PAUSE, no need to resume.
         // Resume without awaiting to avoid blocking the seek process anymore
-        // In case where we aborted, we don't want to resume playback.
+        // In case where we aborted (new load or unload called), we don't want to resume playback.
         if (!this._abortSeeking) {
             if (this._targetSeekPlayingState === TargetPlayingState.PLAYING_UI) {
                 if (!this._isAudioSyncEnabled()) {

package/src/implementation/senzaShakaPlayer.js

@@ -120,13 +120,27 @@ export class SenzaShakaPlayer extends SenzaShakaInterface {
         },
         "pause": () => {
             this._resetPlayPromise();
-            this.remotePlayer.pause()
-                .catch(error => {
-                    sdkLogger.error("Failed to pause remote player:", error);
-                    this.handleSenzaError(error.code, error.message || "Unknown pause error");
-                });
-            // Force move to foreground when pausing as current implementation of remote player doesn't support for exapmle to do load while in background
-            lifecycle.moveToForeground();
+            if (!this._pauseForDelayedSeek) {
+                this.remotePlayer.pause()
+                    .catch(error => {
+                        sdkLogger.error("Failed to pause remote player:", error);
+                        this.handleSenzaError(error.code, error.message || "Unknown pause error");
+                    });
+                lifecycle.moveToForeground();
+            } else {
+                // in case of background seek, pause was called on local player, calling play() on local player will wait until "playing" event arrives (or timesout)
+                sdkLogger.info("senzaShakaPlayer pause Callback calling play() on local player. playing event should follow");
+                this._pauseForDelayedSeek = false;
+                this.videoElement.play();
+            }
+        },
+        "seeked" : () => {
+            // In case of background seek - we need to pause the local player after "seeked" until remote player is "playing" to avoid difference between the players.
+            if (this.isInRemotePlayback) {
+                this._pauseForDelayedSeek = true;
+                sdkLogger.info("senzaShakaPlayer seeked Callback: pausing local player. play should follow");
+                this.videoElement.pause();
+            }
         }
     };
 
@@ -348,7 +362,7 @@ export class SenzaShakaPlayer extends SenzaShakaInterface {
             this._minSuggestedPresentationDelay = uiSettings.minSuggestedPresentationDelay;
             sdkLogger.info(`Using configured minSuggestedPresentationDelay: ${this._minSuggestedPresentationDelay}s`);
         }
-
+        this._pauseForDelayedSeek = false;
         // if video element is provided, add the listeres here. In this case ,there is no need to call attach.
         if (videoElement) {
             this._attach(videoElement);

package/src/implementation/utils.js

@@ -135,6 +135,24 @@ export function isSubtitlesTranslationPattern(lang) {
     return (lang?.toString() || "").startsWith("*:");
 }
 
+export function isAppVersionAboveOrEqual(appVersion, minAppVersion) {
+    const version = appVersion.replace(/-dev|-prod/g, "").replace(/^.*\//, "");
+
+    sdkLogger.info(`isAppVersionAboveOrEqual: Comparing appVersion: ${version} with minAppVersion: ${minAppVersion}`);
+    const v1Parts = version.split(".").map(num => parseInt(num, 10) || 0);
+    const v2Parts = minAppVersion.split(".").map(num => parseInt(num, 10) || 0);
+
+    const maxLength = Math.max(v1Parts.length, v2Parts.length);
+    for (let i = 0; i < maxLength; i++) {
+        const v1 = v1Parts[i] ?? 0; // default missing parts to 0
+        const v2 = v2Parts[i] ?? 0;
+        if (v1 > v2) return true; // `appVersion` is newer
+        if (v1 < v2) return false; // `appVersion` is older
+    }
+    return true; // equal.
+}
+
+
 // These StreamType constants are used as a mask for the client to play/stop the specific types
 export const StreamType = Object.freeze({
     NONE: 0,

package/src/interface/senzaShakaPlayer.js

@@ -1,4 +1,5 @@
 import * as shaka from "shaka-player";
+import shakaUI from "shaka-player/dist/shaka-player.ui.js";
 
 //  Define custom error category
 shaka.util.Error.Category.SENZA_PLAYER_ERROR = 50;
@@ -6,7 +7,7 @@ shaka.util.Error.Code.SENZA_PLAYER_ERROR = 10500;
 
 // Copy the shaka module and replace the Player class with SenzaShakaPlayer
 // if we don't Copy the shaka module, the Player class will be replaced for all the other modules that import shaka
-const senzaShaka = { ...shaka };
+const senzaShaka = { ...shaka, ui: shakaUI.ui };
 
 
 /**

package/src/interface/version.js

@@ -1 +1 @@
-export const version = "4.4.0";
+export const version = "4.4.1-4ca75a1.0";