shaka-player 4.12.8 → 4.13.0

package/lib/dash/mpd_utils.js

@@ -37,7 +37,7 @@ shaka.dash.MpdUtils = class {
    */
   static fillUriTemplate(
       uriTemplate, representationId, number, subNumber, bandwidth, time) {
-    /** @type {!Object.<string, ?number|?string>} */
+    /** @type {!Object<string, ?number | ?string>} */
     const valueTable = {
       'RepresentationID': representationId,
       'Number': number,
@@ -46,6 +46,7 @@ shaka.dash.MpdUtils = class {
       'Time': time,
     };
 
+    // cspell: disable-next-line
     const re = /\$(RepresentationID|Number|SubNumber|Bandwidth|Time)?(?:%0([0-9]+)([diouxX]))?\$/g;  // eslint-disable-line max-len
     const uri = uriTemplate.replace(re, (match, name, widthStr, format) => {
       if (match == '$$') {
@@ -129,7 +130,7 @@ shaka.dash.MpdUtils = class {
    * @param {number} periodDuration The Period's duration in seconds.
    *   Infinity indicates that the Period continues indefinitely.
    * @param {number} startNumber
-   * @return {!Array.<shaka.media.PresentationTimeline.TimeRange>}
+   * @return {!Array<shaka.media.PresentationTimeline.TimeRange>}
    */
   static createTimeline(
       timePoints, timescale, unscaledPresentationTimeOffset,
@@ -143,7 +144,7 @@ shaka.dash.MpdUtils = class {
     // Alias.
     const TXml = shaka.util.TXml;
 
-    /** @type {!Array.<shaka.media.PresentationTimeline.TimeRange>} */
+    /** @type {!Array<shaka.media.PresentationTimeline.TimeRange>} */
     const timeline = [];
     let lastEndTime = -unscaledPresentationTimeOffset;
 
@@ -186,7 +187,7 @@ shaka.dash.MpdUtils = class {
             return timeline;
           } else if (startTime >= nextStartTime) {
             shaka.log.warning(
-                'An "S" element cannot have a negative repeatif its start ',
+                'An "S" element cannot have a negative repeat if its start ',
                 'time exceeds the next "S" element\'s start time:',
                 'ignoring the remaining "S" elements.', timePoint);
             return timeline;
@@ -207,7 +208,7 @@ shaka.dash.MpdUtils = class {
             shaka.log.warning(
                 'The last "S" element cannot have a negative repeat',
                 'if its start time exceeds the Period\'s duration:',
-                'igoring the last "S" element.', timePoint);
+                'ignoring the last "S" element.', timePoint);
             return timeline;
           }
           repeat = Math.ceil((periodDuration * timescale - startTime) / d) - 1;
@@ -293,7 +294,7 @@ shaka.dash.MpdUtils = class {
       startNumber = 1;
     }
 
-    /** @type {Array.<shaka.media.PresentationTimeline.TimeRange>} */
+    /** @type {Array<shaka.media.PresentationTimeline.TimeRange>} */
     let timeline = null;
     const timelineNode =
         MpdUtils.inheritChild(context, callback, 'SegmentTimeline');
@@ -322,8 +323,8 @@ shaka.dash.MpdUtils = class {
    * @param {shaka.dash.DashParser.Context} context
    * @param {function(?shaka.dash.DashParser.InheritanceFrame):
    *    ?shaka.extern.xml.Node} callback
-   * @return {!Array.<!shaka.extern.xml.Node>}
-    */
+   * @return {!Array<!shaka.extern.xml.Node>}
+   */
   static getNodes(context, callback) {
     const Functional = shaka.util.Functional;
     goog.asserts.assert(
@@ -417,9 +418,9 @@ shaka.dash.MpdUtils = class {
     // Remove the xlink properties, so it won't download again
     // when re-processed.
     for (const key of Object.keys(element.attributes)) {
-      const segs = key.split(':');
+      const segments = key.split(':');
       const namespace = shaka.util.TXml.getKnownNameSpace(NS);
-      if (segs[0] == namespace) {
+      if (segments[0] == namespace) {
         delete element.attributes[key];
       }
     }
@@ -504,7 +505,7 @@ shaka.dash.MpdUtils = class {
    * @param {boolean} failGracefully
    * @param {string} baseUri
    * @param {!shaka.net.NetworkingEngine} networkingEngine
-   * @param {number=} linkDepth, default set to 0
+   * @param {number=} linkDepth default set to 0
    * @return {!shaka.util.AbortableOperation.<!shaka.extern.xml.Node>}
    */
   static processXlinks(
@@ -569,7 +570,7 @@ shaka.dash.MpdUtils = class {
  *   startNumber: number,
  *   scaledPresentationTimeOffset: number,
  *   unscaledPresentationTimeOffset: number,
- *   timeline: Array.<shaka.media.PresentationTimeline.TimeRange>
+ *   timeline: Array<shaka.media.PresentationTimeline.TimeRange>
  * }}
  *
  * @description
@@ -587,7 +588,7 @@ shaka.dash.MpdUtils = class {
  *   The presentation time offset of the representation, in seconds.
  * @property {number} unscaledPresentationTimeOffset
  *   The presentation time offset of the representation, in timescale units.
- * @property {Array.<shaka.media.PresentationTimeline.TimeRange>} timeline
+ * @property {Array<shaka.media.PresentationTimeline.TimeRange>} timeline
  *   The timeline of the representation, if given.  Times in seconds.
  */
 shaka.dash.MpdUtils.SegmentInfo;

package/lib/dash/segment_base.js

@@ -136,11 +136,11 @@ shaka.dash.SegmentBase = class {
    * @param {shaka.dash.DashParser.Context} context
    * @param {shaka.dash.DashParser.RequestSegmentCallback} requestSegment
    * @param {shaka.media.InitSegmentReference} initSegmentReference
-   * @param {!Array.<string>} uris
+   * @param {!Array<string>} uris
    * @param {number} startByte
    * @param {?number} endByte
    * @param {number} scaledPresentationTimeOffset
-   * @return {!Promise.<shaka.media.SegmentIndex>}
+   * @return {!Promise<shaka.media.SegmentIndex>}
    */
   static async generateSegmentIndexFromUris(
       context, requestSegment, initSegmentReference, uris, startByte,
@@ -173,7 +173,7 @@ shaka.dash.SegmentBase = class {
     const results = await Promise.all(responses);
     const indexData = results[0];
     const initData = results[1] || null;
-    /** @type {Array.<!shaka.media.SegmentReference>} */
+    /** @type {Array<!shaka.media.SegmentReference>} */
     let references = null;
 
     const timestampOffset = periodStart - scaledPresentationTimeOffset;
@@ -249,7 +249,7 @@ shaka.dash.SegmentBase = class {
    * Compute the URIs of the segment index from the container.
    *
    * @param {shaka.dash.DashParser.Context} context
-   * @return {!Array.<string>}
+   * @return {!Array<string>}
    * @private
    */
   static computeIndexUris_(context) {
@@ -350,7 +350,7 @@ shaka.dash.SegmentBase = class {
    * @param {shaka.dash.DashParser.RequestSegmentCallback} requestSegment
    * @param {shaka.media.InitSegmentReference} initSegmentReference
    * @param {number} scaledPresentationTimeOffset
-   * @return {!Promise.<shaka.media.SegmentIndex>}
+   * @return {!Promise<shaka.media.SegmentIndex>}
    * @private
    */
   static generateSegmentIndex_(

package/lib/dash/segment_list.js

@@ -31,7 +31,7 @@ shaka.dash.SegmentList = class {
    * Updates the existing SegmentIndex, if any.
    *
    * @param {shaka.dash.DashParser.Context} context
-   * @param {!Object.<string, !shaka.extern.Stream>} streamMap
+   * @param {!Object<string, !shaka.extern.Stream>} streamMap
    * @param {shaka.extern.aesKey|undefined} aesKey
    * @return {shaka.dash.DashParser.StreamInfo}
    */
@@ -197,7 +197,7 @@ shaka.dash.SegmentList = class {
    * @param {number} periodStart in seconds.
    * @param {?number} periodDuration in seconds.
    * @param {number} startNumber
-   * @param {function():!Array.<string>} getBaseUris
+   * @param {function(): !Array<string>} getBaseUris
    * @param {shaka.dash.SegmentList.SegmentListInfo} info
    * @param {shaka.media.InitSegmentReference} initSegmentReference
    * @param {shaka.extern.aesKey|undefined} aesKey
@@ -205,7 +205,7 @@ shaka.dash.SegmentList = class {
    * @param {string} codecs
    * @param {number} bandwidth
    * @param {function():string} urlParams
-   * @return {!Array.<!shaka.media.SegmentReference>}
+   * @return {!Array<!shaka.media.SegmentReference>}
    * @private
    */
   static createSegmentReferences_(
@@ -227,7 +227,7 @@ shaka.dash.SegmentList = class {
     const appendWindowEnd = periodDuration ?
         periodStart + periodDuration : Infinity;
 
-    /** @type {!Array.<!shaka.media.SegmentReference>} */
+    /** @type {!Array<!shaka.media.SegmentReference>} */
     const references = [];
     let prevEndTime = info.startTime;
     for (let i = 0; i < max; i++) {
@@ -287,12 +287,12 @@ shaka.dash.SegmentList = class {
    * Parses the media URIs from the context.
    *
    * @param {shaka.dash.DashParser.Context} context
-   * @return {!Array.<shaka.dash.SegmentList.MediaSegment>}
+   * @return {!Array<shaka.dash.SegmentList.MediaSegment>}
    * @private
    */
   static parseMediaSegments_(context) {
     const Functional = shaka.util.Functional;
-    /** @type {!Array.<!shaka.extern.xml.Node>} */
+    /** @type {!Array<!shaka.extern.xml.Node>} */
     const segmentLists = [
       context.representation.segmentList,
       context.adaptationSet.segmentList,
@@ -347,8 +347,8 @@ shaka.dash.SegmentList.MediaSegment;
  *   startTime: number,
  *   startNumber: number,
  *   scaledPresentationTimeOffset: number,
- *   timeline: Array.<shaka.media.PresentationTimeline.TimeRange>,
- *   mediaSegments: !Array.<shaka.dash.SegmentList.MediaSegment>
+ *   timeline: Array<shaka.media.PresentationTimeline.TimeRange>,
+ *   mediaSegments: !Array<shaka.dash.SegmentList.MediaSegment>
  * }}
  * @private
  *
@@ -363,9 +363,9 @@ shaka.dash.SegmentList.MediaSegment;
  *   The start number of the segments; 1 or greater.
  * @property {number} scaledPresentationTimeOffset
  *   The scaledPresentationTimeOffset of the representation, in seconds.
- * @property {Array.<shaka.media.PresentationTimeline.TimeRange>} timeline
+ * @property {Array<shaka.media.PresentationTimeline.TimeRange>} timeline
  *   The timeline of the representation, if given.  Times in seconds.
- * @property {!Array.<shaka.dash.SegmentList.MediaSegment>} mediaSegments
+ * @property {!Array<shaka.dash.SegmentList.MediaSegment>} mediaSegments
  *   The URI and byte-ranges of the media segments.
  */
 shaka.dash.SegmentList.SegmentListInfo;

package/lib/dash/segment_template.js

@@ -33,11 +33,11 @@ shaka.dash.SegmentTemplate = class {
    *
    * @param {shaka.dash.DashParser.Context} context
    * @param {shaka.dash.DashParser.RequestSegmentCallback} requestSegment
-   * @param {!Object.<string, !shaka.extern.Stream>} streamMap
+   * @param {!Object<string, !shaka.extern.Stream>} streamMap
    * @param {boolean} isUpdate True if the manifest is being updated.
    * @param {number} segmentLimit The maximum number of segments to generate for
    *   a SegmentTemplate with fixed duration.
-   * @param {!Object.<string, number>} periodDurationMap
+   * @param {!Object<string, number>} periodDurationMap
    * @param {shaka.extern.aesKey|undefined} aesKey
    * @param {?number} lastSegmentNumber
    * @param {boolean} isPatchUpdate
@@ -131,24 +131,6 @@ shaka.dash.SegmentTemplate = class {
 
       shaka.log.debug(`New manifest ${periodStart} - ${periodEnd}`);
 
-      /* When to fit segments.  All refactors should honor/update this table:
-       *
-       * | dynamic | infinite | last   | should | notes                     |
-       * |         | period   | period | fit    |                           |
-       * | ------- | -------- | ------ | ------ | ------------------------- |
-       * |     F   |     F    |    X   |    T   | typical VOD               |
-       * |     F   |     T    |    X   |    X   | impossible: infinite VOD  |
-       * |     T   |     F    |    F   |    T   | typical live, old period  |
-       * |     T   |     F    |    T   |    F   | typical IPR               |
-       * |     T   |     T    |    F   |    X   | impossible: old, infinite |
-       * |     T   |     T    |    T   |    F   | typical live, new period  |
-       */
-
-      // We never fit the final period of dynamic content, which could be
-      // infinite live (with no limit to fit to) or IPR (which would expand the
-      // most recent segment to the end of the presentation).
-      const shouldFit = !(context.dynamic && context.periodInfo.isLastPeriod);
-
       if (!segmentIndex) {
         shaka.log.debug(`Creating TSI with end ${periodEnd}`);
         segmentIndex = new TimelineSegmentIndex(
@@ -160,14 +142,13 @@ shaka.dash.SegmentTemplate = class {
             periodStart,
             periodEnd,
             initSegmentReference,
-            shouldFit,
             aesKey,
             context.representation.segmentSequenceCadence,
         );
       } else {
         const tsi = /** @type {!TimelineSegmentIndex} */(segmentIndex);
         tsi.appendTemplateInfo(
-            info, periodStart, periodEnd, shouldFit, initSegmentReference);
+            info, periodStart, periodEnd, initSegmentReference);
 
         const availabilityStart =
           context.presentationTimeline.getSegmentAvailabilityStart();
@@ -177,7 +158,9 @@ shaka.dash.SegmentTemplate = class {
       if (info.timeline &&
           context.adaptationSet.contentType !== 'image' &&
           context.adaptationSet.contentType !== 'text') {
-        const timeline = info.timeline;
+        const tsi = /** @type {!TimelineSegmentIndex} */(segmentIndex);
+        // getTimeline is the info.timeline but fitted to the period.
+        const timeline = tsi.getTimeline();
         context.presentationTimeline.notifyTimeRange(
             timeline,
             periodStart);
@@ -195,7 +178,7 @@ shaka.dash.SegmentTemplate = class {
           if (segmentIndex instanceof shaka.dash.TimelineSegmentIndex &&
               segmentIndex.isEmpty()) {
             segmentIndex.appendTemplateInfo(info, periodStart,
-                periodEnd, shouldFit, initSegmentReference);
+                periodEnd, initSegmentReference);
           }
           return Promise.resolve(segmentIndex);
         },
@@ -319,7 +302,7 @@ shaka.dash.SegmentTemplate = class {
           shaka.util.Error.Code.DASH_NO_SEGMENT_INFO);
     } else if (n != 1) {
       shaka.log.warning(
-          'SegmentTemplate containes multiple segment information sources:',
+          'SegmentTemplate contains multiple segment information sources:',
           'the SegmentTemplate should only contain an index URL template,',
           'a SegmentTimeline or a segment duration.',
           context.representation);
@@ -355,7 +338,7 @@ shaka.dash.SegmentTemplate = class {
    * @param {shaka.dash.DashParser.RequestSegmentCallback} requestSegment
    * @param {shaka.media.InitSegmentReference} init
    * @param {shaka.dash.SegmentTemplate.SegmentTemplateInfo} info
-   * @return {!Promise.<shaka.media.SegmentIndex>}
+   * @return {!Promise<shaka.media.SegmentIndex>}
    * @private
    */
   static generateSegmentIndexFromIndexTemplate_(
@@ -383,11 +366,11 @@ shaka.dash.SegmentTemplate = class {
    * @param {shaka.dash.SegmentTemplate.SegmentTemplateInfo} info
    * @param {number} segmentLimit The maximum number of segments to generate.
    * @param {shaka.media.InitSegmentReference} initSegmentReference
-   * @param {!Object.<string, number>} periodDurationMap
+   * @param {!Object<string, number>} periodDurationMap
    * @param {shaka.extern.aesKey|undefined} aesKey
    * @param {?number} lastSegmentNumber
    * @param {number} segmentSequenceCadence
-   * @return {!Promise.<shaka.media.SegmentIndex>}
+   * @return {!Promise<shaka.media.SegmentIndex>}
    * @private
    */
   static generateSegmentIndexFromDuration_(
@@ -699,7 +682,7 @@ shaka.dash.SegmentTemplate = class {
     const getBaseUris = context.representation.getBaseUris;
     const urlParams = context.urlParams;
     const getUris = () => {
-      goog.asserts.assert(initialization, 'Should have returned earler');
+      goog.asserts.assert(initialization, 'Should have returned earlier');
       const filledTemplate = MpdUtils.fillUriTemplate(
           initialization, repId, null, null, bandwidth, null);
       const resolvedUris = ManifestParserUtils.resolveUris(
@@ -728,7 +711,7 @@ shaka.dash.SegmentTemplate = class {
  *
  * @extends shaka.media.SegmentIndex
  * @implements {shaka.util.IReleasable}
- * @implements {Iterable.<!shaka.media.SegmentReference>}
+ * @implements {Iterable<!shaka.media.SegmentReference>}
  *
  * @private
  *
@@ -739,45 +722,50 @@ shaka.dash.TimelineSegmentIndex = class extends shaka.media.SegmentIndex {
    * @param {!shaka.dash.SegmentTemplate.SegmentTemplateInfo} templateInfo
    * @param {?string} representationId
    * @param {number} bandwidth
-   * @param {function():Array.<string>} getBaseUris
+   * @param {function(): Array<string>} getBaseUris
    * @param {function():string} urlParams
    * @param {number} periodStart
    * @param {number} periodEnd
    * @param {shaka.media.InitSegmentReference} initSegmentReference
-   * @param {boolean} shouldFit
    * @param {shaka.extern.aesKey|undefined} aesKey
    * @param {number} segmentSequenceCadence
-  */
+   */
   constructor(templateInfo, representationId, bandwidth, getBaseUris,
-      urlParams, periodStart, periodEnd, initSegmentReference, shouldFit,
+      urlParams, periodStart, periodEnd, initSegmentReference,
       aesKey, segmentSequenceCadence) {
     super([]);
 
     /** @private {?shaka.dash.SegmentTemplate.SegmentTemplateInfo} */
     this.templateInfo_ = templateInfo;
+
     /** @private {?string} */
     this.representationId_ = representationId;
+
     /** @private {number} */
     this.bandwidth_ = bandwidth;
-    /** @private {function():Array.<string>} */
+
+    /** @private {function(): Array<string>} */
     this.getBaseUris_ = getBaseUris;
+
     /** @private {function():string} */
     this.urlParams_ = urlParams;
+
     /** @private {number} */
     this.periodStart_ = periodStart;
+
     /** @private {number} */
     this.periodEnd_ = periodEnd;
+
     /** @private {shaka.media.InitSegmentReference} */
     this.initSegmentReference_ = initSegmentReference;
+
     /** @private {shaka.extern.aesKey|undefined} */
     this.aesKey_ = aesKey;
+
     /** @private {number} */
     this.segmentSequenceCadence_ = segmentSequenceCadence;
 
-
-    if (shouldFit) {
-      this.fitTimeline();
-    }
+    this.fitTimeline();
   }
 
   /**
@@ -845,11 +833,9 @@ shaka.dash.TimelineSegmentIndex = class extends shaka.media.SegmentIndex {
    * @param {shaka.dash.SegmentTemplate.SegmentTemplateInfo} info
    * @param {number} periodStart
    * @param {number} periodEnd
-   * @param {boolean} shouldFit
    * @param {shaka.media.InitSegmentReference} initSegmentReference
    */
-  appendTemplateInfo(info, periodStart, periodEnd, shouldFit,
-      initSegmentReference) {
+  appendTemplateInfo(info, periodStart, periodEnd, initSegmentReference) {
     this.updateInitSegmentReference(initSegmentReference);
     if (!this.templateInfo_) {
       this.templateInfo_ = info;
@@ -883,9 +869,7 @@ shaka.dash.TimelineSegmentIndex = class extends shaka.media.SegmentIndex {
       }
     }
 
-    if (shouldFit) {
-      this.fitTimeline();
-    }
+    this.fitTimeline();
   }
 
   /**
@@ -930,14 +914,19 @@ shaka.dash.TimelineSegmentIndex = class extends shaka.media.SegmentIndex {
       return;
     }
     const timeline = this.templateInfo_.timeline;
-    while (timeline.length) {
-      const lastTimePeriod = timeline[timeline.length - 1];
-      if (lastTimePeriod.start >= this.periodEnd_) {
-        timeline.pop();
+    goog.asserts.assert(timeline, 'Timeline should be non-null!');
+    const newTimeline = [];
+    for (const range of timeline) {
+      if (range.start >= this.periodEnd_) {
+        // Starts after end of period.
+      } else if (range.end <= 0) {
+        // Ends before start of period.
       } else {
-        break;
+        // Usable.
+        newTimeline.push(range);
       }
     }
+    this.templateInfo_.timeline = newTimeline;
 
     this.evict(this.periodStart_);
 
@@ -947,6 +936,19 @@ shaka.dash.TimelineSegmentIndex = class extends shaka.media.SegmentIndex {
     // find/get() methods whenever possible.
   }
 
+  /**
+   * Get the current timeline
+   * @return {!Array<shaka.media.PresentationTimeline.TimeRange>}
+   */
+  getTimeline() {
+    if (!this.templateInfo_) {
+      return [];
+    }
+    const timeline = this.templateInfo_.timeline;
+    goog.asserts.assert(timeline, 'Timeline should be non-null!');
+    return timeline;
+  }
+
   /**
    * @override
    */
@@ -1146,7 +1148,7 @@ shaka.dash.TimelineSegmentIndex = class extends shaka.media.SegmentIndex {
   /**
    * Fill in a specific template with values to get the segment uris
    *
-   * @return {!Array.<string>}
+   * @return {!Array<string>}
    * @private
    */
   static createUris_(mediaTemplate, repId, segmentReplacement,
@@ -1170,7 +1172,7 @@ shaka.dash.TimelineSegmentIndex = class extends shaka.media.SegmentIndex {
  *   startNumber: number,
  *   scaledPresentationTimeOffset: number,
  *   unscaledPresentationTimeOffset: number,
- *   timeline: Array.<shaka.media.PresentationTimeline.TimeRange>,
+ *   timeline: Array<shaka.media.PresentationTimeline.TimeRange>,
  *   mediaTemplate: ?string,
  *   indexTemplate: ?string,
  *   mimeType: string,
@@ -1194,7 +1196,7 @@ shaka.dash.TimelineSegmentIndex = class extends shaka.media.SegmentIndex {
  *   The presentation time offset of the representation, in seconds.
  * @property {number} unscaledPresentationTimeOffset
  *   The presentation time offset of the representation, in timescale units.
- * @property {Array.<shaka.media.PresentationTimeline.TimeRange>} timeline
+ * @property {Array<shaka.media.PresentationTimeline.TimeRange>} timeline
  *   The timeline of the representation, if given.  Times in seconds.
  * @property {?string} mediaTemplate
  *   The media URI template, if given.

package/lib/debug/log.js

@@ -129,13 +129,13 @@ shaka.log.MAX_LOG_LEVEL = 3;
 /**
  * A Set to indicate which one-time warnings have been issued.
  *
- * @private {!Set.<string>}
+ * @private {!Set<string>}
  */
 shaka.log.oneTimeWarningIssued_ = new Set();
 
 
 if (window.console) {
-  /** @private {!Object.<shaka.log.Level, function(...*)>} */
+  /** @private {!Object<shaka.log.Level, function(...*)>} */
   shaka.log.logMap_ = {
     [shaka.log.Level.ERROR]: (...args) => console.error(...args),
     [shaka.log.Level.WARNING]: (...args) => console.warn(...args),

package/lib/dependencies/all.js

@@ -60,11 +60,12 @@ shaka.dependencies.Allowed = {
   ISOBoxer: 'ISOBoxer',
 };
 
+// eslint-disable-next-line jsdoc/require-returns
 /**
  * Contains accessor functions to shared dependencies that could be used by
  * other components.  The default accessors can be overridden.
  *
- * @private {!Map.<shaka.dependencies.Allowed, function():?>}
+ * @private {!Map<shaka.dependencies.Allowed, function(): ?>}
  */
 shaka.dependencies.dependencies_ = new Map([
   [shaka.dependencies.Allowed.ISOBoxer, () => window.ISOBoxer],