@grame/faustwasm 0.12.2 → 0.13.1

package/.prettierrc

@@ -0,0 +1,5 @@
+{
+	"singleQuote": true,
+	"trailingComma": "none",
+	"tabWidth": 4
+}

package/README.md

@@ -37,6 +37,20 @@ Build the files:
 npm run build
 ```
 
+The source code uses [Prettier code formatter](https://prettier.io) to properly format all TS and JS files. Use:
+
+```bash
+npm run format
+```
+
+to apply format rules on `src`, and:
+
+```bash
+npm run lint
+```
+
+to check format rules on `src`. 
+
 ### Versioning
 
 You'll have to raise the package version number in `package.json` before `npm run build` to properly work.
@@ -319,7 +333,13 @@ An offline processor to render a DSP in a non real-time context and get the comp
 
 #### 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`. 
+The high-level API provides convenient functions to compile a Faust DSP program and create its corresponding audio node, either monophonic or polyphonic.
+- using the appropriate `FaustMonoDspGenerator` or `FaustPolyDspGenerator` class, `createNode` explicitly builds a mono or polyphonic node.
+- `createFaustNode` automatically selects mono or polyphonic mode by inspecting the `[nvoices:N] `field in the DSP metadata.
+
+For offline rendering, `createOfflineProcessor` is available and supports both mono and polyphonic processing. FFT processing nodes can be created using `createFFTNode`.
+
+This API is implemented in FaustDspGenerator.ts.
 
 #### How to use with typescript <a name="tsuse"></a>
 
@@ -348,5 +368,3 @@ Html pages embedding the Faust compiler must be served using https, unless using
 
 
 
-
-

package/assets/standalone/faustwasm/index.d.ts

@@ -91,8 +91,7 @@ export interface LibFaustWasm {
 	 */
 	getInfos(what: FaustInfoType): string;
 }
-export interface FaustDspFactory extends Required<LooseFaustDspFactory> {
-}
+export type FaustDspFactory = Required<LooseFaustDspFactory>;
 /**
  * The Factory structure.
  */
@@ -404,7 +403,7 @@ export declare class FaustWasmInstantiator {
 	private static createMemoryMono;
 	private static createMemoryPoly;
 	private static createMixerAux;
-	static loadDSPFactory(wasmPath: string, jsonPath: string): Promise<FaustDspFactory>;
+	static loadDSPFactory(wasmPath: string, jsonPath: string): Promise<Required<LooseFaustDspFactory>>;
 	static loadDSPMixer(mixerPath: string, fs?: typeof FS): Promise<WebAssembly.Module>;
 	static createAsyncMonoDSPInstance(factory: LooseFaustDspFactory): Promise<FaustMonoDspInstance>;
 	static createSyncMonoDSPInstance(factory: LooseFaustDspFactory): FaustMonoDspInstance;
@@ -673,10 +672,10 @@ export interface IFaustBaseWebAudioDsp {
 	 */
 	getUI(): FaustUIDescriptor;
 	/**
-	* Get DSP UI items description.
-	*
-	* @return the DSP UI items description
-	*/
+	 * Get DSP UI items description.
+	 *
+	 * @return the DSP UI items description
+	 */
 	getDescriptors(): FaustUIInputItem[];
 	/**
 	 * Get DSP JSON description with its UI and metadata.
@@ -685,8 +684,8 @@ export interface IFaustBaseWebAudioDsp {
 	 */
 	getJSON(): string;
 	/**
-	* Start accelerometer and gyroscope handlers.
-	*/
+	 * Start accelerometer and gyroscope handlers.
+	 */
 	startSensors(): void;
 	/**
 	 * Stop accelerometer and gyroscope handlers.
@@ -720,8 +719,7 @@ export interface IFaustBaseWebAudioDsp {
 	 */
 	destroy(): void;
 }
-export interface IFaustMonoWebAudioDsp extends IFaustBaseWebAudioDsp {
-}
+export type IFaustMonoWebAudioDsp = IFaustBaseWebAudioDsp;
 export interface IFaustMonoWebAudioNode extends IFaustMonoWebAudioDsp, AudioNode {
 }
 export interface IFaustPolyWebAudioDsp extends IFaustBaseWebAudioDsp {
@@ -849,7 +847,7 @@ export declare class FaustBaseWebAudioDsp implements IFaustBaseWebAudioDsp {
 	 *
 	 * @param allocator : the wasm memory allocator
 	 * @param baseDSP : the DSP struct (either a monophonic DSP of polyphonic voice) base DSP in the wasm memory
-	*/
+	 */
 	protected initSoundfileMemory(allocator: WasmAllocator, baseDSP: number): void;
 	protected updateOutputs(): void;
 	metadata(handler: MetadataHandler): void;
@@ -1164,18 +1162,18 @@ export declare class FaustCompiler implements IFaustCompiler {
 		code: string;
 		json: any;
 		poly: boolean;
-	}>): Promise<Map<string, FaustDspFactory>[]>;
+	}>): Promise<Map<string, Required<LooseFaustDspFactory>>[]>;
 	/**
 	 * Import a stringified DSP factories table
 	 */
-	static importDSPFactories(tableStr: string): Promise<Map<string, FaustDspFactory>[]>;
+	static importDSPFactories(tableStr: string): Promise<Map<string, Required<LooseFaustDspFactory>>[]>;
 	constructor(libFaust: ILibFaust);
 	private intVec2intArray;
 	private createDSPFactory;
 	version(): string;
 	getErrorMessage(): string;
-	createMonoDSPFactory(name: string, code: string, args: string): Promise<FaustDspFactory | null>;
-	createPolyDSPFactory(name: string, code: string, args: string): Promise<FaustDspFactory | null>;
+	createMonoDSPFactory(name: string, code: string, args: string): Promise<Required<LooseFaustDspFactory> | null>;
+	createPolyDSPFactory(name: string, code: string, args: string): Promise<Required<LooseFaustDspFactory> | null>;
 	deleteDSPFactory(factory: FaustDspFactory): void;
 	expandDSP(code: string, args: string): string;
 	generateAuxFiles(name: string, code: string, args: string): boolean;
@@ -1524,6 +1522,20 @@ export interface GeneratorSupportingSoundfiles {
 	 */
 	getSoundfileList(): string[];
 }
+export interface IFaustDspGenerator {
+	/**
+	 * Create a monophonic or polyphonic WebAudio node (either ScriptProcessorNode or AudioWorkletNode).
+	 * Analyze the code to decide whether to create a monophonic or polyphonic node.
+	 *
+	 * @param context - the WebAudio context
+	 * @param name - DSP name, can be used for processorName
+	 * @param code - the DSP code
+	 * @param sp - whether to compile a ScriptProcessorNode or an AudioWorkletNode
+	 * @param bufferSize - the buffer size in frames to be used in ScriptProcessorNode only, since AudioWorkletNode always uses 128 frames
+	 * @returns the compiled monophonic or polyphonic WebAudio node or 'null' if failure
+	 */
+	createFaustNode(context: BaseAudioContext, name: string, code: string, sp?: boolean, bufferSize?: number): Promise<IFaustMonoWebAudioNode | IFaustPolyWebAudioNode | null>;
+}
 export interface IFaustMonoDspGenerator extends GeneratorSupportingSoundfiles {
 	/**
 	 * Compile a monophonic DSP factory from given code.
@@ -1697,6 +1709,16 @@ export declare class FaustPolyDspGenerator implements IFaustPolyDspGenerator {
 	getJSON(): string;
 	getUI(): FaustUIDescriptor;
 }
+export declare class FaustDspGenerator implements IFaustDspGenerator {
+	private static compilerPromise;
+	private extractMidiAndNvoices;
+	/**
+	 * Compile DSP code, inspect metadata for [nvoices:] (and optionally [midi:on]), and build either a mono
+	 * or poly WebAudio node (ScriptProcessor or AudioWorklet depending on `sp`). Compilation uses a shared,
+	 * lazily-created libfaust instance to avoid repeatedly instantiating the WASM compiler.
+	 */
+	createFaustNode(context: BaseAudioContext, name: string, code: string, sp?: boolean, bufferSize?: number): Promise<IFaustMonoWebAudioNode | IFaustPolyWebAudioNode | null>;
+}
 
 export {
 	AudioData$1 as AudioData,