Migrate FLTCaptureDeviceFormat class to Swift

RobertOdrowaz · RobertOdrowaz · commit 0ce8793f666a · 2025-11-16T12:23:20.000+01:00
diff --git a/packages/camera/camera_avfoundation/CHANGELOG.md b/packages/camera/camera_avfoundation/CHANGELOG.md
@@ -1,6 +1,6 @@
 ## 0.9.22+6
 
-* Migrates `FLTCaptureConnection` class to Swift.
+* Migrates `FLTCaptureConnection` and `FLTCaptureDeviceFormat` classes to Swift.
 
 ## 0.9.22+5
 
diff --git a/packages/camera/camera_avfoundation/example/ios/RunnerTests/CameraSettingsTests.swift b/packages/camera/camera_avfoundation/example/ios/RunnerTests/CameraSettingsTests.swift
@@ -203,7 +203,7 @@ final class CameraSettingsTests: XCTestCase {
     configuration.mediaSettings = settings
     let camera = CameraTestUtils.createTestCamera(configuration)
 
-    let range = camera.captureDevice.flutterActiveFormat.videoSupportedFrameRateRanges[0]
+    let range = camera.captureDevice.flutterActiveFormat.flutterVideoSupportedFrameRateRanges[0]
     XCTAssertLessThanOrEqual(range.minFrameRate, 60)
     XCTAssertGreaterThanOrEqual(range.maxFrameRate, 60)
   }
diff --git a/packages/camera/camera_avfoundation/example/ios/RunnerTests/CameraTestUtils.swift b/packages/camera/camera_avfoundation/example/ios/RunnerTests/CameraTestUtils.swift
@@ -39,17 +39,17 @@ enum CameraTestUtils {
     let frameRateRangeMock1 = MockFrameRateRange.init(minFrameRate: 3, maxFrameRate: 30)
 
     let captureDeviceFormatMock1 = MockCaptureDeviceFormat()
-    captureDeviceFormatMock1.videoSupportedFrameRateRanges = [frameRateRangeMock1]
+    captureDeviceFormatMock1.flutterVideoSupportedFrameRateRanges = [frameRateRangeMock1]
 
     let frameRateRangeMock2 = MockFrameRateRange.init(minFrameRate: 3, maxFrameRate: 60)
 
     let captureDeviceFormatMock2 = MockCaptureDeviceFormat()
-    captureDeviceFormatMock2.videoSupportedFrameRateRanges = [frameRateRangeMock2]
+    captureDeviceFormatMock2.flutterVideoSupportedFrameRateRanges = [frameRateRangeMock2]
 
     let captureDeviceMock = MockCaptureDevice()
     captureDeviceMock.flutterFormats = [captureDeviceFormatMock1, captureDeviceFormatMock2]
 
-    var currentFormat: FLTCaptureDeviceFormat = captureDeviceFormatMock1
+    var currentFormat: CaptureDeviceFormat = captureDeviceFormatMock1
 
     captureDeviceMock.activeFormatStub = { currentFormat }
     captureDeviceMock.setActiveFormatStub = { format in
diff --git a/packages/camera/camera_avfoundation/example/ios/RunnerTests/Mocks/MockCaptureDevice.swift b/packages/camera/camera_avfoundation/example/ios/RunnerTests/Mocks/MockCaptureDevice.swift
@@ -12,8 +12,8 @@
 /// A mock implementation of `FLTCaptureDevice` that allows mocking the class
 /// properties.
 class MockCaptureDevice: NSObject, CaptureDevice {
-  var activeFormatStub: (() -> FLTCaptureDeviceFormat)?
-  var setActiveFormatStub: ((FLTCaptureDeviceFormat) -> Void)?
+  var activeFormatStub: (() -> CaptureDeviceFormat)?
+  var setActiveFormatStub: ((CaptureDeviceFormat) -> Void)?
   var getTorchModeStub: (() -> AVCaptureDevice.TorchMode)?
   var setTorchModeStub: ((AVCaptureDevice.TorchMode) -> Void)?
   var isFocusModeSupportedStub: ((AVCaptureDevice.FocusMode) -> Bool)?
@@ -34,7 +34,7 @@ class MockCaptureDevice: NSObject, CaptureDevice {
   var position = AVCaptureDevice.Position.unspecified
   var deviceType = AVCaptureDevice.DeviceType.builtInWideAngleCamera
 
-  var flutterActiveFormat: FLTCaptureDeviceFormat {
+  var flutterActiveFormat: CaptureDeviceFormat {
     get {
       activeFormatStub?() ?? MockCaptureDeviceFormat()
     }
@@ -43,7 +43,7 @@ class MockCaptureDevice: NSObject, CaptureDevice {
     }
   }
 
-  var flutterFormats: [FLTCaptureDeviceFormat] = []
+  var flutterFormats: [CaptureDeviceFormat] = []
   var hasFlash = false
   var hasTorch = false
   var isTorchAvailable = false
diff --git a/packages/camera/camera_avfoundation/example/ios/RunnerTests/Mocks/MockCaptureDeviceFormat.swift b/packages/camera/camera_avfoundation/example/ios/RunnerTests/Mocks/MockCaptureDeviceFormat.swift
@@ -2,20 +2,20 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-import camera_avfoundation
+@testable import camera_avfoundation
 
 // Import Objective-C part of the implementation when SwiftPM is used.
 #if canImport(camera_avfoundation_objc)
   import camera_avfoundation_objc
 #endif
 
-/// A mock implementation of `FLTCaptureDeviceFormat` that allows mocking the class
+/// A mock implementation of `CaptureDeviceFormat` that allows mocking the class
 /// properties.
-final class MockCaptureDeviceFormat: NSObject, FLTCaptureDeviceFormat {
+final class MockCaptureDeviceFormat: NSObject, CaptureDeviceFormat {
 
   /// The format associated with the capture device.
-  var format: AVCaptureDevice.Format {
-    preconditionFailure("Attempted to access unimplemented property: format")
+  var avFormat: AVCaptureDevice.Format {
+    preconditionFailure("Attempted to access unimplemented property: avFormat")
   }
 
   var _formatDescription: CMVideoFormatDescription?
@@ -26,7 +26,7 @@ final class MockCaptureDeviceFormat: NSObject, FLTCaptureDeviceFormat {
   }
 
   /// The array of frame rate ranges supported by the video format.
-  var videoSupportedFrameRateRanges: [FLTFrameRateRange] = []
+  var flutterVideoSupportedFrameRateRanges: [FrameRateRange] = []
 
   override init() {
     super.init()
diff --git a/packages/camera/camera_avfoundation/example/ios/RunnerTests/Mocks/MockFrameRateRange.swift b/packages/camera/camera_avfoundation/example/ios/RunnerTests/Mocks/MockFrameRateRange.swift
@@ -2,20 +2,20 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-import camera_avfoundation
+@testable import camera_avfoundation
 
 // Import Objective-C part of the implementation when SwiftPM is used.
 #if canImport(camera_avfoundation_objc)
   import camera_avfoundation_objc
 #endif
 
-/// A mock implementation of `FLTFrameRateRange` that allows mocking the class properties.
-final class MockFrameRateRange: NSObject, FLTFrameRateRange {
-  var minFrameRate: Float
-  var maxFrameRate: Float
+/// A mock implementation of `FrameRateRange` that allows mocking the class properties.
+final class MockFrameRateRange: NSObject, FrameRateRange {
+  var minFrameRate: Float64
+  var maxFrameRate: Float64
 
   /// Initializes a `MockFrameRateRange` with the given frame rate range.
-  init(minFrameRate: Float, maxFrameRate: Float) {
+  init(minFrameRate: Float64, maxFrameRate: Float64) {
     self.minFrameRate = minFrameRate
     self.maxFrameRate = maxFrameRate
   }
diff --git a/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/CaptureDevice.swift b/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/CaptureDevice.swift
@@ -27,8 +27,8 @@ protocol CaptureDevice: NSObjectProtocol {
   var deviceType: AVCaptureDevice.DeviceType { get }
 
   // Format/Configuration
-  var flutterActiveFormat: FLTCaptureDeviceFormat { get set }
-  var flutterFormats: [FLTCaptureDeviceFormat] { get }
+  var flutterActiveFormat: CaptureDeviceFormat { get set }
+  var flutterFormats: [CaptureDeviceFormat] { get }
 
   // Flash/Torch
   var hasFlash: Bool { get }
@@ -91,14 +91,12 @@ protocol CaptureDeviceInputFactory: NSObjectProtocol {
 extension AVCaptureDevice: CaptureDevice {
   var avDevice: AVCaptureDevice { self }
 
-  var flutterActiveFormat: FLTCaptureDeviceFormat {
-    get { FLTDefaultCaptureDeviceFormat.init(format: activeFormat) }
-    set { activeFormat = newValue.format }
+  var flutterActiveFormat: CaptureDeviceFormat {
+    get { activeFormat }
+    set { activeFormat = newValue.avFormat }
   }
 
-  var flutterFormats: [FLTCaptureDeviceFormat] {
-    return self.formats.map { FLTDefaultCaptureDeviceFormat.init(format: $0) }
-  }
+  var flutterFormats: [CaptureDeviceFormat] { formats }
 }
 
 extension AVCaptureInput: CaptureInput {
diff --git a/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/CaptureDeviceFormat.swift b/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/CaptureDeviceFormat.swift
@@ -0,0 +1,31 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import AVFoundation
+
+/// A protocol which is a direct passthrough to `AVFrameRateRange`. It exists to allow replacing
+/// `AVFrameRateRange` in tests as it has no public initializer.
+protocol FrameRateRange: NSObjectProtocol {
+  var minFrameRate: Float64 { get }
+  var maxFrameRate: Float64 { get }
+}
+
+/// A protocol which is a direct passthrough to `AVCaptureDeviceFormat`. It exists to allow
+/// replacing `AVCaptureDeviceFormat` in tests as it has no public initializer.
+protocol CaptureDeviceFormat: NSObjectProtocol {
+  /// The underlying `AVCaptureDeviceFormat` instance. This exists so that the format
+  /// can be extracted when setting the active format on a device.
+  var avFormat: AVCaptureDevice.Format { get }
+
+  var formatDescription: CMFormatDescription { get }
+  var flutterVideoSupportedFrameRateRanges: [FrameRateRange] { get }
+}
+
+extension AVFrameRateRange: FrameRateRange {}
+
+extension AVCaptureDevice.Format: CaptureDeviceFormat {
+  var avFormat: AVCaptureDevice.Format { self }
+
+  var flutterVideoSupportedFrameRateRanges: [FrameRateRange] { videoSupportedFrameRateRanges }
+}
diff --git a/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/CaptureOutput.swift b/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/CaptureOutput.swift
@@ -3,7 +3,6 @@
 // found in the LICENSE file.
 
 import AVFoundation
-import Foundation
 
 // Import Objective-C part of the implementation when SwiftPM is used.
 #if canImport(camera_avfoundation_objc)
diff --git a/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/DefaultCamera.swift b/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/DefaultCamera.swift
@@ -309,11 +309,11 @@ final class DefaultCamera: NSObject, Camera {
   /// Finds the highest available resolution in terms of pixel count for the given device.
   /// Preferred are formats with the same subtype as current activeFormat.
   private func highestResolutionFormat(forCaptureDevice captureDevice: CaptureDevice)
-    -> FLTCaptureDeviceFormat?
+    -> CaptureDeviceFormat?
   {
     let preferredSubType = CMFormatDescriptionGetMediaSubType(
       captureDevice.flutterActiveFormat.formatDescription)
-    var bestFormat: FLTCaptureDeviceFormat? = nil
+    var bestFormat: CaptureDeviceFormat? = nil
     var maxPixelCount: UInt = 0
     var isBestSubTypePreferred = false
 
diff --git a/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/FormatUtils.swift b/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/FormatUtils.swift
@@ -11,17 +11,17 @@ import AVFoundation
 
 /// Determines the video dimensions (width and height) for a given capture device format.
 /// Used in tests to mock CMVideoFormatDescriptionGetDimensions.
-typealias VideoDimensionsConverter = (FLTCaptureDeviceFormat) -> CMVideoDimensions
+typealias VideoDimensionsConverter = (CaptureDeviceFormat) -> CMVideoDimensions
 
 enum FormatUtils {
   /// Returns frame rate supported by format closest to targetFrameRate.
-  static private func bestFrameRate(for format: FLTCaptureDeviceFormat, targetFrameRate: Double)
+  static private func bestFrameRate(for format: CaptureDeviceFormat, targetFrameRate: Double)
     -> Double
   {
     var bestFrameRate: Double = 0
     var minDistance: Double = Double.greatestFiniteMagnitude
 
-    for range in format.videoSupportedFrameRateRanges {
+    for range in format.flutterVideoSupportedFrameRateRanges {
       let frameRate = min(
         max(targetFrameRate, Double(range.minFrameRate)), Double(range.maxFrameRate))
       let distance = abs(frameRate - targetFrameRate)
diff --git a/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/MediaSettingsAVWrapper.swift b/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/MediaSettingsAVWrapper.swift
@@ -4,7 +4,6 @@
 
 import AVFoundation
 import CoreMedia
-import Foundation
 
 // Import Objective-C part of the implementation when SwiftPM is used.
 #if canImport(camera_avfoundation_objc)
diff --git a/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation_objc/FLTCaptureDeviceFormat.m b/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation_objc/FLTCaptureDeviceFormat.m
diff --git a/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation_objc/include/camera_avfoundation/FLTCaptureDeviceFormat.h b/packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation_objc/include/camera_avfoundation/FLTCaptureDeviceFormat.h

Original file line number	Diff line number	Diff line change
`@@ -203,7 +203,7 @@ final class CameraSettingsTests: XCTestCase {`
`203`	`203`	`configuration.mediaSettings = settings`
`204`	`204`	`let camera = CameraTestUtils.createTestCamera(configuration)`
`205`	`205`
`206`		`- let range = camera.captureDevice.flutterActiveFormat.videoSupportedFrameRateRanges[0]`
	`206`	`+ let range = camera.captureDevice.flutterActiveFormat.flutterVideoSupportedFrameRateRanges[0]`
`207`	`207`	`XCTAssertLessThanOrEqual(range.minFrameRate, 60)`
`208`	`208`	`XCTAssertGreaterThanOrEqual(range.maxFrameRate, 60)`
`209`	`209`	`}`