eyevinn-channel-engine 3.3.0 → 3.3.3

package/README.md

@@ -109,6 +109,7 @@ Available options when constructing the Channel Engine object are:
 - `cloudWatchMetrics`: Output CloudWatch JSON metrics on console log. Default is false.
 - `useDemuxedAudio`: Enable playing VODs with multiple audio tracks. Default is false.
 - `alwaysNewSegments`: Force all new HLS media sequences to always contain at least 1 new segment. Default is false.
+- `diffCompensationRate`: The rate for how much time is added on each sequence to slow down the playhead until it is back on schedule. Default is 0.5 (delay with half a segment duration).
 
 ## High Availability
 

package/engine/server.js

@@ -109,6 +109,9 @@ class ChannelEngine {
     if (options && options.forceTargetDuration) {
       this.streamerOpts.forceTargetDuration = options.forceTargetDuration;
     }
+    if (options && options.diffCompensationRate) {
+      this.streamerOpts.diffCompensationRate = options.diffCompensationRate;
+    }
     const handleMasterRoute = async (req, res, next) => {
       debug(req.params);
       let m;
@@ -237,6 +240,7 @@ class ChannelEngine {
         maxTickInterval: channel.options && channel.options.maxTickInterval ? channel.options.maxTickInterval : this.streamerOpts.defaultMaxTickInterval,
         targetDurationPadding: channel.options && channel.options.targetDurationPadding ? channel.options.targetDurationPadding : this.streamerOpts.targetDurationPadding,
         forceTargetDuration: channel.options && channel.options.forceTargetDuration ? channel.options.forceTargetDuration : this.streamerOpts.forceTargetDuration,
+        diffCompensationRate: channel.options && channel.options.diffCompensationRate ? channel.options.diffCompensationRate : this.streamerOpts.diffCompensationRate,
         profile: channel.profile,
         audioTracks: channel.audioTracks,
         closedCaptions: channel.closedCaptions,
@@ -454,6 +458,7 @@ class ChannelEngine {
       options.maxTickInterval = this.streamerOpts.defaultMaxTickInterval;
       options.targetDurationPadding = this.streamerOpts.targetDurationPadding;
       options.forceTargetDuration = this.streamerOpts.forceTargetDuration;
+      options.diffCompensationRate = this.streamerOpts.diffCompensationRate;
       // if we are initiating a master manifest
       // outside of specific Channel context,
       // if slate options are set at the ChannelEngine level, then set these here

package/engine/session.js

@@ -15,6 +15,7 @@ const ChaosMonkey = require('./chaos_monkey.js');
 const AVERAGE_SEGMENT_DURATION = 3000;
 const DEFAULT_PLAYHEAD_DIFF_THRESHOLD = 1000;
 const DEFAULT_MAX_TICK_INTERVAL = 10000;
+const DEFAULT_DIFF_COMPENSATION_RATE = 0.5;
 
 const timer = ms => new Promise(res => setTimeout(res, ms));
 
@@ -42,7 +43,9 @@ class Session {
     this.cloudWatchLogging = false;
     this.playheadDiffThreshold = DEFAULT_PLAYHEAD_DIFF_THRESHOLD;
     this.maxTickInterval = DEFAULT_MAX_TICK_INTERVAL;
+    this.diffCompensationRate = DEFAULT_DIFF_COMPENSATION_RATE;
     this.diffCompensation = null;
+    this.timePositionOffset = 0;
     this.prevVodMediaSeq = {
       video: null,
       audio: null
@@ -117,6 +120,9 @@ class Session {
       if (config.forceTargetDuration) {
         this.forceTargetDuration = config.forceTargetDuration;
       }
+      if (config.diffCompensationRate) {
+        this.diffCompensationRate = config.diffCompensationRate;
+      }
     }
   }
 
@@ -180,28 +186,43 @@ class Session {
           const reqTickInterval = playheadState.tickInterval;
           const timeSpentInIncrement = (tsIncrementEnd - tsIncrementBegin) / 1000;
           let tickInterval = reqTickInterval - timeSpentInIncrement;
+          // Apply HLSVod delta time for current msequence.
           const delta = await this._getCurrentDeltaTime();
           if (delta != 0) {
-            debug(`[${this._sessionId}]: Delta time is != 0 need will adjust ${delta}sec to tick interval`);
             tickInterval += delta;
+            debug(`[${this._sessionId}]: Delta time is != 0 need will adjust ${delta}sec to tick interval. tick=${tickInterval}`);
           }
           const position = (await this._getCurrentPlayheadPosition()) * 1000;
-          const timePosition = Date.now() - playheadState.playheadRef;
+          let timePosition = Date.now() - playheadState.playheadRef;
+          // Apply time position offset if set, only after external diff compensation has concluded.
+          if (this.timePositionOffset && this.diffCompensation <= 0 && this.alwaysNewSegments) {
+            timePosition -= this.timePositionOffset;
+            cloudWatchLog(!this.cloudWatchLogging, 'engine-session',
+            { event: 'applyTimePositionOffset', channel: this._sessionId, offsetMs: this.timePositionOffset });
+          }
           const diff = position - timePosition;
           debug(`[${this._sessionId}]: ${timePosition}:${position}:${diff > 0 ? '+' : ''}${diff}ms`);
           cloudWatchLog(!this.cloudWatchLogging, 'engine-session',
             { event: 'playheadDiff', channel: this._sessionId, diffMs: diff });
-          if (diff > this.playheadDiffThreshold) {
-            tickInterval += ((diff / 1000)) - (this.playheadDiffThreshold / 1000);
-          } else if (diff < -this.playheadDiffThreshold) {
-            tickInterval += ((diff / 1000)) + (this.playheadDiffThreshold / 1000);
-          }
+            if (this.alwaysNewSegments) {
+              // Apply Playhead diff compensation, only after external diff compensation has concluded.
+              if (this.diffCompensation <= 0) {
+                const timeToAdd = this._getPlayheadDiffCompesationValue(diff, this.playheadDiffThreshold);
+                tickInterval += timeToAdd;
+              }
+            } else {
+              // Apply Playhead diff compensation, always.
+              const timeToAdd = this._getPlayheadDiffCompesationValue(diff, this.playheadDiffThreshold);
+              tickInterval += timeToAdd;
+            }
+          // Apply external diff compensation if available.
           if (this.diffCompensation && this.diffCompensation > 0) {
-            const DIFF_COMPENSATION = 2000;
+            const DIFF_COMPENSATION = (reqTickInterval * this.diffCompensationRate).toFixed(2) * 1000;
             debug(`[${this._sessionId}]: Adding ${DIFF_COMPENSATION}msec to tickInterval to compensate for schedule diff (current=${this.diffCompensation}msec)`);
             tickInterval += (DIFF_COMPENSATION / 1000);
             this.diffCompensation -= DIFF_COMPENSATION;
           }
+          // Keep tickInterval within upper and lower limits.
           debug(`[${this._sessionId}]: Requested tickInterval=${tickInterval}s (max=${this.maxTickInterval / 1000}s, diffThreshold=${this.playheadDiffThreshold}msec)`);
           if (tickInterval <= 0.5) {
             tickInterval = 0.5;
@@ -214,6 +235,13 @@ class Session {
           await this._playheadState.set("tickMs", (tsTickEnd - tsIncrementBegin));
           cloudWatchLog(!this.cloudWatchLogging, 'engine-session',
             { event: 'tickInterval', channel: this._sessionId, tickTimeMs: (tsTickEnd - tsIncrementBegin) });
+          if (this.alwaysNewSegments) {
+            // Use dynamic base-tickInterval. Set according to duration of latest segment.
+            const lastDuration = await this._getLastDuration(manifest);
+            const nextTickInterval = lastDuration < 2 ? 2 : lastDuration;
+            await this._playheadState.set("tickInterval", nextTickInterval);
+            cloudWatchLog(!this.cloudWatchLogging, "engine-session", { event: "tickIntervalUpdated", channel: this._sessionId, tickIntervalSec: nextTickInterval });
+          }
         }
       } catch (err) {
         debug(`[${this._sessionId}]: Playhead consumer crashed (1)`);
@@ -388,7 +416,7 @@ class Session {
         let mediaSequenceValue = 0;
         if (currentVod.sequenceAlwaysContainNewSegments) {
           mediaSequenceValue = currentVod.mediaSequenceValues[playheadState.vodMediaSeqVideo];
-          debug(`[${this._sessionId}]: {${mediaSequenceValue}}_{${currentVod.getLastSequenceMediaSequenceValue()}`);
+          debug(`[${this._sessionId}]: {${mediaSequenceValue}}_{${currentVod.getLastSequenceMediaSequenceValue()}}`);
         } else {
           mediaSequenceValue = playheadState.vodMediaSeqVideo;
         }
@@ -517,6 +545,18 @@ class Session {
         debug(`[${this._sessionId}]: Not a leader and first|second media sequence in a VOD is requested. Invalidate cache to ensure having the correct VOD.`);
         await this._sessionState.clearCurrentVodCache();
         this.isAllowedToClearVodCache = false;
+        const diffMs = await this._playheadState.get("diffCompensation");
+        if (diffMs) {
+          this.diffCompensation = diffMs;
+          debug(`[${this._sessionId}]: Setting diffCompensation->${this.diffCompensation}`);
+          if (this.diffCompensation) {
+            this.timePositionOffset = this.diffCompensation;
+            cloudWatchLog(!this.cloudWatchLogging, 'engine-session',
+            { event: 'timePositionOffsetUpdated', channel: this._sessionId, offsetMs: this.timePositionOffset });
+          } else{
+            this.timePositionOffset = 0;
+          }
+        }
       }
     } else {
       this.isAllowedToClearVodCache = true;
@@ -650,6 +690,18 @@ class Session {
         debug(`[${this._sessionId}]: Not a leader and have just set 'playheadState.vodMediaSeqVideo' to 0|1. Invalidate cache to ensure having the correct VOD.`);
         await this._sessionState.clearCurrentVodCache();
         currentVod = await this._sessionState.getCurrentVod();
+        const diffMs = await this._playheadState.get("diffCompensation");
+        if (diffMs) {
+          this.diffCompensation = diffMs;
+          debug(`[${this._sessionId}]: Setting diffCompensation->${this.diffCompensation}`);
+          if (this.diffCompensation) {
+            this.timePositionOffset = this.diffCompensation;
+            cloudWatchLog(!this.cloudWatchLogging, 'engine-session',
+            { event: 'timePositionOffsetUpdated', channel: this._sessionId, offsetMs: this.timePositionOffset });
+          } else{
+            this.timePositionOffset = 0;
+          }
+        }
         this.isAllowedToClearVodCache = false;
       }
     } else {
@@ -1095,6 +1147,13 @@ class Session {
               loadPromise = newVod.loadAfter(currentVod);
               if (vodResponse.diffMs) {
                 this.diffCompensation = vodResponse.diffMs;
+                if (this.diffCompensation) {
+                  this.timePositionOffset = this.diffCompensation;
+                  cloudWatchLog(!this.cloudWatchLogging, 'engine-session',
+                  { event: 'timePositionOffsetUpdated', channel: this._sessionId, offsetMs: this.timePositionOffset });
+                } else{
+                  this.timePositionOffset = 0;
+                }
               }
             } else {
               loadPromise = new Promise((resolve, reject) => {
@@ -1114,15 +1173,17 @@ class Session {
             debug(`[${this._sessionId}]: ${newVod.getPlayheadPositions()}`);
             currentVod = newVod;
             debug(`[${this._sessionId}]: msequences=${currentVod.getLiveMediaSequencesCount()}`);
-            sessionState.mediaSeq = await this._sessionState.set("mediaSeq", sessionState.mediaSeq + endMseqValue);
-            sessionState.discSeq = await this._sessionState.set("discSeq", sessionState.discSeq + lastDiscontinuity);
             sessionState.vodMediaSeqVideo = await this._sessionState.set("vodMediaSeqVideo", 0);
             sessionState.vodMediaSeqAudio = await this._sessionState.set("vodMediaSeqAudio", 0);
+            sessionState.mediaSeq = await this._sessionState.set("mediaSeq", sessionState.mediaSeq + endMseqValue);
+            sessionState.discSeq = await this._sessionState.set("discSeq", sessionState.discSeq + lastDiscontinuity);
             debug(`[${this._sessionId}]: new sequence data set in store [${sessionState.mediaSeq}][${sessionState.discSeq}]`);
             await this._sessionState.remove("nextVod");
             sessionState.currentVod = await this._sessionState.setCurrentVod(currentVod, { ttl: currentVod.getDuration() * 1000 });
             this.leaderIsSettingNextVod = false;
             await this._playheadState.set("playheadRef", Date.now());
+            await this._playheadState.set("diffCompensation", this.diffCompensation);
+            debug(`[${this._sessionId}]: sharing durrent vods diffCompensation=${this.diffCompensation}`);
             this.produceEvent({
               type: 'NOW_PLAYING',
               data: {
@@ -1138,6 +1199,18 @@ class Session {
             // Allow Leader|Follower to clear vodCache...
             this.isAllowedToClearVodCache = true;
             sessionState.currentVod = await this._sessionState.getCurrentVod();
+            const diffMs = await this._playheadState.get("diffCompensation");
+            if (diffMs) {
+              this.diffCompensation = diffMs;
+              debug(`[${this._sessionId}]: Setting diffCompensation=${this.diffCompensation}`);
+              if (this.diffCompensation) {
+                this.timePositionOffset = this.diffCompensation;
+                cloudWatchLog(!this.cloudWatchLogging, 'engine-session',
+                { event: 'timePositionOffsetUpdated', channel: this._sessionId, offsetMs: this.timePositionOffset });
+              } else{
+                this.timePositionOffset = 0;
+              }
+            }
           }
         } catch (err) {
           console.error(`[${this._sessionId}]: Failed to init next VOD`);
@@ -1209,6 +1282,9 @@ class Session {
               await this._playheadState.set("playheadRef", Date.now());
               debug(`[${this._sessionId}]: LEADER: Set new Reloaded VOD and vodMediaSeq counts in store.`);
               // 4) emit cloudwatch event object
+              debug(`[${this._sessionId}]: next VOD Reloaded (${currentVod.getDeltaTimes()})`);
+              debug(`[${this._sessionId}]: ${currentVod.getPlayheadPositions()}`);
+              debug(`[${this._sessionId}]: msequences=${currentVod.getLiveMediaSequencesCount()}`);
               cloudWatchLog(!this.cloudWatchLogging, "engine-session", { event: "switchback", channel: this._sessionId, reqTimeMs: Date.now() - startTS });
 
               return;
@@ -1435,6 +1511,47 @@ class Session {
     debug(`[${this._sessionId}]: Current playhead position (${sessionState.vodMediaSeqVideo}): ${playheadPositions[sessionState.vodMediaSeqVideo]}`);
     return playheadPositions[sessionState.vodMediaSeqVideo];
   }
+
+  _getLastDuration(manifest) {
+    return new Promise((resolve, reject) => {
+      try {
+        const parser = m3u8.createStream();
+        let manifestStream = new Readable();
+        manifestStream.push(manifest);
+        manifestStream.push(null);
+
+        manifestStream.pipe(parser);
+        parser.on('m3u', m3u => {
+          if (m3u.items.PlaylistItem.length > 0) {
+            const endIdx = m3u.items.PlaylistItem.length - 1;
+            const bottomDuration = m3u.items.PlaylistItem[endIdx].get("duration");
+            resolve(bottomDuration);
+          } else {
+            console.error("Empty media playlist");
+            console.error(manifest);
+            reject('Empty media playlist!')
+          }
+        });
+      } catch (err) {
+        reject(err);
+      }
+    });
+  }
+
+  _getPlayheadDiffCompesationValue(diffMs, thresholdMs) {
+    let compensationSec = 0;
+    if (diffMs > thresholdMs) {
+      compensationSec = (diffMs / 1000) - (thresholdMs / 1000);
+      debug(`[${this._sessionId}]: Playhead stepping msequences too early. Need to wait longer. adding ${compensationSec}s`);
+      return compensationSec;
+    } else if (diffMs < -thresholdMs) {
+      compensationSec = (diffMs / 1000) + (thresholdMs / 1000);
+      debug(`[${this._sessionId}]: Playhead stepping msequences too LATE. Need to fast-forward. adding ${compensationSec}s`);
+      return compensationSec;
+    } else {
+      return compensationSec;
+    }
+  }
 }
 
 module.exports = Session;

package/engine/session_live.js

@@ -267,7 +267,7 @@ class SessionLive {
       debug(`[${this.sessionId}]: 'vodSegments' not empty = Using 'transitSegs'`);
     }
 
-    debug(`[${this.sessionId}]: Setting CurrentMediaSequenceSegments. First seg is: [${this.vodSegments[allBws[0]][0].uri}]`);
+    debug(`[${this.sessionId}]: Setting CurrentMediaSequenceSegments. First seg is: [${this.vodSegments[Object.keys(this.vodSegments)[0]][0].uri}]`);
 
     const isLeader = await this.sessionLiveStateStore.isLeader(this.instanceId);
     if (isLeader) {
@@ -501,7 +501,7 @@ class SessionLive {
           this.liveSegQueue[liveBw] = [];
         }
         // Do not push duplicates
-        const liveSegURIs = this.liveSegQueue[liveBw].filter(seg => seg.uri).map(seg => seg.uri);
+        const liveSegURIs = this.liveSegQueue[liveBw].filter((seg) => seg.uri).map((seg) => seg.uri);
         if (liveSegFromLeader.uri && liveSegURIs.includes(liveSegFromLeader.uri)) {
           debug(`[${this.sessionId}]: FOLLOWER: Found duplicate live segment. Skip push! (${liveBw})`);
         } else {
@@ -638,7 +638,7 @@ class SessionLive {
       if (manifestList.some((result) => result.status === "rejected")) {
         FETCH_ATTEMPTS--;
         debug(`[${this.sessionId}]: ALERT! Promises I: Failed, Rejection Found! Trying again in 1000ms...`);
-        await timer(1000)
+        await timer(1000);
         continue;
       }
 
@@ -654,8 +654,8 @@ class SessionLive {
         debug(`[${this.sessionId}]: Live Mseq counts=[${allMediaSeqCounts}]`);
         // Decrement fetch counter
         FETCH_ATTEMPTS--;
-        // Calculate retry delay time. Default=1500
-        let retryDelayMs = 1500;
+        // Calculate retry delay time. Default=1000
+        let retryDelayMs = 1000;
         if (Object.keys(this.liveSegQueue).length > 0) {
           const firstBw = Object.keys(this.liveSegQueue)[0];
           const lastIdx = this.liveSegQueue[firstBw].length - 1;
@@ -678,7 +678,7 @@ class SessionLive {
         let leadersFirstSeqCounts = await this.sessionLiveState.get("firstCounts");
         let tries = 20;
 
-        while (!isLeader && (!leadersFirstSeqCounts.liveSourceMseqCount && tries > 0) || leadersFirstSeqCounts.liveSourceMseqCount === 0) {
+        while ((!isLeader && !leadersFirstSeqCounts.liveSourceMseqCount && tries > 0) || leadersFirstSeqCounts.liveSourceMseqCount === 0) {
           debug(`[${this.sessionId}]: NEW FOLLOWER: Waiting for LEADER to add 'firstCounts' in store! Will look again after 1000ms (tries left=${tries})`);
           await timer(1000);
           leadersFirstSeqCounts = await this.sessionLiveState.get("firstCounts");
@@ -719,8 +719,9 @@ class SessionLive {
         }
         if (leadersFirstSeqCounts.mediaSeqCount !== this.mediaSeqCount) {
           this.mediaSeqCount = leadersFirstSeqCounts.mediaSeqCount;
-          debug(`[${this.sessionId}]: FOLLOWER transistioned with wrong V2L segments, updating counts to [${
-            this.mediaSeqCount}][${this.discSeqCount}], and reading 'transitSegs' from store`);
+          debug(
+            `[${this.sessionId}]: FOLLOWER transistioned with wrong V2L segments, updating counts to [${this.mediaSeqCount}][${this.discSeqCount}], and reading 'transitSegs' from store`
+          );
           const transitSegs = await this.sessionLiveState.get("transitSegs");
           if (!this._isEmpty(transitSegs)) {
             this.vodSegments = transitSegs;
@@ -1070,7 +1071,7 @@ class SessionLive {
         if (startIdx < 0) {
           this.restAmount = startIdx * -1;
           startIdx = 0;
-        } 
+        }
         if (mediaManifestUri) {
           // push segments
           this._addLiveSegmentsToQueue(startIdx, m3u.items.PlaylistItem, baseUrl, liveTargetBandwidth, isLeader);
@@ -1092,7 +1093,7 @@ class SessionLive {
    * @param {string} liveTargetBandwidth
    */
   _addLiveSegmentsToQueue(startIdx, playlistItems, baseUrl, liveTargetBandwidth, isLeader) {
-    const leaderOrFollower = isLeader ? "LEADER": "NEW FOLLOWER";
+    const leaderOrFollower = isLeader ? "LEADER" : "NEW FOLLOWER";
 
     for (let i = startIdx; i < playlistItems.length; i++) {
       let seg = {};
@@ -1162,7 +1163,7 @@ class SessionLive {
           seg["daterange"] = daterangeData;
         }
         // Push new Live Segments! But do not push duplicates
-        const liveSegURIs = this.liveSegQueue[liveTargetBandwidth].filter(seg => seg.uri).map(seg => seg.uri);
+        const liveSegURIs = this.liveSegQueue[liveTargetBandwidth].filter((seg) => seg.uri).map((seg) => seg.uri);
         if (seg.uri && liveSegURIs.includes(seg.uri)) {
           debug(`[${this.sessionId}]: ${leaderOrFollower}: Found duplicate live segment. Skip push! (${liveTargetBandwidth})`);
         } else {
@@ -1372,12 +1373,12 @@ class SessionLive {
     if (this._isEmpty(this.liveSegQueue)) {
       return null;
     }
-  
-    const bw0 = Object.keys(this.liveSegQueue)[0]; 
+
+    const bw0 = Object.keys(this.liveSegQueue)[0];
     if (this.liveSegQueue[bw0].length === 0) {
       return null;
     }
-    
+
     for (let i = 0; i < this.liveSegQueue[bw0].length; i++) {
       const segment = this.liveSegQueue[bw0][i];
       if (!segment.duration) {

package/engine/stream_switcher.js

@@ -482,7 +482,7 @@ class StreamSwitcher {
           if (mediaUri.match("^http")) {
             mediaURIs[bw] = mediaUri;
           } else {
-            mediaURIs[bw] = new URL(mediaUri, uri);
+            mediaURIs[bw] = new URL(mediaUri, uri).href;
           }
         }
 
@@ -575,7 +575,7 @@ class StreamSwitcher {
             if (playlistItem.properties.uri.match("^http")) {
               segmentUri = playlistItem.properties.uri;
             } else {
-              segmentUri = new URL(playlistItem.properties.uri, mediaURIs[bw]);
+              segmentUri = new URL(playlistItem.properties.uri, mediaURIs[bw]).href;
             }
             seg["duration"] = playlistItem.properties.duration;
             seg["uri"] = segmentUri;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eyevinn-channel-engine",
-  "version": "3.3.0",
+  "version": "3.3.3",
   "description": "OTT TV Channel Engine",
   "main": "index.js",
   "scripts": {
@@ -22,7 +22,7 @@
   "dependencies": {
     "@eyevinn/hls-repeat": "^0.1.1",
     "@eyevinn/hls-truncate": "^0.1.0",
-    "@eyevinn/hls-vodtolive": "^2.0.0",
+    "@eyevinn/hls-vodtolive": "^2.0.2",
     "@eyevinn/m3u8": "^0.4.1",
     "abort-controller": "^3.0.0",
     "debug": "^3.2.7",

package/spec/engine/init_switching_spec.js

@@ -413,14 +413,12 @@ describe("The initialize switching", () => {
       uri: "http://mock.mock.com/180000/seg12.ts",
     });
     expect(sessionCurrentSegs["1313000"][size - 1 - 2]).toEqual({
-      duration: 7.5,
-      timelinePosition: null,
-      uri: 'https://maitv-vod.lab.eyevinn.technology/tearsofsteel_4k.mov/600/600-00008.ts',
-      cue: null
+      discontinuity: true,
+      cue: { in: true }
     });
     expect(sessionCurrentSegs["1313000"][size - 1]).toEqual({
-      duration: 7.5,
-      uri: "https://maitv-vod.lab.eyevinn.technology/tearsofsteel_4k.mov/600/600-00010.ts",
+      duration: 11.25,
+      uri: "https://maitv-vod.lab.eyevinn.technology/tearsofsteel_4k.mov/600/600-00015.ts",
       timelinePosition: null,
       cue: null,
     });