npm - speaker-calibration - Versions diffs - 2.2.217 → 2.2.218 - Mend

speaker-calibration 2.2.217 → 2.2.218

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 (142) hide show

package/.eslintignore +71 -71
package/.eslintrc.json +40 -40
package/.github/workflows/update-phrases.yml +37 -0
package/.prettierignore +69 -69
package/.prettierrc +14 -14
package/LICENSE +20 -20
package/README.md +133 -133
package/__mocks__/fileMock.js +1 -1
package/__mocks__/styleMock.js +1 -1
package/babel.config.js +3 -3
package/coverage/clover.xml +71 -71
package/coverage/coverage-final.json +224 -224
package/coverage/lcov-report/PythonServerInterface.js.html +265 -265
package/coverage/lcov-report/base.css +354 -354
package/coverage/lcov-report/block-navigation.js +82 -82
package/coverage/lcov-report/favicon.png +0 -0
package/coverage/lcov-report/index.html +123 -123
package/coverage/lcov-report/prettify.css +101 -101
package/coverage/lcov-report/prettify.js +937 -937
package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
package/coverage/lcov-report/sorter.js +189 -189
package/coverage/lcov-report/src/index.html +121 -121
package/coverage/lcov-report/src/server/PythonServerInterface.js.html +268 -268
package/coverage/lcov-report/src/server/index.html +123 -123
package/coverage/lcov-report/src/tasks/audioCalibrator.js.html +499 -499
package/coverage/lcov-report/src/tasks/audioRecorder.js.html +412 -412
package/coverage/lcov-report/src/tasks/index.html +143 -143
package/coverage/lcov-report/src/tasks/volume/index.html +123 -123
package/coverage/lcov-report/src/tasks/volume/volume.js.html +409 -409
package/coverage/lcov-report/src/utils.js.html +172 -172
package/coverage/lcov.info +91 -91
package/dist/Procfile +0 -0
package/dist/example/NoSleep.min.js +1 -1
package/dist/example/credentials.json.gpg +0 -0
package/dist/example/fetch-languages-sheets.js +77 -77
package/dist/example/i18n.js +28705 -28705
package/dist/example/index.html +47 -47
package/dist/example/listener.html +79 -79
package/dist/example/server.js +51 -51
package/dist/example/speaker.html +145 -145
package/dist/example/speakerUI.js +273 -273
package/dist/example/styles.css +99 -99
package/dist/listener.js +13 -13
package/dist/main.js +12 -12
package/dist/main.js.LICENSE.txt +0 -0
package/dist/mlsGen.js +6814 -6814
package/dist/mlsGen.wasm +0 -0
package/dist/package-lock.json +1018 -1018
package/dist/package.json +18 -18
package/doc/AudioCalibrator.html +417 -417
package/doc/AudioPeer.html +251 -251
package/doc/AudioRecorder.html +195 -195
package/doc/ImpulseResponse.html +215 -215
package/doc/Listener.html +308 -308
package/doc/MlsGenInterface.html +226 -226
package/doc/MyEventEmitter.html +274 -274
package/doc/PythonServerAPI.html +109 -109
package/doc/Speaker-Calibration-UML-Diagram.png +0 -0
package/doc/Speaker.html +276 -276
package/doc/Takes%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +128 -128
package/doc/Takes%20the%20url%20of%20the%20current%20site%0Aand%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +138 -138
package/doc/Takes%20the%20url%20of%20the%20current%20site%20and%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +137 -137
package/doc/Volume.html +88 -88
package/doc/audioCalibrator.js.html +179 -179
package/doc/audioPeer.js.html +175 -175
package/doc/audioRecorder.js.html +163 -163
package/doc/creates%20a%20new%20AudioRecorder%20instance.%20%0ASets%20up%20the%20audio%20context%20and%20file%20reader..html +114 -114
package/doc/fonts/OpenSans-Bold-webfont.eot +0 -0
package/doc/fonts/OpenSans-Bold-webfont.svg +1829 -1829
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 +1829 -1829
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 +1829 -1829
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 +1830 -1830
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 +1834 -1834
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 +1830 -1830
package/doc/fonts/OpenSans-Regular-webfont.woff +0 -0
package/doc/global.html +308 -308
package/doc/index.html +58 -58
package/doc/listener.js.html +170 -170
package/doc/mlsGen_mlsGenInterface.js.html +117 -117
package/doc/myEventEmitter.js.html +124 -124
package/doc/peer-connection_audioPeer.js.html +188 -188
package/doc/peer-connection_listener.js.html +311 -311
package/doc/peer-connection_speaker.js.html +381 -381
package/doc/sc-activity-diagram.png +0 -0
package/doc/scripts/linenumber.js +25 -25
package/doc/scripts/prettify/Apache-License-2.0.txt +202 -202
package/doc/scripts/prettify/lang-css.js +24 -24
package/doc/scripts/prettify/prettify.js +640 -640
package/doc/server_PythonServerAPI.js.html +160 -160
package/doc/speaker.js.html +248 -248
package/doc/styles/jsdoc-default.css +371 -371
package/doc/styles/prettify-jsdoc.css +111 -111
package/doc/styles/prettify-tomorrow.css +163 -163
package/doc/tasks_audioCalibrator.js.html +207 -207
package/doc/tasks_audioRecorder.js.html +190 -190
package/doc/tasks_impulse-response_impulseResponse.js.html +442 -442
package/doc/tasks_impulse-response_mlsGen_mlsGenInterface.js.html +175 -175
package/doc/tasks_volume_volume.js.html +185 -185
package/doc/utils.js.html +105 -105
package/jest.config.js +173 -173
package/makefile +74 -0
package/netlify.toml +26 -26
package/package.json +78 -78
package/src/config/firebase.js +26 -26
package/src/index.html +21 -21
package/src/listener-app/listener.js +153 -153
package/src/main.js +23 -23
package/src/myEventEmitter.js +83 -83
package/src/peer-connection/audioPeer.js +183 -183
package/src/peer-connection/listener.js +369 -369
package/src/peer-connection/peerErrors.js +25 -25
package/src/peer-connection/speaker.js +767 -765
package/src/powerCheck.js +98 -98
package/src/server/PythonServerAPI.js +869 -869
package/src/tasks/audioCalibrator.js +360 -360
package/src/tasks/audioRecorder.js +315 -315
package/src/tasks/combination/combination.js +3160 -3160
package/src/tasks/combination/mlsGen/mlsGen.cpp +98 -98
package/src/tasks/combination/mlsGen/mlsGen.hpp +303 -303
package/src/tasks/combination/mlsGen/mlsGenInterface.js +131 -131
package/src/tasks/combination/mlsGen/mlsGenTest.cpp +180 -180
package/src/tasks/impulse-response/impulseResponse.js +610 -610
package/src/tasks/impulse-response/mlsGen/mlsGen.cpp +98 -98
package/src/tasks/impulse-response/mlsGen/mlsGen.hpp +303 -303
package/src/tasks/impulse-response/mlsGen/mlsGenInterface.js +131 -131
package/src/tasks/impulse-response/mlsGen/mlsGenTest.cpp +180 -180
package/src/tasks/volume/volume.cpp +2 -2
package/src/tasks/volume/volume.hpp +22 -22
package/src/tasks/volume/volume.js +279 -279
package/src/utils.js +205 -205
package/webpack.config.js +64 -64
package/.gitignore +0 -81

package/doc/tasks_audioCalibrator.js.html CHANGED Viewed

@@ -1,207 +1,207 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <title>JSDoc: Source: tasks/audioCalibrator.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/audioCalibrator.js</h1>
-      <section>
-        <article>
-          <pre class="prettyprint source linenums"><code>/* eslint-disable no-await-in-loop */
-import AudioRecorder from './audioRecorder';
-import PythonServerAPI from '../server/PythonServerAPI';
-import {sleep, saveToCSV} from '../utils';
-/**
- * Provides methods for calibrating the user's speakers
- * @extends AudioRecorder
- */
-class AudioCalibrator extends AudioRecorder {
-  /**
-   *
-   */
-  constructor(numCaptures = 1, numMLSPerCapture = 1) {
-    super();
-    this.numCaptures = numCaptures;
-    this.numMLSPerCapture = numMLSPerCapture;
-    this.pyServerAPI = new PythonServerAPI();
-  }
-  /** @private */
-  #isCalibrating = false;
-  /** @private */
-  sourceAudioContext;
-  /** @protected */
-  numCalibratingRounds;
-  /** @protected */
-  numSuccessfulCaptured = 0;
-  /** @private */
-  sourceSamplingRate;
-  /** @protected */
-  calibrationNodes = [];
-  /** @protected */
-  localAudio;
-  /**
-   * Called when a call is received.
-   * Creates a local audio DOM element and attaches it to the page.
-   */
-  createLocalAudio = targetElement => {
-    this.localAudio = document.createElement('audio');
-    this.localAudio.setAttribute('id', 'localAudio');
-    targetElement.appendChild(this.localAudio);
-  };
-  /**
-   *
-   * @param {MediaStream} stream
-   * @param {Function} playCalibrationAudio - (async) function that plays the calibration audio
-   * @param {*} beforePlay - (async) function that is called before playing the audio
-   * @param {*} beforeRecord - (async) function that is called before recording
-   * @param {*} duringRecord - (async) function that is called while recording
-   * @param {*} afterRecord  - (async) function that is called after recording
-   */
-  calibrationSteps = async (
-    stream,
-    playCalibrationAudio,
-    beforePlay = async () => {},
-    beforeRecord = async () => {},
-    duringRecord = async () => {},
-    afterRecord = async () => {}
-  ) => {
-    this.numSuccessfulCaptured = 0;
-    // do something before recording such as awaiting a certain amount of time
-    await beforeRecord();
-    // calibration loop
-    while (this.numSuccessfulCaptured &lt; this.numCaptures) {
-      // do something before playing such as using the MLS to fill the buffers
-      await beforePlay();
-      // start recording
-      await this.startRecording(stream);
-      // play calibration audio
-      playCalibrationAudio();
-      // do something during the recording such as sleep n amount of time
-      await duringRecord();
-      // when done, stop recording
-      await this.stopRecording();
-      // do something after recording such as start processing values
-      await afterRecord();
-      // eslint-disable-next-line no-await-in-loop
-      this.calibrationNodes = [];
-      await sleep(3);
-    }
-  };
-  /**
-   * Getter for the isCalibrating property.
-   * @public
-   * @returns {Boolean} - True if the audio is being calibrated, false otherwise.
-   */
-  getCalibrationStatus = () => this.#isCalibrating;
-  /**
-   * Set the sampling rate to the value received from the listener
-   * @param {*} sinkSamplingRate
-   */
-  setSamplingRates = samplingRate => {
-    this.sinkSamplingRate = samplingRate;
-    this.sourceSamplingRate = samplingRate;
-    this.emit('update', {message: `sampling at ${samplingRate}Hz...`});
-  };
-  sampleRatesSet = () => this.sourceSamplingRate &amp;&amp; this.sinkSamplingRate;
-  addCalibrationNode = node => {
-    this.calibrationNodes.push(node);
-  };
-  makeNewSourceAudioContext = () => {
-    const options = {
-      sampleRate: this.sourceSamplingRate,
-    };
-    this.sourceAudioContext = new (window.AudioContext ||
-      window.webkitAudioContext ||
-      window.audioContext)(options);
-    return this.sourceAudioContext;
-  };
-  /**
-   * Download the result of the calibration roudns
-   */
-  downloadData = () => {
-    const recordings = this.getAllRecordedSignals();
-    const i = recordings.length - 1;
-    saveToCSV(recordings[i], `recordedMLSignal_${i}.csv`);
-  };
-}
-export default AudioCalibrator;
-</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>
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>JSDoc: Source: tasks/audioCalibrator.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/audioCalibrator.js</h1>
+      <section>
+        <article>
+          <pre class="prettyprint source linenums"><code>/* eslint-disable no-await-in-loop */
+import AudioRecorder from './audioRecorder';
+import PythonServerAPI from '../server/PythonServerAPI';
+import {sleep, saveToCSV} from '../utils';
+/**
+ * Provides methods for calibrating the user's speakers
+ * @extends AudioRecorder
+ */
+class AudioCalibrator extends AudioRecorder {
+  /**
+   *
+   */
+  constructor(numCaptures = 1, numMLSPerCapture = 1) {
+    super();
+    this.numCaptures = numCaptures;
+    this.numMLSPerCapture = numMLSPerCapture;
+    this.pyServerAPI = new PythonServerAPI();
+  }
+  /** @private */
+  #isCalibrating = false;
+  /** @private */
+  sourceAudioContext;
+  /** @protected */
+  numCalibratingRounds;
+  /** @protected */
+  numSuccessfulCaptured = 0;
+  /** @private */
+  sourceSamplingRate;
+  /** @protected */
+  calibrationNodes = [];
+  /** @protected */
+  localAudio;
+  /**
+   * Called when a call is received.
+   * Creates a local audio DOM element and attaches it to the page.
+   */
+  createLocalAudio = targetElement => {
+    this.localAudio = document.createElement('audio');
+    this.localAudio.setAttribute('id', 'localAudio');
+    targetElement.appendChild(this.localAudio);
+  };
+  /**
+   *
+   * @param {MediaStream} stream
+   * @param {Function} playCalibrationAudio - (async) function that plays the calibration audio
+   * @param {*} beforePlay - (async) function that is called before playing the audio
+   * @param {*} beforeRecord - (async) function that is called before recording
+   * @param {*} duringRecord - (async) function that is called while recording
+   * @param {*} afterRecord  - (async) function that is called after recording
+   */
+  calibrationSteps = async (
+    stream,
+    playCalibrationAudio,
+    beforePlay = async () => {},
+    beforeRecord = async () => {},
+    duringRecord = async () => {},
+    afterRecord = async () => {}
+  ) => {
+    this.numSuccessfulCaptured = 0;
+    // do something before recording such as awaiting a certain amount of time
+    await beforeRecord();
+    // calibration loop
+    while (this.numSuccessfulCaptured &lt; this.numCaptures) {
+      // do something before playing such as using the MLS to fill the buffers
+      await beforePlay();
+      // start recording
+      await this.startRecording(stream);
+      // play calibration audio
+      playCalibrationAudio();
+      // do something during the recording such as sleep n amount of time
+      await duringRecord();
+      // when done, stop recording
+      await this.stopRecording();
+      // do something after recording such as start processing values
+      await afterRecord();
+      // eslint-disable-next-line no-await-in-loop
+      this.calibrationNodes = [];
+      await sleep(3);
+    }
+  };
+  /**
+   * Getter for the isCalibrating property.
+   * @public
+   * @returns {Boolean} - True if the audio is being calibrated, false otherwise.
+   */
+  getCalibrationStatus = () => this.#isCalibrating;
+  /**
+   * Set the sampling rate to the value received from the listener
+   * @param {*} sinkSamplingRate
+   */
+  setSamplingRates = samplingRate => {
+    this.sinkSamplingRate = samplingRate;
+    this.sourceSamplingRate = samplingRate;
+    this.emit('update', {message: `sampling at ${samplingRate}Hz...`});
+  };
+  sampleRatesSet = () => this.sourceSamplingRate &amp;&amp; this.sinkSamplingRate;
+  addCalibrationNode = node => {
+    this.calibrationNodes.push(node);
+  };
+  makeNewSourceAudioContext = () => {
+    const options = {
+      sampleRate: this.sourceSamplingRate,
+    };
+    this.sourceAudioContext = new (window.AudioContext ||
+      window.webkitAudioContext ||
+      window.audioContext)(options);
+    return this.sourceAudioContext;
+  };
+  /**
+   * Download the result of the calibration roudns
+   */
+  downloadData = () => {
+    const recordings = this.getAllRecordedSignals();
+    const i = recordings.length - 1;
+    saveToCSV(recordings[i], `recordedMLSignal_${i}.csv`);
+  };
+}
+export default AudioCalibrator;
+</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>