@zappar/zappar-cv 4.0.0-beta.3 → 4.1.0-beta.2

package/README.md

@@ -18,8 +18,8 @@ npm i @zappar/zappar-cv
 
 You can use our CDN from within your HTML:
 ```
-<script src="https://libs.zappar.com/zappar-cv/4.0.0-beta.3/zappar-cv.js"></script>
+<script src="https://libs.zappar.com/zappar-cv/4.1.0-beta.2/zappar-cv.js"></script>
 ```
 
 Or you can download and host our standalone JavaScript bundle:
-[https://libs.zappar.com/zappar-cv/4.0.0-beta.3/zappar-cv.zip](https://libs.zappar.com/zappar-cv/4.0.0-beta.3/zappar-cv.zip)
+[https://libs.zappar.com/zappar-cv/4.1.0-beta.2/zappar-cv.zip](https://libs.zappar.com/zappar-cv/4.1.0-beta.2/zappar-cv.zip)

package/lib/file-locator.d.ts

@@ -0,0 +1,13 @@
+/** Returns the URL to load an asset from, or a falsy value to use the default. */
+export declare type FileLocator = (filename: string, defaultUrl: string) => string | void | undefined;
+/**
+ * Overrides where the library loads its runtime assets from. Call before
+ * `initialize()`; pass nothing to clear.
+ *
+ * The locator runs once per asset, where `filename` is one of:
+ * `zappar-cv.wasm`, `face_tracking_model.zbin`, `face_mesh_face_model.zbin`,
+ * `face_mesh_full_head_simplified_model.zbin`.
+ */
+export declare function setFileLocator(locator?: FileLocator): void;
+/** Resolves an asset URL, routing it through the locator if one is set. */
+export declare function resolveFileUrl(filename: string, defaultUrl: URL | string): string;

package/lib/file-locator.js

@@ -0,0 +1,17 @@
+let fileLocator;
+/**
+ * Overrides where the library loads its runtime assets from. Call before
+ * `initialize()`; pass nothing to clear.
+ *
+ * The locator runs once per asset, where `filename` is one of:
+ * `zappar-cv.wasm`, `face_tracking_model.zbin`, `face_mesh_face_model.zbin`,
+ * `face_mesh_full_head_simplified_model.zbin`.
+ */
+export function setFileLocator(locator) {
+    fileLocator = locator;
+}
+/** Resolves an asset URL, routing it through the locator if one is set. */
+export function resolveFileUrl(filename, defaultUrl) {
+    const url = defaultUrl.toString();
+    return (fileLocator === null || fileLocator === void 0 ? void 0 : fileLocator(filename, url)) || url;
+}

package/lib/index.d.ts

@@ -4,4 +4,5 @@ import { Options } from "./options.js";
 export declare type Zappar = zappar & Additional;
 export declare function initialize(opts?: Options): Zappar;
 export { CameraFrameData } from './camera-frame-data.js';
+export { setFileLocator, FileLocator } from "./file-locator.js";
 export { zappar_image_tracker_t, zappar_instant_world_tracker_t, zappar_world_tracker_t, zappar_barcode_finder_t, zappar_face_tracker_t, zappar_face_landmark_t, zappar_zapcode_tracker_t, zappar_custom_anchor_t, zappar_d3_tracker_t, barcode_format_t, world_scale_mode_t, face_landmark_name_t, instant_world_tracker_transform_orientation_t, log_level_t, zappar_face_mesh_t, zappar_pipeline_t, zappar_camera_source_t, zappar_sequence_source_t, image_target_type_t, world_tracker_quality_t, camera_profile_t, transform_orientation_t, plane_orientation_t, anchor_status_t, } from "./gen/zappar.js";

package/lib/index.js

@@ -4,4 +4,5 @@ export function initialize(opts) {
     console.log(`Zappar CV v${VERSION}`);
     return nativeInitialize(opts);
 }
+export { setFileLocator } from "./file-locator.js";
 export { barcode_format_t, world_scale_mode_t, face_landmark_name_t, instant_world_tracker_transform_orientation_t, log_level_t, image_target_type_t, world_tracker_quality_t, camera_profile_t, transform_orientation_t, plane_orientation_t, anchor_status_t, } from "./gen/zappar.js";

package/lib/landmarkdatagenerate.js

@@ -9,6 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { FaceMesh } from "./facemesh.js";
 import { face_landmark_name_t } from "./gen/zappar.js";
+import { resolveFileUrl } from "./file-locator.js";
 let vertexIndexByName = new Map([
     [face_landmark_name_t.EAR_LEFT, 888],
     [face_landmark_name_t.EAR_RIGHT, 467],
@@ -27,7 +28,7 @@ let vertexIndexByName = new Map([
 export function generateDataJSON() {
     return __awaiter(this, void 0, void 0, function* () {
         let mesh = new FaceMesh();
-        let url = new URL("./face_mesh_face_model.zbin", import.meta.url);
+        let url = resolveFileUrl("face_mesh_face_model.zbin", new URL("./face_mesh_face_model.zbin", import.meta.url));
         let req = yield fetch(url.toString());
         mesh.loadFromMemory(yield req.arrayBuffer(), false, false, false, false);
         let names = new Set([face_landmark_name_t.EYE_LEFT, face_landmark_name_t.EYE_RIGHT, face_landmark_name_t.EAR_LEFT, face_landmark_name_t.EAR_RIGHT, face_landmark_name_t.NOSE_BRIDGE, face_landmark_name_t.NOSE_TIP, face_landmark_name_t.NOSE_BASE, face_landmark_name_t.LIP_TOP, face_landmark_name_t.LIP_BOTTOM, face_landmark_name_t.MOUTH_CENTER, face_landmark_name_t.CHIN, face_landmark_name_t.EYEBROW_LEFT, face_landmark_name_t.EYEBROW_RIGHT]);
@@ -58,7 +59,7 @@ function arrayAsCPPLiteral(a) {
 export function generateDataCPP() {
     return __awaiter(this, void 0, void 0, function* () {
         let mesh = new FaceMesh();
-        let url = new URL("./face_mesh_face_model.zbin", import.meta.url);
+        let url = resolveFileUrl("face_mesh_face_model.zbin", new URL("./face_mesh_face_model.zbin", import.meta.url));
         let req = yield fetch(url.toString());
         mesh.loadFromMemory(yield req.arrayBuffer(), false, false, false, false);
         let names = [face_landmark_name_t.EYE_LEFT, face_landmark_name_t.EYE_RIGHT, face_landmark_name_t.EAR_LEFT, face_landmark_name_t.EAR_RIGHT, face_landmark_name_t.NOSE_BRIDGE, face_landmark_name_t.NOSE_TIP, face_landmark_name_t.NOSE_BASE, face_landmark_name_t.LIP_TOP, face_landmark_name_t.LIP_BOTTOM, face_landmark_name_t.MOUTH_CENTER, face_landmark_name_t.CHIN, face_landmark_name_t.EYEBROW_LEFT, face_landmark_name_t.EYEBROW_RIGHT];

package/lib/native.js

@@ -35,6 +35,7 @@ import { BridgedCameraSource } from "./bridged-camera-source.js";
 import { WebXRCameraSource } from "./webxr-camera-source.js";
 import { WebXRWorldTracker } from "./webxr-world-tracker.js";
 import { profile } from "./profile.js";
+import { resolveFileUrl } from "./file-locator.js";
 let client;
 const pipelineByWorldTracker = new Map();
 const d3TrackerSizeById = new Map();
@@ -861,7 +862,7 @@ export function initialize(opts) {
                 zcwarn("attempting to call face_mesh_load_default on a destroyed zappar_face_mesh_t");
                 return;
             }
-            let url = new URL("./face_mesh_face_model.zbin", import.meta.url);
+            let url = resolveFileUrl("face_mesh_face_model.zbin", new URL("./face_mesh_face_model.zbin", import.meta.url));
             let req = yield fetch(url.toString());
             obj.loadFromMemory(yield req.arrayBuffer(), false, false, false, false);
         }), face_mesh_load_default_face: (m, fillMouth, fillEyeL, fillEyeR) => __awaiter(this, void 0, void 0, function* () {
@@ -870,7 +871,7 @@ export function initialize(opts) {
                 zcwarn("attempting to call face_mesh_load_default_face on a destroyed zappar_face_mesh_t");
                 return;
             }
-            let url = new URL("./face_mesh_face_model.zbin", import.meta.url);
+            let url = resolveFileUrl("face_mesh_face_model.zbin", new URL("./face_mesh_face_model.zbin", import.meta.url));
             let req = yield fetch(url.toString());
             obj.loadFromMemory(yield req.arrayBuffer(), fillMouth, fillEyeL, fillEyeR, false);
         }), face_mesh_load_default_full_head_simplified: (m, fillMouth, fillEyeL, fillEyeR, fillNeck) => __awaiter(this, void 0, void 0, function* () {
@@ -879,7 +880,7 @@ export function initialize(opts) {
                 zcwarn("attempting to call face_mesh_load_default_full_head_simplified on a destroyed zappar_face_mesh_t");
                 return;
             }
-            let url = new URL("./face_mesh_full_head_simplified_model.zbin", import.meta.url);
+            let url = resolveFileUrl("face_mesh_full_head_simplified_model.zbin", new URL("./face_mesh_full_head_simplified_model.zbin", import.meta.url));
             let req = yield fetch(url.toString());
             obj.loadFromMemory(yield req.arrayBuffer(), fillMouth, fillEyeL, fillEyeR, fillNeck);
         }), face_mesh_loaded_version: (m) => {
@@ -1014,7 +1015,7 @@ export function initialize(opts) {
 }
 function loadDefaultFaceModel(o) {
     return __awaiter(this, void 0, void 0, function* () {
-        let url = new URL("./face_tracking_model.zbin", import.meta.url);
+        let url = resolveFileUrl("face_tracking_model.zbin", new URL("./face_tracking_model.zbin", import.meta.url));
         let data = yield fetch(url.toString());
         let ab = yield data.arrayBuffer();
         client === null || client === void 0 ? void 0 : client.face_tracker_model_load_from_memory(o, ab);

package/lib/src/file-locator.d.ts

@@ -0,0 +1,13 @@
+/** Returns the URL to load an asset from, or a falsy value to use the default. */
+export declare type FileLocator = (filename: string, defaultUrl: string) => string | void | undefined;
+/**
+ * Overrides where the library loads its runtime assets from. Call before
+ * `initialize()`; pass nothing to clear.
+ *
+ * The locator runs once per asset, where `filename` is one of:
+ * `zappar-cv.wasm`, `face_tracking_model.zbin`, `face_mesh_face_model.zbin`,
+ * `face_mesh_full_head_simplified_model.zbin`.
+ */
+export declare function setFileLocator(locator?: FileLocator): void;
+/** Resolves an asset URL, routing it through the locator if one is set. */
+export declare function resolveFileUrl(filename: string, defaultUrl: URL | string): string;

package/lib/src/index.d.ts

@@ -4,4 +4,5 @@ import { Options } from "./options.js";
 export declare type Zappar = zappar & Additional;
 export declare function initialize(opts?: Options): Zappar;
 export { CameraFrameData } from './camera-frame-data.js';
+export { setFileLocator, FileLocator } from "./file-locator.js";
 export { zappar_image_tracker_t, zappar_instant_world_tracker_t, zappar_world_tracker_t, zappar_barcode_finder_t, zappar_face_tracker_t, zappar_face_landmark_t, zappar_zapcode_tracker_t, zappar_custom_anchor_t, zappar_d3_tracker_t, barcode_format_t, world_scale_mode_t, face_landmark_name_t, instant_world_tracker_transform_orientation_t, log_level_t, zappar_face_mesh_t, zappar_pipeline_t, zappar_camera_source_t, zappar_sequence_source_t, image_target_type_t, world_tracker_quality_t, camera_profile_t, transform_orientation_t, plane_orientation_t, anchor_status_t, } from "./gen/zappar.js";

package/lib/src/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "4.0.0-beta.3";
+export declare const VERSION = "4.1.0-beta.2";

package/lib/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "4.0.0-beta.3";
+export declare const VERSION = "4.1.0-beta.2";

package/lib/version.js

@@ -1 +1 @@
-export const VERSION = "4.0.0-beta.3";
+export const VERSION = "4.1.0-beta.2";

package/lib/worker-client.js

@@ -9,22 +9,41 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 var _a;
 import { MsgManager } from "./messages.js";
+import { resolveFileUrl } from "./file-locator.js";
 export let messageManager = new MsgManager();
 const params = new URLSearchParams(window.location.search);
 const shouldRecordData = parseInt((_a = params.get('_zrecorddata')) !== null && _a !== void 0 ? _a : '0');
-const wasmModule = (() => __awaiter(void 0, void 0, void 0, function* () {
-    const response = yield fetch(new URL("./zappar-cv.wasm", import.meta.url).toString());
-    const module = yield WebAssembly.compileStreaming(response);
-    return module;
-}))();
+function wasmUrl() {
+    return resolveFileUrl("zappar-cv.wasm", new URL("./zappar-cv.wasm", import.meta.url));
+}
+function compileWasm(url) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (typeof WebAssembly.compileStreaming === "function") {
+            try {
+                return yield WebAssembly.compileStreaming(fetch(url));
+            }
+            catch (_a) {
+                // Fall back to a buffered compile if the server sends a non-wasm MIME type.
+            }
+        }
+        const response = yield fetch(url);
+        return WebAssembly.compile(yield response.arrayBuffer());
+    });
+}
+let wasmModulePromise;
+function getWasmModule() {
+    if (!wasmModulePromise)
+        wasmModulePromise = compileWasm(wasmUrl());
+    return wasmModulePromise;
+}
 export function launchWorker(worker) {
     return __awaiter(this, void 0, void 0, function* () {
         if (!worker)
             worker = new Worker(new URL("./worker", import.meta.url), { type: 'module' });
         worker.postMessage({
             t: "wasm",
-            url: new URL("./zappar-cv.wasm", import.meta.url).toString(),
-            module: yield wasmModule,
+            url: wasmUrl(),
+            module: yield getWasmModule(),
             shouldRecordData
         });
         yield waitForLoad(worker);
@@ -48,8 +67,8 @@ export function launchCeresWorkers(port0, port1, worker0, worker1) {
                 worker0 = new Worker(new URL("./ceres-worker", import.meta.url), { type: 'module' });
             worker0.postMessage({
                 t: "wasm",
-                url: new URL("./zappar-cv.wasm", import.meta.url).toString(),
-                module: yield wasmModule,
+                url: wasmUrl(),
+                module: yield getWasmModule(),
                 port: port0,
                 instance: 0,
             }, [port0]);
@@ -59,8 +78,8 @@ export function launchCeresWorkers(port0, port1, worker0, worker1) {
                 worker1 = new Worker(new URL("./ceres-worker", import.meta.url), { type: 'module' });
             worker1.postMessage({
                 t: "wasm",
-                url: new URL("./zappar-cv.wasm", import.meta.url).toString(),
-                module: yield wasmModule,
+                url: wasmUrl(),
+                module: yield getWasmModule(),
                 port: port1,
                 instance: 1,
             }, [port1]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zappar/zappar-cv",
-  "version": "4.0.0-beta.3",
+  "version": "4.1.0-beta.2",
   "description": "Zappar's core computer vision library, supporting image, face and world tracking.",
   "type": "module",
   "main": "lib/index.js",