/* Copyright 2015, 2016 OpenMarket Ltd Copyright 2019, 2020 The Matrix.org Foundation C.I.C. 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 React, { createRef, CSSProperties } from 'react'; import dis from '../../../dispatcher/dispatcher'; import CallHandler from '../../../CallHandler'; import { MatrixClientPeg } from '../../../MatrixClientPeg'; import { _t, _td } from '../../../languageHandler'; import VideoFeed from './VideoFeed'; import RoomAvatar from "../avatars/RoomAvatar"; import { CallState, CallType, MatrixCall, CallEvent } from 'matrix-js-sdk/src/webrtc/call'; import classNames from 'classnames'; import AccessibleButton from '../elements/AccessibleButton'; import { isOnlyCtrlOrCmdKeyEvent, Key } from '../../../Keyboard'; import { alwaysAboveLeftOf, alwaysAboveRightOf, ChevronFace, ContextMenuButton } from '../../structures/ContextMenu'; import CallContextMenu from '../context_menus/CallContextMenu'; import { avatarUrlForMember } from '../../../Avatar'; import DialpadContextMenu from '../context_menus/DialpadContextMenu'; import { CallFeed } from 'matrix-js-sdk/src/webrtc/callFeed'; import { replaceableComponent } from "../../../utils/replaceableComponent"; import DesktopCapturerSourcePicker from "../elements/DesktopCapturerSourcePicker"; import Modal from '../../../Modal'; import { SDPStreamMetadataPurpose } from 'matrix-js-sdk/src/webrtc/callEventTypes'; import CallViewSidebar from './CallViewSidebar'; interface IProps { // The call for us to display call: MatrixCall; // Another ongoing call to display information about secondaryCall?: MatrixCall; // a callback which is called when the content in the CallView changes // in a way that is likely to cause a resize. onResize?: any; // Whether this call view is for picture-in-picture mode // otherwise, it's the larger call view when viewing the room the call is in. // This is sort of a proxy for a number of things but we currently have no // need to control those things separately, so this is simpler. pipMode?: boolean; // Used for dragging the PiP CallView onMouseDownOnHeader?: (event: React.MouseEvent) => void; } interface IState { isLocalOnHold: boolean; isRemoteOnHold: boolean; micMuted: boolean; vidMuted: boolean; screensharing: boolean; callState: CallState; controlsVisible: boolean; showMoreMenu: boolean; showDialpad: boolean; primaryFeed: CallFeed; secondaryFeeds: Array; sidebarShown: boolean; } function getFullScreenElement() { return ( document.fullscreenElement || // moz omitted because firefox supports this unprefixed now (webkit here for safari) document.webkitFullscreenElement || document.msFullscreenElement ); } function requestFullscreen(element: Element) { const method = ( element.requestFullscreen || // moz omitted since firefox supports unprefixed now element.webkitRequestFullScreen || element.msRequestFullscreen ); if (method) method.call(element); } function exitFullscreen() { const exitMethod = ( document.exitFullscreen || document.webkitExitFullscreen || document.msExitFullscreen ); if (exitMethod) exitMethod.call(document); } const CONTROLS_HIDE_DELAY = 1000; // Height of the header duplicated from CSS because we need to subtract it from our max // height to get the max height of the video const CONTEXT_MENU_VPADDING = 8; // How far the context menu sits above the button (px) @replaceableComponent("views.voip.CallView") export default class CallView extends React.Component { private dispatcherRef: string; private contentRef = createRef(); private controlsHideTimer: number = null; private dialpadButton = createRef(); private contextMenuButton = createRef(); constructor(props: IProps) { super(props); const { primary, secondary } = this.getOrderedFeeds(this.props.call.getFeeds()); this.state = { isLocalOnHold: this.props.call.isLocalOnHold(), isRemoteOnHold: this.props.call.isRemoteOnHold(), micMuted: this.props.call.isMicrophoneMuted(), vidMuted: this.props.call.isLocalVideoMuted(), screensharing: this.props.call.isScreensharing(), callState: this.props.call.state, controlsVisible: true, showMoreMenu: false, showDialpad: false, primaryFeed: primary, secondaryFeeds: secondary, sidebarShown: true, }; this.updateCallListeners(null, this.props.call); } public componentDidMount() { this.dispatcherRef = dis.register(this.onAction); document.addEventListener('keydown', this.onNativeKeyDown); } public componentWillUnmount() { if (getFullScreenElement()) { exitFullscreen(); } document.removeEventListener("keydown", this.onNativeKeyDown); this.updateCallListeners(this.props.call, null); dis.unregister(this.dispatcherRef); } public componentDidUpdate(prevProps) { if (this.props.call === prevProps.call) return; this.setState({ isLocalOnHold: this.props.call.isLocalOnHold(), isRemoteOnHold: this.props.call.isRemoteOnHold(), micMuted: this.props.call.isMicrophoneMuted(), vidMuted: this.props.call.isLocalVideoMuted(), callState: this.props.call.state, }); this.updateCallListeners(null, this.props.call); } private onAction = (payload) => { switch (payload.action) { case 'video_fullscreen': { if (!this.contentRef.current) { return; } if (payload.fullscreen) { requestFullscreen(this.contentRef.current); } else if (getFullScreenElement()) { exitFullscreen(); } break; } } }; private updateCallListeners(oldCall: MatrixCall, newCall: MatrixCall) { if (oldCall === newCall) return; if (oldCall) { oldCall.removeListener(CallEvent.State, this.onCallState); oldCall.removeListener(CallEvent.LocalHoldUnhold, this.onCallLocalHoldUnhold); oldCall.removeListener(CallEvent.RemoteHoldUnhold, this.onCallRemoteHoldUnhold); oldCall.removeListener(CallEvent.FeedsChanged, this.onFeedsChanged); } if (newCall) { newCall.on(CallEvent.State, this.onCallState); newCall.on(CallEvent.LocalHoldUnhold, this.onCallLocalHoldUnhold); newCall.on(CallEvent.RemoteHoldUnhold, this.onCallRemoteHoldUnhold); newCall.on(CallEvent.FeedsChanged, this.onFeedsChanged); } } private onCallState = (state) => { this.setState({ callState: state, }); }; private onFeedsChanged = (newFeeds: Array) => { const { primary, secondary } = this.getOrderedFeeds(newFeeds); this.setState({ primaryFeed: primary, secondaryFeeds: secondary, }); }; private onCallLocalHoldUnhold = () => { this.setState({ isLocalOnHold: this.props.call.isLocalOnHold(), }); }; private onCallRemoteHoldUnhold = () => { this.setState({ isRemoteOnHold: this.props.call.isRemoteOnHold(), // update both here because isLocalOnHold changes when we hold the call too isLocalOnHold: this.props.call.isLocalOnHold(), }); }; private onFullscreenClick = () => { dis.dispatch({ action: 'video_fullscreen', fullscreen: true, }); }; private onExpandClick = () => { const userFacingRoomId = CallHandler.sharedInstance().roomIdForCall(this.props.call); dis.dispatch({ action: 'view_room', room_id: userFacingRoomId, }); }; private onControlsHideTimer = () => { this.controlsHideTimer = null; this.setState({ controlsVisible: false, }); }; private onMouseMove = () => { this.showControls(); }; private getOrderedFeeds(feeds: Array): { primary: CallFeed, secondary: Array } { let primary; // Try to use a screensharing as primary, a remote one if possible const screensharingFeeds = feeds.filter((feed) => feed.purpose === SDPStreamMetadataPurpose.Screenshare); primary = screensharingFeeds.find((feed) => !feed.isLocal()) || screensharingFeeds[0]; // If we didn't find remote screen-sharing stream, try to find any remote stream if (!primary) { primary = feeds.find((feed) => !feed.isLocal()); } const secondary = [...feeds]; // Remove the primary feed from the array if (primary) secondary.splice(secondary.indexOf(primary), 1); secondary.sort((a, b) => { if (a.isLocal() && !b.isLocal()) return -1; if (!a.isLocal() && b.isLocal()) return 1; return 0; }); return { primary, secondary }; } private showControls(): void { if (this.state.showMoreMenu || this.state.showDialpad) return; if (!this.state.controlsVisible) { this.setState({ controlsVisible: true, }); } if (this.controlsHideTimer !== null) { clearTimeout(this.controlsHideTimer); } this.controlsHideTimer = window.setTimeout(this.onControlsHideTimer, CONTROLS_HIDE_DELAY); } private onDialpadClick = (): void => { if (!this.state.showDialpad) { if (this.controlsHideTimer) { clearTimeout(this.controlsHideTimer); this.controlsHideTimer = null; } this.setState({ showDialpad: true, controlsVisible: true, }); } else { if (this.controlsHideTimer !== null) { clearTimeout(this.controlsHideTimer); } this.controlsHideTimer = window.setTimeout(this.onControlsHideTimer, CONTROLS_HIDE_DELAY); this.setState({ showDialpad: false, }); } }; private onMicMuteClick = (): void => { const newVal = !this.state.micMuted; this.props.call.setMicrophoneMuted(newVal); this.setState({ micMuted: newVal }); }; private onVidMuteClick = (): void => { const newVal = !this.state.vidMuted; this.props.call.setLocalVideoMuted(newVal); this.setState({ vidMuted: newVal }); }; private onScreenshareClick = async (): Promise => { const isScreensharing = await this.props.call.setScreensharingEnabled( !this.state.screensharing, async (): Promise => { const { finished } = Modal.createDialog(DesktopCapturerSourcePicker); const [source] = await finished; return source; }, ); this.setState({ sidebarShown: true, screensharing: isScreensharing, }); }; private onMoreClick = (): void => { if (this.controlsHideTimer) { clearTimeout(this.controlsHideTimer); this.controlsHideTimer = null; } this.setState({ showMoreMenu: true, controlsVisible: true, }); }; private closeDialpad = (): void => { this.setState({ showDialpad: false, }); this.controlsHideTimer = window.setTimeout(this.onControlsHideTimer, CONTROLS_HIDE_DELAY); }; private closeContextMenu = (): void => { this.setState({ showMoreMenu: false, }); this.controlsHideTimer = window.setTimeout(this.onControlsHideTimer, CONTROLS_HIDE_DELAY); }; // we register global shortcuts here, they *must not conflict* with local shortcuts elsewhere or both will fire // Note that this assumes we always have a CallView on screen at any given time // CallHandler would probably be a better place for this private onNativeKeyDown = (ev): void => { let handled = false; const ctrlCmdOnly = isOnlyCtrlOrCmdKeyEvent(ev); switch (ev.key) { case Key.D: if (ctrlCmdOnly) { this.onMicMuteClick(); // show the controls to give feedback this.showControls(); handled = true; } break; case Key.E: if (ctrlCmdOnly) { this.onVidMuteClick(); // show the controls to give feedback this.showControls(); handled = true; } break; } if (handled) { ev.stopPropagation(); ev.preventDefault(); } }; private onRoomAvatarClick = (): void => { const userFacingRoomId = CallHandler.sharedInstance().roomIdForCall(this.props.call); dis.dispatch({ action: 'view_room', room_id: userFacingRoomId, }); }; private onSecondaryRoomAvatarClick = (): void => { const userFacingRoomId = CallHandler.sharedInstance().roomIdForCall(this.props.secondaryCall); dis.dispatch({ action: 'view_room', room_id: userFacingRoomId, }); }; private onCallResumeClick = (): void => { const userFacingRoomId = CallHandler.sharedInstance().roomIdForCall(this.props.call); CallHandler.sharedInstance().setActiveCallRoomId(userFacingRoomId); }; private onTransferClick = (): void => { const transfereeCall = CallHandler.sharedInstance().getTransfereeForCallId(this.props.call.callId); this.props.call.transferToCall(transfereeCall); }; private onHangupClick = (): void => { dis.dispatch({ action: 'hangup', room_id: CallHandler.sharedInstance().roomIdForCall(this.props.call), }); }; private onToggleSidebar = (): void => { this.setState({ sidebarShown: !this.state.sidebarShown, }); }; private renderCallControls(): JSX.Element { const micClasses = classNames({ mx_CallView_callControls_button: true, mx_CallView_callControls_button_micOn: !this.state.micMuted, mx_CallView_callControls_button_micOff: this.state.micMuted, }); const vidClasses = classNames({ mx_CallView_callControls_button: true, mx_CallView_callControls_button_vidOn: !this.state.vidMuted, mx_CallView_callControls_button_vidOff: this.state.vidMuted, }); const screensharingClasses = classNames({ mx_CallView_callControls_button: true, mx_CallView_callControls_button_screensharingOn: this.state.screensharing, mx_CallView_callControls_button_screensharingOff: !this.state.screensharing, }); const sidebarButtonClasses = classNames({ mx_CallView_callControls_button: true, mx_CallView_callControls_button_sidebarOn: this.state.sidebarShown, mx_CallView_callControls_button_sidebarOff: !this.state.sidebarShown, }); // Put the other states of the mic/video icons in the document to make sure they're cached // (otherwise the icon disappears briefly when toggled) const micCacheClasses = classNames({ mx_CallView_callControls_button: true, mx_CallView_callControls_button_micOn: this.state.micMuted, mx_CallView_callControls_button_micOff: !this.state.micMuted, mx_CallView_callControls_button_invisible: true, }); const vidCacheClasses = classNames({ mx_CallView_callControls_button: true, mx_CallView_callControls_button_vidOn: this.state.micMuted, mx_CallView_callControls_button_vidOff: !this.state.micMuted, mx_CallView_callControls_button_invisible: true, }); const callControlsClasses = classNames({ mx_CallView_callControls: true, mx_CallView_callControls_hidden: !this.state.controlsVisible, }); // We don't support call upgrades (yet) so hide the video mute button in voice calls let vidMuteButton; if (this.props.call.type === CallType.Video) { vidMuteButton = ( ); } // Screensharing is possible, if we can send a second stream and // identify it using SDPStreamMetadata or if we can replace the already // existing usermedia track by a screensharing track. We also need to be // connected to know the state of the other side let screensharingButton; if ( (this.props.call.opponentSupportsSDPStreamMetadata() || this.props.call.type === CallType.Video) && this.props.call.state === CallState.Connected ) { screensharingButton = ( ); } // To show the sidebar we need secondary feeds, if we don't have them, // we can hide this button. If we are in PiP, sidebar is also hidden, so // we can hide the button too let sidebarButton; if ( !this.props.pipMode && ( this.state.primaryFeed?.purpose === SDPStreamMetadataPurpose.Screenshare || this.props.call.isScreensharing() ) ) { sidebarButton = ( ); } // The dial pad & 'more' button actions are only relevant in a connected call // When not connected, we have to put something there to make the flexbox alignment correct let dialpadButton; let contextMenuButton; if (this.state.callState === CallState.Connected) { contextMenuButton = ( ); dialpadButton = ( ); } return (
{ dialpadButton } { vidMuteButton }
{ screensharingButton } { sidebarButton } { contextMenuButton }
); } public render() { const client = MatrixClientPeg.get(); const callRoomId = CallHandler.sharedInstance().roomIdForCall(this.props.call); const secondaryCallRoomId = CallHandler.sharedInstance().roomIdForCall(this.props.secondaryCall); const callRoom = client.getRoom(callRoomId); const secCallRoom = this.props.secondaryCall ? client.getRoom(secondaryCallRoomId) : null; const avatarSize = this.props.pipMode ? 76 : 160; const transfereeCall = CallHandler.sharedInstance().getTransfereeForCallId(this.props.call.callId); const isOnHold = this.state.isLocalOnHold || this.state.isRemoteOnHold; const isScreensharing = this.props.call.isScreensharing(); const sidebarShown = this.state.sidebarShown; let contentView: React.ReactNode; let holdTransferContent; if (transfereeCall) { const transferTargetRoom = MatrixClientPeg.get().getRoom( CallHandler.sharedInstance().roomIdForCall(this.props.call), ); const transferTargetName = transferTargetRoom ? transferTargetRoom.name : _t("unknown person"); const transfereeRoom = MatrixClientPeg.get().getRoom( CallHandler.sharedInstance().roomIdForCall(transfereeCall), ); const transfereeName = transfereeRoom ? transfereeRoom.name : _t("unknown person"); holdTransferContent =
{ _t( "Consulting with %(transferTarget)s. Transfer to %(transferee)s", { transferTarget: transferTargetName, transferee: transfereeName, }, { a: sub => { sub } , }, ) }
; } else if (isOnHold) { let onHoldText = null; if (this.state.isRemoteOnHold) { const holdString = CallHandler.sharedInstance().hasAnyUnheldCall() ? _td("You held the call Switch") : _td("You held the call Resume"); onHoldText = _t(holdString, {}, { a: sub => { sub } , }); } else if (this.state.isLocalOnHold) { onHoldText = _t("%(peerName)s held the call", { peerName: this.props.call.getOpponentMember().name, }); } holdTransferContent =
{ onHoldText }
; } let sidebar; if ( (!isOnHold && !transfereeCall) && ((sidebarShown && this.props.call.type === CallType.Video) || isScreensharing) ) { sidebar = ( ); } // This is a bit messy. I can't see a reason to have two onHold/transfer screens if (isOnHold || transfereeCall) { if (this.props.call.type === CallType.Video) { const containerClasses = classNames({ mx_CallView_content: true, mx_CallView_video: true, mx_CallView_video_hold: isOnHold, }); let onHoldBackground = null; const backgroundStyle: CSSProperties = {}; const backgroundAvatarUrl = avatarUrlForMember( // is it worth getting the size of the div to pass here? this.props.call.getOpponentMember(), 1024, 1024, 'crop', ); backgroundStyle.backgroundImage = 'url(' + backgroundAvatarUrl + ')'; onHoldBackground =
; contentView = (
{ onHoldBackground } { holdTransferContent } { this.renderCallControls() }
); } else { const classes = classNames({ mx_CallView_content: true, mx_CallView_voice: true, mx_CallView_voice_hold: isOnHold, }); contentView =(
{ holdTransferContent } { this.renderCallControls() }
); } } else if (this.props.call.noIncomingFeeds()) { // Here we're reusing the css classes from voice on hold, because // I am lazy. If this gets merged, the CallView might be subject // to change anyway - I might take an axe to this file in order to // try to get other things working const classes = classNames({ mx_CallView_content: true, mx_CallView_voice: true, }); // Saying "Connecting" here isn't really true, but the best thing // I can come up with, but this might be subject to change as well contentView = (
{ sidebar }
{ _t("Connecting") }
{ this.renderCallControls() }
); } else { const containerClasses = classNames({ mx_CallView_content: true, mx_CallView_video: true, }); let presenting; if (this.props.call.getFeeds().some((feed) => feed.purpose === SDPStreamMetadataPurpose.Screenshare)) { const presentingClasses = classNames({ mx_CallView_presenting: true, mx_CallView_presenting_hidden: !this.state.controlsVisible, }); const sharerName = this.state.primaryFeed.getMember().name; let text = isScreensharing ? _t("You are presenting") : _t('%(sharerName)s is presenting', { sharerName }); if (!this.state.sidebarShown) { text += " • " + _t("Your camera is still enabled"); } presenting = (
{ text }
); } contentView = (
{ presenting } { sidebar } { this.renderCallControls() }
); } const callTypeText = this.props.call.type === CallType.Video ? _t("Video Call") : _t("Voice Call"); let myClassName; let fullScreenButton; if (!this.props.pipMode) { fullScreenButton =
; } let expandButton; if (this.props.pipMode) { expandButton =
; } const headerControls =
{ fullScreenButton } { expandButton }
; let header: React.ReactNode; if (!this.props.pipMode) { header =
{ callTypeText } { headerControls }
; myClassName = 'mx_CallView_large'; } else { let secondaryCallInfo; if (this.props.secondaryCall) { secondaryCallInfo = { _t("%(name)s on hold", { name: secCallRoom.name }) } ; } header = (
{ callRoom.name }
{ callTypeText } { secondaryCallInfo }
{ headerControls }
); myClassName = 'mx_CallView_pip'; } let dialPad; if (this.state.showDialpad) { dialPad = ; } let contextMenu; if (this.state.showMoreMenu) { contextMenu = ; } return
{ header } { contentView } { dialPad } { contextMenu }
; } }