npm - speaker-calibration - Versions diffs - 2.0.0 → 2.1.0 - Mend

speaker-calibration 2.0.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (126) hide show

package/.eslintignore +72 -0
package/.eslintrc.json +40 -0
package/.gitignore +78 -0
package/.prettierignore +70 -0
package/.prettierrc +15 -0
package/LICENSE +20 -20
package/README.md +133 -133
package/__mocks__/fileMock.js +1 -0
package/__mocks__/styleMock.js +1 -0
package/babel.config.js +3 -0
package/coverage/clover.xml +71 -0
package/coverage/coverage-final.json +224 -0
package/coverage/lcov-report/PythonServerInterface.js.html +265 -0
package/coverage/lcov-report/base.css +354 -0
package/coverage/lcov-report/block-navigation.js +82 -0
package/coverage/lcov-report/favicon.png +0 -0
package/coverage/lcov-report/index.html +123 -0
package/coverage/lcov-report/prettify.css +101 -0
package/coverage/lcov-report/prettify.js +937 -0
package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
package/coverage/lcov-report/sorter.js +189 -0
package/coverage/lcov-report/src/index.html +121 -0
package/coverage/lcov-report/src/server/PythonServerInterface.js.html +268 -0
package/coverage/lcov-report/src/server/index.html +123 -0
package/coverage/lcov-report/src/tasks/audioCalibrator.js.html +499 -0
package/coverage/lcov-report/src/tasks/audioRecorder.js.html +412 -0
package/coverage/lcov-report/src/tasks/index.html +143 -0
package/coverage/lcov-report/src/tasks/volume/index.html +123 -0
package/coverage/lcov-report/src/tasks/volume/volume.js.html +409 -0
package/coverage/lcov-report/src/utils.js.html +172 -0
package/coverage/lcov.info +91 -0
package/dist/example/Queen-Bohemian_Rhapsody.wav +0 -0
package/dist/example/Queen-Bohemian_Rhapsody_g_filtered.wav +0 -0
package/dist/example/index.html +47 -0
package/dist/example/listener.html +89 -0
package/dist/example/server.js +49 -0
package/dist/example/speaker.html +126 -0
package/dist/example/speakerUI.js +217 -0
package/dist/example/styles.css +40 -0
package/dist/main.js +1 -1
package/dist/mlsGen.js +6814 -6814
package/dist/mlsGen.wasm +0 -0
package/doc/AudioCalibrator.html +417 -0
package/doc/AudioPeer.html +251 -0
package/doc/AudioRecorder.html +195 -0
package/doc/ImpulseResponse.html +215 -0
package/doc/Listener.html +308 -0
package/doc/MlsGenInterface.html +226 -0
package/doc/MyEventEmitter.html +274 -0
package/doc/PythonServerAPI.html +109 -0
package/doc/Speaker-Calibration-UML-Diagram.png +0 -0
package/doc/Speaker.html +276 -0
package/doc/Takes%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +128 -0
package/doc/Takes%20the%20url%20of%20the%20current%20site%0Aand%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +138 -0
package/doc/Takes%20the%20url%20of%20the%20current%20site%20and%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +137 -0
package/doc/Volume.html +88 -0
package/doc/audioCalibrator.js.html +179 -0
package/doc/audioPeer.js.html +175 -0
package/doc/audioRecorder.js.html +163 -0
package/doc/creates%20a%20new%20AudioRecorder%20instance.%20%0ASets%20up%20the%20audio%20context%20and%20file%20reader..html +114 -0
package/doc/fonts/OpenSans-Bold-webfont.eot +0 -0
package/doc/fonts/OpenSans-Bold-webfont.svg +1830 -0
package/doc/fonts/OpenSans-Bold-webfont.woff +0 -0
package/doc/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/doc/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
package/doc/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/doc/fonts/OpenSans-Italic-webfont.eot +0 -0
package/doc/fonts/OpenSans-Italic-webfont.svg +1830 -0
package/doc/fonts/OpenSans-Italic-webfont.woff +0 -0
package/doc/fonts/OpenSans-Light-webfont.eot +0 -0
package/doc/fonts/OpenSans-Light-webfont.svg +1831 -0
package/doc/fonts/OpenSans-Light-webfont.woff +0 -0
package/doc/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/doc/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
package/doc/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/doc/fonts/OpenSans-Regular-webfont.eot +0 -0
package/doc/fonts/OpenSans-Regular-webfont.svg +1831 -0
package/doc/fonts/OpenSans-Regular-webfont.woff +0 -0
package/doc/global.html +308 -0
package/doc/index.html +58 -0
package/doc/listener.js.html +170 -0
package/doc/mlsGen_mlsGenInterface.js.html +117 -0
package/doc/myEventEmitter.js.html +124 -0
package/doc/peer-connection_audioPeer.js.html +188 -0
package/doc/peer-connection_listener.js.html +311 -0
package/doc/peer-connection_speaker.js.html +381 -0
package/doc/sc-activity-diagram.png +0 -0
package/doc/scripts/linenumber.js +25 -0
package/doc/scripts/prettify/Apache-License-2.0.txt +202 -0
package/doc/scripts/prettify/lang-css.js +24 -0
package/doc/scripts/prettify/prettify.js +640 -0
package/doc/server_PythonServerAPI.js.html +160 -0
package/doc/speaker.js.html +248 -0
package/doc/styles/jsdoc-default.css +371 -0
package/doc/styles/prettify-jsdoc.css +111 -0
package/doc/styles/prettify-tomorrow.css +163 -0
package/doc/tasks_audioCalibrator.js.html +207 -0
package/doc/tasks_audioRecorder.js.html +190 -0
package/doc/tasks_impulse-response_impulseResponse.js.html +442 -0
package/doc/tasks_impulse-response_mlsGen_mlsGenInterface.js.html +175 -0
package/doc/tasks_volume_volume.js.html +185 -0
package/doc/utils.js.html +105 -0
package/jest.config.js +173 -0
package/netlify.toml +27 -0
package/package.json +67 -66
package/src/index.html +21 -0
package/src/main.js +21 -0
package/src/myEventEmitter.js +83 -0
package/src/peer-connection/audioPeer.js +151 -0
package/src/peer-connection/listener.js +251 -0
package/src/peer-connection/peerErrors.js +25 -0
package/src/peer-connection/speaker.js +346 -0
package/src/server/PythonServerAPI.js +117 -0
package/src/tasks/audioCalibrator.js +218 -0
package/src/tasks/audioRecorder.js +148 -0
package/src/tasks/impulse-response/impulseResponse.js +436 -0
package/src/tasks/impulse-response/mlsGen/mlsGen.cpp +99 -0
package/src/tasks/impulse-response/mlsGen/mlsGen.hpp +304 -0
package/src/tasks/impulse-response/mlsGen/mlsGenInterface.js +131 -0
package/src/tasks/impulse-response/mlsGen/mlsGenTest.cpp +181 -0
package/src/tasks/volume/volume.cpp +3 -0
package/src/tasks/volume/volume.hpp +23 -0
package/src/tasks/volume/volume.js +157 -0
package/src/utils.js +55 -0
package/webpack.config.js +37 -0
package/README +0 -3

package/doc/tasks_impulse-response_impulseResponse.js.html ADDED Viewed

@@ -0,0 +1,442 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>JSDoc: Source: tasks/impulse-response/impulseResponse.js</title>
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css" />
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css" />
+  </head>
+  <body>
+    <div id="main">
+      <h1 class="page-title">Source: tasks/impulse-response/impulseResponse.js</h1>
+      <section>
+        <article>
+          <pre
+            class="prettyprint source linenums"
+          ><code>import AudioCalibrator from '../audioCalibrator';
+import MlsGenInterface from './mlsGen/mlsGenInterface';
+import {sleep, csvToArray} from '../../utils';
+/**
+ *
+ */
+class ImpulseResponse extends AudioCalibrator {
+  /**
+   * Default constructor. Creates an instance with any number of paramters passed or the default parameters defined here.
+   * @param {*} param0
+   */
+  constructor({download = false, mlsOrder = 18, numCaptures = 5, numMLSPerCapture = 4}) {
+    super(numCaptures, numMLSPerCapture);
+    this.#mlsOrder = parseInt(mlsOrder, 10);
+    this.#P = 2 ** mlsOrder - 1;
+    this.#download = download;
+  }
+  /** @private */
+  #download;
+  /** @private */
+  #mlsGenInterface;
+  /** @private */
+  #mlsBufferView;
+  /** @private */
+  invertedImpulseResponse = null;
+  /** @private */
+  impulseResponses = [];
+  /** @private */
+  #mlsOrder;
+  #P;
+  /** @private */
+  TAPER_SECS = 5;
+  /** @private */
+  offsetGainNode;
+  /**
+   * Sends all the computed impulse responses to the backend server for processing
+   * @returns sets the resulting inverted impulse response to the class property
+   */
+  sendImpulseResponsesToServerForProcessing = async () => {
+    const computedIRs = await Promise.all(this.impulseResponses);
+    this.emit('update', {message: `computing the IIR...`});
+    return this.pyServerAPI
+      .getInverseImpulseResponse({
+        payload: computedIRs,
+      })
+      .then(res => {
+        this.emit('update', {message: `done computing the IIR...`});
+        this.invertedImpulseResponse = res;
+      })
+      .catch(err => {
+        // this.emit('InvertedImpulseResponse', {res: false});
+        console.error(err);
+      });
+  };
+  /**
+   * Sends the recorded signal, or a given csv string of a signal, to the back end server for processing
+   * @param {&lt;array>String} signalCsv - Optional csv string of a previously recorded signal, if given, this signal will be processed
+   */
+  sendRecordingToServerForProcessing = signalCsv => {
+    const allSignals = this.getAllRecordedSignals();
+    const numSignals = allSignals.length;
+    const payload =
+      signalCsv &amp;&amp; signalCsv.length > 0 ? csvToArray(signalCsv) : allSignals[numSignals - 1];
+    this.emit('update', {message: `computing the IR of the last recording...`});
+    this.impulseResponses.push(
+      this.pyServerAPI
+        .getImpulseResponse({
+          sampleRate: this.sourceSamplingRate || 96000,
+          payload,
+          P: this.#P,
+        })
+        .then(res => {
+          if (this.numSuccessfulCaptured &lt; this.numCaptures) {
+            this.numSuccessfulCaptured += 1;
+            this.emit('update', {
+              message: `${this.numSuccessfulCaptured}/${this.numCaptures} IRs computed...`,
+            });
+          }
+          return res;
+        })
+        .catch(err => {
+          console.error(err);
+        })
+    );
+  };
+  /**
+   * Passed to the calibration steps function, awaits the desired amount of seconds to capture the desired number
+   * of MLS periods defined in the constructor
+   */
+  #awaitDesiredMLSLength = async () => {
+    // seconds per MLS = P / SR
+    // await N * P / SR
+    this.emit('update', {
+      message: `sampling the calibration signal...`,
+    });
+    await sleep((this.#P / this.sourceSamplingRate) * this.numMLSPerCapture);
+  };
+  /**
+   * Passed to the calibration steps function, awaits the onset of the signal to ensure a steady state
+   */
+  #awaitSignalOnset = async () => {
+    this.emit('update', {
+      message: `waiting for the signal to stabalize...`,
+    });
+    await sleep(this.TAPER_SECS);
+  };
+  /**
+   * Called immediately after a recording is captured. Used to process the resulting signal
+   * whether by sending the result to a server or by computing a result locally
+   */
+  #afterMLSRecord = () => {
+    if (this.#download) {
+      this.downloadData();
+    }
+    this.#stopCalibrationAudio();
+    this.sendRecordingToServerForProcessing();
+  };
+  #afterMLSwIIRRecord = () => {
+    if (this.#download) {
+      this.downloadData();
+    }
+    this.#stopCalibrationAudio();
+  };
+  /**
+   * Created an S Curver Buffer to taper the signal onset
+   * @param {*} length
+   * @param {*} phase
+   * @returns
+   */
+  static createSCurveBuffer = (length, phase) => {
+    const curve = new Float32Array(length);
+    let i;
+    for (i = 0; i &lt; length; i += 1) {
+      // scale the curve to be between 0-1
+      curve[i] = Math.sin((Math.PI * i) / length - phase) / 2 + 0.5;
+    }
+    return curve;
+  };
+  static createInverseSCurveBuffer = (length, phase) => {
+    const curve = new Float32Array(length);
+    let i;
+    let j = length - 1;
+    for (i = 0; i &lt; length; i += 1) {
+      // scale the curve to be between 0-1
+      curve[i] = Math.sin((Math.PI * j) / length - phase) / 2 + 0.5;
+      j -= 1;
+    }
+    return curve;
+  };
+  /**
+   * Construct a Calibration Node with the calibration parameters.
+   * @private
+   */
+  #createPureTonenNode = CALIBRATION_TONE_FREQUENCY => {
+    const audioContext = this.makeNewSourceAudioContext();
+    const oscilator = audioContext.createOscillator();
+    const gainNode = audioContext.createGain();
+    oscilator.frequency.value = CALIBRATION_TONE_FREQUENCY;
+    oscilator.type = 'sine';
+    gainNode.gain.value = 0.04;
+    oscilator.connect(gainNode);
+    gainNode.connect(audioContext.destination);
+    this.addCalibrationNode(oscilator);
+  };
+  /**
+   * Construct a Calibration Node with the calibration parameters.
+   * @private
+   */
+  #createCalibrationNodeFromBuffer = dataBuffer => {
+    const audioContext = this.makeNewSourceAudioContext();
+    const buffer = audioContext.createBuffer(
+      1, // number of channels
+      dataBuffer.length,
+      audioContext.sampleRate // sample rate
+    );
+    const data = buffer.getChannelData(0); // get data
+    // fill the buffer with our data
+    try {
+      for (let i = 0; i &lt; dataBuffer.length; i += 1) {
+        data[i] = dataBuffer[i];
+      }
+    } catch (error) {
+      console.error(error);
+    }
+    const source = audioContext.createBufferSource();
+    source.buffer = buffer;
+    source.loop = true;
+    source.connect(audioContext.destination);
+    this.addCalibrationNode(source);
+  };
+  /**
+   * Given a data buffer, creates the required calibration node
+   * @param {*} dataBufferArray
+   */
+  #setCalibrationNodesFromBuffer = (dataBufferArray = [this.#mlsBufferView]) => {
+    if (dataBufferArray.length === 1) {
+      this.#createCalibrationNodeFromBuffer(dataBufferArray[0]);
+    } else {
+      throw new Error('The length of the data buffer array must be 1');
+    }
+  };
+  #createImpulseResponseFilterGraph = (calibrationSignal, iir) => {
+    const audioCtx = this.makeNewSourceAudioContext();
+    // -------------------------------------------------------- IIR
+    const iirBuffer = audioCtx.createBuffer(
+      1,
+      // TODO: quality check this
+      iir.length - 1,
+      audioCtx.sampleRate
+    );
+    // Fill the buffer with the inverted impulse response
+    const iirChannelZeroBuffer = iirBuffer.getChannelData(0);
+    for (let i = 0; i &lt; iirBuffer.length; i++) {
+      // audio needs to be in [-1.0; 1.0]
+      iirChannelZeroBuffer[i] = iir[i];
+    }
+    const convolverNode = audioCtx.createConvolver();
+    convolverNode.normalize = false;
+    convolverNode.channelCount = 1;
+    convolverNode.buffer = iirBuffer;
+    // ------------------------------------------------------ MLS
+    const calibrationSignalBuffer = audioCtx.createBuffer(
+      1, // number of channels
+      calibrationSignal.length,
+      audioCtx.sampleRate // sample rate
+    );
+    const mlsChannelZeroBuffer = calibrationSignalBuffer.getChannelData(0); // get data
+    // fill the buffer with our data
+    try {
+      for (let i = 0; i &lt; calibrationSignal.length; i += 1) {
+        mlsChannelZeroBuffer[i] = calibrationSignal[i];
+      }
+    } catch (error) {
+      console.error(error);
+    }
+    const sourceNode = audioCtx.createBufferSource();
+    sourceNode.buffer = calibrationSignalBuffer;
+    sourceNode.loop = true;
+    sourceNode.connect(convolverNode);
+    convolverNode.connect(audioCtx.destination);
+    console.log({convolverNode, sourceNode});
+    this.addCalibrationNode(sourceNode);
+  };
+  #createIIRwMLSGraph = () => {
+    this.#createImpulseResponseFilterGraph(this.impulseResponses, [this.#mlsBufferView][0]);
+  };
+  /**
+   * Creates an audio context and plays it for a few seconds.
+   * @private
+   * @returns {Promise} - Resolves when the audio is done playing.
+   */
+  #playCalibrationAudio = () => {
+    this.calibrationNodes[0].start(0);
+    this.emit('update', {message: 'playing the calibration tone...'});
+  };
+  /**
+   * Stops the audio with tapered offset
+   */
+  #stopCalibrationAudio = () => {
+    this.calibrationNodes[0].stop();
+    this.emit('update', {message: 'stopping the calibration tone...'});
+  };
+  playMLSwithIIR = async (stream, iir) => {
+    this.invertedImpulseResponse = iir;
+    // initialize the MLSGenInterface object with it's factory method
+    await MlsGenInterface.factory(
+      this.#mlsOrder,
+      this.sinkSamplingRate,
+      this.sourceSamplingRate
+    ).then(mlsGenInterface => {
+      this.#mlsGenInterface = mlsGenInterface;
+      this.#mlsBufferView = this.#mlsGenInterface.getMLS();
+    });
+    // after intializating, start the calibration steps with garbage collection
+    await this.#mlsGenInterface.withGarbageCollection([
+      [
+        this.calibrationSteps,
+        [
+          stream,
+          this.#playCalibrationAudio, // play audio func (required)
+          this.#createImpulseResponseFilterGraph, // before play func
+          null, // before record
+          this.#awaitDesiredMLSLength, // during record
+          this.#afterMLSwIIRRecord, // after record
+        ],
+      ],
+    ]);
+  };
+  /**
+   * Public method to start the calibration process. Objects intialized from webassembly allocate new memory
+   * and must be manually freed. This function is responsible for intializing the MlsGenInterface,
+   * and wrapping the calibration steps with a garbage collection safe gaurd.
+   * @public
+   * @param {MediaStream} stream - The stream of audio from the Listener.
+   */
+  startCalibration = async stream => {
+    // initialize the MLSGenInterface object with it's factory method
+    await MlsGenInterface.factory(
+      this.#mlsOrder,
+      this.sinkSamplingRate,
+      this.sourceSamplingRate
+    ).then(mlsGenInterface => {
+      this.#mlsGenInterface = mlsGenInterface;
+      this.#mlsBufferView = this.#mlsGenInterface.getMLS();
+    });
+    // after intializating, start the calibration steps with garbage collection
+    await this.#mlsGenInterface.withGarbageCollection([
+      [
+        this.calibrationSteps,
+        [
+          stream,
+          this.#playCalibrationAudio, // play audio func (required)
+          this.#setCalibrationNodesFromBuffer, // before play func
+          null, // before record
+          this.#awaitDesiredMLSLength, // during record
+          this.#afterMLSRecord, // after record
+        ],
+      ],
+    ]);
+    // await the server response
+    await this.sendImpulseResponsesToServerForProcessing();
+    await this.playMLSwithIIR(stream, this.invertedImpulseResponse);
+    return this.invertedImpulseResponse;
+  };
+}
+export default ImpulseResponse;
+</code></pre>
+        </article>
+      </section>
+    </div>
+    <nav>
+      <h2><a href="index.html">Home</a></h2>
+      <h3>Classes</h3>
+      <ul>
+        <li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
+        <li><a href="AudioPeer.html">AudioPeer</a></li>
+        <li><a href="AudioRecorder.html">AudioRecorder</a></li>
+        <li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
+        <li><a href="Listener.html">Listener</a></li>
+        <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
+        <li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
+        <li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
+        <li><a href="Speaker.html">Speaker</a></li>
+        <li><a href="Volume.html">Volume</a></li>
+      </ul>
+      <h3>Global</h3>
+      <ul>
+        <li><a href="global.html#csvToArray">csvToArray</a></li>
+        <li><a href="global.html#saveToCSV">saveToCSV</a></li>
+        <li><a href="global.html#sleep">sleep</a></li>
+      </ul>
+    </nav>
+    <br class="clear" />
+    <footer>
+      Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
+      Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
+    </footer>
+    <script>
+      prettyPrint();
+    </script>
+    <script src="scripts/linenumber.js"></script>
+  </body>
+</html>

package/doc/tasks_impulse-response_mlsGen_mlsGenInterface.js.html ADDED Viewed

@@ -0,0 +1,175 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>JSDoc: Source: tasks/impulse-response/mlsGen/mlsGenInterface.js</title>
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css" />
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css" />
+  </head>
+  <body>
+    <div id="main">
+      <h1 class="page-title">Source: tasks/impulse-response/mlsGen/mlsGenInterface.js</h1>
+      <section>
+        <article>
+          <pre class="prettyprint source linenums"><code>/* eslint-disable prefer-destructuring */
+/* eslint-disable dot-notation */
+// eslint-disable-next-line import/extensions
+const createMLSGenModule = require('../../../../dist/mlsGen.js');
+/**
+ * MLSGenInterface provides a class for interfacing with the MLSGen WASM module.
+ */
+class MlsGenInterface {
+  /** @private */
+  #mlsOrder;
+  /** @private */
+  #WASMInstance; // the WASM module instance
+  /** @private */
+  #MLSGenInstance; // the MLSGen object instance
+  /**
+   * Creates an instance of MlsGenInterface.
+   * Makes a call to the WASM glue code to load the WASM module.
+   */
+  constructor(WASMInstance, mlsOrder, sourceSamplingRate, sinkSamplingRate) {
+    this.#mlsOrder = mlsOrder;
+    this.#WASMInstance = WASMInstance;
+    console.warn('initializing MLSGen, need to manually garbage collect');
+    this.#MLSGenInstance = new this.#WASMInstance['MLSGen'](
+      mlsOrder,
+      sourceSamplingRate,
+      sinkSamplingRate
+    );
+  }
+  /**
+   * Factory function that provide an asynchronous function that fetches the WASM module
+   * and returns a promise that resolves when the module is loaded.
+   * @param {number} sourceSamplingRate - The sampling rate of the source audio.
+   * @param {number} sinkSamplingRate - The sampling rate of the sink audio.
+   * @returns {MlsGenInterface} mlsGenInterface
+   */
+  static factory = async (mlsOrder, sourceSamplingRate, sinkSamplingRate) => {
+    if (sourceSamplingRate === undefined || sinkSamplingRate === undefined) {
+      throw new Error('sourceSamplingRate and sinkSamplingRate must be defined');
+    }
+    return new MlsGenInterface(
+      await createMLSGenModule().then(instance => instance),
+      mlsOrder,
+      sourceSamplingRate,
+      sinkSamplingRate
+    );
+  };
+  /**
+   * A Higher-Order function that takes an async callback function that access the MLSGen object,
+   * providing safe garbage collection.
+   * @param {function} func
+   * @param {array} args
+   */
+  withGarbageCollection = async funcsWithParams => {
+    try {
+      for (let i = 0; i &lt; funcsWithParams.length; i += 1) {
+        const [func, params] = funcsWithParams[i];
+        await func(...params);
+      }
+      // await func(...params);
+    } catch (error) {
+      console.error(error);
+    } finally {
+      // garbage collect
+      if (
+        this !== undefined &amp;&amp;
+        this !== null &amp;&amp;
+        this.#MLSGenInstance !== undefined &amp;&amp;
+        this.#MLSGenInstance !== null
+      ) {
+        this.#MLSGenInstance['Destruct'](); // Call the destructor
+        this.#MLSGenInstance['delete'](); // Delete the object
+        console.warn(`GARBAGE COLLECTION: deleted MLSGen`);
+        this.#WASMInstance['doLeakCheck'](); // Check for memory leaks
+      }
+    }
+  };
+  /**
+   * Calculate and return the Impulse Response of the recorded signal.
+   * @returns
+   */
+  getImpulseResponse = () => this.#MLSGenInstance['getImpulseResponse']();
+  /**
+   * Given a recorded MLS signal, this function sets the recordedSignal property of the MLSGen object.
+   * @param {Float32Array} signals
+   */
+  setRecordedSignals = signals => {
+    // get memory view
+    const averagedSignals = this.average(signals);
+    const recordedSignalsMemoryView = this.#MLSGenInstance['setRecordedSignalsMemoryView'](
+      averagedSignals.byteLength
+    );
+    for (let i = 0; i &lt; averagedSignals.length; i++) {
+      recordedSignalsMemoryView[i] = averagedSignals[i];
+    }
+  };
+  /**
+   * Calculate the Maximum Length Sequence (MLS) with period P = 2^N - 1
+   * using the MLSGen WASM module.
+   */
+  getMLS = () => this.#MLSGenInstance['getMLS']();
+}
+export default MlsGenInterface;
+</code></pre>
+        </article>
+      </section>
+    </div>
+    <nav>
+      <h2><a href="index.html">Home</a></h2>
+      <h3>Classes</h3>
+      <ul>
+        <li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
+        <li><a href="AudioPeer.html">AudioPeer</a></li>
+        <li><a href="AudioRecorder.html">AudioRecorder</a></li>
+        <li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
+        <li><a href="Listener.html">Listener</a></li>
+        <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
+        <li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
+        <li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
+        <li><a href="Speaker.html">Speaker</a></li>
+        <li><a href="Volume.html">Volume</a></li>
+      </ul>
+      <h3>Global</h3>
+      <ul>
+        <li><a href="global.html#csvToArray">csvToArray</a></li>
+        <li><a href="global.html#saveToCSV">saveToCSV</a></li>
+        <li><a href="global.html#sleep">sleep</a></li>
+      </ul>
+    </nav>
+    <br class="clear" />
+    <footer>
+      Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
+      Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
+    </footer>
+    <script>
+      prettyPrint();
+    </script>
+    <script src="scripts/linenumber.js"></script>
+  </body>
+</html>