@grame/faustwasm 0.8.2 → 0.9.0

package/assets/standalone/index-pwa.js

@@ -117,7 +117,7 @@ async function activateMIDISensors() {
     }
 
     // Initialize the MIDI setup
-    if (!midiHandlersBound && FAUST_DSP_VOICES > 0) {
+    if (!midiHandlersBound) {
         startMIDI();
         midiHandlersBound = true;
     }

package/assets/standalone/service-worker.js

@@ -5,8 +5,15 @@ const FAUST_DSP_VOICES = 0;
 // Set to true if the DSP has an effect
 const FAUST_DSP_HAS_EFFECT = false;
 
-const CACHE_NAME = "FAUST_DSP_NAME-static"; // Cache name without versioning
+const CACHE_NAME = "FAUST_DSP_NAME_VERSION_DATE"; // Cache name with versioning
 
+/**
+ * List of essential resources required for the **Mono DSP** version of the application.
+ * 
+ * - These files are cached to enable offline functionality and improve loading speed.
+ * - Includes the main HTML, JavaScript, and CSS files required for the app.
+ * - Contains Faust-related files needed for DSP processing.
+ */
 const MONO_RESOURCES = [
     "./index.html",
     "./index.js",
@@ -18,11 +25,23 @@ const MONO_RESOURCES = [
     "./dsp-meta.json"
 ];
 
+/**
+ * List of resources for the **Polyphonic DSP** version of the application.
+ * 
+ * - Extends the mono resource list by adding a **mixer module**.
+ * - The mixer module is required to handle multiple simultaneous voices used in a polyphonic instrument.
+ */
 const POLY_RESOURCES = [
     ...MONO_RESOURCES,
     "./mixer-module.wasm",
 ];
 
+/**
+ * List of resources for the **Polyphonic DSP with Effects** version.
+ * 
+ * - Extends the polyphonic resource list by adding an **effect module**.
+ * - The effect module allows applying audio effects to the polyphonic instrument.
+ */
 const POLY_EFFECT_RESOURCES = [
     ...POLY_RESOURCES,
     "./effect-module.wasm",
@@ -33,13 +52,16 @@ const POLY_EFFECT_RESOURCES = [
 const serviceWorkerGlobalScope = self;
 
 /**
- * Install the service worker and cache the resources
+ * Install the service worker, cache essential resources, and prepare for immediate activation.
+ *
+ * - Opens the cache and stores required assets based on the app's configuration.
+ * - Ensures resources are preloaded for offline access.
  */
 serviceWorkerGlobalScope.addEventListener("install", (event) => {
     console.log("Service worker installed");
     event.waitUntil((async () => {
         const cache = await caches.open(CACHE_NAME);
-        const resources = (FAUST_DSP_VOICES && FAUST_DSP_HAS_EFFECT) ? POLY_EFFECT_RESOURCES : FAUST_DSP_VOICES ? POLY_RESOURCES : MONO_RESOURCES;
+        const resources = (FAUST_DSP_VOICES && FAUST_DSP_HAS_EFFECT) ? POLY_EFFECT_RESOURCES : (FAUST_DSP_VOICES ? POLY_RESOURCES : MONO_RESOURCES);
         try {
             return cache.addAll(resources);
         } catch (error) {
@@ -48,6 +70,16 @@ serviceWorkerGlobalScope.addEventListener("install", (event) => {
     })());
 });
 
+/**
+ * Handles the activation of the Service Worker.
+ * 
+ * - Claims control over all clients immediately, bypassing the default behavior that 
+ *   requires a page reload before the new service worker takes effect.
+ * - Once claimed, it finds all active window clients and reloads them to ensure they are
+ *   controlled by the latest version of the service worker.
+ * - This approach ensures that updates to the service worker take effect immediately
+ *   across all open pages, preventing potential inconsistencies.
+ */
 serviceWorkerGlobalScope.addEventListener("activate", (event) => {
     console.log("Service worker activated");
     event.waitUntil(
@@ -61,7 +93,20 @@ serviceWorkerGlobalScope.addEventListener("activate", (event) => {
     );
 });
 
-/** @type {(response: Response) => Response} */
+/**
+ * Adjusts response headers to enforce Cross-Origin Opener Policy (COOP) and Cross-Origin Embedder Policy (COEP).
+ *
+ * - Ensures that the response is served with `Cross-Origin-Opener-Policy: same-origin`
+ *   and `Cross-Origin-Embedder-Policy: require-corp`.
+ * - Required for enabling **cross-origin isolated** environments in web applications.
+ * - Necessary for features like **SharedArrayBuffer**, WebAssembly threads, and 
+ *   high-performance APIs that require isolation.
+ * - Creates a new `Response` object with the modified headers while preserving 
+ *   the original response body and status.
+ * 
+ * @param {Response} response - The original HTTP response object.
+ * @returns {Response} A new response with updated security headers.
+ */
 const getCrossOriginIsolatedResponse = (response) => {
     // Modify headers to include COOP & COEP
     const headers = new Headers(response.headers);
@@ -79,7 +124,15 @@ const getCrossOriginIsolatedResponse = (response) => {
 };
 
 /**
- * Intercept fetch requests to enforce COOP and COEP headers.
+ * Intercepts fetch requests and enforces COOP and COEP headers for security.
+ *
+ * - Checks if the requested resource is available in the cache:
+ *   - If found, returns a cached response with `Cross-Origin-Opener-Policy` and `Cross-Origin-Embedder-Policy` headers.
+ *   - If not found, fetches the resource from the network, applies COOP/COEP headers, and caches the response (for GET requests).
+ * - Ensures cross-origin isolation, required for APIs like `SharedArrayBuffer` and WebAssembly threading.
+ * - Handles network errors gracefully by returning a 503 "Service Unavailable" response when needed.
+ * 
+ * @param {FetchEvent} event - The fetch event triggered by the browser.
  */
 serviceWorkerGlobalScope.addEventListener("fetch", (event) => {
 

package/dist/cjs/index.d.ts

@@ -618,6 +618,20 @@ export interface IFaustBaseWebAudioDsp {
 	 * @param value - the MIDI controller value (0..16383)
 	 */
 	pitchWheel(chan: number, value: number): void;
+	/**
+	 * Handle MIDI keyOn messages.
+	 * @param channel
+	 * @param pitch
+	 * @param velocity
+	 */
+	keyOn(channel: number, pitch: number, velocity: number): void;
+	/**
+	 * Handle MIDI keyOn messages.
+	 * @param channel
+	 * @param pitch
+	 * @param velocity
+	 */
+	keyOff(channel: number, pitch: number, velocity: number): void;
 	/**
 	 * Set parameter value.
 	 *
@@ -767,6 +781,24 @@ export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 		min: number;
 		max: number;
 	}[][];
+	protected fMidiKeyLabel: {
+		path: string;
+		chan: number;
+		min: number;
+		max: number;
+	}[][];
+	protected fMidiKeyOnLabel: {
+		path: string;
+		chan: number;
+		min: number;
+		max: number;
+	}[][];
+	protected fMidiKeyOffLabel: {
+		path: string;
+		chan: number;
+		min: number;
+		max: number;
+	}[][];
 	protected fPathTable: {
 		[address: string]: number;
 	};
@@ -826,6 +858,8 @@ export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	getNumOutputs(): number;
 	midiMessage(data: number[] | Uint8Array): void;
 	ctrlChange(channel: number, ctrl: number, value: number): void;
+	keyOn(channel: number, pitch: number, velocity: number): void;
+	keyOff(channel: number, pitch: number, velocity: number): void;
 	pitchWheel(channel: number, wheel: number): void;
 	setParamValue(path: string, value: number): void;
 	getParamValue(path: string): number;
@@ -1180,6 +1214,8 @@ export declare class FaustOfflineProcessor<Poly extends boolean = false> {
 	midiMessage(data: number[] | Uint8Array): void;
 	ctrlChange(chan: number, ctrl: number, value: number): void;
 	pitchWheel(chan: number, value: number): void;
+	keyOn(channel: number, pitch: number, velocity: number): void;
+	keyOff(channel: number, pitch: number, velocity: number): void;
 	setParamValue(path: string, value: number): void;
 	getParamValue(path: string): number;
 	getParams(): string[];
@@ -1374,6 +1410,8 @@ export declare class FaustAudioWorkletNode<Poly extends boolean = false> extends
 	midiMessage(data: number[] | Uint8Array): void;
 	ctrlChange(channel: number, ctrl: number, value: number): void;
 	pitchWheel(channel: number, wheel: number): void;
+	keyOn(channel: number, pitch: number, velocity: number): void;
+	keyOff(channel: number, pitch: number, velocity: number): void;
 	get hasAccInput(): boolean;
 	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>, invert?: boolean): void;
 	get hasGyrInput(): boolean;
@@ -1441,6 +1479,8 @@ export declare class FaustScriptProcessorNode<Poly extends boolean = false> exte
 	midiMessage(data: number[] | Uint8Array): void;
 	ctrlChange(chan: number, ctrl: number, value: number): void;
 	pitchWheel(chan: number, value: number): void;
+	keyOn(channel: number, pitch: number, velocity: number): void;
+	keyOff(channel: number, pitch: number, velocity: number): void;
 	setParamValue(path: string, value: number): void;
 	getParamValue(path: string): number;
 	getParams(): string[];

package/dist/cjs/index.js

@@ -216,6 +216,14 @@ export default ${(_b = jsCode.match(jsCodeHead)) == null ? void 0 : _b[1]};
             this.pitchWheel(msg.data[0], msg.data[1]);
             break;
           }
+          case "keyOn": {
+            this.keyOn(msg.data[0], msg.data[1], msg.data[2]);
+            break;
+          }
+          case "keyOff": {
+            this.keyOff(msg.data[0], msg.data[1], msg.data[2]);
+            break;
+          }
           case "param": {
             this.setParamValue(msg.data.path, msg.data.value);
             break;
@@ -262,6 +270,12 @@ export default ${(_b = jsCode.match(jsCodeHead)) == null ? void 0 : _b[1]};
       pitchWheel(channel, wheel) {
         this.fDSPCode.pitchWheel(channel, wheel);
       }
+      keyOn(channel, pitch, velocity) {
+        this.fDSPCode.keyOn(channel, pitch, velocity);
+      }
+      keyOff(channel, pitch, velocity) {
+        this.fDSPCode.keyOff(channel, pitch, velocity);
+      }
       propagateAcc(accelerationIncludingGravity, invert = false) {
         this.fDSPCode.propagateAcc(accelerationIncludingGravity, invert);
       }
@@ -2142,6 +2156,10 @@ export default ${(_b = jsCode.match(jsCodeHead)) == null ? void 0 : _b[1]};
       // MIDI handling
       this.fPitchwheelLabel = [];
       this.fCtrlLabel = new Array(128).fill(null).map(() => []);
+      // array of MIDI key handlers; array index is the MIDI note number
+      this.fMidiKeyLabel = new Array(128).fill(null).map(() => []);
+      this.fMidiKeyOnLabel = new Array(128).fill(null).map(() => []);
+      this.fMidiKeyOffLabel = new Array(128).fill(null).map(() => []);
       this.fPathTable = {};
       this.fUICallback = (item) => {
         if (item.type === "hbargraph" || item.type === "vbargraph") {
@@ -2154,6 +2172,7 @@ export default ${(_b = jsCode.match(jsCodeHead)) == null ? void 0 : _b[1]};
           if (!item.meta)
             return;
           item.meta.forEach((meta) => {
+            var _a, _b, _c, _d, _e, _f;
             const { midi, acc, gyr } = meta;
             if (midi) {
               const strMidi = midi.trim();
@@ -2167,10 +2186,25 @@ export default ${(_b = jsCode.match(jsCodeHead)) == null ? void 0 : _b[1]};
               } else {
                 const matched2 = strMidi.match(/^ctrl\s(\d+)\s(\d+)/);
                 const matched1 = strMidi.match(/^ctrl\s(\d+)/);
+                const matchedKey = strMidi.match(/^key\s+(\d+)(?:\s+(\d+))?$/);
+                const matchedKeyOn = strMidi.match(/^keyon\s+(\d+)(?:\s+(\d+))?$/);
+                const matchedKeyOff = strMidi.match(/^keyoff\s+(\d+)(?:\s+(\d+))?$/);
                 if (matched2) {
                   this.fCtrlLabel[parseInt(matched2[1])].push({ path: item.address, chan: parseInt(matched2[2]), min: item.min, max: item.max });
                 } else if (matched1) {
                   this.fCtrlLabel[parseInt(matched1[1])].push({ path: item.address, chan: 0, min: item.min, max: item.max });
+                } else if (matchedKey) {
+                  const note = parseInt(matchedKey[1]);
+                  const channel = matchedKey[2] ? parseInt(matchedKey[2]) : 0;
+                  this.fMidiKeyLabel[note].push({ path: item.address, chan: channel, min: (_a = item.min) != null ? _a : 0, max: (_b = item.max) != null ? _b : 1 });
+                } else if (matchedKeyOn) {
+                  const note = parseInt(matchedKeyOn[1]);
+                  const channel = matchedKeyOn[2] ? parseInt(matchedKeyOn[2]) : 0;
+                  this.fMidiKeyOnLabel[note].push({ path: item.address, chan: channel, min: (_c = item.min) != null ? _c : 0, max: (_d = item.max) != null ? _d : 1 });
+                } else if (matchedKeyOff) {
+                  const note = parseInt(matchedKeyOff[1]);
+                  const channel = matchedKeyOff[2] ? parseInt(matchedKeyOff[2]) : 0;
+                  this.fMidiKeyOffLabel[note].push({ path: item.address, chan: channel, min: (_e = item.min) != null ? _e : 0, max: (_f = item.max) != null ? _f : 1 });
                 }
               }
             }
@@ -2432,6 +2466,15 @@ export default ${(_b = jsCode.match(jsCodeHead)) == null ? void 0 : _b[1]};
         return this.ctrlChange(channel, data1, data2);
       if (cmd === 14)
         return this.pitchWheel(channel, data2 * 128 + data1);
+      if (cmd === 9) {
+        if (data2 > 0)
+          return this.keyOn(channel, data1, data2);
+        else
+          return this.keyOff(channel, data1, data2);
+      }
+      if (cmd === 8) {
+        return this.keyOff(channel, data1, data2);
+      }
     }
     ctrlChange(channel, ctrl, value) {
       if (this.fPlotHandler)
@@ -2447,6 +2490,46 @@ export default ${(_b = jsCode.match(jsCodeHead)) == null ? void 0 : _b[1]};
         });
       }
     }
+    keyOn(channel, pitch, velocity) {
+      if (this.fPlotHandler)
+        this.fCachedEvents.push({ type: "keyOn", data: [channel, pitch, velocity] });
+      this.fMidiKeyOnLabel[pitch].forEach((key) => {
+        const { path, chan } = key;
+        if (chan === 0 || channel === chan - 1) {
+          this.setParamValue(path, _FaustBaseWebAudioDsp.remap(velocity, 0, 127, key.min, key.max));
+          if (this.fOutputHandler)
+            this.fOutputHandler(path, this.getParamValue(path));
+        }
+      });
+      this.fMidiKeyLabel[pitch].forEach((key) => {
+        const { path, chan } = key;
+        if (chan === 0 || channel === chan - 1) {
+          this.setParamValue(path, _FaustBaseWebAudioDsp.remap(velocity, 0, 127, key.min, key.max));
+          if (this.fOutputHandler)
+            this.fOutputHandler(path, this.getParamValue(path));
+        }
+      });
+    }
+    keyOff(channel, pitch, velocity) {
+      if (this.fPlotHandler)
+        this.fCachedEvents.push({ type: "keyOff", data: [channel, pitch, velocity] });
+      this.fMidiKeyOffLabel[pitch].forEach((key) => {
+        const { path, chan } = key;
+        if (chan === 0 || channel === chan - 1) {
+          this.setParamValue(path, _FaustBaseWebAudioDsp.remap(velocity, 0, 127, key.min, key.max));
+          if (this.fOutputHandler)
+            this.fOutputHandler(path, this.getParamValue(path));
+        }
+      });
+      this.fMidiKeyLabel[pitch].forEach((key) => {
+        const { path, chan } = key;
+        if (chan === 0 || channel === chan - 1) {
+          this.setParamValue(path, 0);
+          if (this.fOutputHandler)
+            this.fOutputHandler(path, this.getParamValue(path));
+        }
+      });
+    }
     pitchWheel(channel, wheel) {
       if (this.fPlotHandler)
         this.fCachedEvents.push({ type: "pitchWheel", data: [channel, wheel] });
@@ -3083,6 +3166,12 @@ export default ${(_b = jsCode.match(jsCodeHead)) == null ? void 0 : _b[1]};
     pitchWheel(chan, value) {
       this.fDSPCode.pitchWheel(chan, value);
     }
+    keyOn(channel, pitch, velocity) {
+      this.fDSPCode.keyOn(channel, pitch, velocity);
+    }
+    keyOff(channel, pitch, velocity) {
+      this.fDSPCode.keyOff(channel, pitch, velocity);
+    }
     setParamValue(path, value) {
       this.fDSPCode.setParamValue(path, value);
     }
@@ -4019,6 +4108,10 @@ export default ${(_b = jsCode.match(jsCodeHead)) == null ? void 0 : _b[1]};
         this.ctrlChange(channel, data1, data2);
       else if (cmd === 14)
         this.pitchWheel(channel, data2 * 128 + data1);
+      if (cmd === 8 || cmd === 9 && data2 === 0)
+        this.keyOff(channel, data1, data2);
+      else if (cmd === 9)
+        this.keyOn(channel, data1, data2);
       else
         this.port.postMessage({ type: "midi", data });
     }
@@ -4030,6 +4123,14 @@ export default ${(_b = jsCode.match(jsCodeHead)) == null ? void 0 : _b[1]};
       const e = { type: "pitchWheel", data: [channel, wheel] };
       this.port.postMessage(e);
     }
+    keyOn(channel, pitch, velocity) {
+      const e = { type: "keyOn", data: [channel, pitch, velocity] };
+      this.port.postMessage(e);
+    }
+    keyOff(channel, pitch, velocity) {
+      const e = { type: "keyOff", data: [channel, pitch, velocity] };
+      this.port.postMessage(e);
+    }
     get hasAccInput() {
       return __privateGet(this, _hasAccInput);
     }
@@ -4193,42 +4294,14 @@ export default ${(_b = jsCode.match(jsCodeHead)) == null ? void 0 : _b[1]};
     async startSensors() {
       if (this.hasAccInput) {
         if (window.DeviceMotionEvent) {
-          if (typeof window.DeviceMotionEvent.requestPermission === "function") {
-            try {
-              const response = await window.DeviceMotionEvent.requestPermission();
-              if (response === "granted") {
-                window.addEventListener("devicemotion", this.handleDeviceMotion, true);
-              } else if (response === "denied") {
-                alert("You have denied access to motion and orientation data. To enable it, go to Settings > Safari > Motion & Orientation Access.");
-                throw new Error("Unable to access the accelerometer.");
-              }
-            } catch (error) {
-              console.error(error);
-            }
-          } else {
-            window.addEventListener("devicemotion", this.handleDeviceMotion, true);
-          }
+          window.addEventListener("devicemotion", this.handleDeviceMotion, true);
         } else {
           console.log("Cannot set the accelerometer handler.");
         }
       }
       if (this.hasGyrInput) {
         if (window.DeviceMotionEvent) {
-          if (typeof window.DeviceOrientationEvent.requestPermission === "function") {
-            try {
-              const response = await window.DeviceOrientationEvent.requestPermission();
-              if (response === "granted") {
-                window.addEventListener("deviceorientation", this.handleDeviceOrientation, true);
-              } else if (response === "denied") {
-                alert("You have denied access to motion and orientation data. To enable it, go to Settings > Safari > Motion & Orientation Access.");
-                throw new Error("Unable to access the gyroscope.");
-              }
-            } catch (error) {
-              console.error(error);
-            }
-          } else {
-            window.addEventListener("deviceorientation", this.handleDeviceOrientation, true);
-          }
+          window.addEventListener("deviceorientation", this.handleDeviceOrientation, true);
         } else {
           console.log("Cannot set the gyroscope handler.");
         }
@@ -4281,6 +4354,12 @@ export default ${(_b = jsCode.match(jsCodeHead)) == null ? void 0 : _b[1]};
     pitchWheel(chan, value) {
       this.fDSPCode.pitchWheel(chan, value);
     }
+    keyOn(channel, pitch, velocity) {
+      this.fDSPCode.keyOn(channel, pitch, velocity);
+    }
+    keyOff(channel, pitch, velocity) {
+      this.fDSPCode.keyOff(channel, pitch, velocity);
+    }
     setParamValue(path, value) {
       this.fDSPCode.setParamValue(path, value);
     }