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

package/src/core/stream/adaptation/utils/create_representation_estimator.ts

@@ -1,114 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { MediaError } from "../../../../errors";
-import Manifest, {
-  Adaptation,
-  Period,
-  Representation,
-} from "../../../../manifest";
-import { IPlayerError } from "../../../../public_types";
-import createSharedReference, {
-  IReadOnlySharedReference,
-} from "../../../../utils/reference";
-import { CancellationSignal } from "../../../../utils/task_canceller";
-import {
-  IABREstimate,
-  IRepresentationEstimatorPlaybackObservation,
-  IRepresentationEstimator,
-  IRepresentationEstimatorCallbacks,
-} from "../../../adaptive";
-import { IReadOnlyPlaybackObserver } from "../../../api";
-
-/**
- * Produce estimates to know which Representation should be played.
- * @param {Object} content - The Manifest, Period and Adaptation wanted.
- * @param {Object} representationEstimator - `IRepresentationEstimator` which
- * will produce Representation estimates.
- * @param {Object} currentRepresentation - Reference emitting the
- * currently-loaded Representation.
- * @param {Object} playbackObserver - Allows to observe the current playback
- * conditions.
- * @param {Function} onFatalError - Callback called when a fatal error was
- * thrown. Once this callback is called, no estimate will be produced.
- * @param {Object} cancellationSignal - `CancellationSignal` allowing to abort
- * the production of estimates (and clean-up all linked resources).
- * @returns {Object} - Returns an object with the following properties:
- *   - `estimateRef`: Reference emitting the last estimate
- *   - `abrCallbacks`: Callbacks allowing to report back network and playback
- *     activities to improve the estimates given.
- */
-export default function getRepresentationEstimate(
-  content : { manifest : Manifest;
-              period : Period;
-              adaptation : Adaptation; },
-  representationEstimator : IRepresentationEstimator,
-  currentRepresentation : IReadOnlySharedReference<Representation | null>,
-  playbackObserver : IReadOnlyPlaybackObserver<
-    IRepresentationEstimatorPlaybackObservation
-  >,
-  onFatalError: (err : IPlayerError) => void,
-  cancellationSignal : CancellationSignal
-) : { estimateRef : IReadOnlySharedReference<IABREstimate>;
-      abrCallbacks : IRepresentationEstimatorCallbacks; }
-{
-  const { manifest, adaptation } = content;
-  const representations = createSharedReference<Representation[]>(
-    [],
-    cancellationSignal);
-  updateRepresentationsReference();
-  manifest.addEventListener("decipherabilityUpdate", updateRepresentationsReference);
-  const unregisterCleanUp = cancellationSignal.register(cleanUp);
-  const { estimates: estimateRef,
-          callbacks: abrCallbacks } = representationEstimator(content,
-                                                              currentRepresentation,
-                                                              representations,
-                                                              playbackObserver,
-                                                              cancellationSignal);
-  return { abrCallbacks, estimateRef };
-
-  function updateRepresentationsReference() : void {
-    /** Representations for which a `RepresentationStream` can be created. */
-    const newRepr = adaptation.getPlayableRepresentations();
-    if (newRepr.length === 0) {
-      const noRepErr = new MediaError("NO_PLAYABLE_REPRESENTATION",
-                                      "No Representation in the chosen " +
-                                      adaptation.type + " Adaptation can be played",
-                                      { adaptation });
-      cleanUp();
-      onFatalError(noRepErr);
-      return;
-    }
-
-    const prevRepr = representations.getValue();
-    if (prevRepr.length === newRepr.length) {
-      if (prevRepr.every((r, idx) => r.id === newRepr[idx].id)) {
-        return ;
-      }
-    }
-    representations.setValue(newRepr);
-  }
-
-  /** Clean-up all resources taken here. */
-  function cleanUp() : void {
-    manifest.removeEventListener("decipherabilityUpdate", updateRepresentationsReference);
-
-    // check to protect against the case where it is not yet defined.
-    if (typeof unregisterCleanUp !== "undefined") {
-      unregisterCleanUp();
-    }
-  }
-}

package/src/core/stream/utils/create_reload_request.ts

@@ -1,69 +0,0 @@
-import nextTick from "next-tick";
-import { CancellationSignal } from "../../../utils/task_canceller";
-import { IReadOnlyPlaybackObserver } from "../../api";
-import { IPausedPlaybackObservation } from "../adaptation";
-import { IPositionPlaybackObservation } from "../representation";
-
-/**
- * Function to facilitate the task of asking for the MediaSource to be reloaded.
- *
- * @param {Object} playbackObserver - Regularly emits the current playback
- * conditions.
- * @param {Function} fn - Function that will be called regularly with the
- * position and auto-play status that you should ask to reload to.
- * @param {number} deltaPos - This value, in seconds, will be added to the
- * actual current position (respecting the `timeBounds` given) to indicate the
- * position we should reload at.
- * This value allows to give back context (by replaying some media data) after
- * a switch.
- * @param {Object} timeBounds - Bounds that should not be exceeded on the
- * position to reload to. Both `start` and `end` bounds can be set to
- * `undefined` to disable them.
- * @param {Object} cancelSignal - When it emits, we stop asking for the
- * MediaSource to be reloaded.
- */
-export default function createReloadRequest (
-  playbackObserver : IReadOnlyPlaybackObserver<{
-    position : IPositionPlaybackObservation;
-    paused : IPausedPlaybackObservation;
-  }>,
-  fn : (arg : { position : number; autoPlay : boolean }) => void,
-  deltaPos : number,
-  timeBounds : { start : number | undefined; end : number | undefined },
-  cancelSignal : CancellationSignal
-) : void {
-  if (cancelSignal.isCancelled()) {
-    return;
-  }
-
-  // We begin by scheduling a micro-task to reduce the possibility of race
-  // conditions.
-  //
-  // For example `createReloadRequest` could be called synchronously
-  // before the next observation (which may reflect very different
-  // playback conditions) is actually received. This can happen when
-  // `createReloadRequest` is called as a side-effect of the same event
-  // that triggers the playback observation to be emitted. In that situation,
-  // scheduling a micro task ensures that the true last observation is
-  // considered.
-  //
-  // Other races conditions could also happen for when example multiple
-  // modules of the player handle some events (I can think for example of the
-  // case where the `Adaptation` disappears on a Manifest update) where we
-  // want the reloading operation to be a last resort situation, so we prefer
-  // to postpone it after other potential synchronous solutions from other
-  // modules have been tested.
-  //
-  // At last, because reloading is such an aggressive situation, we prefer to
-  // trigger it always asynchronously so behavior is better predictible.
-  nextTick(() => {
-    playbackObserver.listen((observation) => {
-      const currentTime = playbackObserver.getCurrentTime();
-      let position = currentTime + deltaPos;
-      position = Math.min(Math.max(timeBounds.start ?? 0, position),
-                          timeBounds.end ?? Infinity);
-      const autoPlay = !(observation.paused.pending ?? playbackObserver.getIsPaused());
-      fn({ position, autoPlay });
-    }, { includeLastObservation: true, clearSignal: cancelSignal });
-  });
-}

package/src/features/__tests__/initialize_features.test.ts

@@ -1,477 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable @typescript-eslint/no-var-requires */
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-return */
-/* eslint-disable max-len */
-
-describe("Features - initializeFeaturesObject", () => {
-  beforeEach(() => {
-    jest.resetModules();
-  });
-
-  /* eslint-disable @typescript-eslint/naming-convention */
-  const win = window as unknown as {
-    __FEATURES__: unknown;
-  };
-  /* eslint-enable @typescript-eslint/naming-convention */
-
-  it("should set no feature if nothing is enabled", () => {
-    win.__FEATURES__ = {
-      IS_DISABLED: 0,
-      IS_ENABLED: 1,
-
-      DASH: 0,
-      DIRECTFILE: 0,
-      EME: 0,
-      HTML_SAMI: 0,
-      HTML_SRT: 0,
-      HTML_TTML: 0,
-      HTML_VTT: 0,
-      LOCAL_MANIFEST: 0,
-      METAPLAYLIST: 0,
-      DEBUG_ELEMENT: 0,
-      NATIVE_SAMI: 0,
-      NATIVE_SRT: 0,
-      NATIVE_TTML: 0,
-      NATIVE_VTT: 0,
-      SMOOTH: 0,
-    };
-    const feat = {};
-    jest.mock("../features_object", () => ({ default: feat,
-                                             __esModule: true as const }));
-    const initializeFeaturesObject = jest.requireActual("../initialize_features").default;
-    initializeFeaturesObject();
-    expect<unknown>(feat).toEqual({});
-    delete win.__FEATURES__;
-  });
-
-  it("should set the right features when everything is enabled", () => {
-    win.__FEATURES__ = {
-      IS_DISABLED: 0,
-      IS_ENABLED: 1,
-
-      DASH: 1,
-      DIRECTFILE: 1,
-      EME: 1,
-      HTML_SAMI: 1,
-      HTML_SRT: 1,
-      HTML_TTML: 1,
-      HTML_VTT: 1,
-      LOCAL_MANIFEST: 1,
-      METAPLAYLIST: 1,
-      DEBUG_ELEMENT: 1,
-      NATIVE_SAMI: 1,
-      NATIVE_SRT: 1,
-      NATIVE_TTML: 1,
-      NATIVE_VTT: 1,
-      SMOOTH: 1,
-    };
-    const feat = {
-      transports: {},
-      dashParsers: { js: null, wasm: null },
-      nativeTextTracksBuffer: null,
-      nativeTextTracksParsers: {},
-      htmlTextTracksBuffer: null,
-      htmlTextTracksParsers: {},
-      ContentDecryptor: null,
-      directfile: null,
-    };
-    jest.mock("../features_object", () => ({
-      __esModule: true as const,
-      default: feat,
-    }));
-    const initializeFeaturesObject = jest.requireActual("../initialize_features").default;
-    initializeFeaturesObject();
-    expect(feat).toEqual({
-      transports: {
-        metaplaylist: jest.requireActual("../../transports/metaplaylist/index").default,
-        dash: jest.requireActual("../../transports/dash/index").default,
-        smooth: jest.requireActual("../../transports/smooth/index").default,
-        local: jest.requireActual("../../transports/local/index").default,
-      },
-      dashParsers: {
-        js: jest.requireActual("../../parsers/manifest/dash/js-parser").default,
-        wasm: null,
-      },
-      ContentDecryptor: jest.requireActual("../../core/decrypt/index").default,
-      createDebugElement: jest.requireActual("../../core/api/debug").default,
-      directfile: {
-        initDirectFile: jest.requireActual("../../core/init/directfile_content_initializer").default,
-        mediaElementTracksStore:
-          jest.requireActual("../../core/api/track_management/media_element_tracks_store").default,
-      },
-      nativeTextTracksBuffer: jest.requireActual("../../core/segment_buffers/implementations/text/native/index")
-        .default,
-      nativeTextTracksParsers: {
-        vtt: jest.requireActual("../../parsers/texttracks/webvtt/native/index").default,
-        ttml: jest.requireActual("../../parsers/texttracks/ttml/native/index").default,
-        sami: jest.requireActual("../../parsers/texttracks/sami/native").default,
-        srt: jest.requireActual("../../parsers/texttracks/srt/native").default,
-      },
-      htmlTextTracksBuffer: jest.requireActual("../../core/segment_buffers/implementations/text/html/index")
-        .default,
-      htmlTextTracksParsers: {
-        vtt: jest.requireActual("../../parsers/texttracks/webvtt/html/index").default,
-        ttml: jest.requireActual("../../parsers/texttracks/ttml/html/index").default,
-        sami: jest.requireActual("../../parsers/texttracks/sami/html").default,
-        srt: jest.requireActual("../../parsers/texttracks/srt/html").default,
-      },
-    });
-
-    delete win.__FEATURES__;
-  });
-
-  it("should add the html text buffer if the html vtt parser is added", () => {
-    win.__FEATURES__ = {
-      IS_DISABLED: 0,
-      IS_ENABLED: 1,
-
-      DASH: 0,
-      DIRECTFILE: 0,
-      EME: 0,
-      HTML_SAMI: 0,
-      HTML_SRT: 0,
-      HTML_TTML: 0,
-      HTML_VTT: 1,
-      LOCAL_MANIFEST: 0,
-      METAPLAYLIST: 0,
-      DEBUG_ELEMENT: 0,
-      NATIVE_SAMI: 0,
-      NATIVE_SRT: 0,
-      NATIVE_TTML: 0,
-      NATIVE_VTT: 0,
-      SMOOTH: 0,
-    };
-    const feat = {
-      htmlTextTracksBuffer: null,
-      htmlTextTracksParsers: {},
-    };
-    jest.mock("../features_object", () => ({
-      __esModule: true as const,
-      default: feat,
-    }));
-    const initializeFeaturesObject = jest.requireActual("../initialize_features").default;
-    initializeFeaturesObject();
-    expect(feat).toEqual({
-      htmlTextTracksBuffer: jest.requireActual("../../core/segment_buffers/implementations/text/html/index")
-        .default,
-      htmlTextTracksParsers: {
-        vtt: jest.requireActual("../../parsers/texttracks/webvtt/html/index").default,
-      },
-    });
-
-    delete win.__FEATURES__;
-  });
-
-  it("should add the html text buffer if the html sami parser is added", () => {
-    win.__FEATURES__ = {
-      IS_DISABLED: 0,
-      IS_ENABLED: 1,
-
-      DASH: 0,
-      DIRECTFILE: 0,
-      EME: 0,
-      HTML_SAMI: 1,
-      HTML_SRT: 0,
-      HTML_TTML: 0,
-      HTML_VTT: 0,
-      LOCAL_MANIFEST: 0,
-      METAPLAYLIST: 0,
-      DEBUG_ELEMENT: 0,
-      NATIVE_SAMI: 0,
-      NATIVE_SRT: 0,
-      NATIVE_TTML: 0,
-      NATIVE_VTT: 0,
-      SMOOTH: 0,
-    };
-    const feat = {
-      htmlTextTracksBuffer: null,
-      htmlTextTracksParsers: {},
-    };
-    jest.mock("../features_object", () => ({
-      __esModule: true as const,
-      default: feat,
-    }));
-    const initializeFeaturesObject = jest.requireActual("../initialize_features").default;
-    initializeFeaturesObject();
-    expect(feat).toEqual({
-      htmlTextTracksBuffer: jest.requireActual("../../core/segment_buffers/implementations/text/html/index")
-        .default,
-      htmlTextTracksParsers: {
-        sami: jest.requireActual("../../parsers/texttracks/sami/html").default,
-      },
-    });
-
-    delete win.__FEATURES__;
-  });
-
-  it("should add the html text buffer if the html ttml parser is added", () => {
-    win.__FEATURES__ = {
-      IS_DISABLED: 0,
-      IS_ENABLED: 1,
-
-      DASH: 0,
-      DIRECTFILE: 0,
-      EME: 0,
-      HTML_SAMI: 0,
-      HTML_SRT: 0,
-      HTML_TTML: 1,
-      HTML_VTT: 0,
-      LOCAL_MANIFEST: 0,
-      METAPLAYLIST: 0,
-      DEBUG_ELEMENT: 0,
-      NATIVE_SAMI: 0,
-      NATIVE_SRT: 0,
-      NATIVE_TTML: 0,
-      NATIVE_VTT: 0,
-      SMOOTH: 0,
-    };
-    const feat = {
-      htmlTextTracksBuffer: null,
-      htmlTextTracksParsers: {},
-    };
-    jest.mock("../features_object", () => ({
-      __esModule: true as const,
-      default: feat,
-    }));
-    const initializeFeaturesObject = jest.requireActual("../initialize_features").default;
-    initializeFeaturesObject();
-    expect(feat).toEqual({
-      htmlTextTracksBuffer: jest.requireActual("../../core/segment_buffers/implementations/text/html/index")
-        .default,
-      htmlTextTracksParsers: {
-        ttml: jest.requireActual("../../parsers/texttracks/ttml/html/index").default,
-      },
-    });
-
-    delete win.__FEATURES__;
-  });
-
-  it("should add the html text buffer if the html srt parser is added", () => {
-    win.__FEATURES__ = {
-      IS_DISABLED: 0,
-      IS_ENABLED: 1,
-
-      DASH: 0,
-      DIRECTFILE: 0,
-      EME: 0,
-      HTML_SAMI: 0,
-      HTML_SRT: 1,
-      HTML_TTML: 0,
-      HTML_VTT: 0,
-      LOCAL_MANIFEST: 0,
-      METAPLAYLIST: 0,
-      DEBUG_ELEMENT: 0,
-      NATIVE_SAMI: 0,
-      NATIVE_SRT: 0,
-      NATIVE_TTML: 0,
-      NATIVE_VTT: 0,
-      SMOOTH: 0,
-    };
-    const feat = {
-      htmlTextTracksBuffer: null,
-      htmlTextTracksParsers: {},
-    };
-    jest.mock("../features_object", () => ({
-      __esModule: true as const,
-      default: feat,
-    }));
-    const initializeFeaturesObject = jest.requireActual("../initialize_features").default;
-    initializeFeaturesObject();
-    expect(feat).toEqual({
-      htmlTextTracksBuffer: jest.requireActual("../../core/segment_buffers/implementations/text/html/index")
-        .default,
-      htmlTextTracksParsers: {
-        srt: jest.requireActual("../../parsers/texttracks/srt/html").default,
-      },
-    });
-
-    delete win.__FEATURES__;
-  });
-
-  it("should add the native text buffer if the native vtt parser is added", () => {
-    win.__FEATURES__ = {
-      IS_DISABLED: 0,
-      IS_ENABLED: 1,
-
-      DASH: 0,
-      DIRECTFILE: 0,
-      EME: 0,
-      HTML_SAMI: 0,
-      HTML_SRT: 0,
-      HTML_TTML: 0,
-      HTML_VTT: 0,
-      LOCAL_MANIFEST: 0,
-      METAPLAYLIST: 0,
-      DEBUG_ELEMENT: 0,
-      NATIVE_SAMI: 0,
-      NATIVE_SRT: 0,
-      NATIVE_TTML: 0,
-      NATIVE_VTT: 1,
-      SMOOTH: 0,
-    };
-    const feat = {
-      nativeTextTracksBuffer: null,
-      nativeTextTracksParsers: {},
-    };
-    jest.mock("../features_object", () => ({
-      __esModule: true as const,
-      default: feat,
-    }));
-    const initializeFeaturesObject = jest.requireActual("../initialize_features").default;
-    initializeFeaturesObject();
-    expect(feat).toEqual({
-      nativeTextTracksBuffer: jest.requireActual("../../core/segment_buffers/implementations/text/native/index")
-        .default,
-      nativeTextTracksParsers: {
-        vtt: jest.requireActual("../../parsers/texttracks/webvtt/native/index").default,
-      },
-    });
-
-    delete win.__FEATURES__;
-  });
-
-  it("should add the native text buffer if the native sami parser is added", () => {
-    win.__FEATURES__ = {
-      IS_DISABLED: 0,
-      IS_ENABLED: 1,
-
-      DASH: 0,
-      DIRECTFILE: 0,
-      EME: 0,
-      HTML_SAMI: 0,
-      HTML_SRT: 0,
-      HTML_TTML: 0,
-      HTML_VTT: 0,
-      LOCAL_MANIFEST: 0,
-      METAPLAYLIST: 0,
-      DEBUG_ELEMENT: 0,
-      NATIVE_SAMI: 1,
-      NATIVE_SRT: 0,
-      NATIVE_TTML: 0,
-      NATIVE_VTT: 0,
-      SMOOTH: 0,
-    };
-    const feat = {
-      nativeTextTracksBuffer: null,
-      nativeTextTracksParsers: {},
-    };
-    jest.mock("../features_object", () => ({
-      __esModule: true as const,
-      default: feat,
-    }));
-    const initializeFeaturesObject = jest.requireActual("../initialize_features").default;
-    initializeFeaturesObject();
-    expect(feat).toEqual({
-      nativeTextTracksBuffer: jest.requireActual("../../core/segment_buffers/implementations/text/native/index")
-        .default,
-      nativeTextTracksParsers: {
-        sami: jest.requireActual("../../parsers/texttracks/sami/native").default,
-      },
-    });
-
-    delete win.__FEATURES__;
-  });
-
-  it("should add the native text buffer if the native ttml parser is added", () => {
-    win.__FEATURES__ = {
-      IS_DISABLED: 0,
-      IS_ENABLED: 1,
-
-      DASH: 0,
-      DIRECTFILE: 0,
-      EME: 0,
-      HTML_SAMI: 0,
-      HTML_SRT: 0,
-      HTML_TTML: 0,
-      HTML_VTT: 0,
-      LOCAL_MANIFEST: 0,
-      METAPLAYLIST: 0,
-      DEBUG_ELEMENT: 0,
-      NATIVE_SAMI: 0,
-      NATIVE_SRT: 0,
-      NATIVE_TTML: 1,
-      NATIVE_VTT: 0,
-      SMOOTH: 0,
-    };
-    const feat = {
-      nativeTextTracksBuffer: null,
-      nativeTextTracksParsers: {},
-    };
-    jest.mock("../features_object", () => ({
-      __esModule: true as const,
-      default: feat,
-    }));
-    const initializeFeaturesObject = jest.requireActual("../initialize_features").default;
-    initializeFeaturesObject();
-    expect(feat).toEqual({
-      nativeTextTracksBuffer: jest.requireActual("../../core/segment_buffers/implementations/text/native/index")
-        .default,
-      nativeTextTracksParsers: {
-        ttml: jest.requireActual("../../parsers/texttracks/ttml/native/index").default,
-      },
-    });
-
-    delete win.__FEATURES__;
-  });
-
-  it("should add the native text buffer if the native srt parser is added", () => {
-    win.__FEATURES__ = {
-      IS_DISABLED: 0,
-      IS_ENABLED: 1,
-
-      DASH: 0,
-      DIRECTFILE: 0,
-      EME: 0,
-      HTML_SAMI: 0,
-      HTML_SRT: 0,
-      HTML_TTML: 0,
-      HTML_VTT: 0,
-      LOCAL_MANIFEST: 0,
-      METAPLAYLIST: 0,
-      DEBUG_ELEMENT: 0,
-      NATIVE_SAMI: 0,
-      NATIVE_SRT: 1,
-      NATIVE_TTML: 0,
-      NATIVE_VTT: 0,
-      SMOOTH: 0,
-    };
-    const feat = {
-      nativeTextTracksBuffer: null,
-      nativeTextTracksParsers: {},
-    };
-    jest.mock("../features_object", () => ({
-      __esModule: true as const,
-      default: feat,
-    }));
-    const initializeFeaturesObject = jest.requireActual("../initialize_features").default;
-    initializeFeaturesObject();
-    expect(feat).toEqual({
-      nativeTextTracksBuffer: jest.requireActual("../../core/segment_buffers/implementations/text/native/index")
-        .default,
-      nativeTextTracksParsers: {
-        srt: jest.requireActual("../../parsers/texttracks/srt/native").default,
-      },
-    });
-
-    delete win.__FEATURES__;
-  });
-});