@grame/faustwasm 0.0.28 → 0.0.29

package/README.md

@@ -1,6 +1,8 @@
 # FaustWasm
 
-The Faust Web Audio library provides a high level Javascript API over the [Faust](https://faust.grame.fr) compiler. The interface is designed to be used with [TypeScript](https://www.typescriptlang.org/), but describes and documents the API for pure Javascript as well. The WebAssembly version of [Faust Compiler](https://github.com/grame-cncm/faust) is for [Node.js](https://nodejs.org) and web browsers, built with [Emscripten](https://emscripten.org/) 3.1.31.
+The FaustWasm library presents a convenient, high-level API that wraps around [Faust](https://faust.grame.fr) compiler. This library's interface is primarily designed for [TypeScript](https://www.typescriptlang.org/) usage, although it also provides API descriptions and documentation for pure JavaScript. The WebAssembly version of the Faust Compiler, compatible with both [Node.js](https://nodejs.org) and web browsers, has been compiled using [Emscripten](https://emscripten.org/) 3.1.31.
+
+The library offers functionality for compiling Faust DSP code into WebAssembly, enabling its utilization as WebAudio nodes within a standard WebAudio node graph. Moreover, it supports offline rendering scenarios. Furthermore, supplementary tools can be employed for generating SVGs from Faust DSP programs.
 
 ## Usage
 
@@ -217,11 +219,11 @@ It provides *classic* Faust compilation services, which output is a raw WebAssem
 
 ### Faust Wasm Instance <a name="wasm"></a>
 
-This level takes a WebAssembly module produced by the Faust compiler or a precompiled module loaded from a file, and builds an instance of this module with the proper Wasm memory layout, ready to run, but not yet connected to any audio node. It is described in `FaustDspGenerator.ts`, `FaustWasmInstantiator.ts`, `FaustWebAudioDsp.ts` and `FaustDspInstance.ts` files.   
+This level takes a WebAssembly module produced by the Faust compiler or a precompiled module loaded from a file, and builds an instance of this module with the proper Wasm memory layout, ready to run. It is described in `FaustDspGenerator.ts`, `FaustWasmInstantiator.ts`, `FaustWebAudioDsp.ts` and `FaustDspInstance.ts` files.   
 
 ### Faust Audio Nodes Instances and Offline Processor <a name="audio"></a>
 
-This level takes a Faust Wasm instance to build an audio node. [AudioWorklet](https://developer.mozilla.org/fr/docs/Web/API/AudioWorklet) and [ScriptProcessor](https://developer.mozilla.org/en-US/docs/Web/API/ScriptProcessorNode) nodes are supported.  It is described in `FaustAudioWorkletNode.ts` and `FaustAudioWorkletProcessor.ts` files.   
+This level takes a Faust Wasm instance to build an audio node. [AudioWorklet](https://developer.mozilla.org/fr/docs/Web/API/AudioWorklet) and [ScriptProcessor](https://developer.mozilla.org/en-US/docs/Web/API/ScriptProcessorNode) nodes are supported. It is described in `FaustAudioWorkletNode.ts` and `FaustAudioWorkletProcessor.ts` files.   
   
 **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.
 

package/assets/standalone/faustwasm/index.js

@@ -1723,7 +1723,6 @@ var FaustDspInstance = class {
     this.fExports.setParamValue($dsp, index, value);
   }
 };
-var FaustDspInstance_default = FaustDspInstance;
 
 // src/FaustWasmInstantiator.ts
 var FaustWasmInstantiator = class {
@@ -1813,7 +1812,7 @@ var FaustWasmInstantiator = class {
   }
   static createMonoDSPInstanceAux(instance, json) {
     const functions = instance.exports;
-    const api = new FaustDspInstance_default(functions);
+    const api = new FaustDspInstance(functions);
     const memory = instance.exports.memory;
     return { memory, api, json };
   }
@@ -1876,12 +1875,12 @@ var FaustWasmInstantiator = class {
     const memory = this.createMemoryAux(voices, voiceFactory, effectFactory);
     const voiceInstance = await WebAssembly.instantiate(voiceFactory.module, this.createWasmImport(memory));
     const voiceFunctions = voiceInstance.exports;
-    const voiceAPI = new FaustDspInstance_default(voiceFunctions);
+    const voiceAPI = new FaustDspInstance(voiceFunctions);
     const mixerAPI = this.createMixerAux(mixerModule, memory);
     if (effectFactory) {
       const effectInstance = await WebAssembly.instantiate(effectFactory.module, this.createWasmImport(memory));
       const effectFunctions = effectInstance.exports;
-      const effectAPI = new FaustDspInstance_default(effectFunctions);
+      const effectAPI = new FaustDspInstance(effectFunctions);
       return {
         memory,
         voices,
@@ -1905,12 +1904,12 @@ var FaustWasmInstantiator = class {
     const memory = this.createMemoryAux(voices, voiceFactory, effectFactory);
     const voiceInstance = new WebAssembly.Instance(voiceFactory.module, this.createWasmImport(memory));
     const voiceFunctions = voiceInstance.exports;
-    const voiceAPI = new FaustDspInstance_default(voiceFunctions);
+    const voiceAPI = new FaustDspInstance(voiceFunctions);
     const mixerAPI = this.createMixerAux(mixerModule, memory);
     if (effectFactory) {
       const effectInstance = new WebAssembly.Instance(effectFactory.module, this.createWasmImport(memory));
       const effectFunctions = effectInstance.exports;
-      const effectAPI = new FaustDspInstance_default(effectFunctions);
+      const effectAPI = new FaustDspInstance(effectFunctions);
       return {
         memory,
         voices,
@@ -3499,15 +3498,15 @@ const faustData = ${JSON.stringify({
             poly: false
           })};
 // Implementation needed classes of functions
-const ${FaustDspInstance_default.name}_default = ${FaustDspInstance_default.toString()}
+const ${FaustDspInstance.name} = ${FaustDspInstance.toString()}
 const ${FaustBaseWebAudioDsp.name} = ${FaustBaseWebAudioDsp.toString()}
 const ${FaustMonoWebAudioDsp.name} = ${FaustMonoWebAudioDsp.toString()}
 const ${FaustWasmInstantiator_default.name} = ${FaustWasmInstantiator_default.toString()}
 // Put them in dependencies
 const dependencies = {
-    ${FaustBaseWebAudioDsp.name},
-    ${FaustMonoWebAudioDsp.name},
-    ${FaustWasmInstantiator_default.name}
+    FaustBaseWebAudioDsp: ${FaustBaseWebAudioDsp.name},
+    FaustMonoWebAudioDsp: ${FaustMonoWebAudioDsp.name},
+    FaustWasmInstantiator: ${FaustWasmInstantiator_default.name}
 };
 // Generate the actual AudioWorkletProcessor code
 (${FaustAudioWorkletProcessor_default.toString()})(dependencies, faustData);
@@ -3542,16 +3541,16 @@ const faustData = ${JSON.stringify({
           fftOptions
         })};
 // Implementation needed classes of functions
-const ${FaustDspInstance_default.name}_default = ${FaustDspInstance_default.toString()}
+const ${FaustDspInstance.name} = ${FaustDspInstance.toString()}
 const ${FaustBaseWebAudioDsp.name} = ${FaustBaseWebAudioDsp.toString()}
 const ${FaustMonoWebAudioDsp.name} = ${FaustMonoWebAudioDsp.toString()}
 const ${FaustWasmInstantiator_default.name} = ${FaustWasmInstantiator_default.toString()}
 const FFTUtils = ${fftUtils.toString()}
 // Put them in dependencies
 const dependencies = {
-    ${FaustBaseWebAudioDsp.name},
-    ${FaustMonoWebAudioDsp.name},
-    ${FaustWasmInstantiator_default.name},
+    FaustBaseWebAudioDsp: ${FaustBaseWebAudioDsp.name},
+    FaustMonoWebAudioDsp: ${FaustMonoWebAudioDsp.name},
+    FaustWasmInstantiator: ${FaustWasmInstantiator_default.name},
     FFTUtils
 };
 // Generate the actual AudioWorkletProcessor code
@@ -3678,16 +3677,16 @@ const faustData = ${JSON.stringify({
             effectMeta
           })};
 // Implementation needed classes of functions
-const ${FaustDspInstance_default.name}_default = ${FaustDspInstance_default.toString()}
+const ${FaustDspInstance.name} = ${FaustDspInstance.toString()}
 const ${FaustBaseWebAudioDsp.name} = ${FaustBaseWebAudioDsp.toString()}
 const ${FaustPolyWebAudioDsp.name} = ${FaustPolyWebAudioDsp.toString()}
 const ${FaustWebAudioDspVoice.name} = ${FaustWebAudioDspVoice.toString()}
 const ${FaustWasmInstantiator_default.name} = ${FaustWasmInstantiator_default.toString()}
 // Put them in dependencies
 const dependencies = {
-    ${FaustBaseWebAudioDsp.name},
-    ${FaustPolyWebAudioDsp.name},
-    ${FaustWasmInstantiator_default.name}
+    FaustBaseWebAudioDsp: ${FaustBaseWebAudioDsp.name},
+    FaustPolyWebAudioDsp: ${FaustPolyWebAudioDsp.name},
+    FaustWasmInstantiator: ${FaustWasmInstantiator_default.name}
 };
 // Generate the actual AudioWorkletProcessor code
 (${FaustAudioWorkletProcessor_default.toString()})(dependencies, faustData);
@@ -3747,7 +3746,7 @@ export {
   FaustAudioWorkletNode,
   FaustBaseWebAudioDsp,
   FaustCompiler_default as FaustCompiler,
-  FaustDspInstance_default as FaustDspInstance,
+  FaustDspInstance,
   FaustMonoAudioWorkletNode,
   FaustMonoDspGenerator,
   FaustMonoOfflineProcessor,