@grame/faustwasm 0.0.27 → 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
 
@@ -72,12 +74,12 @@ node scripts/faust2sndfile.js test/rev.dsp test/out/p-dj-rev.wav -c 192000 -sr 4
 ### Use the JavaScript Module
 
 ```bash
-npm i -D @shren/faustwasm
+npm i -D @grame/faustwasm
 ```
 
 In JavaScript:
 ```JavaScript
-const FaustWasm = require("@shren/faustwasm");
+const FaustWasm = require("@grame/faustwasm");
 const path = require("path");
 const fs = require("fs");
 
@@ -91,7 +93,7 @@ const {
 } = FaustWasm;
 
 (async () => {
-    const faustModulePath = path.join(__dirname, "../node_modules/@shren/faustwasm/ libfaust-wasm/libfaust-wasm.js");
+    const faustModulePath = path.join(__dirname, "../node_modules/@grame/faustwasm/libfaust-wasm/libfaust-wasm.js");
 
     // initialize the libfaust wasm
     const faustModule = await instantiateFaustModuleFromFile(faustModulePath);
@@ -136,10 +138,10 @@ process = ba.pulsen(1, 10000) : pm.djembe(60, 0.3, 0.4, 1);
         FaustMonoDspGenerator,
         FaustCompiler,
         FaustSvgDiagrams
-    } = await import("../node_modules/@shren/faustwasm/dist/esm/index.js");
+    } = await import("../node_modules/@grame/faustwasm/dist/esm/index.js");
 
     // initialize the libfaust wasm
-    const faustModule = await instantiateFaustModuleFromFile("../node_modules/@shren/faustwasm/libfaust-wasm/libfaust-wasm.js");
+    const faustModule = await instantiateFaustModuleFromFile("../node_modules/@grame/faustwasm/libfaust-wasm/libfaust-wasm.js");
 
     // Get the Faust compiler
     const libFaust = new LibFaust(faustModule);
@@ -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.d.ts

@@ -3,7 +3,7 @@
 /// <reference types="emscripten" />
 /// <reference types="node" />
 
-export declare type FaustModuleFactory = EmscriptenModuleFactory<FaustModule>;
+export type FaustModuleFactory = EmscriptenModuleFactory<FaustModule>;
 export interface FaustModule extends EmscriptenModule {
 	ccall: typeof ccall;
 	cwrap: typeof cwrap;
@@ -22,7 +22,7 @@ export interface FaustModule extends EmscriptenModule {
 	FS: typeof FS;
 	libFaustWasm: new () => LibFaustWasm;
 }
-export declare type FaustInfoType = "help" | "version" | "libdir" | "includedir" | "archdir" | "dspdir" | "pathslist";
+export type FaustInfoType = "help" | "version" | "libdir" | "includedir" | "archdir" | "dspdir" | "pathslist";
 export interface IntVector {
 	size(): number;
 	get(i: number): number;
@@ -125,8 +125,8 @@ export interface FaustDspMeta {
 	}[];
 	ui: FaustUIDescriptor;
 }
-export declare type FaustUIDescriptor = FaustUIGroup[];
-export declare type FaustUIItem = FaustUIInputItem | FaustUIOutputItem | FaustUIGroup;
+export type FaustUIDescriptor = FaustUIGroup[];
+export type FaustUIItem = FaustUIInputItem | FaustUIOutputItem | FaustUIGroup;
 export interface FaustUIInputItem {
 	type: FaustUIInputType;
 	label: string;
@@ -156,15 +156,15 @@ export interface FaustUIMeta {
 	hidden?: string;
 	[key: string]: string | undefined;
 }
-export declare type FaustUIGroupType = "vgroup" | "hgroup" | "tgroup";
-export declare type FaustUIOutputType = "hbargraph" | "vbargraph";
-export declare type FaustUIInputType = "vslider" | "hslider" | "button" | "checkbox" | "nentry";
+export type FaustUIGroupType = "vgroup" | "hgroup" | "tgroup";
+export type FaustUIOutputType = "hbargraph" | "vbargraph";
+export type FaustUIInputType = "vslider" | "hslider" | "button" | "checkbox" | "nentry";
 export interface FaustUIGroup {
 	type: FaustUIGroupType;
 	label: string;
 	items: FaustUIItem[];
 }
-export declare type FaustUIType = FaustUIGroupType | FaustUIOutputType | FaustUIInputType;
+export type FaustUIType = FaustUIGroupType | FaustUIOutputType | FaustUIInputType;
 export interface AudioParamDescriptor {
 	automationRate?: AutomationRate;
 	defaultValue?: number;
@@ -198,12 +198,12 @@ export interface InterfaceFFT {
 export declare const InterfaceFFT: {
 	new (size: number): InterfaceFFT;
 };
-export declare type TWindowFunction = (index: number, length: number, ...args: any[]) => number;
-export declare type Writeable<T> = {
+export type TWindowFunction = (index: number, length: number, ...args: any[]) => number;
+export type Writeable<T> = {
 	-readonly [P in keyof T]: T[P];
 };
-export declare type TypedArray = Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Uint8ClampedArray | Float32Array | Float64Array;
-export declare type TypedArrayConstructor = typeof Int8Array | typeof Uint8Array | typeof Int16Array | typeof Uint16Array | typeof Int32Array | typeof Uint32Array | typeof Uint8ClampedArray | typeof Float32Array | typeof Float64Array;
+export type TypedArray = Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Uint8ClampedArray | Float32Array | Float64Array;
+export type TypedArrayConstructor = typeof Int8Array | typeof Uint8Array | typeof Int16Array | typeof Uint16Array | typeof Int32Array | typeof Uint32Array | typeof Uint8ClampedArray | typeof Float32Array | typeof Float64Array;
 export declare const FFTUtils: {
 	/** Inject window functions as array, no need to add rectangular (no windowing) */
 	windowFunctions?: TWindowFunction[];
@@ -359,14 +359,14 @@ export declare class FaustWasmInstantiator {
 	static createAsyncPolyDSPInstance(voiceFactory: LooseFaustDspFactory, mixerModule: WebAssembly.Module, voices: number, effectFactory?: LooseFaustDspFactory): Promise<FaustPolyDspInstance>;
 	static createSyncPolyDSPInstance(voiceFactory: LooseFaustDspFactory, mixerModule: WebAssembly.Module, voices: number, effectFactory?: LooseFaustDspFactory): FaustPolyDspInstance;
 }
-export declare type OutputParamHandler = (path: string, value: number) => void;
-export declare type ComputeHandler = (buffer_size: number) => void;
-export declare type PlotHandler = (plotted: Float32Array[] | Float64Array[], index: number, events?: {
+export type OutputParamHandler = (path: string, value: number) => void;
+export type ComputeHandler = (buffer_size: number) => void;
+export type PlotHandler = (plotted: Float32Array[] | Float64Array[], index: number, events?: {
 	type: string;
 	data: any;
 }[]) => void;
-export declare type MetadataHandler = (key: string, value: string) => void;
-export declare type UIHandler = (item: FaustUIItem) => void;
+export type MetadataHandler = (key: string, value: string) => void;
+export type UIHandler = (item: FaustUIItem) => void;
 /**
  * DSP implementation: mimic the C++ 'dsp' class:
  * - adding MIDI control: metadata are decoded and incoming MIDI messages will control the associated controllers

package/assets/standalone/faustwasm/index.js

@@ -15,7 +15,10 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 
 // node_modules/tslib/tslib.js
 var require_tslib = __commonJS({
@@ -846,8 +849,8 @@ var require_jsSha256 = __commonJS({
         return this.hash.digest();
       };
       Sha2563.prototype.digest = function() {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function() {
-          return (0, tslib_1.__generator)(this, function(_a) {
+        return tslib_1.__awaiter(this, void 0, void 0, function() {
+          return tslib_1.__generator(this, function(_a) {
             return [2, this.digestSync()];
           });
         });
@@ -875,7 +878,7 @@ var require_build2 = __commonJS({
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     var tslib_1 = require_tslib();
-    (0, tslib_1.__exportStar)(require_jsSha256(), exports);
+    tslib_1.__exportStar(require_jsSha256(), exports);
   }
 });
 
@@ -1720,7 +1723,6 @@ var FaustDspInstance = class {
     this.fExports.setParamValue($dsp, index, value);
   }
 };
-var FaustDspInstance_default = FaustDspInstance;
 
 // src/FaustWasmInstantiator.ts
 var FaustWasmInstantiator = class {
@@ -1802,13 +1804,15 @@ var FaustWasmInstantiator = class {
       return n;
     };
     const effectSize = effectMeta ? effectMeta.size : 0;
-    let memorySize = pow2limit(effectSize + dspMeta.size * voices + (dspMeta.inputs + dspMeta.outputs * 2) * (ptrSize + bufferSize * sampleSize)) / 65536;
+    let memorySize = pow2limit(
+      effectSize + dspMeta.size * voices + (dspMeta.inputs + dspMeta.outputs * 2) * (ptrSize + bufferSize * sampleSize)
+    ) / 65536;
     memorySize = Math.max(2, memorySize);
     return new WebAssembly.Memory({ initial: memorySize, maximum: memorySize });
   }
   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 };
   }
@@ -1871,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,
@@ -1900,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,
@@ -2316,7 +2320,13 @@ var FaustPolyWebAudioDsp = class extends FaustBaseWebAudioDsp {
     this.initMemory();
     this.fVoiceTable = [];
     for (let voice = 0; voice < this.fInstance.voices; voice++) {
-      this.fVoiceTable.push(new FaustWebAudioDspVoice(this.fJSONDsp.size * voice, this.fInstance.voiceAPI, this.fInputsItems, this.fPathTable, sampleRate));
+      this.fVoiceTable.push(new FaustWebAudioDspVoice(
+        this.fJSONDsp.size * voice,
+        this.fInstance.voiceAPI,
+        this.fInputsItems,
+        this.fPathTable,
+        sampleRate
+      ));
     }
     if (this.fInstance.effectAPI)
       this.fInstance.effectAPI.init(this.fEffect, sampleRate);
@@ -3283,14 +3293,20 @@ var FaustMonoAudioWorkletNode = class extends FaustAudioWorkletNode {
 };
 var FaustPolyAudioWorkletNode = class extends FaustAudioWorkletNode {
   constructor(context, name, voiceFactory, mixerModule, voices, sampleSize, effectFactory, nodeOptions = {}) {
-    super(context, name, voiceFactory, {
+    super(
+      context,
       name,
       voiceFactory,
-      mixerModule,
-      voices,
-      sampleSize,
-      effectFactory
-    }, nodeOptions);
+      {
+        name,
+        voiceFactory,
+        mixerModule,
+        voices,
+        sampleSize,
+        effectFactory
+      },
+      nodeOptions
+    );
     this.onprocessorerror = (e) => {
       throw e;
     };
@@ -3482,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);
@@ -3525,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
@@ -3661,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);
@@ -3730,7 +3746,7 @@ export {
   FaustAudioWorkletNode,
   FaustBaseWebAudioDsp,
   FaustCompiler_default as FaustCompiler,
-  FaustDspInstance_default as FaustDspInstance,
+  FaustDspInstance,
   FaustMonoAudioWorkletNode,
   FaustMonoDspGenerator,
   FaustMonoOfflineProcessor,