@grame/faustwasm 0.0.66 → 0.1.0

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

@@ -131,6 +131,7 @@ export interface FaustUIInputItem {
 	type: FaustUIInputType;
 	label: string;
 	address: string;
+	url: string;
 	index: number;
 	init?: number;
 	min?: number;
@@ -158,7 +159,7 @@ export interface FaustUIMeta {
 }
 export type FaustUIGroupType = "vgroup" | "hgroup" | "tgroup";
 export type FaustUIOutputType = "hbargraph" | "vbargraph";
-export type FaustUIInputType = "vslider" | "hslider" | "button" | "checkbox" | "nentry";
+export type FaustUIInputType = "vslider" | "hslider" | "button" | "checkbox" | "nentry" | "soundfile";
 export interface FaustUIGroup {
 	type: FaustUIGroupType;
 	label: string;
@@ -355,9 +356,11 @@ export declare class FaustDspInstance implements IFaustDspInstance {
 }
 export declare class FaustWasmInstantiator {
 	private static createWasmImport;
-	private static createWasmMemory;
+	private static createWasmMemoryPoly;
+	private static createWasmMemoryMono;
 	private static createMonoDSPInstanceAux;
-	private static createMemoryAux;
+	private static createMemoryMono;
+	private static createMemoryPoly;
 	private static createMixerAux;
 	static loadDSPFactory(wasmPath: string, jsonPath: string): Promise<FaustDspFactory>;
 	static loadDSPMixer(mixerPath: string, fs?: typeof FS): Promise<WebAssembly.Module>;
@@ -374,6 +377,117 @@ export type PlotHandler = (plotted: Float32Array[] | Float64Array[], index: numb
 }[]) => void;
 export type MetadataHandler = (key: string, value: string) => void;
 export type UIHandler = (item: FaustUIItem) => void;
+declare class WasmAllocator {
+	private readonly memory;
+	private allocatedBytes;
+	constructor(memory: WebAssembly.Memory, offset: number);
+	/**
+	 * Allocates a block of memory of the specified size, returning the pointer to the
+	 * beginning of the block. The block is allocated at the current offset and the
+	 * offset is incremented by the size of the block.
+	 *
+	 * @param sizeInBytes The size of the block to allocate in bytes.
+	 * @returns The offset (pointer) to the beginning of the allocated block.
+	 */
+	alloc(sizeInBytes: number): number;
+	/**
+	 * Returns the underlying buffer object.
+	 *
+	 * @returns The buffer object.
+	 */
+	getBuffer(): ArrayBuffer;
+	/**
+	 * Returns the Int32 view of the underlying buffer object.
+	 *
+	 * @returns The view of the memory buffer as Int32Array.
+	 */
+	getInt32Array(): Int32Array;
+	/**
+	 * Returns the Float32 view of the underlying buffer object.
+	 *
+	 * @returns The view of the memory buffer as Float32Array.
+	 */
+	getFloat32Array(): Float32Array;
+	/**
+	 * Returns the Float64 view of the underlying buffer object..
+	 *
+	 * @returns The view of the memory buffer as Float64Array.
+	 */
+	getFloat64Array(): Float64Array;
+}
+declare class Soundfile {
+	private readonly fPtr;
+	private readonly fBuffers;
+	private readonly fLength;
+	private readonly fSR;
+	private readonly fOffset;
+	private readonly fSampleSize;
+	private readonly fPtrSize;
+	private readonly fAllocator;
+	constructor(allocator: WasmAllocator, ptrSize: number, sampleSize: number, curChan: number, length: number, maxChan: number, totalParts: number);
+	private allocBuffers;
+	shareBuffers(curChan: number, maxChan: number): void;
+	copyToOut(part: number, maxChannels: number, offset: number, buffer: AudioBuffer): void;
+	copyToOutReal32(maxChannels: number, offset: number, buffer: AudioBuffer): void;
+	copyToOutReal64(maxChannels: number, offset: number, buffer: AudioBuffer): void;
+	emptyFile(part: number, offset: number): number;
+	displayMemory(where?: string, mem?: boolean): void;
+	getPtr(): number;
+	getHEAP32(): Int32Array;
+	getHEAPFloat32(): Float32Array;
+	getHEAPFloat64(): Float64Array;
+}
+declare class SoundfileReader {
+	private readonly fAllocator;
+	private readonly fPtrSize;
+	private readonly fSampleSize;
+	private readonly fContext;
+	private readonly fAudioBuffers;
+	constructor(allocator: WasmAllocator, context: BaseAudioContext, ptrSize: number, sampleSize: number);
+	/**
+	 * Check if the file exists in the given directories.
+	 *
+	 * @param directories : the list of directories to search for the file
+	 * @param fileName : the name of the file to search for
+	 * @returns : the path of the file if found, otherwise an empty string
+	 */
+	private checkFile;
+	/**
+	 * Check if all soundfiles exist and return their real path_name.
+	 *
+	 * @param directories : the list of directories to search for the file
+	 * @param fileNameList : the list of file names to search for
+	 * @returns : the list of path names of the files if found, otherwise an empty string
+	 */
+	checkFiles(directories: string[], fileNameList: string[]): Promise<string[]>;
+	/**
+	 * Get the channels and length values of the given sound resource.
+	 *
+	 * @param pathName : the name of the file, or sound resource identified this way
+	 * @returns channels and length of the soundfile
+	 */
+	private getParamsFile;
+	/**
+	 * Read one sound resource and fill the 'soundfile' structure accordingly
+	 *
+	 * @param soundfile - the soundfile to be filled
+	 * @param pathName - the name of the file, or sound resource identified this way
+	 * @param part - the part number to be filled in the soundfile
+	 * @param maxChan - the maximum number of mono channels to fill
+	 *
+	 * @returns the offset in the soundfile buffer
+	 *
+	 */
+	private readFile;
+	/**
+	 * Crate a soundfile, load all parts and copy audio data to the wasm soundfile buffer.
+	 * @param pathNameList : list of soundfile paths
+	 * @param maxChan : maximum number of channels
+	 * @param isDouble : whether the soundfile will be copied as double
+	 */
+	createSoundfile(pathNameList: string[], maxChan: number, isDouble: boolean): Promise<Soundfile | null>;
+	getHEAP32(): Int32Array;
+}
 /**
  * DSP implementation: mimic the C++ 'dsp' class:
  * - adding MIDI control: metadata are decoded and incoming MIDI messages will control the associated controllers
@@ -551,6 +665,11 @@ export interface IFaustPolyWebAudioDsp extends IFaustBaseWebAudioDsp {
 }
 export interface IFaustPolyWebAudioNode extends IFaustPolyWebAudioDsp, AudioNode {
 }
+export type SoundfileItem = {
+	name: string;
+	url: string;
+	basePtr: number;
+};
 export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	protected fOutputHandler: OutputParamHandler | null;
 	protected fComputeHandler: ComputeHandler | null;
@@ -566,11 +685,13 @@ export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	protected fInputsItems: string[];
 	protected fOutputsItems: string[];
 	protected fDescriptor: FaustUIInputItem[];
+	protected fSoundfiles: SoundfileItem[];
+	protected fEndMemory: number;
 	protected fAudioInputs: number;
 	protected fAudioOutputs: number;
 	protected fBufferSize: number;
-	protected gPtrSize: number;
-	protected gSampleSize: number;
+	protected fPtrSize: number;
+	protected fSampleSize: number;
 	protected fPitchwheelLabel: {
 		path: string;
 		min: number;
@@ -587,6 +708,7 @@ export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	protected fUICallback: UIHandler;
 	protected fProcessing: boolean;
 	protected fDestroyed: boolean;
+	protected fFirstCall: boolean;
 	protected fJSONDsp: FaustDspMeta;
 	constructor(sampleSize: number, bufferSize: number);
 	static remap(v: number, mn0: number, mx0: number, mn1: number, mx1: number): number;
@@ -594,6 +716,23 @@ export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	static parseGroup(group: FaustUIGroup, callback: (item: FaustUIItem) => any): void;
 	static parseItems(items: FaustUIItem[], callback: (item: FaustUIItem) => any): void;
 	static parseItem(item: FaustUIItem, callback: (item: FaustUIItem) => any): void;
+	static splitNames(input: string): string[];
+	/**
+	 *  Load a soundfile possibly containing several parts.
+	 *
+	 * @param sfReader : the soundfile reader
+	 * @param sfOffset : the offset in the wasm memory
+	 * @param name : the name of the soundfile
+	 * @param url : the url of the soundfile
+	 */
+	private loadSoundfile;
+	/**
+	 * Init soundfiles memory.
+	 *
+	 * Soundfile pointers are located at the beginning of the DSP struct memory (one after the other),
+	 * so that the TS scode can setup them easily.
+	*/
+	protected initSoundfileMemory(allocator: WasmAllocator, sfReader: SoundfileReader, baseDSP: number): Promise<void>;
 	protected updateOutputs(): void;
 	metadata(handler: MetadataHandler): void;
 	compute(input: Float32Array[], output: Float32Array[]): boolean;
@@ -615,6 +754,7 @@ export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	getJSON(): string;
 	getUI(): FaustUIDescriptor;
 	getDescriptors(): FaustUIInputItem[];
+	hasSoundfiles(): boolean;
 	start(): void;
 	stop(): void;
 	destroy(): void;
@@ -623,6 +763,7 @@ export declare class FaustMonoWebAudioDsp extends FaustBaseWebAudioDsp implement
 	private fInstance;
 	private fDSP;
 	constructor(instance: FaustMonoDspInstance, sampleRate: number, sampleSize: number, bufferSize: number);
+	init(context: BaseAudioContext | null): Promise<void>;
 	private initMemory;
 	toString(): string;
 	compute(input: Float32Array[] | ((input: Float32Array[] | Float64Array[]) => any), output: Float32Array[] | ((output: Float32Array[] | Float64Array[]) => any)): boolean;
@@ -677,6 +818,7 @@ export declare class FaustPolyWebAudioDsp extends FaustBaseWebAudioDsp implement
 	private fAudioMixingHalf;
 	private fVoiceTable;
 	constructor(instance: FaustPolyDspInstance, sampleRate: number, sampleSize: number, bufferSize: number);
+	init(context: BaseAudioContext | null): Promise<void>;
 	private initMemory;
 	toString(): string;
 	private allocVoice;
@@ -774,7 +916,8 @@ export interface FaustFFTAudioWorkletProcessorOptions {
 }
 export declare const getFaustFFTAudioWorkletProcessor: (dependencies: FaustFFTAudioWorkletProcessorDependencies, faustData: FaustFFTData, register?: boolean) => {
 	new (options: AudioWorkletNodeOptions): AudioWorkletProcessor;
-	prototype: AudioWorkletProcessor; /** Generated from the current window function */
+	/** Generated from the current window function */
+	prototype: AudioWorkletProcessor;
 	parameterDescriptors: AudioParamDescriptor[];
 };
 export interface ILibFaust extends LibFaustWasm {