Migrate FLTCameraDeviceDiscovering and FLTDeviceOrientationProviding classes to Swift

Author: RobertOdrowaz

packages/camera/camera_avfoundation/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.9.22+4
+
+* Migrates `FLTCameraDeviceDiscovering` and `FLTDeviceOrientationProviding` classes to Swift.
+
 ## 0.9.22+3
 
 * Updates examples to use the new RadioGroup API instead of deprecated Radio parameters.

packages/camera/camera_avfoundation/example/ios/RunnerTests/Mocks/MockCameraDeviceDiscoverer.swift

@@ -2,16 +2,16 @@
 // 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
 
-/// Mock implementation of `FLTCameraDeviceDiscovering` protocol which allows injecting a custom
+/// Mock implementation of `FLTCameraDeviceDiscoverer` protocol which allows injecting a custom
 /// implementation for session discovery.
-final class MockCameraDeviceDiscoverer: NSObject, FLTCameraDeviceDiscovering {
+final class MockCameraDeviceDiscoverer: NSObject, CameraDeviceDiscoverer {
   var discoverySessionStub:
     (
       (

packages/camera/camera_avfoundation/example/ios/RunnerTests/Mocks/MockDeviceOrientationProvider.swift

@@ -2,17 +2,17 @@
 // 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
 
-final class MockDeviceOrientationProvider: NSObject, FLTDeviceOrientationProviding {
+final class MockDeviceOrientationProvider: NSObject, DeviceOrientationProvider {
   var orientationStub: (() -> UIDeviceOrientation)?
 
-  func orientation() -> UIDeviceOrientation {
+  var orientation: UIDeviceOrientation {
     return orientationStub?() ?? .unknown
   }
 }

packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/CameraConfiguration.swift

@@ -43,7 +43,7 @@ class CameraConfiguration {
   var assetWriterFactory: AssetWriterFactory
   var inputPixelBufferAdaptorFactory: InputPixelBufferAdaptorFactory
   var videoDimensionsConverter: VideoDimensionsConverter
-  var deviceOrientationProvider: FLTDeviceOrientationProviding
+  var deviceOrientationProvider: DeviceOrientationProvider
   let initialCameraName: String
   var orientation: UIDeviceOrientation
 
@@ -67,7 +67,7 @@ class CameraConfiguration {
     self.captureDeviceInputFactory = captureDeviceInputFactory
     self.initialCameraName = initialCameraName
     self.orientation = UIDevice.current.orientation
-    self.deviceOrientationProvider = FLTDefaultDeviceOrientationProvider()
+    self.deviceOrientationProvider = DefaultDeviceOrientationProvider()
 
     self.videoDimensionsConverter = { format in
       return CMVideoFormatDescriptionGetDimensions(format.formatDescription)

packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/CameraDeviceDiscoverer.swift

@@ -0,0 +1,43 @@
+// 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
+
+// Import Objective-C part of the implementation when SwiftPM is used.
+#if canImport(camera_avfoundation_objc)
+  import camera_avfoundation_objc
+#endif
+
+/// A protocol which abstracts the discovery of camera devices.
+/// It is a thin wrapper around `AVCaptureDiscoverySession` and it exists to allow mocking in tests.
+protocol CameraDeviceDiscoverer {
+  func discoverySession(
+    withDeviceTypes deviceTypes: [AVCaptureDevice.DeviceType],
+    mediaType: AVMediaType,
+    position: AVCaptureDevice.Position
+  ) -> [FLTCaptureDevice]
+}
+
+/// The default implementation of the `CameraDeviceDiscoverer` protocol.
+/// It wraps a call to `AVCaptureDeviceDiscoverySession`.
+public class FLTDefaultCameraDeviceDiscoverer: NSObject, CameraDeviceDiscoverer {
+  public func discoverySession(
+    withDeviceTypes deviceTypes: [AVCaptureDevice.DeviceType],
+    mediaType: AVMediaType,
+    position: AVCaptureDevice.Position
+  ) -> [FLTCaptureDevice] {
+    let discoverySession = AVCaptureDevice.DiscoverySession(
+      deviceTypes: deviceTypes,
+      mediaType: mediaType,
+      position: position
+    )
+
+    let devices = discoverySession.devices
+    let deviceControllers = devices.map { device in
+      FLTDefaultCaptureDevice(device: device) as FLTCaptureDevice
+    }
+
+    return deviceControllers
+  }
+}

packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/CameraPlugin.swift

@@ -14,7 +14,7 @@ public final class CameraPlugin: NSObject, FlutterPlugin {
   private let registry: FlutterTextureRegistry
   private let messenger: FlutterBinaryMessenger
   private let globalEventAPI: FCPCameraGlobalEventApi
-  private let deviceDiscoverer: FLTCameraDeviceDiscovering
+  private let deviceDiscoverer: CameraDeviceDiscoverer
   private let permissionManager: FLTCameraPermissionManager
   private let captureDeviceFactory: VideoCaptureDeviceFactory
   private let captureSessionFactory: CaptureSessionFactory
@@ -50,7 +50,7 @@ public final class CameraPlugin: NSObject, FlutterPlugin {
     registry: FlutterTextureRegistry,
     messenger: FlutterBinaryMessenger,
     globalAPI: FCPCameraGlobalEventApi,
-    deviceDiscoverer: FLTCameraDeviceDiscovering,
+    deviceDiscoverer: CameraDeviceDiscoverer,
     permissionManager: FLTCameraPermissionManager,
     deviceFactory: @escaping VideoCaptureDeviceFactory,
     captureSessionFactory: @escaping CaptureSessionFactory,

packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/DefaultCamera.swift

@@ -57,7 +57,7 @@ final class DefaultCamera: NSObject, Camera {
   /// Allows for alternate implementations in tests.
   private let videoDimensionsConverter: VideoDimensionsConverter
 
-  private let deviceOrientationProvider: FLTDeviceOrientationProviding
+  private let deviceOrientationProvider: DeviceOrientationProvider
   private let motionManager = CMMotionManager()
 
   private(set) var captureDevice: FLTCaptureDevice
@@ -858,7 +858,7 @@ final class DefaultCamera: NSObject, Camera {
       return
     }
 
-    let orientation = deviceOrientationProvider.orientation()
+    let orientation = deviceOrientationProvider.orientation
     try? captureDevice.lockForConfiguration()
     // A nil point resets to the center.
     captureDevice.setFocusPointOfInterest(

packages/camera/camera_avfoundation/ios/camera_avfoundation/Sources/camera_avfoundation/DeviceOrientationProvider.swift

@@ -0,0 +1,20 @@
+// 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 UIKit
+
+/// A protocol which provides the current device orientation.
+/// It exists to allow replacing UIDevice in tests.
+protocol DeviceOrientationProvider {
+  /// Returns the physical orientation of the device.
+  var orientation: UIDeviceOrientation { get }
+}
+
+/// A default implementation of DeviceOrientationProvider which uses orientation
+/// of the current device from UIDevice.
+@objc public class DefaultDeviceOrientationProvider: NSObject, DeviceOrientationProvider {
+  @objc public var orientation: UIDeviceOrientation {
+    return UIDevice.current.orientation
+  }
+}