deepar 4.0.3 → 4.1.0-alpha-720

package/README.md

@@ -209,8 +209,8 @@ To use shoe try-on feature DeepAR needs to initialize foot tracking. All the `fo
 
 ```javascript
 import poseEstimationWasmPath from 'deepar/wasm/libxzimgPoseEstimation.wasm';
-import footDetectorPath from 'deepar/models/foot/foot-detector-android.bin'; // or ...-ios.bin
-import footTrackerPath from 'deepar/models/foot/foot-tracker-android.bin'; // or ...-ios.bin
+import footDetectorPath from 'deepar/models/foot/foot-detection-96x96x6.bin';
+import footTrackerPath from 'deepar/models/foot/foot-tracker-96x96x18-test.bin'; // or foot-tracker-96x96x13-test.bin
 import footObjPath from 'deepar/models/foot/foot-model.obj';
 
 // ...

package/js/deepar.d.ts

@@ -31,6 +31,12 @@ export interface FaceData {
      */
     faceRect: number[];
 }
+export interface FootData {
+    /**
+     * True if the foot is detected, false otherwise.
+     */
+    detected: boolean;
+}
 /**
  * Functions that gets called by the DeepAR SDK.
  * Pass them when creating {@link DeepAR} object in {@link DeepARParams.callbacks} object.
@@ -82,10 +88,20 @@ export interface DeepARCallbacks {
      */
     onFaceVisibilityChanged?: (visible: boolean) => void;
     /**
-     * Passes the information about the detected faces. If this callback is set it will get called every frame.
+     * Passes the information about the detected faces. If this callback is set, it will get called every frame when a face is detected.
      * @param faceDataArray Information about all the tracked faces.
      */
     onFaceTracked?: (faceDataArray: FaceData[]) => void;
+    /**
+     * Called when foot tracking is fully initialized.
+     */
+    onFootTrackingInitialized?: () => void;
+    /**
+     * Passes the information about the detected feet. If this callback is set, it will get called every frame when a foot is detected.
+     * @param leftFootData Information about the left foot.
+     * @param rightFootData Information about the right foot.
+     */
+    onFeetTracked?: (leftFootData: FootData, rightFootData: FootData) => void;
     /**
      * Called when any DeepAR related event happens
      * @param errorType Type of message.
@@ -124,26 +140,9 @@ export interface DeepARParams {
         modelPath: string;
     };
     /**
-     * Object containing configuration for DeepAR foot tracking which is used for virtual shoe try on
+     * Object containing configuration for DeepAR foot tracking which is used for virtual shoe try on.
      */
-    footTrackingConfig?: {
-        /**
-         * Path to the pose estimation wasm file, e.g. "/path/to/libPoseEstimation.wasm"
-         */
-        poseEstimationWasmPath: string;
-        /**
-         * Path to the detector model, e.g. "/path/to/foot-detector-ios.bin"
-         */
-        detectorPath: string;
-        /**
-         * Path to the tracker model, e.g. "/path/to/foot-tracker-ios.bin"
-         */
-        trackerPath: string;
-        /**
-         * Path to the foot model object file, e.g. "/path/to/foot-model.obj"
-         */
-        objPath: string;
-    };
+    footTrackingConfig?: DeepARFootTrackingConfig;
     /**
      * Path to deepar.wasm file. Something like "path/to/deepar.wasm".
      */
@@ -153,6 +152,28 @@ export interface DeepARParams {
      */
     callbacks?: DeepARCallbacks;
 }
+/**
+ * Foot tracking initialization parameters.
+ */
+export interface DeepARFootTrackingConfig {
+    /**
+     * Path to the pose estimation wasm file, e.g. "/path/to/libPoseEstimation.wasm".
+     */
+    poseEstimationWasmPath: string;
+    /**
+     * Path to the detector model, e.g. "/path/to/foot-detection-96x96x6.bin".
+     */
+    detectorPath: string;
+    /**
+     * Path to the tracker model, e.g. "/path/to/foot-tracker-96x96x18-test.bin".
+     * For better performance on older devices, you can use "/path/to/foot-tracker-96x96x13-test.bin".
+     */
+    trackerPath: string;
+    /**
+     * Path to the foot model object file, e.g. "/path/to/foot-model.obj".
+     */
+    objPath: string;
+}
 /**
  * Describes the touch/click type.
  */
@@ -284,6 +305,16 @@ export declare class DeepAR {
      * @param callback Callback to be called when the download is complete.
      */
     downloadFaceTrackingModel(path: string, callback?: () => void): void;
+    /**
+     * Downloads the foot tracking models and initializes foot tracking.
+     * @param options Foot tracking initialization options.
+     * @param options.config Foot tracking configuration. It will extend any previously defined foot tracking configuration.
+     * @param options.onInitialized Callback that gets called when foot tracking is fully initialized.
+     */
+    initializeFootTracking(options?: {
+        config?: DeepARFootTrackingConfig;
+        onInitialized?: () => void;
+    }): void;
     /**
      * Sets the face tracking model data.
      * @param byteArray Face tracking model data.

package/js/deepar.esm.d.ts

@@ -31,6 +31,12 @@ export interface FaceData {
      */
     faceRect: number[];
 }
+export interface FootData {
+    /**
+     * True if the foot is detected, false otherwise.
+     */
+    detected: boolean;
+}
 /**
  * Functions that gets called by the DeepAR SDK.
  * Pass them when creating {@link DeepAR} object in {@link DeepARParams.callbacks} object.
@@ -82,10 +88,20 @@ export interface DeepARCallbacks {
      */
     onFaceVisibilityChanged?: (visible: boolean) => void;
     /**
-     * Passes the information about the detected faces. If this callback is set it will get called every frame.
+     * Passes the information about the detected faces. If this callback is set, it will get called every frame when a face is detected.
      * @param faceDataArray Information about all the tracked faces.
      */
     onFaceTracked?: (faceDataArray: FaceData[]) => void;
+    /**
+     * Called when foot tracking is fully initialized.
+     */
+    onFootTrackingInitialized?: () => void;
+    /**
+     * Passes the information about the detected feet. If this callback is set, it will get called every frame when a foot is detected.
+     * @param leftFootData Information about the left foot.
+     * @param rightFootData Information about the right foot.
+     */
+    onFeetTracked?: (leftFootData: FootData, rightFootData: FootData) => void;
     /**
      * Called when any DeepAR related event happens
      * @param errorType Type of message.
@@ -124,26 +140,9 @@ export interface DeepARParams {
         modelPath: string;
     };
     /**
-     * Object containing configuration for DeepAR foot tracking which is used for virtual shoe try on
+     * Object containing configuration for DeepAR foot tracking which is used for virtual shoe try on.
      */
-    footTrackingConfig?: {
-        /**
-         * Path to the pose estimation wasm file, e.g. "/path/to/libPoseEstimation.wasm"
-         */
-        poseEstimationWasmPath: string;
-        /**
-         * Path to the detector model, e.g. "/path/to/foot-detector-ios.bin"
-         */
-        detectorPath: string;
-        /**
-         * Path to the tracker model, e.g. "/path/to/foot-tracker-ios.bin"
-         */
-        trackerPath: string;
-        /**
-         * Path to the foot model object file, e.g. "/path/to/foot-model.obj"
-         */
-        objPath: string;
-    };
+    footTrackingConfig?: DeepARFootTrackingConfig;
     /**
      * Path to deepar.wasm file. Something like "path/to/deepar.wasm".
      */
@@ -153,6 +152,28 @@ export interface DeepARParams {
      */
     callbacks?: DeepARCallbacks;
 }
+/**
+ * Foot tracking initialization parameters.
+ */
+export interface DeepARFootTrackingConfig {
+    /**
+     * Path to the pose estimation wasm file, e.g. "/path/to/libPoseEstimation.wasm".
+     */
+    poseEstimationWasmPath: string;
+    /**
+     * Path to the detector model, e.g. "/path/to/foot-detection-96x96x6.bin".
+     */
+    detectorPath: string;
+    /**
+     * Path to the tracker model, e.g. "/path/to/foot-tracker-96x96x18-test.bin".
+     * For better performance on older devices, you can use "/path/to/foot-tracker-96x96x13-test.bin".
+     */
+    trackerPath: string;
+    /**
+     * Path to the foot model object file, e.g. "/path/to/foot-model.obj".
+     */
+    objPath: string;
+}
 /**
  * Describes the touch/click type.
  */
@@ -284,6 +305,16 @@ export declare class DeepAR {
      * @param callback Callback to be called when the download is complete.
      */
     downloadFaceTrackingModel(path: string, callback?: () => void): void;
+    /**
+     * Downloads the foot tracking models and initializes foot tracking.
+     * @param options Foot tracking initialization options.
+     * @param options.config Foot tracking configuration. It will extend any previously defined foot tracking configuration.
+     * @param options.onInitialized Callback that gets called when foot tracking is fully initialized.
+     */
+    initializeFootTracking(options?: {
+        config?: DeepARFootTrackingConfig;
+        onInitialized?: () => void;
+    }): void;
     /**
      * Sets the face tracking model data.
      * @param byteArray Face tracking model data.