bigbluebutton-Github/bigbluebutton-html5/imports/ui/services/webrtc-base/bbb-video-stream.js

import {
  EFFECT_TYPES,
  BLUR_FILENAME,
  createVirtualBackgroundStream,
} from '/imports/ui/services/virtual-background/service';
import MediaStreamUtils from '/imports/utils/media-stream-utils';
import { EventEmitter2 } from 'eventemitter2';

export default class BBBVideoStream extends EventEmitter2 {
  static isVirtualBackground(type) {
    return type === EFFECT_TYPES.IMAGE_TYPE;
  }

  static trackStreamTermination(stream, handler) {
    const _handler = () => {
      handler({ id: stream?.id });
    };

    // Dirty, but effective way of checking whether the browser supports the 'inactive'
    // event. If the oninactive interface is null, it can be overridden === supported.
    // If undefined, it's not; so we fallback to the track 'ended' event.
    // The track ended listener should probably be reviewed once we create
    // thin wrapper classes for MediaStreamTracks as well, because we'll want a single
    // media stream holding multiple tracks in the future
    if (stream.oninactive === null) {
      stream.addEventListener('inactive', _handler, { once: true });
    } else {
      const track = MediaStreamUtils.getVideoTracks(stream)[0];
      if (track) {
        track.addEventListener('ended', _handler, { once: true });
        // Extra safeguard: Firefox doesn't fire the 'ended' when it should
        // but it invokes the callback (?), so hook up to both
        track.onended = _handler;
      }
    }
  }

  constructor(mediaStream) {
    super();
    this.mediaStream = mediaStream;
    this.originalStream = mediaStream;
    this.effect = null;
    this.virtualBgEnabled = false;
    this.virtualBgService = null;
    this.virtualBgType = EFFECT_TYPES.NONE_TYPE;
    this.virtualBgName = BLUR_FILENAME;
    this.virtualBgUniqueId = null;
    this._trackOriginalStreamTermination();
  }

  set mediaStream(mediaStream) {
    if (!this.mediaStream
      || mediaStream == null
      || mediaStream.id !== this.mediaStream.id) {
      const oldStream = this.mediaStream;
      this._mediaStream = mediaStream;
      this.emit('streamSwapped', {
        oldStream,
        newStream: this.mediaStream,
      });
    }
  }

  get mediaStream() {
    return this._mediaStream;
  }

  set virtualBgService(service) {
    this._virtualBgService = service;
  }

  get virtualBgService() {
    return this._virtualBgService;
  }

  _trackOriginalStreamTermination() {
    const notify = ({ id }) => {
      this.emit('inactive', { id });
    };

    BBBVideoStream.trackStreamTermination(this.originalStream, notify);
  }

  _changeVirtualBackground(type, name, customParams) {
    try {
      this.virtualBgService.changeBackgroundImage({
        type,
        name,
        isVirtualBackground: BBBVideoStream.isVirtualBackground(type),
        customParams,
      });
      this.virtualBgType = type;
      this.virtualBgName = name;
      this.virtualBgUniqueId = customParams?.uniqueId;
      return Promise.resolve();
    } catch (error) {
      return Promise.reject(error);
    }
  }

  startVirtualBackground(type, name = '', customParams) {
    if (this.virtualBgService) return this._changeVirtualBackground(type, name, customParams);

    return createVirtualBackgroundStream(
      type,
      name,
      BBBVideoStream.isVirtualBackground(type),
      this.mediaStream,
      customParams,
    ).then(({ service, effect }) => {
      this.virtualBgService = service;
      this.virtualBgType = type;
      this.virtualBgName = name;
      this.virtualBgUniqueId = customParams?.uniqueId;
      this.originalStream = this.mediaStream;
      this.mediaStream = effect;
      this.isVirtualBackgroundEnabled = true;
    });
  }

  changeCameraBrightness(brightness) {
    if (!this.virtualBgService) return;

    this.virtualBgService.brightness = brightness;
  }

  toggleCameraBrightnessArea(value) {
    if (!this.virtualBgService) return;

    this.virtualBgService.wholeImageBrightness = value;
  }

  stopVirtualBackground() {
    if (this.virtualBgService != null) {
      this.virtualBgService.stopEffect();
      this.virtualBgService = null;
    }

    this.virtualBgType = EFFECT_TYPES.NONE_TYPE;
    this.virtualBgName = undefined;
    this.virtualBgUniqueId = null;
    this.mediaStream = this.originalStream;
    this.isVirtualBackgroundEnabled = false;
  }

  stop() {
    if (this.isVirtualBackgroundEnabled) {
      this.stopVirtualBackground();
    }

    MediaStreamUtils.stopMediaStreamTracks(this.mediaStream);
    this.originalStream = null;
    this.mediaStream = null;
  }
}