speaker-calibration 2.2.248 → 2.2.249

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 (120) hide show
  1. package/.eslintignore +71 -71
  2. package/.eslintrc.json +40 -40
  3. package/.gitignore +81 -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/index.html +123 -123
  17. package/coverage/lcov-report/prettify.css +101 -101
  18. package/coverage/lcov-report/prettify.js +937 -937
  19. package/coverage/lcov-report/sorter.js +189 -189
  20. package/coverage/lcov-report/src/index.html +121 -121
  21. package/coverage/lcov-report/src/server/PythonServerInterface.js.html +268 -268
  22. package/coverage/lcov-report/src/server/index.html +123 -123
  23. package/coverage/lcov-report/src/tasks/audioCalibrator.js.html +499 -499
  24. package/coverage/lcov-report/src/tasks/audioRecorder.js.html +412 -412
  25. package/coverage/lcov-report/src/tasks/index.html +143 -143
  26. package/coverage/lcov-report/src/tasks/volume/index.html +123 -123
  27. package/coverage/lcov-report/src/tasks/volume/volume.js.html +409 -409
  28. package/coverage/lcov-report/src/utils.js.html +172 -172
  29. package/coverage/lcov.info +91 -91
  30. package/dist/example/NoSleep.min.js +1 -1
  31. package/dist/example/fetch-languages-sheets.js +77 -77
  32. package/dist/example/i18n.js +29654 -30000
  33. package/dist/example/index.html +47 -47
  34. package/dist/example/listener.html +81 -81
  35. package/dist/example/server.js +51 -51
  36. package/dist/example/speaker.html +145 -145
  37. package/dist/example/speakerUI.js +273 -273
  38. package/dist/example/styles.css +152 -152
  39. package/dist/mlsGen.js +6814 -6814
  40. package/dist/mlsGen.wasm +0 -0
  41. package/dist/package-lock.json +1018 -1018
  42. package/dist/package.json +18 -18
  43. package/doc/AudioCalibrator.html +417 -417
  44. package/doc/AudioPeer.html +251 -251
  45. package/doc/AudioRecorder.html +195 -195
  46. package/doc/ImpulseResponse.html +215 -215
  47. package/doc/Listener.html +308 -308
  48. package/doc/MlsGenInterface.html +226 -226
  49. package/doc/MyEventEmitter.html +274 -274
  50. package/doc/PythonServerAPI.html +109 -109
  51. package/doc/Speaker.html +276 -276
  52. package/doc/Takes%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +128 -128
  53. package/doc/Takes%20the%20url%20of%20the%20current%20site%0Aand%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +138 -138
  54. package/doc/Takes%20the%20url%20of%20the%20current%20site%20and%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +137 -137
  55. package/doc/Volume.html +88 -88
  56. package/doc/audioCalibrator.js.html +179 -179
  57. package/doc/audioPeer.js.html +175 -175
  58. package/doc/audioRecorder.js.html +163 -163
  59. package/doc/creates%20a%20new%20AudioRecorder%20instance.%20%0ASets%20up%20the%20audio%20context%20and%20file%20reader..html +114 -114
  60. package/doc/fonts/OpenSans-Bold-webfont.svg +1829 -1829
  61. package/doc/fonts/OpenSans-BoldItalic-webfont.svg +1829 -1829
  62. package/doc/fonts/OpenSans-Italic-webfont.svg +1829 -1829
  63. package/doc/fonts/OpenSans-Light-webfont.svg +1830 -1830
  64. package/doc/fonts/OpenSans-LightItalic-webfont.svg +1834 -1834
  65. package/doc/fonts/OpenSans-Regular-webfont.svg +1830 -1830
  66. package/doc/global.html +308 -308
  67. package/doc/index.html +58 -58
  68. package/doc/listener.js.html +170 -170
  69. package/doc/mlsGen_mlsGenInterface.js.html +117 -117
  70. package/doc/myEventEmitter.js.html +124 -124
  71. package/doc/peer-connection_audioPeer.js.html +188 -188
  72. package/doc/peer-connection_listener.js.html +311 -311
  73. package/doc/peer-connection_speaker.js.html +381 -381
  74. package/doc/scripts/linenumber.js +25 -25
  75. package/doc/scripts/prettify/Apache-License-2.0.txt +202 -202
  76. package/doc/scripts/prettify/lang-css.js +24 -24
  77. package/doc/scripts/prettify/prettify.js +640 -640
  78. package/doc/server_PythonServerAPI.js.html +160 -160
  79. package/doc/speaker.js.html +248 -248
  80. package/doc/styles/jsdoc-default.css +371 -371
  81. package/doc/styles/prettify-jsdoc.css +111 -111
  82. package/doc/styles/prettify-tomorrow.css +163 -163
  83. package/doc/tasks_audioCalibrator.js.html +207 -207
  84. package/doc/tasks_audioRecorder.js.html +190 -190
  85. package/doc/tasks_impulse-response_impulseResponse.js.html +442 -442
  86. package/doc/tasks_impulse-response_mlsGen_mlsGenInterface.js.html +175 -175
  87. package/doc/tasks_volume_volume.js.html +185 -185
  88. package/doc/utils.js.html +105 -105
  89. package/jest.config.js +173 -173
  90. package/netlify.toml +26 -26
  91. package/package.json +78 -78
  92. package/src/config/firebase.js +26 -26
  93. package/src/index.html +21 -21
  94. package/src/listener-app/PhonePeer.js +474 -474
  95. package/src/listener-app/listener.js +377 -377
  96. package/src/main.js +22 -22
  97. package/src/myEventEmitter.js +83 -83
  98. package/src/peer-connection/audioPeer.js +100 -100
  99. package/src/peer-connection/listener.js +299 -299
  100. package/src/peer-connection/peerErrors.js +25 -25
  101. package/src/peer-connection/speaker.js +963 -963
  102. package/src/powerCheck.js +110 -110
  103. package/src/server/PythonServerAPI.js +959 -959
  104. package/src/tasks/combination/combination.js +29 -29
  105. package/src/tasks/combination/mlsGen/mlsGen.cpp +98 -98
  106. package/src/tasks/combination/mlsGen/mlsGen.hpp +303 -303
  107. package/src/tasks/combination/mlsGen/mlsGenInterface.js +131 -131
  108. package/src/tasks/combination/mlsGen/mlsGenTest.cpp +180 -180
  109. package/src/tasks/impulse-response/impulseResponse.js +610 -610
  110. package/src/tasks/impulse-response/mlsGen/mlsGen.cpp +98 -98
  111. package/src/tasks/impulse-response/mlsGen/mlsGen.hpp +303 -303
  112. package/src/tasks/impulse-response/mlsGen/mlsGenInterface.js +131 -131
  113. package/src/tasks/impulse-response/mlsGen/mlsGenTest.cpp +180 -180
  114. package/src/tasks/volume/volume.cpp +2 -2
  115. package/src/tasks/volume/volume.hpp +22 -22
  116. package/src/tasks/volume/volume.js +279 -279
  117. package/src/utils.js +205 -205
  118. package/webpack.config.js +65 -65
  119. package/.github/workflows/update-phrases.yml +0 -37
  120. package/makefile +0 -74
@@ -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>