@grame/faustwasm 0.0.45 → 0.0.46

package/assets/standalone/index.js

@@ -29,170 +29,187 @@ audioContext.suspend();
  * @param {FaustAudioWorkletNode} faustNode 
  */
 const buildAudioDeviceMenu = async (faustNode) => {
-	/** @type {MediaStreamAudioSourceNode} */
-	let inputStreamNode;
-	const handleDeviceChange = async () => {
-		const devicesInfo = await navigator.mediaDevices.enumerateDevices();
-		$selectAudioInput.innerHTML = '';
-		devicesInfo.forEach((deviceInfo, i) => {
-			const { kind, deviceId, label } = deviceInfo;
-			if (kind === "audioinput") {
-				const option = new Option(label || `microphone ${i + 1}`, deviceId);
-				$selectAudioInput.add(option);
-			}
-		});
-	}
-	await handleDeviceChange();
-	navigator.mediaDevices.addEventListener("devicechange", handleDeviceChange)
-	$selectAudioInput.onchange = async () => {
-		const id = $selectAudioInput.value;
-		const constraints = {
-			audio: {
-				echoCancellation: false,
-				mozNoiseSuppression: false,
-				mozAutoGainControl: false,
-				deviceId: id ? { exact: id } : undefined,
-			},
-		};
-		const stream = await navigator.mediaDevices.getUserMedia(constraints);
-		if (inputStreamNode) inputStreamNode.disconnect();
-		inputStreamNode = audioContext.createMediaStreamSource(stream);
-		inputStreamNode.connect(faustNode);
-	};
-
-	const defaultConstraints = {
-		audio: {
-			echoCancellation: false,
-			mozNoiseSuppression: false,
-			mozAutoGainControl: false
-		}
-	};	
-	const defaultStream = await navigator.mediaDevices.getUserMedia(defaultConstraints);
-	if (defaultStream) {
-		inputStreamNode = audioContext.createMediaStreamSource(defaultStream);
-		inputStreamNode.connect(faustNode);
-	}
+    /** @type {MediaStreamAudioSourceNode} */
+    let inputStreamNode;
+    const handleDeviceChange = async () => {
+        const devicesInfo = await navigator.mediaDevices.enumerateDevices();
+        $selectAudioInput.innerHTML = '';
+        devicesInfo.forEach((deviceInfo, i) => {
+            const { kind, deviceId, label } = deviceInfo;
+            if (kind === "audioinput") {
+                const option = new Option(label || `microphone ${i + 1}`, deviceId);
+                $selectAudioInput.add(option);
+            }
+        });
+    }
+    await handleDeviceChange();
+    navigator.mediaDevices.addEventListener("devicechange", handleDeviceChange)
+    $selectAudioInput.onchange = async () => {
+        const id = $selectAudioInput.value;
+        const constraints = {
+            audio: {
+                echoCancellation: false,
+                mozNoiseSuppression: false,
+                mozAutoGainControl: false,
+                deviceId: id ? { exact: id } : undefined,
+            },
+        };
+        const stream = await navigator.mediaDevices.getUserMedia(constraints);
+        if (inputStreamNode) inputStreamNode.disconnect();
+        inputStreamNode = audioContext.createMediaStreamSource(stream);
+        inputStreamNode.connect(faustNode);
+    };
+
+    const defaultConstraints = {
+        audio: {
+            echoCancellation: false,
+            mozNoiseSuppression: false,
+            mozAutoGainControl: false
+        }
+    };
+    const defaultStream = await navigator.mediaDevices.getUserMedia(defaultConstraints);
+    if (defaultStream) {
+        inputStreamNode = audioContext.createMediaStreamSource(defaultStream);
+        inputStreamNode.connect(faustNode);
+    }
 };
 
 /**
  * @param {FaustAudioWorkletNode} faustNode 
  */
 const buildMidiDeviceMenu = async (faustNode) => {
-	const midiAccess = await navigator.requestMIDIAccess();
-	/** @type {WebMidi.MIDIInput} */
-	let currentInput;
-	/**
-	 * @param {WebMidi.MIDIMessageEvent} e
-	 */
-	const handleMidiMessage = e => faustNode.midiMessage(e.data);
-	const handleStateChange = () => {
-		const { inputs } = midiAccess;
-		if ($selectMidiInput.options.length === inputs.size + 1) return;
-		if (currentInput) currentInput.removeEventListener("midimessage", handleMidiMessage);
-		$selectMidiInput.innerHTML = '<option value="-1" disabled selected>Select...</option>';
-		inputs.forEach((midiInput) => {
-			const { name, id } = midiInput;
-			const option = new Option(name, id);
-			$selectMidiInput.add(option);
-		});
-	};
-	handleStateChange();
-	midiAccess.addEventListener("statechange", handleStateChange);
-	$selectMidiInput.onchange = () => {
-		if (currentInput) currentInput.removeEventListener("midimessage", handleMidiMessage);
-		const id = $selectMidiInput.value;
-		currentInput = midiAccess.inputs.get(id);
-		currentInput.addEventListener("midimessage", handleMidiMessage);
-	};
+    const midiAccess = await navigator.requestMIDIAccess();
+    /** @type {WebMidi.MIDIInput} */
+    let currentInput;
+    /**
+     * @param {WebMidi.MIDIMessageEvent} e
+     */
+    const handleMidiMessage = e => faustNode.midiMessage(e.data);
+    const handleStateChange = () => {
+        const { inputs } = midiAccess;
+        if ($selectMidiInput.options.length === inputs.size + 1) return;
+        if (currentInput) currentInput.removeEventListener("midimessage", handleMidiMessage);
+        $selectMidiInput.innerHTML = '<option value="-1" disabled selected>Select...</option>';
+        inputs.forEach((midiInput) => {
+            const { name, id } = midiInput;
+            const option = new Option(name, id);
+            $selectMidiInput.add(option);
+        });
+    };
+    handleStateChange();
+    midiAccess.addEventListener("statechange", handleStateChange);
+    $selectMidiInput.onchange = () => {
+        if (currentInput) currentInput.removeEventListener("midimessage", handleMidiMessage);
+        const id = $selectMidiInput.value;
+        currentInput = midiAccess.inputs.get(id);
+        currentInput.addEventListener("midimessage", handleMidiMessage);
+    };
 };
 
 $buttonDsp.disabled = true;
 $buttonDsp.onclick = () => {
-	if (audioContext.state === "running") {
-		$buttonDsp.textContent = "Suspended";
-		audioContext.suspend();
-	} else if (audioContext.state === "suspended") {
-		$buttonDsp.textContent = "Running";
-		audioContext.resume();
-	}
+    if (audioContext.state === "running") {
+        $buttonDsp.textContent = "Suspended";
+        audioContext.suspend();
+    } else if (audioContext.state === "suspended") {
+        $buttonDsp.textContent = "Running";
+        audioContext.resume();
+    }
 }
 
 /**
- * @param {AudioContext} audioContext 
+ * 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.
+ * @returns {Object} - An object containing the Faust audio node, the number of voices (if polyphonic), and the DSP metadata.
  */
 const createFaustNode = async (audioContext) => {
-	const { FaustMonoDspGenerator, FaustPolyDspGenerator } = await import("./faustwasm/index.js");
-
-	/** @type {FaustDspMeta} */
-	const dspMeta = await (await fetch("./dspMeta.json")).json();
-	const dspModule = await WebAssembly.compileStreaming(await fetch("./dspModule.wasm"));
-	/** @type {FaustDspDistribution} */
-	const faustDsp = { dspMeta, dspModule };
-	try {
-		faustDsp.mixerModule = await WebAssembly.compileStreaming(await fetch("./mixerModule.wasm"));
-		faustDsp.effectMeta = await (await fetch("./effectMeta.json")).json();
-		faustDsp.effectModule = await WebAssembly.compileStreaming(await fetch("./effectModule.wasm"));
-	} catch (e) {}
-	const voices = faustDsp.mixerModule ? 64 : 0;
-
-	/** @type {FaustAudioWorkletNode} */
-	let faustNode;
-	if (voices) {
-		const generator = new FaustPolyDspGenerator();
-		faustNode = await generator.createNode(
-			audioContext,
-			voices,
-			"FaustPolyDSP",
-			{ module: faustDsp.dspModule, json: JSON.stringify(faustDsp.dspMeta) },
-			faustDsp.mixerModule,
-			faustDsp.effectModule ? { module: faustDsp.effectModule, json: JSON.stringify(faustDsp.effectMeta) } : undefined
-		);
-	} else {
-		const generator = new FaustMonoDspGenerator();
-		faustNode = await generator.createNode(
-			audioContext,
-			"FaustMonoDSP",
-			{ module: faustDsp.dspModule, json: JSON.stringify(faustDsp.dspMeta) }
-		);
-	}
-	return { faustNode, voices, dspMeta };
+    // 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("./dspMeta.json")).json();
+
+    // Compile the DSP module from WebAssembly binary data
+    const dspModule = await WebAssembly.compileStreaming(await fetch("./dspModule.wasm"));
+
+    // Create an object representing Faust DSP with metadata and module
+    /** @type {FaustDspDistribution} */
+    const faustDsp = { dspMeta, dspModule };
+
+    // Try to load optional mixer and effect modules
+    try {
+        faustDsp.mixerModule = await WebAssembly.compileStreaming(await fetch("./mixerModule.wasm"));
+        faustDsp.effectMeta = await (await fetch("./effectMeta.json")).json();
+        faustDsp.effectModule = await WebAssembly.compileStreaming(await fetch("./effectModule.wasm"));
+    } catch (e) { }
+
+    // Determine the number of voices based on the mixer module
+    const voices = faustDsp.mixerModule ? 64 : 0;
+
+    /** @type {FaustAudioWorkletNode} */
+    let faustNode;
+
+    // Create either a polyphonic or monophonic Faust audio node based on the number of voices
+    if (voices) {
+        const generator = new FaustPolyDspGenerator();
+        faustNode = await generator.createNode(
+            audioContext,
+            voices,
+            "FaustPolyDSP",
+            { module: faustDsp.dspModule, json: JSON.stringify(faustDsp.dspMeta) },
+            faustDsp.mixerModule,
+            faustDsp.effectModule ? { module: faustDsp.effectModule, json: JSON.stringify(faustDsp.effectMeta) } : undefined
+        );
+    } else {
+        const generator = new FaustMonoDspGenerator();
+        faustNode = await generator.createNode(
+            audioContext,
+            "FaustMonoDSP",
+            { module: faustDsp.dspModule, json: JSON.stringify(faustDsp.dspMeta) }
+        );
+    }
+
+    // Return an object with the Faust audio node, the number of voices, and the DSP metadata
+    return { faustNode, voices, dspMeta };
 }
 
 /**
  * @param {FaustAudioWorkletNode} faustNode 
  */
 const createFaustUI = async (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));
-	$container.style.minWidth = `${faustUI.minWidth}px`;
-	$container.style.minHeight = `${faustUI.minHeight}px`;
-	faustUI.resize();
+    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));
+    $container.style.minWidth = `${faustUI.minWidth}px`;
+    $container.style.minHeight = `${faustUI.minHeight}px`;
+    faustUI.resize();
 };
 
 (async () => {
-	const { faustNode, voices, dspMeta: { name } } = await createFaustNode(audioContext);
-	await createFaustUI(faustNode);
-	faustNode.connect(audioContext.destination);
-	if (faustNode.numberOfInputs) await buildAudioDeviceMenu(faustNode);
-	else $spanAudioInput.hidden = true;
-	if (voices && navigator.requestMIDIAccess) await buildMidiDeviceMenu(faustNode);
-	else $spanMidiInput.hidden = true;
-	$buttonDsp.disabled = false;
-	document.title = name;
+    const { faustNode, voices, dspMeta: { name } } = await createFaustNode(audioContext);
+    await createFaustUI(faustNode);
+    faustNode.connect(audioContext.destination);
+    if (faustNode.numberOfInputs) await buildAudioDeviceMenu(faustNode);
+    else $spanAudioInput.hidden = true;
+    if (voices && navigator.requestMIDIAccess) await buildMidiDeviceMenu(faustNode);
+    else $spanMidiInput.hidden = true;
+    $buttonDsp.disabled = false;
+    document.title = name;
 })();

package/assets/standalone/template-poly.html

@@ -0,0 +1,60 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <title>Faust DSP</title>
+</head>
+
+<body>
+    <main>
+        <span id="dsp-switch">
+            <center><button id="button-dsp">Activate DSP</button></center>
+        </span>
+    </main>
+    <script src="./template.js"></script>
+    <script>
+        (async () => {
+
+            // Create audio context
+            const AudioCtx = window.AudioContext || window.webkitAudioContext;
+            const audioContext = new AudioCtx();
+            audioContext.suspend();
+
+            // Create audio context activation button
+            const $buttonDsp = document.getElementById("button-dsp");
+
+			// Play some notes in loop
+            function play(node) {
+                node.keyOn(0, 60, 100);
+                setTimeout(() => node.keyOn(0, 64, 100), 1000);
+                setTimeout(() => node.keyOn(0, 67, 100), 2000);
+                setTimeout(() => node.allNotesOff(), 5000);
+                setTimeout(() => play(node), 7000);
+            }
+
+            // Activate audio context
+            $buttonDsp.disabled = true;
+            $buttonDsp.onclick = () => {
+                if (audioContext.state === "running") {
+                    $buttonDsp.textContent = "Suspended";
+                    audioContext.suspend();
+                } else if (audioContext.state === "suspended") {
+                    $buttonDsp.textContent = "Running";
+                    audioContext.resume();
+                    play(faustNode);
+                }
+            }
+
+            // Create Faust node
+            const { faustNode, voices, dspMeta: { name } } = await createFaustNode(audioContext);
+
+            // Connect Faust node to audio context
+            faustNode.connect(audioContext.destination);
+
+            // Create Faust node activation button
+            $buttonDsp.disabled = false;
+        })();
+    </script>
+</body>
+
+</html>

package/assets/standalone/template.html

@@ -0,0 +1,50 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <title>Faust DSP</title>
+</head>
+
+<body>
+    <main>
+        <span id="dsp-switch">
+            <center><button id="button-dsp">Activate DSP</button></center>
+        </span>
+    </main>
+    <script src="./template.js"></script>
+    <script>
+        (async () => {
+
+            // Create audio context
+            const AudioCtx = window.AudioContext || window.webkitAudioContext;
+            const audioContext = new AudioCtx();
+            audioContext.suspend();
+
+            // Create audio context activation button
+            const $buttonDsp = document.getElementById("button-dsp");
+
+            // Function to activate audio context
+            $buttonDsp.disabled = true;
+            $buttonDsp.onclick = () => {
+                if (audioContext.state === "running") {
+                    $buttonDsp.textContent = "Suspended";
+                    audioContext.suspend();
+                } else if (audioContext.state === "suspended") {
+                    $buttonDsp.textContent = "Running";
+                    audioContext.resume();
+                }
+            }
+
+            // Create Faust node
+            const { faustNode, voices, dspMeta: { name } } = await createFaustNode(audioContext);
+
+            // Connect Faust node to audio context
+            faustNode.connect(audioContext.destination);
+
+            // Create Faust node activation button
+            $buttonDsp.disabled = false;
+        })();
+    </script>
+</body>
+
+</html>

package/assets/standalone/template.js

@@ -0,0 +1,63 @@
+/**
+ * @typedef {import("./types").FaustDspDistribution} FaustDspDistribution
+ * @typedef {import("./faustwasm").FaustAudioWorkletNode} FaustAudioWorkletNode
+ * @typedef {import("./faustwasm").FaustDspMeta} FaustDspMeta
+*/
+
+/**
+ * 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.
+ * @returns {Object} - An object containing the Faust audio node, the number of voices (if polyphonic), and the DSP metadata.
+ */
+const createFaustNode = async (audioContext) => {
+    // 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("./dspMeta.json")).json();
+
+    // Compile the DSP module from WebAssembly binary data
+    const dspModule = await WebAssembly.compileStreaming(await fetch("./dspModule.wasm"));
+
+    // Create an object representing Faust DSP with metadata and module
+    /** @type {FaustDspDistribution} */
+    const faustDsp = { dspMeta, dspModule };
+
+    // Try to load optional mixer and effect modules
+    try {
+        faustDsp.mixerModule = await WebAssembly.compileStreaming(await fetch("./mixerModule.wasm"));
+        faustDsp.effectMeta = await (await fetch("./effectMeta.json")).json();
+        faustDsp.effectModule = await WebAssembly.compileStreaming(await fetch("./effectModule.wasm"));
+    } catch (e) { }
+
+    // Determine the number of voices based on the mixer module
+    const voices = faustDsp.mixerModule ? 64 : 0;
+
+    /** @type {FaustAudioWorkletNode} */
+    let faustNode;
+
+    // Create either a polyphonic or monophonic Faust audio node based on the number of voices
+    if (voices) {
+        const generator = new FaustPolyDspGenerator();
+        faustNode = await generator.createNode(
+            audioContext,
+            voices,
+            "FaustPolyDSP",
+            { module: faustDsp.dspModule, json: JSON.stringify(faustDsp.dspMeta) },
+            faustDsp.mixerModule,
+            faustDsp.effectModule ? { module: faustDsp.effectModule, json: JSON.stringify(faustDsp.effectMeta) } : undefined
+        );
+    } else {
+        const generator = new FaustMonoDspGenerator();
+        faustNode = await generator.createNode(
+            audioContext,
+            "FaustMonoDSP",
+            { module: faustDsp.dspModule, json: JSON.stringify(faustDsp.dspMeta) }
+        );
+    }
+
+    // Return an object with the Faust audio node, the number of voices, and the DSP metadata
+    return { faustNode, voices, dspMeta };
+}

package/dist/cjs/index.d.ts

@@ -1199,7 +1199,7 @@ export interface IFaustPolyDspGenerator {
 	 *
 	 * @param compiler - the Faust compiler
 	 * @param name - the DSP name
-	 * @param dspCode - the DSP code ('dsp_code' can possibly contain an integrated effect)
+	 * @param dspCode - the DSP code ('dspCode' can possibly contain an integrated effect)
 	 * @param args - the compilation parameters
 	 * @param effectCode - optional effect DSP code
 	 * @returns the compiled factory or 'null' if failure
@@ -1215,7 +1215,7 @@ export interface IFaustPolyDspGenerator {
 	 * @param voices - the number of voices
 	 * @param name - AudioWorklet Processor name
 	 * @param voiceFactory - the Faust factory for voices, either obtained with a compiler (createDSPFactory) or loaded from files (loadDSPFactory)
-	 * @param mixerModule - the wasm Mixer module (loaded from 'mixer32.wasm' or 'mixer64.wasm' files)
+	 * @param mixerModule - the wasm Mixer module (loaded from 'mixer32.wasm' or 'mixer64.wasm' files located in the 'faustwasm' package)
 	 * @param effectFactory - the Faust factory for the effect, either obtained with a compiler (createDSPFactory) or loaded from files (loadDSPFactory)
 	 * @param sp - whether to compile a ScriptProcessorNode or an AudioWorkletNode
 	 * @param bufferSize - the buffer size in frames to be used in ScriptProcessorNode only, since AudioWorkletNode always uses 128 frames