Library evolution support (xcframework)

.changes/xcframework

@@ -0,0 +1 @@
+minor type="fixed" "Breaking change: Library evolution support (xcframework). May break existing `*Track` extensions."

.github/workflows/ci.yaml

@@ -151,6 +151,7 @@ jobs:
             -scheme LiveKit \
             -configuration Release \
             -destination 'platform=${{ matrix.platform }}'  \
+            BUILD_LIBRARY_FOR_DISTRIBUTION=YES \
             OTHER_SWIFT_FLAGS="-Xfrontend -emit-symbol-graph\
                                -Xfrontend -emit-symbol-graph-dir\
                                -Xfrontend \"${PWD}/symbol-graph\"" \

Sources/LiveKit/Broadcast/BroadcastScreenCapturer.swift

@@ -97,7 +97,7 @@ class BroadcastScreenCapturer: BufferCapturer, @unchecked Sendable {
 public extension LocalVideoTrack {
     /// Creates a track that captures screen capture from a broadcast upload extension
     static func createBroadcastScreenCapturerTrack(name: String = Track.screenShareVideoName,
-                                                   source: VideoTrack.Source = .screenShareVideo,
+                                                   source: Track.Source = .screenShareVideo,
                                                    options: ScreenShareCaptureOptions = ScreenShareCaptureOptions(),
                                                    reportStatistics: Bool = false) -> LocalVideoTrack
     {

Sources/LiveKit/Core/Room.swift

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import Combine
 import Foundation
 
 #if canImport(Network)

Sources/LiveKit/E2EE/E2EEManager.swift

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import Combine
 import Foundation
 
 internal import LiveKitWebRTC
@@ -39,7 +40,7 @@
 
     // MARK: - Public
 
     public let e2eeOptions: E2EEOptions?
     public let options: EncryptionOptions?
 
     public var keyProvider: BaseKeyProvider {
@@ -75,7 +76,7 @@
         var dataCryptor: LKRTCDataPacketCryptor?
     }
 
     public init(e2eeOptions: E2EEOptions) {
         self.e2eeOptions = e2eeOptions
         options = nil
     }

Sources/LiveKit/Extensions/Sendable.swift

@@ -53,3 +53,9 @@ extension NSMapTable: @unchecked Swift.Sendable {} // cannot specify Obj-C gener
 #if swift(<6.2)
 extension Dictionary: Swift.Sendable where Key: Sendable, Value: Sendable {}
 #endif
+
+// MARK: AV
+
+extension AVCaptureDevice: @unchecked Swift.Sendable {}
+extension AVCaptureDevice.Format: @unchecked Swift.Sendable {}
+extension CVPixelBuffer: @unchecked Swift.Sendable {}

Sources/LiveKit/Participant/Participant.swift

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import Combine
 import Foundation
 
 internal import LiveKitWebRTC

Sources/LiveKit/SwiftUI/TrackDelegateObserver.swift

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import Combine
 import Foundation
 
 /// Helper class to observer ``TrackDelegate`` from Swift UI.

Sources/LiveKit/Track/AudioTrack.swift

@@ -17,10 +17,12 @@
 import Foundation
 
 @objc
-public protocol AudioTrack where Self: Track {
+public protocol AudioTrackProtocol: AnyObject, Sendable {
     @objc(addAudioRenderer:)
     func add(audioRenderer: AudioRenderer)
 
     @objc(removeAudioRenderer:)
     func remove(audioRenderer: AudioRenderer)
 }
+
+public typealias AudioTrack = AudioTrackProtocol & Track

Sources/LiveKit/Track/Capturers/ARCameraCapturer.swift

@@ -21,7 +21,7 @@
 internal import LiveKitWebRTC
 
 @available(visionOS 2.0, *)
 public class ARCameraCapturer: VideoCapturer {
     private let capturer = RTC.createVideoCapturer()
     private let arKitSession = ARKitSession()
     private let cameraFrameProvider = CameraFrameProvider()
@@ -94,7 +94,7 @@
 public extension LocalVideoTrack {
     /// Creates a track that can directly capture `CVPixelBuffer` or `CMSampleBuffer` for convenience
     static func createARCameraTrack(name: String = Track.cameraName,
-                                    source: VideoTrack.Source = .camera,
+                                    source: Track.Source = .camera,
                                     options: ARCameraCaptureOptions = ARCameraCaptureOptions(),
                                     reportStatistics: Bool = false) -> LocalVideoTrack
     {

Sources/LiveKit/Track/Capturers/BufferCapturer.swift

@@ -59,7 +59,7 @@ public class BufferCapturer: VideoCapturer, @unchecked Sendable {
 public extension LocalVideoTrack {
     /// Creates a track that can directly capture `CVPixelBuffer` or `CMSampleBuffer` for convienience
     static func createBufferTrack(name: String = Track.screenShareVideoName,
-                                  source: VideoTrack.Source = .screenShareVideo,
+                                  source: Track.Source = .screenShareVideo,
                                   options: BufferCaptureOptions = BufferCaptureOptions(),
                                   reportStatistics: Bool = false) -> LocalVideoTrack
     {

Sources/LiveKit/Track/Local/LocalAudioTrack.swift

@@ -21,7 +21,7 @@ import Foundation
 internal import LiveKitWebRTC
 
 @objc
-public class LocalAudioTrack: Track, LocalTrack, AudioTrack, @unchecked Sendable {
+public class LocalAudioTrack: Track, LocalTrackProtocol, AudioTrackProtocol, @unchecked Sendable {
     /// ``AudioCaptureOptions`` used to create this track.
     public let captureOptions: AudioCaptureOptions
 

Sources/LiveKit/Track/Local/LocalTrack.swift

@@ -17,16 +17,18 @@
 import Foundation
 
 @objc
-public protocol LocalTrack where Self: Track {
+public protocol LocalTrackProtocol: AnyObject, Sendable {
     @objc
     var publishOptions: TrackPublishOptions? { get }
 
     @objc
-    var publishState: PublishState { get }
+    var publishState: Track.PublishState { get }
 
     @objc
     func mute() async throws
 
     @objc
     func unmute() async throws
 }
+
+public typealias LocalTrack = LocalTrackProtocol & Track

Sources/LiveKit/Track/Local/LocalVideoTrack.swift

@@ -19,7 +19,7 @@ import Foundation
 internal import LiveKitWebRTC
 
 @objc
-public class LocalVideoTrack: Track, LocalTrack, @unchecked Sendable {
+public class LocalVideoTrack: Track, LocalTrackProtocol, @unchecked Sendable {
     @objc
     public internal(set) var capturer: VideoCapturer
 
@@ -65,7 +65,7 @@ public class LocalVideoTrack: Track, LocalTrack, @unchecked Sendable {
 
 // MARK: - VideoTrack Protocol
 
-extension LocalVideoTrack: VideoTrack {
+extension LocalVideoTrack: VideoTrackProtocol {
     public func add(videoRenderer: VideoRenderer) {
         capturer.rendererDelegates.add(delegate: videoRenderer)
     }

Sources/LiveKit/Track/Remote/RemoteAudioTrack.swift

@@ -20,7 +20,7 @@ import CoreMedia
 internal import LiveKitWebRTC
 
 @objc
-public class RemoteAudioTrack: Track, RemoteTrack, AudioTrack, @unchecked Sendable {
+public class RemoteAudioTrack: Track, RemoteTrackProtocol, AudioTrackProtocol, @unchecked Sendable {
     /// Volume with range 0.0 - 1.0
     public var volume: Double {
         get {

Sources/LiveKit/Track/Remote/RemoteTrack.swift

@@ -17,4 +17,6 @@
 import Foundation
 
 @objc
-public protocol RemoteTrack where Self: Track {}
+public protocol RemoteTrackProtocol: AnyObject, Sendable {}
+
+public typealias RemoteTrack = RemoteTrackProtocol & Track

Sources/LiveKit/Track/Remote/RemoteVideoTrack.swift

@@ -17,7 +17,7 @@
 internal import LiveKitWebRTC
 
 @objc
-public class RemoteVideoTrack: Track, RemoteTrack, @unchecked Sendable {
+public class RemoteVideoTrack: Track, RemoteTrackProtocol, @unchecked Sendable {
     init(name: String,
          source: Track.Source,
          track: LKRTCMediaStreamTrack,
@@ -33,7 +33,7 @@ public class RemoteVideoTrack: Track, RemoteTrack, @unchecked Sendable {
 
 // MARK: - VideoTrack Protocol
 
-extension RemoteVideoTrack: VideoTrack {
+extension RemoteVideoTrack: VideoTrackProtocol {
     public func add(videoRenderer: VideoRenderer) {
         guard let rtcVideoTrack = mediaTrack as? LKRTCVideoTrack else {
             log("mediaTrack is not a RTCVideoTrack", .error)

Sources/LiveKit/Track/VideoTrack.swift

@@ -19,22 +19,24 @@ import Foundation
 internal import LiveKitWebRTC
 
 @objc
-public protocol VideoTrack where Self: Track {
+public protocol VideoTrackProtocol: AnyObject, Sendable {
     @objc(addVideoRenderer:)
     func add(videoRenderer: VideoRenderer)
 
     @objc(removeVideoRenderer:)
     func remove(videoRenderer: VideoRenderer)
 }
 
+public typealias VideoTrack = Track & VideoTrackProtocol
+
 // Directly add/remove renderers for better performance
 protocol VideoTrack_Internal where Self: Track {
     func add(rtcVideoRenderer: LKRTCVideoRenderer)
 
     func remove(rtcVideoRenderer: LKRTCVideoRenderer)
 }
 
-extension VideoTrack {
+extension VideoTrackProtocol where Self: Track {
     // Update a single SubscribedCodec
     func _set(subscribedCodec: Livekit_SubscribedCodec) throws -> Bool {
         guard let videoCodec = VideoCodec.from(name: subscribedCodec.codec) else { return false }

Sources/LiveKit/TrackPublications/TrackPublication.swift

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import Combine
 import Foundation
 
 @objc

Sources/LiveKit/VideoProcessors/BackgroundBlurVideoProcessor.swift

@@ -171,5 +171,3 @@ public final class BackgroundBlurVideoProcessor: NSObject, @unchecked Sendable,
         return cachedPixelBuffer
     }
 }
-
-extension CVPixelBuffer: @unchecked Swift.Sendable {}