@100mslive/roomkit-react 0.4.3-alpha.3 → 0.4.3-alpha.4

package/src/Prebuilt/components/PIP/PIPManager.ts

@@ -1,335 +0,0 @@
-import * as workerTimers from 'worker-timers';
-import { HMSActions, HMSPeer, HMSTrack, HMSVideoTrack } from '@100mslive/react-sdk';
-// @ts-ignore: No implicit any
-import { drawVideoElementsOnCanvas, dummyChangeInCanvas, resetPIPCanvasColors } from './pipUtils';
-import { isIOS, isMacOS, isSafari } from '../../common/constants';
-const MAX_NUMBER_OF_TILES_IN_PIP = 4;
-const DEFAULT_FPS = 30;
-const DEFAULT_CANVAS_WIDTH = 480;
-const DEFAULT_CANVAS_HEIGHT = 320;
-const LEAVE_EVENT_NAME = 'leavepictureinpicture';
-
-enum PIPStates {
-  starting = 'starting',
-  started = 'started',
-  stopping = 'stopping',
-  stopped = 'stopped',
-}
-
-/**
- * video elements are stitched together as a canvas which is converted to
- * another video element converted to PIP.
- * The task is split into two parts -
- * 1. a function which gets hit when the input changes and updates the tracks
- * to show
- * 2. an independent loop which updates the canvas periodically based on the current
- * tracks which should be shown.
- */
-class PipManager {
-  private listeners = new Set<(value: boolean) => void>();
-  private canvas: HTMLCanvasElement | null = null;
-  private pipVideo: HTMLVideoElement | null = null;
-  private hmsActions: HMSActions | null = null;
-  private timeoutRef = 0;
-  private videoElements: HTMLVideoElement[] = [];
-  private onStateChange: ((value: boolean) => void) | null = null;
-  private tracksToShow: Array<string> = [];
-  private state: PIPStates = PIPStates.stopped;
-
-  constructor() {
-    this.reset();
-  }
-
-  listenToStateChange(cb: (value: boolean) => void) {
-    this.listeners.add(cb);
-  }
-
-  /**
-   * @private
-   */
-  reset() {
-    console.debug('resetting PIP state');
-    resetPIPCanvasColors();
-    this.canvas = null; // where stitching will take place
-    this.pipVideo = null; // the element which will be sent in PIP
-    this.timeoutRef = 0; // setTimeout reference so it can be cancelled
-    this.hmsActions = null; // for attaching detaching
-    this.videoElements = []; // for attaching tracks
-    this.tracksToShow = [];
-    this.onStateChange = null; // for user of this class to listen to changes
-    this.state = PIPStates.stopped;
-  }
-
-  /**
-   * check if PIP is supported in this browser env
-   */
-  isSupported() {
-    return !!document.pictureInPictureEnabled && !isIOS && !(isMacOS && isSafari);
-  }
-
-  /**
-   * check if pip is currently turned on
-   */
-  isOn() {
-    return !!document.pictureInPictureElement;
-  }
-
-  /**
-   * request browser to start pip and start the render loop updating the pip
-   * video element with peer tracks.
-   * @param hmsActions
-   * @param onStateChangeFn {function(bool):void} callback called to notify change in pip state
-   */
-  async start(hmsActions: HMSActions, onStateChangeFn: (value: boolean) => void): Promise<void> {
-    if (!this.isSupported()) {
-      throw new Error('pip is not supported on this browser');
-    }
-    console.debug('starting PIP, current state', this.state);
-    if (this.state === PIPStates.started) {
-      await this.stop(); // if anything is already running
-    } else if (this.state === PIPStates.starting) {
-      return; // ignore double clicks
-    }
-    this.state = PIPStates.starting;
-    try {
-      await this.init(hmsActions, onStateChangeFn);
-      // when user closes pip, call internal stop
-      this.pipVideo?.addEventListener(LEAVE_EVENT_NAME, this.stop);
-      this.renderLoop();
-      if (!this.isOn()) {
-        await this.requestPIP();
-      }
-      console.debug('pip started');
-      this.state = PIPStates.started;
-      this.onStateChange?.(true);
-      this.callListeners(true);
-    } catch (err) {
-      console.error('error in request pip', err);
-      this.state = PIPStates.stopped;
-    }
-  }
-
-  stop = async () => {
-    if (this.state === PIPStates.stopped) {
-      return;
-    }
-    this.state = PIPStates.stopping;
-    this.pipVideo?.removeEventListener(LEAVE_EVENT_NAME, this.stop);
-    if (this.timeoutRef) {
-      workerTimers.clearTimeout(this.timeoutRef);
-      this.timeoutRef = 0;
-    }
-    if (this.isOn()) {
-      this.exitPIP();
-    }
-    // detach all to avoid bandwidth consumption
-    await this.detachOldAttachNewTracks(this.tracksToShow, []);
-    this.onStateChange?.(false); // notify parent about this
-    this.callListeners(false);
-    this.reset(); // cleanup
-    this.state = PIPStates.stopped;
-  };
-
-  /**
-   * @param peers {Array} All Remote Peers present in call.
-   * @param tracksMap {Object} map of track id to track
-   * */
-  async updatePeersAndTracks(peers: HMSPeer[], tracksMap: Record<string, HMSTrack>) {
-    if (!this.canvas) {
-      console.log('no canvas to render video to');
-      return;
-    }
-    const newTracksToShowUnordered = this.pickTracksToShow(peers, tracksMap);
-    const currentTracksShowing = this.tracksToShow;
-    this.tracksToShow = this.orderNewTracksToShow(newTracksToShowUnordered, currentTracksShowing);
-    try {
-      await this.detachOldAttachNewTracks(currentTracksShowing, this.tracksToShow, tracksMap);
-    } catch (error) {
-      console.error('error in detaching/attaching tracks', error);
-    }
-  }
-
-  // ------- Private function --------------
-  /**
-   * @private {boolean} on - whether pip is on/off
-   */
-  callListeners = (on: boolean) => {
-    this.listeners.forEach(listener => listener?.(on));
-  };
-
-  /**
-   * @private
-   */
-  async init(hmsActions: HMSActions, onStateChangeFn: (value: boolean) => void) {
-    await this.initMediaElements();
-    this.hmsActions = hmsActions;
-    this.onStateChange = onStateChangeFn;
-  }
-
-  async initMediaElements() {
-    if (!this.canvas) {
-      const { canvas, pipVideo } = this.initializeCanvasAndVideoElement();
-      this.canvas = canvas; // where stitching will take place
-      this.pipVideo = pipVideo; // the element which will be sent in PIP
-      this.videoElements = this.initializeVideoElements(); // for attaching tracks
-      const videoPlayPromise = this.pipVideo.play();
-      dummyChangeInCanvas(this.canvas);
-      await videoPlayPromise;
-    }
-  }
-
-  initializeCanvasAndVideoElement() {
-    const canvas = document.createElement('canvas');
-    canvas.width = DEFAULT_CANVAS_WIDTH;
-    canvas.height = DEFAULT_CANVAS_HEIGHT;
-    const pipVideo = document.createElement('video');
-    pipVideo.width = DEFAULT_CANVAS_WIDTH;
-    pipVideo.height = DEFAULT_CANVAS_HEIGHT;
-    pipVideo.muted = true;
-    pipVideo.srcObject = canvas.captureStream();
-    return { canvas, pipVideo };
-  }
-
-  initializeVideoElements() {
-    const videoElements = [];
-    for (let i = 0; i < MAX_NUMBER_OF_TILES_IN_PIP; i++) {
-      const videoElement = document.createElement('video');
-      videoElement.autoplay = true;
-      videoElement.playsInline = true;
-      videoElements.push(videoElement);
-    }
-    return videoElements;
-  }
-
-  /**
-   * render loop is responsible for rendering the video elements on canvas/pip.
-   * in each loop current video elements are stitched and painted on canvas
-   */
-  renderLoop() {
-    const delay = 1000 / DEFAULT_FPS;
-    this.timeoutRef = workerTimers.setTimeout(() => {
-      if (this.state === PIPStates.stopping || this.state === PIPStates.stopped) {
-        return;
-      }
-      if (this.state === PIPStates.started) {
-        drawVideoElementsOnCanvas(this.videoElements, this.canvas);
-      }
-      this.renderLoop();
-    }, delay);
-  }
-
-  async requestPIP() {
-    try {
-      if (this.isOn()) {
-        this.exitPIP(); // is this really needed?
-      }
-      if (!this.pipVideo) {
-        return;
-      }
-      await this.pipVideo.requestPictureInPicture();
-    } catch (error) {
-      console.error('error in requestpip', error, 'state', this.state);
-      throw error;
-    }
-  }
-
-  exitPIP() {
-    document.exitPictureInPicture();
-  }
-
-  /**
-   * Logic - pick only enabled video tracks
-   * @param peers {Array<any>}
-   * @param tracksMap {Record<string, any>}
-   */
-  pickTracksToShow(peers: HMSPeer[], tracksMap: Record<string, HMSTrack>) {
-    const tracksToShow = new Set<string>();
-    for (const peer of peers) {
-      if (tracksToShow.size === MAX_NUMBER_OF_TILES_IN_PIP) {
-        break;
-      } else if (peer.videoTrack && this.showTrack(tracksMap[peer.videoTrack] as HMSVideoTrack)) {
-        tracksToShow.add(peer.videoTrack);
-      }
-    }
-    return Array.from(tracksToShow);
-  }
-
-  /**
-   * there has to be a smart reordering of new tracks based on currently showing
-   * ones to reduce unnecessary displacement. If someone was showing up both
-   * earlier and now, it's a better UX to keep their position same instead
-   * of letting it change.
-   * The returned array is a shuffled version of newTracks with position of
-   * tracks present in the old tracks intact.
-   * eg. old = [1,5,9,3], new = [3,8,2,9], result = [8,2,9,3]
-   * @param oldTracks {Array}
-   * @param newTracks {Array}
-   * @return {Array}
-   */
-  orderNewTracksToShow(newTracks: string[], oldTracks: string[]) {
-    const betterNewTracks: Array<string> = new Array(newTracks.length);
-    const leftOvers: Array<string> = [];
-    // put the common ones in right position
-    newTracks.forEach(track => {
-      const oldPosition = oldTracks.indexOf(track);
-      if (oldPosition !== -1 && oldPosition < newTracks.length) {
-        // if track is there currently and we can put it on the same position
-        betterNewTracks[oldPosition] = track;
-      } else {
-        leftOvers.push(track);
-      }
-    });
-    // put the left overs in remaining empty positions
-    for (let i = 0; i < newTracks.length; i++) {
-      if (!betterNewTracks[i]) {
-        const newEntry = leftOvers.shift();
-        if (newEntry) {
-          betterNewTracks[i] = newEntry;
-        }
-      }
-    }
-    return Array.from(new Set(betterNewTracks));
-  }
-
-  private showTrack(track: HMSVideoTrack | undefined) {
-    return track && track.enabled && !track.degraded;
-  }
-
-  /**
-   * call detach for tracks which no longer need to be shown and attach for
-   * new ones which are to be shown now.
-   * Note: oldTracks and newTracks are not necessarily of same length
-   * @param oldTracks {Array<String>}
-   * @param newTracks {Array<String>}
-   * @param tracksMap {Record<String, any>}
-   */
-  // eslint-disable-next-line complexity
-  async detachOldAttachNewTracks(
-    oldTracks: Array<string>,
-    newTracks: Array<string>,
-    tracksMap: Record<string, HMSTrack> | null = null,
-  ) {
-    const numTracks = Math.max(oldTracks.length, newTracks.length);
-    for (let i = 0; i < numTracks; i++) {
-      if (oldTracks[i] === newTracks[i]) {
-        continue; // it would already have been attached previously
-      } else if (oldTracks[i]) {
-        // old track is there but not equal to new track, detach
-        // no need to call detach if we know for sure track is no longer in store
-        if (!tracksMap || tracksMap[oldTracks[i]]) {
-          await this.hmsActions?.detachVideo(oldTracks[i], this.videoElements[i]);
-        }
-        if (this.videoElements[i]) {
-          // even if old track got removed from the room, element needs to be cleaned up
-          this.videoElements[i].srcObject = null;
-        }
-      }
-      if (newTracks[i]) {
-        await this.hmsActions?.attachVideo(newTracks[i], this.videoElements[i]);
-      }
-    }
-  }
-}
-
-export const PictureInPicture = new PipManager();
-// PictureInPicture.initMediaElements().catch(console.error);  // for safari, init early

package/src/Prebuilt/components/PIP/PIPProvider.tsx

@@ -1,56 +0,0 @@
-import React, { useCallback, useMemo, useState } from 'react';
-import { PIPContext } from './context';
-
-type PIPProviderProps = {
-  children: React.ReactNode;
-};
-
-export const PIPProvider = ({ children }: PIPProviderProps) => {
-  // Detect if the feature is available.
-  const isSupported = 'documentPictureInPicture' in window;
-
-  // Expose pipWindow that is currently active
-  const [pipWindow, setPipWindow] = useState<Window | null>(null);
-
-  // Close pipWidnow programmatically
-  const closePipWindow = useCallback(() => {
-    if (pipWindow != null) {
-      pipWindow.close();
-      setPipWindow(null);
-    }
-  }, [pipWindow]);
-
-  // Open new pipWindow
-  const requestPipWindow = useCallback(
-    async (width: number, height: number) => {
-      // We don't want to allow multiple requests.
-      if (pipWindow != null) {
-        return;
-      }
-      // @ts-ignore for documentPIP
-      const pip = await window.documentPictureInPicture.requestWindow({
-        width,
-        height,
-      });
-
-      // Detect when window is closed by user
-      pip.addEventListener('pagehide', () => {
-        setPipWindow(null);
-      });
-
-      setPipWindow(pip);
-    },
-    [pipWindow],
-  );
-
-  const value = useMemo(() => {
-    return {
-      isSupported,
-      pipWindow,
-      requestPipWindow,
-      closePipWindow,
-    };
-  }, [closePipWindow, isSupported, pipWindow, requestPipWindow]);
-
-  return <PIPContext.Provider value={value}>{children}</PIPContext.Provider>;
-};

package/src/Prebuilt/components/PIP/PIPWindow.tsx

@@ -1,13 +0,0 @@
-import React from 'react';
-import { createPortal } from 'react-dom';
-
-type PIPWindowProps = {
-  pipWindow: Window;
-  children: React.ReactNode;
-};
-
-export const PIPWindow = ({ pipWindow, children }: PIPWindowProps) => {
-  pipWindow.document.body.style.margin = '0';
-  pipWindow.document.body.style.overflow = 'clip';
-  return createPortal(children, pipWindow.document.body);
-};

package/src/Prebuilt/components/PIP/SetupMediaSession.js

@@ -1,60 +0,0 @@
-import { selectIsLocalAudioEnabled, selectIsLocalVideoEnabled } from '@100mslive/react-sdk';
-
-/**
- * Media Session API allows for handling control actions on top of pip
- * https://web.dev/media-session/#video-conferencing-actions
- */
-class SetupMediaSession {
-  setup = (actions, store) => {
-    this.actions = actions;
-    this.store = store;
-    this.initState();
-    this.setUpHandlers();
-  };
-
-  initState = () => {
-    const isMicActive = this.store.getState(selectIsLocalAudioEnabled);
-    const isCamActive = this.store.getState(selectIsLocalVideoEnabled);
-    navigator.mediaSession?.setMicrophoneActive?.(isMicActive);
-    navigator.mediaSession?.setCameraActive?.(isCamActive);
-
-    this.store.subscribe(isMicActive => {
-      navigator.mediaSession?.setMicrophoneActive?.(isMicActive);
-    }, selectIsLocalAudioEnabled);
-
-    this.store.subscribe(isCamActive => {
-      navigator.mediaSession?.setCameraActive?.(isCamActive);
-    }, selectIsLocalVideoEnabled);
-  };
-
-  toggleMic = async () => {
-    console.log('toggle mic clicked in pip');
-    const current = this.store.getState(selectIsLocalAudioEnabled);
-    await this.actions.setLocalAudioEnabled(!current);
-  };
-
-  toggleCam = async () => {
-    console.log('toggle cam clicked in pip');
-    const current = this.store.getState(selectIsLocalVideoEnabled);
-    await this.actions.setLocalVideoEnabled(!current);
-  };
-
-  leave = () => {
-    console.log('leave called from pip');
-    this.actions.leave();
-  };
-
-  setUpHandlers = () => {
-    if (navigator.mediaSession) {
-      try {
-        navigator.mediaSession.setActionHandler('togglemicrophone', this.toggleMic);
-        navigator.mediaSession.setActionHandler('togglecamera', this.toggleCam);
-        navigator.mediaSession.setActionHandler('hangup', this.leave);
-      } catch (err) {
-        console.error('error in setting media session handlers', err);
-      }
-    }
-  };
-}
-
-export const MediaSession = new SetupMediaSession();

package/src/Prebuilt/components/PIP/context.ts

@@ -1,10 +0,0 @@
-import { createContext } from 'react';
-
-export type PIPContextType = {
-  isSupported: boolean;
-  pipWindow: Window | null;
-  requestPipWindow: (width: number, height: number) => Promise<void>;
-  closePipWindow: () => void;
-};
-
-export const PIPContext = createContext<PIPContextType | undefined>(undefined);

package/src/Prebuilt/components/PIP/index.jsx

@@ -1,6 +0,0 @@
-import React from 'react';
-import PIPComponent from './PIPComponent';
-
-export const PIP = ({ content = null }) => {
-  return <PIPComponent content={content} />;
-};

package/src/Prebuilt/components/PIP/pip.test.js

@@ -1,72 +0,0 @@
-import { PictureInPicture } from './PIPManager';
-
-describe('pip manager tests', () => {
-  /**
-   * Ensure that if a track is showing in both before and after, it's at the
-   * same position.
-   */
-  test('merging old and new tracks to show avoids shuffling', () => {
-    const makeTestData = (oldArr, newArr, result) => {
-      return { oldArr, newArr, result };
-    };
-
-    const examples = [
-      makeTestData([1, 5, 9, 3], [3, 8, 2, 9], [8, 2, 9, 3]),
-      makeTestData([1, 3, 5], [5, 3, 1], [1, 3, 5]),
-      makeTestData([2, 7, 9, 4], [9, 2, 4, 6], [2, 6, 9, 4]),
-      makeTestData([1, 2, 3], [4, 5, 6], [4, 5, 6]),
-      makeTestData([1, 2], [4, 5, 2, 1], [1, 2, 4, 5]),
-      makeTestData([4, 1, 2, 3], [1, 3], [3, 1]),
-      makeTestData([4, 5, 1, 3], [1, 3], [1, 3]),
-      makeTestData([], [1, 3], [1, 3]),
-      makeTestData([1, 3], [], []),
-      makeTestData([1], [4, 2, 1, 3], [1, 4, 2, 3]),
-      makeTestData([4, 2, 1, 3], [1], [1]),
-      makeTestData([], [], []),
-    ];
-
-    examples.forEach(example => {
-      expect(PictureInPicture.orderNewTracksToShow(example.newArr, example.oldArr)).toEqual(example.result);
-    });
-  });
-
-  /**
-   * It's very important that detach is properly called for old tracks to guarantee
-   * no unnecessary bandwidth consumption.
-   * For simplicity's sake currently, detach/attach is done if position of
-   * the track changes as well. That is earlier it was showing on third position
-   * but not it's on second position(because there are only two tracks left to show).
-   */
-  test('attach and detach are called properly after tracks in view changes', async () => {
-    const makeTestData = (oldTracks, newTracks, detachFor, attachFor) => {
-      return { oldTracks, newTracks, detachFor, attachFor };
-    };
-
-    let attachCalledFor = [];
-    let detachCalledFor = [];
-    PictureInPicture.hmsActions = {
-      attachVideo: jest.fn(track => attachCalledFor.push(track)),
-      detachVideo: jest.fn(track => detachCalledFor.push(track)),
-    };
-
-    const examples = [
-      makeTestData([1, 2], [3, 4], [1, 2], [3, 4]),
-      makeTestData([1, 2], [1, 2], [], []),
-      makeTestData([1, 5, 9, 3], [8, 2, 9, 3], [1, 5], [8, 2]),
-      makeTestData([1, 5, 9], [6, 5, 9], [1], [6]),
-      makeTestData([], [1, 3], [], [1, 3]),
-      makeTestData([1, 3], [], [1, 3], []),
-      makeTestData([1], [4, 2, 1, 3], [1], [4, 2, 1, 3]),
-      makeTestData([4, 2, 1, 3], [1], [4, 2, 1, 3], [1]),
-      makeTestData([], [], [], []),
-    ];
-
-    for (let example of examples) {
-      attachCalledFor = [];
-      detachCalledFor = [];
-      await PictureInPicture.detachOldAttachNewTracks(example.oldTracks, example.newTracks);
-      expect(attachCalledFor).toEqual(example.attachFor);
-      expect(detachCalledFor).toEqual(example.detachFor);
-    }
-  });
-});