@capgo/camera-preview 8.5.1 → 8.7.1

package/ios/Sources/CapgoCameraPreviewPlugin/CameraController.swift

@@ -1,4 +1,4 @@
-// swiftlint:disable file_length cyclomatic_complexity identifier_name
+// swiftlint:disable file_length type_body_length cyclomatic_complexity identifier_name function_body_length
 import AVFoundation
 import UIKit
 import CoreLocation
@@ -57,7 +57,6 @@ class CameraController: NSObject {
         }
     }
 
-
     private func setVideoOrientation(_ orientation: AVCaptureVideoOrientation, on connection: AVCaptureConnection) {
         guard connection.isVideoOrientationSupported else { return }
         connection.videoOrientation = orientation
@@ -151,10 +150,13 @@ class CameraController: NSObject {
 
     var videoFileURL: URL?
     var recordingFinishedCallback: ((URL, String) -> Void)?
+    private var stopRecordingCompletion: ((URL?, String?, Error?) -> Void)?
     private let saneMaxZoomFactor: CGFloat = 25.5
 
     var videoQuality: String = "high"
+    private var configuredVideoFrameRate: Int?
     var videoCodec: String = "avc1"
+    var videoStabilizationMode: String = "off"
 
     private static let allVideoQualities = ["low", "medium", "high", "2160p", "1080p", "720p", "480p", "4:3"]
 
@@ -213,6 +215,138 @@ class CameraController: NSObject {
         return self.videoCodec
     }
 
+    func isVideoStabilizationSupported() -> Bool {
+        guard let connection = self.fileVideoOutput?.connection(with: .video) else {
+            return false
+        }
+        return connection.isVideoStabilizationSupported
+    }
+
+    func getSupportedVideoStabilizationModes() -> [String] {
+        guard let connection = self.fileVideoOutput?.connection(with: .video),
+              connection.isVideoStabilizationSupported else {
+            return ["off"]
+        }
+
+        let savedPreferred = connection.preferredVideoStabilizationMode
+        var supported: [String] = []
+
+        for candidate in Self.allVideoStabilizationModeCandidates() {
+            connection.preferredVideoStabilizationMode = candidate.mode
+            if connection.preferredVideoStabilizationMode == candidate.mode {
+                supported.append(candidate.name)
+            }
+        }
+
+        connection.preferredVideoStabilizationMode = savedPreferred
+        return supported.isEmpty ? ["off"] : supported
+    }
+
+    func getVideoStabilizationMode() -> String {
+        if let connection = self.fileVideoOutput?.connection(with: .video),
+           connection.isVideoStabilizationSupported {
+            return self.videoStabilizationModeString(from: connection.activeVideoStabilizationMode)
+        }
+        return self.videoStabilizationMode
+    }
+
+    func setVideoStabilizationMode(_ mode: String) throws {
+        if self.fileVideoOutput?.isRecording == true {
+            throw CameraControllerError.recordingInProgress
+        }
+        guard let avMode = self.avVideoStabilizationMode(from: mode) else {
+            throw CameraControllerError.invalidOperation
+        }
+        let supportedModes = self.getSupportedVideoStabilizationModes()
+        guard supportedModes.contains(mode) else {
+            throw CameraControllerError.invalidOperation
+        }
+        self.videoStabilizationMode = mode
+        self.applyVideoStabilizationMode(avMode)
+    }
+
+    private static func allVideoStabilizationModeCandidates() -> [(name: String, mode: AVCaptureVideoStabilizationMode)] {
+        var candidates: [(String, AVCaptureVideoStabilizationMode)] = [
+            ("off", .off),
+            ("standard", .standard),
+            ("cinematic", .cinematic),
+            ("cinematicExtended", .cinematicExtended),
+            ("auto", .auto)
+        ]
+        if #available(iOS 17.0, *) {
+            candidates.append(("previewOptimized", .previewOptimized))
+        }
+        if #available(iOS 18.0, *) {
+            candidates.append(("cinematicExtendedEnhanced", .cinematicExtendedEnhanced))
+        }
+        return candidates
+    }
+
+    private func applyVideoStabilizationMode(_ mode: AVCaptureVideoStabilizationMode? = nil) {
+        guard let connection = self.fileVideoOutput?.connection(with: .video),
+              connection.isVideoStabilizationSupported else {
+            return
+        }
+        let targetMode = mode ?? self.avVideoStabilizationMode(from: self.videoStabilizationMode) ?? .off
+        connection.preferredVideoStabilizationMode = targetMode
+    }
+
+    private func avVideoStabilizationMode(from mode: String) -> AVCaptureVideoStabilizationMode? {
+        switch mode {
+        case "off":
+            return .off
+        case "standard":
+            return .standard
+        case "cinematic":
+            return .cinematic
+        case "cinematicExtended":
+            return .cinematicExtended
+        case "auto":
+            return .auto
+        case "previewOptimized":
+            if #available(iOS 17.0, *) {
+                return .previewOptimized
+            }
+            return nil
+        case "cinematicExtendedEnhanced":
+            if #available(iOS 18.0, *) {
+                return .cinematicExtendedEnhanced
+            }
+            return nil
+        case "lowLatency":
+            return nil
+        default:
+            return nil
+        }
+    }
+
+    private func videoStabilizationModeString(from mode: AVCaptureVideoStabilizationMode) -> String {
+        switch mode {
+        case .off:
+            return "off"
+        case .standard:
+            return "standard"
+        case .cinematic:
+            return "cinematic"
+        case .cinematicExtended:
+            return "cinematicExtended"
+        case .auto:
+            return "auto"
+        default:
+            if #available(iOS 17.0, *) {
+                if mode == .previewOptimized {
+                    return "previewOptimized"
+                }
+            }
+            if #available(iOS 18.0, *) {
+                if mode == .cinematicExtendedEnhanced {
+                    return "cinematicExtendedEnhanced"
+                }
+            }
+            return self.videoStabilizationMode
+        }
+    }
+
     private func avVideoCodecType(for codec: String) -> AVVideoCodecType? {
         switch codec.lowercased() {
         case "avc1":
@@ -515,6 +649,7 @@ extension CameraController {
                     captureSession.addOutput(fileVideoOutput)
                     // Set orientation immediately
                     self.setVideoOrientation(videoOrientation, on: fileVideoOutput.connections)
+                    self.applyVideoStabilizationMode()
                 }
 
                 // Set up preview layer session in the same configuration block
@@ -987,6 +1122,7 @@ extension CameraController {
     }
 
     func switchCameras() throws {
+        configuredVideoFrameRate = nil
         guard let currentCameraPosition = currentCameraPosition,
               let captureSession = self.captureSession else {
             throw CameraControllerError.captureSessionIsMissing
@@ -1094,6 +1230,7 @@ extension CameraController {
             captureSession.removeOutput(fileVideoOutput)
             if captureSession.canAddOutput(fileVideoOutput) {
                 captureSession.addOutput(fileVideoOutput)
+                self.applyVideoStabilizationMode()
             }
         }
 
@@ -2240,6 +2377,7 @@ extension CameraController {
     }
 
     func cleanup() {
+        configuredVideoFrameRate = nil
         stopBarcodeScanner()
         if let captureSession = self.captureSession {
             captureSession.stopRunning()
@@ -2447,6 +2585,129 @@ extension CameraController {
         }
     }
 
+    private func activeVideoDevice() -> AVCaptureDevice? {
+        switch currentCameraPosition {
+        case .front:
+            return self.frontCamera
+        case .rear:
+            return self.rearCamera
+        default:
+            return nil
+        }
+    }
+
+    private func frameRates(from format: AVCaptureDevice.Format) -> [Int] {
+        var rates = Set<Int>()
+        let standardRates = [24, 25, 30, 50, 60, 120]
+
+        for range in format.videoSupportedFrameRateRanges {
+            let minFps = Int(ceil(range.minFrameRate))
+            let maxFps = Int(floor(range.maxFrameRate))
+
+            if minFps == maxFps {
+                rates.insert(minFps)
+                continue
+            }
+
+            rates.insert(minFps)
+            rates.insert(maxFps)
+
+            for rate in standardRates where rate >= minFps && rate <= maxFps {
+                rates.insert(rate)
+            }
+        }
+
+        return rates.sorted()
+    }
+
+    private func formatSupportsFrameRate(_ format: AVCaptureDevice.Format, frameRate: Int) -> Bool {
+        let fps = Double(frameRate)
+        return format.videoSupportedFrameRateRanges.contains { range in
+            fps >= range.minFrameRate && fps <= range.maxFrameRate
+        }
+    }
+
+    private func frameRate(from duration: CMTime) -> Int {
+        guard duration.value > 0 else { return 30 }
+        return Int(round(Double(duration.timescale) / Double(duration.value)))
+    }
+
+    private func allSupportedFrameRates(for device: AVCaptureDevice) -> [Int] {
+        var rates = Set<Int>()
+        for format in device.formats {
+            for rate in frameRates(from: format) {
+                rates.insert(rate)
+            }
+        }
+        return rates.sorted()
+    }
+
+    func getSupportedVideoFrameRates() throws -> [Int] {
+        guard let device = activeVideoDevice() else {
+            throw CameraControllerError.noCamerasAvailable
+        }
+
+        return allSupportedFrameRates(for: device)
+    }
+
+    func getVideoFrameRate() throws -> Int {
+        if let configuredVideoFrameRate = self.configuredVideoFrameRate {
+            return configuredVideoFrameRate
+        }
+
+        guard let device = activeVideoDevice() else {
+            throw CameraControllerError.noCamerasAvailable
+        }
+
+        return frameRate(from: device.activeVideoMinFrameDuration)
+    }
+
+    func setVideoFrameRate(_ frameRate: Int) throws {
+        guard frameRate > 0 else {
+            throw NSError(domain: "CameraPreview", code: 0, userInfo: [NSLocalizedDescriptionKey: "frameRate must be greater than 0"])
+        }
+
+        if let fileVideoOutput = self.fileVideoOutput, fileVideoOutput.isRecording {
+            throw NSError(domain: "CameraPreview", code: 0, userInfo: [NSLocalizedDescriptionKey: "Cannot change video frame rate while recording"])
+        }
+
+        guard let device = activeVideoDevice() else {
+            throw CameraControllerError.noCamerasAvailable
+        }
+
+        let supportedRates = allSupportedFrameRates(for: device)
+        guard supportedRates.contains(frameRate) else {
+            throw NSError(
+                domain: "CameraPreview",
+                code: 0,
+                userInfo: [NSLocalizedDescriptionKey: "Unsupported frame rate \(frameRate). Supported values: \(supportedRates.map(String.init).joined(separator: ", "))"]
+            )
+        }
+
+        guard let targetFormat = device.formats.first(where: { formatSupportsFrameRate($0, frameRate: frameRate) }) else {
+            throw NSError(
+                domain: "CameraPreview",
+                code: 0,
+                userInfo: [NSLocalizedDescriptionKey: "Unsupported frame rate \(frameRate) for the active camera"]
+            )
+        }
+
+        let frameDuration = CMTime(value: 1, timescale: CMTimeScale(frameRate))
+
+        do {
+            try device.lockForConfiguration()
+            if device.activeFormat != targetFormat {
+                device.activeFormat = targetFormat
+            }
+            device.activeVideoMinFrameDuration = frameDuration
+            device.activeVideoMaxFrameDuration = frameDuration
+            device.unlockForConfiguration()
+            self.configuredVideoFrameRate = frameRate
+        } catch {
+            throw CameraControllerError.invalidOperation
+        }
+    }
+
     func captureVideo(maxDuration: Float? = nil, maxFileSize: Int? = nil) throws {
         guard let captureSession = self.captureSession, captureSession.isRunning else {
             throw CameraControllerError.captureSessionIsMissing
@@ -2479,6 +2740,7 @@ extension CameraController {
             captureSession.beginConfiguration()
             if captureSession.canAddOutput(fileVideoOutput) {
                 captureSession.addOutput(fileVideoOutput)
+                self.applyVideoStabilizationMode()
             } else {
                 captureSession.commitConfiguration()
                 throw CameraControllerError.invalidOperation
@@ -2520,6 +2782,8 @@ extension CameraController {
             fileVideoOutput.setOutputSettings([AVVideoCodecKey: codecType], for: connection)
         }
 
+        self.applyVideoStabilizationMode()
+
         // Start recording video
         fileVideoOutput.startRecording(to: fileUrl, recordingDelegate: self)
 
@@ -2527,21 +2791,26 @@ extension CameraController {
         self.videoFileURL = fileUrl
     }
 
-    func stopRecording(completion: @escaping (URL?, Error?) -> Void) {
+    func stopRecording(completion: @escaping (URL?, String?, Error?) -> Void) {
         guard let captureSession = self.captureSession, captureSession.isRunning else {
-            completion(nil, CameraControllerError.captureSessionIsMissing)
+            completion(nil, nil, CameraControllerError.captureSessionIsMissing)
             return
         }
         guard let fileVideoOutput = self.fileVideoOutput else {
-            completion(nil, CameraControllerError.fileVideoOutputNotFound)
+            completion(nil, nil, CameraControllerError.fileVideoOutputNotFound)
+            return
+        }
+        guard fileVideoOutput.isRecording else {
+            completion(nil, nil, CameraControllerError.invalidOperation)
+            return
+        }
+        guard self.stopRecordingCompletion == nil else {
+            completion(nil, nil, CameraControllerError.invalidOperation)
             return
         }
 
-        // Stop recording video
+        self.stopRecordingCompletion = completion
         fileVideoOutput.stopRecording()
-
-        // Return the video file URL in the completion handler
-        completion(self.videoFileURL, nil)
     }
 }
 
@@ -2824,6 +3093,7 @@ enum CameraControllerError: Swift.Error {
     case invalidOperation
     case noCamerasAvailable
     case cannotFindDocumentsDirectory
+    case recordingInProgress
     case fileVideoOutputNotFound
     case unknown
     case invalidZoomLevel(min: CGFloat, max: CGFloat, requested: CGFloat)
@@ -2851,6 +3121,8 @@ extension CameraControllerError: LocalizedError {
             return NSLocalizedString("Unknown", comment: "Unknown")
         case .cannotFindDocumentsDirectory:
             return NSLocalizedString("Cannot find documents directory", comment: "This should never happen")
+        case .recordingInProgress:
+            return NSLocalizedString("Cannot change video stabilization while recording is in progress.", comment: "Recording in progress")
         case .fileVideoOutputNotFound:
             return NSLocalizedString("Video recording is not available. Make sure the camera is properly initialized.", comment: "Video recording not available")
         case .invalidZoomLevel(let min, let max, let requested):
@@ -2934,6 +3206,19 @@ extension UIImage {
 extension CameraController: AVCaptureFileOutputRecordingDelegate {
     func fileOutput(_ output: AVCaptureFileOutput, didFinishRecordingTo outputFileURL: URL, from connections: [AVCaptureConnection], error: Error?) {
         let reason = recordingFinishReason(from: error)
+        let stopCompletion = self.stopRecordingCompletion
+        self.stopRecordingCompletion = nil
+
+        if let stopCompletion = stopCompletion {
+            DispatchQueue.main.async {
+                if reason == "error" {
+                    stopCompletion(nil, nil, error ?? CameraControllerError.unknown)
+                } else {
+                    stopCompletion(outputFileURL, reason, nil)
+                }
+            }
+        }
+
         if reason == "error" {
             print("Error recording movie: \(error?.localizedDescription ?? "unknown")")
             return

package/ios/Sources/CapgoCameraPreviewPlugin/Plugin.swift

@@ -35,7 +35,7 @@ extension UIWindow {
  */
 @objc(CameraPreview)
 public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelegate {
-    private let pluginVersion: String = "8.5.1"
+    private let pluginVersion: String = "8.7.1"
     public let identifier = "CameraPreviewPlugin"
     public let jsName = "CameraPreview"
     public let pluginMethods: [CAPPluginMethod] = [
@@ -54,6 +54,10 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
         CAPPluginMethod(name: "getSupportedVideoCodecs", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getVideoCodec", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setVideoCodec", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "isVideoStabilizationSupported", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getSupportedVideoStabilizationModes", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getVideoStabilizationMode", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "setVideoStabilizationMode", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getSupportedVideoQualities", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getVideoQuality", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setVideoQuality", returnType: CAPPluginReturnPromise),
@@ -86,6 +90,9 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
         CAPPluginMethod(name: "getExposureCompensationRange", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getExposureCompensation", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setExposureCompensation", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getSupportedVideoFrameRates", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getVideoFrameRate", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "setVideoFrameRate", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getPluginVersion", returnType: CAPPluginReturnPromise)
     ]
     // Camera state tracking
@@ -1643,12 +1650,45 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
         call.resolve(["codecs": self.cameraController.getSupportedVideoCodecs()])
     }
 
+    @objc func isVideoStabilizationSupported(_ call: CAPPluginCall) {
+        call.resolve(["supported": self.cameraController.isVideoStabilizationSupported()])
+    }
+
+    @objc func getSupportedVideoStabilizationModes(_ call: CAPPluginCall) {
+        call.resolve(["modes": self.cameraController.getSupportedVideoStabilizationModes()])
+    }
+
+    @objc func getVideoStabilizationMode(_ call: CAPPluginCall) {
+        call.resolve(["mode": self.cameraController.getVideoStabilizationMode()])
+    }
+
+    @objc func setVideoStabilizationMode(_ call: CAPPluginCall) {
+        guard let mode = call.getString("mode") else {
+            call.reject("mode is required")
+            return
+        }
+        do {
+            try self.cameraController.setVideoStabilizationMode(mode)
+            call.resolve()
+        } catch {
+            call.reject("Failed to set video stabilization mode: \(error.localizedDescription)")
+        }
+    }
+
     @objc func startRecordVideo(_ call: CAPPluginCall) {
         let maxDuration = call.getFloat("maxDuration")
         let maxFileSize = call.getInt("maxFileSize")
         if let videoCodec = call.getString("videoCodec") {
             try? self.cameraController.setVideoCodec(videoCodec)
         }
+        if let videoStabilizationMode = call.getString("videoStabilizationMode") {
+            do {
+                try self.cameraController.setVideoStabilizationMode(videoStabilizationMode)
+            } catch {
+                call.reject("Failed to set video stabilization mode: \(error.localizedDescription)")
+                return
+            }
+        }
         self.cameraController.recordingFinishedCallback = { [weak self] fileURL, reason in
             DispatchQueue.main.async {
                 self?.notifyListeners("recordingFinished", data: ["videoFilePath": fileURL.absoluteString, "reason": reason])
@@ -1656,6 +1696,9 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
         }
 
         do {
+            if let frameRate = call.getInt("frameRate") {
+                try self.cameraController.setVideoFrameRate(frameRate)
+            }
             try self.cameraController.captureVideo(maxDuration: maxDuration, maxFileSize: maxFileSize)
             call.resolve()
         } catch {
@@ -1664,8 +1707,8 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
     }
 
     @objc func stopRecordVideo(_ call: CAPPluginCall) {
-        self.cameraController.stopRecording { (fileURL, error) in
-            guard let fileURL = fileURL else {
+        self.cameraController.stopRecording { (fileURL, reason, error) in
+            guard let fileURL = fileURL, let reason = reason else {
                 print(error ?? "Video capture error")
                 guard let error = error else {
                     call.reject("Video capture error")
@@ -1675,7 +1718,7 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
                 return
             }
 
-            call.resolve(["videoFilePath": fileURL.absoluteString, "reason": "manual"])
+            call.resolve(["videoFilePath": fileURL.absoluteString, "reason": reason])
         }
     }
 
@@ -2436,6 +2479,49 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
         }
     }
 
+    @objc func getSupportedVideoFrameRates(_ call: CAPPluginCall) {
+        guard isInitialized else {
+            call.reject("Camera not initialized")
+            return
+        }
+        do {
+            let frameRates = try self.cameraController.getSupportedVideoFrameRates()
+            call.resolve(["frameRates": frameRates])
+        } catch {
+            call.reject("Failed to get supported video frame rates: \(error.localizedDescription)")
+        }
+    }
+
+    @objc func getVideoFrameRate(_ call: CAPPluginCall) {
+        guard isInitialized else {
+            call.reject("Camera not initialized")
+            return
+        }
+        do {
+            let frameRate = try self.cameraController.getVideoFrameRate()
+            call.resolve(["frameRate": frameRate])
+        } catch {
+            call.reject("Failed to get video frame rate: \(error.localizedDescription)")
+        }
+    }
+
+    @objc func setVideoFrameRate(_ call: CAPPluginCall) {
+        guard isInitialized else {
+            call.reject("Camera not initialized")
+            return
+        }
+        guard let frameRate = call.getInt("frameRate") else {
+            call.reject("frameRate parameter is required")
+            return
+        }
+        do {
+            try self.cameraController.setVideoFrameRate(frameRate)
+            call.resolve()
+        } catch {
+            call.reject(error.localizedDescription)
+        }
+    }
+
     private var lastOrientation: String?
 
     @objc private func handleOrientationChange() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/camera-preview",
-  "version": "8.5.1",
+  "version": "8.7.1",
   "description": "Camera preview",
   "license": "MPL-2.0",
   "repository": {