Version 0.16.0

Author: gabime

CMakeLists.txt

@@ -56,7 +56,7 @@ option(RSID_DEBUG_CONSOLE "Log everything to console" ON)
 option(RSID_DEBUG_FILE "Log everything to rsid_debug.log file" OFF)
 option(RSID_DEBUG_SERIAL "Log all serial communication" OFF)
 option(RSID_DEBUG_VALUES "Replace default common values with debug ones" OFF)
-option(RSID_PREVIEW "Enable opencv preview" OFF)
+option(RSID_PREVIEW "Enable preview" OFF)
 option(RSID_SAMPLES "Build samples" OFF)
 option(RSID_TIDY "Enable clang-tidy" OFF)
 option(RSID_DOXYGEN "Build doxygen docs" OFF)
@@ -97,8 +97,6 @@ endif()
 if(RSID_PREVIEW)
     if(${CMAKE_SYSTEM_NAME} STREQUAL "Android")
         include(UVC)
-    else()
-        include(OpenCV)
     endif()
 endif()
 

Readme.md

@@ -289,8 +289,7 @@ bool success = deviceController.Reboot();
 
 
 #### Preview API
-Host needs to have OpenCV installed.
-Currently 640x352 YUV format is available.
+Currently 704x1280 RGB format is available.
 
 ##### StartPreview
 Starts preview. Callback function that is provided as parameter will be invoked for a newly arrived image and can be rendered by your application.

cmake/OpenCV.cmake

@@ -3,6 +3,10 @@
 
 #pragma once
 
+#include "AuthenticateStatus.h"
+#include "FaceRect.h"
+#include <vector>
+
 namespace RealSenseID
 {
 class Faceprints;
@@ -30,6 +34,17 @@ class AuthFaceprintsExtractionCallback
      * @param[in] hint Hint for the problem encountered.
      */
     virtual void OnHint(const AuthenticateStatus hint) = 0;
+
+
+    /**
+     * Called to inform the client about detected faces during the authentication operation.
+     *
+     * @param[in] face Detected faces. First item is the selected one for the authentication operation.
+     */
+    virtual void OnFaceDetected(const std::vector<FaceRect>& faces)
+    {
+        // default empty impl for backward compatibilty
+    }
 };
 
 } // namespace RealSenseID

include/RealSenseID/AuthFaceprintsExtractionCallback.h

@@ -4,6 +4,8 @@
 #pragma once
 
 #include "AuthenticateStatus.h"
+#include "FaceRect.h"
+#include<vector>
 
 namespace RealSenseID
 {
@@ -31,5 +33,16 @@ class RSID_API AuthenticationCallback
      * @param[in] hint Hint for the problem encountered.
      */
     virtual void OnHint(const AuthenticateStatus hint) = 0;
+
+
+    /**
+     * Called to inform the client about detected faces during the authentication operation.
+     *
+     * @param[in] face Detected faces. First item is the selected one for the authentication operation.
+     */
+    virtual void OnFaceDetected(const std::vector<FaceRect> &faces)
+    {
+        //default empty impl for backward compatibilty
+    }
 };
 } // namespace RealSenseID

include/RealSenseID/AuthenticationCallback.h

@@ -15,8 +15,10 @@ struct RSID_API DeviceInfo
     static constexpr std::size_t MaxBufferSize = 256;
 
     char serialPort[MaxBufferSize];
+
 };
 
 std::vector<DeviceInfo> RSID_API DiscoverDevices();
+std::vector<int> RSID_API DiscoverCapture();
 
 } // namespace RealSenseID

include/RealSenseID/DiscoverDevices.h

@@ -5,6 +5,8 @@
 
 #include "EnrollStatus.h"
 #include "FacePose.h"
+#include "FaceRect.h"
+#include <vector>
 
 namespace RealSenseID
 {
@@ -40,6 +42,16 @@ class EnrollFaceprintsExtractionCallback
      * @param[in] hint Hint for the problem encountered.
      */
     virtual void OnHint(const EnrollStatus hint) = 0;
+
+    /**
+     * Called to inform the client about detected faces during the authentication operation.
+     *
+     * @param[in] face Detected faces. First item is the selected one for the authentication operation.
+     */
+    virtual void OnFaceDetected(const std::vector<FaceRect>& faces)
+    {
+        // default empty impl for backward compatibilty
+    }
 };
 
 } // namespace RealSenseID

include/RealSenseID/EnrollFaceprintsExtractionCallback.h

@@ -4,7 +4,9 @@
 #pragma once
 
 #include "FacePose.h"
+#include "FaceRect.h"
 #include "EnrollStatus.h"
+#include <vector>
 
 namespace RealSenseID
 {
@@ -37,5 +39,15 @@ class RSID_API EnrollmentCallback
      * @param[in] hint Hint for the problem encountered.
      */
     virtual void OnHint(const EnrollStatus hint) = 0;
+
+     /**
+     * Called to inform the client about detected faces during the authentication operation.
+     *
+     * @param[in] face Detected faces. First item is the selected one for the authentication operation.
+     */
+    virtual void OnFaceDetected(const std::vector<FaceRect> &faces)
+    {
+        //default empty impl for backward compatibilty
+    }
 };
 } // namespace RealSenseID

include/RealSenseID/EnrollmentCallback.h

@@ -13,6 +13,7 @@
 #include "RealSenseID/SignatureCallback.h"
 #include "RealSenseID/Status.h"
 #include "RealSenseID/MatchResultHost.h"
+#include <cstddef>
 
 #ifdef ANDROID
 #include "RealSenseID/AndroidSerialConfig.h"
@@ -54,7 +55,7 @@ class RSID_API FaceAuthenticator
     /**
      * Connect to device using the given Android serial config
      * reconnect if already connected.
-     * 
+     *
      * @param[in] config Android config Serial configuration
      * @return Status (Status::Ok on success).
      */
@@ -87,6 +88,11 @@ class RSID_API FaceAuthenticator
     Status Unpair();
 #endif // RSID_SECURE
 
+    /**
+     *  Max user id size is 30 bytes, 31 bytes including '\0'
+     */
+    static constexpr size_t MAX_USERID_LENGTH = 31;
+
     /**
      * Enroll a user.
      * Starts the enrollment process, which starts the camera, captures frames and then extracts
@@ -95,7 +101,8 @@ class RSID_API FaceAuthenticator
      * Once process is done, camera will be closed properly and device will be in ready state.
      *
      * @param[in] callback User defined callback to handle the process updates.
-     * @param[in] user_id Null terminated C string of ascii chars. Max user id size is 30 bytes (max total of 31 bytes
+     * @param[in] user_id Null terminated C string of ascii chars. Max user id size is MAX_USERID_LENGTH bytes
+
      * including the terminating zero byte). user.
      * @return Status (Status::Ok on success).
      */
@@ -116,7 +123,7 @@ class RSID_API FaceAuthenticator
     /**
      * Start Authentication Loop.
      * Starts infinite authentication loop. Call Cancel to stop it.
-     * 
+     *
      * @param[in] callback User defined callback object to handle the process updates.
      * @return Status (Status::Ok on success).
      */
@@ -125,7 +132,7 @@ class RSID_API FaceAuthenticator
     /**
      * Detect a spoof attempt.
      * This is advanced mode feature, please check if FW supports it using QueryDeviceConfig API.
-     * Starts the spoof flow which also includes face detection,     
+     * Starts the spoof flow which also includes face detection,
      * During the process callbacks will be called to provide information if needed.
      * Once process is done, camera will be closed properly and device will be in ready state.
      *
@@ -166,47 +173,49 @@ class RSID_API FaceAuthenticator
 
     /**
      * Query FW authentication settings.
-     * 
+     *
      * @param[out] device_config config with settings.
      * @return Status (Status::Ok on success).
      */
     Status QueryDeviceConfig(DeviceConfig& device_config);
 
     /**
      * Query the device about all enrolled users.
-     * 
-     * @param[out] pre-allocated array of user ids.
+     *
+     * @param[out] pre-allocated array of user ids. app is expected to allocated array of length = QueryNumberOfUsers(),
+     * each entry in the array is string of size = MAX_USERID_LENGTH
      * @param[in/out] number of users to retrieve.
      * @return Status (Status::Ok on success).
      */
     Status QueryUserIds(char** user_ids, unsigned int& number_of_users_in_out);
 
     /**
      * Query the device about the number of enrolled users.
-     * 
+     *
      * @param[out] number of users.
      * @return Status (Status::Ok on success).
      */
     Status QueryNumberOfUsers(unsigned int& number_of_users);
 
     /**
      * Prepare device to standby - for now it's saving database of users to flash.
-     * 
+     *
      * @return Status (Status::Ok on success).
      */
     Status Standby();
 
-    /*************************************************/
-    /************** Server Mode Methods **************/
-    /*************************************************/
+    /**************************************************************************/
+    /*************************** Host Mode Methods ****************************/
+    /**************************************************************************/
+
     /**
      * Attempt to extract faceprints using enrollment flow.
      * Starts the enrollment process, which starts the camera, captures frames, extracts
      * faceprints of different face-poses, and sends them to the host.
      * During the process callbacks will be called to provide information if needed.
      * Once process is done, camera will be closed properly and device will be in ready state.
      *
-     * @param[in] callback User defined callback to handle the process updates.     
+     * @param[in] callback User defined callback to handle the process updates.
      * @return Status (Status::Ok on success).
      */
     Status ExtractFaceprintsForEnroll(EnrollFaceprintsExtractionCallback& callback);
@@ -226,8 +235,8 @@ class RSID_API FaceAuthenticator
     /**
      * Attempt faceprints extraction in a loop using authentication flow.
      * Starts infinite authentication loop. Call Cancel to stop it.
-     * 
-     * @param[in] callback User defined callback object to handle the process updates.     
+     *
+     * @param[in] callback User defined callback object to handle the process updates.
      * @return Status (Status::Ok on success).
      */
     Status ExtractFaceprintsForAuthLoop(AuthFaceprintsExtractionCallback& callback);
@@ -240,10 +249,11 @@ class RSID_API FaceAuthenticator
      * @param[in] new_faceprints faceprints which were extracted from a single image of a person.
      * @param[in] existing_faceprints faceprints which were calculated from one or more images of the same person.
      * @param[in] updated_faceprints a placeholder to write the updated-faceprints into, if the match was successful.
-     * @return MatchResultHost match result, the 'success' field indicates if the two faceprints belong to the same person.
+     * @return MatchResultHost match result, the 'success' field indicates if the two faceprints belong to the same
+     * person.
      */
     MatchResultHost MatchFaceprints(Faceprints& new_faceprints, Faceprints& existing_faceprints,
-                                Faceprints& updated_faceprints);
+                                    Faceprints& updated_faceprints);
 
 private:
     FaceAuthenticatorImpl* _impl = nullptr;

include/RealSenseID/FaceAuthenticator.h

@@ -0,0 +1,28 @@
+// License: Apache 2.0. See LICENSE file in root directory.
+// Copyright(c) 2020-2021 Intel Corporation. All Rights Reserved.
+
+#pragma once
+
+#include "RealSenseIDExports.h"
+#include <cstdint>
+
+#pragma pack(push)
+#pragma pack(1)
+
+namespace RealSenseID
+{
+/**
+ * Detected face info
+ * Upper left corner, width and height
+ */
+struct RSID_API FaceRect
+{    
+    uint32_t x = 0;
+    uint32_t y = 0;
+    uint32_t w = 0;
+    uint32_t h = 0;
+};
+
+} // namespace RealSenseID
+
+#pragma pack(pop)