Update engine observer methods (#572)

Author: hiroshihorie

Package.swift

@@ -18,7 +18,7 @@ let package = Package(
     ],
     dependencies: [
         // LK-Prefixed Dynamic WebRTC XCFramework
-        .package(url: "https://github.com/livekit/webrtc-xcframework.git", exact: "125.6422.15"),
+        .package(url: "https://github.com/livekit/webrtc-xcframework.git", exact: "125.6422.16"),
         .package(url: "https://github.com/apple/swift-protobuf.git", from: "1.26.0"),
         .package(url: "https://github.com/apple/swift-log.git", from: "1.5.4"),
         // Only used for DocC generation

[email protected]

@@ -20,7 +20,7 @@ let package = Package(
     ],
     dependencies: [
         // LK-Prefixed Dynamic WebRTC XCFramework
-        .package(url: "https://github.com/livekit/webrtc-xcframework.git", exact: "125.6422.15"),
+        .package(url: "https://github.com/livekit/webrtc-xcframework.git", exact: "125.6422.16"),
         .package(url: "https://github.com/apple/swift-protobuf.git", from: "1.26.0"),
         .package(url: "https://github.com/apple/swift-log.git", from: "1.5.4"),
         // Only used for DocC generation

Sources/LiveKit/Audio/AudioDeviceModuleDelegateAdapter.swift

@@ -74,15 +74,15 @@ class AudioDeviceModuleDelegateAdapter: NSObject, LKRTCAudioDeviceModuleDelegate
         entryPoint?.engineWillRelease(engine)
     }
 
-    func audioDeviceModule(_: LKRTCAudioDeviceModule, engine: AVAudioEngine, configureInputFromSource src: AVAudioNode?, toDestination dst: AVAudioNode, format: AVAudioFormat) -> Bool {
-        guard let audioManager else { return false }
+    func audioDeviceModule(_: LKRTCAudioDeviceModule, engine: AVAudioEngine, configureInputFromSource src: AVAudioNode?, toDestination dst: AVAudioNode, format: AVAudioFormat, context: [AnyHashable: Any]) {
+        guard let audioManager else { return }
         let entryPoint = audioManager.buildEngineObserverChain()
-        return entryPoint?.engineWillConnectInput(engine, src: src, dst: dst, format: format) ?? false
+        entryPoint?.engineWillConnectInput(engine, src: src, dst: dst, format: format, context: context)
     }
 
-    func audioDeviceModule(_: LKRTCAudioDeviceModule, engine: AVAudioEngine, configureOutputFromSource src: AVAudioNode, toDestination dst: AVAudioNode?, format: AVAudioFormat) -> Bool {
-        guard let audioManager else { return false }
+    func audioDeviceModule(_: LKRTCAudioDeviceModule, engine: AVAudioEngine, configureOutputFromSource src: AVAudioNode, toDestination dst: AVAudioNode?, format: AVAudioFormat, context: [AnyHashable: Any]) {
+        guard let audioManager else { return }
         let entryPoint = audioManager.buildEngineObserverChain()
-        return entryPoint?.engineWillConnectOutput(engine, src: src, dst: dst, format: format) ?? false
+        entryPoint?.engineWillConnectOutput(engine, src: src, dst: dst, format: format, context: context)
     }
 }

Sources/LiveKit/Audio/AudioEngineObserver.swift

@@ -16,6 +16,14 @@
 
 import AVFAudio
 
+#if swift(>=5.9)
+internal import LiveKitWebRTC
+#else
+@_implementationOnly import LiveKitWebRTC
+#endif
+
+public let AudioEngineInputMixerNodeKey = kRTCAudioEngineInputMixerNodeKey
+
 /// Do not retain the engine object.
 public protocol AudioEngineObserver: NextInvokable, Sendable {
     associatedtype Next = any AudioEngineObserver
@@ -31,11 +39,11 @@ public protocol AudioEngineObserver: NextInvokable, Sendable {
     /// Provide custom implementation for internal AVAudioEngine's output configuration.
     /// Buffers flow from `src` to `dst`. Preferred format to connect node is provided as `format`.
     /// Return true if custom implementation is provided, otherwise default implementation will be used.
-    func engineWillConnectOutput(_ engine: AVAudioEngine, src: AVAudioNode, dst: AVAudioNode?, format: AVAudioFormat) -> Bool
+    func engineWillConnectOutput(_ engine: AVAudioEngine, src: AVAudioNode, dst: AVAudioNode?, format: AVAudioFormat, context: [AnyHashable: Any])
     /// Provide custom implementation for internal AVAudioEngine's input configuration.
     /// Buffers flow from `src` to `dst`. Preferred format to connect node is provided as `format`.
     /// Return true if custom implementation is provided, otherwise default implementation will be used.
-    func engineWillConnectInput(_ engine: AVAudioEngine, src: AVAudioNode?, dst: AVAudioNode, format: AVAudioFormat) -> Bool
+    func engineWillConnectInput(_ engine: AVAudioEngine, src: AVAudioNode?, dst: AVAudioNode, format: AVAudioFormat, context: [AnyHashable: Any])
 }
 
 /// Default implementation to make it optional.
@@ -64,11 +72,11 @@ public extension AudioEngineObserver {
         next?.engineWillRelease(engine)
     }
 
-    func engineWillConnectOutput(_ engine: AVAudioEngine, src: AVAudioNode, dst: AVAudioNode?, format: AVAudioFormat) -> Bool {
-        next?.engineWillConnectOutput(engine, src: src, dst: dst, format: format) ?? false
+    func engineWillConnectOutput(_ engine: AVAudioEngine, src: AVAudioNode, dst: AVAudioNode?, format: AVAudioFormat, context: [AnyHashable: Any]) {
+        next?.engineWillConnectOutput(engine, src: src, dst: dst, format: format, context: context)
     }
 
-    func engineWillConnectInput(_ engine: AVAudioEngine, src: AVAudioNode?, dst: AVAudioNode, format: AVAudioFormat) -> Bool {
-        next?.engineWillConnectInput(engine, src: src, dst: dst, format: format) ?? false
+    func engineWillConnectInput(_ engine: AVAudioEngine, src: AVAudioNode?, dst: AVAudioNode, format: AVAudioFormat, context: [AnyHashable: Any]) {
+        next?.engineWillConnectInput(engine, src: src, dst: dst, format: format, context: context)
     }
 }

Tests/LiveKitTests/AudioEngineTests.swift

@@ -294,10 +294,9 @@ final class SineWaveNodeHook: AudioEngineObserver {
         engine.detach(sineWaveNode)
     }
 
-    func engineWillConnectInput(_ engine: AVAudioEngine, src _: AVAudioNode?, dst: AVAudioNode, format: AVAudioFormat) -> Bool {
+    func engineWillConnectInput(_ engine: AVAudioEngine, src _: AVAudioNode?, dst: AVAudioNode, format: AVAudioFormat, context _: [AnyHashable: Any]) {
         print("engineWillConnectInput")
         engine.connect(sineWaveNode, to: dst, format: format)
-        return true
     }
 }
 
@@ -322,10 +321,9 @@ final class PlayerNodeHook: AudioEngineObserver {
         engine.detach(playerMixerNode)
     }
 
-    func engineWillConnectInput(_ engine: AVAudioEngine, src _: AVAudioNode?, dst: AVAudioNode, format: AVAudioFormat) -> Bool {
+    func engineWillConnectInput(_ engine: AVAudioEngine, src _: AVAudioNode?, dst: AVAudioNode, format: AVAudioFormat, context _: [AnyHashable: Any]) {
         print("engineWillConnectInput")
         engine.connect(playerNode, to: playerMixerNode, format: playerNodeFormat)
         engine.connect(playerMixerNode, to: dst, format: format)
-        return true
     }
 }