@grame/faustwasm 0.16.4 → 0.16.5

package/assets/standalone/faust-pwa.js

@@ -53,7 +53,7 @@ export class FaustPWA {
         /** @type {FaustPWAOptions} */
         this.fOptions = {
             voices: 0,
-            useScriptProcessor: false,
+            useScriptProcessor: undefined,
             bufferSize: 512,
             uiContainer: null,
             ...options,
@@ -74,6 +74,7 @@ export class FaustPWA {
         // MIDI and Sensor handlers state
         this.fActive.sensors = false;
         this.fActive.midi = false;
+        this.fActive.audioConnected = false;
 
         // Keyboard to MIDI handing
         this.fKeyboard2MIDI = null;
@@ -187,15 +188,59 @@ export class FaustPWA {
         return this.fFaustNode;
     }
 
+    /**
+     * Choose the default audio backend for the current runtime.
+     *
+     * AudioWorklet is always preferred. ScriptProcessor is only requested up
+     * front when the runtime has no AudioWorklet support at all. iOS/WebKit
+     * cases where an AudioWorklet graph is created but stays silent are handled
+     * at node-creation time by the AudioWorklet→ScriptProcessor retry in
+     * `createFaustNode`, so no preemptive iOS heuristic is needed here. The
+     * explicit `useScriptProcessor` option still overrides this default.
+     *
+     * @returns {boolean} True only when AudioWorklet is unavailable.
+     */
+    shouldUseScriptProcessor() {
+        return !this.fAudioContext.audioWorklet;
+    }
+
+    /**
+     * Prime iOS audio output inside the same user gesture used to resume audio.
+     *
+     * Some iOS versions report a resumed AudioContext while the hardware output
+     * path remains locked until a source node is started from the activation
+     * gesture. A one-sample silent buffer is enough to unlock that path without
+     * producing audible sound. Failure is non-fatal because this is only a
+     * compatibility assist.
+     */
+    unlockAudioOutput() {
+        try {
+            const buffer = this.fAudioContext.createBuffer(1, 1, this.fAudioContext.sampleRate);
+            const source = this.fAudioContext.createBufferSource();
+            const gain = this.fAudioContext.createGain();
+            gain.gain.value = 0;
+            source.buffer = buffer;
+            source.connect(gain).connect(this.fAudioContext.destination);
+            source.start(0);
+            source.stop(this.fAudioContext.currentTime + 0.01);
+        } catch (error) {
+            console.warn("Silent audio unlock failed.", error);
+        }
+    }
+
     // Synchronous function to resume AudioContext, to be called first in the synchronous event listener
     resumeAudioContext() {
+        this.unlockAudioOutput();
         if (this.fAudioContext.state === 'suspended') {
-            this.fAudioContext.resume().then(() => {
+            return this.fAudioContext.resume().then(() => {
                 console.log('AudioContext resumed successfully');
+                return this.fAudioContext.state;
             }).catch(error => {
                 console.error('Error when resuming AudioContext:', error);
+                throw error;
             });
         }
+        return Promise.resolve(this.fAudioContext.state);
     }
 
     // Asynchronous function to suspend AudioContext
@@ -212,6 +257,13 @@ export class FaustPWA {
         // Import the create-node module
         const { connectToAudioInput, requestPermissions } = await import("./create-node.js");
 
+        // Connect the Faust node to the audio output before optional permissions
+        // so a denied MIDI/sensor/input permission cannot leave a synth silent.
+        if (!this.fActive.audioConnected) {
+            this.fFaustNode.connect(this.fAudioContext.destination);
+            this.fActive.audioConnected = true;
+        }
+
         // Request permission for sensors
         await requestPermissions();
 
@@ -228,12 +280,13 @@ export class FaustPWA {
             this.fActive.midi = true;
         }
 
-        // Connect the Faust node to the audio output@
-        this.fFaustNode.connect(this.fAudioContext.destination);
-
         // Connect the Faust node to the audio input
         if (this.fFaustNode.numberOfInputs > 0) {
-            await connectToAudioInput(this.fAudioContext, null, this.fFaustNode, null);
+            try {
+                await connectToAudioInput(this.fAudioContext, null, this.fFaustNode, null);
+            } catch (error) {
+                console.error("Error when connecting audio input:", error);
+            }
         }
     }
 
@@ -268,7 +321,7 @@ export class FaustPWA {
                 this.fAudioContext,
                 this.fOptions.dspName,
                 this.fOptions.voices ?? 0,
-                this.fOptions.useScriptProcessor ?? false,
+                this.fOptions.useScriptProcessor ?? this.shouldUseScriptProcessor(),
                 this.fOptions.bufferSize ?? 512
             );
 
@@ -307,12 +360,10 @@ export class FaustPWA {
     */
     async start() {
         // Resume AudioContext synchronously
-        this.resumeAudioContext();
-
+        await this.resumeAudioContext();
+        
         // Launch the activation of MIDI and Sensors
-        this.activateMIDISensors().catch(error => {
-            console.error('Error when activating audio, MIDI and sensors:', error);
-        });
+        await this.activateMIDISensors();
 
         // Dispatch the started event
         this.dispatch('started', { when: this.audioContext.currentTime });

package/assets/standalone/index-pwa.js

@@ -40,19 +40,26 @@ const FAUST_DSP_VOICES = 0;
     // Create PWA and UI
     await pwa.create();
 
-    // Event listener to handle user interaction
+    // Event listener to handle user interaction. The whole start sequence is
+    // launched from the event handler rather than split across delayed tasks so
+    // iOS keeps it associated with the user activation.
     function handleUserInteraction() {
-
+     
         // Resume AudioContext synchronously
         pwa.resumeAudioContext();
 
         // Activate MIDI and Sensors
-        pwa.activateMIDISensors()
-    }
+        pwa.activateMIDISensors();
+   }
 
-    // Activate AudioContext, MIDI and Sensors on user interaction
+    // Register several activation events because iOS standalone PWAs do not
+    // behave identically across versions: some fire pointer events reliably,
+    // others are more consistent with touchend or click.
+    window.addEventListener('pointerdown', handleUserInteraction, { passive: true });
+    window.addEventListener('touchend', handleUserInteraction, { passive: true });
     window.addEventListener('click', handleUserInteraction);
     window.addEventListener('touchstart', handleUserInteraction);
+    window.addEventListener('keydown', handleUserInteraction);
 
     // Deactivate AudioContext, MIDI and Sensors on user interaction
     window.addEventListener('visibilitychange', function () {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@grame/faustwasm",
-    "version": "0.16.4",
+    "version": "0.16.5",
     "description": "WebAssembly version of Faust Compiler",
     "main": "dist/cjs/index.js",
     "types": "dist/esm/index.d.ts",

package/test/organ/create-node.js

@@ -1,253 +0,0 @@
-// @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, bufferSize = 512) => {
-    // 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"));
-        }
-
-        // Create a polyphonic Faust audio node
-        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,
-            bufferSize
-        );
-    } else {
-        // Create a standard Faust audio node
-        const generator = new FaustMonoDspGenerator();
-        faustNode = await generator.createNode(
-            audioContext,
-            dspName,
-            { module: faustDsp.dspModule, json: JSON.stringify(faustDsp.dspMeta), soundfiles: {} },
-            sp,
-            bufferSize
-        );
-    }
-
-    // Return an object with the Faust audio node and the DSP metadata
-    return { faustNode, dspMeta };
-}
-
-/**
- * Connects an audio input stream to a Faust WebAudio node.
- * 
- * @param {AudioContext} audioContext - The Web Audio API AudioContext to which the Faust audio node is connected.
- * @param {string} id - The ID of the audio input device to connect.
- * @param {FaustNode} faustNode - The Faust audio node to which the audio input stream will be connected.
- * @param {MediaStreamAudioSourceNode} oldInputStreamNode - The old audio input stream node to be disconnected from the Faust audio node.
- * @returns {Promise<MediaStreamAudioSourceNode>} - The new audio input stream node connected to the Faust audio node.
- */
-async function connectToAudioInput(audioContext, id, faustNode, oldInputStreamNode) {
-    // Create an audio input stream node
-    const constraints = {
-        audio: {
-            echoCancellation: false,
-            noiseSuppression: false,
-            autoGainControl: false,
-            deviceId: id ? { exact: id } : undefined,
-        },
-    };
-    // Get the audio input stream
-    const stream = await navigator.mediaDevices.getUserMedia(constraints);
-    if (stream) {
-        if (oldInputStreamNode) oldInputStreamNode.disconnect();
-        const newInputStreamNode = audioContext.createMediaStreamSource(stream);
-        newInputStreamNode.connect(faustNode);
-        return newInputStreamNode;
-    } else {
-        return oldInputStreamNode;
-    }
-};
-
-/**
- * Creates a Faust UI for a Faust audio node.
- * 
- * @param {FaustAudioWorkletNode} faustNode 
- */
-async function createFaustUI(divFaustUI, faustNode) {
-    const { FaustUI } = await import("./faust-ui/index.js");
-    const $container = document.createElement("div");
-    $container.style.margin = "0";
-    $container.style.position = "absolute";
-    $container.style.overflow = "auto";
-    $container.style.display = "flex";
-    $container.style.flexDirection = "column";
-    $container.style.width = "100%";
-    $container.style.height = "100%";
-    divFaustUI.appendChild($container);
-    const faustUI = new FaustUI({
-        ui: faustNode.getUI(),
-        root: $container,
-        listenWindowMessage: false,
-        listenWindowResize: true,
-    });
-    faustUI.paramChangeByUI = (path, value) => faustNode.setParamValue(path, value);
-    faustNode.setOutputParamHandler((path, value) => faustUI.paramChangeByDSP(path, value));
-    faustNode.setInputParamHandler((path, value) => faustUI.paramChangeByDSP(path, value));
-    $container.style.minWidth = `${faustUI.minWidth}px`;
-    $container.style.minHeight = `${faustUI.minHeight}px`;
-    faustUI.resize();
-};
-
-/**
- * Request permission to use motion and orientation sensors.
- */
-async function requestPermissions() {
-
-    // Explicitly request permission on iOS before calling startSensors()
-    if (typeof window.DeviceMotionEvent !== "undefined" && typeof window.DeviceMotionEvent.requestPermission === "function") {
-        try {
-            const permissionState = await window.DeviceMotionEvent.requestPermission();
-            if (permissionState !== "granted") {
-                console.warn("Motion sensor permission denied.");
-            } else {
-                console.log("Motion sensor permission granted.");
-            }
-        } catch (error) {
-            console.error("Error requesting motion sensor permission:", error);
-        }
-    }
-
-    if (typeof window.DeviceOrientationEvent !== "undefined" && typeof window.DeviceOrientationEvent.requestPermission === "function") {
-        try {
-            const permissionState = await window.DeviceOrientationEvent.requestPermission();
-            if (permissionState !== "granted") {
-                console.warn("Orientation sensor permission denied.");
-            } else {
-                console.log("Orientation sensor permission granted.");
-            }
-        } catch (error) {
-            console.error("Error requesting orientation sensor permission:", error);
-        }
-    }
-}
-
-/**
- * Key2Midi: maps keyboard input to MIDI messages.
- */
-class Key2Midi {
-    static KEY_MAP = {
-        a: 0, w: 1, s: 2, e: 3, d: 4, f: 5, t: 6, g: 7,
-        y: 8, h: 9, u: 10, j: 11, k: 12, o: 13, l: 14, p: 15, ";": 16,
-        z: "PREV", x: "NEXT", c: "VELDOWN", v: "VELUP"
-    };
-
-    constructor({ keyMap = Key2Midi.KEY_MAP, offset = 60, velocity = 100, handler = console.log } = {}) {
-        this.keyMap = keyMap;
-        this.offset = offset;
-        this.velocity = velocity;
-        this.velMap = [20, 40, 60, 80, 100, 127];
-        this.handler = handler;
-        this.pressed = {};
-
-        this.onKeyDown = this.onKeyDown.bind(this);
-        this.onKeyUp = this.onKeyUp.bind(this);
-    }
-
-    start() {
-        window.addEventListener("keydown", this.onKeyDown);
-        window.addEventListener("keyup", this.onKeyUp);
-    }
-
-    stop() {
-        window.removeEventListener("keydown", this.onKeyDown);
-        window.removeEventListener("keyup", this.onKeyUp);
-    }
-
-    onKeyDown(e) {
-        const key = e.key.toLowerCase();
-        if (this.pressed[key]) return;
-        this.pressed[key] = true;
-
-        const val = this.keyMap[key];
-        if (typeof val === "number") {
-            const note = val + this.offset;
-            this.handler([0x90, note, this.velocity]);
-        } else if (val === "PREV") {
-            this.offset -= 1;
-        } else if (val === "NEXT") {
-            this.offset += 1;
-        } else if (val === "VELDOWN") {
-            const idx = Math.max(0, this.velMap.indexOf(this.velocity) - 1);
-            this.velocity = this.velMap[idx];
-        } else if (val === "VELUP") {
-            const idx = Math.min(this.velMap.length - 1, this.velMap.indexOf(this.velocity) + 1);
-            this.velocity = this.velMap[idx];
-        }
-    }
-
-    onKeyUp(e) {
-        const key = e.key.toLowerCase();
-        const val = this.keyMap[key];
-        if (typeof val === "number") {
-            const note = val + this.offset;
-            this.handler([0x80, note, this.velocity]);
-        }
-        delete this.pressed[key];
-    }
-}
-
-/**
- * Creates a Key2Midi instance.
- * 
- * @param {function} handler - The function to handle MIDI messages.
- * @returns {Key2Midi} - The Key2Midi instance.
- */
-function createKey2MIDI(handler) {
-    return new Key2Midi({ handler: handler });
-}
-
-// Export the functions
-export { createFaustNode, createFaustUI, createKey2MIDI, connectToAudioInput, requestPermissions };
-

package/test/organ/dsp-meta.json

@@ -1,132 +0,0 @@
-{
-    "name": "organ",
-    "filename": "organ",
-    "version": "2.85.8",
-    "compile_options": "-lang wasm-i -fpga-mem-th 4 -ct 1 -es 1 -mcd 16 -mdd 1024 -mdy 33 -single -ftz 2",
-    "library_list": [
-        "/usr/share/faust/stdfaust.lib",
-        "/usr/share/faust/oscillators.lib",
-        "/usr/share/faust/platform.lib",
-        "/usr/share/faust/maths.lib",
-        "/usr/share/faust/basics.lib",
-        "/usr/share/faust/envelopes.lib"
-    ],
-    "include_pathnames": [
-        "/faust/user/inc0",
-        "/share/faust",
-        "/usr/local/share/faust",
-        "/usr/share/faust",
-        "."
-    ],
-    "size": 262264,
-    "code": "cAbO",
-    "inputs": 0,
-    "outputs": 1,
-    "meta": [
-        {
-            "basics.lib/name": "Faust Basic Element Library"
-        },
-        {
-            "basics.lib/version": "1.22.0"
-        },
-        {
-            "compile_options": "-lang wasm-i -fpga-mem-th 4 -ct 1 -es 1 -mcd 16 -mdd 1024 -mdy 33 -single -ftz 2"
-        },
-        {
-            "envelopes.lib/adsr:author": "Yann Orlarey and Andrey Bundin"
-        },
-        {
-            "envelopes.lib/author": "GRAME"
-        },
-        {
-            "envelopes.lib/copyright": "GRAME"
-        },
-        {
-            "envelopes.lib/license": "LGPL with exception"
-        },
-        {
-            "envelopes.lib/name": "Faust Envelope Library"
-        },
-        {
-            "envelopes.lib/version": "1.3.0"
-        },
-        {
-            "filename": "organ"
-        },
-        {
-            "maths.lib/author": "GRAME"
-        },
-        {
-            "maths.lib/copyright": "GRAME"
-        },
-        {
-            "maths.lib/license": "LGPL with exception"
-        },
-        {
-            "maths.lib/name": "Faust Math Library"
-        },
-        {
-            "maths.lib/version": "2.9.0"
-        },
-        {
-            "name": "organ"
-        },
-        {
-            "oscillators.lib/name": "Faust Oscillator Library"
-        },
-        {
-            "oscillators.lib/version": "1.7.0"
-        },
-        {
-            "platform.lib/name": "Generic Platform Library"
-        },
-        {
-            "platform.lib/version": "1.3.0"
-        }
-    ],
-    "ui": [
-        {
-            "type": "vgroup",
-            "label": "organ",
-            "items": [
-                {
-                    "type": "hslider",
-                    "label": "freq",
-                    "varname": "fHslider1",
-                    "shortname": "freq",
-                    "address": "/organ/freq",
-                    "index": 262168,
-                    "meta": [
-                        {
-                            "midi": "ctrl 7"
-                        }
-                    ],
-                    "init": 440,
-                    "min": 20,
-                    "max": 3000,
-                    "step": 1
-                },
-                {
-                    "type": "hslider",
-                    "label": "gain",
-                    "varname": "fHslider0",
-                    "shortname": "gain",
-                    "address": "/organ/gain",
-                    "index": 262144,
-                    "init": 0.5,
-                    "min": 0,
-                    "max": 1,
-                    "step": 0.01
-                },
-                {
-                    "type": "button",
-                    "label": "gate",
-                    "varname": "fButton0",
-                    "shortname": "gate",
-                    "address": "/organ/gate",
-                    "index": 262212
-                }
-            ]
-        }
-    ]
-}