Merge pull request #1170 from canalplus/fix/tizen-enable-audio-track

Fix directfile audiotrack selection on Tizen

src/compat/__tests__/enable_audio_track.test.ts

@@ -0,0 +1,341 @@
+/* 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 */
+describe("compat - enableAudioTrack", () => {
+  beforeEach(() => {
+    jest.resetModules();
+  });
+
+  it("should enable the wanted audioTrack", () => {
+    jest.mock("../browser_detection", () => {
+      return {
+        __esModule: true as const,
+        isTizen: false,
+      };
+    });
+    const fakeAudioTracks = [
+      {
+        id: "id1",
+        kind: "descriptions",
+        label: "Toto",
+        language: "swa",
+        enabled: true,
+      },
+      {
+        id: "id2",
+        kind: "normal",
+        label: "Titi",
+        language: "fre",
+        enabled: false,
+      },
+      {
+        id: "id26",
+        kind: "bloop",
+        label: "hay",
+        language: "hay",
+        enabled: false,
+      },
+    ];
+    const enableAudioTrack = jest.requireActual("../enable_audio_track");
+    expect(enableAudioTrack.default(fakeAudioTracks, 2)).toEqual(true);
+    expect(fakeAudioTracks[0].enabled).toBe(false);
+    expect(fakeAudioTracks[1].enabled).toBe(false);
+    expect(fakeAudioTracks[2].enabled).toBe(true);
+    expect(enableAudioTrack.default(fakeAudioTracks, 1)).toEqual(true);
+    expect(fakeAudioTracks[0].enabled).toBe(false);
+    expect(fakeAudioTracks[1].enabled).toBe(true);
+    expect(fakeAudioTracks[2].enabled).toBe(false);
+    expect(enableAudioTrack.default(fakeAudioTracks, 0)).toEqual(true);
+    expect(fakeAudioTracks[0].enabled).toBe(true);
+    expect(fakeAudioTracks[1].enabled).toBe(false);
+    expect(fakeAudioTracks[2].enabled).toBe(false);
+  });
+
+  it("should enable the wanted audioTrack on Tizen", () => {
+    jest.mock("../browser_detection", () => {
+      return {
+        __esModule: true as const,
+        isTizen: true,
+      };
+    });
+    const fakeAudioTracks = [
+      {
+        id: "id1",
+        kind: "descriptions",
+        label: "Toto",
+        language: "swa",
+        enabled: true,
+      },
+      {
+        id: "id2",
+        kind: "normal",
+        label: "Titi",
+        language: "fre",
+        enabled: false,
+      },
+      {
+        id: "id26",
+        kind: "bloop",
+        label: "hay",
+        language: "hay",
+        enabled: false,
+      },
+    ];
+    const enableAudioTrack = jest.requireActual("../enable_audio_track");
+    expect(enableAudioTrack.default(fakeAudioTracks, 2)).toEqual(true);
+    expect(fakeAudioTracks[0].enabled).toBe(false);
+    expect(fakeAudioTracks[1].enabled).toBe(false);
+    expect(fakeAudioTracks[2].enabled).toBe(true);
+    expect(enableAudioTrack.default(fakeAudioTracks, 1)).toEqual(true);
+    expect(fakeAudioTracks[0].enabled).toBe(false);
+    expect(fakeAudioTracks[1].enabled).toBe(true);
+    expect(fakeAudioTracks[2].enabled).toBe(false);
+    expect(enableAudioTrack.default(fakeAudioTracks, 0)).toEqual(true);
+    expect(fakeAudioTracks[0].enabled).toBe(true);
+    expect(fakeAudioTracks[1].enabled).toBe(false);
+    expect(fakeAudioTracks[2].enabled).toBe(false);
+  });
+
+  it("should return false if the audio track index does not exist", () => {
+    jest.mock("../browser_detection", () => {
+      return {
+        __esModule: true as const,
+        isTizen: false,
+      };
+    });
+    const fakeAudioTracks = [
+      {
+        id: "id1",
+        kind: "descriptions",
+        label: "Toto",
+        language: "swa",
+        enabled: true,
+      },
+      {
+        id: "id2",
+        kind: "normal",
+        label: "Titi",
+        language: "fre",
+        enabled: false,
+      },
+      {
+        id: "id26",
+        kind: "bloop",
+        label: "hay",
+        language: "hay",
+        enabled: false,
+      },
+    ];
+    const enableAudioTrack = jest.requireActual("../enable_audio_track");
+    expect(enableAudioTrack.default(fakeAudioTracks, -1)).toEqual(false);
+    expect(fakeAudioTracks[0].enabled).toBe(false);
+    expect(fakeAudioTracks[1].enabled).toBe(false);
+    expect(fakeAudioTracks[2].enabled).toBe(false);
+    expect(enableAudioTrack.default(fakeAudioTracks, 0)).toEqual(true);
+    expect(fakeAudioTracks[0].enabled).toBe(true);
+    expect(fakeAudioTracks[1].enabled).toBe(false);
+    expect(fakeAudioTracks[2].enabled).toBe(false);
+    expect(enableAudioTrack.default(fakeAudioTracks, 4)).toEqual(false);
+    expect(fakeAudioTracks[0].enabled).toBe(false);
+    expect(fakeAudioTracks[1].enabled).toBe(false);
+    expect(fakeAudioTracks[2].enabled).toBe(false);
+  });
+
+  it("should return false if the audio track index does not exist on Tizen", () => {
+    jest.mock("../browser_detection", () => {
+      return {
+        __esModule: true as const,
+        isTizen: false,
+      };
+    });
+    let track1IsEnabled = true;
+    let track2IsEnabled = false;
+    let track3IsEnabled = false;
+    let track1WasDisabled = 0;
+    let track2WasDisabled = 0;
+    let track3WasDisabled = 0;
+    let track1WasEnabled = 0;
+    let track2WasEnabled = 0;
+    let track3WasEnabled = 0;
+    const fakeAudioTracks = [
+      {
+        id: "id1",
+        kind: "descriptions",
+        label: "Toto",
+        language: "swa",
+        enabled: true,
+      },
+      {
+        id: "id2",
+        kind: "normal",
+        label: "Titi",
+        language: "fre",
+        enabled: false,
+      },
+      {
+        id: "id26",
+        kind: "bloop",
+        label: "hay",
+        language: "hay",
+        enabled: false,
+      },
+    ];
+    Object.defineProperty(fakeAudioTracks[0], "enabled", {
+      enumerable: true,
+      get() : boolean {
+        return track1IsEnabled;
+      },
+      set(enabled : boolean) {
+        if (!enabled) {
+          track1WasDisabled++;
+        } else {
+          track1WasEnabled++;
+        }
+        track1IsEnabled = enabled;
+      },
+    });
+    Object.defineProperty(fakeAudioTracks[1], "enabled", {
+      enumerable: true,
+      get() : boolean {
+        return track2IsEnabled;
+      },
+      set(enabled : boolean) {
+        if (!enabled) {
+          track2WasDisabled++;
+        } else {
+          track2WasEnabled++;
+        }
+        track2IsEnabled = enabled;
+      },
+    });
+    Object.defineProperty(fakeAudioTracks[2], "enabled", {
+      enumerable: true,
+      get() : boolean {
+        return track3IsEnabled;
+      },
+      set(enabled : boolean) {
+        if (!enabled) {
+          track3WasDisabled++;
+        } else {
+          track3WasEnabled++;
+        }
+        track3IsEnabled = enabled;
+      },
+    });
+    const enableAudioTrack = jest.requireActual("../enable_audio_track");
+    expect(enableAudioTrack.default(fakeAudioTracks, 1)).toBe(true);
+    expect(fakeAudioTracks[0].enabled).toBe(false);
+    expect(fakeAudioTracks[1].enabled).toBe(true);
+    expect(fakeAudioTracks[2].enabled).toBe(false);
+    expect(track1IsEnabled).toBe(false);
+    expect(track2IsEnabled).toBe(true);
+    expect(track3IsEnabled).toBe(false);
+    expect(track1WasDisabled).toBe(1);
+    expect(track2WasDisabled).toBe(1);
+    expect(track3WasDisabled).toBe(1);
+    expect(track1WasEnabled).toBe(0);
+    expect(track2WasEnabled).toBe(1);
+    expect(track3WasEnabled).toBe(0);
+  });
+
+  // eslint-disable-next-line max-len
+  it("should first disable all audioTracks except the one wanted by default on Tizen", () => {
+    jest.mock("../browser_detection", () => {
+      return {
+        __esModule: true as const,
+        isTizen: true,
+      };
+    });
+    let track1IsEnabled = true;
+    let track2IsEnabled = false;
+    let track3IsEnabled = false;
+    let track1WasDisabled = 0;
+    let track2WasDisabled = 0;
+    let track3WasDisabled = 0;
+    let track1WasEnabled = 0;
+    let track2WasEnabled = 0;
+    let track3WasEnabled = 0;
+    const fakeAudioTracks = [
+      {
+        id: "id1",
+        kind: "descriptions",
+        label: "Toto",
+        language: "swa",
+        enabled: true,
+      },
+      {
+        id: "id2",
+        kind: "normal",
+        label: "Titi",
+        language: "fre",
+        enabled: false,
+      },
+      {
+        id: "id26",
+        kind: "bloop",
+        label: "hay",
+        language: "hay",
+        enabled: false,
+      },
+    ];
+    Object.defineProperty(fakeAudioTracks[0], "enabled", {
+      enumerable: true,
+      get() : boolean {
+        return track1IsEnabled;
+      },
+      set(enabled : boolean) {
+        if (!enabled) {
+          track1WasDisabled++;
+        } else {
+          track1WasEnabled++;
+        }
+        track1IsEnabled = enabled;
+      },
+    });
+    Object.defineProperty(fakeAudioTracks[1], "enabled", {
+      enumerable: true,
+      get() : boolean {
+        return track2IsEnabled;
+      },
+      set(enabled : boolean) {
+        if (!enabled) {
+          track2WasDisabled++;
+        } else {
+          track2WasEnabled++;
+        }
+        track2IsEnabled = enabled;
+      },
+    });
+    Object.defineProperty(fakeAudioTracks[2], "enabled", {
+      enumerable: true,
+      get() : boolean {
+        return track3IsEnabled;
+      },
+      set(enabled : boolean) {
+        if (!enabled) {
+          track3WasDisabled++;
+        } else {
+          track3WasEnabled++;
+        }
+        track3IsEnabled = enabled;
+      },
+    });
+    const enableAudioTrack = jest.requireActual("../enable_audio_track");
+    expect(enableAudioTrack.default(fakeAudioTracks, 1)).toBe(true);
+    expect(fakeAudioTracks[0].enabled).toBe(false);
+    expect(fakeAudioTracks[1].enabled).toBe(true);
+    expect(fakeAudioTracks[2].enabled).toBe(false);
+    expect(track1IsEnabled).toBe(false);
+    expect(track2IsEnabled).toBe(true);
+    expect(track3IsEnabled).toBe(false);
+    expect(track1WasDisabled).toBe(1);
+    expect(track2WasDisabled).toBe(0);
+    expect(track3WasDisabled).toBe(1);
+    expect(track1WasEnabled).toBe(0);
+    expect(track2WasEnabled).toBe(1);
+    expect(track3WasEnabled).toBe(0);
+  });
+});

src/compat/enable_audio_track.ts

@@ -0,0 +1,33 @@
+import { ICompatAudioTrack } from "./browser_compatibility_types";
+import { isTizen } from "./browser_detection";
+
+/**
+ * Enable the audio track at the given index while disabling all others in the
+ * `audioTracks` array.
+ *
+ * Returns false if the given index is not found in the `audioTracks` array.
+ * @param {array.<audioTrack>} audioTracks
+ * @param {number} indexToEnable
+ * @returns {boolean}
+ */
+export default function enableAudioTrack(
+  audioTracks : ICompatAudioTrack[],
+  indexToEnable : number
+) : boolean {
+  // Seen on Safari MacOS only (2022-02-14), not disabling ALL audio tracks
+  // first (even the wanted one), can lead to the media not playing.
+  for (let i = 0; i < audioTracks.length; i++) {
+    // However, Tizen just plays no audio if it is disabled then enabled
+    // synchronously (2022-10-12)
+    if (!isTizen || i !== indexToEnable) {
+      audioTracks[i].enabled = false;
+    }
+  }
+
+  if (indexToEnable < 0 ||  indexToEnable >= audioTracks.length) {
+    return false;
+  }
+
+  audioTracks[indexToEnable].enabled = true;
+  return true;
+}

src/compat/index.ts

@@ -38,6 +38,7 @@ import {
   requestMediaKeySystemAccess,
   setMediaKeys,
 } from "./eme";
+import enableAudioTrack from "./enable_audio_track";
 import * as events from "./event_listeners";
 import {
   exitFullscreen,
@@ -75,6 +76,7 @@ export {
   clearElementSrc,
   closeSession,
   CustomMediaKeySystemAccess,
+  enableAudioTrack,
   events,
   exitFullscreen,
   generateKeyRequest,