eyevinn-channel-engine 3.3.2 → 3.3.5

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,7 +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 DIFF_CORRECTION_RATE = 0.5;
+const DEFAULT_DIFF_COMPENSATION_RATE = 0.5;
 
 const timer = ms => new Promise(res => setTimeout(res, ms));
 
@@ -43,6 +43,7 @@ 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 = {
@@ -119,6 +120,9 @@ class Session {
       if (config.forceTargetDuration) {
         this.forceTargetDuration = config.forceTargetDuration;
       }
+      if (config.diffCompensationRate) {
+        this.diffCompensationRate = config.diffCompensationRate;
+      }
     }
   }
 
@@ -213,7 +217,7 @@ class Session {
             }
           // Apply external diff compensation if available.
           if (this.diffCompensation && this.diffCompensation > 0) {
-            const DIFF_COMPENSATION = (reqTickInterval * DIFF_CORRECTION_RATE).toFixed(2) * 1000;
+            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;
@@ -562,14 +566,16 @@ class Session {
     if (currentVod) {
       try {
 
+        let manifestMseq = playheadState.mediaSeq + playheadState.vodMediaSeqVideo;
         if (currentVod.sequenceAlwaysContainNewSegments) {
           const mediaSequenceValue = currentVod.mediaSequenceValues[playheadState.vodMediaSeqVideo];
           debug(`[${this._sessionId}]: {${mediaSequenceValue}}_{${currentVod.getLastSequenceMediaSequenceValue()}}`);
+          manifestMseq = playheadState.mediaSeq + mediaSequenceValue;
         }
 
         debug(`[${this._sessionId}]: [${playheadState.vodMediaSeqVideo}]_[${currentVod.getLiveMediaSequencesCount()}]`);
         const m3u8 = currentVod.getLiveMediaSequences(playheadState.mediaSeq, bw, playheadState.vodMediaSeqVideo, sessionState.discSeq, this.targetDurationPadding, this.forceTargetDuration);
-        debug(`[${this._sessionId}]: [${playheadState.mediaSeq + playheadState.vodMediaSeqVideo}][${sessionState.discSeq}][+${this.targetDurationPadding || 0}] Current media manifest for ${bw} requested`);
+        debug(`[${this._sessionId}]: [${manifestMseq}][${sessionState.discSeq}][+${this.targetDurationPadding || 0}] Current media manifest for ${bw} requested`);
         this.prevVodMediaSeq.video = playheadState.vodMediaSeqVideo;
         this.prevMediaSeqOffset.video = playheadState.mediaSeq;
         return m3u8;
@@ -1230,34 +1236,33 @@ class Session {
           try {
             debug(`[${this._sessionId}]: state=VOD_RELOAD_INIT`);
             if (isLeader) {
-
               const startTS = Date.now();
-
               // 1) To tell Follower that, Leader is working on it!
               sessionState.state = await this._sessionState.set("state", SessionState.VOD_RELOAD_INITIATING);
-
               // 2) Set new 'offset' sequences, to carry on the continuity from session-live 
               let mSeq = this.switchDataForSession.mediaSeq;
               let currentVod = await this._sessionState.getCurrentVod();
               if (currentVod.sequenceAlwaysContainNewSegments) {
                 // (!) will need to compensate if using this setting on HLSVod Object.
-                mSeq -= 1;
-              } 
+                Object.keys(this.switchDataForSession.transitionSegments).forEach(bw => {
+                  let shiftedSeg = this.switchDataForSession.transitionSegments[bw].shift();
+                  if (shiftedSeg && shiftedSeg.discontinuity) {
+                    shiftedSeg = this.switchDataForSession.transitionSegments[bw].shift();
+                  }
+                });
+              }
               const dSeq = this.switchDataForSession.discSeq;
               const mSeqOffset = this.switchDataForSession.mediaSeqOffset;
               const reloadBehind = this.switchDataForSession.reloadBehind;
               const segments = this.switchDataForSession.transitionSegments;
-
               if ([mSeq,dSeq,mSeqOffset,reloadBehind,segments].includes(null)) {
                 debug(`[${this._sessionId}]: LEADER: Cannot Reload VOD, missing switch-back data`);
                 return;
               }
-
               await this._sessionState.set("mediaSeq", mSeq);
               await this._playheadState.set("mediaSeq", mSeq);
               await this._sessionState.set("discSeq", dSeq);
               debug(`[${this._sessionId}]: Setting current media and discontinuity count -> [${mSeq}]:[${dSeq}]`);
-
               // 3) Set new media segments/currentVod, to carry on the continuity from session-live
               debug(`[${this._sessionId}]: LEADER: making changes to current VOD. I will also update currentVod in store.`);
               const playheadState = await this._playheadState.getValues(["vodMediaSeqVideo"]);
@@ -1266,8 +1271,10 @@ class Session {
                 nextMseq = currentVod.getLiveMediaSequencesCount() - 1;
               }
 
-              // TODO: Support reloading with audioSegments as well
-
+              // ---------------------------------------------------.
+              // TODO: Support reloading with audioSegments as well |
+              // ---------------------------------------------------'
+              
               await currentVod.reload(nextMseq, segments, null, reloadBehind);
               await this._sessionState.setCurrentVod(currentVod, { ttl: currentVod.getDuration() * 1000 });
               await this._sessionState.set("vodReloaded", 1);
@@ -1276,13 +1283,12 @@ class Session {
               await this._playheadState.set("vodMediaSeqVideo", 0);
               await this._playheadState.set("vodMediaSeqAudio", 0);
               await this._playheadState.set("playheadRef", Date.now());
+               // 4) Log to debug and cloudwatch
               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;
             } else {
               debug(`[${this._sessionId}]: not a leader so will go directly to state VOD_RELOAD_INITIATING`);

package/engine/session_live.js

@@ -218,6 +218,7 @@ class SessionLive {
         this.masterManifestUri = masterManifestUri;
         if (this.sessionLiveProfile) {
           this._filterLiveProfiles();
+          debug(`[${this.sessionId}]: Filtered Live profiles! (${Object.keys(this.mediaManifestURIs).length}) profiles left!`);
         }
       } catch (err) {
         this.masterManifestUri = null;
@@ -253,14 +254,30 @@ class SessionLive {
         if (segments[bw][0].discontinuity) {
           segments[bw].shift();
         }
-
+        let cueInExists = null;
         for (let segIdx = 0; segIdx < segments[bw].length; segIdx++) {
-          this.vodSegments[bw].push(segments[bw][segIdx]);
+          const v2lSegment = segments[bw][segIdx];
+          if (v2lSegment.cue) {
+            if (v2lSegment.cue["in"]) {
+              cueInExists = true;
+            } else {
+              cueInExists = false;
+            }
+          }
+          this.vodSegments[bw].push(v2lSegment);
         }
-        if (!segments[bw][segments[bw].length - 1].discontinuity) {
-          this.vodSegments[bw].push({ discontinuity: true, cue: { in: true } });
+
+        const endIdx = segments[bw].length - 1;
+        if (!segments[bw][endIdx].discontinuity) {
+          const finalSegItem = { discontinuity: true };
+          if (!cueInExists) {
+            finalSegItem["cue"] = { in: true };
+          }
+          this.vodSegments[bw].push(finalSegItem);
         } else {
-          segments[bw][segments[bw].length - 1]["cue"] = { in: true };
+          if (!cueInExists) {
+            segments[bw][endIdx]["cue"] = { in: true };
+          }
         }
       }
     } else {
@@ -601,7 +618,7 @@ class SessionLive {
     // ---------------------------------
     let FETCH_ATTEMPTS = 10;
     this.liveSegsForFollowers = {};
-
+    let bandwidthsToSkipOnRetry = [];
     while (FETCH_ATTEMPTS > 0) {
       if (isLeader) {
         debug(`[${this.sessionId}]: LEADER: Trying to fetch manifests for all bandwidths\n Attempts left=[${FETCH_ATTEMPTS}]`);
@@ -619,9 +636,15 @@ class SessionLive {
       let manifestList = [];
       this.pushAmount = 0;
       try {
+        if (bandwidthsToSkipOnRetry.length > 0) {
+          debug(`[${this.sessionId}]: (X) Skipping loadMedia promises for bws ${JSON.stringify(bandwidthsToSkipOnRetry)}`);
+        }
         // Collect Live Source Requesting Promises
         for (let i = 0; i < Object.keys(this.mediaManifestURIs).length; i++) {
           let bw = Object.keys(this.mediaManifestURIs)[i];
+          if (bandwidthsToSkipOnRetry.includes(bw)) {
+            continue;
+          }
           livePromises.push(this._loadMediaManifest(bw));
           debug(`[${this.sessionId}]: Pushed loadMedia promise for bw=[${bw}]`);
         }
@@ -642,16 +665,28 @@ class SessionLive {
         continue;
       }
 
-      const allMediaSeqCounts = manifestList.map((item) => {
-        if (item.status === "rejected") {
-          return item.reason.mediaSeq;
+      // Store the results locally
+      manifestList.forEach((variantItem) => {
+        const bw = variantItem.value.bandwidth;
+        if (!this.liveSourceM3Us[bw]) {
+          this.liveSourceM3Us[bw] = {};
         }
-        return item.value.mediaSeq;
+        this.liveSourceM3Us[bw] = variantItem.value;
       });
 
+      const allStoredMediaSeqCounts = Object.keys(this.liveSourceM3Us).map((variant) => this.liveSourceM3Us[variant].mediaSeq);
+
       // Handle if mediaSeqCounts are NOT synced up!
-      if (!allMediaSeqCounts.every((val, i, arr) => val === arr[0])) {
-        debug(`[${this.sessionId}]: Live Mseq counts=[${allMediaSeqCounts}]`);
+      if (!allStoredMediaSeqCounts.every((val, i, arr) => val === arr[0])) {
+        debug(`[${this.sessionId}]: Live Mseq counts=[${allStoredMediaSeqCounts}]`);
+        // Figure out what bw's are behind.
+        const higestMediaSeqCount = Math.max(...allStoredMediaSeqCounts);
+        bandwidthsToSkipOnRetry = Object.keys(this.liveSourceM3Us).filter((bw) => {
+          if (this.liveSourceM3Us[bw].mediaSeq === higestMediaSeqCount) {
+            return true;
+          }
+          return false;
+        });
         // Decrement fetch counter
         FETCH_ATTEMPTS--;
         // Calculate retry delay time. Default=1000
@@ -672,7 +707,7 @@ class SessionLive {
         continue;
       }
 
-      currentMseqRaw = allMediaSeqCounts[0];
+      currentMseqRaw = allStoredMediaSeqCounts[0];
 
       if (!isLeader) {
         let leadersFirstSeqCounts = await this.sessionLiveState.get("firstCounts");
@@ -733,7 +768,6 @@ class SessionLive {
         if (currentMseqRaw === leadersFirstSeqCounts.liveSourceMseqCount) {
           this.pushAmount = 1; // Follower from start
         } else {
-
           // TODO: To support and account for past discontinuity tags in the Live Source stream,
           // we will need to get the real 'current' discontinuity-sequence count from Leader somehow.
 
@@ -1030,8 +1064,8 @@ class SessionLive {
           const resolveObj = {
             M3U: m3u,
             mediaSeq: m3u.get("mediaSequence"),
+            bandwidth: liveTargetBandwidth,
           };
-          this.liveSourceM3Us[liveTargetBandwidth] = resolveObj;
           resolve(resolveObj);
         } catch (exc) {
           debug(`[${this.sessionId}]: Error when parsing latest manifest`);

package/engine/stream_switcher.js

@@ -626,7 +626,10 @@ class StreamSwitcher {
       } else {
         const lastSeg = toSegments[bw][toSegments[bw].length - 1];
         if (lastSeg.uri && !lastSeg.discontinuity) {
-          toSegments[bw].push({ discontinuity: true });
+          toSegments[bw].push({ discontinuity: true, cue: { in: true } });
+          OUTPUT_SEGMENTS[bw] = toSegments[bw].concat(fromSegments[targetBw]);
+        } else if (lastSeg.discontinuity && !lastSeg.cue) {
+          toSegments[bw][toSegments[bw].length - 1].cue = { in: true }
           OUTPUT_SEGMENTS[bw] = toSegments[bw].concat(fromSegments[targetBw]);
         } else {
           OUTPUT_SEGMENTS[bw] = toSegments[bw].concat(fromSegments[targetBw]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eyevinn-channel-engine",
-  "version": "3.3.2",
+  "version": "3.3.5",
   "description": "OTT TV Channel Engine",
   "main": "index.js",
   "scripts": {