rx-player 3.26.1 → 3.26.2

package/src/core/abr/representation_score_calculator.ts

@@ -16,7 +16,7 @@
 
 import log from "../../log";
 import { Representation } from "../../manifest";
-import EWMA from "./ewma";
+import EWMA from "./utils/ewma";
 
 /**
  * Calculate the "maintainability score" of a given Representation:
@@ -49,7 +49,9 @@ import EWMA from "./ewma";
  */
 export default class RepresentationScoreCalculator {
   private _currentRepresentationData : { representation : Representation;
-                                         ewma : EWMA; } |
+                                         ewma : EWMA;
+                                         loadedSegments : number;
+                                         loadedDuration : number; } |
                                        null;
 
   private _lastRepresentationWithGoodScore : Representation | null;
@@ -73,21 +75,26 @@ export default class RepresentationScoreCalculator {
     segmentDuration : number
   ) : void {
     const ratio = segmentDuration / requestDuration;
-    const oldEwma = this._getEWMA(representation);
+    const currentRep = this._currentRepresentationData;
     let currentEWMA : EWMA;
-    if (oldEwma != null) {
-      currentEWMA = oldEwma;
-      oldEwma.addSample(requestDuration, ratio);
+    if (currentRep !== null && currentRep.representation.id === representation.id) {
+      currentEWMA = currentRep.ewma;
+      currentRep.ewma.addSample(requestDuration, ratio);
+      currentRep.loadedDuration += segmentDuration;
+      currentRep.loadedSegments++;
     } else {
       currentEWMA = new EWMA(5);
       currentEWMA.addSample(requestDuration, ratio);
-      this._currentRepresentationData = { representation, ewma: currentEWMA };
+      this._currentRepresentationData = { representation,
+                                          ewma: currentEWMA,
+                                          loadedDuration: segmentDuration,
+                                          loadedSegments: 0 };
     }
 
     if (currentEWMA.getEstimate() > 1 &&
         this._lastRepresentationWithGoodScore !== representation
     ) {
-      log.debug("ABR: New last stable representation", representation);
+      log.debug("ABR: New last stable representation", representation.bitrate);
       this._lastRepresentationWithGoodScore = representation;
     }
   }
@@ -98,11 +105,21 @@ export default class RepresentationScoreCalculator {
    * @param {Representation} representation
    * @returns {number|undefined}
    */
-  public getEstimate(representation : Representation) : number | undefined {
-    const ewma = this._getEWMA(representation);
-    if (ewma != null) {
-      return ewma.getEstimate();
+  public getEstimate(
+    representation : Representation
+  ) : [number, ScoreConfidenceLevel] | undefined {
+    if (this._currentRepresentationData === null ||
+        this._currentRepresentationData.representation.id !== representation.id)
+    {
+      return undefined;
     }
+    const { ewma, loadedSegments, loadedDuration } = this._currentRepresentationData;
+    const estimate = ewma.getEstimate();
+    const confidenceLevel = loadedSegments >= 5 &&
+                            loadedDuration >= 10 ? ScoreConfidenceLevel.HIGH :
+                                                   ScoreConfidenceLevel.LOW;
+
+    return [estimate, confidenceLevel];
   }
 
   /**
@@ -116,19 +133,9 @@ export default class RepresentationScoreCalculator {
   public getLastStableRepresentation() : Representation | null {
     return this._lastRepresentationWithGoodScore;
   }
+}
 
-  /**
-   * Returns EWMA for the given Representation.
-   * null if no EWMA is currently stored for it.
-   * @param {Representation} representation
-   * @returns {EWMA|null}
-   */
-  private _getEWMA(representation : Representation) : EWMA | null {
-    if (this._currentRepresentationData != null &&
-        this._currentRepresentationData.representation.id === representation.id)
-    {
-      return this._currentRepresentationData.ewma;
-    }
-    return null;
-  }
+export const enum ScoreConfidenceLevel {
+  HIGH = 1,
+  LOW = 0,
 }

package/src/core/abr/{__tests__ → utils/__tests__}/filter_by_bitrate.test.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { Representation } from "../../../manifest";
+import { Representation } from "../../../../manifest";
 import filterByBitrate from "../filter_by_bitrate";
 
 describe("ABR - filterByBitrate", () => {

package/src/core/abr/{__tests__ → utils/__tests__}/filter_by_width.test.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { Representation } from "../../../manifest";
+import { Representation } from "../../../../manifest";
 import filterByWidth from "../filter_by_width";
 
 describe("ABR - filterByWidth", () => {

package/src/core/abr/{__tests__ → utils/__tests__}/select_optimal_representation.test.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { Representation } from "../../../manifest";
+import { Representation } from "../../../../manifest";
 import selectOptimalRepresentation from "../select_optimal_representation";
 
 describe("ABR - selectOptimalRepresentation", () => {

package/src/core/abr/{filter_by_bitrate.ts → utils/filter_by_bitrate.ts}

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import { Representation } from "../../manifest";
-import arrayFindIndex from "../../utils/array_find_index";
+import { Representation } from "../../../manifest";
+import arrayFindIndex from "../../../utils/array_find_index";
 
 /**
  * Get only representations lower or equal to a given bitrate.

package/src/core/abr/{filter_by_width.ts → utils/filter_by_width.ts}

@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-import { Representation } from "../../manifest";
-import arrayFind from "../../utils/array_find";
-import takeFirstSet from "../../utils/take_first_set";
+import { Representation } from "../../../manifest";
+import arrayFind from "../../../utils/array_find";
+import takeFirstSet from "../../../utils/take_first_set";
 
 /**
  * Filter representations based on their width:

package/src/core/abr/{select_optimal_representation.ts → utils/select_optimal_representation.ts}

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import { Representation } from "../../manifest";
-import arrayFindIndex from "../../utils/array_find_index";
+import { Representation } from "../../../manifest";
+import arrayFindIndex from "../../../utils/array_find_index";
 
 /**
  * From the given array of Representations (sorted by bitrate order ascending),

package/src/core/api/README.md

@@ -46,10 +46,11 @@ this event to then communicate it back to the user.
 
 To facilitate those actions, the API relies on multiple building blocks:
 
-  - __the `Clock` (./clock.ts)__
+  - __the `PlaybackObserver` (./playback_observer.ts)__
 
-    Provide an Observable emitting regularly the current playback conditions for
-    the Player. Many RxPlayer modules rely on that clock.
+    Provide multiple methods allowing to monitor the current playback conditions
+    (e.g. the current position and/or the current playback rate).
+    Many RxPlayer modules rely on this PlaybackObserver.
 
 
   - __the `TrackChoiceManager` (./track_choice_manager.ts)__

package/src/core/api/__tests__/option_utils.test.ts

@@ -20,6 +20,7 @@
 /* eslint-disable @typescript-eslint/no-unsafe-call */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-return */
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 import config from "../../../config";

package/src/core/api/emit_seek_events.ts

@@ -17,49 +17,50 @@
 import {
   defer as observableDefer,
   EMPTY,
+  filter,
+  map,
   merge as observableMerge,
   Observable,
-} from "rxjs";
-import {
-  filter,
-  mapTo,
   startWith,
-  switchMapTo,
+  switchMap,
   take,
-} from "rxjs/operators";
-import { IClockTick } from "./clock";
+} from "rxjs";
+import { IPlaybackObservation } from "./playback_observer";
 
 /**
  * Returns Observable which will emit:
  *   - `"seeking"` when we are seeking in the given mediaElement
- *   - `"seeked"` when a seek is considered as finished by the given clock$
+ *   - `"seeked"` when a seek is considered as finished by the given observation$
  *     Observable.
  * @param {HTMLMediaElement} mediaElement
- * @param {Observable} clock$
+ * @param {Observable} observation$
  * @returns {Observable}
  */
 export default function emitSeekEvents(
   mediaElement : HTMLMediaElement | null,
-  clock$ : Observable<IClockTick>
+  observation$ : Observable<IPlaybackObservation>
 ) : Observable<"seeking" | "seeked"> {
   return observableDefer(() => {
     if (mediaElement === null) {
       return EMPTY;
     }
 
-    const isSeeking$ = clock$.pipe(
-      filter((tick : IClockTick) => tick.event === "seeking"),
-      mapTo("seeking" as const)
+    let isSeeking$ = observation$.pipe(
+      filter((observation : IPlaybackObservation) => observation.event === "seeking"),
+      map(() => "seeking" as const)
     );
+
+    if (mediaElement.seeking) {
+      isSeeking$ = isSeeking$.pipe(startWith("seeking" as const));
+    }
+
     const hasSeeked$ = isSeeking$.pipe(
-      switchMapTo(
-        clock$.pipe(
-          filter((tick : IClockTick) => tick.event === "seeked"),
-          mapTo("seeked" as const),
+      switchMap(() =>
+        observation$.pipe(
+          filter((observation : IPlaybackObservation) => observation.event === "seeked"),
+          map(() => "seeked" as const),
           take(1)))
     );
-    const seekingEvents$ = observableMerge(isSeeking$, hasSeeked$);
-    return mediaElement.seeking ? seekingEvents$.pipe(startWith("seeking" as const)) :
-                                  seekingEvents$;
+    return observableMerge(isSeeking$, hasSeeked$);
   });
 }

package/src/core/api/index.ts

@@ -14,16 +14,20 @@
  * limitations under the License.
  */
 
+import PlaybackObserver from "./playback_observer";
 import Player from "./public_api";
 export {
   IStreamEvent,
   IStreamEventData,
 } from "./public_api";
+export { PlaybackObserver };
 export {
-  IClockMediaEventType,
+  IPlaybackObservation,
+  IPlaybackObserverEventType,
+  IReadOnlyPlaybackObserver,
   IFreezingStatus,
   IRebufferingStatus,
-} from "./clock";
+} from "./playback_observer";
 export {
   IConstructorOptions,
   ILoadVideoOptions,