Update ChallengeOptions and use camera position based on challenge type received

Author: thisisabhash

HostApp/HostApp/Views/ExampleLivenessView.swift

@@ -23,7 +23,8 @@ struct ExampleLivenessView: View {
             FaceLivenessDetectorView(
                 sessionID: viewModel.sessionID,
                 region: "us-east-1",
-                challengeOption: .faceMovementAndLightChallenge,
+                challengeOptions: .init(faceMovementChallengeOption: FaceMovementChallengeOption(camera: .front),
+                                        faceMovementAndLightChallengeOption: FaceMovementAndLightChallengeOption()),
                 isPresented:  Binding(
                     get: { viewModel.presentationState == .liveness },
                     set: { _ in }
@@ -47,6 +48,10 @@ struct ExampleLivenessView: View {
                             viewModel.presentationState = .error(.countdownFaceTooClose)
                         case .failure(.invalidSignature):
                             viewModel.presentationState = .error(.invalidSignature)
+                        case .failure(.faceInOvalMatchExceededTimeLimitError):
+                            viewModel.presentationState = .error(.faceInOvalMatchExceededTimeLimitError)
+                        case .failure(.internalServer):
+                            viewModel.presentationState = .error(.internalServer)
                         case .failure(.cameraNotAvailable):
                             viewModel.presentationState = .error(.cameraNotAvailable)
                         case .failure(.validation):

Sources/FaceLiveness/Views/Instruction/InstructionContainerView.swift

@@ -110,7 +110,7 @@ struct InstructionContainerView: View {
                 )
             }
         case .faceMatched:
-            if let challenge = viewModel.challenge,
+            if let challenge = viewModel.challengeReceived,
                case .faceMovementAndLightChallenge = challenge.type {
                 InstructionView(
                     text: LocalizedStrings.challenge_instruction_hold_still,

Sources/FaceLiveness/Views/Liveness/FaceLivenessDetectionView.swift

@@ -20,7 +20,7 @@ public struct FaceLivenessDetectorView: View {
     @State var displayingCameraPermissionsNeededAlert = false
 
     let disableStartView: Bool
-    let cameraPosition: LivenessCamera
+    let challengeOptions: ChallengeOptions
     let onCompletion: (Result<Void, FaceLivenessDetectionError>) -> Void
 
     let sessionTask: Task<FaceLivenessSession, Error>
@@ -30,14 +30,14 @@ public struct FaceLivenessDetectorView: View {
         credentialsProvider: AWSCredentialsProvider? = nil,
         region: String,
         disableStartView: Bool = false,
-        challengeOption: ChallengeOption,
+        challengeOptions: ChallengeOptions,
         isPresented: Binding<Bool>,
         onCompletion: @escaping (Result<Void, FaceLivenessDetectionError>) -> Void
     ) {        
         self.disableStartView = disableStartView
         self._isPresented = isPresented
-        self.cameraPosition = challengeOption.camera
         self.onCompletion = onCompletion
+        self.challengeOptions = challengeOptions
 
         self.sessionTask = Task {
             let session = try await AWSPredictionsPlugin.startFaceLivenessSession(
@@ -59,31 +59,16 @@ public struct FaceLivenessDetectorView: View {
             assetWriterDelegate: VideoChunker.AssetWriterDelegate(),
             assetWriterInput: LivenessAVAssetWriterInput()
         )
-        
-        let avCaptureDevice = AVCaptureDevice.default(
-                                .builtInWideAngleCamera,
-                                for: .video,
-                                position: cameraPosition == .front ? .front : .back)
-
-        let captureSession = LivenessCaptureSession(
-            captureDevice: .init(avCaptureDevice: avCaptureDevice),
-            outputDelegate: OutputSampleBufferCapturer(
-                faceDetector: faceDetector,
-                videoChunker: videoChunker
-            )
-        )
 
         self._viewModel = StateObject(
             wrappedValue: .init(
                 faceDetector: faceDetector,
                 faceInOvalMatching: faceInOvalStateMatching,
-                captureSession: captureSession,
                 videoChunker: videoChunker,
                 closeButtonAction: { onCompletion(.failure(.userCancelled)) },
                 sessionID: sessionID,
                 isPreviewScreenEnabled: !disableStartView,
-                cameraPosition: challengeOption.camera,
-                challengeOption: challengeOption
+                challengeOptions: challengeOptions
             )
         )
     }
@@ -93,15 +78,15 @@ public struct FaceLivenessDetectorView: View {
         credentialsProvider: AWSCredentialsProvider? = nil,
         region: String,
         disableStartView: Bool = false,
-        challengeOption: ChallengeOption,
+        challengeOptions: ChallengeOptions,
         isPresented: Binding<Bool>,
         onCompletion: @escaping (Result<Void, FaceLivenessDetectionError>) -> Void,
         captureSession: LivenessCaptureSession
     ) {
         self.disableStartView = disableStartView
         self._isPresented = isPresented
         self.onCompletion = onCompletion
-        self.cameraPosition = challengeOption.camera
+        self.challengeOptions = challengeOptions
 
         self.sessionTask = Task {
             let session = try await AWSPredictionsPlugin.startFaceLivenessSession(
@@ -121,13 +106,11 @@ public struct FaceLivenessDetectorView: View {
             wrappedValue: .init(
                 faceDetector: captureSession.outputSampleBufferCapturer!.faceDetector,
                 faceInOvalMatching: faceInOvalStateMatching,
-                captureSession: captureSession,
                 videoChunker: captureSession.outputSampleBufferCapturer!.videoChunker,
                 closeButtonAction: { onCompletion(.failure(.userCancelled)) },
                 sessionID: sessionID,
                 isPreviewScreenEnabled: !disableStartView,
-                cameraPosition: challengeOption.camera,
-                challengeOption: challengeOption
+                challengeOptions: challengeOptions
             )
         )
     }
@@ -172,6 +155,14 @@ public struct FaceLivenessDetectorView: View {
                 .onAppear {
                     Task {
                         do {
+                            let cameraPosition: LivenessCamera
+                            switch challenge.type {
+                            case .faceMovementAndLightChallenge:
+                                cameraPosition = challengeOptions.faceMovementAndLightChallengeOption.camera
+                            case .faceMovementChallenge:
+                                cameraPosition = challengeOptions.faceMovementChallengeOption.camera
+                            }
+                            
                             let newState = disableStartView
                             ? DisplayState.displayingLiveness
                             : DisplayState.displayingGetReadyView(challenge, cameraPosition)
@@ -255,7 +246,7 @@ public struct FaceLivenessDetectorView: View {
             for: .video,
             completionHandler: { accessGranted in
                 guard accessGranted == true else { return }
-                guard let challenge = viewModel.challenge else { return }
+                guard let challenge = viewModel.challengeReceived else { return }
                 displayState = .awaitingLivenessSession(challenge)
             }
         )
@@ -274,7 +265,7 @@ public struct FaceLivenessDetectorView: View {
         case .restricted, .denied:
             alertCameraAccessNeeded()
         case .authorized:
-            guard let challenge = viewModel.challenge else { return }
+            guard let challenge = viewModel.challengeReceived else { return }
             displayState = .awaitingLivenessSession(challenge)
         @unknown default:
             break
@@ -341,32 +332,38 @@ private func map(detectionCompletion: @escaping (Result<Void, FaceLivenessDetect
     }
 }
 
-enum LivenessCamera {
+public enum LivenessCamera {
     case front
     case back
 }
 
-public struct ChallengeOption {
+public struct ChallengeOptions {
+    let faceMovementChallengeOption: FaceMovementChallengeOption
+    let faceMovementAndLightChallengeOption: FaceMovementAndLightChallengeOption
+    
+    public init(faceMovementChallengeOption: FaceMovementChallengeOption,
+                faceMovementAndLightChallengeOption: FaceMovementAndLightChallengeOption) {
+        self.faceMovementChallengeOption = faceMovementChallengeOption
+        self.faceMovementAndLightChallengeOption = faceMovementAndLightChallengeOption
+    }
+}
+
+public struct FaceMovementChallengeOption {
     let challenge: Challenge
     let camera: LivenessCamera
 
-    init(challenge: Challenge, camera: LivenessCamera) {
-        self.challenge = challenge
+    public init(camera: LivenessCamera) {
+        self.challenge = .init(version: "1.0.0", type: .faceMovementChallenge)
         self.camera = camera
     }
+}
+
+public struct FaceMovementAndLightChallengeOption {
+    let challenge: Challenge
+    let camera: LivenessCamera
 
-    public static let faceMovementAndLightChallenge = Self.init(
-        challenge: .init(version: "2.0.0",
-                         type: .faceMovementAndLightChallenge),
-        camera: .front)
-    
-    public static let faceMovementChallengeWithFrontCamera = Self.init(
-        challenge: .init(version: "1.0.0",
-                         type: .faceMovementAndLightChallenge),
-        camera: .front)
-    
-    public static let faceMovementChallengeWithBackCamera = Self.init(
-        challenge: .init(version: "1.0.0",
-                         type: .faceMovementAndLightChallenge),
-        camera: .back)
+    public init() {
+        self.challenge = .init(version: "2.0.0", type: .faceMovementAndLightChallenge)
+        self.camera = .front
+    }
 }

Sources/FaceLiveness/Views/Liveness/FaceLivenessDetectionViewModel+FaceDetectionResultHandler.swift

@@ -113,7 +113,7 @@ extension FaceLivenessDetectionViewModel: FaceDetectionResultHandler {
                 self.faceMatchedTimestamp = Date().timestampMilliseconds
 
                 // next step after face match
-                switch self.challenge?.type {
+                switch self.challengeReceived?.type {
                 case .faceMovementAndLightChallenge:
                     if let colorSequences = colorSequences {
                         DispatchQueue.main.asyncAfter(deadline: .now() + 1.0) {
@@ -146,7 +146,7 @@ extension FaceLivenessDetectionViewModel: FaceDetectionResultHandler {
         DispatchQueue.main.async {
             self.livenessState
                 .unrecoverableStateEncountered(.timedOut)
-            self.captureSession.stopRunning()
+            self.captureSession?.stopRunning()
         }
     }
 }

Sources/FaceLiveness/Views/Liveness/FaceLivenessDetectionViewModel.swift

@@ -21,7 +21,7 @@ class FaceLivenessDetectionViewModel: ObservableObject {
     @Published var livenessState: LivenessStateMachine
 
     weak var livenessViewControllerDelegate: FaceLivenessViewControllerPresenter?
-    let captureSession: LivenessCaptureSession
+    var captureSession: LivenessCaptureSession?
     var closeButtonAction: () -> Void
     let videoChunker: VideoChunker
     let sessionID: String
@@ -35,7 +35,7 @@ class FaceLivenessDetectionViewModel: ObservableObject {
     var hasSentFirstVideo = false
     var layerRectConverted: (CGRect) -> CGRect = { $0 }
     var sessionConfiguration: FaceLivenessSession.SessionConfiguration?
-    var challenge: Challenge?
+    var challengeReceived: Challenge?
     var normalizeFace: (DetectedFace) -> DetectedFace = { $0 }
     var provideSingleFrame: ((UIImage) -> Void)?
     var cameraViewRect = CGRect.zero
@@ -44,8 +44,7 @@ class FaceLivenessDetectionViewModel: ObservableObject {
     var initialClientEvent: InitialClientEvent?
     var faceMatchedTimestamp: UInt64?
     var noFitStartTime: Date?
-    let cameraPosition: LivenessCamera
-    let challengeOption: ChallengeOption
+    let challengeOptions: ChallengeOptions
 
     static var attemptCount: Int = 0
     static var attemptIdTimeStamp: Date = Date()
@@ -61,25 +60,21 @@ class FaceLivenessDetectionViewModel: ObservableObject {
     init(
         faceDetector: FaceDetector,
         faceInOvalMatching: FaceInOvalMatching,
-        captureSession: LivenessCaptureSession,
         videoChunker: VideoChunker,
         stateMachine: LivenessStateMachine = .init(state: .initial),
         closeButtonAction: @escaping () -> Void,
         sessionID: String,
         isPreviewScreenEnabled: Bool,
-        cameraPosition: LivenessCamera,
-        challengeOption: ChallengeOption
+        challengeOptions: ChallengeOptions
     ) {
         self.closeButtonAction = closeButtonAction
         self.videoChunker = videoChunker
         self.livenessState = stateMachine
         self.sessionID = sessionID
-        self.captureSession = captureSession
         self.faceDetector = faceDetector
         self.faceInOvalMatching = faceInOvalMatching
         self.isPreviewScreenEnabled = isPreviewScreenEnabled
-        self.cameraPosition = cameraPosition
-        self.challengeOption = challengeOption
+        self.challengeOptions = challengeOptions
 
         self.closeButtonAction = { [weak self] in
             guard let self else { return }
@@ -129,7 +124,8 @@ class FaceLivenessDetectionViewModel: ObservableObject {
 
         livenessService?.register(
             listener: { [weak self] _challenge in
-                self?.challenge = _challenge
+                self?.challengeReceived = _challenge
+                self?.configureCaptureSession(challenge: _challenge)
                 onChallengeTypeReceived(_challenge)
             },
             on: .challenge)
@@ -144,16 +140,16 @@ class FaceLivenessDetectionViewModel: ObservableObject {
     }
 
     func startSession() {
-        captureSession.startSession()
+        captureSession?.startSession()
     }
 
     func stopRecording() {
-        captureSession.stopRunning()
+        captureSession?.stopRunning()
     }
 
     func configureCamera(withinFrame frame: CGRect) -> CALayer? {
         do {
-            let avLayer = try captureSession.configureCamera(frame: frame)
+            let avLayer = try captureSession?.configureCamera(frame: frame)
             DispatchQueue.main.async {
                 self.livenessState.checkIsFacePrepared()
             }
@@ -209,7 +205,8 @@ class FaceLivenessDetectionViewModel: ObservableObject {
             try livenessService?.initializeLivenessStream(
                 withSessionID: sessionID,
                 userAgent: UserAgentValues.standard().userAgentString,
-                challenges: [challengeOption.challenge],
+                challenges: [challengeOptions.faceMovementChallengeOption.challenge,
+                             challengeOptions.faceMovementAndLightChallengeOption.challenge],
                 options: .init(
                     attemptCount: Self.attemptCount,
                     preCheckViewEnabled: isPreviewScreenEnabled)
@@ -258,7 +255,7 @@ class FaceLivenessDetectionViewModel: ObservableObject {
         videoStartTime: UInt64
     ) {
         guard initialClientEvent == nil else { return }
-        guard let challenge else { return }
+        guard let challengeReceived else { return }
 
         videoChunker.start()
 
@@ -278,8 +275,8 @@ class FaceLivenessDetectionViewModel: ObservableObject {
         do {
             try livenessService?.send(
                 .initialFaceDetected(event: _initialClientEvent, 
-                                     challenge: .init(version: challenge.version,
-                                                      type: challenge.type)),
+                                     challenge: .init(version: challengeReceived.version,
+                                                      type: challengeReceived.type)),
                 eventDate: { .init() }
             )
         } catch {
@@ -298,7 +295,7 @@ class FaceLivenessDetectionViewModel: ObservableObject {
             let sessionConfiguration,
             let initialClientEvent,
             let faceMatchedTimestamp,
-            let challenge
+            let challengeReceived
         else { return }
 
         let finalClientEvent = FinalClientEvent(
@@ -313,8 +310,8 @@ class FaceLivenessDetectionViewModel: ObservableObject {
         do {
             try livenessService?.send(
                 .final(event: finalClientEvent,
-                       challenge: .init(version: challenge.version,
-                                            type: challenge.type)),
+                       challenge: .init(version: challengeReceived.version,
+                                            type: challengeReceived.type)),
                 eventDate: { .init() }
             )
 
@@ -407,6 +404,29 @@ class FaceLivenessDetectionViewModel: ObservableObject {
         }
         return data
     }
+    
+    func configureCaptureSession(challenge: Challenge) {
+        let cameraPosition: LivenessCamera
+        switch challenge.type {
+        case .faceMovementChallenge:
+            cameraPosition = challengeOptions.faceMovementChallengeOption.camera
+        case .faceMovementAndLightChallenge:
+            cameraPosition = challengeOptions.faceMovementAndLightChallengeOption.camera
+        }
+        
+        let avCaptureDevice = AVCaptureDevice.default(
+                                .builtInWideAngleCamera,
+                                for: .video,
+                                position: cameraPosition == .front ? .front : .back)
+
+        self.captureSession = LivenessCaptureSession(
+            captureDevice: .init(avCaptureDevice: avCaptureDevice),
+            outputDelegate: OutputSampleBufferCapturer(
+                faceDetector: self.faceDetector,
+                videoChunker: self.videoChunker
+            )
+        )
+    }
 }
 
 extension FaceLivenessDetectionViewModel: FaceDetectionSessionConfigurationWrapper { }