rx-player 4.0.0-beta.2 → 4.0.0-beta.3

package/src/manifest/representation.ts

@@ -90,6 +90,19 @@ class Representation {
    */
   public frameRate? : number;
 
+  /**
+   * `true` if this `Representation` is linked to a spatial audio technology.
+   * For example, it may be set to `true` if the Representation relies on the
+   * "Dolby Atmos". technology.
+   *
+   * `false` if it is known that this `Representation` does not contain any
+   * spatial audio.
+   *
+   * `undefined` if we do not know whether this `Representation` contains
+   * spatial audio or not.
+   */
+  public isSpatialAudio? : boolean | undefined;
+
   /**
    * A string describing the codec used for this Representation.
    * undefined if we do not know.
@@ -146,6 +159,10 @@ class Representation {
     this.bitrate = args.bitrate;
     this.codec = args.codecs;
 
+    if (args.isSpatialAudio !== undefined) {
+      this.isSpatialAudio = args.isSpatialAudio;
+    }
+
     if (args.height !== undefined) {
       this.height = args.height;
     }
@@ -368,12 +385,13 @@ class Representation {
    * @returns {Object}
    */
   public toAudioRepresentation(): IAudioRepresentation {
-    const { id, bitrate, codec, isSupported, decipherable } = this;
+    const { id, bitrate, codec, isSpatialAudio, isSupported, decipherable } = this;
     return { id,
              bitrate,
              codec,
+             isSpatialAudio,
              isCodecSupported: isSupported,
-             seemsDecipherable: decipherable };
+             decipherable };
   }
 
   /**
@@ -398,7 +416,7 @@ class Representation {
              codec,
              hdrInfo,
              isCodecSupported: isSupported,
-             seemsDecipherable: decipherable };
+             decipherable };
   }
 
   /**

package/src/minimal.ts

@@ -21,28 +21,14 @@
  * import only features that is needed.
  */
 
+import isDebugModeEnabled from "./compat/is_debug_mode_enabled";
 import Player from "./core/api";
-import {
-  addFeatures,
-  IFeature,
-} from "./features";
 import logger from "./log";
 
-if (typeof __RX_PLAYER_DEBUG_MODE__ === "boolean" && __RX_PLAYER_DEBUG_MODE__) {
+if (isDebugModeEnabled()) {
   logger.setLevel("DEBUG");
-} else if (__ENVIRONMENT__.CURRENT_ENV === __ENVIRONMENT__.DEV as number) {
+} else if (__ENVIRONMENT__.CURRENT_ENV as number === __ENVIRONMENT__.DEV as number) {
   logger.setLevel(__LOGGER_LEVEL__.CURRENT_LEVEL);
 }
 
-/**
- * Minimal Player for which you can features at will:
- *   - start with no features
- *   - Allow to only load features wanted
- *
- * @class MinimalPlayer
- */
-export default class MinimalPlayer extends Player {
-  static addFeatures(featureList : IFeature[]) : void {
-    addFeatures(featureList);
-  }
-}
+export default Player;

package/src/parsers/manifest/dash/common/__tests__/get_clock_offset.test.ts

@@ -26,7 +26,8 @@ describe("DASH Parser - getClockOffset", () => {
     jest.resetModules();
   });
 
-  it("should calculate a millisecond offset relatively to performance.now", () => {
+  /* eslint-disable-next-line max-len */
+  it("should calculate a millisecond offset relatively to the monotonically-raising timestamp", () => {
     const mockWarn = jest.fn();
     jest.mock("../../../../../log", () => ({
       __esModule: true,

package/src/parsers/manifest/dash/common/get_clock_offset.ts

@@ -15,16 +15,17 @@
  */
 
 import log from "../../../../log";
+import getMonotonicTimeStamp from "../../../../utils/monotonic_timestamp";
 
 /**
- * Get difference between the server's clock, in milliseconds and the return of
- * the JS function `performance.now`.
+ * Get difference between the server's clock, in milliseconds, and the
+ * monotonically-raising timestamp used by the RxPlayer.
  * This property allows to calculate the server time at any moment.
  *
  * `undefined` if we could not define such offset (in which case, you could have
  * to rely on the user's clock instead).
  *
- * For example, a response of 1000 would mean that performance.now() is 1 second
+ * For example, a response of 1000 would mean that the timestamp is 1 second
  * behind the server's time.
  * @param {string} serverClock
  * @returns {number|undefined}
@@ -32,7 +33,7 @@ import log from "../../../../log";
 export default function getClockOffset(
   serverClock: string
 ): number | undefined {
-  const httpOffset = Date.parse(serverClock) - performance.now();
+  const httpOffset = Date.parse(serverClock) - getMonotonicTimeStamp();
   if (isNaN(httpOffset)) {
     log.warn("DASH Parser: Invalid clock received: ", serverClock);
     return undefined;

package/src/parsers/manifest/dash/common/indexes/timeline/timeline_representation_index.ts

@@ -24,6 +24,7 @@ import {
 } from "../../../../../../manifest";
 import { IPlayerError } from "../../../../../../public_types";
 import assert from "../../../../../../utils/assert";
+import getMonotonicTimeStamp from "../../../../../../utils/monotonic_timestamp";
 import { IEMSG } from "../../../../../containers/isobmff";
 import clearTimelineFromPosition from "../../../../utils/clear_timeline_from_position";
 import {
@@ -162,8 +163,7 @@ export interface ITimelineIndexContextArgument {
   /** Whether the corresponding Manifest can be updated and changed. */
   isDynamic : boolean;
   /**
-   * Time (in terms of `performance.now`) at which the XML file containing this
-   * index was received
+   * Time at which the XML file containing this index was received.
    */
   receivedTime? : number | undefined;
   /** ID of the Representation concerned. */
@@ -200,7 +200,10 @@ export default class TimelineRepresentationIndex implements IRepresentationIndex
   /** Underlying structure to retrieve segment information. */
   protected _index : ITimelineIndex;
 
-  /** Time, in terms of `performance.now`, of the last Manifest update. */
+  /**
+   * Time of the last Manifest update.
+   * The unit is the monotonically-raising timestamp used by the RxPlayer.
+   */
   private _lastUpdate : number;
 
   /** Absolute start of the period, timescaled and converted to index time. */
@@ -272,7 +275,7 @@ export default class TimelineRepresentationIndex implements IRepresentationIndex
     this._isEMSGWhitelisted = isEMSGWhitelisted;
     this._isLastPeriod = isLastPeriod;
     this._lastUpdate = context.receivedTime == null ?
-                                 performance.now() :
+                                 getMonotonicTimeStamp() :
                                  context.receivedTime;
 
     this._unsafelyBaseOnPreviousIndex = null;

package/src/parsers/manifest/dash/common/manifest_bounds_calculator.ts

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+import getMonotonicTimeStamp from "../../../../utils/monotonic_timestamp";
+
 /**
  * This class allows to easily calculate the first and last available positions
  * in a content at any time.
@@ -37,7 +39,10 @@
 export default class ManifestBoundsCalculator {
   /** Value of MPD@timeShiftBufferDepth. */
   private _timeShiftBufferDepth : number | null;
-  /** Value of `performance.now` at the time `lastPosition` was calculated. */
+  /**
+   * Monotonically-raising timestamp (the one used by the RxPlayer) when
+   * `lastPosition` was calculated.
+   */
   private _positionTime : number | undefined;
   /** Last position calculated at a given moment (itself indicated by `_positionTime`. */
   private _lastPosition : number | undefined;
@@ -58,14 +63,15 @@ export default class ManifestBoundsCalculator {
   }
 
   /**
-   * Set the last position and the position time (the value of `performance.now()`
-   * at the time that position was true converted into seconds).
+   * Set the last position and the position time (the value of the RxPlayer's
+   * monotonically-raising timestamp at the time that position was true
+   * converted into seconds).
    *
    * @example
    * Example if you trust `Date.now()` to give you a reliable offset:
    * ```js
    * const lastPosition = Date.now();
-   * const positionTime = performance.now() / 1000;
+   * const positionTime = getMonotonicTimeStamp() / 1000;
    * manifestBoundsCalculator.setLastPosition(lastPosition, positionTime);
    * ```
    *
@@ -119,7 +125,7 @@ export default class ManifestBoundsCalculator {
         this._lastPosition != null)
     {
       return Math.max((this._lastPosition - this._positionTime) +
-                        (performance.now() / 1000),
+                        (getMonotonicTimeStamp() / 1000),
                       0);
     }
     return this._lastPosition;

package/src/parsers/manifest/dash/common/parse_adaptation_sets.ts

@@ -465,6 +465,7 @@ export default function parseAdaptationSets(
                                 mergedInto[1].isMainAdaptation,
               indexInMpd: Math.min(adaptationIdx, mergedInto[1].indexInMpd),
             };
+            break;
           }
         }
       }

package/src/parsers/manifest/dash/common/parse_mpd.ts

@@ -18,6 +18,7 @@ import config from "../../../../config";
 import log from "../../../../log";
 import Manifest from "../../../../manifest";
 import arrayFind from "../../../../utils/array_find";
+import getMonotonicTimeStamp from "../../../../utils/monotonic_timestamp";
 import { getFilenameIndexInUrl } from "../../../../utils/resolve_url";
 import { IParsedManifest } from "../../types";
 import {
@@ -41,11 +42,14 @@ import resolveBaseURLs, {
 /** Possible options for `parseMPD`.  */
 export interface IMPDParserArguments {
   /**
-   * If set, offset to add to `performance.now()` to obtain the current server's
-   * time.
+   * If set, offset to add to the monotonically-raising timestamp used by the
+   * RxPlayer to obtain the current server's time.
    */
   externalClockOffset? : number | undefined;
-  /** Time, in terms of `performance.now` at which this MPD was received. */
+  /**
+   * Time at which this MPD was received.
+   * The unit is the monotonically-raising timestamp used by the RxPlayer.
+   */
   manifestReceivedTime? : number | undefined;
   /** Default base time, in seconds. */
   referenceDateTime? : number | undefined;
@@ -281,7 +285,7 @@ function parseCompleteIntermediateRepresentation(
   const { minimumSafePosition,
           maximumSafePosition,
           maximumUnsafePosition } = getMinimumAndMaximumPositions(parsedPeriods);
-  const now = performance.now();
+  const now = getMonotonicTimeStamp();
 
   if (!isDynamic) {
     minimumTime = minimumSafePosition !== undefined     ? minimumSafePosition :
@@ -327,7 +331,7 @@ function parseCompleteIntermediateRepresentation(
         log.warn("DASH Parser: use system clock to define maximum position");
         finalMaximumSafePosition = (Date.now() / 1000) - ast;
       } else {
-        const serverTime = performance.now() + externalClockOffset;
+        const serverTime = getMonotonicTimeStamp() + externalClockOffset;
         finalMaximumSafePosition = (serverTime / 1000) - ast;
       }
     }

package/src/parsers/manifest/dash/common/parse_periods.ts

@@ -18,6 +18,7 @@ import log from "../../../../log";
 import Manifest from "../../../../manifest";
 import flatMap from "../../../../utils/flat_map";
 import idGenerator from "../../../../utils/id_generator";
+import getMonotonicTimeStamp from "../../../../utils/monotonic_timestamp";
 import objectValues from "../../../../utils/object_values";
 import { utf8ToStr } from "../../../../utils/string_parsing";
 import {
@@ -148,7 +149,7 @@ export default function parsePeriods(
         }
       } else {
         if (typeof lastPosition === "number") {
-          const positionTime = performance.now() / 1000;
+          const positionTime = getMonotonicTimeStamp() / 1000;
           manifestBoundsCalculator.setLastPosition(lastPosition, positionTime);
         } else {
           const guessedLastPositionFromClock =
@@ -177,12 +178,13 @@ export default function parsePeriods(
 
 /**
  * Try to guess the "last position", which is the last position
- * available in the manifest in seconds, and the "position time", the time
- * (`performance.now()`) in which the last position was collected.
+ * available in the manifest in seconds, and the "position time", the
+ * monotonically-raising timestamp used by the RxPlayer, at which the
+ * last position was collected.
  *
  * These values allows to retrieve at any time in the future the new last
  * position, by substracting the position time to the last position, and
- * adding to it the new value returned by `performance.now`.
+ * adding to it the new monotonically-raising timestamp.
  *
  * The last position and position time are returned by this function if and only if
  * it would indicate a last position superior to the `minimumTime` given.
@@ -209,7 +211,7 @@ function guessLastPositionFromClock(
   if (context.clockOffset != null) {
     const lastPosition = context.clockOffset / 1000 -
       context.availabilityStartTime;
-    const positionTime = performance.now() / 1000;
+    const positionTime = getMonotonicTimeStamp() / 1000;
     const timeInSec = positionTime + lastPosition;
     if (timeInSec >= minimumTime) {
       return [timeInSec, positionTime];
@@ -220,7 +222,7 @@ function guessLastPositionFromClock(
       log.warn("DASH Parser: no clock synchronization mechanism found." +
                " Using the system clock instead.");
       const lastPosition = now - context.availabilityStartTime;
-      const positionTime = performance.now() / 1000;
+      const positionTime = getMonotonicTimeStamp() / 1000;
       return [lastPosition, positionTime];
     }
   }
@@ -335,6 +337,10 @@ function generateStreamEvents(
 /** Context needed when calling `parsePeriods`. */
 export interface IPeriodContext extends IInheritedAdaptationContext {
   availabilityStartTime : number;
+  /**
+   * Difference between the server's clock, in milliseconds, and the
+   * monotonically-raising timestamp used by the RxPlayer.
+   */
   clockOffset? : number | undefined;
   /** Duration (mediaPresentationDuration) of the whole MPD, in seconds. */
   duration? : number | undefined;

package/src/parsers/manifest/dash/common/parse_representation_index.ts

@@ -157,8 +157,8 @@ export interface IRepresentationIndexContext {
    */
   parentSegmentTemplates : ISegmentTemplateIntermediateRepresentation[];
   /**
-   * Time (in terms of `performance.now`) at which the XML file containing this
-   * Representation was received.
+   * Time (as the monotonically-raising timestamp used by the RxPlayer) at which
+   * the XML file containing this Representation was received.
    */
   receivedTime? : number | undefined;
   /** Start time of the current period, in seconds. */

package/src/parsers/manifest/dash/common/parse_representations.ts

@@ -192,6 +192,16 @@ export default function parseRepresentations(
         index: representationIndex,
         id: representationID };
 
+    if (
+      representation.children.supplementalProperties !== undefined &&
+      arrayFind(representation.children.supplementalProperties, r =>
+        r.schemeIdUri === "tag:dolby.com,2018:dash:EC3_ExtensionType:2018" &&
+        r.value === "JOC"
+      )
+    ) {
+      parsedRepresentation.isSpatialAudio = true;
+    }
+
     // Add optional attributes
     let codecs : string|undefined;
     if (representation.attributes.codecs != null) {

package/src/parsers/manifest/dash/js-parser/node_parsers/Representation.ts

@@ -94,6 +94,13 @@ function parseRepresentationChildren(
             contentProtections.push(contentProtection);
           }
           break;
+        case "SupplementalProperty":
+          if (children.supplementalProperties == null) {
+            children.supplementalProperties = [parseScheme(currentElement)];
+          } else {
+            children.supplementalProperties.push(parseScheme(currentElement));
+          }
+          break;
       }
     }
   }

package/src/parsers/manifest/dash/node_parser_types.ts

@@ -253,6 +253,7 @@ export interface IRepresentationChildren {
   segmentBase? : ISegmentBaseIntermediateRepresentation;
   segmentList? : ISegmentListIntermediateRepresentation;
   segmentTemplate? : ISegmentTemplateIntermediateRepresentation;
+  supplementalProperties? : IScheme[] | undefined;
 }
 
 /* Intermediate representation for A Representation node's attributes. */

package/src/parsers/manifest/dash/parsers_types.ts

@@ -73,14 +73,14 @@ export interface ILoadedResource<T extends string | ArrayBuffer> {
    */
   url? : string | undefined;
   /**
-   * The time, in terms of `performance.now()`, at which the resource was
-   * starting to be fetched.
+   * The time at which the resource was starting to be fetched, in the unit of
+   * the monotonically-raising timestamp used by the RxPlayer.
    * `undefined` if unknown or not applicable.
    */
   sendingTime? : number | undefined;
   /**
-   * The time, in terms of `performance.now()`, at which the resource was
-   * fully-fetched.
+   * The time at which the resource was completely fetched, in the unit of
+   * the monotonically-raising timestamp used by the RxPlayer.
    * `undefined` if unknown or not applicable.
    */
   receivedTime? : number | undefined;

package/src/parsers/manifest/dash/wasm-parser/Cargo.lock

@@ -17,9 +17,9 @@ dependencies = [
 
 [[package]]
 name = "quick-xml"
-version = "0.22.0"
+version = "0.30.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8533f14c8382aaad0d592c812ac3b826162128b65662331e1127b45c3d18536b"
+checksum = "eff6510e86862b57b210fd8cbe8ed3f0d7d600b9c2863cd4549a2e033c66e956"
 dependencies = [
  "memchr",
 ]

package/src/parsers/manifest/dash/wasm-parser/Cargo.toml

@@ -13,4 +13,4 @@ lto = true
 opt-level = 3
 
 [dependencies]
-quick-xml = "0.22.0"
+quick-xml = "0.30.0"

package/src/parsers/manifest/dash/wasm-parser/rs/errors.rs

@@ -1,5 +1,5 @@
-use crate::onCustomEvent;
 use crate::events::CustomEventType;
+use crate::onCustomEvent;
 
 pub type Result<T> = std::result::Result<T, ParsingError>;
 
@@ -21,8 +21,8 @@ impl ParsingError {
     }
 }
 
-impl<T : std::error::Error> From<T> for ParsingError {
-    fn from(err : T) -> ParsingError {
+impl<T: std::error::Error> From<T> for ParsingError {
+    fn from(err: T) -> ParsingError {
         ParsingError(err.to_string())
     }
 }