Migrate FLTCamConfiguration, FLTCamMediaSettingsAVWrapper, FLTCaptureOutput, FLTCapturePhotoOutput, FLTCaptureVideoDataOutput to Swift

Author: RobertOdrowaz

packages/camera/camera_avfoundation/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.9.21+5
+
+* Migrates `FLTCamConfiguration`, `FLTCamMediaSettingsAVWrapper` classes to Swift.
+* Migrates `FLTCaptureOutput`, `FLTCapturePhotoOutput`, `FLTCaptureVideoDataOutput` protocols to Swift.
+
 ## 0.9.21+4
 
 * Migrates `updateOrientation` and `setCaptureSessionPreset` methods to Swift.

packages/camera/camera_avfoundation/example/ios/RunnerTests/CameraSettingsTests.swift

@@ -106,7 +106,7 @@ private final class TestMediaSettingsAVWrapper: FLTCamMediaSettingsAVWrapper {
   }
 
   override func recommendedVideoSettingsForAssetWriter(
-    withFileType fileType: AVFileType, for output: FLTCaptureVideoDataOutput
+    withFileType fileType: AVFileType, for output: CaptureVideoDataOutput
   ) -> [String: Any]? {
     return [:]
   }

packages/camera/camera_avfoundation/example/ios/RunnerTests/FLTCamSetFlashModeTests.swift

@@ -88,7 +88,7 @@ final class FLTCamSetFlashModeTests: XCTestCase {
     let (camera, mockDevice, mockCapturePhotoOutput) = createCamera()
 
     mockCapturePhotoOutput.supportedFlashModes = [
-      NSNumber(value: AVCaptureDevice.FlashMode.auto.rawValue)
+      AVCaptureDevice.FlashMode.auto
     ]
 
     mockDevice.hasFlash = true

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

@@ -2,7 +2,7 @@
 // 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)
@@ -11,11 +11,11 @@ import camera_avfoundation
 
 /// Mock implementation of `FLTCapturePhotoOutput` protocol which allows injecting a custom
 /// implementation.
-final class MockCapturePhotoOutput: NSObject, FLTCapturePhotoOutput {
+final class MockCapturePhotoOutput: NSObject, CapturePhotoOutput {
   var avOutput = AVCapturePhotoOutput()
   var availablePhotoCodecTypes: [AVVideoCodecType] = []
-  var highResolutionCaptureEnabled = false
-  var supportedFlashModes: [NSNumber] = []
+  var isHighResolutionCaptureEnabled = false
+  var supportedFlashModes: [AVCaptureDevice.FlashMode] = []
 
   // Stub that is called when the corresponding public method is called.
   var capturePhotoWithSettingsStub:

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

@@ -2,7 +2,7 @@
 // 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)
@@ -11,11 +11,10 @@ import camera_avfoundation
 
 /// Mock implementation of `FLTCaptureVideoDataOutput` protocol which allows injecting a custom
 /// implementation.
-class MockCaptureVideoDataOutput: NSObject, FLTCaptureVideoDataOutput {
-
+class MockCaptureVideoDataOutput: NSObject, CaptureVideoDataOutput {
   var avOutput = AVCaptureVideoDataOutput()
   var alwaysDiscardsLateVideoFrames = false
-  var videoSettings: [String: Any] = [:]
+  var videoSettings: [String: Any]! = [:]
 
   var connectionWithMediaTypeStub: ((AVMediaType) -> FLTCaptureConnection?)?
 

packages/camera/camera_avfoundation/example/ios/RunnerTests/SampleBufferTests.swift

@@ -60,7 +60,7 @@ private class FakeMediaSettingsAVWrapper: FLTCamMediaSettingsAVWrapper {
   }
 
   override func recommendedVideoSettingsForAssetWriter(
-    withFileType fileType: AVFileType, for output: FLTCaptureVideoDataOutput
+    withFileType fileType: AVFileType, for output: CaptureVideoDataOutput
   ) -> [String: Any]? {
     return [:]
   }

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

@@ -0,0 +1,86 @@
+// 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 CoreMedia
+import Foundation
+import UIKit
+
+// Import Objective-C part of the implementation when SwiftPM is used.
+#if canImport(camera_avfoundation_objc)
+  import camera_avfoundation_objc
+#endif
+
+/// Factory block returning an FLTCaptureDevice.
+/// Used in tests to inject a device into DefaultCamera.
+typealias CaptureDeviceFactory = (String) -> FLTCaptureDevice
+
+typealias AudioCaptureDeviceFactory = () -> FLTCaptureDevice
+
+typealias CaptureSessionFactory = () -> FLTCaptureSession
+
+typealias AssetWriterFactory = (URL, AVFileType, inout NSError?) -> FLTAssetWriter?
+
+typealias InputPixelBufferAdaptorFactory = (FLTAssetWriterInput, [String: Any]?) -> FLTAssetWriterInputPixelBufferAdaptor
+
+/// Determines the video dimensions (width and height) for a given capture device format.
+/// Used in tests to mock CMVideoFormatDescriptionGetDimensions.
+typealias VideoDimensionsForFormat = (FLTCaptureDeviceFormat) -> CMVideoDimensions
+
+/// A configuration object that centralizes dependencies for `DefaultCamera`.
+class FLTCamConfiguration {
+  var mediaSettings: FCPPlatformMediaSettings
+  var mediaSettingsWrapper: FLTCamMediaSettingsAVWrapper
+  var captureSessionQueue: DispatchQueue
+  var videoCaptureSession: FLTCaptureSession
+  var audioCaptureSession: FLTCaptureSession
+  var captureDeviceFactory: CaptureDeviceFactory
+  let audioCaptureDeviceFactory: AudioCaptureDeviceFactory
+  let captureDeviceInputFactory: FLTCaptureDeviceInputFactory
+  var assetWriterFactory: AssetWriterFactory
+  var inputPixelBufferAdaptorFactory: InputPixelBufferAdaptorFactory
+  var videoDimensionsForFormat: VideoDimensionsForFormat
+  var deviceOrientationProvider: FLTDeviceOrientationProviding
+  let initialCameraName: String
+  var orientation: UIDeviceOrientation
+  
+  init(
+    mediaSettings: FCPPlatformMediaSettings,
+    mediaSettingsWrapper: FLTCamMediaSettingsAVWrapper,
+    captureDeviceFactory: @escaping CaptureDeviceFactory,
+    audioCaptureDeviceFactory: @escaping AudioCaptureDeviceFactory,
+    captureSessionFactory: @escaping CaptureSessionFactory,
+    captureSessionQueue: DispatchQueue,
+    captureDeviceInputFactory: FLTCaptureDeviceInputFactory,
+    initialCameraName: String
+  ) {
+    self.mediaSettings = mediaSettings
+    self.mediaSettingsWrapper = mediaSettingsWrapper
+    self.captureDeviceFactory = captureDeviceFactory
+    self.audioCaptureDeviceFactory = audioCaptureDeviceFactory
+    self.captureSessionQueue = captureSessionQueue
+    self.videoCaptureSession = captureSessionFactory()
+    self.audioCaptureSession = captureSessionFactory()
+    self.captureDeviceInputFactory = captureDeviceInputFactory
+    self.initialCameraName = initialCameraName
+    self.orientation = UIDevice.current.orientation
+    self.deviceOrientationProvider = FLTDefaultDeviceOrientationProvider()
+    
+    self.videoDimensionsForFormat = { format in
+      return CMVideoFormatDescriptionGetDimensions(format.formatDescription)
+    }
+    
+    self.assetWriterFactory = { url, fileType, error in
+      return FLTDefaultAssetWriter(url: url, fileType: fileType, error: &error)
+    }
+    
+    self.inputPixelBufferAdaptorFactory = { assetWriterInput, sourcePixelBufferAttributes in
+      let adaptor = AVAssetWriterInputPixelBufferAdaptor(
+        assetWriterInput: assetWriterInput.input,
+        sourcePixelBufferAttributes: sourcePixelBufferAttributes
+      )
+      return FLTDefaultAssetWriterInputPixelBufferAdaptor(adaptor: adaptor)
+    }
+  }
+}

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

@@ -0,0 +1,79 @@
+// 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 Foundation
+
+// Import Objective-C part of the implementation when SwiftPM is used.
+#if canImport(camera_avfoundation_objc)
+  import camera_avfoundation_objc
+#endif
+
+/// A protocol which is a direct passthrough to `AVCaptureOutput`. It exists to allow mocking
+/// `AVCaptureOutput` in tests.
+protocol CaptureOutput {
+  /// Returns a connection with the specified media type, or nil if no such connection exists.
+  func connection(withMediaType mediaType: AVMediaType) -> FLTCaptureConnection?
+}
+
+/// A protocol which is a direct passthrough to `AVCaptureVideoDataOutput`. It exists to allow
+/// mocking `AVCaptureVideoDataOutput` in tests.
+protocol CaptureVideoDataOutput: CaptureOutput {
+  /// The underlying instance of `AVCaptureVideoDataOutput`.
+  var avOutput: AVCaptureVideoDataOutput { get }
+  
+  /// Corresponds to the `alwaysDiscardsLateVideoFrames` property of `AVCaptureVideoDataOutput`
+  var alwaysDiscardsLateVideoFrames: Bool { get set }
+  
+  /// Corresponds to the `videoSettings` property of `AVCaptureVideoDataOutput`
+  var videoSettings: [String: Any]! { get set }
+  
+  /// Corresponds to the `setSampleBufferDelegate` method of `AVCaptureVideoDataOutput`
+  func setSampleBufferDelegate(
+    _ sampleBufferDelegate: AVCaptureVideoDataOutputSampleBufferDelegate?,
+    queue sampleBufferCallbackQueue: DispatchQueue?
+  )
+}
+
+extension AVCaptureVideoDataOutput: CaptureVideoDataOutput {
+  var avOutput: AVCaptureVideoDataOutput {
+    return self
+  }
+  
+  func connection(withMediaType mediaType: AVMediaType) -> FLTCaptureConnection? {
+    guard let connection = connection(with: mediaType) else { return nil }
+    return FLTDefaultCaptureConnection(connection: connection)
+  }
+}
+
+/// A protocol which is a direct passthrough to `AVCapturePhotoOutput`. It exists to allow mocking
+/// `AVCapturePhotoOutput` in tests.
+protocol CapturePhotoOutput: CaptureOutput {
+  /// The underlying instance of `AVCapturePhotoOutput`.
+  var avOutput: AVCapturePhotoOutput { get }
+  
+  /// Corresponds to the `availablePhotoCodecTypes` property of `AVCapturePhotoOutput`
+  var availablePhotoCodecTypes: [AVVideoCodecType] { get }
+  
+  /// Corresponds to the `isHighResolutionCaptureEnabled` property of `AVCapturePhotoOutput`
+  var isHighResolutionCaptureEnabled: Bool { get set }
+  
+  /// Corresponds to the `supportedFlashModes` property of `AVCapturePhotoOutput`
+  var supportedFlashModes: [AVCaptureDevice.FlashMode] { get }
+  
+  /// Corresponds to the `capturePhotoWithSettings` method of `AVCapturePhotoOutput`
+  func capturePhoto(with settings: AVCapturePhotoSettings, delegate: AVCapturePhotoCaptureDelegate)
+}
+
+/// Make AVCapturePhotoOutput conform to FLTCapturePhotoOutput protocol directly
+extension AVCapturePhotoOutput: CapturePhotoOutput {
+  var avOutput: AVCapturePhotoOutput {
+    return self
+  }
+  
+  func connection(withMediaType mediaType: AVMediaType) -> FLTCaptureConnection? {
+    guard let connection = connection(with: mediaType) else { return nil }
+    return FLTDefaultCaptureConnection(connection: connection)
+  }
+}

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

@@ -62,9 +62,9 @@ final class DefaultCamera: NSObject, Camera {
 
   private(set) var captureDevice: FLTCaptureDevice
   // Setter exposed for tests.
-  var captureVideoOutput: FLTCaptureVideoDataOutput
+  var captureVideoOutput: CaptureVideoDataOutput
   // Setter exposed for tests.
-  var capturePhotoOutput: FLTCapturePhotoOutput
+  var capturePhotoOutput: CapturePhotoOutput
   private var captureVideoInput: FLTCaptureInput
 
   private var videoWriter: FLTAssetWriter?
@@ -135,13 +135,12 @@ final class DefaultCamera: NSObject, Camera {
     captureDevice: FLTCaptureDevice,
     videoFormat: FourCharCode,
     captureDeviceInputFactory: FLTCaptureDeviceInputFactory
-  ) throws -> (FLTCaptureInput, FLTCaptureVideoDataOutput, AVCaptureConnection) {
+  ) throws -> (FLTCaptureInput, CaptureVideoDataOutput, AVCaptureConnection) {
     // Setup video capture input.
     let captureVideoInput = try captureDeviceInputFactory.deviceInput(with: captureDevice)
 
     // Setup video capture output.
-    let captureVideoOutput = FLTDefaultCaptureVideoDataOutput(
-      captureVideoOutput: AVCaptureVideoDataOutput())
+    let captureVideoOutput = AVCaptureVideoDataOutput()
     captureVideoOutput.videoSettings = [
       kCVPixelBufferPixelFormatTypeKey as String: videoFormat
     ]
@@ -176,8 +175,8 @@ final class DefaultCamera: NSObject, Camera {
     captureDevice = captureDeviceFactory(configuration.initialCameraName)
     flashMode = captureDevice.hasFlash ? .auto : .off
 
-    capturePhotoOutput = FLTDefaultCapturePhotoOutput(photoOutput: AVCapturePhotoOutput())
-    capturePhotoOutput.highResolutionCaptureEnabled = true
+    capturePhotoOutput = AVCapturePhotoOutput()
+    capturePhotoOutput.isHighResolutionCaptureEnabled = true
 
     videoCaptureSession.automaticallyConfiguresApplicationAudioSession = false
     audioCaptureSession.automaticallyConfiguresApplicationAudioSession = false
@@ -748,7 +747,7 @@ final class DefaultCamera: NSObject, Camera {
   }
 
   private func updateOrientation(
-    _ orientation: UIDeviceOrientation, forCaptureOutput captureOutput: FLTCaptureOutput
+    _ orientation: UIDeviceOrientation, forCaptureOutput captureOutput: CaptureOutput
   ) {
     if let connection = captureOutput.connection(withMediaType: .video),
       connection.isVideoOrientationSupported
@@ -989,7 +988,7 @@ final class DefaultCamera: NSObject, Camera {
         return
       }
       let avFlashMode = FCPGetAVCaptureFlashModeForPigeonFlashMode(mode)
-      guard capturePhotoOutput.supportedFlashModes.contains(NSNumber(value: avFlashMode.rawValue))
+      guard capturePhotoOutput.supportedFlashModes.contains(avFlashMode)
       else {
         completion(
           FlutterError(