@grame/faustwasm 0.1.6 → 0.2.0

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

@@ -1,7 +1,6 @@
-// Generated by dts-bundle-generator v6.13.0
+// Generated by dts-bundle-generator v9.5.1
 
 /// <reference types="emscripten" />
-/// <reference types="node" />
 
 export type FaustModuleFactory = EmscriptenModuleFactory<FaustModule>;
 export interface FaustModule extends EmscriptenModule {
@@ -92,23 +91,26 @@ export interface LibFaustWasm {
 	 */
 	getInfos(what: FaustInfoType): string;
 }
+export interface FaustDspFactory extends Required<LooseFaustDspFactory> {
+}
 /**
  * The Factory structure.
- * cfactory: a "pointer" (as an integer) on the internal C++ factory
- * code: the WASM code as a binary array
- * module: the compule WASM module
- * json: the compiled DSP JSON description
- * poly: whether the factory is a polyphonic one or not
  */
-export interface FaustDspFactory extends Required<LooseFaustDspFactory> {
-}
 export interface LooseFaustDspFactory {
+	/** a "pointer" (as an integer) on the internal C++ factory */
 	cfactory?: number;
+	/** the WASM code as a binary array */
 	code?: Uint8Array;
+	/** the compule WASM module */
 	module: WebAssembly.Module;
+	/** the compiled DSP JSON description */
 	json: string;
+	/** whether the factory is a polyphonic one or not */
 	poly?: boolean;
+	/** a unique identifier */
 	shaKey?: string;
+	/** a map of transferable audio buffers for the `soundfile` function */
+	soundfiles: Record<string, (AudioData | null)>;
 }
 export interface FaustDspMeta {
 	name: string;
@@ -217,6 +219,10 @@ export declare const FFTUtils: {
 	/** Convert from Faust processor's output to direct audio output, real/imag are readonly, fft length = fftSize = (real/imag length - 1) * 2 */
 	signalToNoFFT: (real: Float32Array | Float64Array, imag: Float32Array | Float64Array, fft: Float32Array | Float64Array) => any;
 };
+export interface AudioData {
+	sampleRate: number;
+	audioBuffer: Float32Array[];
+}
 /**
  * Load libfaust-wasm files, than instantiate libFaust
  * @param jsFile path to `libfaust-wasm.js`
@@ -254,14 +260,14 @@ export interface IFaustDspInstance {
 	 *
 	 * @param $dsp - the DSP pointer
 	 * @param index - the parameter index
-	 * @preturn the parameter value
+	 * @return the parameter value
 	 */
 	getParamValue($dsp: number, index: number): number;
 	/**
 	 * Give the Faust wasm instance sample rate.
 	 *
 	 * @param $dsp - the DSP pointer
-	 * @preturn the sample rate
+	 * @return the sample rate
 	 */
 	getSampleRate($dsp: number): number;
 	/**
@@ -370,7 +376,32 @@ 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 {
+/** Definition of the AudioBufferItem type */
+export interface AudioBufferItem {
+	pathName: string;
+	audioBuffer: AudioBuffer;
+}
+/** Definition of the SoundfileItem type */
+export interface SoundfileItem {
+	/** Name of the soundfile */
+	name: string;
+	/** URL of the soundfile */
+	url: string;
+	/** Index in the DSP struct */
+	index: number;
+	/** Base pointer in wasm memory */
+	basePtr: number;
+}
+/**
+ * WasmAllocator is a basic memory management class designed to allocate
+ * blocks of memory within a WebAssembly.Memory object. It provides a simple
+ * alloc method to allocate a contiguous block of memory of a specified size.
+ *
+ * The allocator operates by keeping a linear progression through the memory,
+ * always allocating the next block at the end of the last. This approach does not
+ * handle freeing of memory or reuse of memory spaces.
+ */
+export declare class WasmAllocator {
 	private readonly memory;
 	private allocatedBytes;
 	constructor(memory: WebAssembly.Memory, offset: number);
@@ -414,7 +445,19 @@ declare class WasmAllocator {
 	 */
 	getFloat64Array(): Float64Array;
 }
-declare class Soundfile {
+/**
+ * Soundfile class to handle soundfile data in wasm memory.
+ */
+export declare class Soundfile {
+	/** Maximum number of soundfile parts. */
+	static get MAX_SOUNDFILE_PARTS(): number;
+	/** Maximum number of channels. */
+	static get MAX_CHAN(): number;
+	/** Maximum buffer size in frames. */
+	static get BUFFER_SIZE(): number;
+	/** Default sample rate. */
+	static get SAMPLE_RATE(): number;
+	/** Pointer to the soundfile structure in wasm memory */
 	private readonly fPtr;
 	private readonly fBuffers;
 	private readonly fLength;
@@ -427,9 +470,9 @@ declare class Soundfile {
 	constructor(allocator: WasmAllocator, 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;
+	copyToOut(part: number, maxChannels: number, offset: number, audioData: AudioData): void;
+	copyToOutReal32(maxChannels: number, offset: number, audioData: AudioData): void;
+	copyToOutReal64(maxChannels: number, offset: number, audioData: AudioData): void;
 	emptyFile(part: number, offset: number): number;
 	displayMemory(where?: string, mem?: boolean): void;
 	getPtr(): number;
@@ -437,62 +480,6 @@ declare class Soundfile {
 	getHEAPFloat32(): Float32Array;
 	getHEAPFloat64(): Float64Array;
 }
-declare class SoundfileReader {
-	private readonly fAllocator;
-	private readonly fSampleSize;
-	private readonly fContext;
-	private readonly fAudioBuffers;
-	constructor(allocator: WasmAllocator, context: BaseAudioContext, sampleSize: number);
-	/**
-	 * Check if the file exists.
-	 *
-	 * @param url : the url of the file to check
-	 * @returns : true if the file exists, otherwise false
-	 */
-	private checkFileExists;
-	/**
-	 * 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
-	 */
-	createSoundfile(pathNameList: string[], maxChan: number): 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
@@ -670,12 +657,6 @@ export interface IFaustPolyWebAudioDsp extends IFaustBaseWebAudioDsp {
 }
 export interface IFaustPolyWebAudioNode extends IFaustPolyWebAudioDsp, AudioNode {
 }
-export type SoundfileItem = {
-	name: string;
-	url: string;
-	index: number;
-	basePtr: number;
-};
 export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	protected fOutputHandler: OutputParamHandler | null;
 	protected fComputeHandler: ComputeHandler | null;
@@ -692,6 +673,8 @@ export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	protected fOutputsItems: string[];
 	protected fDescriptor: FaustUIInputItem[];
 	protected fSoundfiles: SoundfileItem[];
+	protected fSoundfileBuffers: LooseFaustDspFactory["soundfiles"];
+	/** Keep the end of memory offset before soundfiles */
 	protected fEndMemory: number;
 	protected fAudioInputs: number;
 	protected fAudioOutputs: number;
@@ -716,26 +699,28 @@ export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	protected fDestroyed: boolean;
 	protected fFirstCall: boolean;
 	protected fJSONDsp: FaustDspMeta;
-	constructor(sampleSize: number, bufferSize: number);
+	constructor(sampleSize: number, bufferSize: number, soundfiles: LooseFaustDspFactory["soundfiles"]);
 	static remap(v: number, mn0: number, mx0: number, mn1: number, mx1: number): number;
 	static parseUI(ui: FaustUIDescriptor, callback: (item: FaustUIItem) => any): void;
 	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[];
-	private extractURLsFromJSON;
+	/** Split the soundfile names and return an array of names */
+	static splitSoundfileNames(input: string): string[];
+	static extractUrlsFromMeta(dspMeta: FaustDspMeta): string[];
 	/**
 	 * Load a soundfile possibly containing several parts in the DSP struct.
 	 * Soundfile pointers are located at 'index' offset, to be read in the JSON file.
 	 * The DSP struct is located at baseDSP in the wasm memory,
 	 * either a monophonic DSP, or a voice in a polyphonic context.
 	 *
-	 * @param sfReader : the soundfile reader
+	 * @param allocator : the wasm memory allocator
 	 * @param baseDSP : the base DSP in the wasm memory
 	 * @param name : the name of the soundfile
 	 * @param url : the url of the soundfile
 	 */
 	private loadSoundfile;
+	createSoundfile(allocator: WasmAllocator, soundfileIdList: string[], soundfiles: LooseFaustDspFactory["soundfiles"], maxChan?: number): Soundfile;
 	/**
 	 * Init soundfiles memory.
 	 *
@@ -743,7 +728,7 @@ export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	 * @param sfReader : the soundfile reader
 	 * @param baseDSP : the DSP struct (either a monophonic DSP of polyphonic voice) base DSP in the wasm memory
 	*/
-	protected initSoundfileMemory(allocator: WasmAllocator, sfReader: SoundfileReader, baseDSP: number): Promise<void>;
+	protected initSoundfileMemory(allocator: WasmAllocator, baseDSP: number): void;
 	protected updateOutputs(): void;
 	metadata(handler: MetadataHandler): void;
 	compute(input: Float32Array[], output: Float32Array[]): boolean;
@@ -773,8 +758,7 @@ export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 export declare class FaustMonoWebAudioDsp extends FaustBaseWebAudioDsp implements IFaustMonoWebAudioDsp {
 	private fInstance;
 	private fDSP;
-	constructor(instance: FaustMonoDspInstance, sampleRate: number, sampleSize: number, bufferSize: number);
-	init(context: BaseAudioContext | null): Promise<void>;
+	constructor(instance: FaustMonoDspInstance, sampleRate: number, sampleSize: number, bufferSize: number, soundfiles: LooseFaustDspFactory["soundfiles"]);
 	private initMemory;
 	toString(): string;
 	compute(input: Float32Array[] | ((input: Float32Array[] | Float64Array[]) => any), output: Float32Array[] | ((output: Float32Array[] | Float64Array[]) => any)): boolean;
@@ -789,12 +773,12 @@ export declare class FaustMonoWebAudioDsp extends FaustBaseWebAudioDsp implement
 	getUI(): FaustUIDescriptor;
 }
 export declare class FaustWebAudioDspVoice {
-	static kActiveVoice: number;
-	static kFreeVoice: number;
-	static kReleaseVoice: number;
-	static kLegatoVoice: number;
-	static kNoVoice: number;
-	static VOICE_STOP_LEVEL: number;
+	static get kActiveVoice(): number;
+	static get kFreeVoice(): number;
+	static get kReleaseVoice(): number;
+	static get kLegatoVoice(): number;
+	static get kNoVoice(): number;
+	static get VOICE_STOP_LEVEL(): number;
 	private fFreqLabel;
 	private fGateLabel;
 	private fGainLabel;
@@ -828,8 +812,7 @@ export declare class FaustPolyWebAudioDsp extends FaustBaseWebAudioDsp implement
 	private fAudioMixing;
 	private fAudioMixingHalf;
 	private fVoiceTable;
-	constructor(instance: FaustPolyDspInstance, sampleRate: number, sampleSize: number, bufferSize: number);
-	init(context: BaseAudioContext | null): Promise<void>;
+	constructor(instance: FaustPolyDspInstance, sampleRate: number, sampleSize: number, bufferSize: number, soundfiles: LooseFaustDspFactory["soundfiles"]);
 	private initMemory;
 	toString(): string;
 	private allocVoice;
@@ -927,7 +910,6 @@ export interface FaustFFTAudioWorkletProcessorOptions {
 }
 export declare const getFaustFFTAudioWorkletProcessor: (dependencies: FaustFFTAudioWorkletProcessorDependencies, faustData: FaustFFTData, register?: boolean) => {
 	new (options: AudioWorkletNodeOptions): AudioWorkletProcessor;
-	/** Generated from the current window function */
 	prototype: AudioWorkletProcessor;
 	parameterDescriptors: AudioParamDescriptor[];
 };
@@ -1161,8 +1143,8 @@ export interface IFaustCmajor {
 	compile(name: string, code: string, args: string): string;
 }
 export declare class FaustCmajor implements IFaustCmajor {
-	private fLibFaust;
-	constructor(libfaust: LibFaust);
+	private fCompiler;
+	constructor(compiler: FaustCompiler);
 	compile(name: string, code: string, args: string): string;
 }
 export interface WavEncoderOptions {
@@ -1198,6 +1180,57 @@ export declare class WavDecoder {
 	private static decodeData;
 	private static readPCM;
 }
+/** Read metadata and fetch soundfiles */
+export declare class SoundfileReader {
+	static get fallbackPaths(): string[];
+	/**
+	 * Convert an audio buffer to audio data.
+	 *
+	 * @param audioBuffer : the audio buffer to convert
+	 * @returns : the audio data
+	 */
+	private static toAudioData;
+	/**
+	 * Extract the URLs from the metadata.
+	 *
+	 * @param dspMeta : the metadata
+	 * @returns : the URLs
+	 */
+	private static findSoundfilesFromMeta;
+	/**
+	 * Check if the file exists.
+	 *
+	 * @param url : the url of the file to check
+	 * @returns : true if the file exists, otherwise false
+	 */
+	private static checkFileExists;
+	/**
+	 * Fetch the soundfile.
+	 *
+	 * @param url : the url of the soundfile
+	 * @param audioCtx : the audio context
+	 * @returns : the audio data
+	 */
+	private static fetchSoundfile;
+	/**
+	 * Load the soundfile.
+	 *
+	 * @param filename : the filename
+	 * @param metaUrls : the metadata URLs
+	 * @param soundfiles : the soundfiles
+	 * @param audioCtx : the audio context
+	 */
+	private static loadSoundfile;
+	/**
+	 * Load the soundfiles, public API.
+	 *
+	 * @param dspMeta : the metadata
+	 * @param soundfilesIn : the soundfiles
+	 * @param audioCtx : the audio context
+	 * @returns : the soundfiles
+	 */
+	static loadSoundfiles(dspMeta: FaustDspMeta, soundfilesIn: LooseFaustDspFactory["soundfiles"], audioCtx: BaseAudioContext): Promise<LooseFaustDspFactory["soundfiles"]>;
+}
 declare const FaustAudioWorkletNode_base: {
 	new (context: BaseAudioContext, name: string, options?: AudioWorkletNodeOptions | undefined): AudioWorkletNode;
 	prototype: AudioWorkletNode;
@@ -1350,7 +1383,7 @@ export interface IFaustMonoDspGenerator {
 	 * @param factory - default is the compiled factory
 	 * @returns the compiled processor or 'null' if failure
 	 */
-	createOfflineProcessor(sampleRate: number, bufferSize: number, factory?: LooseFaustDspFactory, meta?: FaustDspMeta): Promise<IFaustMonoOfflineProcessor | null>;
+	createOfflineProcessor(sampleRate: number, bufferSize: number, factory?: LooseFaustDspFactory): Promise<IFaustMonoOfflineProcessor | null>;
 	/**
 	 * Get DSP JSON description with its UI and metadata as object.
 	 *
@@ -1398,7 +1431,7 @@ export interface IFaustPolyDspGenerator {
 	 * @param bufferSize - the buffer size in frames to be used in ScriptProcessorNode only, since AudioWorkletNode always uses 128 frames
 	 * @returns the compiled WebAudio node or 'null' if failure
 	 */
-	createNode(context: BaseAudioContext, voices: number, name?: string, voiceFactory?: LooseFaustDspFactory, mixerModule?: WebAssembly.Module, effectFactory?: LooseFaustDspFactory | null, sp?: boolean, bufferSize?: number): Promise<IFaustPolyWebAudioNode | null>;
+	createNode(context: BaseAudioContext, voices: number, name?: string, voiceFactory?: LooseFaustDspFactory, mixerModule?: WebAssembly.Module, effectFactory?: LooseFaustDspFactory | null, sp?: boolean, bufferSize?: number, processorName?: string): Promise<IFaustPolyWebAudioNode | null>;
 	/**
 	 * Create a monophonic Offline processor.
 	 *
@@ -1409,7 +1442,7 @@ export interface IFaustPolyDspGenerator {
 	 * @param effectFactory - the Faust factory for the effect, either obtained with a compiler (createDSPFactory) or loaded from files (loadDSPFactory)
 	 * @returns the compiled processor or 'null' if failure
 	 */
-	createOfflineProcessor(sampleRate: number, bufferSize: number, voices: number, voiceFactory?: LooseFaustDspFactory, mixerModule?: WebAssembly.Module, effectFactory?: LooseFaustDspFactory | null): Promise<IFaustPolyOfflineProcessor | null>;
+	createOfflineProcessor(sampleRate: number, bufferSize: number, voices: number, voiceFactory?: LooseFaustDspFactory, mixerModule?: WebAssembly.Module, effectFactory?: LooseFaustDspFactory | null, processorName?: string): Promise<IFaustPolyOfflineProcessor | null>;
 	/**
 	 * Get DSP JSON description with its UI and metadata as object.
 	 *