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/AudioRecorder.html ADDED Viewed

@@ -0,0 +1,195 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>JSDoc: Class: AudioRecorder</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">Class: AudioRecorder</h1>
+      <section>
+        <header>
+          <h2>
+            <span class="attribs"><span class="type-signature"></span></span>AudioRecorder<span
+              class="signature"
+              >()</span
+            ><span class="type-signature"></span>
+          </h2>
+          <div class="class-description">
+            provides a simple interface for recording audio from a microphone using the Media
+            Recorder API.
+          </div>
+        </header>
+        <article>
+          <div class="container-overview">
+            <h2>Constructor</h2>
+            <h4 class="name" id="AudioRecorder">
+              <span class="type-signature"></span>new AudioRecorder<span class="signature">()</span
+              ><span class="type-signature"></span>
+            </h4>
+            <dl class="details">
+              <dt class="tag-source">Source:</dt>
+              <dd class="tag-source">
+                <ul class="dummy">
+                  <li>
+                    <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
+                    <a href="tasks_audioRecorder.js.html#line7">line 7</a>
+                  </li>
+                </ul>
+              </dd>
+            </dl>
+          </div>
+          <h3 class="subsection-title">Members</h3>
+          <h4 class="name" id="getAllRecordedSignals">
+            <span class="type-signature"></span>getAllRecordedSignals<span
+              class="type-signature"
+            ></span>
+          </h4>
+          <div class="description">Public method to get all the recorded audio signals</div>
+          <dl class="details">
+            <dt class="tag-source">Source:</dt>
+            <dd class="tag-source">
+              <ul class="dummy">
+                <li>
+                  <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
+                  <a href="tasks_audioRecorder.js.html#line115">line 115</a>
+                </li>
+              </ul>
+            </dd>
+          </dl>
+          <h4 class="name" id="getLastRecordedSignal">
+            <span class="type-signature"></span>getLastRecordedSignal<span
+              class="type-signature"
+            ></span>
+          </h4>
+          <div class="description">Public method to get the last recorded audio signal</div>
+          <dl class="details">
+            <dt class="tag-source">Source:</dt>
+            <dd class="tag-source">
+              <ul class="dummy">
+                <li>
+                  <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
+                  <a href="tasks_audioRecorder.js.html#line109">line 109</a>
+                </li>
+              </ul>
+            </dd>
+          </dl>
+          <h4 class="name" id="setSinkSamplingRate">
+            <span class="type-signature"></span>setSinkSamplingRate<span
+              class="type-signature"
+            ></span>
+          </h4>
+          <div class="description">
+            Public method to set the sampling rate used by the capture device
+          </div>
+          <dl class="details">
+            <dt class="tag-source">Source:</dt>
+            <dd class="tag-source">
+              <ul class="dummy">
+                <li>
+                  <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
+                  <a href="tasks_audioRecorder.js.html#line121">line 121</a>
+                </li>
+              </ul>
+            </dd>
+          </dl>
+          <h4 class="name" id="startRecording">
+            <span class="type-signature"></span>startRecording<span class="type-signature"></span>
+          </h4>
+          <div class="description">Public method to start the recording process.</div>
+          <dl class="details">
+            <dt class="tag-source">Source:</dt>
+            <dd class="tag-source">
+              <ul class="dummy">
+                <li>
+                  <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
+                  <a href="tasks_audioRecorder.js.html#line73">line 73</a>
+                </li>
+              </ul>
+            </dd>
+          </dl>
+          <h4 class="name" id="stopRecording">
+            <span class="type-signature"></span>stopRecording<span class="type-signature"></span>
+          </h4>
+          <div class="description">Method to stop the recording process.</div>
+          <dl class="details">
+            <dt class="tag-source">Source:</dt>
+            <dd class="tag-source">
+              <ul class="dummy">
+                <li>
+                  <a href="tasks_audioRecorder.js.html">tasks/audioRecorder.js</a>,
+                  <a href="tasks_audioRecorder.js.html#line88">line 88</a>
+                </li>
+              </ul>
+            </dd>
+          </dl>
+        </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/ImpulseResponse.html ADDED Viewed

@@ -0,0 +1,215 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>JSDoc: Class: ImpulseResponse</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">Class: ImpulseResponse</h1>
+      <section>
+        <header>
+          <h2>
+            <span class="attribs"><span class="type-signature"></span></span>ImpulseResponse<span
+              class="signature"
+              >(param0)</span
+            ><span class="type-signature"></span>
+          </h2>
+        </header>
+        <article>
+          <div class="container-overview">
+            <h4 class="name" id="ImpulseResponse">
+              <span class="type-signature"></span>new ImpulseResponse<span class="signature"
+                >(param0)</span
+              ><span class="type-signature"></span>
+            </h4>
+            <div class="description">
+              Default constructor. Creates an instance with any number of paramters passed or the
+              default parameters defined here.
+            </div>
+            <h5>Parameters:</h5>
+            <table class="params">
+              <thead>
+                <tr>
+                  <th>Name</th>
+                  <th>Type</th>
+                  <th class="last">Description</th>
+                </tr>
+              </thead>
+              <tbody>
+                <tr>
+                  <td class="name"><code>param0</code></td>
+                  <td class="type">
+                    <span class="param-type">*</span>
+                  </td>
+                  <td class="description last"></td>
+                </tr>
+              </tbody>
+            </table>
+            <dl class="details">
+              <dt class="tag-source">Source:</dt>
+              <dd class="tag-source">
+                <ul class="dummy">
+                  <li>
+                    <a href="tasks_impulse-response_impulseResponse.js.html"
+                      >tasks/impulse-response/impulseResponse.js</a
+                    >, <a href="tasks_impulse-response_impulseResponse.js.html#line9">line 9</a>
+                  </li>
+                </ul>
+              </dd>
+            </dl>
+          </div>
+          <h3 class="subsection-title">Members</h3>
+          <h4 class="name" id="createSCurveBuffer">
+            <span class="type-signature"></span>createSCurveBuffer<span
+              class="type-signature"
+            ></span>
+          </h4>
+          <div class="description">Created an S Curver Buffer to taper the signal onset</div>
+          <dl class="details">
+            <dt class="tag-source">Source:</dt>
+            <dd class="tag-source">
+              <ul class="dummy">
+                <li>
+                  <a href="tasks_impulse-response_impulseResponse.js.html"
+                    >tasks/impulse-response/impulseResponse.js</a
+                  >, <a href="tasks_impulse-response_impulseResponse.js.html#line149">line 149</a>
+                </li>
+              </ul>
+            </dd>
+          </dl>
+          <h4 class="name" id="sendImpulseResponsesToServerForProcessing">
+            <span class="type-signature"></span>sendImpulseResponsesToServerForProcessing<span
+              class="type-signature"
+            ></span>
+          </h4>
+          <div class="description">
+            Sends all the computed impulse responses to the backend server for processing
+          </div>
+          <dl class="details">
+            <dt class="tag-source">Source:</dt>
+            <dd class="tag-source">
+              <ul class="dummy">
+                <li>
+                  <a href="tasks_impulse-response_impulseResponse.js.html"
+                    >tasks/impulse-response/impulseResponse.js</a
+                  >, <a href="tasks_impulse-response_impulseResponse.js.html#line51">line 51</a>
+                </li>
+              </ul>
+            </dd>
+          </dl>
+          <h4 class="name" id="sendRecordingToServerForProcessing">
+            <span class="type-signature"></span>sendRecordingToServerForProcessing<span
+              class="type-signature"
+            ></span>
+          </h4>
+          <div class="description">
+            Sends the recorded signal, or a given csv string of a signal, to the back end server for
+            processing
+          </div>
+          <dl class="details">
+            <dt class="tag-source">Source:</dt>
+            <dd class="tag-source">
+              <ul class="dummy">
+                <li>
+                  <a href="tasks_impulse-response_impulseResponse.js.html"
+                    >tasks/impulse-response/impulseResponse.js</a
+                  >, <a href="tasks_impulse-response_impulseResponse.js.html#line72">line 72</a>
+                </li>
+              </ul>
+            </dd>
+          </dl>
+          <h4 class="name" id="startCalibration">
+            <span class="type-signature"></span>startCalibration<span class="type-signature"></span>
+          </h4>
+          <div class="description">
+            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.
+          </div>
+          <dl class="details">
+            <dt class="tag-source">Source:</dt>
+            <dd class="tag-source">
+              <ul class="dummy">
+                <li>
+                  <a href="tasks_impulse-response_impulseResponse.js.html"
+                    >tasks/impulse-response/impulseResponse.js</a
+                  >, <a href="tasks_impulse-response_impulseResponse.js.html#line344">line 344</a>
+                </li>
+              </ul>
+            </dd>
+          </dl>
+        </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>