@grame/faustwasm 0.8.0 → 0.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grame/faustwasm",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "WebAssembly version of Faust Compiler",
   "main": "dist/cjs/index.js",
   "types": "dist/esm/index.d.ts",
@@ -39,7 +39,7 @@
   "homepage": "https://github.com/grame-cncm/faustwasm#readme",
   "devDependencies": {
     "@aws-crypto/sha256-js": "^5.2.0",
-    "@shren/faust-ui": "^1.1.13",
+    "@shren/faust-ui": "^1.1.16",
     "@types/node": "^20.12.7",
     "@types/webmidi": "^2.0.10",
     "@webaudiomodules/api": "^2.0.0-alpha.6",

package/src/FaustAudioWorkletNode.ts

@@ -95,21 +95,8 @@ export class FaustAudioWorkletNode<Poly extends boolean = false> extends (global
     async startSensors() {
         if (this.hasAccInput) {
             if (window.DeviceMotionEvent) {
-                if (typeof (window.DeviceMotionEvent as any).requestPermission === "function") { // for iOS 13+
-                    try {
-                        const response = await (window.DeviceMotionEvent as any).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);
-                }
+                // iOS 13+ requires a user gesture to enable DeviceMotionEvent, to be done in the main thread
+                window.addEventListener("devicemotion", this.handleDeviceMotion, true);
             } else {
                 // Browser doesn't support DeviceMotionEvent
                 console.log("Cannot set the accelerometer handler.");
@@ -117,21 +104,8 @@ export class FaustAudioWorkletNode<Poly extends boolean = false> extends (global
         }
         if (this.hasGyrInput) {
             if (window.DeviceMotionEvent) {
-                if (typeof (window.DeviceOrientationEvent as any).requestPermission === "function") { // for iOS 13+
-                    try {
-                        const response = await (window.DeviceOrientationEvent as any).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);
-                }
+                // iOS 13+ requires a user gesture to enable DeviceMotionEvent, to be done in the main thread
+                window.addEventListener("deviceorientation", this.handleDeviceOrientation, true);
             } else {
                 // Browser doesn't support DeviceMotionEvent
                 console.log("Cannot set the gyroscope handler.");
@@ -204,6 +178,8 @@ export class FaustAudioWorkletNode<Poly extends boolean = false> extends (global
         const data2 = data[2];
         if (cmd === 11) this.ctrlChange(channel, data1, data2);
         else if (cmd === 14) this.pitchWheel(channel, data2 * 128.0 + 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: data });
     }
 
@@ -215,6 +191,14 @@ export class FaustAudioWorkletNode<Poly extends boolean = false> extends (global
         const e = { type: "pitchWheel", data: [channel, wheel] };
         this.port.postMessage(e);
     }
+    keyOn(channel: number, pitch: number, velocity: number) {
+        const e = { type: "keyOn", data: [channel, pitch, velocity] };
+        this.port.postMessage(e);
+    }
+    keyOff(channel: number, pitch: number, velocity: number) {
+        const e = { type: "keyOff", data: [channel, pitch, velocity] };
+        this.port.postMessage(e);
+    }
 
     get hasAccInput() { return this.#hasAccInput; }
 

package/src/FaustAudioWorkletProcessor.ts

@@ -181,6 +181,14 @@ const getFaustAudioWorkletProcessor = <Poly extends boolean = false>(dependencie
                     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;
+                }
                 // Generic data message
                 case "param": {
                     this.setParamValue(msg.data.path, msg.data.value);
@@ -234,6 +242,14 @@ const getFaustAudioWorkletProcessor = <Poly extends boolean = false>(dependencie
             this.fDSPCode.pitchWheel(channel, wheel);
         }
 
+        protected keyOn(channel: number, pitch: number, velocity: number) {
+            this.fDSPCode.keyOn(channel, pitch, velocity);
+        }
+
+        protected keyOff(channel: number, pitch: number, velocity: number) {
+            this.fDSPCode.keyOff(channel, pitch, velocity);
+        }
+
         protected propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>, invert: boolean = false) {
             this.fDSPCode.propagateAcc(accelerationIncludingGravity, invert);
         }

package/src/FaustOfflineProcessor.ts

@@ -66,6 +66,8 @@ export class FaustOfflineProcessor<Poly extends boolean = false> {
 
     ctrlChange(chan: number, ctrl: number, value: number) { this.fDSPCode.ctrlChange(chan, ctrl, value); }
     pitchWheel(chan: number, value: number) { this.fDSPCode.pitchWheel(chan, value); }
+    keyOn(channel: number, pitch: number, velocity: number) { this.fDSPCode.keyOn(channel, pitch, velocity); }
+    keyOff(channel: number, pitch: number, velocity: number) { this.fDSPCode.keyOff(channel, pitch, velocity); }
 
     setParamValue(path: string, value: number) { this.fDSPCode.setParamValue(path, value); }
     getParamValue(path: string) { return this.fDSPCode.getParamValue(path); }

package/src/FaustScriptProcessorNode.ts

@@ -54,21 +54,8 @@ export class FaustScriptProcessorNode<Poly extends boolean = false> extends (glo
     async startSensors() {
         if (this.hasAccInput) {
             if (window.DeviceMotionEvent) {
-                if (typeof (window.DeviceMotionEvent as any).requestPermission === "function") { // for iOS 13+
-                    try {
-                        const response = await (window.DeviceMotionEvent as any).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);
-                }
+                // iOS 13+ requires a user gesture to enable DeviceMotionEvent, to be done in the main thread
+                window.addEventListener("devicemotion", this.handleDeviceMotion, true);
             } else {
                 // Browser doesn't support DeviceMotionEvent
                 console.log("Cannot set the accelerometer handler.");
@@ -76,21 +63,8 @@ export class FaustScriptProcessorNode<Poly extends boolean = false> extends (glo
         }
         if (this.hasGyrInput) {
             if (window.DeviceMotionEvent) {
-                if (typeof (window.DeviceOrientationEvent as any).requestPermission === "function") { // for iOS 13+
-                    try {
-                        const response = await (window.DeviceOrientationEvent as any).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);
-                }
+                // iOS 13+ requires a user gesture to enable DeviceMotionEvent, to be done in the main thread
+                window.addEventListener("deviceorientation", this.handleDeviceOrientation, true);
             } else {
                 // Browser doesn't support DeviceMotionEvent
                 console.log("Cannot set the gyroscope handler.");
@@ -128,6 +102,8 @@ export class FaustScriptProcessorNode<Poly extends boolean = false> extends (glo
 
     ctrlChange(chan: number, ctrl: number, value: number) { this.fDSPCode.ctrlChange(chan, ctrl, value); }
     pitchWheel(chan: number, value: number) { this.fDSPCode.pitchWheel(chan, value); }
+    keyOn(channel: number, pitch: number, velocity: number) { this.fDSPCode.keyOn(channel, pitch, velocity); }
+    keyOff(channel: number, pitch: number, velocity: number) { this.fDSPCode.keyOff(channel, pitch, velocity); }
 
     setParamValue(path: string, value: number) { this.fDSPCode.setParamValue(path, value); }
     getParamValue(path: string) { return this.fDSPCode.getParamValue(path); }

package/src/FaustWebAudioDsp.ts

@@ -444,6 +444,22 @@ export interface IFaustBaseWebAudioDsp {
      */
     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.
      *
@@ -612,6 +628,11 @@ export class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
     // MIDI handling
     protected fPitchwheelLabel: { path: string; chan: number; min: number; max: number }[] = [];
     protected fCtrlLabel: { path: string; chan: number; min: number; max: number }[][] = new Array(128).fill(null).map(() => []);
+    // array of MIDI key handlers; array index is the MIDI note number
+    protected fMidiKeyLabel: { path: string; chan: number; min: number; max: number }[][] = new Array(128).fill(null).map(() => []);
+    protected fMidiKeyOnLabel: { path: string; chan: number; min: number; max: number }[][] = new Array(128).fill(null).map(() => []);
+    protected fMidiKeyOffLabel: { path: string; chan: number; min: number; max: number }[][] = new Array(128).fill(null).map(() => []);
+
     protected fPathTable: { [address: string]: number } = {};
     protected fUICallback: UIHandler = (item: FaustUIItem) => {
         if (item.type === "hbargraph" || item.type === "vbargraph") {
@@ -643,10 +664,28 @@ export class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
                         const matched2 = strMidi.match(/^ctrl\s(\d+)\s(\d+)/);
                         // "ctrl num"
                         const matched1 = strMidi.match(/^ctrl\s(\d+)/);
+                        // match `key <note>[ <channel>]`
+                        const matchedKey = strMidi.match(/^key\s+(\d+)(?:\s+(\d+))?$/);
+                        //match `keyon <note>[ <channel>]`
+                        const matchedKeyOn = strMidi.match(/^keyon\s+(\d+)(?:\s+(\d+))?$/);
+                        //match `keyoff <note>[ <channel>]`
+                        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 as number, max: item.max as number });
                         } else if (matched1) {
                             this.fCtrlLabel[parseInt(matched1[1])].push({ path: item.address, chan: 0, min: item.min as number, max: item.max as number });
+                        } 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: item.min as number ?? 0, max: item.max as number ?? 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: item.min as number ?? 0, max: item.max as number ?? 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: item.min as number ?? 0, max: item.max as number ?? 1 });
                         }
                     }
                 }
@@ -964,6 +1003,15 @@ export class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
         const data2 = data[2];
         if (cmd === 11) return this.ctrlChange(channel, data1, data2);
         if (cmd === 14) return this.pitchWheel(channel, (data2 * 128.0 + 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: number, ctrl: number, value: number) {
@@ -980,6 +1028,46 @@ export class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
         }
     }
 
+    keyOn(channel: number, pitch: number, velocity: number) {
+        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));
+                // Typically used to reflect parameter change on GUI
+                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));
+                // Typically used to reflect parameter change on GUI
+                if (this.fOutputHandler) this.fOutputHandler(path, this.getParamValue(path));
+            }
+        });
+    }
+
+    keyOff(channel: number, pitch: number, velocity: number) {
+        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));
+                // Typically used to reflect parameter change on GUI
+                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);
+                // Typically used to reflect parameter change on GUI
+                if (this.fOutputHandler) this.fOutputHandler(path, this.getParamValue(path));
+            }
+        });
+    }
+
     pitchWheel(channel: number, wheel: number) {
         if (this.fPlotHandler) this.fCachedEvents.push({ type: "pitchWheel", data: [channel, wheel] });
         this.fPitchwheelLabel.forEach((pw) => {

package/src/copyWebStandaloneAssets.js

@@ -17,6 +17,7 @@ const copyWebStandaloneAssets = (outputDir, dspName, poly = false, effect = fals
     console.log(`Writing assets files.`)
     if (!fs.existsSync(outputDir)) fs.mkdirSync(outputDir);
 
+    // Define find and replace patterns
     const findAndReplace = ["FAUST_DSP_NAME", dspName];
     if (poly) findAndReplace.push("FAUST_DSP_VOICES = 0", "FAUST_DSP_VOICES = 16");
     if (poly && effect) findAndReplace.push("FAUST_DSP_HAS_EFFECT = false", "FAUST_DSP_HAS_EFFECT = true");
@@ -57,7 +58,18 @@ const copyWebPWAAssets = (outputDir, dspName, poly = false, effect = false) => {
     console.log(`Writing assets files.`)
     if (!fs.existsSync(outputDir)) fs.mkdirSync(outputDir);
 
+    // Generate VERSION_DATE
+    const now = new Date();
+    const VERSION_DATE = now.getFullYear().toString() +
+        ("0" + (now.getMonth() + 1)).slice(-2) +
+        ("0" + now.getDate()).slice(-2) + "-" +
+        ("0" + now.getHours()).slice(-2) +
+        ("0" + now.getMinutes()).slice(-2);
+
+    // Define find and replace patterns
     const findAndReplace = ["FAUST_DSP_NAME", dspName];
+    findAndReplace.push("VERSION_DATE", VERSION_DATE);
+
     if (poly) findAndReplace.push("FAUST_DSP_VOICES = 0", "FAUST_DSP_VOICES = 16");
     if (poly && effect) findAndReplace.push("FAUST_DSP_HAS_EFFECT = false", "FAUST_DSP_HAS_EFFECT = true");
 
@@ -97,7 +109,9 @@ const copyWebTemplateAssets = (outputDir, dspName, poly = false, effect = false)
     // Create output directory if it doesn't exist
     if (!fs.existsSync(outputDir)) fs.mkdirSync(outputDir);
 
+    // Define find and replace patterns
     const findAndReplace = ["FAUST_DSP_NAME", dspName];
+
     if (poly) findAndReplace.push("FAUST_DSP_VOICES = 0", "FAUST_DSP_VOICES = 16");
     if (poly && effect) findAndReplace.push("FAUST_DSP_HAS_EFFECT = false", "FAUST_DSP_HAS_EFFECT = true");
 

package/test/faustlive-wasm/faust-ui/index.js

@@ -946,10 +946,10 @@ class Group extends _AbstractComponent__WEBPACK_IMPORTED_MODULE_0__["default"] {
     if (!metaIn) return { metaObject };
     metaIn.forEach((m) => Object.assign(metaObject, m));
     if (metaObject.style) {
-      const enumsRegex = /\{(?:(?:'|_|-)(.+?)(?:'|_|-):([-+]?[0-9]*\.?[0-9]+?);)+(?:(?:'|_|-)(.+?)(?:'|_|-):([-+]?[0-9]*\.?[0-9]+?))\}/;
+      const enumsRegex = /\{(?:(?:'|_|-)(.+?)(?:'|_|-):([-+]?[0-9]*\.?[0-9]+);)+(?:(?:'|_|-)(.+?)(?:'|_|-):([-+]?[0-9]*\.?[0-9]+))\}/;
       const matched = metaObject.style.match(enumsRegex);
       if (matched) {
-        const itemsRegex = /(?:(?:'|_|-)(.+?)(?:'|_|-):([-+]?[0-9]*\.?[0-9]+?))/g;
+        const itemsRegex = /(?:(?:'|_|-)(.+?)(?:'|_|-):([-+]?[0-9]*\.?[0-9]+))/g;
         const enums = {};
         let item;
         while (item = itemsRegex.exec(matched[0])) {