Don't configure audio session inside state lock (#491)

livekit · Sep 23, 2024 · 2bc3d6b · 2bc3d6b
1 parent 7727ac6
commit 2bc3d6b
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 22 deletions.
diff --git a/Sources/LiveKit/Track/AudioManager.swift b/Sources/LiveKit/Track/AudioManager.swift
@@ -71,8 +71,8 @@ public class AudioManager: Loggable {
 
     #if os(iOS) || os(visionOS) || os(tvOS)
 
-    public typealias ConfigureAudioSessionFunc = (_ newState: State,
-                                                  _ oldState: State) -> Void
+    public typealias ConfigureAudioSessionFunc = @Sendable (_ newState: State,
+                                                            _ oldState: State) -> Void
 
     /// Use this to provide a custom function to configure the audio session, overriding the default behavior
     /// provided by ``defaultConfigureAudioSessionFunc(newState:oldState:)``.
@@ -119,7 +119,7 @@ public class AudioManager: Loggable {
         case localAndRemote
     }
 
-    public struct State: Equatable {
+    public struct State: Equatable, Sendable {
         // Only consider State mutated when public vars change
         public static func == (lhs: AudioManager.State, rhs: AudioManager.State) -> Bool {
             var isEqual = lhs.localTracksCount == rhs.localTracksCount &&
@@ -226,34 +226,40 @@ public class AudioManager: Loggable {
 
     // MARK: - Private
 
-    // Singleton
-    private init() {
-        // trigger events when state mutates
-        state.onDidMutate = { [weak self] newState, oldState in
-            guard let self else { return }
-            // Return if state is equal.
-            guard newState != oldState else { return }
+    private let _configureRunner = SerialRunnerActor<Void>()
 
+    #if os(iOS) || os(visionOS) || os(tvOS)
+    private func _asyncConfigure(newState: State, oldState: State) async throws {
+        try await _configureRunner.run {
             self.log("\(oldState) -> \(newState)")
-            #if os(iOS) || os(visionOS) || os(tvOS)
             let configureFunc = newState.customConfigureFunc ?? self.defaultConfigureAudioSessionFunc
             configureFunc(newState, oldState)
-            #endif
         }
     }
+    #endif
 
-    func trackDidStart(_ type: Type) {
-        state.mutate { state in
+    func trackDidStart(_ type: Type) async throws {
+        let (newState, oldState) = state.mutate { state in
+            let oldState = state
             if type == .local { state.localTracksCount += 1 }
             if type == .remote { state.remoteTracksCount += 1 }
+            return (state, oldState)
         }
+        #if os(iOS) || os(visionOS) || os(tvOS)
+        try await _asyncConfigure(newState: newState, oldState: oldState)
+        #endif
     }
 
-    func trackDidStop(_ type: Type) {
-        state.mutate { state in
+    func trackDidStop(_ type: Type) async throws {
+        let (newState, oldState) = state.mutate { state in
+            let oldState = state
             if type == .local { state.localTracksCount = max(state.localTracksCount - 1, 0) }
             if type == .remote { state.remoteTracksCount = max(state.remoteTracksCount - 1, 0) }
+            return (state, oldState)
         }
+        #if os(iOS) || os(visionOS) || os(tvOS)
+        try await _asyncConfigure(newState: newState, oldState: oldState)
+        #endif
     }
 
     #if os(iOS) || os(visionOS) || os(tvOS)

diff --git a/Sources/LiveKit/Track/Local/LocalAudioTrack.swift b/Sources/LiveKit/Track/Local/LocalAudioTrack.swift
@@ -82,11 +82,11 @@ public class LocalAudioTrack: Track, LocalTrack, AudioTrack {
     // MARK: - Internal
 
     override func startCapture() async throws {
-        AudioManager.shared.trackDidStart(.local)
+        try await AudioManager.shared.trackDidStart(.local)
     }
 
     override func stopCapture() async throws {
-        AudioManager.shared.trackDidStop(.local)
+        try await AudioManager.shared.trackDidStop(.local)
     }
 }
 

diff --git a/Sources/LiveKit/Track/Remote/RemoteAudioTrack.swift b/Sources/LiveKit/Track/Remote/RemoteAudioTrack.swift
@@ -84,11 +84,11 @@ public class RemoteAudioTrack: Track, RemoteTrack, AudioTrack {
     // MARK: - Internal
 
     override func startCapture() async throws {
-        AudioManager.shared.trackDidStart(.remote)
+        try await AudioManager.shared.trackDidStart(.remote)
     }
 
     override func stopCapture() async throws {
-        AudioManager.shared.trackDidStop(.remote)
+        try await AudioManager.shared.trackDidStop(.remote)
     }
 }
 

diff --git a/Tests/LiveKitTests/TrackTests.swift b/Tests/LiveKitTests/TrackTests.swift
@@ -29,12 +29,12 @@ class TestTrack: LocalAudioTrack {
 
     override func startCapture() async throws {
         try? await Task.sleep(nanoseconds: UInt64(Double.random(in: 0.0 ... 1.0) * 1_000_000))
-        AudioManager.shared.trackDidStart(.local)
+        try await AudioManager.shared.trackDidStart(.local)
     }
 
     override func stopCapture() async throws {
         try? await Task.sleep(nanoseconds: UInt64(Double.random(in: 0.0 ... 1.0) * 1_000_000))
-        AudioManager.shared.trackDidStop(.local)
+        try await AudioManager.shared.trackDidStop(.local)
     }
 }