deepar 5.4.0-canvasInDiv-alpha-13 → 5.4.0-chromeExtension

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

@@ -0,0 +1,219 @@
+/*! *****************************************************************************
+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.
+ * 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 2018 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 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 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 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.
+ * 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 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 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.
+ * 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.
+ * 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.
+ * 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 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
+ *
+ * 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.
+ * =============================================================================
+ */

package/js/types/DeepAR.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="dom-mediacapture-transform" />
 import { ARTouchInfo } from "./touchType";
 import { DeepARCallbacks } from "./callbacks";
 import { DeepARParams } from "./initParams";
@@ -24,6 +25,7 @@ export declare class DeepAR {
      * @private
      */
     private module;
+    private canvasTouchHelper;
     /**
      * Callbacks property is used to add/remove/change callbacks called by the DeepAR SDK. See list of all callbacks at {@link DeepARCallbacks}. <br><br>
      * Example: To add/change certain callback:
@@ -101,18 +103,50 @@ export declare class DeepAR {
      */
     takeScreenshot(): Promise<string>;
     /**
-     * Starts video recording of the canvas.
+     * Start video recording of the DeepAR preview.
+     *
+     * To stop video recording call {@link finishVideoRecording}.
+     * By default, the audio is not recorded. To record audio set the recordAudio parameter. Note that if the user did not give the microphone permission, the recording will not start until the permission is granted. If permission is denied, the function will throw.
+     * The recorded video will be mp4 on all browsers except Firefox where it will be webm.
+     * Audio recording is currently not available on Android.
+     *
      * @param options Parameters that specify the format of recorded videos
-     * @param options.mimeType A MIME type specifying the format for the resulting video, such as `video/webm` or `video/mp4`. Corresponds to the MIME type used by <a href="https://developer.mozilla.org/en-US/docs/Web/API/Blob">Blob</a>objects and <a href="https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder">MediaRecorder</a>from the MediaStream Recording API. Note that `video/mp4` may not be supported in all browsers.
+     * @param options.recordAudio If set, microphone sound will be recorded as well. If this parameter is set, options.audioTrack is ignored.
+     * @param options.audioTrack If passed, this audio track is going to be recorded.
+     * @param options.audioBitRate Sets audio bit rate. By default 128000.
+     * @param options.audioSampleRate Set audio sample rate. On firefox it is 48k. On other browsers defaults to audioTrack.getCapabilities().sampleRate.max or to the value passed here.
+     * @param options.videoBitRate Sets video bit rate. By default 4000000.
+     * @param options.videoFrameRate Sets video frame rate. By default 30.
      */
     startVideoRecording(options?: {
-        mimeType?: string;
-    }): void;
+        recordAudio?: boolean;
+        audioTrack?: MediaStreamAudioTrack;
+        audioBitRate?: number;
+        audioSampleRate?: number;
+        videoBitRate?: number;
+        videoFrameRate?: number;
+    }): Promise<void>;
     /**
      * Stops the video recording and returns a video blob.
      * @returns A promise resolving to Blob of a video.
      */
     finishVideoRecording(): Promise<Blob>;
+    /**
+     * Enable background blur.
+     *
+     * Background blur is usually used in video calling use cases.
+     *
+     * @param enable - Boolean indicating whether to enable or disable the background blur effect.
+     * @param strength - Blur strength. Integer number in range 1-10.
+     */
+    backgroundBlur(enable: boolean, strength: number): Promise<void>;
+    /**
+     * Enable background replacement (also known as background removal or green screen effect).
+     *
+     * @param enable - Boolean indicating whether to enable or disable the background replacement effect.
+     * @param image - The URL of the image to be used as the background.
+     */
+    backgroundReplacement(enable: boolean, image: string): Promise<void>;
     /**
      * Starts the camera preview. By default, the camera will be user facing. The returned promise will resolve after the camera starts
      * or it will reject if camera permission was denied.
@@ -158,6 +192,12 @@ export declare class DeepAR {
      * After shutdown call, it is possible to call {@link initialize} again.
      */
     shutdown(): void;
+    /**
+     * Mutes or un-mutes all the sounds that are currently playing.
+     *
+     * @param muteSound true if you want to mute all the sounds.
+     */
+    muteSound(muteSound: boolean): void;
     /**
      * Feed RGBA image to DeepAR as input instead of camera or video. Used for processing single image. Can be used instead of {@link startCamera} or {@link setVideoElement}.
      * Can be called in a loop.
@@ -218,11 +258,6 @@ export declare class DeepAR {
      * @param trigger The name of the trigger.
      */
     fireTrigger(trigger: string): void;
-    /**
-     * Informs DeepAR that the specified touch event occurred.
-     * @param touchInfo Touch event information.
-     */
-    touchOccurred(touchInfo: ARTouchInfo): void;
     /**
      * Change face detection sensitivity
      * @param sensitivity 0 .. 5 (0 is fast, 4,5 is slow but allows to find smaller faces)
@@ -240,6 +275,16 @@ export declare class DeepAR {
      * @param enable True - DeepAR will use its internal timer for the rendering loop. Rendering will work even when tab is not focused. False - DeepAR will use requestAnimationFrame() for the rendering loop.
      */
     setOffscreenRenderingEnabled(enable: boolean): void;
+    /**
+     * Retrieves the HTML canvas element used for AR preview.
+     *
+     * The returned canvas is used for DeepAR rendering of camera preview and AR filters.
+     * Most commonly canvas is needed when you want to do some postprocessing on it or feed it
+     * into some video calling library.
+     *
+     * @return {HTMLCanvasElement} The HTML canvas element.
+     */
+    getCanvas(): HTMLCanvasElement;
     /**
      * Set the FPS of DeepAR rendering.
      * @param fps New FPS.
@@ -297,27 +342,15 @@ export declare class DeepAR {
      */
     moveGameObject(selectedGameObject: string, targetGameObject: string): void;
     /**
-     * Mutes or un-mutes all the sounds that are currently playing.
-     *
-     * @param muteSound true if you want to mute all the sounds.
-     */
-    muteSound(muteSound: boolean): void;
-    /**
-     * Enable background blur.
-     *
-     * Background blur is usually used in video calling use cases.
+     * Informs DeepAR that the specified touch event occurred.
      *
-     * @param enable - Boolean indicating whether to enable or disable the background blur effect.
-     * @param strength - Blur strength. Integer number in range 1-10.
-     */
-    backgroundBlur(enable: boolean, strength: number): Promise<void>;
-    /**
-     * Enable background replacement (also known as background removal or green screen effect).
+     * @deprecated
+     * Since version 5.4.0 DeepAR will automatically register touch events from canvas.
+     * There is no need to call this function anymore.
      *
-     * @param enable - Boolean indicating whether to enable or disable the background replacement effect.
-     * @param image - The URL of the image to be used as the background.
+     * @param touchInfo Touch event information.
      */
-    backgroundReplacement(enable: boolean, image: string): Promise<void>;
+    touchOccurred(touchInfo: ARTouchInfo): void;
     /** INTERNAL API **/
     /**
      * @internal

package/js/types/callbacks.d.ts

@@ -60,4 +60,5 @@ export interface DeepARCallbacks {
      * @internal
      */
     __deeparRendered?: (canvas: HTMLCanvasElement) => void;
+    __deeparRendered2?: (canvas: HTMLCanvasElement) => void;
 }

package/js/types/canvasHelper.d.ts

@@ -8,9 +8,9 @@ declare const preRenderUpdate: () => void;
 declare const postRenderUpdate: () => void;
 /**
  * Creates a canvas and appends it to the target element.
- * @param targetElement
+ * @param previewElement
  */
-declare function createCanvas(targetElement: HTMLElement): HTMLCanvasElement;
+declare function createCanvas(previewElement: HTMLElement): HTMLCanvasElement;
 /**
  * Removes the created canvas and invalidates the current context.
  */

package/js/types/canvasTouchHelper.d.ts

@@ -0,0 +1,13 @@
+import { ARTouchInfo } from "./touchType";
+export declare class CanvasTouchHelper {
+    private canvas;
+    private canvasListeners;
+    private touchOccurring;
+    private touchListeners;
+    constructor(canvas: HTMLCanvasElement, listener: (info: ARTouchInfo) => void | null);
+    cleanUpCanvasListeners(): void;
+    addTouchListener(listener: (info: ARTouchInfo) => void): void;
+    private touchOccurred;
+    private registerCanvasListener;
+    private touchInfo;
+}

package/js/types/initParams.d.ts

@@ -7,20 +7,20 @@ export interface DeepARParams {
      */
     licenseKey: string;
     /**
-     * Target HTML element where AR preview will be presented.
-     *
-     * > ⚠️ You must specify {@link targetElement} or {@link canvas}.
+     * HTML element where AR preview will be presented.
      *
      * This is usually a <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div">div</a> element which
-     * is used solely for AR preview. AR preview will fully occupy the targetElement's space.
-     * Therefore, position and size your targetElement according to your preferred AR preview dimensions.
+     * is used solely for AR preview. AR preview will fully occupy the previewElement's space.
+     * Therefore, position and size your previewElement according to your preferred AR preview dimensions.
      *
-     * > NOTE: AR preview will adjust to the size of the targetElement if it changes.
+     * > NOTE: AR preview will adjust to the size of the previewElement if it changes.
      *
-     * The canvas element will be appended as child to the targetElement. If you wish to work with the canvas element directly
+     * The canvas element will be appended as child to the previewElement. If you wish to work with the canvas element directly
      * and position and size it yourself then use {@link canvas} parameter instead.
+     *
+     * > ⚠️ You must specify {@link previewElement} or {@link canvas}.
      */
-    targetElement?: HTMLElement;
+    previewElement?: HTMLElement;
     /**
      *  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}.
@@ -42,9 +42,9 @@ export interface DeepARParams {
     /**
      * Canvas element where DeepAR will render the AR preview.
      *
-     * > ⚠️ You must specify {@link targetElement} or {@link canvas}.
+     * > ⚠️ You must specify {@link previewElement} or {@link canvas}.
      *
-     * The preferred way is by using the {@link targetElement} parameter.
+     * The preferred way is by using the {@link previewElement} parameter.
      * In that case, the DeepAR will take care of correctly sizing the canvas.
      *
      * @example
@@ -109,14 +109,58 @@ export interface DeepARParams {
              */
             modelPath: string;
         };
+        rigidFaceTrackingConfig?: {
+            /**
+             * Path to the pose libPoseEstimation.wasm file, e.g. "/path/to/deepar/wasm/libPoseEstimation.wasm".
+             */
+            poseEstimationWasmPath?: string;
+            /**
+             * Path to the detector model, e.g. "/path/to/deepar/models/foot/foot-detector.bin".
+             */
+            detectorPath?: string;
+            /**
+             * Path to the tracker model, e.g. "/path/to/deepar/models/foot/foot-tracker.bin".
+             */
+            trackerPath?: string;
+            /**
+             * Path to the foot model object file, e.g. "/path/to/deepar/models/foot/foot-model.obj".
+             */
+            objPath?: string;
+            /**
+             * Path to tfjs-backend-wasm.wasm file, e.g. "path/to/deepar/wasm/tfjs-backend-wasm.wasm"
+             */
+            tfjsBackendWasmPath?: string;
+            /**
+             * Path to tfjs-backend-wasm-simd.wasm file, e.g. "path/to/deepar/wasm/tfjs-backend-wasm-simd.wasm"
+             */
+            tfjsBackendWasmSimdPath?: string;
+            /**
+             * Path to tfjs-backend-wasm-threaded-simd.wasm file, e.g. "path/to/deepar/wasm/tfjs-backend-wasm-threaded-simd.wasm"
+             */
+            tfjsBackendWasmThreadedSimdPath?: string;
+        };
         /**
          * Segmentation module path and options.
          */
         segmentationConfig?: {
             /**
-             * Path to the segmentation model. Something like "path/to/deepar/models/segmentation/segmentation-192x192.bin".
+             * Path to the base segmentation model. Something like "path/to/deepar/models/segmentation/segmentation-192x192.bin".
+             * Thi is not used by default.
              */
-            modelPath: string;
+            modelPath?: string;
+            /**
+             * MediaPipe segmentation config.
+             */
+            mediaPipeConfig?: {
+                /**
+                 * Base path to wasm fileset. Something like "path/to/deepar/mediaPipe/segmentation/wasm".
+                 */
+                wasmBasePath?: string;
+                /**
+                 * MediaPipe selfie segmenter model to be used. Something like "path/to/deepar/mediaPipe/segmentation/model/selfie_segmenter.tflite".
+                 */
+                modelPath?: string;
+            };
         };
         /**
          * Foot tracking module paths and options.
@@ -188,5 +232,13 @@ export interface DeepARParams {
          * Path to deepar.wasm file. Something like "/path/to/deepar/wasm/deepar.wasm".
          */
         deeparWasmPath?: string;
+        dynamicModulesConfig?: {
+            xzimgPath?: string;
+            mediaPipePath?: string;
+        };
+        embeddedEffectsConfig?: {
+            backgroundBlurPath?: string;
+            backgroundReplacementPath?: string;
+        };
     };
 }

package/js/types/mediaRecorderVideoRecording.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="dom-mediacapture-transform" />
+export declare function startMediaRecorderVideoRecording(canvas: HTMLCanvasElement, options: {
+    audioTrack?: MediaStreamAudioTrack;
+    audioBitRate?: number;
+    audioSampleRate: number;
+    videoBitRate: number;
+    videoFrameRate: number;
+    mimeType: string;
+}): void;
+export declare function finishMediaRecorderVideoRecording(): Promise<Blob>;

package/js/types/version.d.ts

@@ -1,5 +1,5 @@
 /**
  * DeepAR Web SDK version.
  */
-declare const version = "5.4.0-canvasInDiv-alpha-13";
+declare const version = "5.4.0-chromeExtension";
 export { version };

package/js/types/webCodecsVideoRecording.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="dom-mediacapture-transform" />
+import { DeepARCallbacks } from './callbacks';
+export declare function startWebCodecVideoRecording(canvas: HTMLCanvasElement, callbacks: DeepARCallbacks, options: {
+    audioTrack?: MediaStreamAudioTrack;
+    audioBitRate?: number;
+    audioSampleRate: number;
+    videoBitRate: number;
+    videoFrameRate: number;
+    mimeType: string;
+}): Promise<void>;
+export declare function finishWebCodecVideoRecording(callbacks: DeepARCallbacks): Promise<Blob>;

package/lib/LICENSE

@@ -0,0 +1 @@
+Please see: https://developer.deepar.ai/customer-agreement