speaker-calibration 2.2.62 → 2.2.64

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