element-call/src/video-grid/VideoTileContainer.tsx

/*
Copyright 2022 New Vector Ltd

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 { SDPStreamMetadataPurpose } from "matrix-js-sdk/src/webrtc/callEventTypes";
import React, { FC, memo, RefObject } from "react";
import { useCallback } from "react";
import { RoomMember } from "matrix-js-sdk/src/models/room-member";
import { SpringValue } from "@react-spring/web";
import { EventTypes, Handler, useDrag } from "@use-gesture/react";

import { useCallFeed } from "./useCallFeed";
import { useSpatialMediaStream } from "./useMediaStream";
import { useRoomMemberName } from "./useRoomMemberName";
import { VideoTile } from "./VideoTile";
import { VideoTileSettingsModal } from "./VideoTileSettingsModal";
import { useModalTriggerState } from "../Modal";
import { TileDescriptor } from "./TileDescriptor";

interface Props {
  item: TileDescriptor;
  targetWidth: number;
  targetHeight: number;
  getAvatar: (
    roomMember: RoomMember,
    width: number,
    height: number
  ) => JSX.Element;
  audioContext: AudioContext;
  audioDestination: AudioNode;
  disableSpeakingIndicator: boolean;
  maximised: boolean;
  fullscreen: boolean;
  onFullscreen: (item: TileDescriptor) => void;
  opacity?: SpringValue<number>;
  scale?: SpringValue<number>;
  shadow?: SpringValue<number>;
  shadowSpread?: SpringValue<number>;
  zIndex?: SpringValue<number>;
  x?: SpringValue<number>;
  y?: SpringValue<number>;
  width?: SpringValue<number>;
  height?: SpringValue<number>;
  onDragRef?: RefObject<
    (
      tileId: string,
      state: Parameters<Handler<"drag", EventTypes["drag"]>>[0]
    ) => void
  >;
}

export const VideoTileContainer: FC<Props> = memo(
  ({
    item,
    targetWidth,
    targetHeight,
    getAvatar,
    audioContext,
    audioDestination,
    disableSpeakingIndicator,
    maximised,
    fullscreen,
    onFullscreen,
    onDragRef,
    ...rest
  }) => {
    const {
      isLocal,
      audioMuted,
      videoMuted,
      localVolume,
      hasAudio,
      speaking,
      stream,
      purpose,
    } = useCallFeed(item.callFeed);
    const { rawDisplayName } = useRoomMemberName(item.member);

    const [tileRef, mediaRef] = useSpatialMediaStream(
      stream ?? null,
      audioContext,
      audioDestination,
      localVolume,
      // The feed is muted if it's local audio (because we don't want our own audio,
      // but it's a hook and we can't call it conditionally so we're stuck with it)
      // or if there's a maximised feed in which case we always render audio via audio
      // elements because we wire it up at the video tile container level and only one
      // video tile container is displayed.
      isLocal || maximised
    );

    useDrag((state) => onDragRef?.current!(item.id, state), {
      target: tileRef,
      filterTaps: true,
      preventScroll: true,
    });

    const {
      modalState: videoTileSettingsModalState,
      modalProps: videoTileSettingsModalProps,
    } = useModalTriggerState();
    const onOptionsPress = () => {
      videoTileSettingsModalState.open();
    };

    const onFullscreenCallback = useCallback(() => {
      onFullscreen(item);
    }, [onFullscreen, item]);

    // Firefox doesn't respect the disablePictureInPicture attribute
    // https://bugzilla.mozilla.org/show_bug.cgi?id=1611831

    return (
      <>
        <VideoTile
          isLocal={isLocal}
          speaking={speaking && !disableSpeakingIndicator}
          audioMuted={audioMuted}
          videoMuted={videoMuted}
          screenshare={purpose === SDPStreamMetadataPurpose.Screenshare}
          name={rawDisplayName}
          connectionState={item.connectionState}
          ref={tileRef}
          mediaRef={mediaRef}
          avatar={
            getAvatar && getAvatar(item.member, targetWidth, targetHeight)
          }
          onOptionsPress={onOptionsPress}
          localVolume={localVolume}
          hasAudio={hasAudio}
          maximised={maximised}
          fullscreen={fullscreen}
          onFullscreen={onFullscreenCallback}
          {...rest}
        />
        {videoTileSettingsModalState.isOpen && !maximised && item.callFeed && (
          <VideoTileSettingsModal
            {...videoTileSettingsModalProps}
            feed={item.callFeed}
          />
        )}
      </>
    );
  }
);