@grame/faustwasm 0.2.0 → 0.2.2

package/package.json

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

package/src/FaustDspGenerator.ts

@@ -7,10 +7,24 @@ import { FaustMonoOfflineProcessor, FaustPolyOfflineProcessor, IFaustMonoOffline
 import { FaustMonoScriptProcessorNode, FaustPolyScriptProcessorNode } from "./FaustScriptProcessorNode";
 import { FaustBaseWebAudioDsp, FaustMonoWebAudioDsp, FaustPolyWebAudioDsp, FaustWebAudioDspVoice, IFaustMonoWebAudioNode, IFaustPolyWebAudioNode, Soundfile, WasmAllocator } from "./FaustWebAudioDsp";
 import type { IFaustCompiler } from "./FaustCompiler";
-import type { FaustDspFactory, FaustUIDescriptor, FaustDspMeta, FFTUtils, LooseFaustDspFactory } from "./types";
+import type { FaustDspFactory, FaustUIDescriptor, FaustDspMeta, FFTUtils, LooseFaustDspFactory, AudioData } from "./types";
 import SoundfileReader from "./SoundfileReader";
 
-export interface IFaustMonoDspGenerator {
+export interface GeneratorSupportingSoundfiles {
+    /**
+     * Attach a map of id - audio data, call after `compile()` before `createNode()`
+     * 
+     * @param soundfileMap a map of id - `AudioData` as an object where `AudioData` contains channel data as `audioBuffer: Float32Array[]` and `sampleRate: number`
+     */
+    addSoundfiles(soundfileMap: Record<string, AudioData>): void;
+
+    /**
+     * Get a list of soundfiles needed, call after `compile()`
+     */
+    getSoundfileList(): string[];
+}
+
+export interface IFaustMonoDspGenerator extends GeneratorSupportingSoundfiles {
     /**
      * Compile a monophonic DSP factory from given code.
      * 
@@ -26,6 +40,7 @@ export interface IFaustMonoDspGenerator {
         meta?: FaustDspMeta;
     } | null>;
 
+
     /**
      * Create a monophonic WebAudio node (either ScriptProcessorNode or AudioWorkletNode).
      *
@@ -72,12 +87,14 @@ export interface IFaustMonoDspGenerator {
      * @param sampleRate - the sample rate in Hz
      * @param bufferSize - the buffer size in frames
      * @param factory - default is the compiled factory
+     * @param context - if this exists, will be used to fetch soundfiles online
      * @returns the compiled processor or 'null' if failure
      */
     createOfflineProcessor(
         sampleRate: number,
         bufferSize: number,
-        factory?: LooseFaustDspFactory
+        factory?: LooseFaustDspFactory,
+        context?: BaseAudioContext
     ): Promise<IFaustMonoOfflineProcessor | null>;
 
     /**
@@ -102,7 +119,7 @@ export interface IFaustMonoDspGenerator {
     getUI(): FaustUIDescriptor;
 }
 
-export interface IFaustPolyDspGenerator {
+export interface IFaustPolyDspGenerator extends GeneratorSupportingSoundfiles {
     /**
      * Compile a monophonic DSP factory from given code.
      * 
@@ -151,6 +168,7 @@ export interface IFaustPolyDspGenerator {
      * @param voiceFactory - the Faust factory for voices, either obtained with a compiler (createDSPFactory) or loaded from files (loadDSPFactory)
      * @param mixerModule - the wasm Mixer module (loaded from 'mixer32.wasm' or 'mixer64.wasm' files)
      * @param effectFactory - the Faust factory for the effect, either obtained with a compiler (createDSPFactory) or loaded from files (loadDSPFactory)
+     * @param context - if this exists, will be used to fetch soundfiles online
      * @returns the compiled processor or 'null' if failure
      */
     createOfflineProcessor(
@@ -160,7 +178,7 @@ export interface IFaustPolyDspGenerator {
         voiceFactory?: LooseFaustDspFactory,
         mixerModule?: WebAssembly.Module,
         effectFactory?: LooseFaustDspFactory | null,
-        processorName?: string
+        context?: BaseAudioContext
     ): Promise<IFaustPolyOfflineProcessor | null>;
 
     /**
@@ -205,6 +223,19 @@ export class FaustMonoDspGenerator implements IFaustMonoDspGenerator {
         }
     }
 
+    addSoundfiles(soundfileMap: Record<string, AudioData>) {
+        if (!this.factory) throw new Error("Code is not compiled, please define the factory or call `await this.compile()` first.");
+        for (const id in soundfileMap) {
+            this.factory.soundfiles[id] = soundfileMap[id];
+        }
+    }
+    getSoundfileList() {
+        if (!this.factory) throw new Error("Code is not compiled, please define the factory or call `await this.compile()` first.");
+        const meta = JSON.parse(this.factory.json);
+        const map = SoundfileReader.findSoundfilesFromMeta(meta);
+        return Object.keys(map);
+    }
+
     async createNode<SP extends boolean = false>(
         context: BaseAudioContext,
         name = this.name,
@@ -394,13 +425,15 @@ const dependencies = {
     async createOfflineProcessor(
         sampleRate: number,
         bufferSize: number,
-        factory = this.factory as LooseFaustDspFactory
+        factory = this.factory as LooseFaustDspFactory,
+        context?: BaseAudioContext
     ) {
         if (!factory) throw new Error("Code is not compiled, please define the factory or call `await this.compile()` first.");
 
         const meta = JSON.parse(factory.json);
         const instance = await FaustWasmInstantiator.createAsyncMonoDSPInstance(factory);
         const sampleSize = meta.compile_options.match("-double") ? 8 : 4;
+        if (context) factory.soundfiles = await SoundfileReader.loadSoundfiles(meta, factory.soundfiles || {}, context);
         const monoDsp = new FaustMonoWebAudioDsp(instance, sampleRate, sampleSize, bufferSize, factory.soundfiles);
         return new FaustMonoOfflineProcessor(monoDsp, bufferSize);
     }
@@ -507,6 +540,22 @@ process = adaptorIns(dsp_code.process) : dsp_code.effect : adaptorOuts;
         }
     }
 
+    addSoundfiles(soundfileMap: Record<string, AudioData>) {
+        if (!this.voiceFactory) throw new Error("Code is not compiled, please define the factory or call `await this.compile()` first.");
+        for (const id in soundfileMap) {
+            this.voiceFactory.soundfiles[id] = soundfileMap[id];
+        }
+    }
+    getSoundfileList() {
+        if (!this.voiceFactory) throw new Error("Code is not compiled, please define the factory or call `await this.compile()` first.");
+        const meta = JSON.parse(this.voiceFactory.json);
+        const map = SoundfileReader.findSoundfilesFromMeta(meta);
+        if (!this.effectFactory) return Object.keys(map);
+        const effectMeta = JSON.parse(this.effectFactory.json);
+        const effectMap = SoundfileReader.findSoundfilesFromMeta(effectMeta);
+        return Object.keys({ ...effectMap, ...map });
+    }
+
     async createNode<SP extends boolean = false>(
         context: BaseAudioContext,
         voices: number,
@@ -631,7 +680,8 @@ const dependencies = {
         voices: number,
         voiceFactory = this.voiceFactory as LooseFaustDspFactory,
         mixerModule = this.mixerModule,
-        effectFactory = this.effectFactory as LooseFaustDspFactory | null
+        effectFactory = this.effectFactory as LooseFaustDspFactory | null,
+        context?: BaseAudioContext
     ) {
         if (!voiceFactory) throw new Error("Code is not compiled, please define the factory or call `await this.compile()` first.");
 
@@ -639,6 +689,10 @@ const dependencies = {
         const effectMeta = effectFactory ? JSON.parse(effectFactory.json) : undefined;
         const instance = await FaustWasmInstantiator.createAsyncPolyDSPInstance(voiceFactory, mixerModule, voices, effectFactory || undefined);
         const sampleSize = voiceMeta.compile_options.match("-double") ? 8 : 4;
+        if (context) {
+            voiceFactory.soundfiles = await SoundfileReader.loadSoundfiles(voiceMeta, voiceFactory.soundfiles || {}, context);
+            if (effectFactory) effectFactory.soundfiles = await SoundfileReader.loadSoundfiles(effectMeta, effectFactory.soundfiles || {}, context);
+        }
         const soundfiles = { ...effectFactory?.soundfiles, ...voiceFactory.soundfiles };
         const polyDsp = new FaustPolyWebAudioDsp(instance, sampleRate, sampleSize, bufferSize, soundfiles);
         return new FaustPolyOfflineProcessor(polyDsp, bufferSize);

package/src/SoundfileReader.ts

@@ -3,7 +3,7 @@ import type { AudioData, FaustDspMeta, FaustUIItem, LooseFaustDspFactory } from
 
 /** Read metadata and fetch soundfiles */
 class SoundfileReader {
-    static get fallbackPaths() { return [location.href, location.origin, "http://127.0.0.1:8000"]; }
+    static get fallbackPaths() { return [location.href, location.origin]; }
 
     /**
      * Convert an audio buffer to audio data.
@@ -25,7 +25,7 @@ class SoundfileReader {
      * @param dspMeta : the metadata
      * @returns : the URLs
      */
-    private static findSoundfilesFromMeta(dspMeta: FaustDspMeta): LooseFaustDspFactory["soundfiles"] {
+    static findSoundfilesFromMeta(dspMeta: FaustDspMeta): LooseFaustDspFactory["soundfiles"] {
         const soundfiles: LooseFaustDspFactory["soundfiles"] = {};
         const callback = (item: FaustUIItem) => {
             if (item.type === "soundfile") {

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

@@ -1196,7 +1196,7 @@ export declare class SoundfileReader {
 	 * @param dspMeta : the metadata
 	 * @returns : the URLs
 	 */
-	private static findSoundfilesFromMeta;
+	static findSoundfilesFromMeta(dspMeta: FaustDspMeta): LooseFaustDspFactory["soundfiles"];
 	/**
 	 * Check if the file exists.
 	 *
@@ -1336,7 +1336,19 @@ export declare class FaustPolyScriptProcessorNode extends FaustScriptProcessorNo
 	keyOff(channel: number, pitch: number, velocity: number): void;
 	allNotesOff(hard: boolean): void;
 }
-export interface IFaustMonoDspGenerator {
+export interface GeneratorSupportingSoundfiles {
+	/**
+	 * Attach a map of id - audio data, call after `compile()` before `createNode()`
+	 *
+	 * @param soundfileMap a map of id - `AudioData` as an object where `AudioData` contains channel data as `audioBuffer: Float32Array[]` and `sampleRate: number`
+	 */
+	addSoundfiles(soundfileMap: Record<string, AudioData>): void;
+	/**
+	 * Get a list of soundfiles needed, call after `compile()`
+	 */
+	getSoundfileList(): string[];
+}
+export interface IFaustMonoDspGenerator extends GeneratorSupportingSoundfiles {
 	/**
 	 * Compile a monophonic DSP factory from given code.
 	 *
@@ -1381,9 +1393,10 @@ export interface IFaustMonoDspGenerator {
 	 * @param sampleRate - the sample rate in Hz
 	 * @param bufferSize - the buffer size in frames
 	 * @param factory - default is the compiled factory
+	 * @param context - if this exists, will be used to fetch soundfiles online
 	 * @returns the compiled processor or 'null' if failure
 	 */
-	createOfflineProcessor(sampleRate: number, bufferSize: number, factory?: LooseFaustDspFactory): Promise<IFaustMonoOfflineProcessor | null>;
+	createOfflineProcessor(sampleRate: number, bufferSize: number, factory?: LooseFaustDspFactory, context?: BaseAudioContext): Promise<IFaustMonoOfflineProcessor | null>;
 	/**
 	 * Get DSP JSON description with its UI and metadata as object.
 	 *
@@ -1403,7 +1416,7 @@ export interface IFaustMonoDspGenerator {
 	 */
 	getUI(): FaustUIDescriptor;
 }
-export interface IFaustPolyDspGenerator {
+export interface IFaustPolyDspGenerator extends GeneratorSupportingSoundfiles {
 	/**
 	 * Compile a monophonic DSP factory from given code.
 	 *
@@ -1440,9 +1453,10 @@ export interface IFaustPolyDspGenerator {
 	 * @param voiceFactory - the Faust factory for voices, either obtained with a compiler (createDSPFactory) or loaded from files (loadDSPFactory)
 	 * @param mixerModule - the wasm Mixer module (loaded from 'mixer32.wasm' or 'mixer64.wasm' files)
 	 * @param effectFactory - the Faust factory for the effect, either obtained with a compiler (createDSPFactory) or loaded from files (loadDSPFactory)
+	 * @param context - if this exists, will be used to fetch soundfiles online
 	 * @returns the compiled processor or 'null' if failure
 	 */
-	createOfflineProcessor(sampleRate: number, bufferSize: number, voices: number, voiceFactory?: LooseFaustDspFactory, mixerModule?: WebAssembly.Module, effectFactory?: LooseFaustDspFactory | null, processorName?: string): Promise<IFaustPolyOfflineProcessor | null>;
+	createOfflineProcessor(sampleRate: number, bufferSize: number, voices: number, voiceFactory?: LooseFaustDspFactory, mixerModule?: WebAssembly.Module, effectFactory?: LooseFaustDspFactory | null, context?: BaseAudioContext): Promise<IFaustPolyOfflineProcessor | null>;
 	/**
 	 * Get DSP JSON description with its UI and metadata as object.
 	 *
@@ -1468,6 +1482,8 @@ export declare class FaustMonoDspGenerator implements IFaustMonoDspGenerator {
 	factory: FaustDspFactory | null;
 	constructor();
 	compile(compiler: IFaustCompiler, name: string, code: string, args: string): Promise<this | null>;
+	addSoundfiles(soundfileMap: Record<string, AudioData>): void;
+	getSoundfileList(): string[];
 	createNode<SP extends boolean = false>(context: BaseAudioContext, name?: string, factory?: LooseFaustDspFactory, sp?: SP, bufferSize?: number, processorName?: string): Promise<SP extends true ? FaustMonoScriptProcessorNode | null : FaustMonoAudioWorkletNode | null>;
 	createFFTNode(context: BaseAudioContext, fftUtils: typeof FFTUtils, name?: string, factory?: LooseFaustDspFactory, fftOptions?: Partial<FaustFFTOptionsData>, processorName?: string): Promise<FaustMonoAudioWorkletNode | null>;
 	createAudioWorkletProcessor(name?: string, factory?: LooseFaustDspFactory, processorName?: string): Promise<{
@@ -1475,7 +1491,7 @@ export declare class FaustMonoDspGenerator implements IFaustMonoDspGenerator {
 		prototype: AudioWorkletProcessor;
 		parameterDescriptors: AudioParamDescriptor[];
 	}>;
-	createOfflineProcessor(sampleRate: number, bufferSize: number, factory?: LooseFaustDspFactory): Promise<FaustMonoOfflineProcessor>;
+	createOfflineProcessor(sampleRate: number, bufferSize: number, factory?: LooseFaustDspFactory, context?: BaseAudioContext): Promise<FaustMonoOfflineProcessor>;
 	getMeta(): any;
 	getJSON(): string;
 	getUI(): any;
@@ -1489,13 +1505,15 @@ export declare class FaustPolyDspGenerator implements IFaustPolyDspGenerator {
 	mixerModule: WebAssembly.Module;
 	constructor();
 	compile(compiler: IFaustCompiler, name: string, dspCodeAux: string, args: string, effectCodeAux?: string): Promise<this | null>;
+	addSoundfiles(soundfileMap: Record<string, AudioData>): void;
+	getSoundfileList(): string[];
 	createNode<SP extends boolean = false>(context: BaseAudioContext, voices: number, name?: string, voiceFactory?: LooseFaustDspFactory, mixerModule?: WebAssembly.Module, effectFactory?: LooseFaustDspFactory | null, sp?: SP, bufferSize?: number, processorName?: string): Promise<SP extends true ? FaustPolyScriptProcessorNode | null : FaustPolyAudioWorkletNode | null>;
 	createAudioWorkletProcessor(name?: string, voiceFactory?: LooseFaustDspFactory, effectFactory?: LooseFaustDspFactory | null, processorName?: string): Promise<{
 		new (options: AudioWorkletNodeOptions): AudioWorkletProcessor;
 		prototype: AudioWorkletProcessor;
 		parameterDescriptors: AudioParamDescriptor[];
 	}>;
-	createOfflineProcessor(sampleRate: number, bufferSize: number, voices: number, voiceFactory?: LooseFaustDspFactory, mixerModule?: WebAssembly.Module, effectFactory?: LooseFaustDspFactory | null): Promise<FaustPolyOfflineProcessor>;
+	createOfflineProcessor(sampleRate: number, bufferSize: number, voices: number, voiceFactory?: LooseFaustDspFactory, mixerModule?: WebAssembly.Module, effectFactory?: LooseFaustDspFactory | null, context?: BaseAudioContext): Promise<FaustPolyOfflineProcessor>;
 	getMeta(): FaustDspMeta;
 	getJSON(): string;
 	getUI(): FaustUIDescriptor;

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

@@ -3111,7 +3111,7 @@ var WavDecoder_default = WavDecoder;
 // src/SoundfileReader.ts
 var SoundfileReader = class {
   static get fallbackPaths() {
-    return [location.href, location.origin, "http://127.0.0.1:8000"];
+    return [location.href, location.origin];
   }
   /**
    * Convert an audio buffer to audio data.
@@ -3544,6 +3544,20 @@ var _FaustMonoDspGenerator = class _FaustMonoDspGenerator {
       return null;
     }
   }
+  addSoundfiles(soundfileMap) {
+    if (!this.factory)
+      throw new Error("Code is not compiled, please define the factory or call `await this.compile()` first.");
+    for (const id in soundfileMap) {
+      this.factory.soundfiles[id] = soundfileMap[id];
+    }
+  }
+  getSoundfileList() {
+    if (!this.factory)
+      throw new Error("Code is not compiled, please define the factory or call `await this.compile()` first.");
+    const meta = JSON.parse(this.factory.json);
+    const map = SoundfileReader_default.findSoundfilesFromMeta(meta);
+    return Object.keys(map);
+  }
   async createNode(context, name = this.name, factory = this.factory, sp = false, bufferSize = 1024, processorName = (factory == null ? void 0 : factory.shaKey) || name) {
     var _a, _b;
     if (!factory)
@@ -3701,12 +3715,14 @@ const dependencies = {
       throw e;
     }
   }
-  async createOfflineProcessor(sampleRate, bufferSize, factory = this.factory) {
+  async createOfflineProcessor(sampleRate, bufferSize, factory = this.factory, context) {
     if (!factory)
       throw new Error("Code is not compiled, please define the factory or call `await this.compile()` first.");
     const meta = JSON.parse(factory.json);
     const instance = await FaustWasmInstantiator_default.createAsyncMonoDSPInstance(factory);
     const sampleSize = meta.compile_options.match("-double") ? 8 : 4;
+    if (context)
+      factory.soundfiles = await SoundfileReader_default.loadSoundfiles(meta, factory.soundfiles || {}, context);
     const monoDsp = new FaustMonoWebAudioDsp(instance, sampleRate, sampleSize, bufferSize, factory.soundfiles);
     return new FaustMonoOfflineProcessor(monoDsp, bufferSize);
   }
@@ -3796,6 +3812,24 @@ process = adaptorIns(dsp_code.process) : dsp_code.effect : adaptorOuts;
       return null;
     }
   }
+  addSoundfiles(soundfileMap) {
+    if (!this.voiceFactory)
+      throw new Error("Code is not compiled, please define the factory or call `await this.compile()` first.");
+    for (const id in soundfileMap) {
+      this.voiceFactory.soundfiles[id] = soundfileMap[id];
+    }
+  }
+  getSoundfileList() {
+    if (!this.voiceFactory)
+      throw new Error("Code is not compiled, please define the factory or call `await this.compile()` first.");
+    const meta = JSON.parse(this.voiceFactory.json);
+    const map = SoundfileReader_default.findSoundfilesFromMeta(meta);
+    if (!this.effectFactory)
+      return Object.keys(map);
+    const effectMeta = JSON.parse(this.effectFactory.json);
+    const effectMap = SoundfileReader_default.findSoundfilesFromMeta(effectMeta);
+    return Object.keys({ ...effectMap, ...map });
+  }
   async createNode(context, voices, name = this.name, voiceFactory = this.voiceFactory, mixerModule = this.mixerModule, effectFactory = this.effectFactory, sp = false, bufferSize = 1024, processorName = ((voiceFactory == null ? void 0 : voiceFactory.shaKey) || "") + ((effectFactory == null ? void 0 : effectFactory.shaKey) || "") || `${name}_poly`) {
     var _a, _b;
     if (!voiceFactory)
@@ -3890,13 +3924,18 @@ const dependencies = {
       throw e;
     }
   }
-  async createOfflineProcessor(sampleRate, bufferSize, voices, voiceFactory = this.voiceFactory, mixerModule = this.mixerModule, effectFactory = this.effectFactory) {
+  async createOfflineProcessor(sampleRate, bufferSize, voices, voiceFactory = this.voiceFactory, mixerModule = this.mixerModule, effectFactory = this.effectFactory, context) {
     if (!voiceFactory)
       throw new Error("Code is not compiled, please define the factory or call `await this.compile()` first.");
     const voiceMeta = JSON.parse(voiceFactory.json);
     const effectMeta = effectFactory ? JSON.parse(effectFactory.json) : void 0;
     const instance = await FaustWasmInstantiator_default.createAsyncPolyDSPInstance(voiceFactory, mixerModule, voices, effectFactory || void 0);
     const sampleSize = voiceMeta.compile_options.match("-double") ? 8 : 4;
+    if (context) {
+      voiceFactory.soundfiles = await SoundfileReader_default.loadSoundfiles(voiceMeta, voiceFactory.soundfiles || {}, context);
+      if (effectFactory)
+        effectFactory.soundfiles = await SoundfileReader_default.loadSoundfiles(effectMeta, effectFactory.soundfiles || {}, context);
+    }
     const soundfiles = { ...effectFactory == null ? void 0 : effectFactory.soundfiles, ...voiceFactory.soundfiles };
     const polyDsp = new FaustPolyWebAudioDsp(instance, sampleRate, sampleSize, bufferSize, soundfiles);
     return new FaustPolyOfflineProcessor(polyDsp, bufferSize);