Fix multiple issues with device settings

To track media devices, we were previously relying on a combination of LiveKit's useMediaDeviceSelect hook, and an object called UserChoices. Device settings should be accessible from outside a call, but the latter hook should only be used with a room or set of preview tracks, so it couldn't be raised to the app's top level. I also felt that the UserChoices code was hard to follow due to lack of clear ownership of the object.

To bring clarity to media device handling and allow device settings to be shown outside a call, I refactored these things into a single MediaDevicesContext which is instantiated at the top level of the app. Then, I had to manually sync LiveKit's device state with whatever is present in the context. This refactoring ended up fixing a couple other bugs with device handling along the way.

src/livekit/useLiveKit.ts

@@ -1,3 +1,19 @@
+/*
+Copyright 2023 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 {
   E2EEOptions,
   ExternalE2EEKeyProvider,
@@ -6,21 +22,18 @@ import {
   setLogLevel,
 } from "livekit-client";
 import { useLiveKitRoom } from "@livekit/components-react";
-import { useEffect, useMemo } from "react";
+import { useEffect, useMemo, useRef } from "react";
 import E2EEWorker from "livekit-client/e2ee-worker?worker";
+import { logger } from "matrix-js-sdk/src/logger";
 
 import { defaultLiveKitOptions } from "./options";
 import { SFUConfig } from "./openIDSFU";
-
-export type UserChoices = {
-  audio?: DeviceChoices;
-  video?: DeviceChoices;
-};
-
-export type DeviceChoices = {
-  selectedId?: string;
-  enabled: boolean;
-};
+import { MuteStates } from "../room/MuteStates";
+import {
+  MediaDevice,
+  MediaDevices,
+  useMediaDevices,
+} from "./MediaDevicesContext";
 
 export type E2EEConfig = {
   sharedKey: string;
@@ -29,7 +42,7 @@ export type E2EEConfig = {
 setLogLevel("debug");
 
 export function useLiveKit(
-  userChoices: UserChoices,
+  muteStates: MuteStates,
   sfuConfig?: SFUConfig,
   e2eeConfig?: E2EEConfig
 ): Room | undefined {
@@ -50,21 +63,30 @@ export function useLiveKit(
     );
   }, [e2eeOptions, e2eeConfig?.sharedKey]);
 
-  const roomOptions = useMemo((): RoomOptions => {
-    const options = defaultLiveKitOptions;
-    options.videoCaptureDefaults = {
-      ...options.videoCaptureDefaults,
-      deviceId: userChoices.video?.selectedId,
-    };
-    options.audioCaptureDefaults = {
-      ...options.audioCaptureDefaults,
-      deviceId: userChoices.audio?.selectedId,
-    };
+  const initialMuteStates = useRef<MuteStates>(muteStates);
+  const devices = useMediaDevices();
+  const initialDevices = useRef<MediaDevices>(devices);
 
-    options.e2ee = e2eeOptions;
-
-    return options;
-  }, [userChoices.video, userChoices.audio, e2eeOptions]);
+  const roomOptions = useMemo(
+    (): RoomOptions => ({
+      ...defaultLiveKitOptions,
+      videoCaptureDefaults: {
+        ...defaultLiveKitOptions.videoCaptureDefaults,
+        deviceId: initialDevices.current.videoInput.selectedId,
+      },
+      audioCaptureDefaults: {
+        ...defaultLiveKitOptions.audioCaptureDefaults,
+        deviceId: initialDevices.current.audioInput.selectedId,
+      },
+      // XXX Setting the audio output here doesn't seem to do anything… a bug in
+      // LiveKit?
+      audioOutput: {
+        deviceId: initialDevices.current.audioOutput.selectedId,
+      },
+      e2ee: e2eeOptions,
+    }),
+    [e2eeOptions]
+  );
 
   // We have to create the room manually here due to a bug inside
   // @livekit/components-react. JSON.stringify() is used in deps of a
@@ -73,10 +95,53 @@ export function useLiveKit(
   const { room } = useLiveKitRoom({
     token: sfuConfig?.jwt,
     serverUrl: sfuConfig?.url,
-    audio: userChoices.audio?.enabled ?? false,
-    video: userChoices.video?.enabled ?? false,
+    audio: initialMuteStates.current.audio.enabled,
+    video: initialMuteStates.current.video.enabled,
     room: roomWithoutProps,
   });
 
+  useEffect(() => {
+    // Sync the requested mute states with LiveKit's mute states. We do it this
+    // way around rather than using LiveKit as the source of truth, so that the
+    // states can be consistent throughout the lobby and loading screens.
+    if (room !== undefined) {
+      const participant = room.localParticipant;
+      if (participant.isMicrophoneEnabled !== muteStates.audio.enabled) {
+        participant
+          .setMicrophoneEnabled(muteStates.audio.enabled)
+          .catch((e) =>
+            logger.error("Failed to sync audio mute state with LiveKit", e)
+          );
+      }
+      if (participant.isCameraEnabled !== muteStates.video.enabled) {
+        participant
+          .setCameraEnabled(muteStates.video.enabled)
+          .catch((e) =>
+            logger.error("Failed to sync video mute state with LiveKit", e)
+          );
+      }
+    }
+  }, [room, muteStates]);
+
+  useEffect(() => {
+    // Sync the requested devices with LiveKit's devices
+    if (room !== undefined) {
+      const syncDevice = (kind: MediaDeviceKind, device: MediaDevice) => {
+        const id = device.selectedId;
+        if (id !== undefined && room.getActiveDevice(kind) !== id) {
+          room
+            .switchActiveDevice(kind, id)
+            .catch((e) =>
+              logger.error(`Failed to sync ${kind} device with LiveKit`, e)
+            );
+        }
+      };
+
+      syncDevice("audioinput", devices.audioInput);
+      syncDevice("audiooutput", devices.audioOutput);
+      syncDevice("videoinput", devices.videoInput);
+    }
+  }, [room, devices]);
+
   return room;
 }