speaker-calibration 2.2.198 → 2.2.199

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 (122) 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/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 +27366 -27366
  33. package/dist/example/index.html +47 -47
  34. package/dist/example/listener.html +79 -79
  35. package/dist/example/listener.js +149 -149
  36. package/dist/example/server.js +51 -51
  37. package/dist/example/speaker.html +145 -145
  38. package/dist/example/speakerUI.js +273 -273
  39. package/dist/example/styles.css +99 -99
  40. package/dist/main.js +1234 -1234
  41. package/dist/mlsGen.js +6814 -6814
  42. package/dist/mlsGen.wasm +0 -0
  43. package/dist/package-lock.json +1018 -1018
  44. package/dist/package.json +18 -18
  45. package/doc/AudioCalibrator.html +417 -417
  46. package/doc/AudioPeer.html +251 -251
  47. package/doc/AudioRecorder.html +195 -195
  48. package/doc/ImpulseResponse.html +215 -215
  49. package/doc/Listener.html +308 -308
  50. package/doc/MlsGenInterface.html +226 -226
  51. package/doc/MyEventEmitter.html +274 -274
  52. package/doc/PythonServerAPI.html +109 -109
  53. package/doc/Speaker.html +276 -276
  54. package/doc/Takes%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +128 -128
  55. package/doc/Takes%20the%20url%20of%20the%20current%20site%0Aand%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +138 -138
  56. package/doc/Takes%20the%20url%20of%20the%20current%20site%20and%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +137 -137
  57. package/doc/Volume.html +88 -88
  58. package/doc/audioCalibrator.js.html +179 -179
  59. package/doc/audioPeer.js.html +175 -175
  60. package/doc/audioRecorder.js.html +163 -163
  61. package/doc/creates%20a%20new%20AudioRecorder%20instance.%20%0ASets%20up%20the%20audio%20context%20and%20file%20reader..html +114 -114
  62. package/doc/fonts/OpenSans-Bold-webfont.svg +1829 -1829
  63. package/doc/fonts/OpenSans-BoldItalic-webfont.svg +1829 -1829
  64. package/doc/fonts/OpenSans-Italic-webfont.svg +1829 -1829
  65. package/doc/fonts/OpenSans-Light-webfont.svg +1830 -1830
  66. package/doc/fonts/OpenSans-LightItalic-webfont.svg +1834 -1834
  67. package/doc/fonts/OpenSans-Regular-webfont.svg +1830 -1830
  68. package/doc/global.html +308 -308
  69. package/doc/index.html +58 -58
  70. package/doc/listener.js.html +170 -170
  71. package/doc/mlsGen_mlsGenInterface.js.html +117 -117
  72. package/doc/myEventEmitter.js.html +124 -124
  73. package/doc/peer-connection_audioPeer.js.html +188 -188
  74. package/doc/peer-connection_listener.js.html +311 -311
  75. package/doc/peer-connection_speaker.js.html +381 -381
  76. package/doc/scripts/linenumber.js +25 -25
  77. package/doc/scripts/prettify/Apache-License-2.0.txt +202 -202
  78. package/doc/scripts/prettify/lang-css.js +24 -24
  79. package/doc/scripts/prettify/prettify.js +640 -640
  80. package/doc/server_PythonServerAPI.js.html +160 -160
  81. package/doc/speaker.js.html +248 -248
  82. package/doc/styles/jsdoc-default.css +371 -371
  83. package/doc/styles/prettify-jsdoc.css +111 -111
  84. package/doc/styles/prettify-tomorrow.css +163 -163
  85. package/doc/tasks_audioCalibrator.js.html +207 -207
  86. package/doc/tasks_audioRecorder.js.html +190 -190
  87. package/doc/tasks_impulse-response_impulseResponse.js.html +442 -442
  88. package/doc/tasks_impulse-response_mlsGen_mlsGenInterface.js.html +175 -175
  89. package/doc/tasks_volume_volume.js.html +185 -185
  90. package/doc/utils.js.html +105 -105
  91. package/jest.config.js +173 -173
  92. package/makefile +74 -0
  93. package/netlify.toml +26 -26
  94. package/package.json +73 -72
  95. package/src/config/firebase.js +26 -26
  96. package/src/index.html +21 -21
  97. package/src/main.js +23 -23
  98. package/src/myEventEmitter.js +83 -83
  99. package/src/peer-connection/audioPeer.js +178 -178
  100. package/src/peer-connection/listener.js +340 -340
  101. package/src/peer-connection/peerErrors.js +25 -25
  102. package/src/peer-connection/speaker.js +727 -724
  103. package/src/powerCheck.js +98 -98
  104. package/src/server/PythonServerAPI.js +869 -869
  105. package/src/tasks/audioCalibrator.js +335 -335
  106. package/src/tasks/audioRecorder.js +315 -315
  107. package/src/tasks/combination/combination.js +2963 -3033
  108. package/src/tasks/combination/mlsGen/mlsGen.cpp +98 -98
  109. package/src/tasks/combination/mlsGen/mlsGen.hpp +303 -303
  110. package/src/tasks/combination/mlsGen/mlsGenInterface.js +131 -131
  111. package/src/tasks/combination/mlsGen/mlsGenTest.cpp +180 -180
  112. package/src/tasks/impulse-response/impulseResponse.js +610 -610
  113. package/src/tasks/impulse-response/mlsGen/mlsGen.cpp +98 -98
  114. package/src/tasks/impulse-response/mlsGen/mlsGen.hpp +303 -303
  115. package/src/tasks/impulse-response/mlsGen/mlsGenInterface.js +131 -131
  116. package/src/tasks/impulse-response/mlsGen/mlsGenTest.cpp +180 -180
  117. package/src/tasks/volume/volume.cpp +2 -2
  118. package/src/tasks/volume/volume.hpp +22 -22
  119. package/src/tasks/volume/volume.js +279 -279
  120. package/src/utils.js +205 -205
  121. package/webpack.config.js +37 -37
  122. package/.gitignore +0 -81
@@ -1,215 +1,215 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8" />
5
- <title>JSDoc: Class: ImpulseResponse</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">Class: ImpulseResponse</h1>
19
-
20
- <section>
21
- <header>
22
- <h2>
23
- <span class="attribs"><span class="type-signature"></span></span>ImpulseResponse<span
24
- class="signature"
25
- >(param0)</span
26
- ><span class="type-signature"></span>
27
- </h2>
28
- </header>
29
-
30
- <article>
31
- <div class="container-overview">
32
- <h4 class="name" id="ImpulseResponse">
33
- <span class="type-signature"></span>new ImpulseResponse<span class="signature"
34
- >(param0)</span
35
- ><span class="type-signature"></span>
36
- </h4>
37
-
38
- <div class="description">
39
- Default constructor. Creates an instance with any number of paramters passed or the
40
- default parameters defined here.
41
- </div>
42
-
43
- <h5>Parameters:</h5>
44
-
45
- <table class="params">
46
- <thead>
47
- <tr>
48
- <th>Name</th>
49
-
50
- <th>Type</th>
51
-
52
- <th class="last">Description</th>
53
- </tr>
54
- </thead>
55
-
56
- <tbody>
57
- <tr>
58
- <td class="name"><code>param0</code></td>
59
-
60
- <td class="type">
61
- <span class="param-type">*</span>
62
- </td>
63
-
64
- <td class="description last"></td>
65
- </tr>
66
- </tbody>
67
- </table>
68
-
69
- <dl class="details">
70
- <dt class="tag-source">Source:</dt>
71
- <dd class="tag-source">
72
- <ul class="dummy">
73
- <li>
74
- <a href="tasks_impulse-response_impulseResponse.js.html"
75
- >tasks/impulse-response/impulseResponse.js</a
76
- >, <a href="tasks_impulse-response_impulseResponse.js.html#line9">line 9</a>
77
- </li>
78
- </ul>
79
- </dd>
80
- </dl>
81
- </div>
82
-
83
- <h3 class="subsection-title">Members</h3>
84
-
85
- <h4 class="name" id="createSCurveBuffer">
86
- <span class="type-signature"></span>createSCurveBuffer<span
87
- class="type-signature"
88
- ></span>
89
- </h4>
90
-
91
- <div class="description">Created an S Curver Buffer to taper the signal onset</div>
92
-
93
- <dl class="details">
94
- <dt class="tag-source">Source:</dt>
95
- <dd class="tag-source">
96
- <ul class="dummy">
97
- <li>
98
- <a href="tasks_impulse-response_impulseResponse.js.html"
99
- >tasks/impulse-response/impulseResponse.js</a
100
- >, <a href="tasks_impulse-response_impulseResponse.js.html#line149">line 149</a>
101
- </li>
102
- </ul>
103
- </dd>
104
- </dl>
105
-
106
- <h4 class="name" id="sendImpulseResponsesToServerForProcessing">
107
- <span class="type-signature"></span>sendImpulseResponsesToServerForProcessing<span
108
- class="type-signature"
109
- ></span>
110
- </h4>
111
-
112
- <div class="description">
113
- Sends all the computed impulse responses to the backend server for processing
114
- </div>
115
-
116
- <dl class="details">
117
- <dt class="tag-source">Source:</dt>
118
- <dd class="tag-source">
119
- <ul class="dummy">
120
- <li>
121
- <a href="tasks_impulse-response_impulseResponse.js.html"
122
- >tasks/impulse-response/impulseResponse.js</a
123
- >, <a href="tasks_impulse-response_impulseResponse.js.html#line51">line 51</a>
124
- </li>
125
- </ul>
126
- </dd>
127
- </dl>
128
-
129
- <h4 class="name" id="sendRecordingToServerForProcessing">
130
- <span class="type-signature"></span>sendRecordingToServerForProcessing<span
131
- class="type-signature"
132
- ></span>
133
- </h4>
134
-
135
- <div class="description">
136
- Sends the recorded signal, or a given csv string of a signal, to the back end server for
137
- processing
138
- </div>
139
-
140
- <dl class="details">
141
- <dt class="tag-source">Source:</dt>
142
- <dd class="tag-source">
143
- <ul class="dummy">
144
- <li>
145
- <a href="tasks_impulse-response_impulseResponse.js.html"
146
- >tasks/impulse-response/impulseResponse.js</a
147
- >, <a href="tasks_impulse-response_impulseResponse.js.html#line72">line 72</a>
148
- </li>
149
- </ul>
150
- </dd>
151
- </dl>
152
-
153
- <h4 class="name" id="startCalibration">
154
- <span class="type-signature"></span>startCalibration<span class="type-signature"></span>
155
- </h4>
156
-
157
- <div class="description">
158
- Public method to start the calibration process. Objects intialized from webassembly
159
- allocate new memory and must be manually freed. This function is responsible for
160
- intializing the MlsGenInterface, and wrapping the calibration steps with a garbage
161
- collection safe gaurd.
162
- </div>
163
-
164
- <dl class="details">
165
- <dt class="tag-source">Source:</dt>
166
- <dd class="tag-source">
167
- <ul class="dummy">
168
- <li>
169
- <a href="tasks_impulse-response_impulseResponse.js.html"
170
- >tasks/impulse-response/impulseResponse.js</a
171
- >, <a href="tasks_impulse-response_impulseResponse.js.html#line344">line 344</a>
172
- </li>
173
- </ul>
174
- </dd>
175
- </dl>
176
- </article>
177
- </section>
178
- </div>
179
-
180
- <nav>
181
- <h2><a href="index.html">Home</a></h2>
182
- <h3>Classes</h3>
183
- <ul>
184
- <li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
185
- <li><a href="AudioPeer.html">AudioPeer</a></li>
186
- <li><a href="AudioRecorder.html">AudioRecorder</a></li>
187
- <li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
188
- <li><a href="Listener.html">Listener</a></li>
189
- <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
190
- <li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
191
- <li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
192
- <li><a href="Speaker.html">Speaker</a></li>
193
- <li><a href="Volume.html">Volume</a></li>
194
- </ul>
195
- <h3>Global</h3>
196
- <ul>
197
- <li><a href="global.html#csvToArray">csvToArray</a></li>
198
- <li><a href="global.html#saveToCSV">saveToCSV</a></li>
199
- <li><a href="global.html#sleep">sleep</a></li>
200
- </ul>
201
- </nav>
202
-
203
- <br class="clear" />
204
-
205
- <footer>
206
- Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
207
- Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
208
- </footer>
209
-
210
- <script>
211
- prettyPrint();
212
- </script>
213
- <script src="scripts/linenumber.js"></script>
214
- </body>
215
- </html>
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <title>JSDoc: Class: ImpulseResponse</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">Class: ImpulseResponse</h1>
19
+
20
+ <section>
21
+ <header>
22
+ <h2>
23
+ <span class="attribs"><span class="type-signature"></span></span>ImpulseResponse<span
24
+ class="signature"
25
+ >(param0)</span
26
+ ><span class="type-signature"></span>
27
+ </h2>
28
+ </header>
29
+
30
+ <article>
31
+ <div class="container-overview">
32
+ <h4 class="name" id="ImpulseResponse">
33
+ <span class="type-signature"></span>new ImpulseResponse<span class="signature"
34
+ >(param0)</span
35
+ ><span class="type-signature"></span>
36
+ </h4>
37
+
38
+ <div class="description">
39
+ Default constructor. Creates an instance with any number of paramters passed or the
40
+ default parameters defined here.
41
+ </div>
42
+
43
+ <h5>Parameters:</h5>
44
+
45
+ <table class="params">
46
+ <thead>
47
+ <tr>
48
+ <th>Name</th>
49
+
50
+ <th>Type</th>
51
+
52
+ <th class="last">Description</th>
53
+ </tr>
54
+ </thead>
55
+
56
+ <tbody>
57
+ <tr>
58
+ <td class="name"><code>param0</code></td>
59
+
60
+ <td class="type">
61
+ <span class="param-type">*</span>
62
+ </td>
63
+
64
+ <td class="description last"></td>
65
+ </tr>
66
+ </tbody>
67
+ </table>
68
+
69
+ <dl class="details">
70
+ <dt class="tag-source">Source:</dt>
71
+ <dd class="tag-source">
72
+ <ul class="dummy">
73
+ <li>
74
+ <a href="tasks_impulse-response_impulseResponse.js.html"
75
+ >tasks/impulse-response/impulseResponse.js</a
76
+ >, <a href="tasks_impulse-response_impulseResponse.js.html#line9">line 9</a>
77
+ </li>
78
+ </ul>
79
+ </dd>
80
+ </dl>
81
+ </div>
82
+
83
+ <h3 class="subsection-title">Members</h3>
84
+
85
+ <h4 class="name" id="createSCurveBuffer">
86
+ <span class="type-signature"></span>createSCurveBuffer<span
87
+ class="type-signature"
88
+ ></span>
89
+ </h4>
90
+
91
+ <div class="description">Created an S Curver Buffer to taper the signal onset</div>
92
+
93
+ <dl class="details">
94
+ <dt class="tag-source">Source:</dt>
95
+ <dd class="tag-source">
96
+ <ul class="dummy">
97
+ <li>
98
+ <a href="tasks_impulse-response_impulseResponse.js.html"
99
+ >tasks/impulse-response/impulseResponse.js</a
100
+ >, <a href="tasks_impulse-response_impulseResponse.js.html#line149">line 149</a>
101
+ </li>
102
+ </ul>
103
+ </dd>
104
+ </dl>
105
+
106
+ <h4 class="name" id="sendImpulseResponsesToServerForProcessing">
107
+ <span class="type-signature"></span>sendImpulseResponsesToServerForProcessing<span
108
+ class="type-signature"
109
+ ></span>
110
+ </h4>
111
+
112
+ <div class="description">
113
+ Sends all the computed impulse responses to the backend server for processing
114
+ </div>
115
+
116
+ <dl class="details">
117
+ <dt class="tag-source">Source:</dt>
118
+ <dd class="tag-source">
119
+ <ul class="dummy">
120
+ <li>
121
+ <a href="tasks_impulse-response_impulseResponse.js.html"
122
+ >tasks/impulse-response/impulseResponse.js</a
123
+ >, <a href="tasks_impulse-response_impulseResponse.js.html#line51">line 51</a>
124
+ </li>
125
+ </ul>
126
+ </dd>
127
+ </dl>
128
+
129
+ <h4 class="name" id="sendRecordingToServerForProcessing">
130
+ <span class="type-signature"></span>sendRecordingToServerForProcessing<span
131
+ class="type-signature"
132
+ ></span>
133
+ </h4>
134
+
135
+ <div class="description">
136
+ Sends the recorded signal, or a given csv string of a signal, to the back end server for
137
+ processing
138
+ </div>
139
+
140
+ <dl class="details">
141
+ <dt class="tag-source">Source:</dt>
142
+ <dd class="tag-source">
143
+ <ul class="dummy">
144
+ <li>
145
+ <a href="tasks_impulse-response_impulseResponse.js.html"
146
+ >tasks/impulse-response/impulseResponse.js</a
147
+ >, <a href="tasks_impulse-response_impulseResponse.js.html#line72">line 72</a>
148
+ </li>
149
+ </ul>
150
+ </dd>
151
+ </dl>
152
+
153
+ <h4 class="name" id="startCalibration">
154
+ <span class="type-signature"></span>startCalibration<span class="type-signature"></span>
155
+ </h4>
156
+
157
+ <div class="description">
158
+ Public method to start the calibration process. Objects intialized from webassembly
159
+ allocate new memory and must be manually freed. This function is responsible for
160
+ intializing the MlsGenInterface, and wrapping the calibration steps with a garbage
161
+ collection safe gaurd.
162
+ </div>
163
+
164
+ <dl class="details">
165
+ <dt class="tag-source">Source:</dt>
166
+ <dd class="tag-source">
167
+ <ul class="dummy">
168
+ <li>
169
+ <a href="tasks_impulse-response_impulseResponse.js.html"
170
+ >tasks/impulse-response/impulseResponse.js</a
171
+ >, <a href="tasks_impulse-response_impulseResponse.js.html#line344">line 344</a>
172
+ </li>
173
+ </ul>
174
+ </dd>
175
+ </dl>
176
+ </article>
177
+ </section>
178
+ </div>
179
+
180
+ <nav>
181
+ <h2><a href="index.html">Home</a></h2>
182
+ <h3>Classes</h3>
183
+ <ul>
184
+ <li><a href="AudioCalibrator.html">AudioCalibrator</a></li>
185
+ <li><a href="AudioPeer.html">AudioPeer</a></li>
186
+ <li><a href="AudioRecorder.html">AudioRecorder</a></li>
187
+ <li><a href="ImpulseResponse.html">ImpulseResponse</a></li>
188
+ <li><a href="Listener.html">Listener</a></li>
189
+ <li><a href="MlsGenInterface.html">MlsGenInterface</a></li>
190
+ <li><a href="MyEventEmitter.html">MyEventEmitter</a></li>
191
+ <li><a href="PythonServerAPI.html">PythonServerAPI</a></li>
192
+ <li><a href="Speaker.html">Speaker</a></li>
193
+ <li><a href="Volume.html">Volume</a></li>
194
+ </ul>
195
+ <h3>Global</h3>
196
+ <ul>
197
+ <li><a href="global.html#csvToArray">csvToArray</a></li>
198
+ <li><a href="global.html#saveToCSV">saveToCSV</a></li>
199
+ <li><a href="global.html#sleep">sleep</a></li>
200
+ </ul>
201
+ </nav>
202
+
203
+ <br class="clear" />
204
+
205
+ <footer>
206
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri
207
+ Jul 29 2022 15:09:48 GMT-0400 (Eastern Daylight Time)
208
+ </footer>
209
+
210
+ <script>
211
+ prettyPrint();
212
+ </script>
213
+ <script src="scripts/linenumber.js"></script>
214
+ </body>
215
+ </html>