csound-wasm/src/modules/instantiation.js

[](https://badge.fury.io/js/csound-wasm)

/*
   csound instantiation module from <csound.h>
   https://csound.com/docs/api/modules.html
*/

/**
 * @typedef {Object} Csound
 * @property {function} csoundCreate
 * @property {function} csoundDestroy
 * @property {function} csoundGetAPIVersion
 */
/**
 * Creates new csound object
 * @callback csoundCreate
 * @return {Csound}
 */
/**
 * Parses an orchestra string
 * @param {Object} wasm
 * @return {csoundCreate}
 */
export const csoundCreate = wasm => () => wasm.exports.csoundCreateWasi();

csoundCreate.toString = () => 'csoundCreate = async (csound) => undefined;';

/**
 * Destroys an instance of Csound and frees memory
 * @callback csoundDestroy
 * @param {Csound} csound
 * @return {undefined}
 */
/**
 * @param {Object} wasm
 * @return {csoundDestroy}
 */
export const csoundDestroy = wasm => csound => wasm.exports.csoundDestroy(csound);

csoundDestroy.toString = () => 'csoundDestroy = async (csound) => undefined;';

/**
 * Returns the API version as int
 * @callback csoundGetAPIVersion
 * @param {Csound} csound
 * @return {number}
 */
/**
 * @param {Object} wasm
 * @return {csoundGetAPIVersion}
 */
export const csoundGetAPIVersion = wasm => () => wasm.exports.csoundGetAPIVersion();

csoundGetAPIVersion.toString = () => 'csoundGetAPIVersion = async (csound) => Number;';

/**
 * Returns the Csound version as int
 * @callback csoundGetVersion
 * @param {Csound} csound
 * @return {number}
 */
/**
 * @param {Object} wasm
 * @return {csoundGetVersion}
 */
export const csoundGetVersion = wasm => () => wasm.exports.csoundGetVersion();

csoundGetVersion.toString = () => 'csoundGetVersion = async (csound) => Number;';

/**
 * Initialise Csound with specific flags.
 * This function is called internally by csoundCreate(),
 * so there is generally no need to use it explicitly
 * unless you need to avoid default initilization that
 * sets signal handlers and atexit() callbacks.
 * @callback csoundGetVersion
 * @param {Csound} csound
 * @return {number} - Return value is zero on success,
 *     positive if initialisation was done already, and negative on error.
 */
/**
 * @param {Object} wasm
 * @return {csoundGetVersion}
 */
export const csoundInitialize = wasm => flags => wasm.exports.csoundInitialize(flags);

csoundInitialize.toString = () => 'csoundInitialize = async (csound) => Number;';