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
  1. package/.eslintignore +72 -0
  2. package/.eslintrc.json +40 -0
  3. package/.gitignore +78 -0
  4. package/.prettierignore +70 -0
  5. package/.prettierrc +15 -0
  6. package/LICENSE +20 -20
  7. package/README.md +133 -133
  8. package/__mocks__/fileMock.js +1 -0
  9. package/__mocks__/styleMock.js +1 -0
  10. package/babel.config.js +3 -0
  11. package/coverage/clover.xml +71 -0
  12. package/coverage/coverage-final.json +224 -0
  13. package/coverage/lcov-report/PythonServerInterface.js.html +265 -0
  14. package/coverage/lcov-report/base.css +354 -0
  15. package/coverage/lcov-report/block-navigation.js +82 -0
  16. package/coverage/lcov-report/favicon.png +0 -0
  17. package/coverage/lcov-report/index.html +123 -0
  18. package/coverage/lcov-report/prettify.css +101 -0
  19. package/coverage/lcov-report/prettify.js +937 -0
  20. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  21. package/coverage/lcov-report/sorter.js +189 -0
  22. package/coverage/lcov-report/src/index.html +121 -0
  23. package/coverage/lcov-report/src/server/PythonServerInterface.js.html +268 -0
  24. package/coverage/lcov-report/src/server/index.html +123 -0
  25. package/coverage/lcov-report/src/tasks/audioCalibrator.js.html +499 -0
  26. package/coverage/lcov-report/src/tasks/audioRecorder.js.html +412 -0
  27. package/coverage/lcov-report/src/tasks/index.html +143 -0
  28. package/coverage/lcov-report/src/tasks/volume/index.html +123 -0
  29. package/coverage/lcov-report/src/tasks/volume/volume.js.html +409 -0
  30. package/coverage/lcov-report/src/utils.js.html +172 -0
  31. package/coverage/lcov.info +91 -0
  32. package/dist/example/Queen-Bohemian_Rhapsody.wav +0 -0
  33. package/dist/example/Queen-Bohemian_Rhapsody_g_filtered.wav +0 -0
  34. package/dist/example/index.html +47 -0
  35. package/dist/example/listener.html +89 -0
  36. package/dist/example/server.js +49 -0
  37. package/dist/example/speaker.html +126 -0
  38. package/dist/example/speakerUI.js +217 -0
  39. package/dist/example/styles.css +40 -0
  40. package/dist/main.js +1 -1
  41. package/dist/mlsGen.js +6814 -6814
  42. package/dist/mlsGen.wasm +0 -0
  43. package/doc/AudioCalibrator.html +417 -0
  44. package/doc/AudioPeer.html +251 -0
  45. package/doc/AudioRecorder.html +195 -0
  46. package/doc/ImpulseResponse.html +215 -0
  47. package/doc/Listener.html +308 -0
  48. package/doc/MlsGenInterface.html +226 -0
  49. package/doc/MyEventEmitter.html +274 -0
  50. package/doc/PythonServerAPI.html +109 -0
  51. package/doc/Speaker-Calibration-UML-Diagram.png +0 -0
  52. package/doc/Speaker.html +276 -0
  53. package/doc/Takes%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +128 -0
  54. package/doc/Takes%20the%20url%20of%20the%20current%20site%0Aand%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +138 -0
  55. package/doc/Takes%20the%20url%20of%20the%20current%20site%20and%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +137 -0
  56. package/doc/Volume.html +88 -0
  57. package/doc/audioCalibrator.js.html +179 -0
  58. package/doc/audioPeer.js.html +175 -0
  59. package/doc/audioRecorder.js.html +163 -0
  60. package/doc/creates%20a%20new%20AudioRecorder%20instance.%20%0ASets%20up%20the%20audio%20context%20and%20file%20reader..html +114 -0
  61. package/doc/fonts/OpenSans-Bold-webfont.eot +0 -0
  62. package/doc/fonts/OpenSans-Bold-webfont.svg +1830 -0
  63. package/doc/fonts/OpenSans-Bold-webfont.woff +0 -0
  64. package/doc/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  65. package/doc/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
  66. package/doc/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  67. package/doc/fonts/OpenSans-Italic-webfont.eot +0 -0
  68. package/doc/fonts/OpenSans-Italic-webfont.svg +1830 -0
  69. package/doc/fonts/OpenSans-Italic-webfont.woff +0 -0
  70. package/doc/fonts/OpenSans-Light-webfont.eot +0 -0
  71. package/doc/fonts/OpenSans-Light-webfont.svg +1831 -0
  72. package/doc/fonts/OpenSans-Light-webfont.woff +0 -0
  73. package/doc/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  74. package/doc/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
  75. package/doc/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  76. package/doc/fonts/OpenSans-Regular-webfont.eot +0 -0
  77. package/doc/fonts/OpenSans-Regular-webfont.svg +1831 -0
  78. package/doc/fonts/OpenSans-Regular-webfont.woff +0 -0
  79. package/doc/global.html +308 -0
  80. package/doc/index.html +58 -0
  81. package/doc/listener.js.html +170 -0
  82. package/doc/mlsGen_mlsGenInterface.js.html +117 -0
  83. package/doc/myEventEmitter.js.html +124 -0
  84. package/doc/peer-connection_audioPeer.js.html +188 -0
  85. package/doc/peer-connection_listener.js.html +311 -0
  86. package/doc/peer-connection_speaker.js.html +381 -0
  87. package/doc/sc-activity-diagram.png +0 -0
  88. package/doc/scripts/linenumber.js +25 -0
  89. package/doc/scripts/prettify/Apache-License-2.0.txt +202 -0
  90. package/doc/scripts/prettify/lang-css.js +24 -0
  91. package/doc/scripts/prettify/prettify.js +640 -0
  92. package/doc/server_PythonServerAPI.js.html +160 -0
  93. package/doc/speaker.js.html +248 -0
  94. package/doc/styles/jsdoc-default.css +371 -0
  95. package/doc/styles/prettify-jsdoc.css +111 -0
  96. package/doc/styles/prettify-tomorrow.css +163 -0
  97. package/doc/tasks_audioCalibrator.js.html +207 -0
  98. package/doc/tasks_audioRecorder.js.html +190 -0
  99. package/doc/tasks_impulse-response_impulseResponse.js.html +442 -0
  100. package/doc/tasks_impulse-response_mlsGen_mlsGenInterface.js.html +175 -0
  101. package/doc/tasks_volume_volume.js.html +185 -0
  102. package/doc/utils.js.html +105 -0
  103. package/jest.config.js +173 -0
  104. package/netlify.toml +27 -0
  105. package/package.json +67 -66
  106. package/src/index.html +21 -0
  107. package/src/main.js +21 -0
  108. package/src/myEventEmitter.js +83 -0
  109. package/src/peer-connection/audioPeer.js +151 -0
  110. package/src/peer-connection/listener.js +251 -0
  111. package/src/peer-connection/peerErrors.js +25 -0
  112. package/src/peer-connection/speaker.js +346 -0
  113. package/src/server/PythonServerAPI.js +117 -0
  114. package/src/tasks/audioCalibrator.js +218 -0
  115. package/src/tasks/audioRecorder.js +148 -0
  116. package/src/tasks/impulse-response/impulseResponse.js +436 -0
  117. package/src/tasks/impulse-response/mlsGen/mlsGen.cpp +99 -0
  118. package/src/tasks/impulse-response/mlsGen/mlsGen.hpp +304 -0
  119. package/src/tasks/impulse-response/mlsGen/mlsGenInterface.js +131 -0
  120. package/src/tasks/impulse-response/mlsGen/mlsGenTest.cpp +181 -0
  121. package/src/tasks/volume/volume.cpp +3 -0
  122. package/src/tasks/volume/volume.hpp +23 -0
  123. package/src/tasks/volume/volume.js +157 -0
  124. package/src/utils.js +55 -0
  125. package/webpack.config.js +37 -0
  126. package/README +0 -3
package/doc/tasks_audioCalibrator.js.html ADDED
@@ -0,0 +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>
package/doc/tasks_audioRecorder.js.html ADDED
@@ -0,0 +1,190 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <title>JSDoc: Source: tasks/audioRecorder.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/audioRecorder.js</h1>
19
+
20
+ <section>
21
+ <article>
22
+ <pre
23
+ class="prettyprint source linenums"
24
+ ><code>import MyEventEmitter from '../myEventEmitter';
25
+
26
+ /**
27
+ * @class provides a simple interface for recording audio from a microphone
28
+ * using the Media Recorder API.
29
+ */
30
+ class AudioRecorder extends MyEventEmitter {
31
+ /** @private */
32
+ #mediaRecorder;
33
+
34
+ /** @private */
35
+ #recordedChunks = [];
36
+
37
+ /** @private */
38
+ #audioBlob;
39
+
40
+ /** @private */
41
+ #audioContext;
42
+
43
+ /** @private */
44
+ #recordedSignals = [];
45
+
46
+ /** @private */
47
+ sinkSamplingRate;
48
+
49
+ /**
50
+ * Decode the audio data from the recorded audio blob.
51
+ * @private
52
+ */
53
+ #saveRecording = async () => {
54
+ const arrayBuffer = await this.#audioBlob.arrayBuffer();
55
+ const audioBuffer = await this.#audioContext.decodeAudioData(arrayBuffer);
56
+ const data = audioBuffer.getChannelData(0);
57
+
58
+ console.log(`Decoded audio buffer with ${data.length} samples`);
59
+ this.#recordedSignals.push(Array.from(data));
60
+ };
61
+
62
+ /**
63
+ * Event listener triggered when data is available in the media recorder.
64
+ * @private
65
+ * @param {*} e - The event object.
66
+ */
67
+ #onRecorderDataAvailable = e => {
68
+ if (e.data &amp;&amp; e.data.size > 0) this.#recordedChunks.push(e.data);
69
+ };
70
+
71
+ /**
72
+ * Method to create a media recorder object and set up event listeners.
73
+ * @private
74
+ * @param {MediaStream} stream - The stream of audio from the Listener.
75
+ */
76
+ #setMediaRecorder = stream => {
77
+ // Create a new MediaRecorder object
78
+ this.#mediaRecorder = new MediaRecorder(stream);
79
+
80
+ // Add event listeners
81
+ this.#mediaRecorder.ondataavailable = e => this.#onRecorderDataAvailable(e);
82
+ };
83
+
84
+ #setAudioContext = () => {
85
+ this.#audioContext = new (window.AudioContext ||
86
+ window.webkitAudioContext ||
87
+ window.audioContext)({
88
+ sampleRate: this.sinkSamplingRate,
89
+ });
90
+ };
91
+
92
+ /**
93
+ * Public method to start the recording process.
94
+ * @param {MediaStream} stream - The stream of audio from the Listener.
95
+ */
96
+ startRecording = async stream => {
97
+ // Create a fresh audio context
98
+ this.#setAudioContext();
99
+ // Set up media recorder if needed
100
+ if (!this.#mediaRecorder) this.#setMediaRecorder(stream);
101
+ // clear recorded chunks
102
+ this.#recordedChunks = [];
103
+ // start recording
104
+ this.#mediaRecorder.start();
105
+ };
106
+
107
+ /**
108
+ * Method to stop the recording process.
109
+ * @public
110
+ */
111
+ stopRecording = async () => {
112
+ // Stop the media recorder, and wait for the data to be available
113
+ await new Promise(resolve => {
114
+ this.#mediaRecorder.onstop = () => {
115
+ // when the stop event is triggered, resolve the promise
116
+ this.#audioBlob = new Blob(this.#recordedChunks, {
117
+ type: 'audio/wav; codecs=opus',
118
+ });
119
+ resolve(this.#audioBlob);
120
+ };
121
+ // call stop
122
+ this.#mediaRecorder.stop();
123
+ });
124
+ // Now that we have data, save it
125
+ await this.#saveRecording();
126
+ };
127
+
128
+ /**
129
+ * Public method to get the last recorded audio signal
130
+ * @returns
131
+ */
132
+ getLastRecordedSignal = () => this.#recordedSignals[this.#recordedSignals.length - 1];
133
+
134
+ /**
135
+ * Public method to get all the recorded audio signals
136
+ * @returns
137
+ */
138
+ getAllRecordedSignals = () => this.#recordedSignals;
139
+
140
+ /**
141
+ * Public method to set the sampling rate used by the capture device
142
+ * @param {Number} sinkSamplingRate - The sampling rate of the capture device
143
+ */
144
+ setSinkSamplingRate = sinkSamplingRate => {
145
+ this.sinkSamplingRate = sinkSamplingRate;
146
+ };
147
+ }
148
+
149
+ export default AudioRecorder;
150
+ </code></pre>
151
+ </article>
152
+ </section>
153
+ </div>
154
+
155
+ <nav>
156
+ <h2><a href="index.html">Home</a></h2>
157
+ <h3>Classes</h3>
158
+ <ul>
159
+ <li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
160
+ <li><a href="AudioPeer.html">AudioPeer</a></li>
161
+ <li><a href="AudioRecorder.html">AudioRecorder</a></li>
162
+ <li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
163
+ <li><a href="Listener.html">Listener</a></li>
164
+ <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
165
+ <li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
166
+ <li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
167
+ <li><a href="Speaker.html">Speaker</a></li>
168
+ <li><a href="Volume.html">Volume</a></li>
169
+ </ul>
170
+ <h3>Global</h3>
171
+ <ul>
172
+ <li><a href="global.html#csvToArray">csvToArray</a></li>
173
+ <li><a href="global.html#saveToCSV">saveToCSV</a></li>
174
+ <li><a href="global.html#sleep">sleep</a></li>
175
+ </ul>
176
+ </nav>
177
+
178
+ <br class="clear" />
179
+
180
+ <footer>
181
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
182
+ Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
183
+ </footer>
184
+
185
+ <script>
186
+ prettyPrint();
187
+ </script>
188
+ <script src="scripts/linenumber.js"></script>
189
+ </body>
190
+ </html>