speaker-calibration 2.2.206 → 2.2.207

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 (141) hide show
  1. package/.eslintignore +71 -71
  2. package/.eslintrc.json +40 -40
  3. package/.github/workflows/update-phrases.yml +37 -0
  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 +17 -17
  45. package/dist/main.js.LICENSE.txt +0 -0
  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/makefile +74 -0
  112. package/netlify.toml +26 -26
  113. package/package.json +73 -73
  114. package/src/config/firebase.js +26 -26
  115. package/src/index.html +21 -21
  116. package/src/main.js +23 -23
  117. package/src/myEventEmitter.js +83 -83
  118. package/src/peer-connection/audioPeer.js +178 -178
  119. package/src/peer-connection/listener.js +362 -360
  120. package/src/peer-connection/peerErrors.js +25 -25
  121. package/src/peer-connection/speaker.js +736 -736
  122. package/src/powerCheck.js +98 -98
  123. package/src/server/PythonServerAPI.js +869 -869
  124. package/src/tasks/audioCalibrator.js +336 -336
  125. package/src/tasks/audioRecorder.js +315 -315
  126. package/src/tasks/combination/combination.js +3008 -3008
  127. package/src/tasks/combination/mlsGen/mlsGen.cpp +98 -98
  128. package/src/tasks/combination/mlsGen/mlsGen.hpp +303 -303
  129. package/src/tasks/combination/mlsGen/mlsGenInterface.js +131 -131
  130. package/src/tasks/combination/mlsGen/mlsGenTest.cpp +180 -180
  131. package/src/tasks/impulse-response/impulseResponse.js +610 -610
  132. package/src/tasks/impulse-response/mlsGen/mlsGen.cpp +98 -98
  133. package/src/tasks/impulse-response/mlsGen/mlsGen.hpp +303 -303
  134. package/src/tasks/impulse-response/mlsGen/mlsGenInterface.js +131 -131
  135. package/src/tasks/impulse-response/mlsGen/mlsGenTest.cpp +180 -180
  136. package/src/tasks/volume/volume.cpp +2 -2
  137. package/src/tasks/volume/volume.hpp +22 -22
  138. package/src/tasks/volume/volume.js +279 -279
  139. package/src/utils.js +205 -205
  140. package/webpack.config.js +37 -37
  141. package/.gitignore +0 -81
package/doc/audioCalibrator.js.html CHANGED
@@ -1,179 +1,179 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8" />
5
- <title>JSDoc: Source: 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: audioCalibrator.js</h1>
19
-
20
- <section>
21
- <article>
22
- <pre
23
- class="prettyprint source linenums"
24
- ><code>import AudioRecorder from "./audioRecorder";
25
- import visualize from "./visualize";
26
- import MlsGenInterface from "./mlsGen/mlsGenInterface";
27
-
28
- /**
29
- * Provides methods for calibrating the user's speakers
30
- * @extends AudioRecorder
31
- */
32
- class AudioCalibrator extends AudioRecorder {
33
- /** @private */
34
- #isCalibrating = false;
35
-
36
- /** @private */
37
- #sourceAudio;
38
-
39
- /** @private */
40
- #sourceAudioContext;
41
-
42
- /** @private */
43
- #sourceAudioAnalyser;
44
-
45
- /** @private */
46
- #sinkAudioContext;
47
-
48
- /** @private */
49
- #sinkAudioAnalyser;
50
-
51
- /** @private */
52
- #mlsGenInterface;
53
-
54
- /**
55
- * Creates an instance of AudioCalibrator
56
- * Makes a call to the super constructor, and initializes MLSGenInterface
57
- */
58
- constructor() {
59
- super();
60
- this.#mlsGenInterface = new MlsGenInterface();
61
- }
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
- const localAudio = document.createElement("audio");
69
- localAudio.setAttribute("id", "localAudio");
70
- targetElement.appendChild(localAudio);
71
- };
72
-
73
- /**
74
- * Creates an audio context and plays it for a few seconds.
75
- * @private
76
- * @returns {Promise} - Resolves when the audio is done playing.
77
- */
78
- #playCalibrationAudio = () => {
79
- // const buffer = new ArrayBuffer(this.#mlsData.length);
80
- // const view = new Uint8Array(buffer);
81
- // const duration = 2000;
82
-
83
- // for (let i; i &lt; this.#mlsData.length; i += 1) {
84
- // view[i] = this.#mlsData[i];
85
- // }
86
-
87
- // this.#sourceAudioContext = new AudioContext();
88
-
89
- // // TODO: Uncaught (in promise) DOMException: Unable to decode audio data
90
- // // Possibly to do with the type of audio data being passed in.
91
- // this.#sourceAudioContext.decodeAudioData(buffer).then((buf) => {
92
- // // Create a source node from the buffer
93
- // this.#sourceAudio = this.#sourceAudioContext.createBufferSource();
94
- // this.#sourceAudio.buffer = buf;
95
- // // Connect to the final output node (the speakers)
96
- // this.#sourceAudio.connect(this.#sourceAudioContext.destination);
97
- // // Play immediately
98
- // this.#sourceAudio.start(0);
99
- // });
100
-
101
- // let's return a promise so we can await the end of each track
102
- return new Promise((resolve) => {
103
- setTimeout(resolve, duration * 2);
104
- });
105
- };
106
-
107
- /**
108
- * Getter for the isCalibrating property.
109
- * @public
110
- * @returns {Boolean} - True if the audio is being calibrated, false otherwise.
111
- */
112
- getCalibrationStatus = () => this.#isCalibrating;
113
-
114
- setSinkAudio = (stream) => {
115
- this.#sinkAudioContext = new AudioContext();
116
- this.#sinkAudioAnalyser = this.#sinkAudioContext.createAnalyser();
117
- const source = this.#sinkAudioContext.createMediaStreamSource(stream);
118
- source.connect(this.#sinkAudioAnalyser);
119
- visualize(this.#sinkAudioAnalyser);
120
- };
121
-
122
- /**
123
- * Method to start the calibration process.
124
- * @public
125
- * @param {MediaStream} stream - The stream of audio from the Listener.
126
- */
127
- startCalibration = async (stream) => {
128
- this.setSinkAudio(stream);
129
- this.#mlsGenInterface.getMls();
130
-
131
- let numRounds = 0;
132
-
133
- while (!this.#isCalibrating &amp;&amp; numRounds &lt;= 2) {
134
- // start recording
135
- this.startRecording(stream);
136
- // play calibration audio
137
- // eslint-disable-next-line no-await-in-loop
138
- await this.#playCalibrationAudio().then(() => {
139
- // when done, stop recording
140
- this.stopRecording();
141
- });
142
- numRounds += 1;
143
- }
144
- };
145
- }
146
-
147
- export default AudioCalibrator;
148
- </code></pre>
149
- </article>
150
- </section>
151
- </div>
152
-
153
- <nav>
154
- <h2><a href="index.html">Home</a></h2>
155
- <h3>Classes</h3>
156
- <ul>
157
- <li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
158
- <li><a href="AudioPeer.html">AudioPeer</a></li>
159
- <li><a href="AudioRecorder.html">AudioRecorder</a></li>
160
- <li><a href="Listener.html">Listener</a></li>
161
- <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
162
- <li><a href="Speaker.html">Speaker</a></li>
163
- </ul>
164
- <h3><a href="global.html">Global</a></h3>
165
- </nav>
166
-
167
- <br class="clear" />
168
-
169
- <footer>
170
- Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue
171
- Mar 01 2022 12:39:42 GMT-0500 (Eastern Standard Time)
172
- </footer>
173
-
174
- <script>
175
- prettyPrint();
176
- </script>
177
- <script src="scripts/linenumber.js"></script>
178
- </body>
179
- </html>
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <title>JSDoc: Source: 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: audioCalibrator.js</h1>
19
+
20
+ <section>
21
+ <article>
22
+ <pre
23
+ class="prettyprint source linenums"
24
+ ><code>import AudioRecorder from "./audioRecorder";
25
+ import visualize from "./visualize";
26
+ import MlsGenInterface from "./mlsGen/mlsGenInterface";
27
+
28
+ /**
29
+ * Provides methods for calibrating the user's speakers
30
+ * @extends AudioRecorder
31
+ */
32
+ class AudioCalibrator extends AudioRecorder {
33
+ /** @private */
34
+ #isCalibrating = false;
35
+
36
+ /** @private */
37
+ #sourceAudio;
38
+
39
+ /** @private */
40
+ #sourceAudioContext;
41
+
42
+ /** @private */
43
+ #sourceAudioAnalyser;
44
+
45
+ /** @private */
46
+ #sinkAudioContext;
47
+
48
+ /** @private */
49
+ #sinkAudioAnalyser;
50
+
51
+ /** @private */
52
+ #mlsGenInterface;
53
+
54
+ /**
55
+ * Creates an instance of AudioCalibrator
56
+ * Makes a call to the super constructor, and initializes MLSGenInterface
57
+ */
58
+ constructor() {
59
+ super();
60
+ this.#mlsGenInterface = new MlsGenInterface();
61
+ }
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
+ const localAudio = document.createElement("audio");
69
+ localAudio.setAttribute("id", "localAudio");
70
+ targetElement.appendChild(localAudio);
71
+ };
72
+
73
+ /**
74
+ * Creates an audio context and plays it for a few seconds.
75
+ * @private
76
+ * @returns {Promise} - Resolves when the audio is done playing.
77
+ */
78
+ #playCalibrationAudio = () => {
79
+ // const buffer = new ArrayBuffer(this.#mlsData.length);
80
+ // const view = new Uint8Array(buffer);
81
+ // const duration = 2000;
82
+
83
+ // for (let i; i &lt; this.#mlsData.length; i += 1) {
84
+ // view[i] = this.#mlsData[i];
85
+ // }
86
+
87
+ // this.#sourceAudioContext = new AudioContext();
88
+
89
+ // // TODO: Uncaught (in promise) DOMException: Unable to decode audio data
90
+ // // Possibly to do with the type of audio data being passed in.
91
+ // this.#sourceAudioContext.decodeAudioData(buffer).then((buf) => {
92
+ // // Create a source node from the buffer
93
+ // this.#sourceAudio = this.#sourceAudioContext.createBufferSource();
94
+ // this.#sourceAudio.buffer = buf;
95
+ // // Connect to the final output node (the speakers)
96
+ // this.#sourceAudio.connect(this.#sourceAudioContext.destination);
97
+ // // Play immediately
98
+ // this.#sourceAudio.start(0);
99
+ // });
100
+
101
+ // let's return a promise so we can await the end of each track
102
+ return new Promise((resolve) => {
103
+ setTimeout(resolve, duration * 2);
104
+ });
105
+ };
106
+
107
+ /**
108
+ * Getter for the isCalibrating property.
109
+ * @public
110
+ * @returns {Boolean} - True if the audio is being calibrated, false otherwise.
111
+ */
112
+ getCalibrationStatus = () => this.#isCalibrating;
113
+
114
+ setSinkAudio = (stream) => {
115
+ this.#sinkAudioContext = new AudioContext();
116
+ this.#sinkAudioAnalyser = this.#sinkAudioContext.createAnalyser();
117
+ const source = this.#sinkAudioContext.createMediaStreamSource(stream);
118
+ source.connect(this.#sinkAudioAnalyser);
119
+ visualize(this.#sinkAudioAnalyser);
120
+ };
121
+
122
+ /**
123
+ * Method to start the calibration process.
124
+ * @public
125
+ * @param {MediaStream} stream - The stream of audio from the Listener.
126
+ */
127
+ startCalibration = async (stream) => {
128
+ this.setSinkAudio(stream);
129
+ this.#mlsGenInterface.getMls();
130
+
131
+ let numRounds = 0;
132
+
133
+ while (!this.#isCalibrating &amp;&amp; numRounds &lt;= 2) {
134
+ // start recording
135
+ this.startRecording(stream);
136
+ // play calibration audio
137
+ // eslint-disable-next-line no-await-in-loop
138
+ await this.#playCalibrationAudio().then(() => {
139
+ // when done, stop recording
140
+ this.stopRecording();
141
+ });
142
+ numRounds += 1;
143
+ }
144
+ };
145
+ }
146
+
147
+ export default AudioCalibrator;
148
+ </code></pre>
149
+ </article>
150
+ </section>
151
+ </div>
152
+
153
+ <nav>
154
+ <h2><a href="index.html">Home</a></h2>
155
+ <h3>Classes</h3>
156
+ <ul>
157
+ <li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
158
+ <li><a href="AudioPeer.html">AudioPeer</a></li>
159
+ <li><a href="AudioRecorder.html">AudioRecorder</a></li>
160
+ <li><a href="Listener.html">Listener</a></li>
161
+ <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
162
+ <li><a href="Speaker.html">Speaker</a></li>
163
+ </ul>
164
+ <h3><a href="global.html">Global</a></h3>
165
+ </nav>
166
+
167
+ <br class="clear" />
168
+
169
+ <footer>
170
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue
171
+ Mar 01 2022 12:39:42 GMT-0500 (Eastern Standard Time)
172
+ </footer>
173
+
174
+ <script>
175
+ prettyPrint();
176
+ </script>
177
+ <script src="scripts/linenumber.js"></script>
178
+ </body>
179
+ </html>