speaker-calibration 2.2.211 → 2.2.212

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 (139) hide show
  1. package/.eslintignore +71 -71
  2. package/.eslintrc.json +40 -40
  3. package/.gitignore +81 -81
  4. package/.prettierignore +69 -69
  5. package/.prettierrc +14 -14
  6. package/LICENSE +20 -20
  7. package/README.md +133 -133
  8. package/__mocks__/fileMock.js +1 -1
  9. package/__mocks__/styleMock.js +1 -1
  10. package/babel.config.js +3 -3
  11. package/coverage/clover.xml +71 -71
  12. package/coverage/coverage-final.json +224 -224
  13. package/coverage/lcov-report/PythonServerInterface.js.html +265 -265
  14. package/coverage/lcov-report/base.css +354 -354
  15. package/coverage/lcov-report/block-navigation.js +82 -82
  16. package/coverage/lcov-report/favicon.png +0 -0
  17. package/coverage/lcov-report/index.html +123 -123
  18. package/coverage/lcov-report/prettify.css +101 -101
  19. package/coverage/lcov-report/prettify.js +937 -937
  20. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  21. package/coverage/lcov-report/sorter.js +189 -189
  22. package/coverage/lcov-report/src/index.html +121 -121
  23. package/coverage/lcov-report/src/server/PythonServerInterface.js.html +268 -268
  24. package/coverage/lcov-report/src/server/index.html +123 -123
  25. package/coverage/lcov-report/src/tasks/audioCalibrator.js.html +499 -499
  26. package/coverage/lcov-report/src/tasks/audioRecorder.js.html +412 -412
  27. package/coverage/lcov-report/src/tasks/index.html +143 -143
  28. package/coverage/lcov-report/src/tasks/volume/index.html +123 -123
  29. package/coverage/lcov-report/src/tasks/volume/volume.js.html +409 -409
  30. package/coverage/lcov-report/src/utils.js.html +172 -172
  31. package/coverage/lcov.info +91 -91
  32. package/dist/Procfile +0 -0
  33. package/dist/example/NoSleep.min.js +1 -1
  34. package/dist/example/credentials.json.gpg +0 -0
  35. package/dist/example/fetch-languages-sheets.js +77 -77
  36. package/dist/example/i18n.js +27366 -27366
  37. package/dist/example/index.html +47 -47
  38. package/dist/example/listener.html +79 -79
  39. package/dist/example/listener.js +152 -152
  40. package/dist/example/server.js +51 -51
  41. package/dist/example/speaker.html +145 -145
  42. package/dist/example/speakerUI.js +273 -273
  43. package/dist/example/styles.css +99 -99
  44. package/dist/main.js +1223 -1223
  45. package/dist/main.js.LICENSE.txt +118 -118
  46. package/dist/mlsGen.js +6814 -6814
  47. package/dist/mlsGen.wasm +0 -0
  48. package/dist/package-lock.json +1018 -1018
  49. package/dist/package.json +18 -18
  50. package/doc/AudioCalibrator.html +417 -417
  51. package/doc/AudioPeer.html +251 -251
  52. package/doc/AudioRecorder.html +195 -195
  53. package/doc/ImpulseResponse.html +215 -215
  54. package/doc/Listener.html +308 -308
  55. package/doc/MlsGenInterface.html +226 -226
  56. package/doc/MyEventEmitter.html +274 -274
  57. package/doc/PythonServerAPI.html +109 -109
  58. package/doc/Speaker-Calibration-UML-Diagram.png +0 -0
  59. package/doc/Speaker.html +276 -276
  60. package/doc/Takes%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +128 -128
  61. package/doc/Takes%20the%20url%20of%20the%20current%20site%0Aand%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +138 -138
  62. package/doc/Takes%20the%20url%20of%20the%20current%20site%20and%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +137 -137
  63. package/doc/Volume.html +88 -88
  64. package/doc/audioCalibrator.js.html +179 -179
  65. package/doc/audioPeer.js.html +175 -175
  66. package/doc/audioRecorder.js.html +163 -163
  67. package/doc/creates%20a%20new%20AudioRecorder%20instance.%20%0ASets%20up%20the%20audio%20context%20and%20file%20reader..html +114 -114
  68. package/doc/fonts/OpenSans-Bold-webfont.eot +0 -0
  69. package/doc/fonts/OpenSans-Bold-webfont.svg +1829 -1829
  70. package/doc/fonts/OpenSans-Bold-webfont.woff +0 -0
  71. package/doc/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  72. package/doc/fonts/OpenSans-BoldItalic-webfont.svg +1829 -1829
  73. package/doc/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  74. package/doc/fonts/OpenSans-Italic-webfont.eot +0 -0
  75. package/doc/fonts/OpenSans-Italic-webfont.svg +1829 -1829
  76. package/doc/fonts/OpenSans-Italic-webfont.woff +0 -0
  77. package/doc/fonts/OpenSans-Light-webfont.eot +0 -0
  78. package/doc/fonts/OpenSans-Light-webfont.svg +1830 -1830
  79. package/doc/fonts/OpenSans-Light-webfont.woff +0 -0
  80. package/doc/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  81. package/doc/fonts/OpenSans-LightItalic-webfont.svg +1834 -1834
  82. package/doc/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  83. package/doc/fonts/OpenSans-Regular-webfont.eot +0 -0
  84. package/doc/fonts/OpenSans-Regular-webfont.svg +1830 -1830
  85. package/doc/fonts/OpenSans-Regular-webfont.woff +0 -0
  86. package/doc/global.html +308 -308
  87. package/doc/index.html +58 -58
  88. package/doc/listener.js.html +170 -170
  89. package/doc/mlsGen_mlsGenInterface.js.html +117 -117
  90. package/doc/myEventEmitter.js.html +124 -124
  91. package/doc/peer-connection_audioPeer.js.html +188 -188
  92. package/doc/peer-connection_listener.js.html +311 -311
  93. package/doc/peer-connection_speaker.js.html +381 -381
  94. package/doc/sc-activity-diagram.png +0 -0
  95. package/doc/scripts/linenumber.js +25 -25
  96. package/doc/scripts/prettify/Apache-License-2.0.txt +202 -202
  97. package/doc/scripts/prettify/lang-css.js +24 -24
  98. package/doc/scripts/prettify/prettify.js +640 -640
  99. package/doc/server_PythonServerAPI.js.html +160 -160
  100. package/doc/speaker.js.html +248 -248
  101. package/doc/styles/jsdoc-default.css +371 -371
  102. package/doc/styles/prettify-jsdoc.css +111 -111
  103. package/doc/styles/prettify-tomorrow.css +163 -163
  104. package/doc/tasks_audioCalibrator.js.html +207 -207
  105. package/doc/tasks_audioRecorder.js.html +190 -190
  106. package/doc/tasks_impulse-response_impulseResponse.js.html +442 -442
  107. package/doc/tasks_impulse-response_mlsGen_mlsGenInterface.js.html +175 -175
  108. package/doc/tasks_volume_volume.js.html +185 -185
  109. package/doc/utils.js.html +105 -105
  110. package/jest.config.js +173 -173
  111. package/netlify.toml +26 -26
  112. package/package.json +73 -73
  113. package/src/config/firebase.js +26 -26
  114. package/src/index.html +21 -21
  115. package/src/main.js +23 -23
  116. package/src/myEventEmitter.js +83 -83
  117. package/src/peer-connection/audioPeer.js +183 -183
  118. package/src/peer-connection/listener.js +367 -364
  119. package/src/peer-connection/peerErrors.js +25 -25
  120. package/src/peer-connection/speaker.js +738 -738
  121. package/src/powerCheck.js +98 -98
  122. package/src/server/PythonServerAPI.js +869 -869
  123. package/src/tasks/audioCalibrator.js +351 -351
  124. package/src/tasks/audioRecorder.js +315 -315
  125. package/src/tasks/combination/combination.js +3030 -3030
  126. package/src/tasks/combination/mlsGen/mlsGen.cpp +98 -98
  127. package/src/tasks/combination/mlsGen/mlsGen.hpp +303 -303
  128. package/src/tasks/combination/mlsGen/mlsGenInterface.js +131 -131
  129. package/src/tasks/combination/mlsGen/mlsGenTest.cpp +180 -180
  130. package/src/tasks/impulse-response/impulseResponse.js +610 -610
  131. package/src/tasks/impulse-response/mlsGen/mlsGen.cpp +98 -98
  132. package/src/tasks/impulse-response/mlsGen/mlsGen.hpp +303 -303
  133. package/src/tasks/impulse-response/mlsGen/mlsGenInterface.js +131 -131
  134. package/src/tasks/impulse-response/mlsGen/mlsGenTest.cpp +180 -180
  135. package/src/tasks/volume/volume.cpp +2 -2
  136. package/src/tasks/volume/volume.hpp +22 -22
  137. package/src/tasks/volume/volume.js +279 -279
  138. package/src/utils.js +205 -205
  139. package/webpack.config.js +37 -37
package/doc/tasks_audioCalibrator.js.html CHANGED
@@ -1,207 +1,207 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8" />
5
- <title>JSDoc: Source: tasks/audioCalibrator.js</title>
6
-
7
- <script src="scripts/prettify/prettify.js"></script>
8
- <script src="scripts/prettify/lang-css.js"></script>
9
- <!--[if lt IE 9]>
10
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
- <![endif]-->
12
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css" />
13
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css" />
14
- </head>
15
-
16
- <body>
17
- <div id="main">
18
- <h1 class="page-title">Source: tasks/audioCalibrator.js</h1>
19
-
20
- <section>
21
- <article>
22
- <pre class="prettyprint source linenums"><code>/* eslint-disable no-await-in-loop */
23
- import AudioRecorder from './audioRecorder';
24
- import PythonServerAPI from '../server/PythonServerAPI';
25
- import {sleep, saveToCSV} from '../utils';
26
-
27
- /**
28
- * Provides methods for calibrating the user's speakers
29
- * @extends AudioRecorder
30
- */
31
- class AudioCalibrator extends AudioRecorder {
32
- /**
33
- *
34
- */
35
- constructor(numCaptures = 1, numMLSPerCapture = 1) {
36
- super();
37
- this.numCaptures = numCaptures;
38
- this.numMLSPerCapture = numMLSPerCapture;
39
- this.pyServerAPI = new PythonServerAPI();
40
- }
41
-
42
- /** @private */
43
- #isCalibrating = false;
44
-
45
- /** @private */
46
- sourceAudioContext;
47
-
48
- /** @protected */
49
- numCalibratingRounds;
50
-
51
- /** @protected */
52
- numSuccessfulCaptured = 0;
53
-
54
- /** @private */
55
- sourceSamplingRate;
56
-
57
- /** @protected */
58
- calibrationNodes = [];
59
-
60
- /** @protected */
61
- localAudio;
62
-
63
- /**
64
- * Called when a call is received.
65
- * Creates a local audio DOM element and attaches it to the page.
66
- */
67
- createLocalAudio = targetElement => {
68
- this.localAudio = document.createElement('audio');
69
- this.localAudio.setAttribute('id', 'localAudio');
70
- targetElement.appendChild(this.localAudio);
71
- };
72
-
73
- /**
74
- *
75
- * @param {MediaStream} stream
76
- * @param {Function} playCalibrationAudio - (async) function that plays the calibration audio
77
- * @param {*} beforePlay - (async) function that is called before playing the audio
78
- * @param {*} beforeRecord - (async) function that is called before recording
79
- * @param {*} duringRecord - (async) function that is called while recording
80
- * @param {*} afterRecord - (async) function that is called after recording
81
- */
82
- calibrationSteps = async (
83
- stream,
84
- playCalibrationAudio,
85
- beforePlay = async () => {},
86
- beforeRecord = async () => {},
87
- duringRecord = async () => {},
88
- afterRecord = async () => {}
89
- ) => {
90
- this.numSuccessfulCaptured = 0;
91
-
92
- // do something before recording such as awaiting a certain amount of time
93
- await beforeRecord();
94
-
95
- // calibration loop
96
- while (this.numSuccessfulCaptured &lt; this.numCaptures) {
97
- // do something before playing such as using the MLS to fill the buffers
98
- await beforePlay();
99
-
100
- // start recording
101
- await this.startRecording(stream);
102
-
103
- // play calibration audio
104
- playCalibrationAudio();
105
-
106
- // do something during the recording such as sleep n amount of time
107
- await duringRecord();
108
-
109
- // when done, stop recording
110
- await this.stopRecording();
111
-
112
- // do something after recording such as start processing values
113
- await afterRecord();
114
-
115
- // eslint-disable-next-line no-await-in-loop
116
- this.calibrationNodes = [];
117
- await sleep(3);
118
- }
119
- };
120
-
121
- /**
122
- * Getter for the isCalibrating property.
123
- * @public
124
- * @returns {Boolean} - True if the audio is being calibrated, false otherwise.
125
- */
126
- getCalibrationStatus = () => this.#isCalibrating;
127
-
128
- /**
129
- * Set the sampling rate to the value received from the listener
130
- * @param {*} sinkSamplingRate
131
- */
132
- setSamplingRates = samplingRate => {
133
- this.sinkSamplingRate = samplingRate;
134
- this.sourceSamplingRate = samplingRate;
135
- this.emit('update', {message: `sampling at ${samplingRate}Hz...`});
136
- };
137
-
138
- sampleRatesSet = () => this.sourceSamplingRate &amp;&amp; this.sinkSamplingRate;
139
-
140
- addCalibrationNode = node => {
141
- this.calibrationNodes.push(node);
142
- };
143
-
144
- makeNewSourceAudioContext = () => {
145
- const options = {
146
- sampleRate: this.sourceSamplingRate,
147
- };
148
-
149
- this.sourceAudioContext = new (window.AudioContext ||
150
- window.webkitAudioContext ||
151
- window.audioContext)(options);
152
-
153
- return this.sourceAudioContext;
154
- };
155
-
156
- /**
157
- * Download the result of the calibration roudns
158
- */
159
- downloadData = () => {
160
- const recordings = this.getAllRecordedSignals();
161
- const i = recordings.length - 1;
162
- saveToCSV(recordings[i], `recordedMLSignal_${i}.csv`);
163
- };
164
- }
165
-
166
- export default AudioCalibrator;
167
- </code></pre>
168
- </article>
169
- </section>
170
- </div>
171
-
172
- <nav>
173
- <h2><a href="index.html">Home</a></h2>
174
- <h3>Classes</h3>
175
- <ul>
176
- <li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
177
- <li><a href="AudioPeer.html">AudioPeer</a></li>
178
- <li><a href="AudioRecorder.html">AudioRecorder</a></li>
179
- <li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
180
- <li><a href="Listener.html">Listener</a></li>
181
- <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
182
- <li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
183
- <li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
184
- <li><a href="Speaker.html">Speaker</a></li>
185
- <li><a href="Volume.html">Volume</a></li>
186
- </ul>
187
- <h3>Global</h3>
188
- <ul>
189
- <li><a href="global.html#csvToArray">csvToArray</a></li>
190
- <li><a href="global.html#saveToCSV">saveToCSV</a></li>
191
- <li><a href="global.html#sleep">sleep</a></li>
192
- </ul>
193
- </nav>
194
-
195
- <br class="clear" />
196
-
197
- <footer>
198
- Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
199
- Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
200
- </footer>
201
-
202
- <script>
203
- prettyPrint();
204
- </script>
205
- <script src="scripts/linenumber.js"></script>
206
- </body>
207
- </html>
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <title>JSDoc: Source: tasks/audioCalibrator.js</title>
6
+
7
+ <script src="scripts/prettify/prettify.js"></script>
8
+ <script src="scripts/prettify/lang-css.js"></script>
9
+ <!--[if lt IE 9]>
10
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
+ <![endif]-->
12
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css" />
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css" />
14
+ </head>
15
+
16
+ <body>
17
+ <div id="main">
18
+ <h1 class="page-title">Source: tasks/audioCalibrator.js</h1>
19
+
20
+ <section>
21
+ <article>
22
+ <pre class="prettyprint source linenums"><code>/* eslint-disable no-await-in-loop */
23
+ import AudioRecorder from './audioRecorder';
24
+ import PythonServerAPI from '../server/PythonServerAPI';
25
+ import {sleep, saveToCSV} from '../utils';
26
+
27
+ /**
28
+ * Provides methods for calibrating the user's speakers
29
+ * @extends AudioRecorder
30
+ */
31
+ class AudioCalibrator extends AudioRecorder {
32
+ /**
33
+ *
34
+ */
35
+ constructor(numCaptures = 1, numMLSPerCapture = 1) {
36
+ super();
37
+ this.numCaptures = numCaptures;
38
+ this.numMLSPerCapture = numMLSPerCapture;
39
+ this.pyServerAPI = new PythonServerAPI();
40
+ }
41
+
42
+ /** @private */
43
+ #isCalibrating = false;
44
+
45
+ /** @private */
46
+ sourceAudioContext;
47
+
48
+ /** @protected */
49
+ numCalibratingRounds;
50
+
51
+ /** @protected */
52
+ numSuccessfulCaptured = 0;
53
+
54
+ /** @private */
55
+ sourceSamplingRate;
56
+
57
+ /** @protected */
58
+ calibrationNodes = [];
59
+
60
+ /** @protected */
61
+ localAudio;
62
+
63
+ /**
64
+ * Called when a call is received.
65
+ * Creates a local audio DOM element and attaches it to the page.
66
+ */
67
+ createLocalAudio = targetElement => {
68
+ this.localAudio = document.createElement('audio');
69
+ this.localAudio.setAttribute('id', 'localAudio');
70
+ targetElement.appendChild(this.localAudio);
71
+ };
72
+
73
+ /**
74
+ *
75
+ * @param {MediaStream} stream
76
+ * @param {Function} playCalibrationAudio - (async) function that plays the calibration audio
77
+ * @param {*} beforePlay - (async) function that is called before playing the audio
78
+ * @param {*} beforeRecord - (async) function that is called before recording
79
+ * @param {*} duringRecord - (async) function that is called while recording
80
+ * @param {*} afterRecord - (async) function that is called after recording
81
+ */
82
+ calibrationSteps = async (
83
+ stream,
84
+ playCalibrationAudio,
85
+ beforePlay = async () => {},
86
+ beforeRecord = async () => {},
87
+ duringRecord = async () => {},
88
+ afterRecord = async () => {}
89
+ ) => {
90
+ this.numSuccessfulCaptured = 0;
91
+
92
+ // do something before recording such as awaiting a certain amount of time
93
+ await beforeRecord();
94
+
95
+ // calibration loop
96
+ while (this.numSuccessfulCaptured &lt; this.numCaptures) {
97
+ // do something before playing such as using the MLS to fill the buffers
98
+ await beforePlay();
99
+
100
+ // start recording
101
+ await this.startRecording(stream);
102
+
103
+ // play calibration audio
104
+ playCalibrationAudio();
105
+
106
+ // do something during the recording such as sleep n amount of time
107
+ await duringRecord();
108
+
109
+ // when done, stop recording
110
+ await this.stopRecording();
111
+
112
+ // do something after recording such as start processing values
113
+ await afterRecord();
114
+
115
+ // eslint-disable-next-line no-await-in-loop
116
+ this.calibrationNodes = [];
117
+ await sleep(3);
118
+ }
119
+ };
120
+
121
+ /**
122
+ * Getter for the isCalibrating property.
123
+ * @public
124
+ * @returns {Boolean} - True if the audio is being calibrated, false otherwise.
125
+ */
126
+ getCalibrationStatus = () => this.#isCalibrating;
127
+
128
+ /**
129
+ * Set the sampling rate to the value received from the listener
130
+ * @param {*} sinkSamplingRate
131
+ */
132
+ setSamplingRates = samplingRate => {
133
+ this.sinkSamplingRate = samplingRate;
134
+ this.sourceSamplingRate = samplingRate;
135
+ this.emit('update', {message: `sampling at ${samplingRate}Hz...`});
136
+ };
137
+
138
+ sampleRatesSet = () => this.sourceSamplingRate &amp;&amp; this.sinkSamplingRate;
139
+
140
+ addCalibrationNode = node => {
141
+ this.calibrationNodes.push(node);
142
+ };
143
+
144
+ makeNewSourceAudioContext = () => {
145
+ const options = {
146
+ sampleRate: this.sourceSamplingRate,
147
+ };
148
+
149
+ this.sourceAudioContext = new (window.AudioContext ||
150
+ window.webkitAudioContext ||
151
+ window.audioContext)(options);
152
+
153
+ return this.sourceAudioContext;
154
+ };
155
+
156
+ /**
157
+ * Download the result of the calibration roudns
158
+ */
159
+ downloadData = () => {
160
+ const recordings = this.getAllRecordedSignals();
161
+ const i = recordings.length - 1;
162
+ saveToCSV(recordings[i], `recordedMLSignal_${i}.csv`);
163
+ };
164
+ }
165
+
166
+ export default AudioCalibrator;
167
+ </code></pre>
168
+ </article>
169
+ </section>
170
+ </div>
171
+
172
+ <nav>
173
+ <h2><a href="index.html">Home</a></h2>
174
+ <h3>Classes</h3>
175
+ <ul>
176
+ <li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
177
+ <li><a href="AudioPeer.html">AudioPeer</a></li>
178
+ <li><a href="AudioRecorder.html">AudioRecorder</a></li>
179
+ <li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
180
+ <li><a href="Listener.html">Listener</a></li>
181
+ <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
182
+ <li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
183
+ <li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
184
+ <li><a href="Speaker.html">Speaker</a></li>
185
+ <li><a href="Volume.html">Volume</a></li>
186
+ </ul>
187
+ <h3>Global</h3>
188
+ <ul>
189
+ <li><a href="global.html#csvToArray">csvToArray</a></li>
190
+ <li><a href="global.html#saveToCSV">saveToCSV</a></li>
191
+ <li><a href="global.html#sleep">sleep</a></li>
192
+ </ul>
193
+ </nav>
194
+
195
+ <br class="clear" />
196
+
197
+ <footer>
198
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
199
+ Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
200
+ </footer>
201
+
202
+ <script>
203
+ prettyPrint();
204
+ </script>
205
+ <script src="scripts/linenumber.js"></script>
206
+ </body>
207
+ </html>