@grame/faustwasm 0.0.29 → 0.0.32

package/README.md

@@ -16,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.
@@ -39,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.
@@ -47,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)
@@ -128,6 +147,7 @@ process = ba.pulsen(1, 10000) : pm.djembe(60, 0.3, 0.4, 1);
 ```
 
 ### Use in a web browser
+
 ```JavaScript
 
 (async () => {
@@ -195,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:
@@ -221,7 +241,7 @@ It provides *classic* Faust compilation services, which output is a raw WebAssem
 
 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.   
   
@@ -233,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.
@@ -255,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

@@ -1748,7 +1748,7 @@ var FaustWasmInstantiator = class {
         _min_f: Math.min,
         _remainderf: (x, y) => x - Math.round(x / y) * y,
         _powf: Math.pow,
-        _roundf: Math.fround,
+        _roundf: Math.round,
         _sinf: Math.sin,
         _sqrtf: Math.sqrt,
         _tanf: Math.tan,
@@ -1776,7 +1776,7 @@ var FaustWasmInstantiator = class {
         _min_: Math.min,
         _remainder: (x, y) => x - Math.round(x / y) * y,
         _pow: Math.pow,
-        _round: Math.fround,
+        _round: Math.round,
         _sin: Math.sin,
         _sqrt: Math.sqrt,
         _tan: Math.tan,