@scalable-vector-audio/sva-wasm 0.9.5 → 0.9.6

package/package.json

@@ -2,7 +2,7 @@
   "name": "@scalable-vector-audio/sva-wasm",
   "type": "module",
   "description": "JS bindings: a composition a page fills node by node, rendered in the browser",
-  "version": "0.9.5",
+  "version": "0.9.6",
   "license": "MIT",
   "repository": {
     "type": "git",

package/sva_wasm.d.ts

@@ -1,6 +1,74 @@
 /* tslint:disable */
 /* eslint-disable */
 
+/** What one call did so far, or every call since `subscribe`. */
+export interface EngineWork {
+    /** Samples of the target delivered. */
+    samples: number;
+    /** Samples computed meanwhile, summed over every value: 0 when all was read back. */
+    computed_samples: number;
+    /**
+     * Lookups by what each came to, the counts `Rendering.stats()` ends at. Cached: `hit`
+     * (`from_memory` + `from_store`) and `reused`. Uncached: `miss`, and `prefix` (found only in
+     * part). `new`: misses kept for the next call. A count may fall as a lookup settles.
+     */
+    lookups: {
+        hit: number; from_memory: number; from_store: number;
+        prefix: number; miss: number; new: number; reused: number;
+    };
+    /** Memory's disk traffic meanwhile, whichever call asked: `Rendering.stats().tier`. */
+    tier: {
+        disk_lookups: number; disk_reads: number; disk_read_bytes: number; promotions: number;
+        writebacks: number; hits: number; evictions: number;
+        probation_evictions: number; protected_evictions: number;
+    };
+}
+
+/** One call: a render, a stream from its open on, one stream edit, or a persist. */
+export interface EngineCall extends EngineWork {
+    /** Counted from 1 over the composition, never given twice. */
+    id: number;
+    kind: "render" | "stream" | "edit" | "persist";
+    /** As the page wrote it; a persist's is empty. */
+    target: string;
+    /**
+     * Samples are delivered in `delivering` alone. `done`, `failed` and `abandoned` end the call:
+     * its last report.
+     */
+    phase: "parsing" | "typing" | "looking_up" | "planning" | "fetching" | "delivering"
+    | "finishing" | "storing" | "done" | "failed" | "abandoned";
+    /**
+     * What `samples` counts up to. null until the range is decided (before `delivering`), and
+     * for a stream whose end is open.
+     */
+    total_samples: number | null;
+}
+
+/**
+ * One report of `Composition.subscribe`. A call reports when it begins, at each new phase, per
+ * fetch from the store while `fetching`, while `delivering` at block boundaries no more than ten
+ * times per second of samples delivered, and when it ends. The callback runs inside the call, on the thread
+ * that made it, never on a render thread: a worker forwards each report with `postMessage`. A
+ * page on the engine's own thread hears every report as it is made, but paints nothing until the
+ * call yields to the event loop, which a render does between blocks only when given a `signal`
+ * or reading a store. What the callback throws is logged, and stops nothing.
+ */
+export interface EngineStats {
+    /**
+     * "working" while a render, a stream's open, an edit or a persist is in flight. A stream's
+     * reads never count: what they report says "idle" unless such a call is in flight beside it.
+     */
+    state: "working" | "idle";
+    /** How many such calls are in flight. */
+    working: number;
+    /** The call this report is about; null in the one report `subscribe` answers with. */
+    call: EngineCall | null;
+    /** Every call's work since `subscribe`. */
+    totals: EngineWork;
+}
+
+
+
 export class Composition {
     free(): void;
     [Symbol.dispose](): void;
@@ -33,6 +101,12 @@ export class Composition {
      * `threads` (as `open` takes it).
      */
     stream(target: string, block: number, options: any): Promise<Stream>;
+    /**
+     * `callback`, in place of the last one, hears an `EngineStats` at once, then from every
+     * render, stream, edit and persist of this composition while it works and when it ends.
+     */
+    subscribe(callback: (stats: EngineStats) => void): void;
+    unsubscribe(): void;
     readonly cache_bytes: number;
     readonly cache_entries: number;
     readonly cache_evictions: number;
@@ -164,6 +238,8 @@ export interface InitOutput {
     readonly composition_store_bytes: (a: number) => [number, number];
     readonly composition_store_max_bytes: (a: number) => [number, number];
     readonly composition_stream: (a: number, b: number, c: number, d: number, e: any) => any;
+    readonly composition_subscribe: (a: number, b: any) => void;
+    readonly composition_unsubscribe: (a: number) => void;
     readonly initThreadPool: (a: number) => any;
     readonly rendering_channels: (a: number) => number;
     readonly rendering_duration_secs: (a: number) => number;

package/sva_wasm.js

@@ -157,6 +157,17 @@ export class Composition {
         const ret = wasm.composition_stream(this.__wbg_ptr, ptr0, len0, block, options);
         return ret;
     }
+    /**
+     * `callback`, in place of the last one, hears an `EngineStats` at once, then from every
+     * render, stream, edit and persist of this composition while it works and when it ends.
+     * @param {(stats: EngineStats) => void} callback
+     */
+    subscribe(callback) {
+        wasm.composition_subscribe(this.__wbg_ptr, callback);
+    }
+    unsubscribe() {
+        wasm.composition_unsubscribe(this.__wbg_ptr);
+    }
 }
 if (Symbol.dispose) Composition.prototype[Symbol.dispose] = Composition.prototype.free;
 
@@ -560,7 +571,7 @@ function __wbg_get_imports(memory) {
         __wbg__wbg_cb_unref_997e73d32238e655: function(arg0) {
             arg0._wbg_cb_unref();
         },
-        __wbg_arrayBuffer_840f6cee53783ab5: function(arg0) {
+        __wbg_arrayBuffer_ca727a2a5437ebb5: function(arg0) {
             const ret = arg0.arrayBuffer();
             return ret;
         },
@@ -580,18 +591,18 @@ function __wbg_get_imports(memory) {
             const ret = arg0.call(arg1, arg2);
             return ret;
         }, arguments); },
-        __wbg_close_079e5dfd4d0b7025: function(arg0) {
+        __wbg_close_708ebf920f3ea7ca: function(arg0) {
             const ret = arg0.close();
             return ret;
         },
-        __wbg_close_1fc7943048263f1c: function(arg0) {
+        __wbg_close_ed5e9b27b36b4a58: function(arg0) {
             arg0.close();
         },
         __wbg_composition_new: function(arg0) {
             const ret = Composition.__wrap(arg0);
             return ret;
         },
-        __wbg_createWritable_eb49ae1a38a27748: function(arg0) {
+        __wbg_createWritable_bd0c7c16a78b0321: function(arg0) {
             const ret = arg0.createWritable();
             return ret;
         },
@@ -607,15 +618,15 @@ function __wbg_get_imports(memory) {
             const ret = Array.from(arg0);
             return ret;
         },
-        __wbg_getDirectoryHandle_87163dd5ce083804: function(arg0, arg1, arg2, arg3) {
+        __wbg_getDirectoryHandle_4b86f3073ed463f1: function(arg0, arg1, arg2, arg3) {
             const ret = arg0.getDirectoryHandle(getStringFromWasm0(arg1, arg2), arg3);
             return ret;
         },
-        __wbg_getFileHandle_e3bc25991894dffd: function(arg0, arg1, arg2, arg3) {
+        __wbg_getFileHandle_c30cbc45acfedaa7: function(arg0, arg1, arg2, arg3) {
             const ret = arg0.getFileHandle(getStringFromWasm0(arg1, arg2), arg3);
             return ret;
         },
-        __wbg_getFile_1d1e8ae322a0bcc1: function(arg0) {
+        __wbg_getFile_941a29388bde207f: function(arg0) {
             const ret = arg0.getFile();
             return ret;
         },
@@ -659,7 +670,7 @@ function __wbg_get_imports(memory) {
             const ret = Array.isArray(arg0);
             return ret;
         },
-        __wbg_keys_86ce54571fde5fa1: function(arg0) {
+        __wbg_keys_89f211fd7be63aec: function(arg0) {
             const ret = arg0.keys();
             return ret;
         },
@@ -675,11 +686,11 @@ function __wbg_get_imports(memory) {
             const ret = arg0.length;
             return ret;
         },
-        __wbg_move_d371e6c98198a836: function(arg0, arg1, arg2, arg3) {
+        __wbg_move_c9336b1e6b1b4197: function(arg0, arg1, arg2, arg3) {
             const ret = arg0.move(arg1, getStringFromWasm0(arg2, arg3));
             return ret;
         },
-        __wbg_name_3949f1232649f0db: function(arg0, arg1) {
+        __wbg_name_58b92bcf5b65574b: function(arg0, arg1) {
             const ret = arg1.name;
             const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
             const len1 = WASM_VECTOR_LEN;
@@ -690,12 +701,16 @@ function __wbg_get_imports(memory) {
             const ret = new Int32Array(arg0);
             return ret;
         },
+        __wbg_new_19a2e1ad79ba0ef2: function() {
+            const ret = new MessageChannel();
+            return ret;
+        },
         __wbg_new_1da3429bc3c4541c: function(arg0) {
             const ret = new Uint8Array(arg0);
             return ret;
         },
-        __wbg_new_48023d79e7a2e0f4: function() {
-            const ret = new MessageChannel();
+        __wbg_new_44be9c56c1230128: function(arg0, arg1) {
+            const ret = new Error(getStringFromWasm0(arg0, arg1));
             return ret;
         },
         __wbg_new_8f72ed7c652bf5a2: function(arg0, arg1) {
@@ -720,10 +735,6 @@ function __wbg_get_imports(memory) {
             const ret = new Object();
             return ret;
         },
-        __wbg_new_c38fc43a35a11a41: function(arg0, arg1) {
-            const ret = new Error(getStringFromWasm0(arg0, arg1));
-            return ret;
-        },
         __wbg_new_from_slice_4ee02165f9de919e: function(arg0, arg1) {
             const ret = new Uint8Array(getArrayU8FromWasm0(arg0, arg1));
             return ret;
@@ -750,7 +761,7 @@ function __wbg_get_imports(memory) {
             const ret = new Worker(getStringFromWasm0(arg0, arg1));
             return ret;
         },
-        __wbg_next_ab692ce2d3f8c5b8: function(arg0) {
+        __wbg_next_5a7cb7819ee1bc88: function(arg0) {
             const ret = arg0.next();
             return ret;
         },
@@ -758,28 +769,28 @@ function __wbg_get_imports(memory) {
             const ret = Array.of(arg0, arg1, arg2);
             return ret;
         },
-        __wbg_parse_23aa75de5140423d: function() { return handleError(function (arg0, arg1) {
+        __wbg_parse_3c17fe4e94eb39f5: function() { return handleError(function (arg0, arg1) {
             const ret = JSON.parse(getStringFromWasm0(arg0, arg1));
             return ret;
         }, arguments); },
-        __wbg_port1_24596868d987fde6: function(arg0) {
+        __wbg_port1_eac34109aa737b69: function(arg0) {
             const ret = arg0.port1;
             return ret;
         },
-        __wbg_port2_4164d04bdc804b58: function(arg0) {
+        __wbg_port2_7e9c530d0b66d38b: function(arg0) {
             const ret = arg0.port2;
             return ret;
         },
         __wbg_postMessage_8105a302ed002474: function() { return handleError(function (arg0, arg1) {
             arg0.postMessage(arg1);
         }, arguments); },
-        __wbg_postMessage_993ae22fc5c9c66c: function(arg0, arg1) {
+        __wbg_postMessage_f09ef855b53cb647: function(arg0, arg1) {
             arg0.postMessage(arg1);
         },
         __wbg_prototypesetcall_ae9f5e7459250748: function(arg0, arg1, arg2) {
             Uint8Array.prototype.set.call(getArrayU8FromWasm0(arg0, arg1), arg2);
         },
-        __wbg_query_7a0b50aa8d084f73: function(arg0) {
+        __wbg_query_f5697193f450c601: function(arg0) {
             const ret = arg0.query();
             return ret;
         },
@@ -794,19 +805,19 @@ function __wbg_get_imports(memory) {
             const ret = Math.random();
             return ret;
         },
-        __wbg_removeEntry_1ebb67c168ea09c9: function(arg0, arg1, arg2, arg3) {
-            const ret = arg0.removeEntry(getStringFromWasm0(arg1, arg2), arg3);
+        __wbg_removeEntry_1a97420c5a9f6f99: function(arg0, arg1, arg2) {
+            const ret = arg0.removeEntry(getStringFromWasm0(arg1, arg2));
             return ret;
         },
-        __wbg_removeEntry_edc21914f22bae4c: function(arg0, arg1, arg2) {
-            const ret = arg0.removeEntry(getStringFromWasm0(arg1, arg2));
+        __wbg_removeEntry_de675a309ac183da: function(arg0, arg1, arg2, arg3) {
+            const ret = arg0.removeEntry(getStringFromWasm0(arg1, arg2), arg3);
             return ret;
         },
         __wbg_rendering_new: function(arg0) {
             const ret = Rendering.__wrap(arg0);
             return ret;
         },
-        __wbg_request_857918013adf1ed3: function(arg0, arg1, arg2, arg3) {
+        __wbg_request_210c800f06d0c757: function(arg0, arg1, arg2, arg3) {
             const ret = arg0.request(getStringFromWasm0(arg1, arg2), arg3);
             return ret;
         },
@@ -821,23 +832,23 @@ function __wbg_get_imports(memory) {
         __wbg_set_c41f8dbc07a2190f: function(arg0, arg1, arg2) {
             arg0.set(getArrayF32FromWasm0(arg1, arg2));
         },
-        __wbg_set_name_665f9bc15f60f94b: function(arg0, arg1, arg2) {
+        __wbg_set_name_bdf1245644137892: function(arg0, arg1, arg2) {
             arg0.name = getStringFromWasm0(arg1, arg2);
         },
         __wbg_set_onmessage_2244c2525c4e0c38: function(arg0, arg1) {
             arg0.onmessage = arg1;
         },
-        __wbg_set_onmessage_81be37e59419a29d: function(arg0, arg1) {
+        __wbg_set_onmessage_a5511a9bda9fcffd: function(arg0, arg1) {
             arg0.onmessage = arg1;
         },
-        __wbg_set_refusal_dd4086d9e81ea709: function(arg0, arg1) {
+        __wbg_set_refusal_a6fbdf2910883e33: function(arg0, arg1) {
             arg0.refusal = arg1;
         },
-        __wbg_size_10991f391b641021: function(arg0) {
+        __wbg_size_9292c1f221818f87: function(arg0) {
             const ret = arg0.size;
             return ret;
         },
-        __wbg_slice_3e6a4fe3e9c0b057: function(arg0, arg1, arg2) {
+        __wbg_slice_6cf55ffb2d36810c: function(arg0, arg1, arg2) {
             const ret = arg0.slice(arg1, arg2);
             return ret;
         },
@@ -897,10 +908,10 @@ function __wbg_get_imports(memory) {
             const ret = Atomics.waitAsync;
             return ret;
         },
-        __wbg_warn_53de75b39da09994: function(arg0, arg1) {
+        __wbg_warn_1a71557ff61ac2e7: function(arg0, arg1) {
             console.warn(getStringFromWasm0(arg0, arg1));
         },
-        __wbg_write_fd00fab297d6bcb5: function(arg0, arg1) {
+        __wbg_write_7491dbbb4466b287: function(arg0, arg1) {
             const ret = arg0.write(arg1);
             return ret;
         },
@@ -910,12 +921,12 @@ function __wbg_get_imports(memory) {
             return ret;
         },
         __wbindgen_generic_0000000000000002: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 705, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
+            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 709, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
             const ret = makeMutClosure(arg0, arg1, wasm_bindgen_d3a5247b0aa3f0ac___convert__closures_____invoke___wasm_bindgen_d3a5247b0aa3f0ac___JsValue__core_ea519e494776717c___result__Result_____wasm_bindgen_d3a5247b0aa3f0ac___JsError___true_);
             return ret;
         },
         __wbindgen_generic_0000000000000003: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 707, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 711, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
             const ret = makeMutClosure(arg0, arg1, wasm_bindgen_d3a5247b0aa3f0ac___convert__closures_____invoke___js_sys_2b088e2931f41c5___futures__task__wait_async_polyfill__MessageEvent______true_);
             return ret;
         },