deepar 5.6.19 → 5.6.21

package/js/dynamicModules/xzimg.js.LICENSE.txt

@@ -1,18 +1,3 @@
-/*! *****************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-
 /**
  * @license
  * Copyright 2017 Google LLC. All Rights Reserved.
@@ -82,23 +67,6 @@ PERFORMANCE OF THIS SOFTWARE.
  * =============================================================================
  */
 
-/**
- * @license
- * Copyright 2019 Google LLC. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the 'License');
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an 'AS IS' BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * =============================================================================
- */
-
 /**
  * @license
  * Copyright 2020 Google Inc. All Rights Reserved.
@@ -133,23 +101,6 @@ PERFORMANCE OF THIS SOFTWARE.
  * =============================================================================
  */
 
-/**
- * @license
- * Copyright 2020 Google LLC. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the License);
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an AS IS BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * =============================================================================
- */
-
 /**
  * @license
  * Copyright 2021 Google LLC. All Rights Reserved.
@@ -169,24 +120,7 @@ PERFORMANCE OF THIS SOFTWARE.
 
 /**
  * @license
- * Copyright 2022 Google LLC.
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * =============================================================================
- */
-
-/**
- * @license
- * Copyright 2022 Google LLC. All Rights Reserved.
+ * Copyright 2023 Google LLC.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -203,7 +137,7 @@ PERFORMANCE OF THIS SOFTWARE.
 
 /**
  * @license
- * Copyright 2023 Google LLC.
+ * Copyright 2023 Google LLC. All Rights Reserved.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -220,7 +154,7 @@ PERFORMANCE OF THIS SOFTWARE.
 
 /**
  * @license
- * Copyright 2023 Google LLC. All Rights Reserved.
+ * Copyright 2025 Google LLC. All Rights Reserved.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at

package/js/types/DeepAR.d.ts

@@ -4,8 +4,8 @@ import { DeepARCallbacks } from "./callbacks";
 import { DeepARParams } from "./initParams";
 import { LogType } from "./logType";
 import { ScriptingAPI } from "./scriptingApi";
-import type * as xzimg from "./dynamicModules/xzimg/index";
-import type * as mediaPipe from "./dynamicModules/mediaPipe/index";
+import { FootData } from "./footData";
+import { DynamicDeps } from "./dynamicImport";
 export declare type ToneMapping = "Linear" | "Reinhard" | "Cineon" | "ACES" | "AGX" | "Neutral";
 declare global {
     interface Window extends DynamicDeps {
@@ -15,10 +15,6 @@ declare global {
         require?: (modules: string[], onLoad: (mod: unknown) => void, onError: () => void) => void;
     }
 }
-interface DynamicDeps {
-    __deeparDynamicJsModule_xzimg__: typeof xzimg;
-    __deeparDynamicJsModule_mediaPipe__: typeof mediaPipe;
-}
 /**
  * Initialize the DeepAR SDK.<br><br>
  * @param params Initialization parameters.
@@ -549,5 +545,16 @@ export declare class DeepAR {
      * @param rotation
      */
     setVideoRotation(rotation: number): void;
+    setSubsampleVisionImage(subsample: boolean): void;
+    useExternalTrackingData(use: boolean): void;
+    setExternalTrackingDataFoot(left: FootData, right: FootData): void;
+    getFootData(): {
+        left: FootData;
+        right: FootData;
+    } | null;
+    addPreRenderListener(listener: () => void): void;
+    addPostRenderListener(listener: () => void): void;
+    removePreRenderListener(listener: () => void): void;
+    removePostRenderListener(listener: () => void): void;
+    setWatchTicking(isTicking: boolean, beatsPerSecond?: number): void;
 }
-export {};

package/js/types/callbacks.d.ts

@@ -39,7 +39,12 @@ export interface DeepARCallbacks {
      * Because this callback is called only once. So if you set this callback after the foot tracking is initialized, it will not be called again.
      * @internal
      */
-    onFootTrackingInitialized?: () => void;
+    onFootTrackingInitialized?: (fovY: number, filteringDelay: number, width: number, height: number) => void;
+    /**
+     * Called when face tracking is fully initialized.
+     * @internal
+     */
+    onFaceTrackingInitialized?: (fovY: number, width: number, height: number) => void;
     /**
      * Called when segmentation is fully initialized.
      * Be sure to check {@link DeepAR.isSegmentationInitialized} before setting this callback.
@@ -52,7 +57,7 @@ export interface DeepARCallbacks {
      * Because this callback is called only once. So if you set this callback after the wrist tracking is initialized, it will not be called again.
      * @internal
      */
-    onWristTrackingInitialized?: () => void;
+    onWristTrackingInitialized?: (fovY: number, filteringDelay: number, width: number, height: number) => void;
     /**
      * Called when the animation player transitions to a new state.
      * @param newState Name of the new state that is being transitioned to.

package/js/types/dynamicImport.d.ts

@@ -0,0 +1,10 @@
+import type * as xzimg from "./dynamicModules/xzimg";
+import type * as mediaPipe from "./dynamicModules/mediaPipe";
+import { CombinedGlobalProgress, GlobalProgress } from "./fetch";
+export interface DynamicDeps {
+    __deeparDynamicJsModule_xzimg__: typeof xzimg;
+    __deeparDynamicJsModule_mediaPipe__: typeof mediaPipe;
+}
+export declare function disposeDynamicImports(): void;
+export declare const dynamicImportXzimg: (path: string) => (progress: GlobalProgress | CombinedGlobalProgress) => Promise<typeof xzimg>;
+export declare const dynamicImportMediaPipe: (path: string) => (progress: GlobalProgress | CombinedGlobalProgress) => Promise<typeof mediaPipe>;

package/js/types/dynamicModules/xzimg/index.d.ts

@@ -1 +1 @@
-export { Foot, Segmentation, VideoManager, Geometry } from "../../../../xzimg/xzimg.esm";
+export { Foot, Segmentation, VideoManager, Geometry, shutdownTfjs } from "../../../../xzimg/xzimg.esm";

package/js/types/errors.d.ts

@@ -4,3 +4,9 @@
 export declare class SwitchEffectCanceled extends Error {
     constructor(message?: string);
 }
+export declare class NoCameraError extends Error {
+    constructor(message?: string);
+}
+export declare class CameraPermissionDeniedError extends Error {
+    constructor(message?: string);
+}

package/js/types/fetch.d.ts

@@ -0,0 +1,51 @@
+export declare function setFileSizes(sizes: any): void;
+export interface Progress {
+    loaded: number;
+    total: number;
+}
+interface FileProgress extends Progress {
+    isFailed: boolean;
+    dataPromise: Promise<ArrayBuffer>;
+    data: ArrayBuffer | null;
+    isStarted: boolean;
+    xhr: XMLHttpRequest;
+    isLengthComputable: boolean;
+    isEventLengthComputable: boolean;
+    isCancelled: boolean;
+}
+export declare class GlobalProgress {
+    private files;
+    private totalProgress;
+    onProgress?: (progress: Progress) => void;
+    startImmediately: boolean;
+    constructor(startImmediately?: boolean);
+    downloadFile(url: string, type?: XMLHttpRequestResponseType, startImmediately?: boolean): Promise<ArrayBuffer>;
+    addCustomProgress(): (progress: Progress) => void;
+    private reportProgress;
+    getFileProgress(url: string): FileProgress;
+    getProgress(): Progress;
+    getFilePromises(url: string): Promise<ArrayBuffer>;
+    getFileData(url: string): ArrayBuffer | null;
+    getFilesList(): string[];
+    isUrlTracked(url: string): boolean;
+    dispose(): void;
+    startDownloading(): void;
+    allFilesHaveSize(): boolean;
+}
+export declare class CombinedGlobalProgress {
+    private progressArray;
+    private progressGroupId;
+    private groupWeight;
+    private totalProgress;
+    onProgress?: (progress: Progress) => void;
+    addGlobalProgress(globalProgress: GlobalProgress, groupId?: number): void;
+    setGroupWeight(groupId: number, weight: number): void;
+    getFileProgress(url: string): FileProgress;
+    getProgress(): Progress;
+    getFilePromises(url: string): Promise<ArrayBuffer>;
+    getFileData(url: string): ArrayBuffer | null;
+    getFilesList(): string[];
+    isUrlTracked(url: string): boolean;
+    dispose(): void;
+}
+export {};

package/js/types/flags_wasm.d.ts

@@ -0,0 +1,8 @@
+/**
+ * True if SIMD is supported.
+ */
+export declare const WASM_HAS_SIMD_SUPPORT: boolean;
+/**
+ * True if threads are supported.
+ */
+export declare const WASM_HAS_MULTITHREAD_SUPPORT: boolean;

package/js/types/footData.d.ts

@@ -7,4 +7,16 @@ export interface FootData {
      * True if the foot is detected, false otherwise.
      */
     detected: boolean;
+    /**
+     * Array of 3 floats containing (x, y, z) scale of the foot in 3D space.
+     */
+    scale: number[];
+    /**
+     * Array of 4 floats containing quat rotation of the foot in 3D space.
+     */
+    rotation: number[];
+    /**
+     * Array of 3 floats containing (x, y, z) position of the foot in 3D space.
+     */
+    position: number[];
 }

package/js/types/initParams.d.ts

@@ -1,4 +1,18 @@
 import { ToneMapping } from "./DeepAR";
+import { Progress } from "./fetch";
+export declare type SwitchEffectOptions = {
+    slot?: string;
+    face?: number;
+    envmap?: string | ArrayBufferLike;
+    diamondEnvMap?: string | ArrayBufferLike;
+    onProgress?: (progress: Progress) => void;
+    trackingInit?: {
+        foot?: boolean;
+        wrist?: boolean;
+        face?: boolean;
+        segmentation?: boolean;
+    };
+};
 /**
  * Parameters for the initialization of {@link DeepAR} object.
  */
@@ -26,7 +40,12 @@ export interface DeepARParams {
      *  The URL of a DeepAR effect file. This effect will be applied when DeepAR is initialized.
      *  This parameter is optional. You can always later switch to a different effect with {@link DeepAR.switchEffect}.
      */
-    effect?: string;
+    effect?: string | ArrayBufferLike;
+    /**
+     * Options for switching effects
+     * @internal
+     */
+    effectOptions?: Omit<SwitchEffectOptions, 'onProgress'>;
     /**
      * Path to the root directory of the DeepAR SDK. This path will be used to locate and download all the additional needed files like ML models and wasm files.
      * By default, this points to the JsDelivr CDN. For example "https://cdn.jsdelivr.net/npm/deepar@5.0.0/".<br>
@@ -64,6 +83,11 @@ export interface DeepARParams {
      * ```
      */
     canvas?: HTMLCanvasElement;
+    /**
+     * Callback that will be called with the progress of the initialization.
+     * @internal
+     */
+    onProgress?: (progress: Progress) => void;
     /**
      * Additional DeepAR options.
      */
@@ -127,10 +151,6 @@ export interface DeepARParams {
              * Path to the tracker model, e.g. "/path/to/deepar/models/face-cnn/face-track-19-v2.bin".
              */
             trackerPath?: string;
-            /**
-             * Path to the face model object file, e.g. "/path/to/deepar/models/face/face-rigid.obj".
-             */
-            objPath?: string;
             /**
              * Path to tfjs-backend-wasm.wasm file, e.g. "path/to/deepar/wasm/tfjs-backend-wasm.wasm"
              */

package/js/types/version.d.ts

@@ -1,5 +1,5 @@
 /**
  * DeepAR Web SDK version.
  */
-declare const version = "5.6.19";
+declare const version = "5.6.21";
 export { version };

package/js/types/watch-ticking.d.ts

@@ -0,0 +1,8 @@
+interface DeepARInterface {
+    addPreRenderListener: (listener: () => void) => void;
+    removePreRenderListener: (listener: () => void) => void;
+    changeParameterVector: (name: string, parameterGroup: string, parameterType: string, index: number, x: number, y: number, z: number) => void;
+}
+export declare function addClock(deepAR: DeepARInterface, beatsPerSecond?: number): void;
+export declare function removeClock(deepAR: DeepARInterface): void;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "deepar",
-  "version": "5.6.19",
+  "version": "5.6.21",
   "description": "The official DeepAR Web SDK",
   "main": "js/deepar.esm.js",
   "jsdelivr": "js/deepar.js",