shaka-player 4.2.5 → 4.3.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shaka-player",
   "description": "DASH/EME video player library",
-  "version": "4.2.5",
+  "version": "4.3.1",
   "homepage": "https://github.com/shaka-project/shaka-player",
   "author": "Google",
   "maintainers": [
@@ -28,9 +28,9 @@
     "eslint-plugin-shaka-rules": "file:./build/eslint-plugin-shaka-rules",
     "esprima": "^4.0.1",
     "fontfaceonload": "^1.0.2",
-    "google-closure-compiler-java": "^20220301.0.0",
-    "google-closure-deps": "https://gitpkg.now.sh/google/closure-library/closure-deps?d7736da6",
-    "google-closure-library": "^20220301.0.0",
+    "google-closure-compiler-java": "^20221102.0.0",
+    "google-closure-deps": "^20221102.0.0",
+    "google-closure-library": "^20221102.0.0",
     "htmlhint": "^1.1.3",
     "jasmine-ajax": "^4.0.0",
     "jimp": "^0.16.1",
@@ -46,6 +46,7 @@
     "karma-sourcemap-loader": "^0.3.8",
     "karma-spec-reporter": "^0.0.34",
     "karma-webdriver-launcher": "^1.0.8",
+    "lcevc_dil.js": "^1.1.20",
     "less": "https://gitpkg.now.sh/joeyparrish/less.js/packages/less?28c63a43",
     "less-plugin-clean-css": "github:austingardner/less-plugin-clean-css#4e9e77bf",
     "material-design-lite": "^1.3.0",
@@ -71,6 +72,8 @@
       "eme-encryption-scheme-polyfill/index.js",
       "es6-promise-polyfill/promise.min.js",
       "google-closure-library/closure/goog/base.js",
+      "lcevc_dil.js/dist/lcevc_dil.min.js",
+      "lcevc_dil.js/dist/liblcevc_dpi.wasm",
       "less/dist/less.js",
       "material-design-lite/dist/material.indigo-blue.min.css",
       "material-design-lite/dist/material.min.js",

package/roadmap.md

@@ -23,13 +23,15 @@ Candidate features for future release cycles:
    https://github.com/shaka-project/shaka-player/issues/879
  - Smaller, more modular binary
 
-v4.3 - 2022 Q4 / 2023 Q1
+=====
+
+v4.3 - 2022 Q4
  - Support ID3 tags in mp4
    https://github.com/shaka-project/shaka-player/issues/3351
  - Lazy-load HLS playlists on adaptation
    https://github.com/shaka-project/shaka-player/issues/1936
-
-=====
+ - HLS key rotation
+   https://github.com/shaka-project/shaka-player/issues/741
 
 v4.2 - 2022 Q3
  - Automatic ABR quality restrictions based on size

package/test/ads/ad_manager_unit.js

@@ -25,45 +25,158 @@ describe('Ad manager', () => {
       /** @type {!HTMLElement} */ (document.createElement('div'));
   });
 
-  it('doesn\'t init CS if CS IMA is missing', () => {
-    const error = createError(
-        shaka.util.Error.Severity.CRITICAL,
-        shaka.util.Error.Code.CS_IMA_SDK_MISSING);
+  describe('client side', () => {
+    it('doesn\'t init if CS IMA is missing', () => {
+      const error = createError(
+          shaka.util.Error.Severity.CRITICAL,
+          shaka.util.Error.Code.CS_IMA_SDK_MISSING);
 
-    expect(() => adManager.initClientSide(
-        adContainer, mockVideo)).toThrow(error);
-  });
+      expect(() => adManager.initClientSide(
+          adContainer, mockVideo)).toThrow(error);
+    });
 
-  it('doesn\'t init SS if SS IMA is missing', () => {
-    const error = createError(
-        shaka.util.Error.Severity.CRITICAL,
-        shaka.util.Error.Code.SS_IMA_SDK_MISSING);
+    it('doesn\'t request ads until CS is initialized', () => {
+      setupFakeIMA();
+      const error = createError(
+          shaka.util.Error.Severity.RECOVERABLE,
+          shaka.util.Error.Code.CS_AD_MANAGER_NOT_INITIALIZED);
 
-    expect(() => adManager.initServerSide(
-        adContainer, mockVideo)).toThrow(error);
-  });
+      const request = new google.ima.AdsRequest();
+      request.adTagUrl = 'fakeTag';
+
+      expect(() => adManager.requestClientSideAds(request)).toThrow(error);
+    });
+
+    it('doesn\'t request ads if CS events return no ad', () => {
+      setupFakeIMA();
+
+      const request = new google.ima.AdsRequest();
+      request.adTagUrl = 'fakeTag';
+
+      /** @type {google.ima.AdsLoader} */
+      let mockAdsLoaderInstance;
+      let numAdsRequested = 0;
+      /** @type {google.ima.AdsManager} */
+      let mockAdsManagerInstance;
+      /** @type {Event} */
+      let loadEvent;
+      /** @type {Event} */
+      let startedEventA;
+      /** @type {Event} */
+      let startedEventB;
+
+      /** @suppress {invalidCasts} */
+      function makeMocks() {
+        const mockAdsLoader = class extends shaka.util.FakeEventTarget {
+          constructor(container) {
+            super();
+            mockAdsLoaderInstance = /** @type {!google.ima.AdsLoader} */ (this);
+          }
+
+          getSettings() {
+            return {
+              setPlayerType: (type) => {},
+              setPlayerVersion: (version) => {},
+            };
+          }
 
-  it('doesn\'t request CS ads until CS is initialized', () => {
-    setupFakeIMA();
-    const error = createError(
-        shaka.util.Error.Severity.RECOVERABLE,
-        shaka.util.Error.Code.CS_AD_MANAGER_NOT_INITIALIZED);
+          requestAds(imaRequest) {
+            numAdsRequested += 1;
+          }
+        };
+        window['google'].ima.AdsLoader = mockAdsLoader;
 
-    const request = new google.ima.AdsRequest();
-    request.adTagUrl = 'fakeTag';
+        loadEvent = /** @type {!google.ima.AdsManagerLoadedEvent} */ (
+          new shaka.util.FakeEvent(
+              google.ima.AdsManagerLoadedEvent.Type.ADS_MANAGER_LOADED));
+        loadEvent.getAdsManager = () => {
+          const MockAdManager = class extends shaka.util.FakeEventTarget {
+            constructor() {
+              super();
+              mockAdsManagerInstance =
+              /** @type {!google.ima.AdsManager} */ (this);
+            }
 
-    expect(() => adManager.requestClientSideAds(request)).toThrow(error);
+            getCuePoints() {
+              return [];
+            }
+
+            getVolume() {
+              return 0;
+            }
+          };
+          return new MockAdManager();
+        };
+        startedEventA = /** @type {!google.ima.AdEvent} */ (
+          new shaka.util.FakeEvent(google.ima.AdEvent.Type.STARTED));
+        startedEventA.getAd = () => {
+          return null;
+        };
+        startedEventB = /** @type {!google.ima.AdEvent} */ (
+          new shaka.util.FakeEvent(google.ima.AdEvent.Type.STARTED));
+        startedEventB.getAd = () => {
+          return {
+            isLinear: () => true,
+          };
+        };
+      }
+      makeMocks();
+
+      // Set up event listeners.
+      const eventManager = new shaka.util.EventManager();
+      let loaded = false;
+      let numAdStarted = 0;
+      const AdManager = shaka.ads.AdManager;
+      eventManager.listen(adManager, AdManager.IMA_AD_MANAGER_LOADED, () => {
+        loaded = true;
+      });
+      eventManager.listen(adManager, AdManager.AD_STARTED, () => {
+        numAdStarted += 1;
+      });
+
+      // Set up the ad manager.
+      adManager.initClientSide(adContainer, mockVideo);
+      goog.asserts.assert(loadEvent != null, 'loadEvent exists');
+      mockAdsLoaderInstance.dispatchEvent(/** @type {!Event} */ (loadEvent));
+      expect(loaded).toBe(true);
+
+      // Request an ad, but create an event with no ad.
+      adManager.requestClientSideAds(request);
+      expect(numAdsRequested).toBe(1);
+      mockAdsManagerInstance.dispatchEvent(/** @type {!Event} */ (
+        startedEventA));
+      expect(numAdStarted).toBe(0);
+
+      // Request another ad. This time, the IMA event has an ad, so the ad
+      // manager should fire a started event.
+      adManager.requestClientSideAds(request);
+      expect(numAdsRequested).toBe(2);
+      mockAdsManagerInstance.dispatchEvent(/** @type {!Event} */ (
+        startedEventB));
+      expect(numAdStarted).toBe(1);
+    });
   });
 
-  it('doesn\'t request SS streams until SS is initialized', () => {
-    setupFakeIMA();
-    const error = createError(
-        shaka.util.Error.Severity.RECOVERABLE,
-        shaka.util.Error.Code.SS_AD_MANAGER_NOT_INITIALIZED);
+  describe('server side', () => {
+    it('doesn\'t init if SS IMA is missing', () => {
+      const error = createError(
+          shaka.util.Error.Severity.CRITICAL,
+          shaka.util.Error.Code.SS_IMA_SDK_MISSING);
+
+      expect(() => adManager.initServerSide(
+          adContainer, mockVideo)).toThrow(error);
+    });
+
+    it('doesn\'t request streams until SS is initialized', () => {
+      setupFakeIMA();
+      const error = createError(
+          shaka.util.Error.Severity.RECOVERABLE,
+          shaka.util.Error.Code.SS_AD_MANAGER_NOT_INITIALIZED);
 
-    const request = new google.ima.dai.api.StreamRequest();
+      const request = new google.ima.dai.api.StreamRequest();
 
-    expect(() => adManager.requestServerSideStream(request)).toThrow(error);
+      expect(() => adManager.requestServerSideStream(request)).toThrow(error);
+    });
   });
 
   /**
@@ -86,5 +199,45 @@ describe('Ad manager', () => {
     window['google'].ima.AdsRequest = class {};
     window['google'].ima.dai.api = {};
     window['google'].ima.dai.api.StreamRequest = class {};
+    window['google'].ima.settings = {};
+    window['google'].ima.settings.setLocale = (locale) => {};
+    window['google'].ima.AdsManagerLoadedEvent = {};
+    window['google'].ima.AdsManagerLoadedEvent.Type = {
+      ADS_MANAGER_LOADED: 'ADS_MANAGER_LOADED',
+    };
+    window['google'].ima.AdErrorEvent = {};
+    window['google'].ima.AdErrorEvent.Type = {
+      AD_ERROR: 'AD_ERROR',
+    };
+    window['google'].ima.AdEvent = {};
+    window['google'].ima.AdEvent.Type = {
+      CONTENT_PAUSE_REQUESTED: 'CONTENT_PAUSE_REQUESTED',
+      STARTED: 'STARTED',
+      FIRST_QUARTILE: 'FIRST_QUARTILE',
+      MIDPOINT: 'MIDPOINT',
+      THIRD_QUARTILE: 'THIRD_QUARTILE',
+      COMPLETE: 'COMPLETE',
+      CONTENT_RESUME_REQUESTED: 'CONTENT_RESUME_REQUESTED',
+      ALL_ADS_COMPLETED: 'ALL_ADS_COMPLETED',
+      SKIPPED: 'SKIPPED',
+      VOLUME_CHANGED: 'VOLUME_CHANGED',
+      VOLUME_MUTED: 'VOLUME_MUTED',
+      PAUSED: 'PAUSED',
+      RESUMED: 'RESUMED',
+      SKIPPABLE_STATE_CHANGED: 'SKIPPABLE_STATE_CHANGED',
+      CLICK: 'CLICK',
+      AD_PROGRESS: 'AD_PROGRESS',
+      AD_BUFFERING: 'AD_BUFFERING',
+      IMPRESSION: 'IMPRESSION',
+      DURATION_CHANGE: 'DURATION_CHANGE',
+      USER_CLOSE: 'USER_CLOSE',
+      LOADED: 'LOADED',
+      LINEAR_CHANGED: 'LINEAR_CHANGED',
+      AD_METADATA: 'AD_METADATA',
+      LOG: 'LOG',
+      AD_BREAK_READY: 'AD_BREAK_READY',
+      INTERACTION: 'INTERACTION',
+    };
+    window['google'].ima.AdDisplayContainer = class { initialize() {} };
   }
 });

package/test/cast/cast_utils_unit.js

@@ -206,8 +206,10 @@ describe('CastUtils', () => {
 
         mediaSourceEngine = new shaka.media.MediaSourceEngine(
             video,
-            new shaka.test.FakeClosedCaptionParser(),
             new shaka.test.FakeTextDisplayer());
+        const config =
+            shaka.util.PlayerConfiguration.createDefault().mediaSource;
+        mediaSourceEngine.configure(config);
 
         const ContentType = shaka.util.ManifestParserUtils.ContentType;
         const initObject = new Map();

package/test/dash/dash_parser_content_protection_unit.js

@@ -44,6 +44,7 @@ describe('DashParser ContentProtection', () => {
       isAutoLowLatencyMode: () => false,
       enableLowLatencyMode: () => {},
       updateDuration: () => {},
+      newDrmInfo: (stream) => {},
     };
 
     const actual = await dashParser.start(

package/test/dash/dash_parser_live_unit.js

@@ -37,6 +37,7 @@ describe('DashParser Live', () => {
       isAutoLowLatencyMode: () => false,
       enableLowLatencyMode: () => {},
       updateDuration: () => {},
+      newDrmInfo: (stream) => {},
     };
   });
 

package/test/dash/dash_parser_manifest_unit.js

@@ -53,6 +53,7 @@ describe('DashParser Manifest', () => {
       isAutoLowLatencyMode: () => false,
       enableLowLatencyMode: () => {},
       updateDuration: () => {},
+      newDrmInfo: (stream) => {},
     };
   });
 
@@ -119,7 +120,97 @@ describe('DashParser Manifest', () => {
     });
   }
 
-  describe('parses and inherits attributes', () => {
+  describe('parses and inherits attributes with sequenceMode', () => {
+    beforeEach(() => {
+      const config = shaka.util.PlayerConfiguration.createDefault().manifest;
+      config.dash.sequenceMode = true;
+      parser.configure(config);
+    });
+
+    makeTestsForEach(
+        [
+          '<MPD minBufferTime="PT75S">',
+          '  <Period id="1" duration="PT30S">',
+          '    <BaseURL>http://example.com</BaseURL>',
+        ],
+        [
+          '    <AdaptationSet contentType="video" mimeType="video/mp4"',
+          '        codecs="avc1.4d401f" frameRate="1000000/42000">',
+          '      <Representation bandwidth="100" width="768" height="576" />',
+          '      <Representation bandwidth="50" width="576" height="432" />',
+          '    </AdaptationSet>',
+          '    <AdaptationSet mimeType="text/vtt"',
+          '        lang="es" label="spanish">',
+          '      <Role value="caption" />',
+          '      <Role value="main" />',
+          '      <Representation bandwidth="100" />',
+          '    </AdaptationSet>',
+          '    <AdaptationSet mimeType="audio/mp4" lang="en" ',
+          '                             codecs="mp4a.40.29">',
+          '      <Role value="main" />',
+          '      <Representation bandwidth="100" />',
+          '    </AdaptationSet>',
+          '  </Period>',
+          '</MPD>',
+        ],
+        shaka.test.ManifestGenerator.generate((manifest) => {
+          manifest.sequenceMode = true;
+          manifest.anyTimeline();
+          manifest.minBufferTime = 75;
+          manifest.addPartialVariant((variant) => {
+            variant.language = 'en';
+            variant.bandwidth = 200;
+            variant.primary = true;
+            variant.addPartialStream(ContentType.VIDEO, (stream) => {
+              stream.bandwidth = 100;
+              stream.frameRate = 1000000 / 42000;
+              stream.size(768, 576);
+              stream.mime('video/mp4', 'avc1.4d401f');
+            });
+            variant.addPartialStream(ContentType.AUDIO, (stream) => {
+              stream.bandwidth = 100;
+              stream.primary = true;
+              stream.roles = ['main'];
+              stream.mime('audio/mp4', 'mp4a.40.29');
+            });
+          });
+          manifest.addPartialVariant((variant) => {
+            variant.language = 'en';
+            variant.bandwidth = 150;
+            variant.primary = true;
+            variant.addPartialStream(ContentType.VIDEO, (stream) => {
+              stream.bandwidth = 50;
+              stream.frameRate = 1000000 / 42000;
+              stream.size(576, 432);
+              stream.mime('video/mp4', 'avc1.4d401f');
+            });
+            variant.addPartialStream(ContentType.AUDIO, (stream) => {
+              stream.bandwidth = 100;
+              stream.primary = true;
+              stream.roles = ['main'];
+              stream.mime('audio/mp4', 'mp4a.40.29');
+            });
+          });
+          manifest.addPartialTextStream((stream) => {
+            stream.language = 'es';
+            stream.label = 'spanish';
+            stream.primary = true;
+            stream.mimeType = 'text/vtt';
+            stream.bandwidth = 100;
+            stream.kind = 'caption';
+            stream.roles = ['caption', 'main'];
+          });
+        }));
+  });
+
+  describe('parses and inherits attributes without sequenceMode', () => {
+    beforeEach(() => {
+      const config = shaka.util.PlayerConfiguration.createDefault().manifest;
+      config.dash.sequenceMode = false;
+      parser.configure(config);
+    });
+
+
     makeTestsForEach(
         [
           '<MPD minBufferTime="PT75S">',
@@ -147,6 +238,7 @@ describe('DashParser Manifest', () => {
           '</MPD>',
         ],
         shaka.test.ManifestGenerator.generate((manifest) => {
+          manifest.sequenceMode = false;
           manifest.anyTimeline();
           manifest.minBufferTime = 75;
           manifest.addPartialVariant((variant) => {

package/test/dash/dash_parser_segment_base_unit.js

@@ -39,6 +39,7 @@ describe('DashParser SegmentBase', () => {
       isAutoLowLatencyMode: () => false,
       enableLowLatencyMode: () => {},
       updateDuration: () => {},
+      newDrmInfo: (stream) => {},
     };
   });
 

package/test/dash/dash_parser_segment_list_unit.js

@@ -349,6 +349,7 @@ describe('DashParser SegmentList', () => {
       isAutoLowLatencyMode: () => false,
       enableLowLatencyMode: () => {},
       updateDuration: () => {},
+      newDrmInfo: (stream) => {},
     };
     const manifest = await dashParser.start('dummy://foo', playerInterface);
     const stream = manifest.variants[0].video;

package/test/dash/dash_parser_segment_template_unit.js

@@ -48,6 +48,7 @@ describe('DashParser SegmentTemplate', () => {
       isAutoLowLatencyMode: () => false,
       enableLowLatencyMode: () => {},
       updateDuration: () => {},
+      newDrmInfo: (stream) => {},
     };
   });
 

package/test/demo/demo_unit.js

@@ -95,7 +95,8 @@ describe('Demo', () => {
           .add('playRangeEnd')
           .add('manifest.dash.keySystemsByURI')
           .add('manifest.hls.mediaPlaylistFullMimeType')
-          .add('drm.keySystemsMapping');
+          .add('drm.keySystemsMapping')
+          .add('streaming.parsePrftBox');
 
       /**
        * @param {!Object} section