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

package/src/core/api/debug/modules/segment_buffer_content.ts

@@ -0,0 +1,155 @@
+import {
+  Adaptation,
+  Period,
+  Representation,
+} from "../../../../manifest";
+import isNullOrUndefined from "../../../../utils/is_null_or_undefined";
+import { CancellationSignal } from "../../../../utils/task_canceller";
+import { IBufferType } from "../../../segment_buffers";
+import RxPlayer from "../../public_api";
+import SegmentBufferGraph from "../buffer_graph";
+import { DEFAULT_REFRESH_INTERVAL } from "../constants";
+import {
+  createElement,
+  createGraphCanvas,
+  createMetricTitle,
+  isExtendedMode,
+} from "../utils";
+
+export default function createSegmentBufferGraph(
+  instance : RxPlayer,
+  bufferType : IBufferType,
+  title : string,
+  parentElt : HTMLElement,
+  cancelSignal : CancellationSignal
+) : HTMLElement {
+  const bufferGraphWrapper = createElement("div");
+  const bufferTitle = createMetricTitle(title);
+  const canvasElt = createGraphCanvas();
+  const currentRangeRepInfoElt = createElement("div");
+  const loadingRangeRepInfoElt = createElement("div");
+  const bufferGraph = new SegmentBufferGraph(canvasElt);
+  const intervalId = setInterval(update, DEFAULT_REFRESH_INTERVAL);
+  cancelSignal.register(() => {
+    clearInterval(intervalId);
+  });
+  bufferGraphWrapper.appendChild(bufferTitle);
+  bufferGraphWrapper.appendChild(canvasElt);
+  bufferGraphWrapper.appendChild(currentRangeRepInfoElt);
+  bufferGraphWrapper.appendChild(loadingRangeRepInfoElt);
+  bufferGraphWrapper.style.padding = "5px 0px";
+  update();
+  return bufferGraphWrapper;
+
+  function update() {
+    if (instance.getVideoElement() === null) {
+      // disposed player. Clean-up everything
+      bufferGraphWrapper.style.display = "none";
+      bufferGraphWrapper.innerHTML = "";
+      clearInterval(intervalId);
+      return;
+    }
+    const showAllInfo = isExtendedMode(parentElt);
+    const inventory = instance.__priv_getSegmentBufferContent(bufferType);
+    if (inventory === null) {
+      bufferGraphWrapper.style.display = "none";
+      currentRangeRepInfoElt.innerHTML = "";
+      loadingRangeRepInfoElt.innerHTML = "";
+    } else {
+      bufferGraphWrapper.style.display = "block";
+      const currentTime = instance.getPosition();
+      const width = Math.min(parentElt.clientWidth - 150, 600);
+      bufferGraph.update({
+        currentTime,
+        minimumPosition: instance.getMinimumPosition() ?? undefined,
+        maximumPosition: instance.getMaximumPosition() ?? undefined,
+        inventory,
+        width,
+        height: 10,
+      });
+
+      if (!showAllInfo) {
+        currentRangeRepInfoElt.innerHTML = "";
+        loadingRangeRepInfoElt.innerHTML = "";
+        return;
+      }
+
+      currentRangeRepInfoElt.innerHTML = "";
+      for (let i = 0; i < inventory.length; i++) {
+        const rangeInfo = inventory[i];
+        const { bufferedStart, bufferedEnd, infos } = rangeInfo;
+        if (bufferedStart !== undefined && bufferedEnd !== undefined &&
+            currentTime >= bufferedStart && currentTime < bufferedEnd)
+        {
+          currentRangeRepInfoElt.appendChild(createMetricTitle("play"));
+          currentRangeRepInfoElt.appendChild(createElement("span", {
+            textContent: constructRepresentationInfo(infos),
+          }));
+          break;
+        }
+      }
+
+      loadingRangeRepInfoElt.innerHTML = "";
+      const rep = instance.__priv_getCurrentRepresentations()?.[bufferType];
+      const adap = instance.__priv_getCurrentAdaptation()?.[bufferType];
+      const manifest = instance.__priv_getManifest();
+      if (manifest !== null && !isNullOrUndefined(rep) && !isNullOrUndefined(adap)) {
+        const period = manifest.getPeriodForTime(currentTime);
+        if (period !== undefined) {
+          loadingRangeRepInfoElt.appendChild(createMetricTitle("load"));
+          loadingRangeRepInfoElt.appendChild(createElement("span", {
+            textContent: constructRepresentationInfo({
+              period,
+              adaptation: adap,
+              representation: rep,
+            }),
+          }));
+        }
+      }
+    }
+  }
+}
+
+function constructRepresentationInfo(
+  content : {
+    period : Period;
+    adaptation : Adaptation;
+    representation : Representation;
+  }
+) : string {
+  const period = content.period;
+  const { language,
+          isAudioDescription,
+          isClosedCaption,
+          isTrickModeTrack,
+          isSignInterpreted,
+          type: bufferType } = content.adaptation;
+  const { id, height, width, bitrate, codec } = content.representation;
+  let representationInfo = `"${id}" `;
+  if (height !== undefined && width !== undefined) {
+    representationInfo += `${width}x${height} `;
+  }
+  if (bitrate !== undefined) {
+    representationInfo += `(${(bitrate / 1000).toFixed(0)}kbps) `;
+  }
+  if (codec !== undefined) {
+    representationInfo += `c:"${codec}" `;
+  }
+  if (language !== undefined) {
+    representationInfo += `l:"${language}" `;
+  }
+  if (bufferType === "video" && typeof isSignInterpreted === "boolean") {
+    representationInfo += `si:${isSignInterpreted ? 1 : 0} `;
+  }
+  if (bufferType === "video" && typeof isTrickModeTrack === "boolean") {
+    representationInfo += `tm:${isTrickModeTrack ? 1 : 0} `;
+  }
+  if (bufferType === "audio" && typeof isAudioDescription === "boolean") {
+    representationInfo += `ad:${isAudioDescription ? 1 : 0} `;
+  }
+  if (bufferType === "text" && typeof isClosedCaption === "boolean") {
+    representationInfo += `cc:${isClosedCaption ? 1 : 0} `;
+  }
+  representationInfo += `p:${period.start}-${period.end ?? "?"}`;
+  return representationInfo;
+}

package/src/core/api/debug/modules/segment_buffer_size.ts

@@ -0,0 +1,48 @@
+import { CancellationSignal } from "../../../../utils/task_canceller";
+import RxPlayer from "../../public_api";
+import BufferSizeGraph from "../buffer_size_graph";
+import { DEFAULT_REFRESH_INTERVAL } from "../constants";
+import {
+  createElement,
+  createGraphCanvas,
+  createMetricTitle,
+} from "../utils";
+
+export default function createSegmentBufferSizeGraph(
+  instance : RxPlayer,
+  parentElt : HTMLElement,
+  cancelSignal : CancellationSignal
+) : HTMLElement {
+  const bufferSizeGraphWrapperElt = createElement("div");
+  const bufferSizeTitle = createMetricTitle("bgap");
+  const canvasElt = createGraphCanvas();
+
+  const bufferSizeGraph = new BufferSizeGraph(canvasElt);
+  const intervalId = setInterval(addBufferSize, DEFAULT_REFRESH_INTERVAL);
+  cancelSignal.register(() => {
+    clearInterval(intervalId);
+  });
+  bufferSizeGraphWrapperElt.appendChild(bufferSizeTitle);
+  bufferSizeGraphWrapperElt.appendChild(canvasElt);
+  bufferSizeGraphWrapperElt.style.padding = "7px 0px";
+  addBufferSize();
+  return bufferSizeGraphWrapperElt;
+
+  function addBufferSize() {
+    if (instance.getVideoElement() === null) {
+      // disposed player. Clean-up everything
+      bufferSizeGraphWrapperElt.innerHTML = "";
+      clearInterval(intervalId);
+      return;
+    }
+    const bufferGap = instance.getCurrentBufferGap();
+    if (bufferGap === Infinity) {
+      bufferSizeGraph.pushBufferSize(0);
+    } else {
+      bufferSizeGraph.pushBufferSize(bufferGap);
+    }
+    const width = Math.min(parentElt.clientWidth - 150, 600);
+    bufferSizeGraph.reRender(width, 10);
+  }
+}
+

package/src/core/api/debug/render.ts

@@ -0,0 +1,40 @@
+import { CancellationSignal } from "../../../utils/task_canceller";
+import RxPlayer from "../public_api";
+import constructDebugGeneralInfo from "./modules/general_info";
+import createSegmentBufferGraph from "./modules/segment_buffer_content";
+import createSegmentBufferSizeGraph from "./modules/segment_buffer_size";
+import { createCompositeElement, createElement } from "./utils";
+
+export default function renderDebugElement(
+  parentElt : HTMLElement,
+  instance : RxPlayer,
+  cancelSignal : CancellationSignal
+) : void {
+  const debugElementTitleElt = createElement("div", {
+    textContent: "RxPlayer Debug Information",
+  });
+  debugElementTitleElt.style.fontWeight = "bold";
+  debugElementTitleElt.style.borderBottom = "1px solid white";
+  debugElementTitleElt.style.marginBottom = "5px";
+  debugElementTitleElt.style.fontStyle = "italic";
+
+  const debugWrapperElt = createCompositeElement("div", [
+    debugElementTitleElt,
+    constructDebugGeneralInfo(instance, parentElt, cancelSignal),
+    createSegmentBufferGraph(instance, "video", "vbuf", parentElt, cancelSignal),
+    createSegmentBufferGraph(instance, "audio", "abuf", parentElt, cancelSignal),
+    createSegmentBufferGraph(instance, "text", "tbuf", parentElt, cancelSignal),
+    createSegmentBufferSizeGraph(instance, parentElt, cancelSignal),
+  ]);
+  debugWrapperElt.style.backgroundColor = "#00000099";
+  debugWrapperElt.style.padding = "7px";
+  debugWrapperElt.style.fontSize = "13px";
+  debugWrapperElt.style.fontFamily = "mono, monospace";
+  debugWrapperElt.style.color = "white";
+  debugWrapperElt.style.display = "inline-block";
+  debugWrapperElt.style.bottom = "0px";
+  parentElt.appendChild(debugWrapperElt);
+  cancelSignal.register(() => {
+    parentElt.removeChild(debugWrapperElt);
+  });
+}

package/src/core/api/debug/utils.ts

@@ -0,0 +1,103 @@
+/**
+ * Create an HTML element.
+ * @param {string} elementName - The element's name, like `"div"` for example.
+ * @param {Object} [options={}] - Optional attributes for the element.
+ * @param {string} [options.textContent] - Inner text for that element.
+ * @param {string} [options.className] - Value for a `class` attribute
+ * associated to this element.
+ * @param {string} [options.href] - Value for a `href` attribute
+ * associated to this element.
+ * @returns {HTMLElement}
+ */
+export function createElement(
+  elementName : "input",
+  opts? : CreateElementOptions | undefined
+) : HTMLInputElement;
+export function createElement(
+  elementName : "button",
+  opts? : CreateElementOptions | undefined
+) : HTMLButtonElement;
+export function createElement(
+  elementName : "a",
+  opts? : CreateElementOptions | undefined
+) : HTMLLinkElement;
+export function createElement(
+  elementName : "canvas",
+  opts? : CreateElementOptions | undefined
+) : HTMLCanvasElement;
+export function createElement(
+  elementName : string,
+  opts? : CreateElementOptions | undefined
+) : HTMLElement;
+export function createElement(
+  elementName : string,
+  {
+    textContent,
+    className,
+  } : CreateElementOptions | undefined = {}
+) : HTMLElement {
+  const elt = document.createElement(elementName);
+  if (className !== undefined) {
+    elt.className = className;
+  }
+  if (textContent !== undefined) {
+    elt.textContent = textContent;
+  }
+  return elt;
+}
+
+interface CreateElementOptions {
+  textContent? : string | undefined;
+  className? : string | undefined;
+}
+
+/**
+ * Create an HTML element which may contain mutiple HTML sub-elements.
+ * @param {string} rootElementName - The element's name, like `"div"` for
+ * example.
+ * @param {Array.<string|HTMLElement>} parts - The HTML sub-elements, in order.
+ * Those can also just be strings, in which case only text nodes (and no actual
+ * HTMLElement) will be added at this place.
+ * @param {Object} [options={}] - Optional attributes for the element.
+ * @param {string} [options.className] - Value for a `class` attribute
+ * associated to this element.
+ * @returns {HTMLElement}
+ */
+export function createCompositeElement(
+  rootElementName : string,
+  parts : Array<HTMLElement | string>,
+  { className } : { className? : string } | undefined = {}
+) : HTMLElement {
+  const elt = document.createElement(rootElementName);
+  if (className !== undefined) {
+    elt.className = className;
+  }
+  for (const subElt of parts) {
+    if (typeof subElt === "string") {
+      elt.appendChild(document.createTextNode(subElt));
+    } else {
+      elt.appendChild(subElt);
+    }
+  }
+  return elt;
+}
+
+export function isExtendedMode(parentElt : HTMLElement) : boolean {
+  return parentElt.clientHeight > 400;
+}
+
+export function createMetricTitle(title : string) : HTMLElement {
+  const elt = createElement("span", {
+    textContent: title + "/",
+  });
+  elt.style.fontWeight = "bold";
+  return elt;
+}
+
+export function createGraphCanvas() : HTMLCanvasElement {
+  const canvasElt = createElement("canvas");
+  canvasElt.style.border = "1px solid white";
+  canvasElt.style.height = "15px";
+  canvasElt.style.marginLeft = "2px";
+  return canvasElt;
+}

package/src/core/api/playback_observer.ts

@@ -167,6 +167,7 @@ export default class PlaybackObserver {
    */
   public setCurrentTime(time: number) : void {
     this._internalSeeksIncoming.push(time);
+    log.info("API: Seeking internally", time);
     this._mediaElement.currentTime = time;
   }
 
@@ -217,7 +218,7 @@ export default class PlaybackObserver {
     options? : { includeLastObservation? : boolean | undefined;
                  clearSignal? : CancellationSignal | undefined; }
   ) {
-    if (this._canceller.isUsed || options?.clearSignal?.isCancelled === true) {
+    if (this._canceller.isUsed() || options?.clearSignal?.isCancelled() === true) {
       return noop;
     }
     this._observationRef.onUpdate(cb, {
@@ -971,7 +972,9 @@ function generateReadOnlyObserver<TSource, TDest>(
       options? : { includeLastObservation? : boolean | undefined;
                    clearSignal? : CancellationSignal | undefined; }
     ) : void {
-      if (cancellationSignal.isCancelled || options?.clearSignal?.isCancelled === true) {
+      if (cancellationSignal.isCancelled() ||
+          options?.clearSignal?.isCancelled() === true)
+      {
         return ;
       }
       mappedRef.onUpdate(cb, {