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

speaker-calibration 2.0.0 → 2.1.1

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 +913 -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 +155 -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 +174 -0
package/src/utils.js +55 -0
package/webpack.config.js +37 -0
package/README +0 -3

package/doc/server_PythonServerAPI.js.html ADDED Viewed

@@ -0,0 +1,160 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>JSDoc: Source: server/PythonServerAPI.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: server/PythonServerAPI.js</h1>
+      <section>
+        <article>
+          <pre class="prettyprint source linenums"><code>import axios from 'axios';
+/**
+ *
+ */
+class PythonServerAPI {
+  static PYTHON_SERVER_URL = 'https://easyeyes-python-flask-server.herokuapp.com';
+  static TEST_SERVER_URL = 'http://127.0.0.1:5000';
+  /**
+   * @param {array} data
+   * g = inverted impulse response, when convolved with the impulse
+   * reponse, they cancel out.
+   * @returns {Float&lt;array>}
+   */
+  getImpulseResponse = async ({payload, sampleRate, P}) => {
+    const task = 'impulse-response';
+    let res = null;
+    console.log({payload});
+    const data = JSON.stringify({
+      task,
+      payload,
+      'sample-rate': sampleRate,
+      P,
+    });
+    await axios({
+      method: 'post',
+      baseURL: PythonServerAPI.PYTHON_SERVER_URL,
+      url: `/task/${task}`,
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      data,
+    })
+      .then(response => {
+        res = response;
+      })
+      .catch(error => {
+        throw error;
+      });
+    return res.data[task];
+  };
+  getInverseImpulseResponse = async ({payload}) => {
+    const task = 'inverse-impulse-response';
+    let res = null;
+    console.log({payload});
+    const data = JSON.stringify({
+      task,
+      payload,
+    });
+    await axios({
+      method: 'post',
+      baseURL: PythonServerAPI.PYTHON_SERVER_URL,
+      url: `/task/${task}`,
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      data,
+    })
+      .then(response => {
+        res = response;
+      })
+      .catch(error => {
+        throw error;
+      });
+    return res.data[task];
+  };
+  getVolumeCalibration = async data => {
+    let serverRep;
+    let res;
+    try {
+      serverRep = await this.asyncEmit('data', {
+        task: 'volume-calibration',
+        data,
+      });
+      const [soundGainDbSPL, P, L, vectorDb] = serverRep.data
+        .trim()
+        .split(',')
+        .map(resp => parseFloat(resp.split(':')[1]));
+      res = soundGainDbSPL;
+    } catch (e) {
+      throw new Error(e);
+    }
+    return res;
+  };
+}
+export default PythonServerAPI;
+</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/speaker.js.html ADDED Viewed

@@ -0,0 +1,248 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>JSDoc: Source: speaker.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: speaker.js</h1>
+      <section>
+        <article>
+          <pre class="prettyprint source linenums"><code>import './speaker.css';
+import AudioPeer from './audioPeer';
+import AudioCalibrator from './audioCalibrator';
+const QRCode = require('qrcode');
+// TODO: some of these methods were preimplmented, but appear to be unused, cleanup
+/**
+ * @class Handles the speaker's side of the connection. Responsible for initiating the connection,
+ * rendering the QRCode, and answering the call.
+ * @extends AudioPeer
+ */
+class Speaker extends AudioPeer {
+  /**
+   * Takes the url of the current site and a target element where html elements will be appended.
+   * @param {initParameters} params - see type definition for initParameters
+   */
+  constructor(params) {
+    super(params);
+    this.siteUrl += '/listener?';
+    this.ac = new AudioCalibrator();
+    /* Set up callbacks that handle any events related to our peer object. */
+    this.peer.on('open', this.onPeerOpen);
+    this.peer.on('connection', this.onPeerConnection);
+    this.peer.on('call', this.onPeerCall);
+    this.peer.on('close', this.onPeerClose);
+    this.peer.on('disconnected', this.onPeerDisconnected);
+    this.peer.on('error', this.onPeerError);
+  }
+  /**
+   * Called after the peer conncection has been opened.
+   * Generates a QR code for the connection and displays it.
+   */
+  showQRCode = () => {
+    // this.ac.test();
+    // Get query string, the URL parameters to specify a Listener
+    const queryStringParameters = {
+      speakerPeerId: this.peer.id,
+    };
+    const queryString = this.queryStringFromObject(queryStringParameters);
+    const uri = this.siteUrl + queryString;
+    // Display QR code for the participant to scan
+    const qrCanvas = document.createElement('canvas');
+    qrCanvas.setAttribute('id', 'qrCanvas');
+    console.log(uri);
+    QRCode.toCanvas(qrCanvas, uri, error => {
+      if (error) console.error(error);
+    });
+    // If specified HTML Id is available, show QR code there
+    if (document.getElementById(this.targetElement)) {
+      document.getElementById(this.targetElement).appendChild(qrCanvas);
+    } else {
+      // or just print it to console
+      console.log('TEST: Peer reachable at: ', uri);
+    }
+  };
+  /**
+   * Called when the peer connection is opened.
+   * Saves the peer id and calls the QR code generator.
+   * @param {object} peerId - The peer id of the peer connection
+   */
+  onPeerOpen = id => {
+    // Workaround for peer.reconnect deleting previous id
+    if (id === null) {
+      console.error('Received null id from peer open');
+      this.peer.id = this.lastPeerId;
+    } else {
+      this.lastPeerId = this.peer.id;
+    }
+    if (id !== this.peer.id) {
+      console.warn('DEBUG Check you assumption that id === this.peer.id');
+    }
+    this.showQRCode();
+  };
+  /**
+   * Called when the peer connection is established.
+   * Enforces a single connection.
+   * @param {*} connection - The connection object
+   */
+  onPeerConnection = connection => {
+    console.log('Speaker - onPeerConnection');
+    // Allow only a single connection
+    if (this.conn &amp;&amp; this.conn.open) {
+      connection.on('open', () => {
+        connection.send('Already connected to another client');
+        setTimeout(() => {
+          connection.close();
+        }, 500);
+      });
+      return;
+    }
+    this.conn = connection;
+    console.log('Connected to: ', this.conn.peer);
+    this.ready();
+  };
+  /**
+   * Called after a call is established and data is flowing.
+   * Sets up the local audio stream and starts the calibration process.
+   * @param {MediaStream} stream - The stream of audio from the Listener.
+   */
+  onReceiveStream = stream => {
+    window.localStream = stream;
+    window.localAudio.srcObject = stream;
+    window.localAudio.autoplay = true;
+    // Start calibration
+    if (!this.ac.getCalibrationStatus()) {
+      this.ac.startCalibration(stream);
+    }
+  };
+  /**
+   * Called when a call is made by the Listener.
+   * Answers the call in a one-way manner, and sets up a stream listener.
+   * @param {*} call
+   */
+  onPeerCall = call => {
+    call.answer(); // Answer the call (one way)
+    this.ac.createLocalAudio(document.getElementById(this.targetElement));
+    call.on('stream', this.onReceiveStream);
+  };
+  /**
+   * Called when the peer connection is closed.
+   */
+  onPeerClose = () => {
+    this.conn = null;
+    console.log('Connection destroyed');
+  };
+  /**
+   * Called when the peer connection is disconnected.
+   * Attempts to reconnect.
+   */
+  onPeerDisconnected = () => {
+    console.log('Connection lost. Please reconnect');
+    // Workaround for peer.reconnect deleting previous id
+    this.peer.id = this.lastPeerId;
+    // eslint-disable-next-line no-underscore-dangle
+    this.peer._lastServerId = this.lastPeerId;
+    this.peer.reconnect();
+  };
+  /**
+   * Called when the peer connection encounters an error.
+   * @param {*} error
+   */
+  onPeerError = error => {
+    // TODO: check if this function is needed or not
+    console.error(error);
+  };
+  /**
+   * Called when data is received from the peer connection.
+   * @param {*} data
+   */
+  onIncomingData = data => {
+    // TODO: check if this function is needed or not
+    console.log({data});
+  };
+  /**
+   * Called when the peer connection is ready.
+   */
+  ready = () => {
+    // Perform callback with data
+    this.conn.on('data', this.onIncomingData);
+    this.conn.on('close', () => {
+      console.log('Connection reset&lt;br>Awaiting connection...');
+      this.conn = null;
+    });
+  };
+}
+/*
+Referenced links:
+https://stackoverflow.com/questions/28016664/when-you-pass-this-as-an-argument/28016676#28016676
+https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes
+https://stackoverflow.com/questions/879152/how-do-i-make-javascript-beep [3]
+*/
+export default Speaker;
+</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="Listener.html">Listener</a></li>
+        <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
+        <li><a href="Speaker.html">Speaker</a></li>
+      </ul>
+      <h3><a href="global.html">Global</a></h3>
+    </nav>
+    <br class="clear" />
+    <footer>
+      Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue
+      Mar 01 2022 12:39:42 GMT-0500 (Eastern Standard Time)
+    </footer>
+    <script>
+      prettyPrint();
+    </script>
+    <script src="scripts/linenumber.js"></script>
+  </body>
+</html>