@grame/faustwasm 0.2.2 → 0.3.0

package/README.md

@@ -283,6 +283,8 @@ This level takes a Faust Wasm instance to build an audio node. [AudioWorklet](ht
   
 **Warning**: AudioWorklet is a recent technology and may not be supported by all the browsers. Check the [compatibility](https://developer.mozilla.org/fr/docs/Web/API/AudioWorklet) chart.
 
+The audio node API documentation can be [accessed here](https://github.com/search?q=repo%3Agrame-cncm%2Ffaustwasm%20IFaustBaseWebAudioDsp&type=code).
+
 Note that ScriptProcessor is marked as [deprecated](https://developer.mozilla.org/en-US/docs/Web/API/ScriptProcessorNode) but it's the only audio architecture available in older Safari versions. Both monophonic (generators, effects...) or polyphonic (instruments) nodes can be created. It is described in `FaustScriptProcessorNode.ts` file.
 
 Created audio nodes have a `start` and `stop` methods. When started (which is done by default), they are processing audio buffers. You may have to explicitly stop them to save CPU (and start then again when needed), if for instance several nodes are created at init time before actual use. 

package/assets/standalone/faustwasm/index.d.ts

@@ -376,6 +376,12 @@ export type PlotHandler = (plotted: Float32Array[] | Float64Array[], index: numb
 }[]) => void;
 export type MetadataHandler = (key: string, value: string) => void;
 export type UIHandler = (item: FaustUIItem) => void;
+export type SensorEventHandler = (val: number) => void;
+export type SensorEventHandlers = {
+	x: SensorEventHandler[];
+	y: SensorEventHandler[];
+	z: SensorEventHandler[];
+};
 /** Definition of the AudioBufferItem type */
 export interface AudioBufferItem {
 	pathName: string;
@@ -481,10 +487,10 @@ export declare class Soundfile {
 	getHEAPFloat64(): Float64Array;
 }
 /**
- * DSP implementation: mimic the C++ 'dsp' class:
+ * 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')
- * - regular controllers are handled using setParamValue/getParamValue
+ * - regular controllers are handled using setParamValue/getParamValue and getParams methods
  */
 export interface IFaustBaseWebAudioDsp {
 	/**
@@ -596,12 +602,6 @@ export interface IFaustBaseWebAudioDsp {
 	 * @return the DSP JSON description as object
 	 */
 	getMeta(): FaustDspMeta;
-	/**
-	 * Get DSP JSON description with its UI and metadata.
-	 *
-	 * @return the DSP JSON description
-	 */
-	getJSON(): string;
 	/**
 	 * Get DSP UI description.
 	 *
@@ -614,6 +614,12 @@ export interface IFaustBaseWebAudioDsp {
 	* @return the DSP UI items description
 	*/
 	getDescriptors(): FaustUIInputItem[];
+	/**
+	 * Get DSP JSON description with its UI and metadata.
+	 *
+	 * @return the DSP JSON description
+	 */
+	getJSON(): string;
 	/**
 	 * Start the DSP.
 	 */
@@ -626,6 +632,14 @@ export interface IFaustBaseWebAudioDsp {
 	 * Destroy the DSP.
 	 */
 	destroy(): void;
+	/** Indicating if the DSP handles the accelerometer */
+	readonly hasAccInput: boolean;
+	/** Accelerometer handling */
+	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>): void;
+	/** Indicating if the DSP handles the gyroscope */
+	readonly hasGyrInput: boolean;
+	/** Gyroscope handling */
+	propagateGyr(event: Pick<DeviceOrientationEvent, "alpha" | "beta" | "gamma">): void;
 }
 export interface IFaustMonoWebAudioDsp extends IFaustBaseWebAudioDsp {
 }
@@ -676,6 +690,8 @@ export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	protected fSoundfileBuffers: LooseFaustDspFactory["soundfiles"];
 	/** Keep the end of memory offset before soundfiles */
 	protected fEndMemory: number;
+	protected fAcc: SensorEventHandlers;
+	protected fGyr: SensorEventHandlers;
 	protected fAudioInputs: number;
 	protected fAudioOutputs: number;
 	protected fBufferSize: number;
@@ -707,6 +723,14 @@ export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	static parseItem(item: FaustUIItem, callback: (item: FaustUIItem) => any): void;
 	/** Split the soundfile names and return an array of names */
 	static splitSoundfileNames(input: string): string[];
+	get hasAccInput(): boolean;
+	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>): void;
+	get hasGyrInput(): boolean;
+	propagateGyr(event: Pick<DeviceOrientationEvent, "alpha" | "beta" | "gamma">): void;
+	/** Build the accelerometer handler */
+	private setupAccHandler;
+	/** Build the gyroscope handler */
+	private setupGyrHandler;
 	static extractUrlsFromMeta(dspMeta: FaustDspMeta): string[];
 	/**
 	 * Load a soundfile possibly containing several parts in the DSP struct.
@@ -1098,6 +1122,10 @@ export declare class FaustOfflineProcessor<Poly extends boolean = false> {
 	start(): void;
 	stop(): void;
 	destroy(): void;
+	get hasAccInput(): boolean;
+	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>): void;
+	get hasGyrInput(): boolean;
+	propagateGyr(event: Pick<DeviceOrientationEvent, "alpha" | "beta" | "gamma">): void;
 	/**
 	 * Render frames in an array.
 	 *
@@ -1239,6 +1267,7 @@ declare const FaustAudioWorkletNode_base: {
  * Base class for Monophonic and Polyphonic AudioWorkletNode
  */
 export declare class FaustAudioWorkletNode<Poly extends boolean = false> extends FaustAudioWorkletNode_base {
+	#private;
 	protected fJSONDsp: FaustDspMeta;
 	protected fJSON: string;
 	protected fInputsItems: string[];
@@ -1248,6 +1277,8 @@ export declare class FaustAudioWorkletNode<Poly extends boolean = false> extends
 	protected fUICallback: UIHandler;
 	protected fDescriptor: FaustUIInputItem[];
 	constructor(context: BaseAudioContext, name: string, factory: LooseFaustDspFactory, options: FaustAudioWorkletNodeOptions<Poly>["processorOptions"], nodeOptions?: Partial<FaustAudioWorkletNodeOptions>);
+	/** Setup accelerometer and gyroscope handlers */
+	listenMotion(): Promise<void>;
 	setOutputParamHandler(handler: OutputParamHandler | null): void;
 	getOutputParamHandler(): OutputParamHandler | null;
 	setComputeHandler(handler: ComputeHandler | null): void;
@@ -1261,6 +1292,10 @@ export declare class FaustAudioWorkletNode<Poly extends boolean = false> extends
 	midiMessage(data: number[] | Uint8Array): void;
 	ctrlChange(channel: number, ctrl: number, value: number): void;
 	pitchWheel(channel: number, wheel: number): void;
+	get hasAccInput(): boolean;
+	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>): void;
+	get hasGyrInput(): boolean;
+	propagateGyr(event: Pick<DeviceOrientationEvent, "alpha" | "beta" | "gamma">): void;
 	setParamValue(path: string, value: number): void;
 	getParamValue(path: string): number;
 	getParams(): string[];
@@ -1305,6 +1340,8 @@ export declare class FaustScriptProcessorNode<Poly extends boolean = false> exte
 	protected fInputs: Float32Array[];
 	protected fOutputs: Float32Array[];
 	init(instance: Poly extends true ? FaustPolyWebAudioDsp : FaustMonoWebAudioDsp): void;
+	/** Setup accelerometer and gyroscope handlers */
+	listenMotion(): Promise<void>;
 	compute(input: Float32Array[], output: Float32Array[]): boolean;
 	setOutputParamHandler(handler: OutputParamHandler): void;
 	getOutputParamHandler(): OutputParamHandler | null;
@@ -1328,6 +1365,10 @@ export declare class FaustScriptProcessorNode<Poly extends boolean = false> exte
 	start(): void;
 	stop(): void;
 	destroy(): void;
+	get hasAccInput(): boolean;
+	propagateAcc(accelerationIncludingGravity: NonNullable<DeviceMotionEvent["accelerationIncludingGravity"]>): void;
+	get hasGyrInput(): boolean;
+	propagateGyr(event: Pick<DeviceOrientationEvent, "alpha" | "beta" | "gamma">): void;
 }
 export declare class FaustMonoScriptProcessorNode extends FaustScriptProcessorNode<false> implements IFaustMonoWebAudioDsp {
 }