Merge pull request #14 from IntelRealSense/v0.13.0

V0.13.0

Author: gabime

Readme.md

@@ -33,24 +33,8 @@ $ make -j
 ## Sample Code
 This snippet shows the basic usage of our library.
 ```cpp
-// Start preview
-PreviewRender image_clbk;
-Preview preview;
-bool success = preview.StartPreview(image_clbk);
-
-// Create device controller instance and connect to the device on COM9 which is of type USB
-RealSenseID::DeviceController deviceController;
-auto connect_status = deviceController.Connect({RealSenseID::SerialType::USB, "COM9"});
-
-// Pair with host
-auto pair_status = deviceController.Pair(host_pubkey, host_pubkey_signature, device_pubkey);
-
-// Disconnect from the device
-deviceController.Disconnect();
-
-// Create face authenticator instance and connect to the device on COM9 which is of type USB
-MySigClbk sig_clbk;
-RealSenseID::FaceAuthenticator authenticator {&sig_clbk};
+// Create face authenticator and connect it to the device on port COM9
+RealSenseID::FaceAuthenticator authenticator;
 connect_status = authenticator.Connect({RealSenseID::SerialType::USB, "COM9"});
 
 // Enroll a user
@@ -65,19 +49,16 @@ status = authenticator.Authenticate(auth_clbk);
 // Remove the user from device
 success = authenticator.RemoveUser(user_id);
 
-// Disconnect from the device
-authenticator.Disconnect();
-
-// Stop preview
-success = preview.StopPreview();
 ```
 
 For additional languages, build instruction and detailed code please see our [examples](./examples).
 
 ## Secure Communication
-The communication with the device is encrypted using the Elliptic-curve  Diffie–Hellman key exchange (ECDH).
+The library can be compiled in secure mode.
+Once secure communication is enabled, the communication with the device is encrypted using the Elliptic-curve Diffie–Hellman key exchange (ECDH).
 
-To enable secure communication, the host should perform the following steps:
+To enable secure mode, the host should perform the following steps:
+* Compile the library with `RSID_SECURE` defined. e.g. ```cmake -DRSID_SECURE=ON ..```
 * Generate a set of ECDSA public and private keys. The host is responsible for keeping his private key safe.
 * Pair with the device to enable secure communication. Pairing is performed once using the FaceAuthenticator API.
 * Implement a [SignatureCallback](./include/RealSenseID/SignatureCallback.h). Signing and verifying is done with the ECDSA keys.

examples/README.md

@@ -176,7 +176,7 @@ For Example:
  3. In Android Studio, File->Open: \<RealSenseID repository\>/examples/android_example
  4. "Sync project" and then "Make project".
 
- 	Note: Application and "RealSenseIDSwigClient" module have two flavors. "Secured" and "Unsecured" to choose between the two supported modes. If when trying to switch between them, you suffer compilation issues, you might need to clear files generated by SWIG in previous build (.i files as well as generated cpp_gen folder and api folder containing .java files). One way to do it is with "git clean -dfix".
+ 	Note: Application and "RealSenseIDSwigClient" module have two flavors. "Secured" and "Unsecured" to choose between the two supported modes. If when trying to switch between them, you suffer compilation issues, try Android Studio's "Refresh Linked C++ Projects" option. Another thing that might work is to remove all auto generated files (try "git clean -dfix" can help).
 
  **Done!**
 ## **How to run example application**

examples/android_example/app/build.gradle

@@ -13,7 +13,7 @@ android {
         applicationId "com.intel.realsenseid.f450androidexample"
         minSdkVersion 23
         targetSdkVersion 27
-        versionName "0_12_1"
+        versionName "0_13_0"
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
 
@@ -54,7 +54,10 @@ dependencies {
     implementation 'androidx.appcompat:appcompat:1.3.0-alpha02'
     implementation 'com.google.android.material:material:1.2.1'
     implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
+    implementation 'androidx.recyclerview:recyclerview:1.1.0'
     implementation project(path: ':RealSenseIDSwigClient')
+    implementation 'androidx.lifecycle:lifecycle-livedata-ktx:2.2.0'
+    implementation 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.2.0'
     testImplementation 'junit:junit:4.13.1'
     androidTestImplementation 'androidx.test.ext:junit:1.1.2'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'

examples/android_example/app/src/main/AndroidManifest.xml

@@ -2,13 +2,15 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
     package="com.intel.realsenseid.f450androidexample">
 
+    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
+
     <application
         android:allowBackup="true"
         android:icon="@mipmap/ic_launcher"
         android:label="@string/app_name"
         android:roundIcon="@mipmap/ic_launcher_round"
         android:theme="@style/Theme.MyApplication">
-
+        <activity android:name=".FilesListActivity"></activity>
         <activity
             android:name=".MainActivity"
             android:configChanges="orientation"
@@ -22,7 +24,10 @@
             <intent-filter>
                 <action android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED" />
             </intent-filter>
-            <meta-data android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED" android:resource="@xml/device_filter" />
+
+            <meta-data
+                android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED"
+                android:resource="@xml/device_filter" />
         </activity>
     </application>
 

examples/android_example/app/src/main/java/com/intel/realsenseid/f450androidexample/EnrollmentPoseTracker.java

@@ -0,0 +1,59 @@
+package com.intel.realsenseid.f450androidexample;
+
+import com.intel.realsenseid.api.FacePose;
+
+import java.util.LinkedList;
+import java.util.List;
+
+public class EnrollmentPoseTracker {
+    private List<TrackedPose> m_trackedPoses;
+
+    private class TrackedPose {
+
+        private final FacePose m_pose;
+        private boolean m_check;
+
+        public TrackedPose(FacePose p) {
+            m_pose = p;
+            m_check = false;
+        }
+
+
+        public FacePose getPose() {
+            return m_pose;
+        }
+
+        public boolean isCheck() {
+            return m_check;
+        }
+
+        public void setCheck() {
+            this.m_check = true;
+        }
+    }
+
+    public EnrollmentPoseTracker(FacePose[] facePoses) {
+        m_trackedPoses = new LinkedList<>();
+        for (FacePose p : facePoses) {
+            m_trackedPoses.add(new TrackedPose(p));
+        }
+    }
+
+    public void markPoseCheck(FacePose pose) {
+        for (TrackedPose tp: m_trackedPoses) {
+            if ((tp.getPose() == pose) && !tp.isCheck()) {
+                tp.setCheck();
+                return;
+            }
+        }
+    }
+
+    public FacePose getNext() {
+        for (TrackedPose tp: m_trackedPoses) {
+            if (!tp.isCheck()) {
+                return tp.getPose();
+            }
+        }
+        return null;
+    }
+}

examples/android_example/app/src/main/java/com/intel/realsenseid/f450androidexample/FileModel.java

@@ -0,0 +1,59 @@
+package com.intel.realsenseid.f450androidexample;
+
+
+public class FileModel {
+    public String getPath() {
+        return path;
+    }
+
+    public void setPath(String path) {
+        this.path = path;
+    }
+
+    public FileType getFileType() {
+        return fileType;
+    }
+
+    public void setFileType(FileType fileType) {
+        this.fileType = fileType;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public Double getSizeInMB() {
+        return sizeInMB;
+    }
+
+    public void setSizeInMB(Double sizeInMB) {
+        this.sizeInMB = sizeInMB;
+    }
+
+    public String getExtension() {
+        return extension;
+    }
+
+    public void setExtension(String extension) {
+        this.extension = extension;
+    }
+
+    public int getSubFiles() {
+        return subFiles;
+    }
+
+    public void setSubFiles(int subFiles) {
+        this.subFiles = subFiles;
+    }
+
+    private String path;
+    private FileType fileType;
+    private String name;
+    private Double sizeInMB;
+    private String extension;
+    private int subFiles;
+}

examples/android_example/app/src/main/java/com/intel/realsenseid/f450androidexample/FileType.java

@@ -0,0 +1,14 @@
+package com.intel.realsenseid.f450androidexample;
+
+import java.io.File;
+
+public enum FileType {
+    FILE,
+    FOLDER;
+
+    public static FileType getType(File file) {
+        if (file.isDirectory())
+            return FOLDER;
+        return FILE;
+    }
+}

examples/android_example/app/src/main/java/com/intel/realsenseid/f450androidexample/FileUtils.java

@@ -0,0 +1,47 @@
+package com.intel.realsenseid.f450androidexample;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+public class FileUtils {
+
+    public static List<File> getFilesFromPath(String path) {
+        File file = new File(path);
+        return Arrays.asList(file.listFiles());
+    }
+
+    public static List<FileModel> getFileModelsFromFiles(List<File> files) {
+        List<FileModel> outList = new ArrayList<>();
+        for (File it : files) {
+            FileModel fm = new FileModel(); // TODO: create builder for FileModel and use it instead
+            fm.setPath(it.getPath());
+            fm.setFileType(FileType.getType(it));
+            fm.setName(it.getName());
+            fm.setSizeInMB(convertFileSizeToMB(it.length()));
+            fm.setExtension(getExtension(it));
+            fm.setSubFiles(getNumberOfSubFiles(it));
+            outList.add(fm);
+        }
+        return outList;
+    }
+
+    private static int getNumberOfSubFiles(File f) {
+        if (!f.isDirectory())
+            return 0;
+        return f.listFiles().length;
+    }
+
+    private static String getExtension(File f) {
+        String filename = f.getName();
+        int lastDotIndex = filename.lastIndexOf(".");
+        if (lastDotIndex < 0)
+            return "";
+        return filename.substring(lastDotIndex);
+    }
+
+    private static Double  convertFileSizeToMB(Long sizeInBytes) {
+        return (sizeInBytes.doubleValue()) / (1024 * 1024);
+    }
+}