@grame/faustwasm 0.0.25 → 0.0.27

package/README.md

@@ -1,6 +1,6 @@
 # FaustWasm
 
-WebAssembly version of [Faust Compiler](https://github.com/grame-cncm/faust) for [Node.js](https://nodejs.org) and web browsers, built with [Emscripten](https://emscripten.org/) 3.1.31
+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.
 
 ## Usage
 
@@ -178,4 +178,89 @@ process = ba.pulsen(1, 10000) : pm.djembe(60, 0.3, 0.4, 1);
 })();
 ```
 
-The implementation description can be [read here](library.md).
+## Documentation
+
+-  [Organisation of the API](#org)
+
+  - [Faust Compiler WebAssembly module](#module)
+  - [Faust Compiler Javascript Interface](#compiler)
+  - [Faust Wasm Instance](#wasm)
+  - [Faust Audio Nodes Instances and Offline Processor ](#audio)
+  - [High-level API](#high)
+  - [How to use with typescript](#tsuse)
+- [Dynamic and Static Instances](#ds)
+- [Misc. services](#misc)
+- [Important note](#note)
+
+
+## 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>
+
+The first level is the Faust compiler compiled as a wasm library named `libfaust-wasm`.
+It consists in 3 different files:
+
+- `libfaust-wasm.wasm` : the Faust compiler provided as a WebAssembly module 
+- `libfaust-wasm.js` : a Javascript loader of the WebAssembly module
+- `libfaust-wasm.data` : a virtual file system containing the Faust libraries.
+
+The C++ code is compiled with [Emscripten](https://emscripten.org) and interfaced in `LibFaust.ts` and `types.ts`files. The loader will take care of providing an instance of the Faust WebAssembly module and of the associated virtual file system (libfaust-wasm.data).
+
+### Faust Compiler Javascript Interface <a name="compiler"></a>
+
+The Faust Compiler Javascript interface is described in `FaustCompiler.ts`.   
+It provides *classic* Faust compilation services, which output is a raw WebAssembly module with an associated JSON description of the module.
+
+### 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.   
+
+### 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.   
+  
+**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.
+
+Note that ScriptProcessor is marked as [deprecated](https://developer.mozilla.org/en-US/docs/Web/API/ScriptProcessorNode) but it's the only audio architecture available in older Safari versions. Both monophonic (generators, effects...) or polyphonic (instruments) nodes can be created. It is described in `FaustScriptProcessorNode.ts` file.
+
+By default, and to save CPU, created audio nodes are not processing audio buffers. They have to be explicitely started with the `start` method (and possibly stopped if needed using the `stop`method).
+
+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>
+
+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>
+
+Simply include the following to get access to types and functions:
+~~~~~~~~~~~~~~~
+///<reference types="@grame/faustwasm"/>
+~~~~~~~~~~~~~~~
+
+## 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.
+This allows to generate lighter and faster-loading HTML pages.
+
+## Misc. services <a name="misc"></a>
+
+- `FaustSvgDiagrams.ts`: provides facilities to browse Faust generated SVG diagrams
+- `FaustFFTAudioWorkletProcessor`: provides FFT processing
+
+## Important note <a name="note"></a>
+
+Html pages embedding the Faust compiler must be served using https, unless using http://localhost.
+
+----
+<a href="http://faust.grame.fr"><img src=https://faust.grame.fr/community/logos/img/LOGO_FAUST_COMPLET_ORANGE.png width=200 /></a>
+
+
+
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grame/faustwasm",
-  "version": "0.0.25",
+  "version": "0.0.27",
   "description": "WebAssembly version of Faust Compiler",
   "main": "dist/cjs/index.js",
   "types": "dist/esm/index.d.ts",
@@ -22,7 +22,9 @@
   },
   "keywords": [
     "faust",
-    "webassembly"
+    "webassembly",
+    "audio",
+    "signal processing"
   ],
   "author": "Grame-CNCM",
   "license": "LGPL-3.0",

package/library.md

@@ -1,91 +0,0 @@
-# Faust Web Audio Library
-
-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. This document provides an overview of the differents levels of the API. Examples of use are also provided in the `test` folder.
-
-
-## Table of Content
-
--  [Organisation of the API](#org)
-
-  - [Faust Compiler WebAssembly module](#module)
-  - [Faust Compiler Javascript Interface](#compiler)
-  - [Faust Wasm Instance](#wasm)
-  - [Faust Audio Nodes Instances and Offline Processor ](#audio)
-  - [High-level API](#high)
-  - [How to use with typescript](#tsuse)
-- [Dynamic and Static Instances](#ds)
-- [Misc. services](#misc)
-- [Important note](#note)
-
-
-## 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>
-
-The first level is the Faust compiler compiled as a wasm library named `libfaust-wasm`.
-It consists in 3 different files:
-
-- `libfaust-wasm.wasm` : the Faust compiler provided as a WebAssembly module 
-- `libfaust-wasm.js` : a Javascript loader of the WebAssembly module
-- `libfaust-wasm.data` : a virtual file system containing the Faust libraries.
-
-The C++ code is compiled with [Emscripten](https://emscripten.org) and interfaced in `LibFaust.ts` and `types.ts`files. The loader will take care of providing an instance of the Faust WebAssembly module and of the associated virtual file system (libfaust-wasm.data).
-
-### Faust Compiler Javascript Interface <a name="compiler"></a>
-
-The Faust Compiler Javascript interface is described in `FaustCompiler.ts`.   
-It provides *classic* Faust compilation services, which output is a raw WebAssembly module with an associated JSON description of the module.
-
-### 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.   
-
-### 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.   
-  
-**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.
-
-Note that ScriptProcessor is marked as [deprecated](https://developer.mozilla.org/en-US/docs/Web/API/ScriptProcessorNode) but it's the only audio architecture available in older Safari versions. Both monophonic (generators, effects...) or polyphonic (instruments) nodes can be created. It is described in `FaustScriptProcessorNode.ts` file.
-
-By default, and to save CPU, created audio nodes are not processing audio buffers. They have to be explicitely started with the `start` method (and possibly stopped if needed using the `stop`method).
-
-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>
-
-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>
-
-Simply include the following to get access to types and functions:
-~~~~~~~~~~~~~~~
-///<reference types="@grame/libfaust"/>
-~~~~~~~~~~~~~~~
-
-## 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.
-This allows to generate lighter and faster-loading HTML pages.
-
-## Misc. services <a name="misc"></a>
-
-- `FaustSvgDiagrams.ts`: provides facilities to browse Faust generated SVG diagrams
-- `FaustFFTAudioWorkletProcessor`: provides FFT processing
-
-## Important note <a name="note"></a>
-
-Html pages embedding the Faust compiler must be served using https, unless using http://localhost.
-
-----
-<a href="http://faust.grame.fr"><img src=https://faust.grame.fr/community/logos/img/LOGO_FAUST_COMPLET_ORANGE.png width=200 /></a>
-
-
-
-
-