speaker-calibration 2.2.104 → 2.2.106

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 (119) hide show
  1. package/.eslintignore +71 -71
  2. package/.eslintrc.json +40 -40
  3. package/.prettierignore +69 -69
  4. package/.prettierrc +14 -14
  5. package/LICENSE +20 -20
  6. package/README.md +133 -133
  7. package/__mocks__/fileMock.js +1 -1
  8. package/__mocks__/styleMock.js +1 -1
  9. package/babel.config.js +3 -3
  10. package/coverage/clover.xml +71 -71
  11. package/coverage/coverage-final.json +224 -224
  12. package/coverage/lcov-report/PythonServerInterface.js.html +265 -265
  13. package/coverage/lcov-report/base.css +354 -354
  14. package/coverage/lcov-report/block-navigation.js +82 -82
  15. package/coverage/lcov-report/index.html +123 -123
  16. package/coverage/lcov-report/prettify.css +101 -101
  17. package/coverage/lcov-report/prettify.js +937 -937
  18. package/coverage/lcov-report/sorter.js +189 -189
  19. package/coverage/lcov-report/src/index.html +121 -121
  20. package/coverage/lcov-report/src/server/PythonServerInterface.js.html +268 -268
  21. package/coverage/lcov-report/src/server/index.html +123 -123
  22. package/coverage/lcov-report/src/tasks/audioCalibrator.js.html +499 -499
  23. package/coverage/lcov-report/src/tasks/audioRecorder.js.html +412 -412
  24. package/coverage/lcov-report/src/tasks/index.html +143 -143
  25. package/coverage/lcov-report/src/tasks/volume/index.html +123 -123
  26. package/coverage/lcov-report/src/tasks/volume/volume.js.html +409 -409
  27. package/coverage/lcov-report/src/utils.js.html +172 -172
  28. package/coverage/lcov.info +91 -91
  29. package/dist/example/fetch-languages-sheets.js +77 -77
  30. package/dist/example/i18n.js +35846 -35846
  31. package/dist/example/index.html +47 -47
  32. package/dist/example/listener.html +62 -62
  33. package/dist/example/listener.js +129 -118
  34. package/dist/example/server.js +51 -51
  35. package/dist/example/speaker.html +145 -145
  36. package/dist/example/speakerUI.js +273 -273
  37. package/dist/example/styles.css +92 -92
  38. package/dist/main.js +17 -17
  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/makefile +74 -0
  91. package/netlify.toml +26 -26
  92. package/package.json +69 -69
  93. package/src/config/firebase.js +26 -26
  94. package/src/index.html +21 -21
  95. package/src/main.js +23 -23
  96. package/src/myEventEmitter.js +83 -83
  97. package/src/peer-connection/audioPeer.js +151 -151
  98. package/src/peer-connection/listener.js +327 -327
  99. package/src/peer-connection/peerErrors.js +25 -25
  100. package/src/peer-connection/speaker.js +474 -474
  101. package/src/server/PythonServerAPI.js +673 -673
  102. package/src/tasks/audioCalibrator.js +308 -308
  103. package/src/tasks/audioRecorder.js +301 -301
  104. package/src/tasks/combination/combination.js +2305 -2298
  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 +105 -105
  118. package/webpack.config.js +37 -37
  119. package/.gitignore +0 -81
package/doc/tasks_impulse-response_mlsGen_mlsGenInterface.js.html CHANGED
@@ -1,175 +1,175 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8" />
5
- <title>JSDoc: Source: tasks/impulse-response/mlsGen/mlsGenInterface.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/impulse-response/mlsGen/mlsGenInterface.js</h1>
19
-
20
- <section>
21
- <article>
22
- <pre class="prettyprint source linenums"><code>/* eslint-disable prefer-destructuring */
23
- /* eslint-disable dot-notation */
24
- // eslint-disable-next-line import/extensions
25
- const createMLSGenModule = require('../../../../dist/mlsGen.js');
26
-
27
- /**
28
- * MLSGenInterface provides a class for interfacing with the MLSGen WASM module.
29
- */
30
- class MlsGenInterface {
31
- /** @private */
32
- #mlsOrder;
33
-
34
- /** @private */
35
- #WASMInstance; // the WASM module instance
36
-
37
- /** @private */
38
- #MLSGenInstance; // the MLSGen object instance
39
-
40
- /**
41
- * Creates an instance of MlsGenInterface.
42
- * Makes a call to the WASM glue code to load the WASM module.
43
- */
44
- constructor(WASMInstance, mlsOrder, sourceSamplingRate, sinkSamplingRate) {
45
- this.#mlsOrder = mlsOrder;
46
- this.#WASMInstance = WASMInstance;
47
-
48
- console.warn('initializing MLSGen, need to manually garbage collect');
49
- this.#MLSGenInstance = new this.#WASMInstance['MLSGen'](
50
- mlsOrder,
51
- sourceSamplingRate,
52
- sinkSamplingRate
53
- );
54
- }
55
-
56
- /**
57
- * Factory function that provide an asynchronous function that fetches the WASM module
58
- * and returns a promise that resolves when the module is loaded.
59
- * @param {number} sourceSamplingRate - The sampling rate of the source audio.
60
- * @param {number} sinkSamplingRate - The sampling rate of the sink audio.
61
- * @returns {MlsGenInterface} mlsGenInterface
62
- */
63
- static factory = async (mlsOrder, sourceSamplingRate, sinkSamplingRate) => {
64
- if (sourceSamplingRate === undefined || sinkSamplingRate === undefined) {
65
- throw new Error('sourceSamplingRate and sinkSamplingRate must be defined');
66
- }
67
- return new MlsGenInterface(
68
- await createMLSGenModule().then(instance => instance),
69
- mlsOrder,
70
- sourceSamplingRate,
71
- sinkSamplingRate
72
- );
73
- };
74
-
75
- /**
76
- * A Higher-Order function that takes an async callback function that access the MLSGen object,
77
- * providing safe garbage collection.
78
- * @param {function} func
79
- * @param {array} args
80
- */
81
- withGarbageCollection = async funcsWithParams => {
82
- try {
83
- for (let i = 0; i &lt; funcsWithParams.length; i += 1) {
84
- const [func, params] = funcsWithParams[i];
85
- await func(...params);
86
- }
87
- // await func(...params);
88
- } catch (error) {
89
- console.error(error);
90
- } finally {
91
- // garbage collect
92
- if (
93
- this !== undefined &amp;&amp;
94
- this !== null &amp;&amp;
95
- this.#MLSGenInstance !== undefined &amp;&amp;
96
- this.#MLSGenInstance !== null
97
- ) {
98
- this.#MLSGenInstance['Destruct'](); // Call the destructor
99
- this.#MLSGenInstance['delete'](); // Delete the object
100
- console.warn(`GARBAGE COLLECTION: deleted MLSGen`);
101
- this.#WASMInstance['doLeakCheck'](); // Check for memory leaks
102
- }
103
- }
104
- };
105
-
106
- /**
107
- * Calculate and return the Impulse Response of the recorded signal.
108
- * @returns
109
- */
110
- getImpulseResponse = () => this.#MLSGenInstance['getImpulseResponse']();
111
-
112
- /**
113
- * Given a recorded MLS signal, this function sets the recordedSignal property of the MLSGen object.
114
- * @param {Float32Array} signals
115
- */
116
- setRecordedSignals = signals => {
117
- // get memory view
118
- const averagedSignals = this.average(signals);
119
- const recordedSignalsMemoryView = this.#MLSGenInstance['setRecordedSignalsMemoryView'](
120
- averagedSignals.byteLength
121
- );
122
- for (let i = 0; i &lt; averagedSignals.length; i++) {
123
- recordedSignalsMemoryView[i] = averagedSignals[i];
124
- }
125
- };
126
-
127
- /**
128
- * Calculate the Maximum Length Sequence (MLS) with period P = 2^N - 1
129
- * using the MLSGen WASM module.
130
- */
131
- getMLS = () => this.#MLSGenInstance['getMLS']();
132
- }
133
-
134
- export default MlsGenInterface;
135
- </code></pre>
136
- </article>
137
- </section>
138
- </div>
139
-
140
- <nav>
141
- <h2><a href="index.html">Home</a></h2>
142
- <h3>Classes</h3>
143
- <ul>
144
- <li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
145
- <li><a href="AudioPeer.html">AudioPeer</a></li>
146
- <li><a href="AudioRecorder.html">AudioRecorder</a></li>
147
- <li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
148
- <li><a href="Listener.html">Listener</a></li>
149
- <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
150
- <li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
151
- <li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
152
- <li><a href="Speaker.html">Speaker</a></li>
153
- <li><a href="Volume.html">Volume</a></li>
154
- </ul>
155
- <h3>Global</h3>
156
- <ul>
157
- <li><a href="global.html#csvToArray">csvToArray</a></li>
158
- <li><a href="global.html#saveToCSV">saveToCSV</a></li>
159
- <li><a href="global.html#sleep">sleep</a></li>
160
- </ul>
161
- </nav>
162
-
163
- <br class="clear" />
164
-
165
- <footer>
166
- Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
167
- Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
168
- </footer>
169
-
170
- <script>
171
- prettyPrint();
172
- </script>
173
- <script src="scripts/linenumber.js"></script>
174
- </body>
175
- </html>
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <title>JSDoc: Source: tasks/impulse-response/mlsGen/mlsGenInterface.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/impulse-response/mlsGen/mlsGenInterface.js</h1>
19
+
20
+ <section>
21
+ <article>
22
+ <pre class="prettyprint source linenums"><code>/* eslint-disable prefer-destructuring */
23
+ /* eslint-disable dot-notation */
24
+ // eslint-disable-next-line import/extensions
25
+ const createMLSGenModule = require('../../../../dist/mlsGen.js');
26
+
27
+ /**
28
+ * MLSGenInterface provides a class for interfacing with the MLSGen WASM module.
29
+ */
30
+ class MlsGenInterface {
31
+ /** @private */
32
+ #mlsOrder;
33
+
34
+ /** @private */
35
+ #WASMInstance; // the WASM module instance
36
+
37
+ /** @private */
38
+ #MLSGenInstance; // the MLSGen object instance
39
+
40
+ /**
41
+ * Creates an instance of MlsGenInterface.
42
+ * Makes a call to the WASM glue code to load the WASM module.
43
+ */
44
+ constructor(WASMInstance, mlsOrder, sourceSamplingRate, sinkSamplingRate) {
45
+ this.#mlsOrder = mlsOrder;
46
+ this.#WASMInstance = WASMInstance;
47
+
48
+ console.warn('initializing MLSGen, need to manually garbage collect');
49
+ this.#MLSGenInstance = new this.#WASMInstance['MLSGen'](
50
+ mlsOrder,
51
+ sourceSamplingRate,
52
+ sinkSamplingRate
53
+ );
54
+ }
55
+
56
+ /**
57
+ * Factory function that provide an asynchronous function that fetches the WASM module
58
+ * and returns a promise that resolves when the module is loaded.
59
+ * @param {number} sourceSamplingRate - The sampling rate of the source audio.
60
+ * @param {number} sinkSamplingRate - The sampling rate of the sink audio.
61
+ * @returns {MlsGenInterface} mlsGenInterface
62
+ */
63
+ static factory = async (mlsOrder, sourceSamplingRate, sinkSamplingRate) => {
64
+ if (sourceSamplingRate === undefined || sinkSamplingRate === undefined) {
65
+ throw new Error('sourceSamplingRate and sinkSamplingRate must be defined');
66
+ }
67
+ return new MlsGenInterface(
68
+ await createMLSGenModule().then(instance => instance),
69
+ mlsOrder,
70
+ sourceSamplingRate,
71
+ sinkSamplingRate
72
+ );
73
+ };
74
+
75
+ /**
76
+ * A Higher-Order function that takes an async callback function that access the MLSGen object,
77
+ * providing safe garbage collection.
78
+ * @param {function} func
79
+ * @param {array} args
80
+ */
81
+ withGarbageCollection = async funcsWithParams => {
82
+ try {
83
+ for (let i = 0; i &lt; funcsWithParams.length; i += 1) {
84
+ const [func, params] = funcsWithParams[i];
85
+ await func(...params);
86
+ }
87
+ // await func(...params);
88
+ } catch (error) {
89
+ console.error(error);
90
+ } finally {
91
+ // garbage collect
92
+ if (
93
+ this !== undefined &amp;&amp;
94
+ this !== null &amp;&amp;
95
+ this.#MLSGenInstance !== undefined &amp;&amp;
96
+ this.#MLSGenInstance !== null
97
+ ) {
98
+ this.#MLSGenInstance['Destruct'](); // Call the destructor
99
+ this.#MLSGenInstance['delete'](); // Delete the object
100
+ console.warn(`GARBAGE COLLECTION: deleted MLSGen`);
101
+ this.#WASMInstance['doLeakCheck'](); // Check for memory leaks
102
+ }
103
+ }
104
+ };
105
+
106
+ /**
107
+ * Calculate and return the Impulse Response of the recorded signal.
108
+ * @returns
109
+ */
110
+ getImpulseResponse = () => this.#MLSGenInstance['getImpulseResponse']();
111
+
112
+ /**
113
+ * Given a recorded MLS signal, this function sets the recordedSignal property of the MLSGen object.
114
+ * @param {Float32Array} signals
115
+ */
116
+ setRecordedSignals = signals => {
117
+ // get memory view
118
+ const averagedSignals = this.average(signals);
119
+ const recordedSignalsMemoryView = this.#MLSGenInstance['setRecordedSignalsMemoryView'](
120
+ averagedSignals.byteLength
121
+ );
122
+ for (let i = 0; i &lt; averagedSignals.length; i++) {
123
+ recordedSignalsMemoryView[i] = averagedSignals[i];
124
+ }
125
+ };
126
+
127
+ /**
128
+ * Calculate the Maximum Length Sequence (MLS) with period P = 2^N - 1
129
+ * using the MLSGen WASM module.
130
+ */
131
+ getMLS = () => this.#MLSGenInstance['getMLS']();
132
+ }
133
+
134
+ export default MlsGenInterface;
135
+ </code></pre>
136
+ </article>
137
+ </section>
138
+ </div>
139
+
140
+ <nav>
141
+ <h2><a href="index.html">Home</a></h2>
142
+ <h3>Classes</h3>
143
+ <ul>
144
+ <li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
145
+ <li><a href="AudioPeer.html">AudioPeer</a></li>
146
+ <li><a href="AudioRecorder.html">AudioRecorder</a></li>
147
+ <li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
148
+ <li><a href="Listener.html">Listener</a></li>
149
+ <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
150
+ <li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
151
+ <li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
152
+ <li><a href="Speaker.html">Speaker</a></li>
153
+ <li><a href="Volume.html">Volume</a></li>
154
+ </ul>
155
+ <h3>Global</h3>
156
+ <ul>
157
+ <li><a href="global.html#csvToArray">csvToArray</a></li>
158
+ <li><a href="global.html#saveToCSV">saveToCSV</a></li>
159
+ <li><a href="global.html#sleep">sleep</a></li>
160
+ </ul>
161
+ </nav>
162
+
163
+ <br class="clear" />
164
+
165
+ <footer>
166
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
167
+ Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
168
+ </footer>
169
+
170
+ <script>
171
+ prettyPrint();
172
+ </script>
173
+ <script src="scripts/linenumber.js"></script>
174
+ </body>
175
+ </html>