@grame/faustwasm 0.0.28 → 0.0.30

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
 
@@ -14,12 +16,29 @@ git clone https://github.com/grame-cncm/faustwasm.git
 cd faustwasm
 ```
 
+Install development dependencies:
+
+```bash
+npm install
+```
+
+Possibly:
+
+```bash
+npm update
+```
+
 Build the files:
 ```bash
 npm run build
 ```
 
+### Versioning
+
+You'll have to raise the package version number in `package.json` before `npm run build` to properly work.
+
 #### Generate WebAssembly version of a Faust DSP
+
 For example:
 ```bash
 rm -rf test/out # make sure you are under the faustwasm directory.
@@ -37,6 +56,7 @@ node scripts/faust2wasm.js test/rev.dsp test/out -standalone
 ```
 
 #### Generate SVG Diagrams of a Faust DSP
+
 For example:
 ```bash
 rm -rf test/out # make sure you are under the faustwasm directory.
@@ -45,6 +65,7 @@ node scripts/faust2svg.js test/mono.dsp test/out
 The main diagram should be in `test/out/process.svg`.
 
 #### Generate or process audio files
+
 Options:
 - `-bs     <num>` to setup the rendering buffer size in frames (default: 64)
 - `-bd     16|24|32` to setup the output file bit-depth (default: 16)
@@ -126,6 +147,7 @@ process = ba.pulsen(1, 10000) : pm.djembe(60, 0.3, 0.4, 1);
 ```
 
 ### Use in a web browser
+
 ```JavaScript
 
 (async () => {
@@ -193,13 +215,13 @@ process = ba.pulsen(1, 10000) : pm.djembe(60, 0.3, 0.4, 1);
 - [Important note](#note)
 
 
-## Organisation of the API <a name="org"></a>
+### Organisation of the API <a name="org"></a>
 
 The API is organised from low to high level as illustrated by the figure below.
 
 <img src="rsrc/overview.png" class="mx-auto d-block" width="60%">
 
-### Faust Compiler WebAssembly module <a name="module"></a>
+#### Faust Compiler WebAssembly module <a name="module"></a>
 
 The first level is the Faust compiler compiled as a wasm library named `libfaust-wasm`.
 It consists in 3 different files:
@@ -217,11 +239,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>
+#### 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.
 
@@ -231,18 +253,18 @@ By default, and to save CPU, created audio nodes are not processing audio buffer
 
 An offline processor to render a DSP in a non real-time context and get the computed frames is available. It is described in `FaustOfflineProcessor.ts`. It will automatically use the `start` and `stop` methods internally to activate actual rendering in its `plot` method. 
 
-### High-level API <a name="high"></a>
+#### High-level API <a name="high"></a>
 
 A high-level API is available to compile a DSP program and create the audio node, either monophonic or polyphonic using `createNode`. Offline processing monophonic or polyphonic nodes can be created using `createOfflineProcessor`. FFT processing nodes can be created using `createFFTNode`. It is described in `FaustDspGenerator.ts`. 
 
-### How to use with typescript <a name="tsuse"></a>
+#### How to use with typescript <a name="tsuse"></a>
 
 Simply include the following to get access to types and functions:
 ~~~~~~~~~~~~~~~
 ///<reference types="@grame/faustwasm"/>
 ~~~~~~~~~~~~~~~
 
-## Dynamic and Static Instances <a name="ds"></a>
+### Dynamic and Static Instances <a name="ds"></a>
 
 The Faust Wasm and Audio Node levels make it possible to generate instances from Faust dsp code as well as from pre-compiled WebAssembly modules.
 In the latter case, it is not necessary to include the `libfaust-wasm.js` library, `index.js` is sufficient to provide the required services.
@@ -253,7 +275,7 @@ This allows to generate lighter and faster-loading HTML pages.
 - `FaustSvgDiagrams.ts`: provides facilities to browse Faust generated SVG diagrams
 - `FaustFFTAudioWorkletProcessor`: provides FFT processing
 
-## Important note <a name="note"></a>
+### Important note <a name="note"></a>
 
 Html pages embedding the Faust compiler must be served using https, unless using http://localhost.
 

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,