@capgo/camera-preview 8.3.8 → 8.4.0

package/ios/Sources/CapgoCameraPreviewPlugin/CameraController.swift

@@ -1,3 +1,4 @@
+// swiftlint:disable file_length cyclomatic_complexity identifier_name
 import AVFoundation
 import UIKit
 import CoreLocation
@@ -102,6 +103,7 @@ class CameraController: NSObject {
     var frontCameraInput: AVCaptureDeviceInput?
 
     var dataOutput: AVCaptureVideoDataOutput?
+    var metadataOutput: AVCaptureMetadataOutput?
     var photoOutput: AVCapturePhotoOutput?
 
     var rearCamera: AVCaptureDevice?
@@ -119,6 +121,10 @@ class CameraController: NSObject {
     var photoCaptureCompletionBlock: ((UIImage?, Data?, [AnyHashable: Any]?, Error?) -> Void)?
 
     var sampleBufferCaptureCompletionBlock: ((UIImage?, Error?) -> Void)?
+    var barcodeScannerCallback: (([[String: Any]]) -> Void)?
+    private let barcodeMetadataQueue = DispatchQueue(label: "com.camera.barcodeMetadataQueue", qos: .userInitiated)
+    private var barcodeDetectionInterval: TimeInterval = 0.5
+    private var lastBarcodeDetectionAt: TimeInterval = 0
 
     // Add callback for detecting when first frame is ready
     var firstFrameReadyCallback: (() -> Void)?
@@ -1561,6 +1567,137 @@ extension CameraController {
         self.sampleBufferCaptureCompletionBlock = completion
     }
 
+    func startBarcodeScanner(formats: [String], detectionIntervalMs: Int, callback: @escaping ([[String: Any]]) -> Void) throws {
+        guard let captureSession = captureSession,
+              captureSession.isRunning else {
+            throw CameraControllerError.captureSessionIsMissing
+        }
+
+        stopBarcodeScanner()
+
+        let output = AVCaptureMetadataOutput()
+        guard captureSession.canAddOutput(output) else {
+            throw CameraControllerError.invalidOperation
+        }
+
+        self.barcodeScannerCallback = callback
+        self.barcodeDetectionInterval = TimeInterval(max(100, detectionIntervalMs)) / 1000.0
+        self.lastBarcodeDetectionAt = 0
+
+        captureSession.beginConfiguration()
+        captureSession.addOutput(output)
+        captureSession.commitConfiguration()
+
+        let requestedTypes = metadataObjectTypes(for: formats)
+        let availableTypes = output.availableMetadataObjectTypes
+        let enabledTypes = requestedTypes.isEmpty ? availableTypes : requestedTypes.filter { availableTypes.contains($0) }
+
+        guard !enabledTypes.isEmpty else {
+            captureSession.beginConfiguration()
+            captureSession.removeOutput(output)
+            captureSession.commitConfiguration()
+            self.barcodeScannerCallback = nil
+            throw CameraControllerError.invalidOperation
+        }
+
+        output.metadataObjectTypes = enabledTypes
+        output.setMetadataObjectsDelegate(self, queue: barcodeMetadataQueue)
+        self.metadataOutput = output
+    }
+
+    func stopBarcodeScanner() {
+        metadataOutput?.setMetadataObjectsDelegate(nil, queue: nil)
+        if let output = metadataOutput,
+           let captureSession = captureSession,
+           captureSession.outputs.contains(output) {
+            captureSession.beginConfiguration()
+            captureSession.removeOutput(output)
+            captureSession.commitConfiguration()
+        }
+        metadataOutput = nil
+        barcodeScannerCallback = nil
+        lastBarcodeDetectionAt = 0
+    }
+
+    private func metadataObjectTypes(for formats: [String]) -> [AVMetadataObject.ObjectType] {
+        guard !formats.isEmpty else { return [] }
+
+        var result: [AVMetadataObject.ObjectType] = []
+        for format in formats {
+            let mappedTypes = metadataObjectTypes(for: format)
+            for type in mappedTypes where !result.contains(type) {
+                result.append(type)
+            }
+        }
+        return result
+    }
+
+    private func metadataObjectTypes(for format: String) -> [AVMetadataObject.ObjectType] {
+        switch format {
+        case "aztec":
+            return [.aztec]
+        case "code_39":
+            return [.code39, .code39Mod43]
+        case "code_93":
+            return [.code93]
+        case "code_128":
+            return [.code128]
+        case "data_matrix":
+            return [.dataMatrix]
+        case "ean_8":
+            return [.ean8]
+        case "ean_13", "upc_a":
+            return [.ean13]
+        case "itf":
+            return [.interleaved2of5, .itf14]
+        case "pdf417":
+            return [.pdf417]
+        case "qr_code":
+            return [.qr]
+        case "upc_e":
+            return [.upce]
+        case "codabar":
+            if #available(iOS 15.4, *) {
+                return [.codabar]
+            }
+            return []
+        default:
+            return []
+        }
+    }
+
+    private func barcodeFormat(from type: AVMetadataObject.ObjectType) -> String {
+        switch type {
+        case .aztec:
+            return "aztec"
+        case .code39, .code39Mod43:
+            return "code_39"
+        case .code93:
+            return "code_93"
+        case .code128:
+            return "code_128"
+        case .dataMatrix:
+            return "data_matrix"
+        case .ean8:
+            return "ean_8"
+        case .ean13:
+            return "ean_13"
+        case .interleaved2of5, .itf14:
+            return "itf"
+        case .pdf417:
+            return "pdf417"
+        case .qr:
+            return "qr_code"
+        case .upce:
+            return "upc_e"
+        default:
+            if #available(iOS 15.4, *), type == .codabar {
+                return "codabar"
+            }
+            return "unknown"
+        }
+    }
+
     func getSupportedFlashModes() throws -> [String] {
         var currentCamera: AVCaptureDevice?
         switch currentCameraPosition {
@@ -2040,6 +2177,7 @@ extension CameraController {
     }
 
     func cleanup() {
+        stopBarcodeScanner()
         if let captureSession = self.captureSession {
             captureSession.stopRunning()
             captureSession.inputs.forEach { captureSession.removeInput($0) }
@@ -2065,6 +2203,7 @@ extension CameraController {
         self.allDiscoveredDevices = []
 
         self.dataOutput = nil
+        self.metadataOutput = nil
         self.photoOutput = nil
         self.fileVideoOutput = nil
 
@@ -2522,7 +2661,7 @@ extension CameraController: AVCapturePhotoCaptureDelegate {
     }
 }
 
-extension CameraController: AVCaptureVideoDataOutputSampleBufferDelegate {
+extension CameraController: AVCaptureVideoDataOutputSampleBufferDelegate, AVCaptureMetadataOutputObjectsDelegate {
     func captureOutput(_ output: AVCaptureOutput, didOutput sampleBuffer: CMSampleBuffer, from connection: AVCaptureConnection) {
         // Check if we're waiting for the first frame
         if !hasReceivedFirstFrame, let firstFrameCallback = firstFrameReadyCallback {
@@ -2573,6 +2712,33 @@ extension CameraController: AVCaptureVideoDataOutputSampleBufferDelegate {
 
         sampleBufferCaptureCompletionBlock = nil
     }
+
+    func metadataOutput(_ output: AVCaptureMetadataOutput, didOutput metadataObjects: [AVMetadataObject], from connection: AVCaptureConnection) {
+        guard let callback = barcodeScannerCallback else { return }
+
+        let now = Date().timeIntervalSince1970
+        guard now - lastBarcodeDetectionAt >= barcodeDetectionInterval else { return }
+
+        let barcodes: [[String: Any]] = metadataObjects.compactMap { object in
+            guard let readableObject = object as? AVMetadataMachineReadableCodeObject,
+                  let value = readableObject.stringValue,
+                  !value.isEmpty else {
+                return nil
+            }
+
+            return [
+                "value": value,
+                "format": barcodeFormat(from: readableObject.type)
+            ]
+        }
+
+        guard !barcodes.isEmpty else { return }
+        lastBarcodeDetectionAt = now
+
+        DispatchQueue.main.async {
+            callback(barcodes)
+        }
+    }
 }
 
 enum CameraControllerError: Swift.Error {

package/ios/Sources/CapgoCameraPreviewPlugin/Plugin.swift

@@ -1,3 +1,4 @@
+// swiftlint:disable file_length type_body_length cyclomatic_complexity function_body_length
 import Foundation
 import AVFoundation
 import Photos
@@ -34,7 +35,7 @@ extension UIWindow {
  */
 @objc(CameraPreview)
 public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelegate {
-    private let pluginVersion: String = "8.3.8"
+    private let pluginVersion: String = "8.4.0"
     public let identifier = "CameraPreviewPlugin"
     public let jsName = "CameraPreview"
     public let pluginMethods: [CAPPluginMethod] = [
@@ -43,6 +44,8 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
         CAPPluginMethod(name: "stop", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "capture", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "captureSample", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "startBarcodeScanner", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "stopBarcodeScanner", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getSupportedFlashModes", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "getHorizontalFov", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setFlashMode", returnType: CAPPluginReturnPromise),
@@ -108,6 +111,8 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
     private var permissionCallID: String?
     private var waitingForLocation: Bool = false
     private var isPresentingPermissionAlert: Bool = false
+    private var pendingStartBarcodeScannerOptions: (formats: [String], detectionInterval: Int)?
+    private var hasResolvedStartCall: Bool = false
 
     // Store original webview colors to restore them when stopping
     private var originalWebViewBackgroundColor: UIColor?
@@ -709,6 +714,7 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
         }
 
         self.isInitializing = true
+        self.hasResolvedStartCall = false
 
         self.cameraPosition = call.getString("position") ?? "rear"
         let deviceId = call.getString("deviceId")
@@ -759,6 +765,7 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
 
         // Default to high if not provided
         let videoQuality = call.getString("videoQuality") ?? "high"
+        self.pendingStartBarcodeScannerOptions = self.barcodeScannerStartOptions(from: call)
 
         let initialZoomLevel = call.getFloat("initialZoomLevel")
 
@@ -768,6 +775,7 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
         let hasHeight = call.getInt("height") != nil
 
         if hasAspectRatio && (hasWidth || hasHeight) {
+            self.pendingStartBarcodeScannerOptions = nil
             call.reject("Cannot set both aspectRatio and size (width/height). Use setPreviewSize after start.")
             return
         }
@@ -785,6 +793,7 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
                     print(error)
                     DispatchQueue.main.async {
                         self.isInitializing = false
+                        self.pendingStartBarcodeScannerOptions = nil
                         call.reject(error.localizedDescription)
                     }
                     return
@@ -807,6 +816,7 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
         let handleDenied: (AVAuthorizationStatus) -> Void = { _ in
             DispatchQueue.main.async {
                 self.isInitializing = false
+                self.pendingStartBarcodeScannerOptions = nil
                 call.reject("camera permission denied. enable camera access in Settings.", "cameraPermissionDenied")
             }
         }
@@ -880,7 +890,7 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
                 returnedObject["height"] = self.previewView.frame.height as any JSValue
                 returnedObject["x"] = self.previewView.frame.origin.x as any JSValue
                 returnedObject["y"] = self.previewView.frame.origin.y as any JSValue
-                call.resolve(returnedObject)
+                self.resolveStartCall(call, returnedObject: returnedObject)
             }
         }
 
@@ -892,11 +902,46 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
                 returnedObject["height"] = self.previewView.frame.height as any JSValue
                 returnedObject["x"] = self.previewView.frame.origin.x as any JSValue
                 returnedObject["y"] = self.previewView.frame.origin.y as any JSValue
-                call.resolve(returnedObject)
+                self.resolveStartCall(call, returnedObject: returnedObject)
             }
         }
     }
 
+    private func barcodeScannerStartOptions(from call: CAPPluginCall) -> (formats: [String], detectionInterval: Int)? {
+        if call.getBool("barcodeScanner") == true {
+            return (formats: [], detectionInterval: 500)
+        }
+
+        guard let options = call.getObject("barcodeScanner") else {
+            return nil
+        }
+
+        let formats = options["formats"] as? [String] ?? []
+        let detectionInterval = (options["detectionInterval"] as? Int) ?? (options["detectionInterval"] as? NSNumber)?.intValue ?? 500
+        return (formats: formats, detectionInterval: detectionInterval)
+    }
+
+    private func resolveStartCall(_ call: CAPPluginCall, returnedObject: JSObject) {
+        guard !hasResolvedStartCall else { return }
+        hasResolvedStartCall = true
+        cameraController.firstFrameReadyCallback = nil
+
+        if let options = pendingStartBarcodeScannerOptions {
+            do {
+                try self.cameraController.startBarcodeScanner(formats: options.formats, detectionIntervalMs: options.detectionInterval) { [weak self] barcodes in
+                    self?.notifyListeners("barcodeScanned", data: ["barcodes": barcodes])
+                }
+            } catch {
+                self.pendingStartBarcodeScannerOptions = nil
+                call.reject("Failed to start barcode scanner: \(error.localizedDescription)")
+                return
+            }
+            self.pendingStartBarcodeScannerOptions = nil
+        }
+
+        call.resolve(returnedObject)
+    }
+
     @objc func flip(_ call: CAPPluginCall) {
         guard isInitialized else {
             call.reject("Camera not initialized")
@@ -1478,6 +1523,30 @@ public class CameraPreview: CAPPlugin, CAPBridgedPlugin, CLLocationManagerDelega
         }
     }
 
+    @objc func startBarcodeScanner(_ call: CAPPluginCall) {
+        guard self.isInitialized else {
+            call.reject("Camera is not running")
+            return
+        }
+
+        let formats = call.getArray("formats") as? [String] ?? []
+        let detectionInterval = call.getInt("detectionInterval") ?? 500
+
+        do {
+            try self.cameraController.startBarcodeScanner(formats: formats, detectionIntervalMs: detectionInterval) { [weak self] barcodes in
+                self?.notifyListeners("barcodeScanned", data: ["barcodes": barcodes])
+            }
+            call.resolve()
+        } catch {
+            call.reject("Failed to start barcode scanner: \(error.localizedDescription)")
+        }
+    }
+
+    @objc func stopBarcodeScanner(_ call: CAPPluginCall) {
+        self.cameraController.stopBarcodeScanner()
+        call.resolve()
+    }
+
     @objc func getSupportedFlashModes(_ call: CAPPluginCall) {
         do {
             let supportedFlashModes = try self.cameraController.getSupportedFlashModes()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/camera-preview",
-  "version": "8.3.8",
+  "version": "8.4.0",
   "description": "Camera preview",
   "license": "MPL-2.0",
   "repository": {
@@ -25,7 +25,10 @@
     "video",
     "photo",
     "image",
-    "capture"
+    "capture",
+    "barcode",
+    "qr",
+    "scanner"
   ],
   "main": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
@@ -51,7 +54,8 @@
     "clean": "rimraf ./dist",
     "maestro:smoke": "bunx maestro test .maestro/camera-preview-smoke.yaml",
     "watch": "tsc --watch",
-    "prepublishOnly": "bun run build"
+    "prepublishOnly": "bun run build",
+    "check:wiring": "node scripts/check-capacitor-plugin-wiring.mjs"
   },
   "devDependencies": {
     "@capacitor/android": "^8.0.0",