shaka-player 3.2.1 → 3.3.1

package/test/util/cmcd_manager_unit.js

@@ -0,0 +1,291 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+goog.require('shaka.util.CmcdManager');
+goog.require('shaka.util.ObjectUtils');
+
+describe('CmcdManager', () => {
+  const CmcdManager = shaka.util.CmcdManager;
+  const uuidRegex =
+    '[A-F\\d]{8}-[A-F\\d]{4}-4[A-F\\d]{3}-[89AB][A-F\\d]{3}-[A-F\\d]{12}';
+  const data = {
+    'sid': 'c936730c-031e-4a73-976f-92bc34039c60',
+    'cid': 'xyz',
+    'su': false,
+    'nor': '../testing/3.m4v',
+    'nrr': '0-99',
+    'd': 6066.66,
+    'mtp': 10049,
+    'bs': true,
+    'br': 52317,
+    'v': 1,
+    'pr': 1,
+    'com.test-hello': 'world',
+    'com.test-testing': 1234,
+    'com.test-exists': true,
+    'com.test-notExists': false,
+    'com.test-token': Symbol('s'),
+  };
+
+  describe('Query serialization', () => {
+    it('produces correctly serialized data', () => {
+      const query = CmcdManager.toQuery(data);
+      const result = 'br=52317,bs,cid="xyz",com.test-exists,' +
+                     'com.test-hello="world",com.test-testing=1234,' +
+                     'com.test-token=s,d=6067,mtp=10000,' +
+                     'nor="..%2Ftesting%2F3.m4v",nrr="0-99",' +
+                     'sid="c936730c-031e-4a73-976f-92bc34039c60"';
+      expect(query).toBe(result);
+    });
+
+    it('escapes reserve character in string values', () => {
+      const query = CmcdManager.toQuery({
+        'com.test-escape': 'Double "Quotes"',
+      });
+      const result = 'com.test-escape="Double \\"Quotes\\""';
+      expect(query).toBe(result);
+    });
+  });
+
+  describe('Header serialization', () => {
+    it('produces all header shards', () => {
+      const header = CmcdManager.toHeaders(data);
+      expect(header).toEqual({
+        'CMCD-Object': 'br=52317,d=6067',
+        'CMCD-Request': 'com.test-exists,com.test-hello="world",' +
+                        'com.test-testing=1234,com.test-token=s,mtp=10000,' +
+                        'nor="..%2Ftesting%2F3.m4v",nrr="0-99"',
+        'CMCD-Session': 'cid="xyz",sid="c936730c-031e-4a73-976f-92bc34039c60"',
+        'CMCD-Status': 'bs',
+      });
+    });
+
+    it('ignores empty shards', () => {
+      expect(CmcdManager.toHeaders({br: 200})).toEqual({
+        'CMCD-Object': 'br=200',
+      });
+    });
+  });
+
+  describe('CmcdManager instance', () => {
+    const ObjectUtils = shaka.util.ObjectUtils;
+
+    const playerInterface = {
+      isLive: () => false,
+      getBandwidthEstimate: () => 10000000,
+      getBufferedInfo: () => ({
+        video: [
+          {start: 0, end: 5},
+          {start: 6, end: 31.234},
+          {start: 35, end: 40},
+        ],
+      }),
+      getVariantTracks: () => /** @type {Array.<shaka.extern.Track>} */([
+        {
+          type: 'variant',
+          bandwidth: 50000,
+          videoBandwidth: 40000,
+          audioBandWidth: 10000,
+        },
+        {
+          type: 'variant',
+          bandwidth: 5000000,
+          videoBandwidth: 4000000,
+          audioBandWidth: 1000000,
+        },
+      ]),
+      getPlaybackRate: () => 1,
+      getCurrentTime: () => 10,
+    };
+
+    const sid = '2ed2d1cd-970b-48f2-bfb3-50a79e87cfa3';
+    const config = {
+      enabled: false,
+      sessionId: '',
+      contentId: 'testing',
+      useHeaders: false,
+    };
+
+    /** @type shaka.util.CmcdManager */
+    let cmcdManager = new CmcdManager(playerInterface, config);
+
+    const request = {
+      uris: ['https://test.com/test.mpd'],
+      method: 'GET',
+      body: null,
+      headers: {
+        testing: '1234',
+      },
+      allowCrossSiteCredentials: false,
+      retryParameters: /** @type {shaka.extern.RetryParameters} */({}),
+      licenseRequestType: null,
+      sessionId: null,
+      streamDataCallback: null,
+    };
+
+    const manifestInfo = {
+      format: shaka.util.CmcdManager.StreamingFormat.DASH,
+    };
+
+    const segmentInfo = {
+      type: 'video',
+      init: false,
+      duration: 3.33,
+      mimeType: 'application/mp4',
+      codecs: 'avc1.42001e',
+      bandwidth: 5234167,
+    };
+
+    describe('configuration', () => {
+      it('does not modify requests when disabled', () => {
+        const r = ObjectUtils.cloneObject(request);
+
+        cmcdManager.applyManifestData(r, manifestInfo);
+        expect(r.uris[0]).toBe(request.uris[0]);
+
+        cmcdManager.applySegmentData(r, segmentInfo);
+        expect(r.uris[0]).toBe(request.uris[0]);
+      });
+
+      it('generates a session id if not provided', () => {
+        config.enabled = true;
+        cmcdManager = new CmcdManager(playerInterface, config);
+
+        const r = ObjectUtils.cloneObject(request);
+
+        cmcdManager.applyManifestData(r, manifestInfo);
+        const regex = new RegExp(`sid%3D%22${uuidRegex}%22`, 'i');
+        expect(regex.test(r.uris[0])).toBe(true);
+      });
+    });
+
+    describe('query mode', () => {
+      beforeAll(() => {
+        config.sessionId = sid;
+        cmcdManager = new CmcdManager(playerInterface, config);
+      });
+
+      it('modifies manifest request uris', () => {
+        const r = ObjectUtils.cloneObject(request);
+        cmcdManager.applyManifestData(r, manifestInfo);
+        const uri = 'https://test.com/test.mpd?CMCD=cid%3D%22testing%22%2C' +
+          'mtp%3D10000%2Cot%3Dm%2Csf%3Dd%2C' +
+          'sid%3D%222ed2d1cd-970b-48f2-bfb3-50a79e87cfa3%22%2Csu';
+        expect(r.uris[0]).toBe(uri);
+      });
+
+      it('modifies segment request uris', () => {
+        const r = ObjectUtils.cloneObject(request);
+        cmcdManager.applySegmentData(r, segmentInfo);
+        const uri = 'https://test.com/test.mpd?CMCD=bl%3D21200%2Cbr%3D5234%2Ccid%3D%22' +
+          'testing%22%2Cd%3D3330%2Cmtp%3D10000%2Cot%3Dv%2Csf%3Dd%2C' +
+          'sid%3D%222ed2d1cd-970b-48f2-bfb3-50a79e87cfa3%22%2Cst%3Dv%2Csu%2C' +
+          'tb%3D4000';
+        expect(r.uris[0]).toBe(uri);
+      });
+
+      it('modifies text request uris', () => {
+        const r = ObjectUtils.cloneObject(request);
+        cmcdManager.applyTextData(r);
+        const uri = 'https://test.com/test.mpd?CMCD=cid%3D%22' +
+          'testing%22%2Cmtp%3D10000%2Cot%3Dc%2Csf%3Dd%2C' +
+          'sid%3D%222ed2d1cd-970b-48f2-bfb3-50a79e87cfa3%22%2Csu';
+        expect(r.uris[0]).toBe(uri);
+      });
+    });
+
+    describe('header mode', () => {
+      beforeAll(() => {
+        config.useHeaders = true;
+        cmcdManager = new CmcdManager(playerInterface, config);
+      });
+
+      it('modifies manifest request headers', () => {
+        const r = ObjectUtils.cloneObject(request);
+        cmcdManager.applyManifestData(r, manifestInfo);
+        expect(r.headers).toEqual({
+          'testing': '1234',
+          'CMCD-Object': 'ot=m',
+          'CMCD-Request': 'mtp=10000,su',
+          'CMCD-Session': 'cid="testing",sf=d,' +
+                          'sid="2ed2d1cd-970b-48f2-bfb3-50a79e87cfa3"',
+        });
+      });
+
+      it('modifies segment request headers', () => {
+        const r = ObjectUtils.cloneObject(request);
+        cmcdManager.applySegmentData(r, segmentInfo);
+        expect(r.headers).toEqual({
+          'testing': '1234',
+          'CMCD-Object': 'br=5234,d=3330,ot=v,tb=4000',
+          'CMCD-Request': 'bl=21200,mtp=10000,su',
+          'CMCD-Session': 'cid="testing",sf=d,' +
+                          'sid="2ed2d1cd-970b-48f2-bfb3-50a79e87cfa3",st=v',
+        });
+      });
+    });
+
+    describe('src= mode', () => {
+      it('modifies media stream uris', () => {
+        const r = cmcdManager
+            .appendSrcData('https://test.com/test.mp4', 'video/mp4');
+        const uri = 'https://test.com/test.mp4?CMCD=cid%3D%22testing%22%2C' +
+                    'mtp%3D10000%2Cot%3Dav%2Csf%3Dd%2C' +
+                    'sid%3D%222ed2d1cd-970b-48f2-bfb3-50a79e87cfa3%22%2Csu';
+        expect(r).toBe(uri);
+      });
+
+      it('modifies manifest stream uris', () => {
+        const r = cmcdManager
+            .appendSrcData('https://test.com/test.m3u8', 'application/x-mpegurl');
+        const uri = 'https://test.com/test.m3u8?CMCD=cid%3D%22testing%22%2C' +
+                    'mtp%3D10000%2Cot%3Dm%2Csf%3Dd%2C' +
+                    'sid%3D%222ed2d1cd-970b-48f2-bfb3-50a79e87cfa3%22%2Csu';
+        expect(r).toBe(uri);
+      });
+
+      it('modifies text track uris', () => {
+        const r = cmcdManager.appendTextTrackData('https://test.com/test.vtt');
+        const uri = 'https://test.com/test.vtt?CMCD=cid%3D%22testing%22%2C' +
+                    'mtp%3D10000%2Cot%3Dc%2Csf%3Dd%2C' +
+                    'sid%3D%222ed2d1cd-970b-48f2-bfb3-50a79e87cfa3%22%2Csu';
+        expect(r).toBe(uri);
+      });
+    });
+
+    describe('adheres to the spec', () => {
+      beforeAll(() => {
+        cmcdManager.setBuffering(false);
+        cmcdManager.setBuffering(true);
+      });
+
+      it('sends bs only once', () => {
+        let r = ObjectUtils.cloneObject(request);
+        cmcdManager.applySegmentData(r, segmentInfo);
+        expect(r.headers['CMCD-Status']).toContain('bs');
+
+        r = ObjectUtils.cloneObject(request);
+        cmcdManager.applySegmentData(r, segmentInfo);
+        expect(r.headers['CMCD-Status']).not.toContain('bs');
+      });
+
+      it('sends su until buffering is complete', () => {
+        let r = ObjectUtils.cloneObject(request);
+        cmcdManager.applySegmentData(r, segmentInfo);
+        expect(r.headers['CMCD-Request']).toContain(',su');
+
+        r = ObjectUtils.cloneObject(request);
+        cmcdManager.applySegmentData(r, segmentInfo);
+        expect(r.headers['CMCD-Request']).toContain(',su');
+
+        cmcdManager.setBuffering(false);
+        r = ObjectUtils.cloneObject(request);
+        cmcdManager.applySegmentData(r, segmentInfo);
+        expect(r.headers['CMCD-Request']).not.toContain(',su');
+      });
+    });
+  });
+});

package/test/util/stream_utils_unit.js

@@ -16,14 +16,14 @@ describe('StreamUtils', () => {
   /** @type {!jasmine.Spy} */
   let decodingInfoSpy;
 
-  const originalDecodingInfo = window.shakaMediaCapabilities.decodingInfo;
+  const originalDecodingInfo = navigator.mediaCapabilities.decodingInfo;
 
   beforeEach(() => {
     decodingInfoSpy = jasmine.createSpy('decodingInfo');
   });
 
   afterEach(() => {
-    window.shakaMediaCapabilities.decodingInfo = originalDecodingInfo;
+    navigator.mediaCapabilities.decodingInfo = originalDecodingInfo;
   });
 
   describe('filterStreamsByLanguageAndRole', () => {
@@ -511,7 +511,7 @@ describe('StreamUtils', () => {
     });
 
     it('handles decodingInfo exception', async () => {
-      window.shakaMediaCapabilities.decodingInfo =
+      navigator.mediaCapabilities.decodingInfo =
           shaka.test.Util.spyFunc(decodingInfoSpy);
       // If decodingInfo() fails, setDecodingInfo should finish without throwing
       // an exception, and the variant should have no decodingInfo result.
@@ -537,6 +537,47 @@ describe('StreamUtils', () => {
       expect(manifest.variants.length).toBe(1);
       expect(manifest.variants[0].decodingInfos.length).toBe(0);
     });
+
+    it('includes transferFunction in config when hdr', async () => {
+      const originalDecodingInfo = navigator.mediaCapabilities.decodingInfo;
+
+      try {
+        navigator.mediaCapabilities.decodingInfo =
+            shaka.test.Util.spyFunc(decodingInfoSpy);
+
+        manifest = shaka.test.ManifestGenerator.generate((manifest) => {
+          manifest.addVariant(0, (variant) => {
+            variant.addVideo(0, (stream) => {
+              stream.mime('video/mp4', 'avc1.640028');
+              stream.hdr = 'SDR';
+            });
+          });
+          manifest.addVariant(1, (variant) => {
+            variant.addVideo(1, (stream) => {
+              stream.mime('video/mp4', 'hvc1.2.4.L150.90');
+              stream.hdr = 'PQ';
+            });
+          });
+          manifest.addVariant(2, (variant) => {
+            variant.addVideo(2, (stream) => {
+              stream.mime('video/mp4', 'hvc1.2.4.L153.B0');
+              stream.hdr = 'HLG';
+            });
+          });
+        });
+
+        await StreamUtils.getDecodingInfosForVariants(manifest.variants,
+            /* usePersistentLicenses= */ false, /* srcEquals= */ false);
+        expect(decodingInfoSpy.calls.argsFor(0)[0].video.transferFunction)
+            .toBe('srgb');
+        expect(decodingInfoSpy.calls.argsFor(1)[0].video.transferFunction)
+            .toBe('pq');
+        expect(decodingInfoSpy.calls.argsFor(2)[0].video.transferFunction)
+            .toBe('hlg');
+      } finally {
+        navigator.mediaCapabilities.decodingInfo = originalDecodingInfo;
+      }
+    });
   });
 
   describe('filterManifest', () => {
@@ -826,7 +867,7 @@ describe('StreamUtils', () => {
           });
         });
       });
-      window.shakaMediaCapabilities.decodingInfo =
+      navigator.mediaCapabilities.decodingInfo =
           shaka.test.Util.spyFunc(decodingInfoSpy);
       decodingInfoSpy.and.callFake((config) => {
         const res = config.video.contentType.includes('notsmooth') ?

package/third_party/closure-uri/uri.js

@@ -808,6 +808,27 @@ goog.Uri.QueryData.prototype.add = function(key, value) {
   return this;
 };
 
+/**
+ * Sets a key value pair and removes all other keys with the same value.
+ *
+ * @param {string} key Name.
+ * @param {string} value Value.
+ * @return {!goog.Uri.QueryData} Instance of this object.
+ */
+ goog.Uri.QueryData.prototype.set = function(key, value) {
+  this.ensureKeyMapInitialized_();
+  // Invalidate the cache.
+  this.encodedQuery_ = null;
+
+  if (!this.keyMap_.hasOwnProperty(key)) {
+    this.add(key, value);
+  } else {
+    this.keyMap_[key] = [value];
+  }
+
+  return this;
+};
+
 
 /**
  * @return {string} Encoded query string.

package/ui/airplay_button.js

@@ -36,6 +36,7 @@ shaka.ui.AirPlayButton = class extends shaka.ui.Element {
     /** @private {!HTMLButtonElement} */
     this.airplayButton_ = shaka.util.Dom.createButton();
     this.airplayButton_.classList.add('shaka-airplay-button');
+    this.airplayButton_.classList.add('shaka-tooltip');
     this.airplayButton_.ariaPressed = 'false';
 
     /** @private {!HTMLElement} */

package/ui/audio_language_selection.js

@@ -7,6 +7,7 @@
 
 goog.provide('shaka.ui.AudioLanguageSelection');
 
+goog.require('shaka.ui.Controls');
 goog.require('shaka.ui.Enums');
 goog.require('shaka.ui.LanguageUtils');
 goog.require('shaka.ui.Locales');
@@ -31,6 +32,7 @@ shaka.ui.AudioLanguageSelection = class extends shaka.ui.SettingsMenu {
     super(parent, controls, shaka.ui.Enums.MaterialDesignIcons.LANGUAGE);
 
     this.button.classList.add('shaka-language-button');
+    this.button.classList.add('shaka-tooltip-status');
     this.menu.classList.add('shaka-audio-languages');
 
     this.eventManager.listen(
@@ -71,6 +73,8 @@ shaka.ui.AudioLanguageSelection = class extends shaka.ui.SettingsMenu {
 
     this.controls.dispatchEvent(
         new shaka.util.FakeEvent('languageselectionupdated'));
+
+    this.button.setAttribute('shaka-status', this.currentSelection.innerText);
   }
 
   /** @private */
@@ -118,3 +122,6 @@ shaka.ui.AudioLanguageSelection.Factory = class {
 
 shaka.ui.OverflowMenu.registerElement(
     'language', new shaka.ui.AudioLanguageSelection.Factory());
+
+shaka.ui.Controls.registerElement(
+    'language', new shaka.ui.AudioLanguageSelection.Factory());

package/ui/cast_button.js

@@ -41,6 +41,7 @@ shaka.ui.CastButton = class extends shaka.ui.Element {
     /** @private {!HTMLButtonElement} */
     this.castButton_ = shaka.util.Dom.createButton();
     this.castButton_.classList.add('shaka-cast-button');
+    this.castButton_.classList.add('shaka-tooltip');
     this.castButton_.ariaPressed = 'false';
 
     /** @private {!HTMLElement} */
@@ -101,9 +102,8 @@ shaka.ui.CastButton = class extends shaka.ui.Element {
       } catch (error) {
         this.castButton_.disabled = false;
         if (error.code != shaka.util.Error.Code.CAST_CANCELED_BY_USER) {
-          this.controls.dispatchEvent(new shaka.util.FakeEvent('error', {
-            detail: error,
-          }));
+          this.controls.dispatchEvent(new shaka.util.FakeEvent(
+              'error', (new Map()).set('detail', error)));
         }
       }
     }

package/ui/context_menu.js

@@ -0,0 +1,109 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+
+goog.provide('shaka.ui.ContextMenu');
+
+goog.require('goog.asserts');
+goog.require('shaka.log');
+goog.require('shaka.ui.Element');
+goog.require('shaka.ui.Utils');
+goog.require('shaka.util.Dom');
+goog.requireType('shaka.ui.Controls');
+
+
+/**
+ * @extends {shaka.ui.Element}
+ * @final
+ * @export
+ */
+shaka.ui.ContextMenu = class extends shaka.ui.Element {
+  /**
+   * @param {!HTMLElement} parent
+   * @param {!shaka.ui.Controls} controls
+   */
+  constructor(parent, controls) {
+    super(parent, controls);
+
+    /** @private {!shaka.extern.UIConfiguration} */
+    this.config_ = this.controls.getConfig();
+
+    /** @private {HTMLElement} */
+    this.controlsContainer_ = this.controls.getControlsContainer();
+
+    /** @private {!Array.<shaka.extern.IUIElement>} */
+    this.children_ = [];
+
+    /** @private {!HTMLElement} */
+    this.contextMenu_ = shaka.util.Dom.createHTMLElement('div');
+    this.contextMenu_.classList.add('shaka-no-propagation');
+    this.contextMenu_.classList.add('shaka-context-menu');
+    this.contextMenu_.classList.add('shaka-hidden');
+
+    this.controlsContainer_.appendChild(this.contextMenu_);
+
+    this.eventManager.listen(this.controlsContainer_, 'contextmenu', (e) => {
+      if (this.contextMenu_.classList.contains('shaka-hidden')) {
+        e.preventDefault();
+
+        const controlsLocation =
+            this.controlsContainer_.getBoundingClientRect();
+        this.contextMenu_.style.left = `${e.clientX - controlsLocation.left}px`;
+        this.contextMenu_.style.top = `${e.clientY - controlsLocation.top}px`;
+
+        shaka.ui.Utils.setDisplay(this.contextMenu_, true);
+      } else {
+        shaka.ui.Utils.setDisplay(this.contextMenu_, false);
+      }
+    });
+
+    this.eventManager.listen(window, 'click', () => {
+      shaka.ui.Utils.setDisplay(this.contextMenu_, false);
+    });
+
+    this.createChildren_();
+  }
+
+  /** @override */
+  release() {
+    this.controlsContainer_ = null;
+
+    for (const element of this.children_) {
+      element.release();
+    }
+
+    this.children_ = [];
+    super.release();
+  }
+
+  /**
+   * @param {string} name
+   * @param {!shaka.extern.IUIElement.Factory} factory
+   * @export
+   */
+  static registerElement(name, factory) {
+    shaka.ui.ContextMenu.elementNamesToFactories_.set(name, factory);
+  }
+
+  /**
+   * @private
+   */
+  createChildren_() {
+    for (const name of this.config_.contextMenuElements) {
+      const factory =
+          shaka.ui.ContextMenu.elementNamesToFactories_.get(name);
+      if (factory) {
+        goog.asserts.assert(this.controls, 'Controls should not be null!');
+        this.children_.push(factory.create(this.contextMenu_, this.controls));
+      } else {
+        shaka.log.alwaysWarn('Unrecognized context menu element:', name);
+      }
+    }
+  }
+};
+
+/** @private {!Map.<string, !shaka.extern.IUIElement.Factory>} */
+shaka.ui.ContextMenu.elementNamesToFactories_ = new Map();