@grame/faustwasm 0.3.1 → 0.4.0

package/README.md

@@ -4,6 +4,10 @@ The FaustWasm library presents a convenient, high-level API that wraps around [F
 
 The library offers functionality for compiling Faust DSP code into WebAssembly, enabling its utilization as WebAudio nodes within a standard WebAudio node graph. Moreover, it supports offline rendering scenarios. Furthermore, supplementary tools can be employed for generating SVGs from Faust DSP programs.
 
+Synthesizer and effect mono nodes, as well as [polyphonic](https://faustdoc.grame.fr/manual/midi/#midi-polyphony-support) poly nodes can be created. MIDI support is activated as soon as [MIDI metadata](https://faustdoc.grame.fr/manual/midi/#configuring-midi-in-faust) are used in the DSP code for mono nodes, and always in polyphonic mode. 
+  
+[Sensors](https://faustdoc.grame.fr/manual/syntax/#sensors-control-metadatas) (accelerometer and gyroscope) are supported, as well as the  [Progressive Web Application](https://en.wikipedia.org/wiki/Progressive_web_app) model.  
+
 ## Usage
 
 Please use a stable version of [Node.js](https://nodejs.org) 16+ to work with this project.
@@ -55,21 +59,23 @@ node scripts/faust2wasm.js test/poly.dsp test/out -poly
 ```
 will create a set of files: `poly.js`, `poly.wasm`, `poly.json`, `poly.html` (and possibly `poly_effect.wasm`, `poly_effect.json`) in the `out` folder.
 
-You can create a standalone DSP on a web page using the same command line:
+You can create a standalone Progressive Web Application using the same command line:
 
 ```bash
 rm -rf test/out # make sure you are under the faustwasm directory.
 node scripts/faust2wasm.js test/rev.dsp test/out -standalone
 ```
-will create a set of files: `rev.js`, `rev.wasm`, `rev.json`, `rev.html`, and the `faustwasm`, `faust-ui` folders in the `out` folder .
+will create a set of files: `icon.png`, `service-worker.js`, `manifest.json`, `rev.js`, `rev.wasm`, `rev.json`, `index.html`, and the `faustwasm`, `faust-ui` folders in the `out` folder.
+
+The folder contains the necessary ressources to deploy the Faust application as a PWA on a server, to be installed and used offline. Note that audio files used by the `soundfile` primitives in the DSP code will have to be mannually added in the folder. 
 
-Or a standalone polyphonic DSP on a web page with:
+A standalone polyphonic and MIDI standalone Progressive Web Application can be created with:
 
 ```bash
 rm -rf test/out # make sure you are under the faustwasm directory.
 node scripts/faust2wasm.js test/organ1.dsp test/out -standalone
 ```
-will create a set of files: `organ1.js`, `organ1.wasm`, `organ1.json`, `organ1_effect.wasm`, `organ1_effect.json`, `organ1.html`, and the `faustwasm`, `faust-ui` folders in the `out` folder.
+will create a set of files: `icon.png`, `service-worker.js`, `manifest.json`, `organ1.js`, `organ1.wasm`, `organ1.json`, `organ1_effect.wasm`, `organ1_effect.json`, `index.html`, and the `faustwasm`, `faust-ui` folders in the `out` folder.
 
 #### Generate SVG Diagrams of a Faust DSP
 

package/assets/standalone/faustwasm/index.d.ts

@@ -635,7 +635,7 @@ export interface IFaustBaseWebAudioDsp {
 	/** Indicating if the DSP handles the accelerometer */
 	readonly hasAccInput: boolean;
 	/** Accelerometer handling */
-	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>): void;
+	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>, invert: boolean): void;
 	/** Indicating if the DSP handles the gyroscope */
 	readonly hasGyrInput: boolean;
 	/** Gyroscope handling */
@@ -724,7 +724,7 @@ export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	/** Split the soundfile names and return an array of names */
 	static splitSoundfileNames(input: string): string[];
 	get hasAccInput(): boolean;
-	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>): void;
+	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>, invert?: boolean): void;
 	get hasGyrInput(): boolean;
 	propagateGyr(event: Pick<DeviceOrientationEvent, "alpha" | "beta" | "gamma">): void;
 	/** Build the accelerometer handler */
@@ -1123,7 +1123,7 @@ export declare class FaustOfflineProcessor<Poly extends boolean = false> {
 	stop(): void;
 	destroy(): void;
 	get hasAccInput(): boolean;
-	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>): void;
+	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>, invert?: boolean): void;
 	get hasGyrInput(): boolean;
 	propagateGyr(event: Pick<DeviceOrientationEvent, "alpha" | "beta" | "gamma">): void;
 	/**
@@ -1211,6 +1211,12 @@ export declare class WavDecoder {
 /** Read metadata and fetch soundfiles */
 export declare class SoundfileReader {
 	static get fallbackPaths(): string[];
+	/**
+	 * Extract the parent URL from an URL.
+	 * @param url : the URL
+	 * @returns : the parent URL
+	 */
+	private static getParentUrl;
 	/**
 	 * Convert an audio buffer to audio data.
 	 *
@@ -1293,7 +1299,7 @@ export declare class FaustAudioWorkletNode<Poly extends boolean = false> extends
 	ctrlChange(channel: number, ctrl: number, value: number): void;
 	pitchWheel(channel: number, wheel: number): void;
 	get hasAccInput(): boolean;
-	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>): void;
+	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>, invert?: boolean): void;
 	get hasGyrInput(): boolean;
 	propagateGyr(event: Pick<DeviceOrientationEvent, "alpha" | "beta" | "gamma">): void;
 	setParamValue(path: string, value: number): void;
@@ -1366,7 +1372,7 @@ export declare class FaustScriptProcessorNode<Poly extends boolean = false> exte
 	stop(): void;
 	destroy(): void;
 	get hasAccInput(): boolean;
-	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>): void;
+	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>, invert?: boolean): void;
 	get hasGyrInput(): boolean;
 	propagateGyr(event: Pick<DeviceOrientationEvent, "alpha" | "beta" | "gamma">): void;
 }

package/assets/standalone/faustwasm/index.js

@@ -138,7 +138,7 @@ var getFaustAudioWorkletProcessor = (dependencies, faustData, register = true) =
       const msg = e.data;
       switch (msg.type) {
         case "acc": {
-          this.propagateAcc(msg.data);
+          this.propagateAcc(msg.data, msg.invert);
           break;
         }
         case "gyr": {
@@ -199,8 +199,8 @@ var getFaustAudioWorkletProcessor = (dependencies, faustData, register = true) =
     pitchWheel(channel, wheel) {
       this.fDSPCode.pitchWheel(channel, wheel);
     }
-    propagateAcc(accelerationIncludingGravity) {
-      this.fDSPCode.propagateAcc(accelerationIncludingGravity);
+    propagateAcc(accelerationIncludingGravity, invert = false) {
+      this.fDSPCode.propagateAcc(accelerationIncludingGravity, invert);
     }
     propagateGyr(event) {
       this.fDSPCode.propagateGyr(event);
@@ -2103,14 +2103,23 @@ var FaustBaseWebAudioDsp = class _FaustBaseWebAudioDsp {
   get hasAccInput() {
     return this.fAcc.x.length + this.fAcc.y.length + this.fAcc.z.length > 0;
   }
-  propagateAcc(accelerationIncludingGravity) {
+  propagateAcc(accelerationIncludingGravity, invert = false) {
     const { x, y, z } = accelerationIncludingGravity;
-    if (x !== null)
-      this.fAcc.x.forEach((handler) => handler(x));
-    if (y !== null)
-      this.fAcc.y.forEach((handler) => handler(y));
-    if (z !== null)
-      this.fAcc.z.forEach((handler) => handler(z));
+    if (invert) {
+      if (x !== null)
+        this.fAcc.x.forEach((handler) => handler(-x));
+      if (y !== null)
+        this.fAcc.y.forEach((handler) => handler(-y));
+      if (z !== null)
+        this.fAcc.z.forEach((handler) => handler(-z));
+    } else {
+      if (x !== null)
+        this.fAcc.x.forEach((handler) => handler(x));
+      if (y !== null)
+        this.fAcc.y.forEach((handler) => handler(y));
+      if (z !== null)
+        this.fAcc.z.forEach((handler) => handler(z));
+    }
   }
   get hasGyrInput() {
     return this.fGyr.x.length + this.fGyr.y.length + this.fGyr.z.length > 0;
@@ -2970,8 +2979,8 @@ var FaustOfflineProcessor = class {
   get hasAccInput() {
     return this.fDSPCode.hasAccInput;
   }
-  propagateAcc(accelerationIncludingGravity) {
-    this.fDSPCode.propagateAcc(accelerationIncludingGravity);
+  propagateAcc(accelerationIncludingGravity, invert = false) {
+    this.fDSPCode.propagateAcc(accelerationIncludingGravity, invert);
   }
   get hasGyrInput() {
     return this.fDSPCode.hasGyrInput;
@@ -3487,8 +3496,17 @@ var WavDecoder_default = WavDecoder;
 
 // src/SoundfileReader.ts
 var SoundfileReader = class {
+  // Set the fallback paths
   static get fallbackPaths() {
-    return [location.href, location.origin];
+    return [location.href, this.getParentUrl(location.href), location.origin];
+  }
+  /**
+   * Extract the parent URL from an URL.
+   * @param url : the URL
+   * @returns : the parent URL
+   */
+  static getParentUrl(url) {
+    return url.substring(0, url.lastIndexOf("/") + 1);
   }
   /**
    * Convert an audio buffer to audio data.
@@ -3529,7 +3547,8 @@ var SoundfileReader = class {
   static async checkFileExists(url) {
     try {
       console.log(`"checkFileExists" url: ${url}`);
-      const response = await fetch(url, { method: "HEAD" });
+      const response = await fetch(url);
+      console.log(`"checkFileExists" response.ok: ${response.ok}`);
       return response.ok;
     } catch (error) {
       console.error("Fetch error:", error);
@@ -3649,12 +3668,23 @@ var FaustAudioWorkletNode = class extends (globalThis.AudioWorkletNode || null)
   /** Setup accelerometer and gyroscope handlers */
   async listenSensors() {
     if (this.hasAccInput) {
-      const handleDeviceMotion = ({ accelerationIncludingGravity }) => {
-        if (!accelerationIncludingGravity)
-          return;
-        const { x, y, z } = accelerationIncludingGravity;
-        this.propagateAcc({ x, y, z });
-      };
+      const isAndroid = /Android/i.test(navigator.userAgent);
+      let handleDeviceMotion = null;
+      if (isAndroid) {
+        handleDeviceMotion = ({ accelerationIncludingGravity }) => {
+          if (!accelerationIncludingGravity)
+            return;
+          const { x, y, z } = accelerationIncludingGravity;
+          this.propagateAcc({ x, y, z }, true);
+        };
+      } else {
+        handleDeviceMotion = ({ accelerationIncludingGravity }) => {
+          if (!accelerationIncludingGravity)
+            return;
+          const { x, y, z } = accelerationIncludingGravity;
+          this.propagateAcc({ x, y, z });
+        };
+      }
       if (window.DeviceMotionEvent) {
         if (typeof window.DeviceMotionEvent.requestPermission === "function") {
           try {
@@ -3755,10 +3785,10 @@ var FaustAudioWorkletNode = class extends (globalThis.AudioWorkletNode || null)
   get hasAccInput() {
     return __privateGet(this, _hasAccInput);
   }
-  propagateAcc(accelerationIncludingGravity) {
+  propagateAcc(accelerationIncludingGravity, invert = false) {
     if (!accelerationIncludingGravity)
       return;
-    const e = { type: "acc", data: accelerationIncludingGravity };
+    const e = { type: "acc", data: accelerationIncludingGravity, invert };
     this.port.postMessage(e);
   }
   get hasGyrInput() {
@@ -3907,12 +3937,23 @@ var FaustScriptProcessorNode = class extends (globalThis.ScriptProcessorNode ||
   /** Setup accelerometer and gyroscope handlers */
   async listenSensors() {
     if (this.hasAccInput) {
-      const handleDeviceMotion = ({ accelerationIncludingGravity }) => {
-        if (!accelerationIncludingGravity)
-          return;
-        const { x, y, z } = accelerationIncludingGravity;
-        this.propagateAcc({ x, y, z });
-      };
+      const isAndroid = /Android/i.test(navigator.userAgent);
+      let handleDeviceMotion = null;
+      if (isAndroid) {
+        handleDeviceMotion = ({ accelerationIncludingGravity }) => {
+          if (!accelerationIncludingGravity)
+            return;
+          const { x, y, z } = accelerationIncludingGravity;
+          this.propagateAcc({ x, y, z }, true);
+        };
+      } else {
+        handleDeviceMotion = ({ accelerationIncludingGravity }) => {
+          if (!accelerationIncludingGravity)
+            return;
+          const { x, y, z } = accelerationIncludingGravity;
+          this.propagateAcc({ x, y, z });
+        };
+      }
       if (window.DeviceMotionEvent) {
         if (typeof window.DeviceMotionEvent.requestPermission === "function") {
           try {
@@ -4023,8 +4064,8 @@ var FaustScriptProcessorNode = class extends (globalThis.ScriptProcessorNode ||
   get hasAccInput() {
     return this.fDSPCode.hasAccInput;
   }
-  propagateAcc(accelerationIncludingGravity) {
-    this.fDSPCode.propagateAcc(accelerationIncludingGravity);
+  propagateAcc(accelerationIncludingGravity, invert = false) {
+    this.fDSPCode.propagateAcc(accelerationIncludingGravity, invert);
   }
   get hasGyrInput() {
     return this.fDSPCode.hasGyrInput;