@vonage/ml-transformers 4.0.1 → 4.2.0

package/dist/types/main.d.ts

@@ -1,8 +1,9 @@
 import { WarningType, ErrorFunction, PipelineInfoData } from "@vonage/media-processor";
-import { BlurRadius, BackgroundBlurConfig, VirtualBackgroundConfig, AssetBackgroundConfig, VideoBackgroundConfig, MediaProcessorBaseConfig, SilhouetteBlurConfig, MediapipeConfig, MediaPipeResults, MediaPipeResultsListener, MediaPipeModelType, FaceDetectionResults, FaceDetectionOptions, FaceMeshResults, FaceMeshOptions, HandsResults, HandsOptions, HolisticResults, HolisticOptions, ObjectronResults, ObjectronOptions, PoseResults, PoseOptions, SelfieSegmentationResults, SelfieSegmentationOptions, MediaPipeModelConfig } from "./src/types";
-import { isSupported } from "./src/utils/support";
+import { BlurRadius, BackgroundBlurConfig, VirtualBackgroundConfig, AssetBackgroundConfig, VideoBackgroundConfig, MediaProcessorBaseConfig, SilhouetteBlurConfig, MediapipeConfig, MediaPipeResults, MediaPipeResultsListener, MediaPipeModelType, FaceDetectionResults, FaceDetectionOptions, FaceMeshResults, FaceMeshOptions, HandsResults, HandsOptions, HolisticResults, HolisticOptions, ObjectronResults, ObjectronOptions, PoseResults, PoseOptions, SelfieSegmentationResults, SelfieSegmentationOptions, MediaPipeModelConfig, SupportedBrowserFeatures, FeatureSupport } from "./src/types";
+import { isSupported, getSupportedBrowserFeatures } from "./src/utils/support";
 import { MediapipeHelper } from "./src/utils/mediapipe";
 import { VonageMediaProcessor } from "./src/facades/vonage-media-processor";
+import { BackgroundTransformer } from "./src/transformers/background-transformer";
 import VonageSelfieSegmentation from "./libs/selfie-segmentation-helper";
 /**
  * MediaPipe Selfie Segmentation static metadata.
@@ -146,5 +147,5 @@ declare type MediaProcessorConfig = MediaProcessorBaseConfig & BackgroundOptions
  */
 export declare function createVonageMediaProcessor(config: MediaProcessorConfig): Promise<VonageMediaProcessor>;
 export type { EventDataMap, WarnData, ErrorData, EventMetaData, DropInfo, } from "@vonage/media-processor";
-export type { MediaProcessorBaseConfig, BackgroundBlurConfig, VirtualBackgroundConfig, VideoBackgroundConfig, AssetBackgroundConfig, SilhouetteBlurConfig, MediaProcessorConfig, BackgroundOptions, MediapipeConfig, MediaPipeResults, MediaPipeModelType, MediaPipeResultsListener, FaceDetectionResults, FaceDetectionOptions, FaceMeshResults, FaceMeshOptions, HandsResults, HandsOptions, HolisticResults, HolisticOptions, ObjectronResults, ObjectronOptions, SelfieSegmentationOptions, SelfieSegmentationResults, PoseResults, PoseOptions, MediaPipeModelConfig, };
-export { VonageMediaProcessor, BlurRadius, isSupported, MediapipeHelper, getVonageSelfieSegmentation, getVonageFaceDetection, getVonageFaceMash, getVonageHands, getVonageHolistic, getVonageObjectron, getVonagePose, WarningType, PipelineInfoData, ErrorFunction, };
+export type { MediaProcessorBaseConfig, BackgroundBlurConfig, VirtualBackgroundConfig, VideoBackgroundConfig, AssetBackgroundConfig, SilhouetteBlurConfig, MediaProcessorConfig, BackgroundOptions, MediapipeConfig, MediaPipeResults, MediaPipeModelType, MediaPipeResultsListener, FaceDetectionResults, FaceDetectionOptions, FaceMeshResults, FaceMeshOptions, HandsResults, HandsOptions, HolisticResults, HolisticOptions, ObjectronResults, ObjectronOptions, SelfieSegmentationOptions, SelfieSegmentationResults, PoseResults, PoseOptions, MediaPipeModelConfig, SupportedBrowserFeatures, FeatureSupport, };
+export { VonageMediaProcessor, BlurRadius, isSupported, getSupportedBrowserFeatures, MediapipeHelper, getVonageSelfieSegmentation, getVonageFaceDetection, getVonageFaceMash, getVonageHands, getVonageHolistic, getVonageObjectron, getVonagePose, WarningType, PipelineInfoData, ErrorFunction, BackgroundTransformer, };

package/dist/types/src/types.d.ts

@@ -157,3 +157,37 @@ export declare type TextureSource = string | number[] | ArrayBufferView | TexIma
 export declare type UniformDataMap = {
     [key: string]: number | number[] | WebGLTexture;
 };
+/**
+ * Feature support detail
+ */
+export interface FeatureSupport {
+    /**
+     * Is the feature supported
+     */
+    supported: boolean;
+    /**
+     * Readable message explaining the feature is not supported
+     */
+    message?: string;
+}
+/**
+ * Features supported by the browser
+ */
+export interface SupportedBrowserFeatures {
+    /**
+     * Web assembly support, required to use ml-transformer
+     */
+    wasm: FeatureSupport;
+    /**
+     * Simd support, required to use ml-transformer
+     */
+    simd: FeatureSupport;
+    /**
+     * Insertable stream support, required to use ml-transformer
+     */
+    insertableStreams: FeatureSupport;
+    /**
+     * GPU processing support, optional
+     */
+    gpu: FeatureSupport;
+}

package/dist/types/src/utils/support.d.ts

@@ -1,6 +1,12 @@
+import { SupportedBrowserFeatures } from "../types";
 /**
  * Check if the current browser is officially supported by the library.
- * **If this function is rejected the library might be able to run but the performance is unknown**
- * @returns
+ *
+ * @returns The promise will resolve or reject depending whether the browser is supported or not.
  */
-export declare function isSupported(): Promise<void>;
+export declare function isSupported(wasmAssetUriPath?: string, tfliteAssetUriPath?: string): Promise<void>;
+/**
+ * Detect which features is available in the browser.
+ * @returns Supported features by the browser
+ */
+export declare function getSupportedBrowserFeatures(wasmAssetUriPath?: string, tfliteAssetUriPath?: string): Promise<SupportedBrowserFeatures>;

package/dist/types/src/wasm/selfie-segmentation/loader.d.ts

@@ -11,6 +11,7 @@ export interface TFLite extends EmscriptenModule {
     _getOutputChannelCount(): number;
     _loadModel(bufferSize: number): number;
     _runInference(): number;
+    _isGPUEnabled(): boolean;
 }
 export declare class VonageTFLiteInfo {
     selectedTFLite: TFLite;

package/dist/types/src/wasm/selfie-segmentation/wrapper.d.ts

@@ -7,9 +7,11 @@ export declare class SelfieSegmentation {
     private infos?;
     private mask?;
     init(wasmAssetUriPath?: string, tfliteAssetUriPath?: string): Promise<void>;
+    initWasm(wasmAssetUriPath?: string, tfliteAssetUriPath?: string): Promise<void>;
     getOutputDimensions(): {
         width: number;
         height: number;
     };
     process(input: ImageBitmap): Promise<ImageBitmap | void>;
+    isGpuSupported(): boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vonage/ml-transformers",
-    "version": "4.0.1",
+    "version": "4.2.0",
     "author": "Guy Mininberg <guy.mininberg@vonage.com>",
     "contributors": [
         "Guy Mininberg <guy.mininberg@vonage.com>",
@@ -23,8 +23,9 @@
         "nexmo"
     ],
     "scripts": {
-        "build": "npm-run-all build:js doc",
+        "build": "npm-run-all build:js build:static doc",
         "build:js": "tsc && vite build && tsc --declaration --emitDeclarationOnly --outDir dist/types",
+        "build:static": "node ./scripts/build-static.js && minify ./dist/ml-transformers.static.js > ./dist/ml-transformers.min.js ",
         "doc": "typedoc --excludePrivate --excludeProtected --disableSources --out dist/docs lib/main.ts",
         "dev": "vite",
         "prettier": "prettier --write ./lib/src/**/*.ts",
@@ -64,6 +65,7 @@
     },
     "devDependencies": {
         "@tsconfig/node12": "^1.0.1",
+        "minify": "^9.1.0",
         "npm-run-all": "^4.1.5",
         "typedoc": "^0.22.12",
         "typescript": "^4.5.4",