@grame/faustwasm 0.2.2 → 0.3.0

package/dist/cjs-bundle/index.d.ts

@@ -383,6 +383,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;
@@ -488,10 +494,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 {
 	/**
@@ -603,12 +609,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.
 	 *
@@ -621,6 +621,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.
 	 */
@@ -633,6 +639,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 {
 }
@@ -683,6 +697,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;
@@ -714,6 +730,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.
@@ -1105,6 +1129,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.
 	 *
@@ -1246,6 +1274,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[];
@@ -1255,6 +1284,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;
@@ -1268,6 +1299,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[];
@@ -1312,6 +1347,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;
@@ -1335,6 +1372,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 {
 }