shaka-player 4.3.13 → 4.3.15

package/docs/tutorials/ad_monetization.md

@@ -7,6 +7,60 @@ other ad providers in v3.1+.
 Please note that the current API is likely to undergo significant
 changes as our support extends.
 
+#### AWS Elemental MediaTailor Integration
+
+Shaka Player provides an integration with the [AWS Elemental MediaTailor][].
+We support Client Side, Server Side and overlays ad insertion.
+
+[AWS Elemental MediaTailor]: https://aws.amazon.com/mediatailor/
+
+All ad insertion experiences are available through the
+{@linksource shaka.extern.IAdManager} object on the Player.
+
+If you're not using Shaka's UI library, you will
+also need to create a `<div>` over your video element to serve as an ad
+container.
+
+Start by initializing the server side logic.
+With Shaka UI:
+
+```js
+const video = document.getElementById('video');
+const ui = video['ui'];
+const controls = video.ui.getControls();
+// If you're using a non-UI build, this is the div you'll need to create
+// for your layout.
+const container = controls.getServerSideAdContainer();
+const player = controls.getPlayer();
+const netEngine = player.getNetworkingEngine();
+const adManager = player.getAdManager();
+adManager.initMediaTailor(container, netEngine, video);
+```
+
+Requesting a Client Side stream:
+
+```js
+const mediaTailorUrl = 'https://d305rncpy6ne2q.cloudfront.net/v1/session/94063eadf7d8c56e9e2edd84fdf897826a70d0df/SFP-MediaTailor-VOD-HLS-DASH/out/v1/b94f3611978f419985a18335bac9d9cb/ddb73bf548a44551a0059c346226445a/eaa5485198bf497284559efb8172425e/index.mpd';
+const mediaTailorAdsParams = {
+  adsParams: {
+    assetid: 'test2',
+    podduration: '15',
+  },
+};
+const uri = await adManager.requestMediaTailorStream(mediaTailorUrl, mediaTailorAdsParams);
+player.load(uri);
+```
+
+Requesting a Server Side stream:
+
+```js
+const mediaTailorUrl = 'https://ad391cc0d55b44c6a86d232548adc225.mediatailor.us-east-1.amazonaws.com/v1/session/d02fedbbc5a68596164208dd24e9b48aa60dadc7/singssai/master.m3u8';
+const uri = await adManager.requestMediaTailorStream(mediaTailorUrl);
+player.load(uri);
+```
+
+Note: overlays ad insertions is the same as server side.
+
 #### IMA SDK Integration
 
 Shaka Player provides an integration with the [Interactive Media Ads][] SDKs.

package/docs/tutorials/fairplay.md

@@ -98,9 +98,9 @@ player.getNetworkingEngine().registerRequestFilter((type, request) => {
   const originalPayload = new Uint8Array(request.body);
   const base64Payload =
       shaka.util.Uint8ArrayUtils.toStandardBase64(originalPayload);
-  const params = 'spc=' + base64Payload;
+  const params = 'spc=' + encodeURIComponent(base64Payload);
   request.headers['Content-Type'] = 'application/x-www-form-urlencoded';
-  request.body = shaka.util.StringUtils.toUTF8(encodeURIComponent(params));
+  request.body = shaka.util.StringUtils.toUTF8(params);
 });
 
 player.getNetworkingEngine().registerResponseFilter((type, response) => {

package/docs/tutorials/index.json

@@ -9,6 +9,7 @@
   { "license-wrapping": { "title": "License Wrapping" } },
   { "ui": { "title": "UI Library" } },
   { "ui-customization": { "title": "Configuring the UI" } },
+  { "text-displayer": { "title": "Configuring text displayer" } },
   { "errors": { "title": "Error Handling" } },
   { "a11y": { "title": "Creating accessible buttons" } },
   { "ad_monetization": { "title": "Serving ads with our IMA SDK integration" } },

package/docs/tutorials/plugins.md

@@ -38,6 +38,10 @@ __Subtitle/caption parsers__
       {@linksource shaka.text.Mp4VttParser}
     - TTML: {@linksource shaka.text.TtmlTextParser} and
       {@linksource shaka.text.Mp4TtmlParser}
+    - SubRip (SRT): {@linksource shaka.text.SrtTextParser}
+    - LyRiCs (LRC): {@linksource shaka.text.LrcTextParser}
+    - SubStation Alpha (SSA, ASS): {@linksource shaka.text.SsaTextParser}
+    - SubViewer (SBV): {@linksource shaka.text.SbvTextParser}
 
 __Subtitle/caption displayers__
   - Configured at runtime on a Player instance

package/docs/tutorials/text-displayer.md

@@ -0,0 +1,15 @@
+# Configuring text displayer`
+
+Shaka Player supports two types of Text Displayer.
+1) Using the browser's native API, Shaka Player creates a textTrack along
+   with the AUDIO or VIDEO Element.
+2) Rendering the subtitles in a container in the DOM.
+3) Providing a custom text displayer factory would allow a developer to make
+   their own custom text displayer that fits neither category.
+
+By default, if not configured otherwise, the player will use type 1.
+To configure type 2, you have to call `setVideoContainer` function before
+making `load` call in the player.
+
+Note: The UI calls setVideoContainer for you if the video's controls are
+disabled, so this isn't always necessary when using the UI.

package/docs/tutorials/ui-customization.md

@@ -265,3 +265,32 @@ PR contributions to [the gallery repo][] are welcome.
 [@lucksy]: https://github.com/lucksy
 [pre-packaged Shaka UI themes]: https://lucksy.github.io/shaka-player-themes/
 [the gallery repo]: https://github.com/lucksy/shaka-player-themes
+
+#### Add custom localization
+
+Load specific locale data at runtime (adjust the URL and language as needed):
+```js
+const locale = 'el';
+const controls = ui.getControls();
+const localization = controls.getLocalization();
+const response = await fetch('ui/locales/' + locale + '.json');     // <----- JSON translation URL here
+const translations = await response.json();
+const translation_map = new Map(Object.entries(translations));
+localization.insert(locale, translation_map);
+```
+
+Lazy-load any requested locale data at runtime (adjust the URL as needed):
+```js
+const controls = ui.getControls();
+const localization = controls.getLocalization();
+
+localization.addEventListener('unknown-locales', async (e) => {
+  for (const locale of e.locales) {
+    const response = await fetch('ui/locales/' + locale + '.json');     // <----- JSON translation URL here
+    const translations = await response.json();
+    const translation_map = new Map(Object.entries(translations));
+    localization.insert(locale, translation_map);
+  }
+});
+```
+

package/docs/tutorials/ui.md

@@ -203,11 +203,14 @@ constructor.
 ```js
 // "local" because it is for local playback only, as opposed to the player proxy
 // object, which will route your calls to the ChromeCast receiver as necessary.
-const localPlayer = new shaka.Player(videoElement);
+const localPlayer = new shaka.Player();
 // "Overlay" because the UI will add DOM elements inside the container,
 // to visually overlay the video element
 const ui = new shaka.ui.Overlay(localPlayer, videoContainerElement,
   videoElement);
+// Now that the player has been configured to be part of a UI, attach it to the
+// video.
+await localPlayer.attach(videoElement);
 
 // As with DOM-based setup, get access to the UI controls and player from the
 // UI.

package/externs/lcevc.js

@@ -1,3 +1,9 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2023 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 /**
 * @fileoverview Externs for LcevcDil
 * compiler.

package/externs/shaka/manifest_parser.js

@@ -94,6 +94,14 @@ shaka.extern.ManifestParser = class {
    * @exportDoc
    */
   onExpirationUpdated(sessionId, expiration) {}
+
+  /**
+   * Tell the parser that the initial variant has been chosen.
+   *
+   * @param {shaka.extern.Variant} variant
+   * @exportDoc
+   */
+  onInitialVariantChosen(variant) {}
 };
 
 

package/externs/shaka/player.js

@@ -561,7 +561,7 @@ shaka.extern.TimelineRegionInfo;
  * @property {?number} channelsCount
  *   The number of audio channels, or null if unknown.
  * @property {?string} pixelAspectRatio
- *   The pixel aspect ratio value; e.g "1:1".
+ *   The pixel aspect ratio value; e.g. "1:1".
  * @property {?number} width
  *   The video width in pixels.
  * @exportDoc

package/externs/shaka/text.js

@@ -417,11 +417,13 @@ shaka.extern.TextParser = class {
    * @param {shaka.extern.TextParser.TimeContext} timeContext
    *    The time information that should be used to adjust the times values
    *    for each cue.
+   * @param {?(string|undefined)} uri
+   *    The media uri.
    * @return {!Array.<!shaka.extern.Cue>}
    *
    * @exportDoc
    */
-  parseMedia(data, timeContext) {}
+  parseMedia(data, timeContext, uri) {}
 
   /**
    * Notifies the stream if the manifest is in sequence mode or not.

package/lib/abr/simple_abr_manager.js

@@ -63,7 +63,7 @@ shaka.abr.SimpleAbrManager = class {
             this.bandwidthEstimator_.configure(this.config_.advanced);
           }
           const chosenVariant = this.chooseVariant();
-          if (chosenVariant) {
+          if (chosenVariant && navigator.onLine) {
             this.switch_(chosenVariant);
           }
         }

package/lib/ads/client_side_ad.js

@@ -207,6 +207,15 @@ shaka.ads.ClientSideAd = class {
     }
   }
 
+  /**
+   * It's required for a muted ad to start when autoplaying.
+   *
+   * @param {number} videoVolume
+   */
+  setInitialMuted(videoVolume) {
+    this.volume_ = videoVolume;
+    this.manager_.setVolume(0);
+  }
 
   /**
    * @override

package/lib/ads/client_side_ad_manager.js

@@ -13,6 +13,10 @@ goog.provide('shaka.ads.ClientSideAdManager');
 
 goog.require('goog.asserts');
 goog.require('shaka.ads.ClientSideAd');
+goog.require('shaka.log');
+goog.require('shaka.util.Dom');
+goog.require('shaka.util.EventManager');
+goog.require('shaka.util.FakeEvent');
 goog.require('shaka.util.IReleasable');
 
 /**
@@ -452,9 +456,10 @@ shaka.ads.ClientSideAdManager = class {
     if (this.ad_.isLinear()) {
       this.adContainer_.setAttribute('ad-active', 'true');
       this.video_.pause();
-      this.ad_.setVolume(this.video_.volume);
       if (this.video_.muted) {
-        this.ad_.setMuted(true);
+        this.ad_.setInitialMuted(this.video_.volume);
+      } else {
+        this.ad_.setVolume(this.video_.volume);
       }
     }
   }

package/lib/ads/server_side_ad_manager.js

@@ -14,7 +14,11 @@ goog.provide('shaka.ads.ServerSideAdManager');
 goog.require('goog.asserts');
 goog.require('shaka.ads.ServerSideAd');
 goog.require('shaka.log');
+goog.require('shaka.util.EventManager');
+goog.require('shaka.util.Error');
+goog.require('shaka.util.FakeEvent');
 goog.require('shaka.util.IReleasable');
+goog.require('shaka.util.PublicPromise');
 
 
 /**

package/lib/cast/cast_proxy.js

@@ -496,6 +496,16 @@ shaka.cast.CastProxy = class extends shaka.util.FakeEventTarget {
       startTime = this.sender_.get('video', 'currentTime');
     }
 
+    let activeTextTrack;
+    const textTracks = this.sender_.get('player', 'getTextTracks')();
+
+    if (textTracks && textTracks.length) {
+      activeTextTrack = textTracks.find((t) => t.active);
+    }
+
+    const isTextTrackVisible =
+        this.sender_.get('player', 'isTextTrackVisible')();
+
     // Now load the manifest, if present.
     if (assetUri) {
       // Don't autoplay the content until we finish setting up initial state.
@@ -527,6 +537,14 @@ shaka.cast.CastProxy = class extends shaka.util.FakeEventTarget {
         /** @type {Object} */(this.localPlayer_)[setter](value);
       }
 
+      this.localPlayer_.setTextTrackVisibility(isTextTrackVisible);
+      if (activeTextTrack) {
+        this.localPlayer_.selectTextLanguage(
+            activeTextTrack.language,
+            activeTextTrack.roles,
+            activeTextTrack.forced);
+      }
+
       // Restore the original autoplay setting.
       this.localVideo_.autoplay = autoplay;
       if (assetUri) {

package/lib/cea/cea608_memory.js

@@ -80,7 +80,7 @@ shaka.cea.Cea608Memory = class {
    * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
    */
   forceEmit(startTime, endTime) {
-    const stream = `CC${(this.fieldNum_<< 1) | this.channelNum_ +1}`;
+    const stream = `CC${((this.fieldNum_<< 1) | this.channelNum_) + 1}`;
     const topLevelCue = new shaka.text.Cue(
         startTime, endTime, /* payload= */ '');
     return shaka.cea.CeaUtils.getParsedCaption(

package/lib/cea/cea_decoder.js

@@ -117,6 +117,9 @@ shaka.cea.CeaDecoder = class {
     const reader = new shaka.util.DataViewReader(
         userDataSeiMessage, shaka.util.DataViewReader.Endianness.BIG_ENDIAN);
 
+    if (reader.getLength() < shaka.cea.CeaDecoder.MIN_LENGTH) {
+      return;
+    }
     if (reader.readUint8() !== shaka.cea.CeaDecoder.USA_COUNTRY_CODE) {
       return;
     }
@@ -260,7 +263,7 @@ shaka.cea.CeaDecoder = class {
     // Get the correct stream for this caption packet (CC1, ..., CC4)
     const selectedChannel = fieldNum ?
         this.currentField2Channel_ : this.currentField1Channel_;
-    const selectedMode = `CC${(fieldNum << 1) | selectedChannel + 1}`;
+    const selectedMode = `CC${((fieldNum << 1) | selectedChannel) + 1}`;
     const selectedStream = this.cea608ModeToStream_.get(selectedMode);
 
     // Check for bad frames (bad pairs). This can be two 0xff, two 0x00, or any
@@ -402,3 +405,10 @@ shaka.cea.CeaDecoder.NTSC_CC_FIELD_2 = 1;
  * @private @const {number}
  */
 shaka.cea.CeaDecoder.USA_COUNTRY_CODE = 0xb5;
+
+/**
+ * Caption packet min length
+ * Country Code + ATSC_PROVIDER_CODE + ATSC_1_USER_IDENTIFIER + USER_DATA_TYPE
+ * @private @const {number}
+ */
+shaka.cea.CeaDecoder.MIN_LENGTH = 8;

package/lib/dash/dash_parser.js

@@ -213,6 +213,33 @@ shaka.dash.DashParser = class {
     // No-op
   }
 
+  /**
+   * @override
+   * @exportInterface
+   */
+  onInitialVariantChosen(variant) {
+    // For live it is necessary that the first time we update the manifest with
+    // a shorter time than indicated to take into account that the last segment
+    // added could be halfway, for example
+    if (this.manifest_ && this.manifest_.presentationTimeline.isLive()) {
+      const stream = variant.video || variant.audio;
+      if (stream && stream.segmentIndex) {
+        const availabilityEnd =
+            this.manifest_.presentationTimeline.getSegmentAvailabilityEnd();
+        const position = stream.segmentIndex.find(availabilityEnd);
+        if (position == null) {
+          return;
+        }
+        const reference = stream.segmentIndex.get(position);
+        if (!reference) {
+          return;
+        }
+        this.updatePeriod_ = reference.endTime - availabilityEnd;
+        this.setUpdateTimer_(/* offset= */ 0);
+      }
+    }
+  }
+
   /**
    * Makes a network request for the manifest and parses the resulting data.
    *
@@ -242,7 +269,8 @@ shaka.dash.DashParser = class {
 
     // For redirections add the response uri to the first entry in the
     // Manifest Uris array.
-    if (response.uri && !this.manifestUris_.includes(response.uri)) {
+    if (response.uri && response.uri != response.originalUri &&
+        !this.manifestUris_.includes(response.uri)) {
       this.manifestUris_.unshift(response.uri);
     }
 
@@ -489,6 +517,12 @@ shaka.dash.DashParser = class {
 
     await this.periodCombiner_.combinePeriods(periods, context.dynamic);
 
+    // Set minBufferTime to 0 for low-latency DASH live stream to achieve the
+    // best latency
+    if (this.lowLatencyMode_) {
+      minBufferTime = 0;
+    }
+
     // These steps are not done on manifest update.
     if (!this.manifest_) {
       this.manifest_ = {
@@ -780,40 +814,29 @@ shaka.dash.DashParser = class {
       }
     }
 
-    const audioSets = this.config_.disableAudio ? [] :
-        this.getSetsOfType_(normalAdaptationSets, ContentType.AUDIO);
-    const videoSets = this.config_.disableVideo ? [] :
-        this.getSetsOfType_(normalAdaptationSets, ContentType.VIDEO);
-    const textSets = this.config_.disableText ? [] :
-        this.getSetsOfType_(normalAdaptationSets, ContentType.TEXT);
-    const imageSets = this.config_.disableThumbnails ? [] :
-        this.getSetsOfType_(normalAdaptationSets, ContentType.IMAGE);
-
-    if (!videoSets.length && !audioSets.length) {
+    const audioStreams = this.getStreamsFromSets_(
+        this.config_.disableAudio,
+        normalAdaptationSets,
+        ContentType.AUDIO);
+    const videoStreams = this.getStreamsFromSets_(
+        this.config_.disableVideo,
+        normalAdaptationSets,
+        ContentType.VIDEO);
+    const textStreams = this.getStreamsFromSets_(
+        this.config_.disableText,
+        normalAdaptationSets,
+        ContentType.TEXT);
+    const imageStreams = this.getStreamsFromSets_(
+        this.config_.disableThumbnails,
+        normalAdaptationSets,
+        ContentType.IMAGE);
+
+    if (videoStreams.length === 0 && audioStreams.length === 0) {
       throw new shaka.util.Error(
           shaka.util.Error.Severity.CRITICAL,
           shaka.util.Error.Category.MANIFEST,
-          shaka.util.Error.Code.DASH_EMPTY_PERIOD);
-    }
-
-    const audioStreams = [];
-    for (const audioSet of audioSets) {
-      audioStreams.push(...audioSet.streams);
-    }
-
-    const videoStreams = [];
-    for (const videoSet of videoSets) {
-      videoStreams.push(...videoSet.streams);
-    }
-
-    const textStreams = [];
-    for (const textSet of textSets) {
-      textStreams.push(...textSet.streams);
-    }
-
-    const imageStreams = [];
-    for (const imageSet of imageSets) {
-      imageStreams.push(...imageSet.streams);
+          shaka.util.Error.Code.DASH_EMPTY_PERIOD,
+      );
     }
 
     return {
@@ -826,15 +849,26 @@ shaka.dash.DashParser = class {
   }
 
   /**
+   * Gets the streams from the given sets or returns an empty array if disabled
+   * or no streams are found.
+   * @param {boolean} disabled
    * @param {!Array.<!shaka.dash.DashParser.AdaptationInfo>} adaptationSets
-   * @param {string} type
-   * @return {!Array.<!shaka.dash.DashParser.AdaptationInfo>}
-   * @private
-   */
-  getSetsOfType_(adaptationSets, type) {
-    return adaptationSets.filter((as) => {
-      return as.contentType == type;
-    });
+   * @param {string} contentType
+   @private
+  */
+  getStreamsFromSets_(disabled, adaptationSets, contentType) {
+    if (disabled || !adaptationSets.length) {
+      return [];
+    }
+
+    return adaptationSets.reduce((all, part) => {
+      if (part.contentType != contentType) {
+        return all;
+      }
+
+      all.push(...part.streams);
+      return all;
+    }, []);
   }
 
   /**
@@ -1407,7 +1441,7 @@ shaka.dash.DashParser = class {
     // NOTE: An updatePeriod_ of -1 means the attribute was missing.
     // An attribute which is present and set to 0 should still result in
     // periodic updates.  For more, see:
-    // https://github.com/shaka-project/shaka-player/issues/331
+    // https://github.com/Dash-Industry-Forum/Guidelines-TimingModel/issues/48
     if (this.updatePeriod_ < 0) {
       return;
     }

package/lib/dash/mpd_utils.js

@@ -310,30 +310,46 @@ shaka.dash.MpdUtils = class {
   }
 
   /**
-   * Searches the inheritance for a Segment* with the given attribute.
-   *
+   * Parses common attributes for Representation, AdaptationSet, and Period.
    * @param {shaka.dash.DashParser.Context} context
    * @param {function(?shaka.dash.DashParser.InheritanceFrame):Element} callback
-   *   Gets the Element that contains the attribute to inherit.
-   * @param {string} attribute
-   * @return {?string}
-   */
-  static inheritAttribute(context, callback, attribute) {
+   * @return {!Array.<!Element>}
+    */
+  static getNodes(context, callback) {
     const Functional = shaka.util.Functional;
     goog.asserts.assert(
         callback(context.representation),
-        'There must be at least one element of the given type');
+        'There must be at least one element of the given type',
+    );
 
-    /** @type {!Array.<!Element>} */
-    const nodes = [
+    return [
       callback(context.representation),
       callback(context.adaptationSet),
       callback(context.period),
     ].filter(Functional.isNotNull);
+  }
 
-    return nodes
-        .map((s) => { return s.getAttribute(attribute); })
-        .reduce((all, part) => { return all || part; });
+  /**
+   * Searches the inheritance for a Segment* with the given attribute.
+   *
+   * @param {shaka.dash.DashParser.Context} context
+   * @param {function(?shaka.dash.DashParser.InheritanceFrame):Element} callback
+   *   Gets the Element that contains the attribute to inherit.
+   * @param {string} attribute
+   * @return {?string}
+   */
+  static inheritAttribute(context, callback, attribute) {
+    const MpdUtils = shaka.dash.MpdUtils;
+    const nodes = MpdUtils.getNodes(context, callback);
+
+    let result = null;
+    for (const node of nodes) {
+      result = node.getAttribute(attribute);
+      if (result) {
+        break;
+      }
+    }
+    return result;
   }
 
   /**
@@ -346,22 +362,18 @@ shaka.dash.MpdUtils = class {
    * @return {Element}
    */
   static inheritChild(context, callback, child) {
-    const Functional = shaka.util.Functional;
-    goog.asserts.assert(
-        callback(context.representation),
-        'There must be at least one element of the given type');
-
-    /** @type {!Array.<!Element>} */
-    const nodes = [
-      callback(context.representation),
-      callback(context.adaptationSet),
-      callback(context.period),
-    ].filter(Functional.isNotNull);
+    const MpdUtils = shaka.dash.MpdUtils;
+    const nodes = MpdUtils.getNodes(context, callback);
 
     const XmlUtils = shaka.util.XmlUtils;
-    return nodes
-        .map((s) => { return XmlUtils.findChild(s, child); })
-        .reduce((all, part) => { return all || part; });
+    let result = null;
+    for (const node of nodes) {
+      result = XmlUtils.findChild(node, child);
+      if (result) {
+        break;
+      }
+    }
+    return result;
   }
 
   /**

package/lib/deprecate/deprecate.js

@@ -107,7 +107,7 @@ shaka.Deprecate = class {
       libraryVersion,
       '. Additional information:',
       description,
-    ].join('');
+    ].join(' ');
 
     shaka.log.alwaysError(errorMessage);
     goog.asserts.assert(false, errorMessage);