feat(Ads): Add basic VMAP support without IMA (#7054)

Author: avelad

lib/ads/ad_utils.js

@@ -96,6 +96,47 @@ shaka.ads.Utils = class {
     }
     return interstitials;
   }
+
+  /**
+   * @param {!shaka.extern.xml.Node} vmap
+   * @return {!Array.<{time: ?number, uri: string}>}
+   */
+  static parseVMAP(vmap) {
+    const TXml = shaka.util.TXml;
+    /** @type {!Array.<{time: ?number, uri: string}>} */
+    const ads = [];
+    for (const adBreak of TXml.findChildren(vmap, 'vmap:AdBreak')) {
+      const timeOffset = adBreak.attributes['timeOffset'];
+      if (!timeOffset) {
+        continue;
+      }
+      let time = null;
+      if (timeOffset == 'start') {
+        time = 0;
+      } else if (timeOffset == 'end') {
+        time = Infinity;
+      } else {
+        time = shaka.util.TextParser.parseTime(timeOffset);
+      }
+      const adSource = TXml.findChild(adBreak, 'vmap:AdSource');
+      if (!adSource) {
+        continue;
+      }
+      const adTagURI = TXml.findChild(adSource, 'vmap:AdTagURI');
+      if (!adTagURI) {
+        continue;
+      }
+      const uri = TXml.getTextContents(adTagURI);
+      if (!uri) {
+        continue;
+      }
+      ads.push({
+        time,
+        uri,
+      });
+    }
+    return ads;
+  }
 };
 
 /**

lib/ads/interstitial_ad_manager.js

@@ -230,13 +230,8 @@ shaka.ads.InterstitialAdManager = class {
    * @return {!Promise}
    */
   async addAdUrlInterstitial(url) {
-    const type = shaka.net.NetworkingEngine.RequestType.ADS;
-    const request = shaka.net.NetworkingEngine.makeRequest(
-        [url],
-        shaka.net.NetworkingEngine.defaultRetryParameters());
-    const op = this.basePlayer_.getNetworkingEngine().request(type, request);
-    const response = await op.promise;
-    const data = shaka.util.TXml.parseXml(response.data, 'VAST,vmap:VMAP');
+    const responseData = await this.makeAdRequest_(url);
+    const data = shaka.util.TXml.parseXml(responseData, 'VAST,vmap:VMAP');
     if (!data) {
       throw new shaka.util.Error(
           shaka.util.Error.Severity.CRITICAL,
@@ -247,6 +242,20 @@ shaka.ads.InterstitialAdManager = class {
     if (data.tagName == 'VAST') {
       interstitials = shaka.ads.Utils.parseVastToInterstitials(
           data, this.lastTime_);
+    } else if (data.tagName == 'vmap:VMAP') {
+      for (const ad of shaka.ads.Utils.parseVMAP(data)) {
+        // eslint-disable-next-line no-await-in-loop
+        const vastResponseData = await this.makeAdRequest_(ad.uri);
+        const vast = shaka.util.TXml.parseXml(vastResponseData, 'VAST');
+        if (!vast) {
+          throw new shaka.util.Error(
+              shaka.util.Error.Severity.CRITICAL,
+              shaka.util.Error.Category.ADS,
+              shaka.util.Error.Code.VAST_INVALID_XML);
+        }
+        interstitials.push(...shaka.ads.Utils.parseVastToInterstitials(
+            vast, ad.time));
+      }
     }
     this.addInterstitials(interstitials);
   }
@@ -705,14 +714,9 @@ shaka.ads.InterstitialAdManager = class {
       if (!uri) {
         return interstitialsAd;
       }
-      const type = shaka.net.NetworkingEngine.RequestType.ADS;
-      const request = shaka.net.NetworkingEngine.makeRequest(
-          [uri],
-          shaka.net.NetworkingEngine.defaultRetryParameters());
-      const op = this.basePlayer_.getNetworkingEngine().request(type, request);
       try {
-        const response = await op.promise;
-        const data = shaka.util.StringUtils.fromUTF8(response.data);
+        const responseData = await this.makeAdRequest_(uri);
+        const data = shaka.util.StringUtils.fromUTF8(responseData);
         const dataAsJson =
         /** @type {!shaka.ads.InterstitialAdManager.AssetsList} */ (
             JSON.parse(data));
@@ -791,6 +795,21 @@ shaka.ads.InterstitialAdManager = class {
     netEngine.clearAllResponseFilters();
     this.basePlayer_.getNetworkingEngine().copyFiltersInto(netEngine);
   }
+
+  /**
+   * @param {string} url
+   * @return {!Promise.<BufferSource>}
+   * @private
+   */
+  async makeAdRequest_(url) {
+    const type = shaka.net.NetworkingEngine.RequestType.ADS;
+    const request = shaka.net.NetworkingEngine.makeRequest(
+        [url],
+        shaka.net.NetworkingEngine.defaultRetryParameters());
+    const op = this.basePlayer_.getNetworkingEngine().request(type, request);
+    const response = await op.promise;
+    return response.data;
+  }
 };