/* eslint-disable lines-around-comment */ import { withStyles } from '@mui/styles'; import clsx from 'clsx'; import _ from 'lodash'; import React, { PureComponent } from 'react'; import { WithTranslation } from 'react-i18next'; import { FixedSizeGrid, FixedSizeList } from 'react-window'; import { ACTION_SHORTCUT_TRIGGERED, createShortcutEvent, createToolbarEvent } from '../../../analytics/AnalyticsEvents'; import { sendAnalytics } from '../../../analytics/functions'; import { IReduxState, IStore } from '../../../app/types'; import { getToolbarButtons } from '../../../base/config/functions.web'; import { isMobileBrowser } from '../../../base/environment/utils'; import { translate } from '../../../base/i18n/functions'; import Icon from '../../../base/icons/components/Icon'; import { IconArrowDown, IconArrowUp } from '../../../base/icons/svg'; import { IParticipant } from '../../../base/participants/types'; import { connect } from '../../../base/redux/functions'; import { getHideSelfView } from '../../../base/settings/functions.any'; import { showToolbox } from '../../../toolbox/actions.web'; import { isButtonEnabled, isToolboxVisible } from '../../../toolbox/functions.web'; import { LAYOUTS } from '../../../video-layout/constants'; import { getCurrentLayout } from '../../../video-layout/functions.web'; import { setFilmstripVisible, setTopPanelVisible, setUserFilmstripHeight, setUserFilmstripWidth, setUserIsResizing, setVisibleRemoteParticipants } from '../../actions'; import { ASPECT_RATIO_BREAKPOINT, DEFAULT_FILMSTRIP_WIDTH, FILMSTRIP_TYPE, MIN_STAGE_VIEW_HEIGHT, MIN_STAGE_VIEW_WIDTH, TILE_HORIZONTAL_MARGIN, TILE_VERTICAL_MARGIN, TOP_FILMSTRIP_HEIGHT } from '../../constants'; import { getVerticalViewMaxWidth, isStageFilmstripTopPanel, shouldRemoteVideosBeVisible } from '../../functions'; // @ts-ignore import AudioTracksContainer from './AudioTracksContainer'; import Thumbnail from './Thumbnail'; // @ts-ignore import ThumbnailWrapper from './ThumbnailWrapper'; // @ts-ignore import { styles } from './styles'; /** * The type of the React {@code Component} props of {@link Filmstrip}. */ interface IProps extends WithTranslation { /** * Additional CSS class names top add to the root. */ _className: string; /** * The number of columns in tile view. */ _columns: number; /** * The current layout of the filmstrip. */ _currentLayout: string; /** * Whether or not to hide the self view. */ _disableSelfView: boolean; /** * The height of the filmstrip. */ _filmstripHeight: number; /** * The width of the filmstrip. */ _filmstripWidth: number; /** * Whether or not we have scroll on the filmstrip. */ _hasScroll: boolean; /** * Whether this is a recorder or not. */ _iAmRecorder: boolean; /** * Whether the filmstrip button is enabled. */ _isFilmstripButtonEnabled: boolean; /** * Whether or not the toolbox is displayed. */ _isToolboxVisible: Boolean; /** * Whether or not the current layout is vertical filmstrip. */ _isVerticalFilmstrip: boolean; /** * The local screen share participant. This prop is behind the sourceNameSignaling feature flag. */ _localScreenShare: IParticipant; /** * Whether or not the filmstrip videos should currently be displayed. */ _mainFilmstripVisible: boolean; /** * The maximum width of the vertical filmstrip. */ _maxFilmstripWidth: number; /** * The maximum height of the top panel. */ _maxTopPanelHeight: number; /** * The participants in the call. */ _remoteParticipants: Array; /** * The length of the remote participants array. */ _remoteParticipantsLength: number; /** * Whether or not the filmstrip should be user-resizable. */ _resizableFilmstrip: boolean; /** * The number of rows in tile view. */ _rows: number; /** * The height of the thumbnail. */ _thumbnailHeight: number; /** * The width of the thumbnail. */ _thumbnailWidth: number; /** * Whether or not the filmstrip is top panel. */ _topPanelFilmstrip: boolean; /** * The height of the top panel (user resized). */ _topPanelHeight?: number; /** * The max height of the top panel. */ _topPanelMaxHeight: number; /** * Whether or not the top panel is visible. */ _topPanelVisible: boolean; /** * The width of the vertical filmstrip (user resized). */ _verticalFilmstripWidth?: number; /** * Whether or not the vertical filmstrip should have a background color. */ _verticalViewBackground: boolean; /** * Whether or not the vertical filmstrip should be displayed as grid. */ _verticalViewGrid: boolean; /** * The max width of the vertical filmstrip. */ _verticalViewMaxWidth: number; /** * Additional CSS class names to add to the container of all the thumbnails. */ _videosClassName: string; /** * An object containing the CSS classes. */ classes: any; /** * The redux {@code dispatch} function. */ dispatch: IStore['dispatch']; /** * The type of filmstrip to be displayed. */ filmstripType: string; } interface IState { /** * Initial top panel height on drag handle mouse down. */ dragFilmstripHeight?: number; /** * Initial filmstrip width on drag handle mouse down. */ dragFilmstripWidth?: number | null; /** * Whether or not the mouse is pressed. */ isMouseDown: boolean; /** * Initial mouse position on drag handle mouse down. */ mousePosition?: number | null; } /** * Implements a React {@link Component} which represents the filmstrip on * Web/React. * * @augments Component */ class Filmstrip extends PureComponent { _throttledResize: Function; /** * Initializes a new {@code Filmstrip} instance. * * @param {Object} props - The read-only properties with which the new * instance is to be initialized. */ constructor(props: IProps) { super(props); this.state = { isMouseDown: false, mousePosition: null, dragFilmstripWidth: null }; // Bind event handlers so they are only bound once for every instance. this._onShortcutToggleFilmstrip = this._onShortcutToggleFilmstrip.bind(this); this._onToolbarToggleFilmstrip = this._onToolbarToggleFilmstrip.bind(this); this._onTabIn = this._onTabIn.bind(this); this._gridItemKey = this._gridItemKey.bind(this); this._listItemKey = this._listItemKey.bind(this); this._onGridItemsRendered = this._onGridItemsRendered.bind(this); this._onListItemsRendered = this._onListItemsRendered.bind(this); this._onToggleButtonTouch = this._onToggleButtonTouch.bind(this); this._onDragHandleMouseDown = this._onDragHandleMouseDown.bind(this); this._onDragMouseUp = this._onDragMouseUp.bind(this); this._onFilmstripResize = this._onFilmstripResize.bind(this); this._throttledResize = _.throttle( this._onFilmstripResize, 50, { leading: true, trailing: false }); } /** * Implements React's {@link Component#componentDidMount}. * * @inheritdoc */ componentDidMount() { APP.keyboardshortcut.registerShortcut( 'F', 'filmstripPopover', this._onShortcutToggleFilmstrip, 'keyboardShortcuts.toggleFilmstrip' ); document.addEventListener('mouseup', this._onDragMouseUp); // @ts-ignore document.addEventListener('mousemove', this._throttledResize); } /** * Implements React's {@link Component#componentDidUpdate}. * * @inheritdoc */ componentWillUnmount() { APP.keyboardshortcut.unregisterShortcut('F'); document.removeEventListener('mouseup', this._onDragMouseUp); // @ts-ignore document.removeEventListener('mousemove', this._throttledResize); } /** * Implements React's {@link Component#render()}. * * @inheritdoc * @returns {ReactElement} */ render() { const filmstripStyle: any = { }; const { _currentLayout, _disableSelfView, _localScreenShare, _mainFilmstripVisible, _resizableFilmstrip, _topPanelFilmstrip, _topPanelMaxHeight, _topPanelVisible, _verticalViewBackground, _verticalViewGrid, _verticalViewMaxWidth, classes, filmstripType } = this.props; const { isMouseDown } = this.state; const tileViewActive = _currentLayout === LAYOUTS.TILE_VIEW; if (_currentLayout === LAYOUTS.STAGE_FILMSTRIP_VIEW && filmstripType === FILMSTRIP_TYPE.STAGE) { if (_topPanelFilmstrip) { filmstripStyle.maxHeight = `${_topPanelMaxHeight}px`; filmstripStyle.zIndex = 1; if (!_topPanelVisible) { filmstripStyle.top = `-${_topPanelMaxHeight}px`; } } if (_mainFilmstripVisible) { filmstripStyle.maxWidth = `calc(100% - ${_verticalViewMaxWidth}px)`; } } else if (_currentLayout === LAYOUTS.STAGE_FILMSTRIP_VIEW && filmstripType === FILMSTRIP_TYPE.SCREENSHARE) { if (_mainFilmstripVisible) { filmstripStyle.maxWidth = `calc(100% - ${_verticalViewMaxWidth}px)`; } if (_topPanelVisible) { filmstripStyle.maxHeight = `calc(100% - ${_topPanelMaxHeight}px)`; } filmstripStyle.bottom = 0; filmstripStyle.top = 'auto'; } else if (_currentLayout === LAYOUTS.VERTICAL_FILMSTRIP_VIEW || (_currentLayout === LAYOUTS.STAGE_FILMSTRIP_VIEW && filmstripType === FILMSTRIP_TYPE.MAIN)) { filmstripStyle.maxWidth = _verticalViewMaxWidth; if (!_mainFilmstripVisible) { filmstripStyle.right = `-${filmstripStyle.maxWidth}px`; } } let toolbar = null; if (!this.props._iAmRecorder && this.props._isFilmstripButtonEnabled && _currentLayout !== LAYOUTS.TILE_VIEW && (filmstripType === FILMSTRIP_TYPE.MAIN || (filmstripType === FILMSTRIP_TYPE.STAGE && _topPanelFilmstrip))) { toolbar = this._renderToggleButton(); } const filmstrip = (<>
{!_disableSelfView && !_verticalViewGrid && (
{ !tileViewActive && filmstripType === FILMSTRIP_TYPE.MAIN &&
}
)} {_localScreenShare && !_disableSelfView && !_verticalViewGrid && (
{ !tileViewActive && filmstripType === FILMSTRIP_TYPE.MAIN && }
)} { this._renderRemoteParticipants() }
); return (
{ toolbar } {_resizableFilmstrip ?
{filmstrip}
: filmstrip }
); } /** * Handles mouse down on the drag handle. * * @param {MouseEvent} e - The mouse down event. * @returns {void} */ _onDragHandleMouseDown(e: React.MouseEvent) { const { _topPanelFilmstrip, _topPanelHeight, _verticalFilmstripWidth } = this.props; this.setState({ isMouseDown: true, mousePosition: _topPanelFilmstrip ? e.clientY : e.clientX, dragFilmstripWidth: _verticalFilmstripWidth || DEFAULT_FILMSTRIP_WIDTH, dragFilmstripHeight: _topPanelHeight || TOP_FILMSTRIP_HEIGHT }); this.props.dispatch(setUserIsResizing(true)); } /** * Drag handle mouse up handler. * * @returns {void} */ _onDragMouseUp() { if (this.state.isMouseDown) { this.setState({ isMouseDown: false }); this.props.dispatch(setUserIsResizing(false)); } } /** * Handles drag handle mouse move. * * @param {MouseEvent} e - The mousemove event. * @returns {void} */ _onFilmstripResize(e: React.MouseEvent) { if (this.state.isMouseDown) { const { dispatch, _verticalFilmstripWidth, _maxFilmstripWidth, _topPanelHeight, _maxTopPanelHeight, _topPanelFilmstrip } = this.props; const { dragFilmstripWidth, dragFilmstripHeight, mousePosition } = this.state; if (_topPanelFilmstrip) { const diff = e.clientY - (mousePosition ?? 0); const height = Math.max( Math.min((dragFilmstripHeight ?? 0) + diff, _maxTopPanelHeight), TOP_FILMSTRIP_HEIGHT ); if (height !== _topPanelHeight) { dispatch(setUserFilmstripHeight(height)); } } else { const diff = (mousePosition ?? 0) - e.clientX; const width = Math.max( Math.min((dragFilmstripWidth ?? 0) + diff, _maxFilmstripWidth), DEFAULT_FILMSTRIP_WIDTH ); if (width !== _verticalFilmstripWidth) { dispatch(setUserFilmstripWidth(width)); } } } } /** * Calculates the start and stop indices based on whether the thumbnails need to be reordered in the filmstrip. * * @param {number} startIndex - The start index. * @param {number} stopIndex - The stop index. * @returns {Object} */ _calculateIndices(startIndex: number, stopIndex: number) { const { _currentLayout, _iAmRecorder, _disableSelfView } = this.props; let start = startIndex; let stop = stopIndex; if (!_disableSelfView) { // In tile view, the indices needs to be offset by 1 because the first thumbnail is that of the local // endpoint. The remote participants start from index 1. if (!_iAmRecorder && _currentLayout === LAYOUTS.TILE_VIEW) { start = Math.max(startIndex - 1, 0); stop = stopIndex - 1; } } return { startIndex: start, stopIndex: stop }; } /** * Toggle the toolbar visibility when tabbing into it. * * @returns {void} */ _onTabIn() { if (!this.props._isToolboxVisible && this.props._mainFilmstripVisible) { this.props.dispatch(showToolbox()); } } /** * The key to be used for every ThumbnailWrapper element in stage view. * * @param {number} index - The index of the ThumbnailWrapper instance. * @returns {string} - The key. */ _listItemKey(index: number) { const { _remoteParticipants, _remoteParticipantsLength } = this.props; if (typeof index !== 'number' || _remoteParticipantsLength <= index) { return `empty-${index}`; } return _remoteParticipants[index]; } /** * The key to be used for every ThumbnailWrapper element in tile views. * * @param {Object} data - An object with the indexes identifying the ThumbnailWrapper instance. * @returns {string} - The key. */ _gridItemKey({ columnIndex, rowIndex }: { columnIndex: number; rowIndex: number; }) { const { _disableSelfView, _columns, _iAmRecorder, _remoteParticipants, _remoteParticipantsLength } = this.props; const index = (rowIndex * _columns) + columnIndex; // When the thumbnails are reordered, local participant is inserted at index 0. const localIndex = _disableSelfView ? _remoteParticipantsLength : 0; const remoteIndex = !_iAmRecorder && !_disableSelfView ? index - 1 : index; if (index > _remoteParticipantsLength - (_iAmRecorder ? 1 : 0)) { return `empty-${index}`; } if (!_iAmRecorder && index === localIndex) { return 'local'; } return _remoteParticipants[remoteIndex]; } /** * Handles items rendered changes in stage view. * * @param {Object} data - Information about the rendered items. * @returns {void} */ _onListItemsRendered({ visibleStartIndex, visibleStopIndex }: { visibleStartIndex: number; visibleStopIndex: number; }) { const { dispatch } = this.props; const { startIndex, stopIndex } = this._calculateIndices(visibleStartIndex, visibleStopIndex); dispatch(setVisibleRemoteParticipants(startIndex, stopIndex)); } /** * Handles items rendered changes in tile view. * * @param {Object} data - Information about the rendered items. * @returns {void} */ _onGridItemsRendered({ visibleColumnStartIndex, visibleColumnStopIndex, visibleRowStartIndex, visibleRowStopIndex }: { visibleColumnStartIndex: number; visibleColumnStopIndex: number; visibleRowStartIndex: number; visibleRowStopIndex: number; }) { const { _columns, dispatch } = this.props; const start = (visibleRowStartIndex * _columns) + visibleColumnStartIndex; const stop = (visibleRowStopIndex * _columns) + visibleColumnStopIndex; const { startIndex, stopIndex } = this._calculateIndices(start, stop); dispatch(setVisibleRemoteParticipants(startIndex, stopIndex)); } /** * Renders the thumbnails for remote participants. * * @returns {ReactElement} */ _renderRemoteParticipants() { const { _columns, _currentLayout, _filmstripHeight, _filmstripWidth, _hasScroll, _isVerticalFilmstrip, _remoteParticipantsLength, _resizableFilmstrip, _rows, _thumbnailHeight, _thumbnailWidth, _verticalViewGrid, filmstripType } = this.props; if (!_thumbnailWidth || isNaN(_thumbnailWidth) || !_thumbnailHeight || isNaN(_thumbnailHeight) || !_filmstripHeight || isNaN(_filmstripHeight) || !_filmstripWidth || isNaN(_filmstripWidth)) { return null; } if (_currentLayout === LAYOUTS.TILE_VIEW || _verticalViewGrid || filmstripType !== FILMSTRIP_TYPE.MAIN) { return ( { ThumbnailWrapper } ); } const props: any = { itemCount: _remoteParticipantsLength, className: `filmstrip__videos remote-videos ${_resizableFilmstrip ? '' : 'height-transition'}`, height: _filmstripHeight, itemKey: this._listItemKey, itemSize: 0, onItemsRendered: this._onListItemsRendered, overscanCount: 1, width: _filmstripWidth, style: { willChange: 'auto' } }; if (_currentLayout === LAYOUTS.HORIZONTAL_FILMSTRIP_VIEW) { const itemSize = _thumbnailWidth + TILE_HORIZONTAL_MARGIN; const isNotOverflowing = !_hasScroll; props.itemSize = itemSize; props.layout = 'horizontal'; if (isNotOverflowing) { props.className += ' is-not-overflowing'; } } else if (_isVerticalFilmstrip) { const itemSize = _thumbnailHeight + TILE_VERTICAL_MARGIN; const isNotOverflowing = !_hasScroll; if (isNotOverflowing) { props.className += ' is-not-overflowing'; } props.itemSize = itemSize; } return ( { ThumbnailWrapper } ); } /** * Dispatches an action to change the visibility of the filmstrip. * * @private * @returns {void} */ _doToggleFilmstrip() { const { dispatch, _mainFilmstripVisible, _topPanelFilmstrip, _topPanelVisible } = this.props; _topPanelFilmstrip ? dispatch(setTopPanelVisible(!_topPanelVisible)) : dispatch(setFilmstripVisible(!_mainFilmstripVisible)); } /** * Creates an analytics keyboard shortcut event and dispatches an action for * toggling filmstrip visibility. * * @private * @returns {void} */ _onShortcutToggleFilmstrip() { sendAnalytics(createShortcutEvent( 'toggle.filmstrip', ACTION_SHORTCUT_TRIGGERED, { enable: this.props._mainFilmstripVisible })); this._doToggleFilmstrip(); } /** * Creates an analytics toolbar event and dispatches an action for opening * the speaker stats modal. * * @private * @returns {void} */ _onToolbarToggleFilmstrip() { sendAnalytics(createToolbarEvent( 'toggle.filmstrip.button', { enable: this.props._mainFilmstripVisible })); this._doToggleFilmstrip(); } /** * Handler for touch start event of the 'toggle button'. * * @private * @param {Object} e - The synthetic event. * @returns {void} */ _onToggleButtonTouch(e: React.TouchEvent) { // Don't propagate the touchStart event so the toolbar doesn't get toggled. e.stopPropagation(); this._onToolbarToggleFilmstrip(); } /** * Creates a React Element for changing the visibility of the filmstrip when * clicked. * * @private * @returns {ReactElement} */ _renderToggleButton() { const { t, classes, _isVerticalFilmstrip, _mainFilmstripVisible, _topPanelFilmstrip, _topPanelVisible } = this.props; const icon = (_topPanelFilmstrip ? _topPanelVisible : _mainFilmstripVisible) ? IconArrowDown : IconArrowUp; const actions = isMobileBrowser() ? { onTouchStart: this._onToggleButtonTouch } : { onClick: this._onToolbarToggleFilmstrip }; return (
); } } /** * Maps (parts of) the Redux state to the associated {@code Filmstrip}'s props. * * @param {Object} state - The Redux state. * @param {Object} ownProps - The own props of the component. * @private * @returns {IProps} */ function _mapStateToProps(state: IReduxState, ownProps: Partial) { const { _hasScroll = false, filmstripType, _topPanelFilmstrip, _remoteParticipants } = ownProps; const toolbarButtons = getToolbarButtons(state); const { iAmRecorder } = state['features/base/config']; const { topPanelHeight, topPanelVisible, visible, width: verticalFilmstripWidth } = state['features/filmstrip']; const { localScreenShare } = state['features/base/participants']; const reduceHeight = state['features/toolbox'].visible && toolbarButtons.length; const remoteVideosVisible = shouldRemoteVideosBeVisible(state); const { isOpen: shiftRight } = state['features/chat']; const disableSelfView = getHideSelfView(state); const { clientWidth, clientHeight } = state['features/base/responsive-ui']; const collapseTileView = reduceHeight && isMobileBrowser() && clientWidth <= ASPECT_RATIO_BREAKPOINT; const shouldReduceHeight = reduceHeight && isMobileBrowser(); const _topPanelVisible = isStageFilmstripTopPanel(state) && topPanelVisible; let isVisible = visible || filmstripType !== FILMSTRIP_TYPE.MAIN; if (_topPanelFilmstrip) { isVisible = _topPanelVisible; } const videosClassName = `filmstrip__videos${isVisible ? '' : ' hidden'}${_hasScroll ? ' has-scroll' : ''}`; const className = `${remoteVideosVisible || ownProps._verticalViewGrid ? '' : 'hide-videos'} ${ shouldReduceHeight ? 'reduce-height' : '' } ${shiftRight ? 'shift-right' : ''} ${collapseTileView ? 'collapse' : ''} ${isVisible ? '' : 'hidden'}`.trim(); const _currentLayout = getCurrentLayout(state); const _isVerticalFilmstrip = _currentLayout === LAYOUTS.VERTICAL_FILMSTRIP_VIEW || (filmstripType === FILMSTRIP_TYPE.MAIN && _currentLayout === LAYOUTS.STAGE_FILMSTRIP_VIEW); return { _className: className, _chatOpen: state['features/chat'].isOpen, _currentLayout, _disableSelfView: disableSelfView, _hasScroll, _iAmRecorder: Boolean(iAmRecorder), _isFilmstripButtonEnabled: isButtonEnabled('filmstrip', state), _isToolboxVisible: isToolboxVisible(state), _isVerticalFilmstrip, _localScreenShare: localScreenShare, _mainFilmstripVisible: visible, _maxFilmstripWidth: clientWidth - MIN_STAGE_VIEW_WIDTH, _maxTopPanelHeight: clientHeight - MIN_STAGE_VIEW_HEIGHT, _remoteParticipantsLength: _remoteParticipants?.length, _topPanelHeight: topPanelHeight.current, _topPanelMaxHeight: topPanelHeight.current || TOP_FILMSTRIP_HEIGHT, _topPanelVisible, _verticalFilmstripWidth: verticalFilmstripWidth.current, _verticalViewMaxWidth: getVerticalViewMaxWidth(state), _videosClassName: videosClassName }; } export default withStyles(styles)(translate(connect(_mapStateToProps)(Filmstrip)));