speaker-calibration 2.2.55 → 2.2.56

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/.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/fetch-languages-sheets.js +77 -77
  31. package/dist/example/i18n.js +6822 -6822
  32. package/dist/example/index.html +47 -47
  33. package/dist/example/listener.html +61 -61
  34. package/dist/example/listener.js +100 -97
  35. package/dist/example/server.js +51 -51
  36. package/dist/example/speaker.html +145 -139
  37. package/dist/example/speakerUI.js +272 -270
  38. package/dist/example/styles.css +72 -68
  39. package/dist/main.js +17 -17
  40. package/dist/mlsGen.js +6814 -6814
  41. package/dist/mlsGen.wasm +0 -0
  42. package/dist/package-lock.json +1018 -1018
  43. package/dist/package.json +18 -18
  44. package/doc/AudioCalibrator.html +417 -417
  45. package/doc/AudioPeer.html +251 -251
  46. package/doc/AudioRecorder.html +195 -195
  47. package/doc/ImpulseResponse.html +215 -215
  48. package/doc/Listener.html +308 -308
  49. package/doc/MlsGenInterface.html +226 -226
  50. package/doc/MyEventEmitter.html +274 -274
  51. package/doc/PythonServerAPI.html +109 -109
  52. package/doc/Speaker.html +276 -276
  53. package/doc/Takes%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +128 -128
  54. package/doc/Takes%20the%20url%20of%20the%20current%20site%0Aand%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +138 -138
  55. package/doc/Takes%20the%20url%20of%20the%20current%20site%20and%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +137 -137
  56. package/doc/Volume.html +88 -88
  57. package/doc/audioCalibrator.js.html +179 -179
  58. package/doc/audioPeer.js.html +175 -175
  59. package/doc/audioRecorder.js.html +163 -163
  60. package/doc/creates%20a%20new%20AudioRecorder%20instance.%20%0ASets%20up%20the%20audio%20context%20and%20file%20reader..html +114 -114
  61. package/doc/fonts/OpenSans-Bold-webfont.svg +1829 -1829
  62. package/doc/fonts/OpenSans-BoldItalic-webfont.svg +1829 -1829
  63. package/doc/fonts/OpenSans-Italic-webfont.svg +1829 -1829
  64. package/doc/fonts/OpenSans-Light-webfont.svg +1830 -1830
  65. package/doc/fonts/OpenSans-LightItalic-webfont.svg +1834 -1834
  66. package/doc/fonts/OpenSans-Regular-webfont.svg +1830 -1830
  67. package/doc/global.html +308 -308
  68. package/doc/index.html +58 -58
  69. package/doc/listener.js.html +170 -170
  70. package/doc/mlsGen_mlsGenInterface.js.html +117 -117
  71. package/doc/myEventEmitter.js.html +124 -124
  72. package/doc/peer-connection_audioPeer.js.html +188 -188
  73. package/doc/peer-connection_listener.js.html +311 -311
  74. package/doc/peer-connection_speaker.js.html +381 -381
  75. package/doc/scripts/linenumber.js +25 -25
  76. package/doc/scripts/prettify/Apache-License-2.0.txt +202 -202
  77. package/doc/scripts/prettify/lang-css.js +24 -24
  78. package/doc/scripts/prettify/prettify.js +640 -640
  79. package/doc/server_PythonServerAPI.js.html +160 -160
  80. package/doc/speaker.js.html +248 -248
  81. package/doc/styles/jsdoc-default.css +371 -371
  82. package/doc/styles/prettify-jsdoc.css +111 -111
  83. package/doc/styles/prettify-tomorrow.css +163 -163
  84. package/doc/tasks_audioCalibrator.js.html +207 -207
  85. package/doc/tasks_audioRecorder.js.html +190 -190
  86. package/doc/tasks_impulse-response_impulseResponse.js.html +442 -442
  87. package/doc/tasks_impulse-response_mlsGen_mlsGenInterface.js.html +175 -175
  88. package/doc/tasks_volume_volume.js.html +185 -185
  89. package/doc/utils.js.html +105 -105
  90. package/jest.config.js +173 -173
  91. package/netlify.toml +26 -26
  92. package/package.json +69 -69
  93. package/src/config/firebase.js +25 -25
  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 +291 -288
  99. package/src/peer-connection/peerErrors.js +25 -25
  100. package/src/peer-connection/speaker.js +457 -455
  101. package/src/server/PythonServerAPI.js +587 -587
  102. package/src/tasks/audioCalibrator.js +304 -304
  103. package/src/tasks/audioRecorder.js +277 -277
  104. package/src/tasks/combination/combination.js +1960 -1960
  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 +55 -55
  118. package/webpack.config.js +37 -37
  119. package/makefile +0 -74
@@ -1,455 +1,457 @@
1
- import QRCode from 'qrcode';
2
- import AudioPeer from './audioPeer';
3
- import {sleep} from '../utils';
4
- import {
5
- UnsupportedDeviceError,
6
- MissingSpeakerIdError,
7
- CalibrationTimedOutError,
8
- } from './peerErrors';
9
-
10
- import database from '../config/firebase';
11
- import {ref, set, get, child} from 'firebase/database';
12
- import {phrases} from '../../dist/example/i18n';
13
-
14
- /**
15
- * @class Handles the speaker's side of the connection. Responsible for initiating the connection,
16
- * rendering the QRCode, and answering the call.
17
- * @augments AudioPeer
18
- */
19
- class Speaker extends AudioPeer {
20
- /**
21
- * Takes the url of the current site and a target element where html elements will be appended.
22
- *
23
- * @param params - See type definition for initParameters.
24
- * @param Calibrator - An instance of the AudioCalibrator class, should not use AudioCalibrator directly, instead use an extended class available in /tasks/.
25
- * @param CalibratorInstance
26
- * @example
27
- */
28
- constructor(params, CalibratorInstance) {
29
- super(params);
30
- this.siteUrl += '/listener?';
31
- this.ac = CalibratorInstance;
32
- this.result = null;
33
- this.debug = params?.debug ?? false;
34
- this.isSmartPhone = params?.isSmartPhone ?? false;
35
- this.calibrateSoundHz = params?.calibrateSoundHz ?? 48000;
36
- this.instructionDisplayId = params?.instructionDisplayId ?? '';
37
- this.timeToCalibrateDisplay = params?.timeToCalibrateId ?? '';
38
- this.soundMessageId = params?.soundMessageId ?? '';
39
- this.titleDisplayId = params?.titleDisplayId ?? '';
40
- this.timeToCalibrate = params?.timeToCalibrate ?? 10;
41
-
42
- /* Set up callbacks that handle any events related to our peer object. */
43
- this.peer.on('open', this.#onPeerOpen);
44
- this.peer.on('connection', this.#onPeerConnection);
45
- this.peer.on('close', this.#onPeerClose);
46
- this.peer.on('disconnected', this.#onPeerDisconnected);
47
- this.peer.on('error', this.#onPeerError);
48
- }
49
-
50
- static getMicrophoneNamesFromDatabase = async () => {
51
- const dbRef = ref(database);
52
- const snapshot = await get(child(dbRef, 'Microphone'));
53
- if (snapshot.exists()) {
54
- return Object.keys(snapshot.val());
55
- }
56
- return null;
57
- };
58
-
59
- /**
60
- * Async factory method that creates the Speaker object, and returns a promise that resolves to the result of the calibration.
61
- *
62
- * @param params - The parameters to be passed to the peer object.
63
- * @param Calibrator - The class that defines the calibration process.
64
- * @param CalibratorInstance
65
- * @param timeOut - The amount of time to wait before timing out the connection (in milliseconds).
66
- * @public
67
- * @example
68
- */
69
- static startCalibration = async (params, CalibratorInstance, timeOut = 180000) => {
70
- window.speaker = new Speaker(params, CalibratorInstance);
71
- const {speaker} = window;
72
-
73
- // wrap the calibration process in a promise so we can await it
74
- return new Promise((resolve, reject) => {
75
- // when a call is received
76
- speaker.peer.on('call', async call => {
77
- // Answer the call (one way)
78
- call.answer();
79
- speaker.#removeUIElems();
80
- speaker.#showSpinner();
81
- speaker.ac.createLocalAudio(document.getElementById(speaker.targetElement));
82
- // when we start receiving audio
83
- call.on('stream', async stream => {
84
- window.localStream = stream;
85
- window.localAudio.srcObject = stream;
86
- window.localAudio.autoplay = false;
87
-
88
- // if the sinkSamplingRate is not set sleep
89
- while (!speaker.ac.sampleRatesSet()) {
90
- console.log('SinkSamplingRate is undefined, sleeping');
91
- await sleep(1);
92
- }
93
- // resolve when we have a result
94
- speaker.result = await speaker.ac.startCalibration(
95
- stream,
96
- params.gainValues,
97
- params.ICalib,
98
- params.knownIR,
99
- params.microphoneName,
100
- params.calibrateSoundCheck,
101
- params.isSmartPhone,
102
- params.calibrateSoundBurstDb,
103
- params.calibrateSoundBurstRepeats,
104
- params.calibrateSoundBurstSec,
105
- params.calibrateSoundBurstsWarmup,
106
- params.calibrateSoundHz,
107
- params.calibrateSoundIIRSec,
108
- params.calibrateSound1000HzPreSec,
109
- params.calibrateSound1000HzSec,
110
- params.calibrateSound1000HzPostSec,
111
- params.calibrateSoundBackgroundSecs,
112
- params.micManufacturer,
113
- params.micSerialNumber,
114
- params.micModelNumber,
115
- params.micModelName
116
- );
117
- speaker.#removeUIElems();
118
- resolve(speaker.result);
119
- });
120
- // if we do not receive a result within the timeout, reject
121
- setTimeout(() => {
122
- reject(
123
- new CalibrationTimedOutError(
124
- `Calibration failed to produce a result after ${
125
- timeOut / 1000
126
- } seconds. Please try again.`
127
- )
128
- );
129
- }, timeOut);
130
- });
131
- });
132
- };
133
-
134
- static testIIR = async (params, CalibratorInstance, IIR, timeOut = 180000) => {
135
- window.speaker = new Speaker(params, CalibratorInstance);
136
- const {speaker} = window;
137
-
138
- // wrap the calibration process in a promise so we can await it
139
- return new Promise((resolve, reject) => {
140
- // when a call is received
141
- speaker.peer.on('call', async call => {
142
- // Answer the call (one way)
143
- call.answer();
144
- speaker.#removeUIElems();
145
- speaker.#showSpinner();
146
- speaker.ac.createLocalAudio(document.getElementById(speaker.targetElement));
147
- // when we start receiving audio
148
- call.on('stream', async stream => {
149
- window.localStream = stream;
150
- window.localAudio.srcObject = stream;
151
- window.localAudio.autoplay = false;
152
-
153
- // if the sinkSamplingRate is not set sleep
154
- while (!speaker.ac.sampleRatesSet()) {
155
- console.log('SinkSamplingRate is undefined, sleeping');
156
- await sleep(1);
157
- }
158
- // resolve when we have a result
159
- speaker.result = await speaker.ac.playMLSwithIIR(stream, IIR);
160
- speaker.#removeUIElems();
161
- resolve(speaker.result);
162
- });
163
- // if we do not receive a result within the timeout, reject
164
- setTimeout(() => {
165
- reject(
166
- new CalibrationTimedOutError(
167
- `Calibration failed to produce a result after ${
168
- timeOut / 1000
169
- } seconds. Please try again.`
170
- )
171
- );
172
- }, timeOut);
173
- });
174
- });
175
- };
176
-
177
- /**
178
- * Called after the peer conncection has been opened.
179
- * Generates a QR code for the connection and displays it.
180
- *
181
- * @private
182
- * @example
183
- */
184
- #showQRCode = () => {
185
- // Get query string, the URL parameters to specify a Listener
186
- const queryStringParameters = {
187
- speakerPeerId: this.peer.id,
188
- isSmartPhone: this.isSmartPhone,
189
- calibrateSoundHz: this.calibrateSoundHz,
190
- };
191
- const queryString = this.queryStringFromObject(queryStringParameters);
192
- const uri = this.siteUrl + queryString;
193
- if (this.isSmartPhone) {
194
- // Display QR code for the participant to scan
195
- const qrCanvas = document.createElement('canvas');
196
- qrCanvas.setAttribute('id', 'qrCanvas');
197
- console.log(uri);
198
- QRCode.toCanvas(qrCanvas, uri, error => {
199
- if (error) console.error(error);
200
- });
201
- document.getElementById(this.targetElement).appendChild(qrCanvas);
202
- } else {
203
- // show the link to the user
204
- // If specified HTML Id is available, show QR code there
205
- if (document.getElementById(this.targetElement)) {
206
- // const linkTag = document.createElement('a');
207
- // linkTag.setAttribute('href', uri);
208
- // linkTag.innerHTML = 'Click here to start the calibration';
209
- // linkTag.target = '_blank';
210
- // document.getElementById(this.targetElement).appendChild(linkTag);
211
- // document.getElementById(this.targetElement).appendChild(qrCanvas);
212
-
213
- const proceedButton = document.createElement('button');
214
- proceedButton.setAttribute('id', 'calibrationProceedButton');
215
- proceedButton.setAttribute('class', 'btn btn-success');
216
- proceedButton.innerHTML = 'Proceed';
217
- proceedButton.onclick = () => {
218
- // open the link in a new tab
219
- window.open(uri, '_blank');
220
- // remove the button
221
- document.getElementById('calibrationProceedButton').remove();
222
- };
223
- document.getElementById(this.targetElement).appendChild(proceedButton);
224
- }
225
- }
226
- // or just print it to console
227
- console.log('TEST: Peer reachable at: ', uri);
228
- };
229
-
230
- #showSpinner = () => {
231
- const spinner = document.createElement('div');
232
- spinner.className = 'spinner-border ml-auto';
233
- spinner.role = 'status';
234
- spinner.ariaHidden = 'true';
235
- document.getElementById(this.targetElement).appendChild(spinner);
236
-
237
- // clear instructionDisplay
238
- const soundMessage = document.getElementById(this.soundMessageId);
239
- soundMessage.innerHTML = '';
240
- soundMessage.style.display = 'none';
241
- const instructionDisplay = document.getElementById(this.instructionDisplayId);
242
- const background = document.getElementById('background'); // todo: get background id from params
243
- if (instructionDisplay) {
244
- instructionDisplay.innerHTML = '';
245
- instructionDisplay.style.whiteSpace = 'nowrap';
246
- instructionDisplay.style.fontWeight = 'bold';
247
- instructionDisplay.style.width = 'fit-content';
248
- instructionDisplay.innerHTML = phrases.RC_soundRecording['en-US'];
249
- let fontSize = 100;
250
- instructionDisplay.style.fontSize = fontSize + 'px';
251
- while (instructionDisplay.scrollWidth > background.scrollWidth * 0.9 && fontSize > 10) {
252
- fontSize--;
253
- instructionDisplay.style.fontSize = fontSize + 'px';
254
- }
255
- // const p = document.createElement('p');
256
- // // font size
257
- // p.style.fontSize = '1.1rem';
258
- // p.style.fontWeight = 'normal';
259
- // p.style.paddingTop = '20px';
260
- // const timeToCalibrateText = phrases.RC_howLongToCalibrate['en-US'];
261
- // p.innerHTML = timeToCalibrateText.replace('111', this.timeToCalibrate);
262
- // instructionDisplay.appendChild(p);
263
- }
264
-
265
- const timeToCalibrateDisplay = document.getElementById(this.timeToCalibrateDisplay);
266
- if (timeToCalibrateDisplay) {
267
- const timeToCalibrateText = phrases.RC_howLongToCalibrate['en-US'];
268
- timeToCalibrateDisplay.innerHTML = timeToCalibrateText.replace('111', this.timeToCalibrate);
269
- timeToCalibrateDisplay.style.fontWeight = 'normal';
270
- timeToCalibrateDisplay.style.fontSize = '1rem';
271
- // timeToCalibrateDisplay.style.paddingTop = '20px';
272
- }
273
-
274
- // Update title - titleDisplayId
275
- const titleDisplay = document.getElementById(this.titleDisplayId);
276
- if (titleDisplay) {
277
- // replace 2 with 3
278
- titleDisplay.innerHTML = titleDisplay.innerHTML.replace('2', '3');
279
- // replace 1 with 3
280
- titleDisplay.innerHTML = titleDisplay.innerHTML.replace('1', '3');
281
- titleDisplay.innerHTML = titleDisplay.innerHTML.replace('4', '5');
282
- }
283
- };
284
-
285
- #removeUIElems = () => {
286
- const parent = document.getElementById(this.targetElement);
287
- while (parent.firstChild) {
288
- parent.firstChild.remove();
289
- }
290
- };
291
-
292
- /**
293
- * Called when the peer connection is opened.
294
- * Saves the peer id and calls the QR code generator.
295
- *
296
- * @param peerId - The peer id of the peer connection.
297
- * @param id
298
- * @private
299
- * @example
300
- */
301
- #onPeerOpen = id => {
302
- // Workaround for peer.reconnect deleting previous id
303
- if (id === null) {
304
- console.error('Received null id from peer open');
305
- this.peer.id = this.lastPeerId;
306
- } else {
307
- this.lastPeerId = this.peer.id;
308
- }
309
-
310
- if (id !== this.peer.id) {
311
- console.warn('DEBUG Check you assumption that id === this.peer.id');
312
- }
313
-
314
- this.#showQRCode();
315
- };
316
-
317
- /**
318
- * Called when the peer connection is established.
319
- * Enforces a single connection.
320
- *
321
- * @param connection - The connection object.
322
- * @private
323
- * @example
324
- */
325
- #onPeerConnection = connection => {
326
- // Allow only a single connection
327
- if (this.conn && this.conn.open) {
328
- connection.on('open', () => {
329
- connection.send('Already connected to another client');
330
- setTimeout(() => {
331
- connection.close();
332
- }, 500);
333
- });
334
- return;
335
- }
336
-
337
- this.conn = connection;
338
- console.log('Connected to: ', this.conn.peer);
339
- this.#ready();
340
- };
341
-
342
- /**
343
- * Called when the peer connection is closed.
344
- *
345
- * @private
346
- * @example
347
- */
348
- #onPeerClose = () => {
349
- this.conn = null;
350
- console.log('Connection destroyed');
351
- };
352
-
353
- /**
354
- * Called when the peer connection is disconnected.
355
- * Attempts to reconnect.
356
- *
357
- * @private
358
- * @example
359
- */
360
- #onPeerDisconnected = () => {
361
- console.log('Connection lost. Please reconnect');
362
-
363
- // Workaround for peer.reconnect deleting previous id
364
- this.peer.id = this.lastPeerId;
365
- // eslint-disable-next-line no-underscore-dangle
366
- this.peer._lastServerId = this.lastPeerId;
367
- this.peer.reconnect();
368
- };
369
-
370
- /**
371
- * Called when the peer connection encounters an error.
372
- *
373
- * @param error
374
- * @private
375
- * @example
376
- */
377
- #onPeerError = error => {
378
- // TODO: check if this function is needed or not
379
- console.error(error);
380
- };
381
-
382
- /**
383
- * Called when data is received from the peer connection.
384
- *
385
- * @param data
386
- * @private
387
- * @example
388
- */
389
- #onIncomingData = data => {
390
- // enforce object type
391
- if (
392
- !Object.prototype.hasOwnProperty.call(data, 'name') ||
393
- !Object.prototype.hasOwnProperty.call(data, 'payload')
394
- ) {
395
- console.error('Received malformed data: ', data);
396
- return;
397
- }
398
-
399
- switch (data.name) {
400
- case 'samplingRate':
401
- this.ac.setSamplingRates(data.payload);
402
- break;
403
- case 'deviceType':
404
- this.ac.setDeviceType(data.payload);
405
- break;
406
- case 'deviceName':
407
- this.ac.setDeviceName(data.payload);
408
- break;
409
- case 'deviceInfo':
410
- this.ac.setDeviceInfo(data.payload);
411
- case UnsupportedDeviceError.name:
412
- case MissingSpeakerIdError.name:
413
- throw data.payload;
414
- break;
415
- default:
416
- break;
417
- }
418
- };
419
-
420
- /**
421
- * Called when the peer connection is #ready.
422
- *
423
- * @private
424
- * @example
425
- */
426
- #ready = () => {
427
- // Perform callback with data
428
- this.conn.on('data', this.#onIncomingData);
429
- this.conn.on('close', () => {
430
- console.log('Connection reset<br>Awaiting connection...');
431
- this.conn = null;
432
- });
433
- };
434
-
435
- /** .
436
- * .
437
- * .
438
- * Debug method for downloading the recorded audio
439
- *
440
- * @public
441
- * @example
442
- */
443
- downloadData = () => {
444
- this.ac.downloadData();
445
- };
446
- }
447
-
448
- /*
449
- Referenced links:
450
- https://stackoverflow.com/questions/28016664/when-you-pass-this-as-an-argument/28016676#28016676
451
- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes
452
- https://stackoverflow.com/questions/879152/how-do-i-make-javascript-beep [3]
453
- */
454
-
455
- export default Speaker;
1
+ import QRCode from 'qrcode';
2
+ import AudioPeer from './audioPeer';
3
+ import {sleep} from '../utils';
4
+ import {
5
+ UnsupportedDeviceError,
6
+ MissingSpeakerIdError,
7
+ CalibrationTimedOutError,
8
+ } from './peerErrors';
9
+
10
+ import database from '../config/firebase';
11
+ import {ref, set, get, child} from 'firebase/database';
12
+ import {phrases} from '../../dist/example/i18n';
13
+
14
+ /**
15
+ * @class Handles the speaker's side of the connection. Responsible for initiating the connection,
16
+ * rendering the QRCode, and answering the call.
17
+ * @augments AudioPeer
18
+ */
19
+ class Speaker extends AudioPeer {
20
+ /**
21
+ * Takes the url of the current site and a target element where html elements will be appended.
22
+ *
23
+ * @param params - See type definition for initParameters.
24
+ * @param Calibrator - An instance of the AudioCalibrator class, should not use AudioCalibrator directly, instead use an extended class available in /tasks/.
25
+ * @param CalibratorInstance
26
+ * @example
27
+ */
28
+ constructor(params, CalibratorInstance) {
29
+ super(params);
30
+ this.siteUrl += '/listener?';
31
+ this.ac = CalibratorInstance;
32
+ this.result = null;
33
+ this.debug = params?.debug ?? false;
34
+ this.isSmartPhone = params?.isSmartPhone ?? false;
35
+ this.calibrateSoundHz = params?.calibrateSoundHz ?? 48000;
36
+ this.calibrateSoundSamplingDesiredBits = params?.calibrateSoundSamplingDesiredBits ?? 24;
37
+ this.instructionDisplayId = params?.instructionDisplayId ?? '';
38
+ this.timeToCalibrateDisplay = params?.timeToCalibrateId ?? '';
39
+ this.soundMessageId = params?.soundMessageId ?? '';
40
+ this.titleDisplayId = params?.titleDisplayId ?? '';
41
+ this.timeToCalibrate = params?.timeToCalibrate ?? 10;
42
+
43
+ /* Set up callbacks that handle any events related to our peer object. */
44
+ this.peer.on('open', this.#onPeerOpen);
45
+ this.peer.on('connection', this.#onPeerConnection);
46
+ this.peer.on('close', this.#onPeerClose);
47
+ this.peer.on('disconnected', this.#onPeerDisconnected);
48
+ this.peer.on('error', this.#onPeerError);
49
+ }
50
+
51
+ static getMicrophoneNamesFromDatabase = async () => {
52
+ const dbRef = ref(database);
53
+ const snapshot = await get(child(dbRef, 'Microphone'));
54
+ if (snapshot.exists()) {
55
+ return Object.keys(snapshot.val());
56
+ }
57
+ return null;
58
+ };
59
+
60
+ /**
61
+ * Async factory method that creates the Speaker object, and returns a promise that resolves to the result of the calibration.
62
+ *
63
+ * @param params - The parameters to be passed to the peer object.
64
+ * @param Calibrator - The class that defines the calibration process.
65
+ * @param CalibratorInstance
66
+ * @param timeOut - The amount of time to wait before timing out the connection (in milliseconds).
67
+ * @public
68
+ * @example
69
+ */
70
+ static startCalibration = async (params, CalibratorInstance, timeOut = 180000) => {
71
+ window.speaker = new Speaker(params, CalibratorInstance);
72
+ const {speaker} = window;
73
+
74
+ // wrap the calibration process in a promise so we can await it
75
+ return new Promise((resolve, reject) => {
76
+ // when a call is received
77
+ speaker.peer.on('call', async call => {
78
+ // Answer the call (one way)
79
+ call.answer();
80
+ speaker.#removeUIElems();
81
+ speaker.#showSpinner();
82
+ speaker.ac.createLocalAudio(document.getElementById(speaker.targetElement));
83
+ // when we start receiving audio
84
+ call.on('stream', async stream => {
85
+ window.localStream = stream;
86
+ window.localAudio.srcObject = stream;
87
+ window.localAudio.autoplay = false;
88
+
89
+ // if the sinkSamplingRate is not set sleep
90
+ while (!speaker.ac.sampleRatesSet()) {
91
+ console.log('SinkSamplingRate is undefined, sleeping');
92
+ await sleep(1);
93
+ }
94
+ // resolve when we have a result
95
+ speaker.result = await speaker.ac.startCalibration(
96
+ stream,
97
+ params.gainValues,
98
+ params.ICalib,
99
+ params.knownIR,
100
+ params.microphoneName,
101
+ params.calibrateSoundCheck,
102
+ params.isSmartPhone,
103
+ params.calibrateSoundBurstDb,
104
+ params.calibrateSoundBurstRepeats,
105
+ params.calibrateSoundBurstSec,
106
+ params.calibrateSoundBurstsWarmup,
107
+ params.calibrateSoundHz,
108
+ params.calibrateSoundIIRSec,
109
+ params.calibrateSound1000HzPreSec,
110
+ params.calibrateSound1000HzSec,
111
+ params.calibrateSound1000HzPostSec,
112
+ params.calibrateSoundBackgroundSecs,
113
+ params.micManufacturer,
114
+ params.micSerialNumber,
115
+ params.micModelNumber,
116
+ params.micModelName
117
+ );
118
+ speaker.#removeUIElems();
119
+ resolve(speaker.result);
120
+ });
121
+ // if we do not receive a result within the timeout, reject
122
+ setTimeout(() => {
123
+ reject(
124
+ new CalibrationTimedOutError(
125
+ `Calibration failed to produce a result after ${
126
+ timeOut / 1000
127
+ } seconds. Please try again.`
128
+ )
129
+ );
130
+ }, timeOut);
131
+ });
132
+ });
133
+ };
134
+
135
+ static testIIR = async (params, CalibratorInstance, IIR, timeOut = 180000) => {
136
+ window.speaker = new Speaker(params, CalibratorInstance);
137
+ const {speaker} = window;
138
+
139
+ // wrap the calibration process in a promise so we can await it
140
+ return new Promise((resolve, reject) => {
141
+ // when a call is received
142
+ speaker.peer.on('call', async call => {
143
+ // Answer the call (one way)
144
+ call.answer();
145
+ speaker.#removeUIElems();
146
+ speaker.#showSpinner();
147
+ speaker.ac.createLocalAudio(document.getElementById(speaker.targetElement));
148
+ // when we start receiving audio
149
+ call.on('stream', async stream => {
150
+ window.localStream = stream;
151
+ window.localAudio.srcObject = stream;
152
+ window.localAudio.autoplay = false;
153
+
154
+ // if the sinkSamplingRate is not set sleep
155
+ while (!speaker.ac.sampleRatesSet()) {
156
+ console.log('SinkSamplingRate is undefined, sleeping');
157
+ await sleep(1);
158
+ }
159
+ // resolve when we have a result
160
+ speaker.result = await speaker.ac.playMLSwithIIR(stream, IIR);
161
+ speaker.#removeUIElems();
162
+ resolve(speaker.result);
163
+ });
164
+ // if we do not receive a result within the timeout, reject
165
+ setTimeout(() => {
166
+ reject(
167
+ new CalibrationTimedOutError(
168
+ `Calibration failed to produce a result after ${
169
+ timeOut / 1000
170
+ } seconds. Please try again.`
171
+ )
172
+ );
173
+ }, timeOut);
174
+ });
175
+ });
176
+ };
177
+
178
+ /**
179
+ * Called after the peer conncection has been opened.
180
+ * Generates a QR code for the connection and displays it.
181
+ *
182
+ * @private
183
+ * @example
184
+ */
185
+ #showQRCode = () => {
186
+ // Get query string, the URL parameters to specify a Listener
187
+ const queryStringParameters = {
188
+ speakerPeerId: this.peer.id,
189
+ isSmartPhone: this.isSmartPhone,
190
+ calibrateSoundHz: this.calibrateSoundHz,
191
+ calibrateSoundSamplingDesiredBits: this.calibrateSoundSamplingDesiredBits,
192
+ };
193
+ const queryString = this.queryStringFromObject(queryStringParameters);
194
+ const uri = this.siteUrl + queryString;
195
+ if (this.isSmartPhone) {
196
+ // Display QR code for the participant to scan
197
+ const qrCanvas = document.createElement('canvas');
198
+ qrCanvas.setAttribute('id', 'qrCanvas');
199
+ console.log(uri);
200
+ QRCode.toCanvas(qrCanvas, uri, error => {
201
+ if (error) console.error(error);
202
+ });
203
+ document.getElementById(this.targetElement).appendChild(qrCanvas);
204
+ } else {
205
+ // show the link to the user
206
+ // If specified HTML Id is available, show QR code there
207
+ if (document.getElementById(this.targetElement)) {
208
+ // const linkTag = document.createElement('a');
209
+ // linkTag.setAttribute('href', uri);
210
+ // linkTag.innerHTML = 'Click here to start the calibration';
211
+ // linkTag.target = '_blank';
212
+ // document.getElementById(this.targetElement).appendChild(linkTag);
213
+ // document.getElementById(this.targetElement).appendChild(qrCanvas);
214
+
215
+ const proceedButton = document.createElement('button');
216
+ proceedButton.setAttribute('id', 'calibrationProceedButton');
217
+ proceedButton.setAttribute('class', 'btn btn-success');
218
+ proceedButton.innerHTML = 'Proceed';
219
+ proceedButton.onclick = () => {
220
+ // open the link in a new tab
221
+ window.open(uri, '_blank');
222
+ // remove the button
223
+ document.getElementById('calibrationProceedButton').remove();
224
+ };
225
+ document.getElementById(this.targetElement).appendChild(proceedButton);
226
+ }
227
+ }
228
+ // or just print it to console
229
+ console.log('TEST: Peer reachable at: ', uri);
230
+ };
231
+
232
+ #showSpinner = () => {
233
+ const spinner = document.createElement('div');
234
+ spinner.className = 'spinner-border ml-auto';
235
+ spinner.role = 'status';
236
+ spinner.ariaHidden = 'true';
237
+ document.getElementById(this.targetElement).appendChild(spinner);
238
+
239
+ // clear instructionDisplay
240
+ const soundMessage = document.getElementById(this.soundMessageId);
241
+ soundMessage.innerHTML = '';
242
+ soundMessage.style.display = 'none';
243
+ const instructionDisplay = document.getElementById(this.instructionDisplayId);
244
+ const background = document.getElementById('background'); // todo: get background id from params
245
+ if (instructionDisplay) {
246
+ instructionDisplay.innerHTML = '';
247
+ instructionDisplay.style.whiteSpace = 'nowrap';
248
+ instructionDisplay.style.fontWeight = 'bold';
249
+ instructionDisplay.style.width = 'fit-content';
250
+ instructionDisplay.innerHTML = phrases.RC_soundRecording['en-US'];
251
+ let fontSize = 100;
252
+ instructionDisplay.style.fontSize = fontSize + 'px';
253
+ while (instructionDisplay.scrollWidth > background.scrollWidth * 0.9 && fontSize > 10) {
254
+ fontSize--;
255
+ instructionDisplay.style.fontSize = fontSize + 'px';
256
+ }
257
+ // const p = document.createElement('p');
258
+ // // font size
259
+ // p.style.fontSize = '1.1rem';
260
+ // p.style.fontWeight = 'normal';
261
+ // p.style.paddingTop = '20px';
262
+ // const timeToCalibrateText = phrases.RC_howLongToCalibrate['en-US'];
263
+ // p.innerHTML = timeToCalibrateText.replace('111', this.timeToCalibrate);
264
+ // instructionDisplay.appendChild(p);
265
+ }
266
+
267
+ const timeToCalibrateDisplay = document.getElementById(this.timeToCalibrateDisplay);
268
+ if (timeToCalibrateDisplay) {
269
+ const timeToCalibrateText = phrases.RC_howLongToCalibrate['en-US'];
270
+ timeToCalibrateDisplay.innerHTML = timeToCalibrateText.replace('111', this.timeToCalibrate);
271
+ timeToCalibrateDisplay.style.fontWeight = 'normal';
272
+ timeToCalibrateDisplay.style.fontSize = '1rem';
273
+ // timeToCalibrateDisplay.style.paddingTop = '20px';
274
+ }
275
+
276
+ // Update title - titleDisplayId
277
+ const titleDisplay = document.getElementById(this.titleDisplayId);
278
+ if (titleDisplay) {
279
+ // replace 2 with 3
280
+ titleDisplay.innerHTML = titleDisplay.innerHTML.replace('2', '3');
281
+ // replace 1 with 3
282
+ titleDisplay.innerHTML = titleDisplay.innerHTML.replace('1', '3');
283
+ titleDisplay.innerHTML = titleDisplay.innerHTML.replace('4', '5');
284
+ }
285
+ };
286
+
287
+ #removeUIElems = () => {
288
+ const parent = document.getElementById(this.targetElement);
289
+ while (parent.firstChild) {
290
+ parent.firstChild.remove();
291
+ }
292
+ };
293
+
294
+ /**
295
+ * Called when the peer connection is opened.
296
+ * Saves the peer id and calls the QR code generator.
297
+ *
298
+ * @param peerId - The peer id of the peer connection.
299
+ * @param id
300
+ * @private
301
+ * @example
302
+ */
303
+ #onPeerOpen = id => {
304
+ // Workaround for peer.reconnect deleting previous id
305
+ if (id === null) {
306
+ console.error('Received null id from peer open');
307
+ this.peer.id = this.lastPeerId;
308
+ } else {
309
+ this.lastPeerId = this.peer.id;
310
+ }
311
+
312
+ if (id !== this.peer.id) {
313
+ console.warn('DEBUG Check you assumption that id === this.peer.id');
314
+ }
315
+
316
+ this.#showQRCode();
317
+ };
318
+
319
+ /**
320
+ * Called when the peer connection is established.
321
+ * Enforces a single connection.
322
+ *
323
+ * @param connection - The connection object.
324
+ * @private
325
+ * @example
326
+ */
327
+ #onPeerConnection = connection => {
328
+ // Allow only a single connection
329
+ if (this.conn && this.conn.open) {
330
+ connection.on('open', () => {
331
+ connection.send('Already connected to another client');
332
+ setTimeout(() => {
333
+ connection.close();
334
+ }, 500);
335
+ });
336
+ return;
337
+ }
338
+
339
+ this.conn = connection;
340
+ console.log('Connected to: ', this.conn.peer);
341
+ this.#ready();
342
+ };
343
+
344
+ /**
345
+ * Called when the peer connection is closed.
346
+ *
347
+ * @private
348
+ * @example
349
+ */
350
+ #onPeerClose = () => {
351
+ this.conn = null;
352
+ console.log('Connection destroyed');
353
+ };
354
+
355
+ /**
356
+ * Called when the peer connection is disconnected.
357
+ * Attempts to reconnect.
358
+ *
359
+ * @private
360
+ * @example
361
+ */
362
+ #onPeerDisconnected = () => {
363
+ console.log('Connection lost. Please reconnect');
364
+
365
+ // Workaround for peer.reconnect deleting previous id
366
+ this.peer.id = this.lastPeerId;
367
+ // eslint-disable-next-line no-underscore-dangle
368
+ this.peer._lastServerId = this.lastPeerId;
369
+ this.peer.reconnect();
370
+ };
371
+
372
+ /**
373
+ * Called when the peer connection encounters an error.
374
+ *
375
+ * @param error
376
+ * @private
377
+ * @example
378
+ */
379
+ #onPeerError = error => {
380
+ // TODO: check if this function is needed or not
381
+ console.error(error);
382
+ };
383
+
384
+ /**
385
+ * Called when data is received from the peer connection.
386
+ *
387
+ * @param data
388
+ * @private
389
+ * @example
390
+ */
391
+ #onIncomingData = data => {
392
+ // enforce object type
393
+ if (
394
+ !Object.prototype.hasOwnProperty.call(data, 'name') ||
395
+ !Object.prototype.hasOwnProperty.call(data, 'payload')
396
+ ) {
397
+ console.error('Received malformed data: ', data);
398
+ return;
399
+ }
400
+
401
+ switch (data.name) {
402
+ case 'samplingRate':
403
+ this.ac.setSamplingRates(data.payload);
404
+ break;
405
+ case 'deviceType':
406
+ this.ac.setDeviceType(data.payload);
407
+ break;
408
+ case 'deviceName':
409
+ this.ac.setDeviceName(data.payload);
410
+ break;
411
+ case 'deviceInfo':
412
+ this.ac.setDeviceInfo(data.payload);
413
+ case UnsupportedDeviceError.name:
414
+ case MissingSpeakerIdError.name:
415
+ throw data.payload;
416
+ break;
417
+ default:
418
+ break;
419
+ }
420
+ };
421
+
422
+ /**
423
+ * Called when the peer connection is #ready.
424
+ *
425
+ * @private
426
+ * @example
427
+ */
428
+ #ready = () => {
429
+ // Perform callback with data
430
+ this.conn.on('data', this.#onIncomingData);
431
+ this.conn.on('close', () => {
432
+ console.log('Connection reset<br>Awaiting connection...');
433
+ this.conn = null;
434
+ });
435
+ };
436
+
437
+ /** .
438
+ * .
439
+ * .
440
+ * Debug method for downloading the recorded audio
441
+ *
442
+ * @public
443
+ * @example
444
+ */
445
+ downloadData = () => {
446
+ this.ac.downloadData();
447
+ };
448
+ }
449
+
450
+ /*
451
+ Referenced links:
452
+ https://stackoverflow.com/questions/28016664/when-you-pass-this-as-an-argument/28016676#28016676
453
+ https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes
454
+ https://stackoverflow.com/questions/879152/how-do-i-make-javascript-beep [3]
455
+ */
456
+
457
+ export default Speaker;