@grame/faustwasm 0.14.2 → 0.15.0

package/package.json

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

package/src/FaustAudioWorkletNode.ts

@@ -1,4 +1,5 @@
 import {
+    InputParamHandler,
     OutputParamHandler,
     ComputeHandler,
     PlotHandler,
@@ -27,6 +28,7 @@ export class FaustAudioWorkletNode<
     protected fJSON: string;
     protected fInputsItems: string[];
     protected fOutputHandler: OutputParamHandler | null;
+    protected fInputHandler: InputParamHandler | null;
     protected fComputeHandler: ComputeHandler | null;
     protected fPlotHandler: PlotHandler | null;
     protected fUICallback: UIHandler;
@@ -60,6 +62,7 @@ export class FaustAudioWorkletNode<
         this.fJSONDsp = JSONObj;
         this.fJSON = factory.json;
         this.fOutputHandler = null;
+        this.fInputHandler = null;
         this.fComputeHandler = null;
         this.fPlotHandler = null;
         this.fDescriptor = [];
@@ -104,8 +107,10 @@ export class FaustAudioWorkletNode<
     }
 
     protected handleMessageAux = (e: MessageEvent) => {
-        if (e.data.type === 'param' && this.fOutputHandler) {
+        if (e.data.type === 'out-param' && this.fOutputHandler) {
             this.fOutputHandler(e.data.path, e.data.value);
+        } else if (e.data.type === 'in-param' && this.fInputHandler) {
+            this.fInputHandler(e.data.path, e.data.value);
         } else if (e.data.type === 'plot' && this.fPlotHandler) {
             this.fPlotHandler(e.data.value, e.data.index, e.data.events);
         }
@@ -187,8 +192,18 @@ export class FaustAudioWorkletNode<
     callOutputParamHandler(path: string, value: number) {
         if (this.fOutputHandler) {
             this.fOutputHandler(path, value);
-        } else {
-            console.warn('No OutputParamHandler set for this Faust node.');
+        }
+    }
+
+    setInputParamHandler(handler: InputParamHandler | null) {
+        this.fInputHandler = handler;
+    }
+    getInputParamHandler() {
+        return this.fInputHandler;
+    }
+    callInputParamHandler(path: string, value: number) {
+        if (this.fInputHandler) {
+            this.fInputHandler(path, value);
         }
     }
 

package/src/FaustAudioWorkletProcessor.ts

@@ -370,7 +370,10 @@ const getFaustAudioWorkletProcessor = <Poly extends boolean = false>(
 
             // Setup output handler
             this.fDSPCode.setOutputParamHandler((path, value) =>
-                this.port.postMessage({ path, value, type: 'param' })
+                this.port.postMessage({ path, value, type: 'out-param' })
+            );
+            this.fDSPCode.setInputParamHandler((path, value) =>
+                this.port.postMessage({ path, value, type: 'in-param' })
             );
 
             this.fDSPCode.start();
@@ -425,7 +428,10 @@ const getFaustAudioWorkletProcessor = <Poly extends boolean = false>(
 
             // Setup output handler
             this.fDSPCode.setOutputParamHandler((path, value) =>
-                this.port.postMessage({ path, value, type: 'param' })
+                this.port.postMessage({ path, value, type: 'out-param' })
+            );
+            this.fDSPCode.setInputParamHandler((path, value) =>
+                this.port.postMessage({ path, value, type: 'in-param' })
             );
 
             this.fDSPCode.start();

package/src/FaustFFTAudioWorkletProcessor.ts

@@ -768,7 +768,10 @@ const getFaustFFTAudioWorkletProcessor = (
 
             // Setup output handler
             this.fDSPCode.setOutputParamHandler((path, value) =>
-                this.port.postMessage({ path, value, type: 'param' })
+                this.port.postMessage({ path, value, type: 'out-param' })
+            );
+            this.fDSPCode.setInputParamHandler((path, value) =>
+                this.port.postMessage({ path, value, type: 'in-param' })
             );
             this.fDSPCode.setPlotHandler(this.fPlotHandler);
             const params = this.fDSPCode.getParams();

package/src/FaustOfflineProcessor.ts

@@ -6,6 +6,7 @@ import {
     IFaustBaseWebAudioDsp,
     IFaustMonoWebAudioDsp,
     IFaustPolyWebAudioDsp,
+    InputParamHandler,
     MetadataHandler,
     OutputParamHandler,
     PlotHandler
@@ -116,6 +117,16 @@ export class FaustOfflineProcessor<Poly extends boolean = false> {
         this.fDSPCode.callOutputParamHandler(path, value);
     }
 
+    setInputParamHandler(handler: InputParamHandler) {
+        this.fDSPCode.setInputParamHandler(handler);
+    }
+    getInputParamHandler() {
+        return this.fDSPCode.getInputParamHandler();
+    }
+    callInputParamHandler(path: string, value: number) {
+        this.fDSPCode.callInputParamHandler(path, value);
+    }
+
     setComputeHandler(handler: ComputeHandler) {
         this.fDSPCode.setComputeHandler(handler);
     }

package/src/FaustScriptProcessorNode.ts

@@ -4,6 +4,7 @@ import type {
     FaustPolyWebAudioDsp,
     IFaustMonoWebAudioDsp,
     IFaustPolyWebAudioDsp,
+    InputParamHandler,
     MetadataHandler,
     OutputParamHandler,
     PlotHandler
@@ -134,6 +135,16 @@ export class FaustScriptProcessorNode<
         this.fDSPCode.callOutputParamHandler(path, value);
     }
 
+    setInputParamHandler(handler: InputParamHandler) {
+        this.fDSPCode.setInputParamHandler(handler);
+    }
+    getInputParamHandler() {
+        return this.fDSPCode.getInputParamHandler();
+    }
+    callInputParamHandler(path: string, value: number) {
+        this.fDSPCode.callInputParamHandler(path, value);
+    }
+
     setComputeHandler(handler: ComputeHandler) {
         this.fDSPCode.setComputeHandler(handler);
     }

package/src/FaustWebAudioDsp.ts

@@ -20,6 +20,7 @@ import FaustSensors, {
 
 // Public API
 export type OutputParamHandler = (path: string, value: number) => void;
+export type InputParamHandler = (path: string, value: number) => void;
 export type ComputeHandler = (buffer_size: number) => void;
 export type PlotHandler = (
     plotted: Float32Array[] | Float64Array[],
@@ -444,6 +445,7 @@ export class Soundfile {
  * DSP implementation that mimic the C++ 'dsp' class:
  * - adding MIDI control: metadata are decoded and incoming MIDI messages will control the associated controllers
  * - an output handler can be set to treat produced output controllers (like 'bargraph')
+ * - an input handler can be set to follow control parameter changes (like sliders)
  * - regular controllers are handled using setParamValue/getParamValue and getParams methods
  */
 export interface IFaustBaseWebAudioDsp {
@@ -467,9 +469,30 @@ export interface IFaustBaseWebAudioDsp {
      * @param path - the path to the wanted parameter (retrieved using 'getParams' method)
      * @param value - the float value for the wanted control
      */
-
     callOutputParamHandler(path: string, value: number): void;
 
+    /**
+     * Set the parameter input handler, to be called when input parameters change (like sliders).
+     *
+     * @param handler - the input handler
+     */
+    setInputParamHandler(handler: InputParamHandler | null): void;
+
+    /**
+     * Get the parameter input handler.
+     *
+     * @return the current input handler
+     */
+    getInputParamHandler(): InputParamHandler | null;
+
+    /**
+     * Call the input parameter handler with a path and value.
+     *
+     * @param path - the path to the wanted parameter (retrieved using 'getParams' method)
+     * @param value - the float value for the wanted control
+     */
+    callInputParamHandler(path: string, value: number): void;
+
     /**
      * Set the compute handler, to  be called in the 'compute' method with buffer size.
      *
@@ -708,6 +731,7 @@ export interface IFaustPolyWebAudioNode
 
 export class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
     protected fOutputHandler: OutputParamHandler | null = null;
+    protected fInputHandler: InputParamHandler | null = null;
     protected fComputeHandler: ComputeHandler | null = null;
 
     // To handle MIDI events plot
@@ -1337,8 +1361,18 @@ export class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
     callOutputParamHandler(path: string, value: number) {
         if (this.fOutputHandler) {
             this.fOutputHandler(path, value);
-        } else {
-            console.warn('No OutputParamHandler set for this Faust node.');
+        }
+    }
+
+    setInputParamHandler(handler: InputParamHandler | null) {
+        this.fInputHandler = handler;
+    }
+    getInputParamHandler() {
+        return this.fInputHandler;
+    }
+    callInputParamHandler(path: string, value: number) {
+        if (this.fInputHandler) {
+            this.fInputHandler(path, value);
         }
     }
 
@@ -1551,6 +1585,7 @@ export class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
     destroy() {
         this.fDestroyed = true;
         this.fOutputHandler = null;
+        this.fInputHandler = null;
         this.fComputeHandler = null;
         this.fPlotHandler = null;
     }
@@ -1800,6 +1835,7 @@ export class FaustMonoWebAudioDsp
             this.fPathTable[path],
             value
         );
+        this.callInputParamHandler(path, this.getParamValue(path));
     }
     getParamValue(path: string) {
         return this.fInstance.api.getParamValue(
@@ -2403,6 +2439,7 @@ export class FaustPolyWebAudioDsp
                 voice.setParamValue(this.fPathTable[path], value)
             );
         }
+        this.callInputParamHandler(path, this.getParamValue(path));
     }
     getParamValue(path: string) {
         if (

package/test/faustlive-wasm/faustwasm/index.d.ts

@@ -413,6 +413,7 @@ export declare class FaustWasmInstantiator {
 	static createSyncPolyDSPInstance(voiceFactory: LooseFaustDspFactory, mixerModule: WebAssembly.Module, voices: number, effectFactory?: LooseFaustDspFactory): FaustPolyDspInstance;
 }
 export type OutputParamHandler = (path: string, value: number) => void;
+export type InputParamHandler = (path: string, value: number) => void;
 export type ComputeHandler = (buffer_size: number) => void;
 export type PlotHandler = (plotted: Float32Array[] | Float64Array[], index: number, events?: {
 	type: string;
@@ -534,6 +535,7 @@ export declare class Soundfile {
  * DSP implementation that mimic the C++ 'dsp' class:
  * - adding MIDI control: metadata are decoded and incoming MIDI messages will control the associated controllers
  * - an output handler can be set to treat produced output controllers (like 'bargraph')
+ * - an input handler can be set to follow control parameter changes (like sliders)
  * - regular controllers are handled using setParamValue/getParamValue and getParams methods
  */
 export interface IFaustBaseWebAudioDsp {
@@ -556,6 +558,25 @@ export interface IFaustBaseWebAudioDsp {
 	 * @param value - the float value for the wanted control
 	 */
 	callOutputParamHandler(path: string, value: number): void;
+	/**
+	 * Set the parameter input handler, to be called when input parameters change (like sliders).
+	 *
+	 * @param handler - the input handler
+	 */
+	setInputParamHandler(handler: InputParamHandler | null): void;
+	/**
+	 * Get the parameter input handler.
+	 *
+	 * @return the current input handler
+	 */
+	getInputParamHandler(): InputParamHandler | null;
+	/**
+	 * Call the input parameter handler with a path and value.
+	 *
+	 * @param path - the path to the wanted parameter (retrieved using 'getParams' method)
+	 * @param value - the float value for the wanted control
+	 */
+	callInputParamHandler(path: string, value: number): void;
 	/**
 	 * Set the compute handler, to  be called in the 'compute' method with buffer size.
 	 *
@@ -752,6 +773,7 @@ export interface IFaustPolyWebAudioNode extends IFaustPolyWebAudioDsp, AudioNode
 }
 export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	protected fOutputHandler: OutputParamHandler | null;
+	protected fInputHandler: InputParamHandler | null;
 	protected fComputeHandler: ComputeHandler | null;
 	protected fPlotHandler: PlotHandler | null;
 	protected fCachedEvents: {
@@ -857,6 +879,9 @@ export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	setOutputParamHandler(handler: OutputParamHandler | null): void;
 	getOutputParamHandler(): OutputParamHandler | null;
 	callOutputParamHandler(path: string, value: number): void;
+	setInputParamHandler(handler: InputParamHandler | null): void;
+	getInputParamHandler(): InputParamHandler | null;
+	callInputParamHandler(path: string, value: number): void;
 	setComputeHandler(handler: ComputeHandler | null): void;
 	getComputeHandler(): ComputeHandler | null;
 	setPlotHandler(handler: PlotHandler | null): void;
@@ -1211,6 +1236,9 @@ export declare class FaustOfflineProcessor<Poly extends boolean = false> {
 	setOutputParamHandler(handler: OutputParamHandler): void;
 	getOutputParamHandler(): OutputParamHandler | null;
 	callOutputParamHandler(path: string, value: number): void;
+	setInputParamHandler(handler: InputParamHandler): void;
+	getInputParamHandler(): InputParamHandler | null;
+	callInputParamHandler(path: string, value: number): void;
 	setComputeHandler(handler: ComputeHandler): void;
 	getComputeHandler(): ComputeHandler | null;
 	setPlotHandler(handler: PlotHandler): void;
@@ -1397,6 +1425,7 @@ export declare class FaustAudioWorkletNode<Poly extends boolean = false> extends
 	protected fJSON: string;
 	protected fInputsItems: string[];
 	protected fOutputHandler: OutputParamHandler | null;
+	protected fInputHandler: InputParamHandler | null;
 	protected fComputeHandler: ComputeHandler | null;
 	protected fPlotHandler: PlotHandler | null;
 	protected fUICallback: UIHandler;
@@ -1413,6 +1442,9 @@ export declare class FaustAudioWorkletNode<Poly extends boolean = false> extends
 	setOutputParamHandler(handler: OutputParamHandler | null): void;
 	getOutputParamHandler(): OutputParamHandler | null;
 	callOutputParamHandler(path: string, value: number): void;
+	setInputParamHandler(handler: InputParamHandler | null): void;
+	getInputParamHandler(): InputParamHandler | null;
+	callInputParamHandler(path: string, value: number): void;
 	setComputeHandler(handler: ComputeHandler | null): void;
 	getComputeHandler(): ComputeHandler | null;
 	setPlotHandler(handler: PlotHandler | null): void;
@@ -1485,6 +1517,9 @@ export declare class FaustScriptProcessorNode<Poly extends boolean = false> exte
 	setOutputParamHandler(handler: OutputParamHandler): void;
 	getOutputParamHandler(): OutputParamHandler | null;
 	callOutputParamHandler(path: string, value: number): void;
+	setInputParamHandler(handler: InputParamHandler): void;
+	getInputParamHandler(): InputParamHandler | null;
+	callInputParamHandler(path: string, value: number): void;
 	setComputeHandler(handler: ComputeHandler): void;
 	getComputeHandler(): ComputeHandler | null;
 	setPlotHandler(handler: PlotHandler): void;

package/test/faustlive-wasm/faustwasm/index.js

@@ -281,7 +281,10 @@ var getFaustAudioWorkletProcessor = (dependencies, faustData, register = true) =
       this.port.addEventListener("message", this.handleMessageAux);
       this.port.start();
       this.fDSPCode.setOutputParamHandler(
-        (path, value) => this.port.postMessage({ path, value, type: "param" })
+        (path, value) => this.port.postMessage({ path, value, type: "out-param" })
+      );
+      this.fDSPCode.setInputParamHandler(
+        (path, value) => this.port.postMessage({ path, value, type: "in-param" })
       );
       this.fDSPCode.start();
     }
@@ -331,7 +334,10 @@ var getFaustAudioWorkletProcessor = (dependencies, faustData, register = true) =
       this.port.addEventListener("message", this.handleMessageAux);
       this.port.start();
       this.fDSPCode.setOutputParamHandler(
-        (path, value) => this.port.postMessage({ path, value, type: "param" })
+        (path, value) => this.port.postMessage({ path, value, type: "out-param" })
+      );
+      this.fDSPCode.setInputParamHandler(
+        (path, value) => this.port.postMessage({ path, value, type: "in-param" })
       );
       this.fDSPCode.start();
     }
@@ -867,7 +873,10 @@ var getFaustFFTAudioWorkletProcessor = (dependencies, faustData, register = true
         this.soundfiles
       );
       this.fDSPCode.setOutputParamHandler(
-        (path, value) => this.port.postMessage({ path, value, type: "param" })
+        (path, value) => this.port.postMessage({ path, value, type: "out-param" })
+      );
+      this.fDSPCode.setInputParamHandler(
+        (path, value) => this.port.postMessage({ path, value, type: "in-param" })
       );
       this.fDSPCode.setPlotHandler(this.fPlotHandler);
       const params = this.fDSPCode.getParams();
@@ -2501,6 +2510,7 @@ var Soundfile = class _Soundfile {
 var FaustBaseWebAudioDsp = class _FaustBaseWebAudioDsp {
   constructor(sampleSize, bufferSize, soundfiles) {
     this.fOutputHandler = null;
+    this.fInputHandler = null;
     this.fComputeHandler = null;
     // To handle MIDI events plot
     this.fPlotHandler = null;
@@ -2923,8 +2933,17 @@ var FaustBaseWebAudioDsp = class _FaustBaseWebAudioDsp {
   callOutputParamHandler(path, value) {
     if (this.fOutputHandler) {
       this.fOutputHandler(path, value);
-    } else {
-      console.warn("No OutputParamHandler set for this Faust node.");
+    }
+  }
+  setInputParamHandler(handler) {
+    this.fInputHandler = handler;
+  }
+  getInputParamHandler() {
+    return this.fInputHandler;
+  }
+  callInputParamHandler(path, value) {
+    if (this.fInputHandler) {
+      this.fInputHandler(path, value);
     }
   }
   setComputeHandler(handler) {
@@ -3116,6 +3135,7 @@ var FaustBaseWebAudioDsp = class _FaustBaseWebAudioDsp {
   destroy() {
     this.fDestroyed = true;
     this.fOutputHandler = null;
+    this.fInputHandler = null;
     this.fComputeHandler = null;
     this.fPlotHandler = null;
   }
@@ -3257,6 +3277,7 @@ var FaustMonoWebAudioDsp = class extends FaustBaseWebAudioDsp {
       this.fPathTable[path],
       value
     );
+    this.callInputParamHandler(path, this.getParamValue(path));
   }
   getParamValue(path) {
     return this.fInstance.api.getParamValue(
@@ -3672,6 +3693,7 @@ var FaustPolyWebAudioDsp = class _FaustPolyWebAudioDsp extends FaustBaseWebAudio
         (voice) => voice.setParamValue(this.fPathTable[path], value)
       );
     }
+    this.callInputParamHandler(path, this.getParamValue(path));
   }
   getParamValue(path) {
     if (this.fJSONEffect && _FaustPolyWebAudioDsp.findPath(this.fJSONEffect.ui, path) && this.fInstance.effectAPI) {
@@ -3823,6 +3845,15 @@ var FaustOfflineProcessor = class {
   callOutputParamHandler(path, value) {
     this.fDSPCode.callOutputParamHandler(path, value);
   }
+  setInputParamHandler(handler) {
+    this.fDSPCode.setInputParamHandler(handler);
+  }
+  getInputParamHandler() {
+    return this.fDSPCode.getInputParamHandler();
+  }
+  callInputParamHandler(path, value) {
+    this.fDSPCode.callInputParamHandler(path, value);
+  }
   setComputeHandler(handler) {
     this.fDSPCode.setComputeHandler(handler);
   }
@@ -4728,8 +4759,10 @@ var FaustAudioWorkletNode = class extends (globalThis.AudioWorkletNode || null)
     __privateAdd(this, _hasAccInput, false);
     __privateAdd(this, _hasGyrInput, false);
     this.handleMessageAux = (e) => {
-      if (e.data.type === "param" && this.fOutputHandler) {
+      if (e.data.type === "out-param" && this.fOutputHandler) {
         this.fOutputHandler(e.data.path, e.data.value);
+      } else if (e.data.type === "in-param" && this.fInputHandler) {
+        this.fInputHandler(e.data.path, e.data.value);
       } else if (e.data.type === "plot" && this.fPlotHandler) {
         this.fPlotHandler(e.data.value, e.data.index, e.data.events);
       }
@@ -4753,6 +4786,7 @@ var FaustAudioWorkletNode = class extends (globalThis.AudioWorkletNode || null)
     this.fJSONDsp = JSONObj;
     this.fJSON = factory.json;
     this.fOutputHandler = null;
+    this.fInputHandler = null;
     this.fComputeHandler = null;
     this.fPlotHandler = null;
     this.fDescriptor = [];
@@ -4833,8 +4867,17 @@ var FaustAudioWorkletNode = class extends (globalThis.AudioWorkletNode || null)
   callOutputParamHandler(path, value) {
     if (this.fOutputHandler) {
       this.fOutputHandler(path, value);
-    } else {
-      console.warn("No OutputParamHandler set for this Faust node.");
+    }
+  }
+  setInputParamHandler(handler) {
+    this.fInputHandler = handler;
+  }
+  getInputParamHandler() {
+    return this.fInputHandler;
+  }
+  callInputParamHandler(path, value) {
+    if (this.fInputHandler) {
+      this.fInputHandler(path, value);
     }
   }
   setComputeHandler(handler) {
@@ -5129,6 +5172,15 @@ var FaustScriptProcessorNode = class extends (globalThis.ScriptProcessorNode ||
   callOutputParamHandler(path, value) {
     this.fDSPCode.callOutputParamHandler(path, value);
   }
+  setInputParamHandler(handler) {
+    this.fDSPCode.setInputParamHandler(handler);
+  }
+  getInputParamHandler() {
+    return this.fDSPCode.getInputParamHandler();
+  }
+  callInputParamHandler(path, value) {
+    this.fDSPCode.callInputParamHandler(path, value);
+  }
   setComputeHandler(handler) {
     this.fDSPCode.setComputeHandler(handler);
   }