@grame/faustwasm 0.4.6 → 0.4.8

package/README.md

@@ -49,7 +49,7 @@ For example:
 rm -rf test/out # make sure you are under the faustwasm directory.
 node scripts/faust2wasm.js test/mono.dsp test/out
 ```
-will create a set of files: `mono.js`, `mono.wasm`, `mono.json`, `mono.html` in the `out` folder.
+will create a set of files: `index.js`, `dsp-module.wasm`, `dsp-meta.json`, `index.html` in the `out` folder. `-no-template` option will omit `index.js` and `index.html` files.
 
 Polyphonic instrument with:
 
@@ -57,7 +57,7 @@ Polyphonic instrument with:
 rm -rf test/out # make sure you are under the faustwasm directory.
 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.
+will create a set of files: `index.js`, `dsp-module.wasm`, `dsp-meta.json`, `index.html` (and possibly `effect-module.wasm`, `effect-meta.json`) in the `out` folder.
 
 
 #### Creating a Progressive Web Application of a Faust DSP
@@ -67,7 +67,7 @@ You can create a standalone Progressive Web Application using the same command l
 ```bash
 node scripts/faust2wasm.js test/rev.dsp test/rev -standalone
 ```
-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 `rev` folder. 
+will create a set of files: `icon.png`, `service-worker.js`, `manifest.json`, `index.js`, `dsp-module.wasm`, `dsp-meta.json`, `index.html`, and the `faustwasm`, `faust-ui` folders in the `rev` 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. To test, be sure to launch a local web server at the `test` folder level, then go inside `test\rev` folder. 
 
@@ -76,7 +76,7 @@ A standalone polyphonic and MIDI standalone Progressive Web Application can be c
 ```bash
 node scripts/faust2wasm.js test/organ1.dsp test/organ1 -poly -standalone
 ```
-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 `organ1` folder.
+will create a set of files: `icon.png`, `service-worker.js`, `manifest.json`, `index.js`, `dsp-module.wasm`, `dsp-meta.json`, `effect-module.wasm`, `effect-meta.json`, `index.html`, and the `faustwasm`, `faust-ui` folders in the `organ1` folder.
 
 To test, be sure to launch a local web server at the `test` folder level, then go inside `test\organ1` folder. 
 

package/assets/standalone/create-node.js

@@ -0,0 +1,78 @@
+// @ts-check
+
+/**
+ * @typedef {{ dspModule: WebAssembly.Module; dspMeta: FaustDspMeta; effectModule?: WebAssembly.Module; effectMeta?: FaustDspMeta; mixerModule?: WebAssembly.Module }} FaustDspDistribution
+ * @typedef {import("./faustwasm").FaustDspMeta} FaustDspMeta
+ * @typedef {import("./faustwasm").FaustMonoAudioWorkletNode} FaustMonoAudioWorkletNode
+ * @typedef {import("./faustwasm").FaustPolyAudioWorkletNode} FaustPolyAudioWorkletNode
+ * @typedef {import("./faustwasm").FaustMonoScriptProcessorNode} FaustMonoScriptProcessorNode
+ * @typedef {import("./faustwasm").FaustPolyScriptProcessorNode} FaustPolyScriptProcessorNode
+ * @typedef {FaustMonoAudioWorkletNode | FaustPolyAudioWorkletNode | FaustMonoScriptProcessorNode | FaustPolyScriptProcessorNode} FaustNode
+ */
+
+/**
+ * Creates a Faust audio node for use in the Web Audio API.
+ *
+ * @param {AudioContext} audioContext - The Web Audio API AudioContext to which the Faust audio node will be connected.
+ * @param {string} [dspName] - The name of the DSP to be loaded.
+ * @param {number} [voices] - The number of voices to be used for polyphonic DSPs.
+ * @param {boolean} [sp] - Whether to create a ScriptProcessorNode instead of an AudioWorkletNode.
+ * @returns {Promise<{ faustNode: FaustNode | null; dspMeta: FaustDspMeta }>} - An object containing the Faust audio node and the DSP metadata.
+ */
+const createFaustNode = async (audioContext, dspName = "template", voices = 0, sp = false) => {
+    // Set to true if the DSP has an effect
+    const FAUST_DSP_HAS_EFFECT = false;
+
+    // Import necessary Faust modules and data
+    const { FaustMonoDspGenerator, FaustPolyDspGenerator } = await import("./faustwasm/index.js");
+
+    // Load DSP metadata from JSON
+    /** @type {FaustDspMeta} */
+    const dspMeta = await (await fetch("./dsp-meta.json")).json();
+
+    // Compile the DSP module from WebAssembly binary data
+    const dspModule = await WebAssembly.compileStreaming(await fetch("./dsp-module.wasm"));
+
+    // Create an object representing Faust DSP with metadata and module
+    /** @type {FaustDspDistribution} */
+    const faustDsp = { dspMeta, dspModule };
+
+    /** @type {FaustNode | null} */
+    let faustNode = null;
+
+    // Create either a polyphonic or monophonic Faust audio node based on the number of voices
+    if (voices > 0) {
+
+        // Try to load optional mixer and effect modules
+        faustDsp.mixerModule = await WebAssembly.compileStreaming(await fetch("./mixer-module.wasm"));
+
+        if (FAUST_DSP_HAS_EFFECT) {
+            faustDsp.effectMeta = await (await fetch("./effect-meta.json")).json();
+            faustDsp.effectModule = await WebAssembly.compileStreaming(await fetch("./effect-module.wasm"));
+        }
+
+        const generator = new FaustPolyDspGenerator();
+        faustNode = await generator.createNode(
+            audioContext,
+            voices,
+            dspName,
+            { module: faustDsp.dspModule, json: JSON.stringify(faustDsp.dspMeta), soundfiles: {} },
+            faustDsp.mixerModule,
+            faustDsp.effectModule ? { module: faustDsp.effectModule, json: JSON.stringify(faustDsp.effectMeta), soundfiles: {} } : undefined,
+            sp
+        );
+    } else {
+        const generator = new FaustMonoDspGenerator();
+        faustNode = await generator.createNode(
+            audioContext,
+            dspName,
+            { module: faustDsp.dspModule, json: JSON.stringify(faustDsp.dspMeta), soundfiles: {} },
+            sp
+        );
+    }
+
+    // Return an object with the Faust audio node and the DSP metadata
+    return { faustNode, dspMeta };
+}
+
+export default createFaustNode;

package/assets/standalone/faustwasm/index.js

@@ -3719,22 +3719,12 @@ var FaustAudioWorkletNode = class extends (globalThis.AudioWorkletNode || null)
   async listenSensors() {
     if (this.hasAccInput) {
       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 });
-        };
-      }
+      const handleDeviceMotion = ({ accelerationIncludingGravity }) => {
+        if (!accelerationIncludingGravity)
+          return;
+        const { x, y, z } = accelerationIncludingGravity;
+        this.propagateAcc({ x, y, z }, isAndroid);
+      };
       if (window.DeviceMotionEvent) {
         if (typeof window.DeviceMotionEvent.requestPermission === "function") {
           try {
@@ -3983,22 +3973,12 @@ var FaustScriptProcessorNode = class extends (globalThis.ScriptProcessorNode ||
   async listenSensors() {
     if (this.hasAccInput) {
       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 });
-        };
-      }
+      const handleDeviceMotion = ({ accelerationIncludingGravity }) => {
+        if (!accelerationIncludingGravity)
+          return;
+        const { x, y, z } = accelerationIncludingGravity;
+        this.propagateAcc({ x, y, z }, isAndroid);
+      };
       if (window.DeviceMotionEvent) {
         if (typeof window.DeviceMotionEvent.requestPermission === "function") {
           try {