shaka-player 4.3.9 → 4.4.0

package/lib/dash/dash_parser.js

@@ -19,7 +19,6 @@ goog.require('shaka.media.PresentationTimeline');
 goog.require('shaka.media.SegmentIndex');
 goog.require('shaka.net.NetworkingEngine');
 goog.require('shaka.text.TextEngine');
-goog.require('shaka.util.CmcdManager');
 goog.require('shaka.util.Error');
 goog.require('shaka.util.Functional');
 goog.require('shaka.util.LanguageUtils');
@@ -222,15 +221,12 @@ shaka.dash.DashParser = class {
    */
   async requestManifest_() {
     const requestType = shaka.net.NetworkingEngine.RequestType.MANIFEST;
+    const type = shaka.net.NetworkingEngine.AdvancedRequestType.MPD;
     const request = shaka.net.NetworkingEngine.makeRequest(
         this.manifestUris_, this.config_.retryParameters);
     const networkingEngine = this.playerInterface_.networkingEngine;
-
-    const format = shaka.util.CmcdManager.StreamingFormat.DASH;
-    this.playerInterface_.modifyManifestRequest(request, {format: format});
-
     const startTime = Date.now();
-    const operation = networkingEngine.request(requestType, request);
+    const operation = networkingEngine.request(requestType, request, {type});
     this.operationManager_.manage(operation);
 
     const response = await operation.promise;
@@ -489,6 +485,18 @@ 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;
+    }
+
+    // Set updatePeriod_ to minTotalAvailabilityTimeOffset_ to achieve the best
+    // latency in LL streams
+    if (this.lowLatencyMode_ && this.minTotalAvailabilityTimeOffset_) {
+      this.updatePeriod_ = this.minTotalAvailabilityTimeOffset_;
+    }
+
     // These steps are not done on manifest update.
     if (!this.manifest_) {
       this.manifest_ = {
@@ -499,6 +507,9 @@ shaka.dash.DashParser = class {
         offlineSessionIds: [],
         minBufferTime: minBufferTime || 0,
         sequenceMode: this.config_.dash.sequenceMode,
+        ignoreManifestTimestampsInSegmentsMode: false,
+        type: shaka.media.ManifestParser.DASH,
+        serviceDescription: this.parseServiceDescription_(mpd),
       };
 
       // We only need to do clock sync when we're using presentation start
@@ -537,6 +548,39 @@ shaka.dash.DashParser = class {
     this.playerInterface_.makeTextStreamsForClosedCaptions(this.manifest_);
   }
 
+  /**
+   * Reads maxLatency and maxPlaybackRate properties from service
+   * description element.
+   *
+   * @param {!Element} mpd
+   * @return {?shaka.extern.ServiceDescription}
+   * @private
+   */
+  parseServiceDescription_(mpd) {
+    const XmlUtils = shaka.util.XmlUtils;
+    const elem = XmlUtils.findChild(mpd, 'ServiceDescription');
+
+    if (!elem ) {
+      return null;
+    }
+
+    const latencyNode = XmlUtils.findChild(elem, 'Latency');
+    const playbackRateNode = XmlUtils.findChild(elem, 'PlaybackRate');
+
+    if ((latencyNode && latencyNode.getAttribute('max')) || playbackRateNode) {
+      const maxLatency = latencyNode && latencyNode.getAttribute('max') ?
+        parseInt(latencyNode.getAttribute('max'), 10) / 1000 :
+        null;
+      const maxPlaybackRate = playbackRateNode ?
+        parseFloat(playbackRateNode.getAttribute('max')) :
+        null;
+
+      return {maxLatency, maxPlaybackRate};
+    }
+
+    return null;
+  }
+
   /**
    * Reads and parses the periods from the manifest.  This first does some
    * partial parsing so the start and duration is available when parsing
@@ -546,7 +590,7 @@ shaka.dash.DashParser = class {
    * @param {!Array.<string>} baseUris
    * @param {!Element} mpd
    * @return {{
-   *   periods: !Array.<shaka.util.PeriodCombiner.Period>,
+   *   periods: !Array.<shaka.extern.Period>,
    *   duration: ?number,
    *   durationDerivedFromPeriods: boolean
    * }}
@@ -698,7 +742,7 @@ shaka.dash.DashParser = class {
    * @param {shaka.dash.DashParser.Context} context
    * @param {!Array.<string>} baseUris
    * @param {shaka.dash.DashParser.PeriodInfo} periodInfo
-   * @return {shaka.util.PeriodCombiner.Period}
+   * @return {shaka.extern.Period}
    * @private
    */
   parsePeriod_(context, baseUris, periodInfo) {
@@ -950,6 +994,8 @@ shaka.dash.DashParser = class {
     const accessibilities = XmlUtils.findChildren(elem, 'Accessibility');
     const LanguageUtils = shaka.util.LanguageUtils;
     const closedCaptions = new Map();
+    /** @type {?shaka.media.ManifestParser.AccessibilityPurpose} */
+    let accessibilityPurpose;
     for (const prop of accessibilities) {
       const schemeId = prop.getAttribute('schemeIdUri');
       const value = prop.getAttribute('value');
@@ -1032,6 +1078,15 @@ shaka.dash.DashParser = class {
             kind = ManifestParserUtils.TextStreamKind.CLOSED_CAPTION;
           }
         }
+      } else if (schemeId == 'urn:tva:metadata:cs:AudioPurposeCS:2007') {
+        // See DASH DVB Document A168 Rev.6 Table 5.
+        if (value == '1') {
+          accessibilityPurpose =
+              shaka.media.ManifestParser.AccessibilityPurpose.VISUALLY_IMPAIRED;
+        } else if (value == '2') {
+          accessibilityPurpose =
+              shaka.media.ManifestParser.AccessibilityPurpose.HARD_OF_HEARING;
+        }
       }
     }
 
@@ -1053,8 +1108,8 @@ shaka.dash.DashParser = class {
         this.config_.dash.ignoreDrmInfo,
         this.config_.dash.keySystemsByURI);
 
-    const language =
-        shaka.util.LanguageUtils.normalize(elem.getAttribute('lang') || 'und');
+    const language = shaka.util.LanguageUtils.normalize(
+        context.adaptationSet.language || 'und');
 
     // This attribute is currently non-standard, but it is supported by Kaltura.
     let label = elem.getAttribute('label');
@@ -1074,7 +1129,7 @@ shaka.dash.DashParser = class {
     const streams = representations.map((representation) => {
       const parsedRepresentation = this.parseRepresentation_(context,
           contentProtection, kind, language, label, main, roleValues,
-          closedCaptions, representation);
+          closedCaptions, representation, accessibilityPurpose);
       if (parsedRepresentation) {
         parsedRepresentation.hdr = parsedRepresentation.hdr || videoRange;
       }
@@ -1150,12 +1205,15 @@ shaka.dash.DashParser = class {
    * @param {!Array.<string>} roles
    * @param {Map.<string, string>} closedCaptions
    * @param {!Element} node
+   * @param {?shaka.media.ManifestParser.AccessibilityPurpose}
+   *   accessibilityPurpose
+   *
    * @return {?shaka.extern.Stream} The Stream, or null when there is a
    *   non-critical parsing error.
    * @private
    */
   parseRepresentation_(context, contentProtection, kind, language, label,
-      isPrimary, roles, closedCaptions, node) {
+      isPrimary, roles, closedCaptions, node, accessibilityPurpose) {
     const XmlUtils = shaka.util.XmlUtils;
     const ContentType = shaka.util.ManifestParserUtils.ContentType;
 
@@ -1189,12 +1247,12 @@ shaka.dash.DashParser = class {
     const isImage = contentType == ContentType.IMAGE;
 
     try {
-      const requestInitSegment = (uris, startByte, endByte) => {
-        return this.requestInitSegment_(uris, startByte, endByte);
+      const requestSegment = (uris, startByte, endByte, isInit) => {
+        return this.requestSegment_(uris, startByte, endByte, isInit);
       };
       if (context.representation.segmentBase) {
         streamInfo = shaka.dash.SegmentBase.createStreamInfo(
-            context, requestInitSegment);
+            context, requestSegment);
       } else if (context.representation.segmentList) {
         streamInfo = shaka.dash.SegmentList.createStreamInfo(
             context, this.streamMap_);
@@ -1202,7 +1260,7 @@ shaka.dash.DashParser = class {
         const hasManifest = !!this.manifest_;
 
         streamInfo = shaka.dash.SegmentTemplate.createStreamInfo(
-            context, requestInitSegment, this.streamMap_, hasManifest,
+            context, requestSegment, this.streamMap_, hasManifest,
             this.config_.dash.initialSegmentLimit, this.periodDurations_);
       } else {
         goog.asserts.assert(isText,
@@ -1322,6 +1380,7 @@ shaka.dash.DashParser = class {
         drmInfos: contentProtection.drmInfos,
         keyIds,
         language,
+        originalLanguage: context.adaptationSet.language,
         label,
         type: context.adaptationSet.contentType,
         primary: isPrimary,
@@ -1337,6 +1396,7 @@ shaka.dash.DashParser = class {
         hdr,
         tilesLayout,
         matchedStreams: [],
+        accessibilityPurpose,
         external: false,
       };
     }
@@ -1378,6 +1438,10 @@ shaka.dash.DashParser = class {
 
       // Try updating again, but ensure we haven't been destroyed.
       if (this.playerInterface_) {
+        if (this.config_.raiseFatalErrorOnManifestUpdateRequestFailure) {
+          this.playerInterface_.onError(error);
+          return;
+        }
         // We will retry updating, so override the severity of the error.
         error.severity = shaka.util.Error.Severity.RECOVERABLE;
         this.playerInterface_.onError(error);
@@ -1410,7 +1474,6 @@ shaka.dash.DashParser = class {
     }
 
     const finalDelay = Math.max(
-        shaka.dash.DashParser.MIN_UPDATE_PERIOD_,
         this.updatePeriod_ - offset,
         this.averageUpdateDuration_.getEstimate());
 
@@ -1508,6 +1571,7 @@ shaka.dash.DashParser = class {
       pixelAspectRatio: pixelAspectRatio,
       emsgSchemeIdUris: emsgSchemeIdUris,
       id: elem.getAttribute('id'),
+      language: elem.getAttribute('lang'),
       numChannels: numChannels,
       audioSamplingRate: audioSamplingRate,
       availabilityTimeOffset: availabilityTimeOffset,
@@ -1846,11 +1910,15 @@ shaka.dash.DashParser = class {
    * @param {!Array.<string>} uris
    * @param {?number} startByte
    * @param {?number} endByte
+   * @param {boolean} isInit
    * @return {!Promise.<BufferSource>}
    * @private
    */
-  async requestInitSegment_(uris, startByte, endByte) {
+  async requestSegment_(uris, startByte, endByte, isInit) {
     const requestType = shaka.net.NetworkingEngine.RequestType.SEGMENT;
+    const type = isInit ?
+        shaka.net.NetworkingEngine.AdvancedRequestType.INIT_SEGMENT :
+        shaka.net.NetworkingEngine.AdvancedRequestType.MEDIA_SEGMENT;
 
     const request = shaka.util.Networking.createSegmentRequest(
         uris,
@@ -1859,7 +1927,7 @@ shaka.dash.DashParser = class {
         this.config_.retryParameters);
 
     const networkingEngine = this.playerInterface_.networkingEngine;
-    const operation = networkingEngine.request(requestType, request);
+    const operation = networkingEngine.request(requestType, request, {type});
     this.operationManager_.manage(operation);
     const response = await operation.promise;
     return response.data;
@@ -1890,22 +1958,13 @@ shaka.dash.DashParser = class {
 };
 
 
-/**
- * Contains the minimum amount of time, in seconds, between manifest update
- * requests.
- *
- * @private
- * @const {number}
- */
-shaka.dash.DashParser.MIN_UPDATE_PERIOD_ = 3;
-
-
 /**
  * @typedef {
- *   function(!Array.<string>, ?number, ?number):!Promise.<BufferSource>
+ *   function(!Array.<string>, ?number, ?number, boolean):
+ *     !Promise.<BufferSource>
  * }
  */
-shaka.dash.DashParser.RequestInitSegmentCallback;
+shaka.dash.DashParser.RequestSegmentCallback;
 
 
 /**
@@ -1923,6 +1982,7 @@ shaka.dash.DashParser.RequestInitSegmentCallback;
  *   pixelAspectRatio: (string|undefined),
  *   emsgSchemeIdUris: !Array.<string>,
  *   id: ?string,
+ *   language: ?string,
  *   numChannels: ?number,
  *   audioSamplingRate: ?number,
  *   availabilityTimeOffset: number
@@ -1958,6 +2018,8 @@ shaka.dash.DashParser.RequestInitSegmentCallback;
  *   emsg registered schemeIdUris.
  * @property {?string} id
  *   The ID of the element.
+ * @property {?string} language
+ *   The original language of the element.
  * @property {?number} numChannels
  *   The number of audio channels, or null if unknown.
  * @property {?number} audioSamplingRate

package/lib/dash/mpd_utils.js

@@ -15,6 +15,7 @@ goog.require('shaka.util.Functional');
 goog.require('shaka.util.ManifestParserUtils');
 goog.require('shaka.util.XmlUtils');
 goog.requireType('shaka.dash.DashParser');
+goog.requireType('shaka.media.PresentationTimeline');
 
 
 /**
@@ -121,7 +122,7 @@ shaka.dash.MpdUtils = class {
    * @param {number} unscaledPresentationTimeOffset
    * @param {number} periodDuration The Period's duration in seconds.
    *   Infinity indicates that the Period continues indefinitely.
-   * @return {!Array.<shaka.dash.MpdUtils.TimeRange>}
+   * @return {!Array.<shaka.media.PresentationTimeline.TimeRange>}
    */
   static createTimeline(
       segmentTimeline, timescale, unscaledPresentationTimeOffset,
@@ -137,7 +138,7 @@ shaka.dash.MpdUtils = class {
 
     const timePoints = XmlUtils.findChildren(segmentTimeline, 'S');
 
-    /** @type {!Array.<shaka.dash.MpdUtils.TimeRange>} */
+    /** @type {!Array.<shaka.media.PresentationTimeline.TimeRange>} */
     const timeline = [];
     let lastEndTime = -unscaledPresentationTimeOffset;
 
@@ -289,7 +290,7 @@ shaka.dash.MpdUtils = class {
 
     const timelineNode =
         MpdUtils.inheritChild(context, callback, 'SegmentTimeline');
-    /** @type {Array.<shaka.dash.MpdUtils.TimeRange>} */
+    /** @type {Array.<shaka.media.PresentationTimeline.TimeRange>} */
     let timeline = null;
     if (timelineNode) {
       timeline = MpdUtils.createTimeline(
@@ -538,26 +539,6 @@ shaka.dash.MpdUtils = class {
 };
 
 
-/**
- * @typedef {{
- *   start: number,
- *   unscaledStart: number,
- *   end: number
- * }}
- *
- * @description
- * Defines a time range of a media segment.  Times are in seconds.
- *
- * @property {number} start
- *   The start time of the range.
- * @property {number} unscaledStart
- *   The start time of the range in representation timescale units.
- * @property {number} end
- *   The end time (exclusive) of the range.
- */
-shaka.dash.MpdUtils.TimeRange;
-
-
 /**
  * @typedef {{
  *   timescale: number,
@@ -565,7 +546,7 @@ shaka.dash.MpdUtils.TimeRange;
  *   startNumber: number,
  *   scaledPresentationTimeOffset: number,
  *   unscaledPresentationTimeOffset: number,
- *   timeline: Array.<shaka.dash.MpdUtils.TimeRange>
+ *   timeline: Array.<shaka.media.PresentationTimeline.TimeRange>
  * }}
  *
  * @description
@@ -581,7 +562,7 @@ shaka.dash.MpdUtils.TimeRange;
  *   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.dash.MpdUtils.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

@@ -70,11 +70,10 @@ shaka.dash.SegmentBase = class {
    * Creates a new StreamInfo object.
    *
    * @param {shaka.dash.DashParser.Context} context
-   * @param {shaka.dash.DashParser.RequestInitSegmentCallback}
-   *     requestInitSegment
+   * @param {shaka.dash.DashParser.RequestSegmentCallback} requestSegment
    * @return {shaka.dash.DashParser.StreamInfo}
    */
-  static createStreamInfo(context, requestInitSegment) {
+  static createStreamInfo(context, requestSegment) {
     goog.asserts.assert(context.representation.segmentBase,
         'Should only be called with SegmentBase');
     // Since SegmentBase does not need updates, simply treat any call as
@@ -111,7 +110,7 @@ shaka.dash.SegmentBase = class {
     return {
       generateSegmentIndex: () => {
         return SegmentBase.generateSegmentIndex_(
-            shallowCopyOfContext, requestInitSegment, initSegmentReference,
+            shallowCopyOfContext, requestSegment, initSegmentReference,
             scaledPresentationTimeOffset);
       },
     };
@@ -121,8 +120,7 @@ shaka.dash.SegmentBase = class {
    * Creates a SegmentIndex for the given URIs and context.
    *
    * @param {shaka.dash.DashParser.Context} context
-   * @param {shaka.dash.DashParser.RequestInitSegmentCallback}
-   *     requestInitSegment
+   * @param {shaka.dash.DashParser.RequestSegmentCallback} requestSegment
    * @param {shaka.media.InitSegmentReference} initSegmentReference
    * @param {!Array.<string>} uris
    * @param {number} startByte
@@ -131,7 +129,7 @@ shaka.dash.SegmentBase = class {
    * @return {!Promise.<shaka.media.SegmentIndex>}
    */
   static async generateSegmentIndexFromUris(
-      context, requestInitSegment, initSegmentReference, uris, startByte,
+      context, requestSegment, initSegmentReference, uris, startByte,
       endByte, scaledPresentationTimeOffset) {
     // Unpack context right away, before we start an async process.
     // This immunizes us against changes to the context object later.
@@ -143,16 +141,17 @@ shaka.dash.SegmentBase = class {
     const containerType = context.representation.mimeType.split('/')[1];
 
     // Create a local variable to bind to so we can set to null to help the GC.
-    let localRequest = requestInitSegment;
+    let localRequest = requestSegment;
     let segmentIndex = null;
 
     const responses = [
-      localRequest(uris, startByte, endByte),
+      localRequest(uris, startByte, endByte, /* isInit= */ false),
       containerType == 'webm' ?
           localRequest(
               initSegmentReference.getUris(),
               initSegmentReference.startByte,
-              initSegmentReference.endByte) :
+              initSegmentReference.endByte,
+              /* isInit= */ true) :
           null,
     ];
 
@@ -327,15 +326,14 @@ shaka.dash.SegmentBase = class {
    * Generate a SegmentIndex from a Context object.
    *
    * @param {shaka.dash.DashParser.Context} context
-   * @param {shaka.dash.DashParser.RequestInitSegmentCallback}
-   *     requestInitSegment
+   * @param {shaka.dash.DashParser.RequestSegmentCallback} requestSegment
    * @param {shaka.media.InitSegmentReference} initSegmentReference
    * @param {number} scaledPresentationTimeOffset
    * @return {!Promise.<shaka.media.SegmentIndex>}
    * @private
    */
   static generateSegmentIndex_(
-      context, requestInitSegment, initSegmentReference,
+      context, requestSegment, initSegmentReference,
       scaledPresentationTimeOffset) {
     const SegmentBase = shaka.dash.SegmentBase;
 
@@ -344,7 +342,7 @@ shaka.dash.SegmentBase = class {
     goog.asserts.assert(indexRange, 'Index range should not be null!');
 
     return shaka.dash.SegmentBase.generateSegmentIndexFromUris(
-        context, requestInitSegment, initSegmentReference, indexUris,
+        context, requestSegment, initSegmentReference, indexUris,
         indexRange.start, indexRange.end,
         scaledPresentationTimeOffset);
   }

package/lib/dash/segment_list.js

@@ -18,6 +18,7 @@ goog.require('shaka.util.Functional');
 goog.require('shaka.util.ManifestParserUtils');
 goog.require('shaka.util.XmlUtils');
 goog.requireType('shaka.dash.DashParser');
+goog.requireType('shaka.media.PresentationTimeline');
 
 
 /**
@@ -223,9 +224,6 @@ shaka.dash.SegmentList = class {
     let prevEndTime = info.startTime;
     for (let i = 0; i < max; i++) {
       const segment = info.mediaSegments[i];
-      const mediaUri = ManifestParserUtils.resolveUris(
-          baseUris, [segment.mediaUri]);
-
       const startTime = prevEndTime;
       let endTime;
 
@@ -243,7 +241,13 @@ shaka.dash.SegmentList = class {
         endTime = startTime + periodDuration;
       }
 
-      const getUris = () => mediaUri;
+      let uris = null;
+      const getUris = () => {
+        if (uris == null) {
+          uris = ManifestParserUtils.resolveUris(baseUris, [segment.mediaUri]);
+        }
+        return uris;
+      };
       references.push(
           new shaka.media.SegmentReference(
               periodStart + startTime,
@@ -323,7 +327,7 @@ shaka.dash.SegmentList.MediaSegment;
  *   startTime: number,
  *   startNumber: number,
  *   scaledPresentationTimeOffset: number,
- *   timeline: Array.<shaka.dash.MpdUtils.TimeRange>,
+ *   timeline: Array.<shaka.media.PresentationTimeline.TimeRange>,
  *   mediaSegments: !Array.<shaka.dash.SegmentList.MediaSegment>
  * }}
  * @private
@@ -339,7 +343,7 @@ 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.dash.MpdUtils.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
  *   The URI and byte-ranges of the media segments.