feat(DASH): MPD Alternate support

shaka-project · Jul 17, 2024 · 297a3a6 · 297a3a6
1 parent c59922b
commit 297a3a6
Show file tree

Hide file tree

Showing 5 changed files with 74 additions and 0 deletions.
diff --git a/externs/shaka/ads.js b/externs/shaka/ads.js
@@ -250,6 +250,13 @@ shaka.extern.IAdManager = class extends EventTarget {
    */
   onHLSInterstitialMetadata(basePlayer, baseVideo, interstitial) {}
 
+  /**
+   * @param {!shaka.Player} basePlayer
+   * @param {!HTMLMediaElement} baseVideo
+   * @param {shaka.extern.TimelineRegionInfo} region
+   */
+  onDASHInterstitialMetadata(basePlayer, baseVideo, region) {}
+
   /**
    * @param {shaka.extern.AdInterstitial} interstitial
    */

diff --git a/lib/ads/ad_manager.js b/lib/ads/ad_manager.js
@@ -832,6 +832,22 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
     }
   }
 
+  /**
+   * @override
+   * @export
+   */
+  onDASHInterstitialMetadata(basePlayer, baseVideo, region) {
+    if (region.schemeIdUri != 'urn:mpeg:dash:event:alternativeMPD:2022') {
+      return;
+    }
+    if (!this.interstitialAdManager_) {
+      this.initInterstitial(/* adContainer= */ null, basePlayer, baseVideo);
+    }
+    if (this.interstitialAdManager_) {
+      this.interstitialAdManager_.addRegion(region);
+    }
+  }
+
   /**
    * @override
    * @export

diff --git a/lib/ads/interstitial_ad_manager.js b/lib/ads/interstitial_ad_manager.js
@@ -225,6 +225,51 @@ shaka.ads.InterstitialAdManager = class {
     }
   }
 
+  /**
+   * @param {shaka.extern.TimelineRegionInfo} region
+   */
+  addRegion(region) {
+    let alternativeMPDUri;
+    let alternativeMPDmode;
+    for (const node of region.eventNode.children) {
+      if (node.tagName == 'AlternativeMPD') {
+        const uri = node.attributes['uri'];
+        const mode = node.attributes['mode'];
+        if (uri) {
+          alternativeMPDUri = uri;
+          alternativeMPDmode = mode;
+          break;
+        }
+      }
+    }
+    if (!alternativeMPDUri) {
+      shaka.log.alwaysWarn('Unsupported MPD alternate', region);
+      return;
+    }
+    const isReplace = alternativeMPDmode == 'replace';
+    const isInsert = alternativeMPDmode == 'insert';
+    if (!isReplace && !isInsert) {
+      shaka.log.warning('Unsupported MPD alternate', region);
+      return;
+    }
+    const interstitial = {
+      id: null,
+      startTime: region.startTime,
+      endTime: isReplace ? region.endTime : null,
+      uri: alternativeMPDUri,
+      isSkippable: false,
+      skipOffset: null,
+      canJump: true,
+      resumeOffset: isInsert ? 0 : null,
+      playoutLimit: null,
+      once: false,
+      pre: false,
+      post: false,
+      timelineRange: isReplace && !isInsert,
+    };
+    this.addInterstitials([interstitial]);
+  }
+
   /**
    * @param {string} url
    * @return {!Promise}

diff --git a/lib/player.js b/lib/player.js
@@ -2148,6 +2148,9 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       preloadManager.addQueuedOperation(false, () => {
         if (this.adManager_) {
           this.adManager_.onDashTimedMetadata(region);
+          goog.asserts.assert(this.video_, 'Must have video');
+          this.adManager_.onDASHInterstitialMetadata(
+              this, this.video_, region);
         }
       });
     });

diff --git a/test/test/util/fake_ad_manager.js b/test/test/util/fake_ad_manager.js
@@ -94,6 +94,9 @@ shaka.test.FakeAdManager = class extends shaka.util.FakeEventTarget {
   /** @override */
   onHLSInterstitialMetadata(basePlayer, baseVideo, interstitial) {}
 
+  /** @override */
+  onDASHInterstitialMetadata(basePlayer, baseVideo, region) {}
+
   /** @override */
   addCustomInterstitial(interstitial) {}