use unzip include folder instead of zip file as zip could not be unzip on docs.rs

Author: shigedangao

.cargo/config.toml

@@ -2,6 +2,6 @@
 rustflags = ["-C", "link-arg=-Wl,-rpath,@executable_path/../lib"]
 
 [env]
-INSIGHTFACE_PATH = "/Users/marcintha/workspace/baklava/insightface/cpp-package/inspireface/build/inspireface-macos/InspireFace"
+INSIGHTFACE_PATH = "/Users/marcinthaamnouay/workspace/baklava/insightface/cpp-package/inspireface/build/inspireface-macos/InspireFace"
 # Enable the setting below to generate documentation locally
 # DOCS_RS = "true"

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "baklava"
 description = "A rust wrapper around the InsightFace library to perform face comparison"
-version = "0.1.3"
+version = "0.1.4"
 edition = "2021"
 authors = ["Marc Intha-amnouay <marc.inthaamnouay@gmail.com>"]
 keywords = ["insightface", "face-comparison", "inspireface"]

Cargo.toml

@@ -1,22 +1,14 @@
 use std::env;
 use std::path::PathBuf;
-use std::process::Command;
 
 fn main() {
     let lib_path = match env::var("INSIGHTFACE_PATH") {
         Ok(path) => PathBuf::from(path),
         Err(_) => {
             let current_dir = env::current_dir().unwrap();
             match env::var("DOCS_RS").is_ok() {
-                true => {
-                    // The headers can be passed from the "zipped" file "insightface_headers.zip"
-                    Command::new("unzip")
-                        .arg("insightface_headers.zip")
-                        .spawn()
-                        .expect("Expect unzip command to work");
-
-                    current_dir
-                }
+                // Use the curent_directory which include the "include" directory.
+                true => current_dir,
                 false => {
                     let local_path = format!(
                         "insightface/cpp-package/inspireface/build/inspireface-{}/InspireFace",

build.rs

@@ -0,0 +1,79 @@
+/**
+ * Created by Jingyu Yan
+ * @date 2024-10-01
+ */
+
+#ifndef INSPIRE_FACE_HERROR_H
+#define INSPIRE_FACE_HERROR_H
+
+// [Anchor-Begin]
+
+#define HSUCCEED (0)                                              // Success
+#define HERR_BASIC_BASE 0X0001                                    // Basic error types
+#define HERR_UNKNOWN HERR_BASIC_BASE                              // Unknown error
+#define HERR_INVALID_PARAM (HERR_BASIC_BASE + 1)                  // Invalid parameter
+#define HERR_INVALID_IMAGE_STREAM_HANDLE (HERR_BASIC_BASE + 24)   // Invalid image stream handle
+#define HERR_INVALID_CONTEXT_HANDLE (HERR_BASIC_BASE + 25)        // Invalid context handle
+#define HERR_INVALID_FACE_TOKEN (HERR_BASIC_BASE + 30)            // Invalid face token
+#define HERR_INVALID_FACE_FEATURE (HERR_BASIC_BASE + 31)          // Invalid face feature
+#define HERR_INVALID_FACE_LIST (HERR_BASIC_BASE + 32)             // Invalid face feature list
+#define HERR_INVALID_BUFFER_SIZE (HERR_BASIC_BASE + 33)           // Invalid copy token
+#define HERR_INVALID_IMAGE_STREAM_PARAM (HERR_BASIC_BASE + 34)    // Invalid image param
+#define HERR_INVALID_SERIALIZATION_FAILED (HERR_BASIC_BASE + 35)  // Invalid face serialization failed
+#define HERR_INVALID_DETECTION_INPUT (HERR_BASIC_BASE + 36)       // Failed to modify detector input size
+#define HERR_INVALID_IMAGE_BITMAP_HANDLE (HERR_BASIC_BASE + 37)   // Invalid image bitmap handle
+
+#define HERR_SESS_BASE 0X500                                     // Session error types
+#define HERR_SESS_FUNCTION_UNUSABLE (HERR_SESS_BASE + 2)         // Function not usable
+#define HERR_SESS_TRACKER_FAILURE (HERR_SESS_BASE + 3)           // Tracker module not initialized
+#define HERR_SESS_INVALID_RESOURCE (HERR_SESS_BASE + 10)         // Invalid static resource
+#define HERR_SESS_NUM_OF_MODELS_NOT_MATCH (HERR_SESS_BASE + 11)  // Number of models does not match
+#define HERR_SESS_LANDMARK_NUM_NOT_MATCH (HERR_SESS_BASE + 20)   // The number of input landmark points does not match
+#define HERR_SESS_LANDMARK_NOT_ENABLE (HERR_SESS_BASE + 21)      // The number of input landmark points does not match
+#define HERR_SESS_KEY_POINT_NUM_NOT_MATCH (HERR_SESS_BASE + 22)  // The number of input key points does not match
+
+#define HERR_SESS_PIPELINE_FAILURE (HERR_SESS_BASE + 8)  // Pipeline module not initialized
+
+#define HERR_SESS_REC_EXTRACT_FAILURE (HERR_SESS_BASE + 15)       // Face feature extraction not registered
+#define HERR_SESS_REC_DEL_FAILURE (HERR_SESS_BASE + 16)           // Face feature deletion failed due to out of range index
+#define HERR_SESS_REC_UPDATE_FAILURE (HERR_SESS_BASE + 17)        // Face feature update failed due to out of range index
+#define HERR_SESS_REC_ADD_FEAT_EMPTY (HERR_SESS_BASE + 18)        // Feature vector for registration cannot be empty
+#define HERR_SESS_REC_FEAT_SIZE_ERR (HERR_SESS_BASE + 19)         // Incorrect length of feature vector for registration
+#define HERR_SESS_REC_INVALID_INDEX (HERR_SESS_BASE + 20)         // Invalid index number
+#define HERR_SESS_REC_CONTRAST_FEAT_ERR (HERR_SESS_BASE + 23)     // Incorrect length of feature vector for comparison
+#define HERR_SESS_REC_BLOCK_FULL (HERR_SESS_BASE + 24)            // Feature vector block full
+#define HERR_SESS_REC_BLOCK_DEL_FAILURE (HERR_SESS_BASE + 25)     // Deletion failed
+#define HERR_SESS_REC_BLOCK_UPDATE_FAILURE (HERR_SESS_BASE + 26)  // Update failed
+#define HERR_SESS_REC_ID_ALREADY_EXIST (HERR_SESS_BASE + 27)      // ID already exists
+
+#define HERR_SESS_FACE_DATA_ERROR (HERR_SESS_BASE + 30)  // Face data parsing
+
+#define HERR_SESS_FACE_REC_OPTION_ERROR (HERR_SESS_BASE + 40)  // An optional parameter is incorrect
+
+#define HERR_FT_HUB_DISABLE (HERR_SESS_BASE + 49)                // FeatureHub is disabled
+#define HERR_FT_HUB_OPEN_ERROR (HERR_SESS_BASE + 50)             // Database open error
+#define HERR_FT_HUB_NOT_OPENED (HERR_SESS_BASE + 51)             // Database not opened
+#define HERR_FT_HUB_NO_RECORD_FOUND (HERR_SESS_BASE + 52)        // No record found
+#define HERR_FT_HUB_CHECK_TABLE_ERROR (HERR_SESS_BASE + 53)      // Data table check error
+#define HERR_FT_HUB_INSERT_FAILURE (HERR_SESS_BASE + 54)         // Data insertion error
+#define HERR_FT_HUB_PREPARING_FAILURE (HERR_SESS_BASE + 55)      // Data preparation error
+#define HERR_FT_HUB_EXECUTING_FAILURE (HERR_SESS_BASE + 56)      // SQL execution error
+#define HERR_FT_HUB_NOT_VALID_FOLDER_PATH (HERR_SESS_BASE + 57)  // Invalid folder path
+#define HERR_FT_HUB_ENABLE_REPETITION (HERR_SESS_BASE + 58)      // Enable db function repeatedly
+#define HERR_FT_HUB_DISABLE_REPETITION (HERR_SESS_BASE + 59)     // Disable db function repeatedly
+#define HERR_FT_HUB_NOT_FOUND_FEATURE (HERR_SESS_BASE + 60)      // Get face feature error
+
+#define HERR_ARCHIVE_LOAD_FAILURE (HERR_SESS_BASE + 80)        // Archive load failure
+#define HERR_ARCHIVE_LOAD_MODEL_FAILURE (HERR_SESS_BASE + 81)  // Model load failure
+#define HERR_ARCHIVE_FILE_FORMAT_ERROR (HERR_SESS_BASE + 82)   // The archive format is incorrect
+#define HERR_ARCHIVE_REPETITION_LOAD (HERR_SESS_BASE + 83)     // Do not reload the model
+#define HERR_ARCHIVE_NOT_LOAD (HERR_SESS_BASE + 84)            // Model not loaded
+
+#define HERR_DEVICE_BASE 0X900                                        // hardware error
+#define HERR_DEVICE_CUDA_NOT_SUPPORT (HERR_DEVICE_BASE + 1)           // CUDA not supported
+#define HERR_DEVICE_CUDA_TENSORRT_NOT_SUPPORT (HERR_DEVICE_BASE + 2)  // CUDA TensorRT not supported
+#define HERR_DEVICE_CUDA_UNKNOWN_ERROR (HERR_DEVICE_BASE + 20)        // CUDA unknown error
+#define HERR_DEVICE_CUDA_DISABLE (HERR_DEVICE_BASE + 21)              // CUDA support is disabled
+// [Anchor-End]
+
+#endif  // INSPIRE_FACE_HERROR_H

include/herror.h

@@ -0,0 +1,28 @@
+#ifndef INSPIRECV_CHECK_H_
+#define INSPIRECV_CHECK_H_
+#include "logging.h"
+
+#define INSPIRECV_RETURN_IF_ERROR(...)                 \
+    do {                                               \
+        const okcv::Status _status = (__VA_ARGS__);    \
+        if (!_status.ok()) {                           \
+            INSPIRECV_LOG(ERROR) << _status.message(); \
+            return _status;                            \
+        }                                              \
+    } while (0)
+
+#define INSPIRECV_LOG_IF(severity, condition) \
+    if (condition)                            \
+    INSPIRECV_LOG(severity)
+
+#define INSPIRECV_CHECK(condition) \
+    INSPIRECV_LOG_IF(FATAL, !(condition)) << "Check failed: (" #condition ") "
+
+#define INSPIRECV_CHECK_EQ(a, b) INSPIRECV_CHECK((a) == (b))
+#define INSPIRECV_CHECK_NE(a, b) INSPIRECV_CHECK((a) != (b))
+#define INSPIRECV_CHECK_LE(a, b) INSPIRECV_CHECK((a) <= (b))
+#define INSPIRECV_CHECK_LT(a, b) INSPIRECV_CHECK((a) < (b))
+#define INSPIRECV_CHECK_GE(a, b) INSPIRECV_CHECK((a) >= (b))
+#define INSPIRECV_CHECK_GT(a, b) INSPIRECV_CHECK((a) > (b))
+
+#endif  // INSPIRECV_CHECK_H_

include/inspirecv/check.h

@@ -0,0 +1,28 @@
+#ifndef INSPIRECV_CORE_COLOR_H
+#define INSPIRECV_CORE_COLOR_H
+
+#include <vector>
+
+namespace inspirecv {
+
+namespace Color {
+
+const std::vector<double> Red = {0.0, 0.0, 255.0};
+const std::vector<double> Green = {0.0, 255.0, 0.0};
+const std::vector<double> Blue = {255.0, 0.0, 0.0};
+const std::vector<double> Black = {0.0, 0.0, 0.0};
+const std::vector<double> White = {255.0, 255.0, 255.0};
+const std::vector<double> Yellow = {0.0, 255.0, 255.0};
+const std::vector<double> Magenta = {255.0, 0.0, 255.0};
+const std::vector<double> Cyan = {255.0, 255.0, 0.0};
+const std::vector<double> Gray = {128.0, 128.0, 128.0};
+const std::vector<double> Orange = {0.0, 128.0, 255.0};
+const std::vector<double> Purple = {128.0, 0.0, 128.0};
+const std::vector<double> Brown = {42.0, 42.0, 165.0};
+const std::vector<double> Pink = {147.0, 20.0, 255.0};
+
+}  // namespace Color
+
+}  // namespace inspirecv
+
+#endif  // INSPIRECV_CORE_COLOR_H

include/inspirecv/core/color.h

@@ -0,0 +1,39 @@
+#ifndef INSPIRECV_DEFINE_H
+#define INSPIRECV_DEFINE_H
+
+#include <array>
+
+#ifndef INSPIRECV_API
+#define INSPIRECV_API
+#endif
+
+namespace inspirecv {
+
+template <typename T, size_t N>
+using Vec = std::array<T, N>;
+
+template <typename T>
+using Vec2 = Vec<T, 2>;
+template <typename T>
+using Vec3 = Vec<T, 3>;
+template <typename T>
+using Vec4 = Vec<T, 4>;
+
+// Float vectors
+using Vec2f = Vec<float, 2>;
+using Vec3f = Vec<float, 3>;
+using Vec4f = Vec<float, 4>;
+
+// Double vectors
+using Vec2d = Vec<double, 2>;
+using Vec3d = Vec<double, 3>;
+using Vec4d = Vec<double, 4>;
+
+// Integer vectors
+using Vec2i = Vec<int, 2>;
+using Vec3i = Vec<int, 3>;
+using Vec4i = Vec<int, 4>;
+
+}  // namespace inspirecv
+
+#endif  // INSPIRECV_DEFINE_H