Bandwidth calculator. (#323)

* Rename file. * Add bandwidth calculator. * Add bandwidth calculator. * Git use another approach. Suppress loading intervals together. * Use time shift instead of loading intervals. --------- Co-authored-by: Igor Zolotarenko <[email protected]>
Novage · Jan 2, 2024 · 39ec83d · 39ec83d
1 parent 0508d9f
commit 39ec83d
Show file tree

Hide file tree

Showing 8 changed files with 91 additions and 104 deletions.
diff --git a/packages/p2p-media-loader-core/src/bandwidth-approximator.ts b/packages/p2p-media-loader-core/src/bandwidth-approximator.ts
diff --git a/packages/p2p-media-loader-core/src/bandwidth-calculator.ts b/packages/p2p-media-loader-core/src/bandwidth-calculator.ts
@@ -0,0 +1,63 @@
+const CLEAR_THRESHOLD_MS = 3000;
+
+export class BandwidthCalculator {
+  private simultaneousLoadingsCount = 0;
+  private readonly bytes: number[] = [];
+  private readonly timestamps: number[] = [];
+  private noLoadingsTotalTime = 0;
+  private allLoadingsStoppedTimestamp = 0;
+
+  addBytes(bytesLength: number, now = performance.now()) {
+    this.bytes.push(bytesLength);
+    this.timestamps.push(now - this.noLoadingsTotalTime);
+  }
+
+  startLoading(now = performance.now()) {
+    this.clearStale();
+    if (this.simultaneousLoadingsCount === 0) {
+      this.noLoadingsTotalTime += now - this.allLoadingsStoppedTimestamp;
+    }
+    this.simultaneousLoadingsCount++;
+  }
+
+  // in bits per second
+  stopLoading(now = performance.now()) {
+    if (this.simultaneousLoadingsCount <= 0) return;
+    this.simultaneousLoadingsCount--;
+    if (this.simultaneousLoadingsCount !== 0) return;
+    this.allLoadingsStoppedTimestamp = now;
+  }
+
+  getBandwidthForLastNSeconds(seconds: number) {
+    if (!this.timestamps.length) return 0;
+    const milliseconds = seconds * 1000;
+    const lastItemTimestamp = this.timestamps[this.timestamps.length - 1];
+    let lastCountedTimestamp = lastItemTimestamp;
+    const threshold = lastItemTimestamp - milliseconds;
+    let totalBytes = 0;
+
+    for (let i = this.bytes.length - 1; i >= 0; i--) {
+      const timestamp = this.timestamps[i];
+      if (timestamp < threshold) break;
+      lastCountedTimestamp = timestamp;
+      totalBytes += this.bytes[i];
+    }
+
+    return (totalBytes * 8000) / (lastItemTimestamp - lastCountedTimestamp);
+  }
+
+  clearStale() {
+    if (!this.timestamps.length) return;
+    const threshold =
+      this.timestamps[this.timestamps.length - 1] - CLEAR_THRESHOLD_MS;
+
+    let samplesToRemove = 0;
+    for (const timestamp of this.timestamps) {
+      if (timestamp > threshold) break;
+      samplesToRemove++;
+    }
+
+    this.bytes.splice(0, samplesToRemove);
+    this.timestamps.splice(0, samplesToRemove);
+  }
+}
diff --git a/packages/p2p-media-loader-core/src/core.ts b/packages/p2p-media-loader-core/src/core.ts
@@ -9,7 +9,7 @@ import {
 } from "./types";
 import * as StreamUtils from "./utils/stream";
 import { LinkedMap } from "./linked-map";
-import { BandwidthApproximator } from "./bandwidth-approximator";
+import { BandwidthCalculator } from "./bandwidth-calculator";
 import { EngineCallbacks } from "./request";
 import { SegmentsMemoryStorage } from "./segments-storage";
 
@@ -31,7 +31,7 @@ export class Core<TStream extends Stream = Stream> {
     httpErrorRetries: 3,
     p2pErrorRetries: 3,
   };
-  private readonly bandwidthApproximator = new BandwidthApproximator();
+  private readonly bandwidthCalculator = new BandwidthCalculator();
   private segmentStorage?: SegmentsMemoryStorage;
   private mainStreamLoader?: HybridLoader;
   private secondaryStreamLoader?: HybridLoader;
@@ -113,7 +113,6 @@ export class Core<TStream extends Stream = Stream> {
     this.mainStreamLoader = undefined;
     this.secondaryStreamLoader = undefined;
     this.segmentStorage = undefined;
-    this.bandwidthApproximator.destroy();
     this.manifestResponseUrl = undefined;
   }
 
@@ -145,7 +144,7 @@ export class Core<TStream extends Stream = Stream> {
         manifestResponseUrl,
         segment,
         this.settings,
-        this.bandwidthApproximator,
+        this.bandwidthCalculator,
         this.segmentStorage,
         this.eventHandlers
       );

diff --git a/packages/p2p-media-loader-core/src/hybrid-loader.ts b/packages/p2p-media-loader-core/src/hybrid-loader.ts
@@ -2,7 +2,7 @@ import { Segment, StreamWithSegments } from "./index";
 import { HttpRequestExecutor } from "./http-loader";
 import { SegmentsMemoryStorage } from "./segments-storage";
 import { Settings, CoreEventHandlers, Playback } from "./types";
-import { BandwidthApproximator } from "./bandwidth-approximator";
+import { BandwidthCalculator } from "./bandwidth-calculator";
 import { P2PLoadersContainer } from "./p2p/loaders-container";
 import { RequestsContainer } from "./request-container";
 import { EngineCallbacks } from "./request";
@@ -30,7 +30,7 @@ export class HybridLoader {
     private streamManifestUrl: string,
     requestedSegment: Segment,
     private readonly settings: Settings,
-    private readonly bandwidthApproximator: BandwidthApproximator,
+    private readonly bandwidthCalculator: BandwidthCalculator,
     private readonly segmentStorage: SegmentsMemoryStorage,
     private readonly eventHandlers?: Pick<CoreEventHandlers, "onSegmentLoaded">
   ) {
@@ -40,7 +40,7 @@ export class HybridLoader {
     this.segmentAvgDuration = StreamUtils.getSegmentAvgDuration(activeStream);
     this.requests = new RequestsContainer(
       this.requestProcessQueueMicrotask,
-      this.bandwidthApproximator,
+      this.bandwidthCalculator,
       this.playback,
       this.settings
     );
@@ -94,7 +94,7 @@ export class HybridLoader {
       if (data) {
         callbacks.onSuccess({
           data,
-          bandwidth: this.bandwidthApproximator.getBandwidth(),
+          bandwidth: this.bandwidthCalculator.getBandwidthForLastNSeconds(3),
         });
       }
     } else {
@@ -344,7 +344,7 @@ export class HybridLoader {
     queue: QueueUtils.QueueItem[],
     segment: Segment
   ): boolean {
-    for (const { segment: itemSegment } of arrayBackwards(queue)) {
+    for (const { segment: itemSegment } of Utils.arrayBackwards(queue)) {
       if (itemSegment === segment) break;
       const request = this.requests.get(itemSegment);
       if (request?.type === "http" && request.status === "loading") {
@@ -359,7 +359,7 @@ export class HybridLoader {
     queue: QueueUtils.QueueItem[],
     segment: Segment
   ): boolean {
-    for (const { segment: itemSegment } of arrayBackwards(queue)) {
+    for (const { segment: itemSegment } of Utils.arrayBackwards(queue)) {
       if (itemSegment === segment) break;
       const request = this.requests.get(itemSegment);
       if (request?.type === "p2p" && request.status === "loading") {
@@ -403,9 +403,3 @@ export class HybridLoader {
     this.logger.destroy();
   }
 }
-
-function* arrayBackwards<T>(arr: T[]) {
-  for (let i = arr.length - 1; i >= 0; i--) {
-    yield arr[i];
-  }
-}
diff --git a/packages/p2p-media-loader-core/src/linked-map.ts b/packages/p2p-media-loader-core/src/linked-map.ts
@@ -9,14 +9,6 @@ export class LinkedMap<K, V extends object> {
   private _first?: LinkedObject<K, V>;
   private _last?: LinkedObject<K, V>;
 
-  get first() {
-    return this._first?.item;
-  }
-
-  get last() {
-    return this._last?.item;
-  }
-
   get size() {
     return this.map.size;
   }
@@ -53,12 +45,6 @@ export class LinkedMap<K, V extends object> {
     this.map.delete(key);
   }
 
-  clear() {
-    this._first = undefined;
-    this._last = undefined;
-    this.map.clear();
-  }
-
   *values(key?: K) {
     let value = key ? this.map.get(key) : this._first;
     if (value === undefined) return;

diff --git a/packages/p2p-media-loader-core/src/request-container.ts b/packages/p2p-media-loader-core/src/request-container.ts
@@ -1,13 +1,13 @@
 import { Segment, Settings, Playback } from "./types";
-import { BandwidthApproximator } from "./bandwidth-approximator";
+import { BandwidthCalculator } from "./bandwidth-calculator";
 import { Request } from "./request";
 
 export class RequestsContainer {
   private readonly requests = new Map<Segment, Request>();
 
   constructor(
     private readonly requestProcessQueueCallback: () => void,
-    private readonly bandwidthApproximator: BandwidthApproximator,
+    private readonly bandwidthCalculator: BandwidthCalculator,
     private readonly playback: Playback,
     private readonly settings: Settings
   ) {}
@@ -44,7 +44,7 @@ export class RequestsContainer {
       request = new Request(
         segment,
         this.requestProcessQueueCallback,
-        this.bandwidthApproximator,
+        this.bandwidthCalculator,
         this.playback,
         this.settings
       );

diff --git a/packages/p2p-media-loader-core/src/request.ts b/packages/p2p-media-loader-core/src/request.ts
@@ -1,5 +1,5 @@
 import { Segment, SegmentResponse, Playback } from "./types";
-import { BandwidthApproximator } from "./bandwidth-approximator";
+import { BandwidthCalculator } from "./bandwidth-calculator";
 import * as StreamUtils from "./utils/stream";
 import * as Utils from "./utils/utils";
 import * as LoggerUtils from "./utils/logger";
@@ -73,7 +73,7 @@ export class Request {
   constructor(
     readonly segment: Segment,
     private readonly requestProcessQueueCallback: () => void,
-    private readonly bandwidthApproximator: BandwidthApproximator,
+    private readonly bandwidthCalculator: BandwidthCalculator,
     private readonly playback: Playback,
     private readonly settings: StreamUtils.PlaybackTimeWindowsSettings
   ) {
@@ -179,7 +179,7 @@ export class Request {
       loadedBytes: 0,
       startTimestamp: performance.now(),
     };
-    this.bandwidthApproximator.addLoading(this.progress);
+    this.bandwidthCalculator.startLoading();
     const { notReceivingBytesTimeoutMs, abort } = controls;
     this._abortRequestCallback = abort;
 
@@ -207,10 +207,8 @@ export class Request {
 
   resolveEngineCallbacksSuccessfully() {
     if (!this.finalData) return;
-    this._engineCallbacks?.onSuccess({
-      data: this.finalData,
-      bandwidth: this.bandwidthApproximator.getBandwidth(),
-    });
+    const bandwidth = this.bandwidthCalculator.getBandwidthForLastNSeconds(3);
+    this._engineCallbacks?.onSuccess({ data: this.finalData, bandwidth });
     this._engineCallbacks = undefined;
   }
 
@@ -236,6 +234,7 @@ export class Request {
     this._abortRequestCallback = undefined;
     this.currentAttempt = undefined;
     this.notReceivingBytesTimeout.clear();
+    this.bandwidthCalculator.stopLoading();
   }
 
   private abortOnTimeout = () => {
@@ -252,6 +251,7 @@ export class Request {
       error,
     });
     this.notReceivingBytesTimeout.clear();
+    this.bandwidthCalculator.stopLoading();
     this.requestProcessQueueCallback();
   };
 
@@ -266,19 +266,20 @@ export class Request {
       error,
     });
     this.notReceivingBytesTimeout.clear();
+    this.bandwidthCalculator.stopLoading();
     this.requestProcessQueueCallback();
   };
 
   private completeOnSuccess = () => {
     this.throwErrorIfNotLoadingStatus();
     if (!this.currentAttempt) return;
 
+    this.bandwidthCalculator.stopLoading();
     this.notReceivingBytesTimeout.clear();
     this.finalData = Utils.joinChunks(this.bytes);
     this.setStatus("succeed");
     this._totalBytes = this._loadedBytes;
 
-    this.resolveEngineCallbacksSuccessfully();
     this.logger(
       `${this.currentAttempt.type} ${this.segment.externalId} succeed`
     );
@@ -290,6 +291,7 @@ export class Request {
     if (!this.currentAttempt || !this.progress) return;
     this.notReceivingBytesTimeout.restart();
 
+    this.bandwidthCalculator.addBytes(chunk.length);
     this.bytes.push(chunk);
     this.progress.lastLoadedChunkTimestamp = performance.now();
     this.progress.loadedBytes += chunk.length;
@@ -320,11 +322,6 @@ export class Request {
 
 class FailedRequestAttempts {
   private attempts: Required<RequestAttempt>[] = [];
-  private _lastClearTimestamp = performance.now();
-
-  get lastClearTimestamp() {
-    return this._lastClearTimestamp;
-  }
 
   add(attempt: Required<RequestAttempt>) {
     this.attempts.push(attempt);
@@ -343,7 +340,6 @@ class FailedRequestAttempts {
 
   clear() {
     this.attempts = [];
-    this._lastClearTimestamp = performance.now();
   }
 }
 

diff --git a/packages/p2p-media-loader-core/src/utils/utils.ts b/packages/p2p-media-loader-core/src/utils/utils.ts
@@ -56,3 +56,9 @@ export function hexToUtf8(hexString: string) {
   const decoder = new TextDecoder();
   return decoder.decode(bytes);
 }
+
+export function* arrayBackwards<T>(arr: T[]) {
+  for (let i = arr.length - 1; i >= 0; i--) {
+    yield arr[i];
+  }
+}