eyevinn-channel-engine 4.2.9 → 4.3.0

package/dist/engine/session_state.js

@@ -92,7 +92,7 @@ var SharedSessionState = /** @class */ (function () {
     };
     SharedSessionState.prototype.getCurrentVod = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var currentVod, hlsVod;
+            var currentVod, hlsVod, strToMB;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -107,16 +107,27 @@ var SharedSessionState = /** @class */ (function () {
                     case 1:
                         currentVod = _a.sent();
                         hlsVod = null;
-                        if (currentVod) {
-                            if (this.store.isShared()) {
-                                debug("[".concat(this.sessionId, "]: reading ").concat(currentVod.length, " characters from shared store (").concat(Date.now(), " < ").concat(this.cache.currentVod.ts + this.cache.currentVod.ttl, ")"));
-                                hlsVod = new HLSVod();
-                                hlsVod.fromJSON(currentVod);
-                            }
-                            else {
-                                hlsVod = currentVod;
-                            }
-                        }
+                        if (!currentVod) return [3 /*break*/, 5];
+                        if (!this.store.isShared()) return [3 /*break*/, 4];
+                        strToMB = function (str) {
+                            var bytesPerCharacter = 2; // Assuming each character takes around 2 bytes in memory
+                            var stringSizeBytes = str.length * bytesPerCharacter;
+                            var sizeInMegabytes = stringSizeBytes / (1024 * 1024);
+                            return sizeInMegabytes.toFixed(1);
+                        };
+                        debug("[".concat(this.sessionId, "]: reading ").concat(currentVod.length, " characters or (").concat(strToMB(currentVod), " MB) from shared store (").concat(Date.now(), " < ").concat(this.cache.currentVod.ts + this.cache.currentVod.ttl, ")"));
+                        hlsVod = new HLSVod();
+                        hlsVod.fromJSON(currentVod);
+                        if (!hlsVod.skipSerializeMediaSequences) return [3 /*break*/, 3];
+                        return [4 /*yield*/, hlsVod.generateMediaSequences()];
+                    case 2:
+                        _a.sent();
+                        _a.label = 3;
+                    case 3: return [3 /*break*/, 5];
+                    case 4:
+                        hlsVod = currentVod;
+                        _a.label = 5;
+                    case 5:
                         this.cache.currentVod.ts = Date.now();
                         this.cache.currentVod.value = hlsVod;
                         return [2 /*return*/, hlsVod];
@@ -133,7 +144,7 @@ var SharedSessionState = /** @class */ (function () {
                         if (!this.sessionId) {
                             throw new Error("shared session state store has not been initialized");
                         }
-                        if (!this.store.isShared()) return [3 /*break*/, 7];
+                        if (!this.store.isShared()) return [3 /*break*/, 8];
                         return [4 /*yield*/, this.store.clearLeaderCache()];
                     case 1:
                         _a.sent();
@@ -144,7 +155,7 @@ var SharedSessionState = /** @class */ (function () {
                         return [4 /*yield*/, this.set("currentVod", hlsVod.toJSON())];
                     case 3:
                         _a.sent();
-                        return [3 /*break*/, 6];
+                        return [3 /*break*/, 7];
                     case 4:
                         debug("[".concat(this.sessionId, "]: Not a leader. Will not overwrite. Getting currentVod in shared store"));
                         return [4 /*yield*/, this.get("currentVod")];
@@ -152,13 +163,17 @@ var SharedSessionState = /** @class */ (function () {
                         currentVod = _a.sent();
                         hlsVod = new HLSVod();
                         hlsVod.fromJSON(currentVod);
-                        _a.label = 6;
-                    case 6: return [3 /*break*/, 9];
-                    case 7: return [4 /*yield*/, this.set("currentVod", hlsVod)];
-                    case 8:
+                        if (!hlsVod.skipSerializeMediaSequences) return [3 /*break*/, 7];
+                        return [4 /*yield*/, hlsVod.generateMediaSequences()];
+                    case 6:
                         _a.sent();
-                        _a.label = 9;
+                        _a.label = 7;
+                    case 7: return [3 /*break*/, 10];
+                    case 8: return [4 /*yield*/, this.set("currentVod", hlsVod)];
                     case 9:
+                        _a.sent();
+                        _a.label = 10;
+                    case 10:
                         if (this.cache.currentVod) {
                             this.cache.currentVod.ts = Date.now();
                             this.cache.currentVod.ttl = CURRENTVOD_CACHE_TTL;

package/dist/examples/truncate.js

@@ -50,7 +50,8 @@ var RefAssetManager = /** @class */ (function () {
                     id: vod.id,
                     title: vod.title,
                     uri: vod.uri,
-                    desiredDuration: 50000
+                    desiredDuration: 50000,
+                    startOffset: 10000,
                 };
                 resolve(vodResponse);
             }

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eyevinn-channel-engine",
-  "version": "4.2.9",
+  "version": "4.3.0",
   "description": "OTT TV Channel Engine",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,8 +29,8 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@eyevinn/hls-repeat": "^0.2.0",
-    "@eyevinn/hls-truncate": "^0.2.0",
-    "@eyevinn/hls-vodtolive": "^3.0.1",
+    "@eyevinn/hls-truncate": "^0.3.0",
+    "@eyevinn/hls-vodtolive": "^4.0.0",
     "@eyevinn/m3u8": "^0.5.3",
     "abort-controller": "^3.0.0",
     "debug": "^3.2.7",

package/engine/server.ts

@@ -46,6 +46,8 @@ export interface ChannelEngineOpts {
   subtitleSliceEndpoint?: string;
   useVTTSubtitles?: boolean;
   alwaysNewSegments?: boolean;
+  partialStoreHLSVod?: boolean;
+  alwaysMapBandwidthByNearest?: boolean;
   diffCompensationRate?: number;
   staticDirectory?: string;
   averageSegmentDuration?: number;
@@ -100,6 +102,7 @@ export interface VodResponse {
   offset?: number;
   diffMs?: number;
   desiredDuration?: number;
+  startOffset?: number;
   type?: string;
   currentMetadata?: VodResponseMetadata;
   timedMetadata?: VodTimedMetadata;
@@ -181,6 +184,8 @@ export class ChannelEngine {
   private subtitleSliceEndpoint: string;
   private useVTTSubtitles: boolean;
   private alwaysNewSegments: boolean;
+  private partialStoreHLSVod: boolean;
+  private alwaysMapBandwidthByNearest: boolean;
   private defaultSlateUri?: string;
   private slateDuration?: number;
   private assetMgr: IAssetManager;
@@ -220,6 +225,14 @@ export class ChannelEngine {
     if (options && options.alwaysNewSegments) {
       this.alwaysNewSegments = true;
     }
+    this.partialStoreHLSVod = false;
+    if (options && options.partialStoreHLSVod) {
+      this.partialStoreHLSVod = true;
+    }
+    this.alwaysMapBandwidthByNearest = false;
+    if (options && options.alwaysMapBandwidthByNearest) {
+      this.alwaysMapBandwidthByNearest = true;
+    }
     if (options && options.defaultSlateUri) {
       this.defaultSlateUri = options.defaultSlateUri;
       this.slateRepetitions = options.slateRepetitions || 10;
@@ -453,6 +466,8 @@ export class ChannelEngine {
         subtitleSliceEndpoint: this.subtitleSliceEndpoint,
         useVTTSubtitles: this.useVTTSubtitles,
         alwaysNewSegments: options.alwaysNewSegments,
+        partialStoreHLSVod: options.partialStoreHLSVod,
+        alwaysMapBandwidthByNearest: options.alwaysMapBandwidthByNearest,
         noSessionDataTags: options.noSessionDataTags,
         playheadDiffThreshold: channel.options && channel.options.playheadDiffThreshold ? channel.options.playheadDiffThreshold : this.streamerOpts.defaultPlayheadDiffThreshold,
         maxTickInterval: channel.options && channel.options.maxTickInterval ? channel.options.maxTickInterval : this.streamerOpts.defaultMaxTickInterval,

package/engine/session.js

@@ -72,11 +72,22 @@ class Session {
     }
     this.isAllowedToClearVodCache = null;
     this.alwaysNewSegments = null;
+    this.alwaysMapBandwidthByNearest = null;
+    this.partialStoreHLSVod = null;
+    this.currentPlayheadRef = null;
     if (config) {
       if (config.alwaysNewSegments) {
         this.alwaysNewSegments = config.alwaysNewSegments;
       }
 
+      if (config.partialStoreHLSVod) {
+        this.partialStoreHLSVod = config.partialStoreHLSVod;
+      }
+
+      if (config.alwaysMapBandwidthByNearest) {
+        this.alwaysMapBandwidthByNearest = config.alwaysMapBandwidthByNearest;
+      }
+
       if (config.sessionId) {
         this._sessionId = config.sessionId;
       }
@@ -632,7 +643,7 @@ class Session {
     }
     let currentVod = null;
     const sessionState = await this._sessionState.getValues(["discSeqAudio", "vodMediaSeqAudio"]);
-    let playheadState = await this._playheadState.getValues(["mediaSeqAudio", "vodMediaSeqAudio"]);
+    let playheadState = await this._playheadState.getValues(["mediaSeqAudio", "vodMediaSeqAudio", "playheadRef"]);
 
     if (playheadState.vodMediaSeqAudio > sessionState.vodMediaSeqAudio || (playheadState.vodMediaSeqAudio < sessionState.vodMediaSeqAudio && playheadState.mediaSeqAudio === this.prevMediaSeqOffset.audio)) {
       const state = await this._sessionState.get("state");
@@ -653,14 +664,10 @@ class Session {
     if (currentVod) {
       // condition suggesting that a new vod should exist
       if (playheadState.vodMediaSeqAudio < 2 || playheadState.mediaSeqAudio !== this.prevMediaSeqOffset.audio) {
-        const AGE_THRESH = this.averageSegmentDuration * 2;
-        let cacheAge = null;
-        if (this._sessionState.cache && this._sessionState.cache.currentVod.ts) {
-          cacheAge = Date.now() - this._sessionState.cache.currentVod.ts;
-        }
-        if (cacheAge !== null && cacheAge > AGE_THRESH) {
+        if (playheadState.playheadRef > this.currentPlayheadRef) {
           await timer(500);
-          debug(`[${this._sessionId}]: While requesting audio manifest for ${audioGroupId}-${audioLanguage}, (mseq=${playheadState.vodMediaSeqAudio})(vod cache age=${cacheAge})`);
+          this.currentPlayheadRef = playheadState.playheadRef;
+          debug(`[${this._sessionId}]: While requesting audio manifest for ${audioGroupId}-${audioLanguage}, (mseq=${playheadState.vodMediaSeqAudio})`);
           await this._sessionState.clearCurrentVodCache(); // force reading up from shared store
           currentVod = await this._sessionState.getCurrentVod();
         }
@@ -707,7 +714,7 @@ class Session {
     }
     let currentVod = null;
     const sessionState = await this._sessionState.getValues(["discSeqSubtitle", "vodMediaSeqSubtitle"]);
-    let playheadState = await this._playheadState.getValues(["mediaSeqSubtitle", "vodMediaSeqSubtitle"]);
+    let playheadState = await this._playheadState.getValues(["mediaSeqSubtitle", "vodMediaSeqSubtitle", "playheadRef"]);
 
     if (playheadState.vodMediaSeqSubtitle > sessionState.vodMediaSeqSubtitle || (playheadState.vodMediaSeqSubtitle < sessionState.vodMediaSeqSubtitle && playheadState.mediaSeqSubtitle === this.prevMediaSeqOffset.subtitle)) {
       const state = await this._sessionState.get("state");
@@ -728,14 +735,10 @@ class Session {
     if (currentVod) {
       // condition suggesting that a new vod should exist
       if (playheadState.vodMediaSeqSubtitle < 2 || playheadState.mediaSeqSubtitle !== this.prevMediaSeqOffset.subtitle) {
-        const AGE_THRESH = this.averageSegmentDuration * 2;
-        let cacheAge = null;
-        if (this._sessionState.cache && this._sessionState.cache.currentVod.ts) {
-          cacheAge = Date.now() - this._sessionState.cache.currentVod.ts;
-        }
-        if (cacheAge !== null && cacheAge > AGE_THRESH) {
+        if (playheadState.playheadRef > this.currentPlayheadRef) {
           await timer(500);
-          debug(`[${this._sessionId}]: While requesting subtitle manifest for ${subtitleGroupId}-${subtitleLanguage}, (mseq=${playheadState.vodMediaSeqSubtitle})(vod cache age=${cacheAge})`);
+          this.currentPlayheadRef = playheadState.playheadRef;
+          debug(`[${this._sessionId}]: While requesting subtitle manifest for ${subtitleGroupId}-${subtitleLanguage}, (mseq=${playheadState.vodMediaSeqSubtitle})`);
           await this._sessionState.clearCurrentVodCache(); // force reading up from shared store
           currentVod = await this._sessionState.getCurrentVod();
         }
@@ -828,7 +831,7 @@ class Session {
         let positionV = 0;
         let positionA = 0;
         const position = (await this._getCurrentPlayheadPosition()) * 1000;
-        positionV = position / 1000;
+        positionV = position ? position / 1000 : 0;
         let currentVod = await this._sessionState.getCurrentVod();
         const sessionState = await this._sessionState.getValues(["vodMediaSeqAudio"]);
         let posDiff;
@@ -840,11 +843,10 @@ class Session {
         debug(`[${this._sessionId}]: About to determine audio increment`);
         do {
           const audioPosition = (await this._getAudioPlayheadPosition(sessionState.vodMediaSeqAudio + index)) * 1000;
-          positionA = audioPosition / 1000;
-          posDiff = (positionV-positionA).toFixed(3);
-          debug(`[${this._sessionId}]: positionV=${positionV};positionA=${positionA};posDiff=${posDiff};(posDiff <= 0.001)=${posDiff <= 0.001}`);
+          positionA = audioPosition ? audioPosition / 1000 : 0;
+          posDiff = (positionV - positionA).toFixed(3);
+          debug(`[${this._sessionId}]: positionV=${positionV};positionA=${positionA};posDiff=${posDiff}`);
           if (posDiff <= maxAcceptableDiff) {
-            debug(`[${this._sessionId}]: posDiff value (${posDiff}) is acceptable`);
             break;
           }
           if (posDiff > thresh) {
@@ -858,7 +860,7 @@ class Session {
           if (sessionState.vodMediaSeqAudio + index > audioSeqLastIdx) {
             break;
           }
-        } while (!(-thresh < posDiff && posDiff < thresh));
+        } while (!(-thresh < posDiff && posDiff < thresh) && !isNaN(posDiff));
         audioIncrement = index;
         debug(`[${this._sessionId}]: Current VOD Playhead Positions are to be: [${positionV.toFixed(3)}][${positionA.toFixed(3)}] (${posDiff})`);
       }
@@ -1271,7 +1273,7 @@ class Session {
       await this._sessionState.set("discSeq", sessionState.discSeq + lastDiscontinuity);
       await this._sessionState.set("discSeqAudio", sessionState.discSeqAudio + lastDiscontinuityAudio);
       await this._sessionState.set("slateCount", sessionState.slateCount + 1);
-      await this._playheadState.set("playheadRef", Date.now(), isLeader);
+      this.currentPlayheadRef = await this._playheadState.set("playheadRef", Date.now(), isLeader);
 
       cloudWatchLog(!this.cloudWatchLogging, 'engine-session', { event: 'slateInserted', channel: this._sessionId });
 
@@ -1326,7 +1328,9 @@ class Session {
                 dummySubtitleEndpoint: this.dummySubtitleEndpoint,
                 subtitleSliceEndpoint: this.subtitleSliceEndpoint,
                 shouldContainSubtitles: this.use_vtt_subtitles,
-                expectedSubtitleTracks: this._subtitleTracks
+                expectedSubtitleTracks: this._subtitleTracks,
+                alwaysMapBandwidthByNearest: this.alwaysMapBandwidthByNearest,
+                skipSerializeMediaSequences: this.partialStoreHLSVod
               };
               newVod = new HLSVod(vodResponse.uri, [], vodResponse.unixTs, vodResponse.offset * 1000, m3u8Header(this._instanceId), hlsOpts);
               if (vodResponse.timedMetadata) {
@@ -1370,7 +1374,6 @@ class Session {
             sessionState.vodMediaSeqVideo = await this._sessionState.set("vodMediaSeqVideo", 0);
             sessionState.vodMediaSeqAudio = await this._sessionState.set("vodMediaSeqAudio", 0);
             sessionState.vodMediaSeqSubtitle = await this._sessionState.set("vodMediaSeqSubtitle", 0);
-            await this._playheadState.set("playheadRef", Date.now(), isLeader);
             this.produceEvent({
               type: 'NOW_PLAYING',
               data: {
@@ -1380,6 +1383,7 @@ class Session {
             });
             sessionState.state = await this._sessionState.set("state", SessionState.VOD_PLAYING);
             sessionState.currentVod = await this._sessionState.setCurrentVod(currentVod, { ttl: currentVod.getDuration() * 1000 });
+            this.currentPlayheadRef = await this._playheadState.set("playheadRef", Date.now(), isLeader);
             await this._sessionState.remove("nextVod");
             return;
           } else {
@@ -1502,7 +1506,9 @@ class Session {
                 dummySubtitleEndpoint: this.dummySubtitleEndpoint,
                 subtitleSliceEndpoint: this.subtitleSliceEndpoint,
                 shouldContainSubtitles: this.use_vtt_subtitles,
-                expectedSubtitleTracks: this._subtitleTracks
+                expectedSubtitleTracks: this._subtitleTracks,
+                alwaysMapBandwidthByNearest: this.alwaysMapBandwidthByNearest,
+                skipSerializeMediaSequences: this.partialStoreHLSVod
               };
               newVod = new HLSVod(vodResponse.uri, null, vodResponse.unixTs, vodResponse.offset * 1000, m3u8Header(this._instanceId), hlsOpts);
               if (vodResponse.timedMetadata) {
@@ -1554,7 +1560,7 @@ class Session {
             currentVod = newVod;
             debug(`[${this._sessionId}]: msequences=${currentVod.getLiveMediaSequencesCount()}; audio msequences=${currentVod.getLiveMediaSequencesCount("audio")}; subtitle msequences=${currentVod.getLiveMediaSequencesCount("subtitle")}`);
             sessionState.currentVod = await this._sessionState.setCurrentVod(currentVod, { ttl: currentVod.getDuration() * 1000 });
-            await this._playheadState.set("playheadRef", Date.now(), isLeader);
+            this.currentPlayheadRef = await this._playheadState.set("playheadRef", Date.now(), isLeader);
             sessionState.vodMediaSeqVideo = await this._sessionState.set("vodMediaSeqVideo", 0);
             sessionState.vodMediaSeqAudio = await this._sessionState.set("vodMediaSeqAudio", 0);
             sessionState.vodMediaSeqSubtitle = await this._sessionState.set("vodMediaSeqSubtitle", 0);
@@ -1669,7 +1675,7 @@ class Session {
             await this._playheadState.set("vodMediaSeqVideo", 0, isLeader);
             await this._playheadState.set("vodMediaSeqAudio", 0, isLeader);
             await this._playheadState.set("vodMediaSeqSubtitle", 0, isLeader);
-            await this._playheadState.set("playheadRef", Date.now(), isLeader);
+            this.currentPlayheadRef = await this._playheadState.set("playheadRef", Date.now(), isLeader);
             // 4) Log to debug and cloudwatch
             debug(`[${this._sessionId}]: LEADER: Set new Reloaded VOD and vodMediaSeq counts in store.`);
             debug(`[${this._sessionId}]: next VOD Reloaded (${currentVod.getDeltaTimes()})`);
@@ -1749,7 +1755,9 @@ class Session {
               dummySubtitleEndpoint: this.dummySubtitleEndpoint,
               subtitleSliceEndpoint: this.subtitleSliceEndpoint,
               shouldContainSubtitles: this.use_vtt_subtitles,
-              expectedSubtitleTracks: this._subtitleTracks
+              expectedSubtitleTracks: this._subtitleTracks,
+              alwaysMapBandwidthByNearest: this.alwaysMapBandwidthByNearest,
+              skipSerializeMediaSequences: this.partialStoreHLSVod
             };
             const timestamp = Date.now();
             hlsVod = new HLSVod(this.slateUri, null, timestamp, null, m3u8Header(this._instanceId), hlsOpts);
@@ -1799,7 +1807,11 @@ class Session {
   _truncateVod(vodResponse) {
     return new Promise((resolve, reject) => {
       try {
-        const truncatedVod = new HLSTruncateVod(vodResponse.uri, vodResponse.desiredDuration / 1000);
+        const options = {};
+        if (vodResponse.startOffset) {
+          options.offset = vodResponse.startOffset / 1000;
+        }
+        const truncatedVod = new HLSTruncateVod(vodResponse.uri, vodResponse.desiredDuration / 1000, options);
         truncatedVod.load()
           .then(() => {
             let audioManifestLoader;
@@ -1848,7 +1860,9 @@ class Session {
               dummySubtitleEndpoint: this.dummySubtitleEndpoint, 
               subtitleSliceEndpoint: this.subtitleSliceEndpoint,
               shouldContainSubtitles: this.use_vtt_subtitles,
-              expectedSubtitleTracks: this._subtitleTracks
+              expectedSubtitleTracks: this._subtitleTracks,
+              alwaysMapBandwidthByNearest: this.alwaysMapBandwidthByNearest,
+              skipSerializeMediaSequences: this.partialStoreHLSVod
             };
             const timestamp = Date.now();
             hlsVod = new HLSVod(nexVodUri, null, timestamp, null, m3u8Header(this._instanceId), hlsOpts);

package/engine/session_state.js

@@ -57,9 +57,18 @@ class SharedSessionState {
     let hlsVod = null;
     if (currentVod) {
       if (this.store.isShared()) {
-        debug(`[${this.sessionId}]: reading ${currentVod.length} characters from shared store (${Date.now()} < ${this.cache.currentVod.ts + this.cache.currentVod.ttl})`);
+        const strToMB = (str) => {
+          const bytesPerCharacter = 2; // Assuming each character takes around 2 bytes in memory
+          const stringSizeBytes = str.length * bytesPerCharacter;
+          const sizeInMegabytes = stringSizeBytes / (1024 * 1024);
+          return sizeInMegabytes.toFixed(1);
+        }
+        debug(`[${this.sessionId}]: reading ${currentVod.length} characters or (${strToMB(currentVod)} MB) from shared store (${Date.now()} < ${this.cache.currentVod.ts + this.cache.currentVod.ttl})`);
         hlsVod = new HLSVod();
         hlsVod.fromJSON(currentVod);
+        if (hlsVod.skipSerializeMediaSequences) {
+          await hlsVod.generateMediaSequences();
+        }
       } else {
         hlsVod = currentVod;
       }
@@ -83,6 +92,9 @@ class SharedSessionState {
         const currentVod = await this.get("currentVod");
         hlsVod = new HLSVod();
         hlsVod.fromJSON(currentVod);
+        if (hlsVod.skipSerializeMediaSequences) {
+          await hlsVod.generateMediaSequences();
+        }
       }
     } else {
       await this.set("currentVod", hlsVod);

package/examples/truncate.ts

@@ -57,7 +57,8 @@ class RefAssetManager implements IAssetManager {
           id: vod.id,
           title: vod.title,
           uri: vod.uri,
-          desiredDuration: 50000
+          desiredDuration: 50000,
+          startOffset: 10000,
         };
         resolve(vodResponse);
       } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eyevinn-channel-engine",
-  "version": "4.2.9",
+  "version": "4.3.0",
   "description": "OTT TV Channel Engine",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,8 +29,8 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@eyevinn/hls-repeat": "^0.2.0",
-    "@eyevinn/hls-truncate": "^0.2.0",
-    "@eyevinn/hls-vodtolive": "^3.0.1",
+    "@eyevinn/hls-truncate": "^0.3.0",
+    "@eyevinn/hls-vodtolive": "^4.0.0",
     "@eyevinn/m3u8": "^0.5.3",
     "abort-controller": "^3.0.0",
     "debug": "^3.2.7",