Fix Orientation & Animation

- Fixes an issue where orientation may be incorrect on iOS
- Fixes some documentation issues
- Cleans up resize/rotate animation

Author: git-shawn

Sources/ScanKit/NSCodeScanner.swift Sources/ScanKit/NSScanKitPreview.swiftSources/ScanKit/NSCodeScanner.swift renamed to Sources/ScanKit/NSScanKitPreview.swift

@@ -1,5 +1,5 @@
 //
-//  ScanKit.swift
+//  NSScanKitPreview.swift
 //  SwiftUI ScanKit
 //
 //  Copyright © 2023 Shawn Davis
@@ -35,20 +35,20 @@ fileprivate let logger = Logger(subsystem: Bundle.main.bundleIdentifier ?? "dev.
 public struct ScanKitPreview: NSViewControllerRepresentable {
     var camera: ScanKitCamera
 
-    public init(camera: ScanKitCamera, startScanningOnLoad: Bool = true) {
+    public init(camera: ScanKitCamera) {
         self.camera = camera
     }
 
-    public func makeNSViewController(context: Context) -> NSCodeScanner {
-        return NSCodeScanner(camera: camera)
+    public func makeNSViewController(context: Context) -> NSScanKitPreview {
+        return NSScanKitPreview(camera: camera)
     }
 
-    public func updateNSViewController(_ nsViewController: NSCodeScanner, context: Context) {
-        // do nothing
+    public func updateNSViewController(_ nsViewController: NSScanKitPreview, context: Context) {
+        // Do nothing
     }
 }
 
-public class NSCodeScanner: NSViewController, AVCaptureVideoDataOutputSampleBufferDelegate {
+public class NSScanKitPreview: NSViewController, AVCaptureVideoDataOutputSampleBufferDelegate {
 
     weak var camera: ScanKitCamera?
 
@@ -86,7 +86,10 @@ public class NSCodeScanner: NSViewController, AVCaptureVideoDataOutputSampleBuff
 
     public override func viewWillLayout() {
         super.viewWillLayout()
+        CATransaction.begin()
+        CATransaction.setDisableActions(true)
         self.camera?.previewLayer.frame = self.view.bounds
+        CATransaction.commit()
     }
 
     private func addPreviewLayer() {

Sources/ScanKit/ScanKit.swift

@@ -58,7 +58,8 @@ public struct ScannerView: View {
     ///   - isScanning: Whether or not to scan for the selected symbology.
     ///                 When `false` the preview will continue but frames will not be processed for
     ///                 instances of the selected symbology.
-    ///   - completion: A completion handler that returns a `Result` of either `String` when information has been found and can be decoded or `ScanKitError` when an error occurs.
+    ///   - completion: A completion handler that returns a `Result` of either `String` when information has been found
+    ///                 and can be decoded or `ScanKitError` when an error occurs.
     public init(for symbology: VNBarcodeSymbology,
          showViewfinder: Bool = true,
          isScanning: Binding<Bool>,

Sources/ScanKit/ScanKitCamera.swift

@@ -414,7 +414,17 @@ public class ScanKitCamera: NSObject, ObservableObject, AVCaptureVideoDataOutput
     /// You may need to call this function again if you wish to restart the scanning process.
     ///
     /// ```
-    /// ADD EXAMPLE!!!
+    /// @StateObject var camera = ScanKitCamera()
+    /// ...
+    /// .task {
+    ///     do {
+    ///         for try await result in camera.resultsStream {
+    ///             print(result)
+    ///         }
+    ///     } catch let error {
+    ///         print(error)
+    ///     }
+    /// }
     /// ```
     ///
     /// It is possible to recieve an empty `String` if the code does not contain any data. Be prepared to handle that.

Sources/ScanKit/UICodeScanner.swift Sources/ScanKit/UIScanKitPreview.swiftSources/ScanKit/UICodeScanner.swift renamed to Sources/ScanKit/UIScanKitPreview.swift

@@ -1,5 +1,5 @@
 //
-//  ScanKit.swift
+//  UIScanKitPreview.swift
 //  SwiftUI ScanKit
 //
 //  Copyright © 2023 Shawn Davis
@@ -41,26 +41,18 @@ public struct ScanKitPreview: UIViewControllerRepresentable {
         self.camera = camera
     }
 
-    public func makeUIViewController(context: Context) -> UICodeScanner {
-        return UICodeScanner(camera: camera)
+    public func makeUIViewController(context: Context) -> UIScanKitPreview {
+        return UIScanKitPreview(camera: camera)
     }
 
-    public func updateUIViewController(_ uiViewController: UICodeScanner, context: Context) {
-        // Do nothing!
+    public func updateUIViewController(_ uiViewController: UIScanKitPreview, context: Context) {
+        // Do nothing
     }
 }
 
-public class UICodeScanner: UIViewController {
+public class UIScanKitPreview: UIViewController {
     weak var camera: ScanKitCamera?
 
-    private var deviceOrientation: UIDeviceOrientation {
-        var orientation = UIDevice.current.orientation
-        if orientation == UIDeviceOrientation.unknown {
-            orientation = .portrait
-        }
-        return orientation
-    }
-    
     init(camera: ScanKitCamera) {
         self.camera = camera
         super.init(nibName: nil, bundle: nil)
@@ -70,20 +62,28 @@ public class UICodeScanner: UIViewController {
         fatalError("init(coder:) has not been implemented")
     }
 
-    public override func viewDidLoad() {
-        super.viewDidLoad()
+    public override func viewWillAppear(_ animated: Bool) {
+        super.viewWillAppear(animated)
+        UIDevice.current.beginGeneratingDeviceOrientationNotifications()
+        
+        CATransaction.begin()
+        CATransaction.setDisableActions(true)
         addPreviewLayer()
-    }
-    
-    public override func viewDidAppear(_ animated: Bool) {
+        CATransaction.commit()
+        
         // Start the camera
-        Task.detached(priority: .userInitiated) { [weak self] in
+        Task(priority: .userInitiated) { [weak self] in
             await self?.camera?.start()
         }
     }
 
+    public override func viewDidAppear(_ animated: Bool) {
+        super.viewDidAppear(animated)
+    }
+    
     public override func viewWillDisappear(_ animated: Bool) {
         super.viewWillDisappear(animated)
+        UIDevice.current.endGeneratingDeviceOrientationNotifications()
         camera?.stop()
     }
 
@@ -93,25 +93,56 @@ public class UICodeScanner: UIViewController {
         // Update video orientation on rotate
         guard let connection = camera?.previewLayer.connection else { return }
         if connection.isVideoOrientationSupported {
-            connection.videoOrientation = videoOrientation(for: deviceOrientation)
+            print("updating orientation...")
+            Task { @MainActor in
+                connection.videoOrientation = appropriateVideoOrientation
+            }
         }
 
+        CATransaction.begin()
+        CATransaction.setDisableActions(true)
         self.camera?.previewLayer.frame = self.view.bounds
+        CATransaction.commit()
     }
 
     private func addPreviewLayer() {
         if let previewLayer = self.camera?.previewLayer {
+            previewLayer.frame = self.view.bounds
             self.view.layer.addSublayer(previewLayer)
         }
     }
 
+    private var appropriateVideoOrientation: AVCaptureVideoOrientation {
+        let orientation = UIDevice.current.orientation
+        
+        // If the device orientation cannot be found, check the UI instead...
+        if orientation == .unknown {
+            return videOrientationFromInterfaceOrientation(self.preferredInterfaceOrientationForPresentation)
+        }
+        return videoOrientationFromDeviceOrientation(orientation)
+    }
+    
+    /// Converts a `UIInterfaceOrientation` to an appropriate `AVCaptureVideoOrientation` equivalent.
+    private func videOrientationFromInterfaceOrientation(_ interfaceOrientation: UIInterfaceOrientation) -> AVCaptureVideoOrientation {
+        switch interfaceOrientation {
+        case .unknown: return .portrait
+        case .portrait: return .portrait
+        case .portraitUpsideDown: return .portrait
+        case .landscapeLeft: return .landscapeLeft
+        case .landscapeRight: return .landscapeRight
+        default: return .portrait
+        }
+    }
+    
     /// Converts a `UIDeviceOrientation` to an appropriate `AVCaptureVideoOrientation` equivalent.
-    private func videoOrientation(for deviceOrientation: UIDeviceOrientation) -> AVCaptureVideoOrientation {
+    private func videoOrientationFromDeviceOrientation(_ deviceOrientation: UIDeviceOrientation) -> AVCaptureVideoOrientation {
         switch deviceOrientation {
-        case .portrait: return AVCaptureVideoOrientation.portrait
-        case .portraitUpsideDown: return AVCaptureVideoOrientation.portraitUpsideDown
-        case .landscapeLeft: return AVCaptureVideoOrientation.landscapeRight
-        case .landscapeRight: return AVCaptureVideoOrientation.landscapeLeft
+        case .portrait: return .portrait
+        case .portraitUpsideDown: return .portraitUpsideDown
+        case .landscapeLeft: return .landscapeRight
+        case .landscapeRight: return .landscapeLeft
+        case .faceUp: return .landscapeRight
+        case .faceDown: return .landscapeRight
         default: return .portrait
         }
     }