speaker-calibration 2.2.204 → 2.2.206

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "speaker-calibration",
-  "version": "2.2.204",
+  "version": "2.2.206",
   "description": "Speaker calibration library for auditory testing",
   "main": "dist/main.js",
   "directories": {

package/src/peer-connection/listener.js

@@ -26,16 +26,11 @@ class Listener extends AudioPeer {
 
     const urlParameters = this.parseURLSearchParams();
     this.calibrateSoundHz =
-    // previous calibrateSoundHz
-      urlParameters.hz !== null && urlParameters.hz !== undefined
-        ? urlParameters.hz
-        : 48000;
+      // previous calibrateSoundHz
+      urlParameters.hz !== null && urlParameters.hz !== undefined ? urlParameters.hz : 48000;
     this.calibrateSoundSamplingDesiredBits =
-    // previous calibrateSoundSamplingDesiredBits
-      urlParameters.bits !== null &&
-      urlParameters.bits !== undefined
-        ? urlParameters.bits
-        : 24;
+      // previous calibrateSoundSamplingDesiredBits
+      urlParameters.bits !== null && urlParameters.bits !== undefined ? urlParameters.bits : 24;
     this.speakerPeerId = urlParameters.speakerPeerId;
 
     this.peer.on('open', this.onPeerOpen);
@@ -161,9 +156,9 @@ class Listener extends AudioPeer {
     this.displayUpdate('Listener - sendFlags');
     this.conn.send({
       name: 'flags',
-      payload: flags
+      payload: flags,
     });
-  }
+  };
 
   getDeviceInfo = async () => {
     try {
@@ -200,7 +195,9 @@ class Listener extends AudioPeer {
 
   applyHQTrackConstraints = async stream => {
     // Contraint the incoming audio to the sampling rate we want
-    stream.getAudioTracks().forEach(track => {console.log(track, track.enabled)});
+    stream.getAudioTracks().forEach(track => {
+      console.log(track, track.enabled);
+    });
     const track = stream.getAudioTracks()[0];
     console.log(track);
     const capabilities = track.getCapabilities();
@@ -242,47 +239,54 @@ class Listener extends AudioPeer {
     return settings;
   };
 
-  getMediaDevicesAudioContraints = () => {
+  getMediaDevicesAudioContraints = async () => {
     const availableConstraints = navigator.mediaDevices.getSupportedConstraints();
 
-    this.displayUpdate(
-      `Listener MediaDevices Available Contraints  - ${JSON.stringify(
-        availableConstraints,
-        undefined,
-        2
-      )}`
-    );
-
     const contraints = {
       // ...(availableConstraints.echoCancellation && availableConstraints.echoCancellation == true
       //   ? {echoCancellation: {exact: false}}
       //   : {}),
-      ...(availableConstraints.sampleRate && availableConstraints.sampleRate == true
-        ? {sampleRate: {ideal: this.calibrateSoundHz}}
-        : {}),
-      ...(availableConstraints.sampleSize && availableConstraints.sampleSize == true
-        ? {sampleSize: {ideal: this.calibrateSoundSamplingDesiredBits}}
-        : {}),
-      ...(availableConstraints.channelCount && availableConstraints.channelCount == true
-        ? {channelCount: {exact: 1}}
-        : {}),
+      // ...(availableConstraints.sampleRate && availableConstraints.sampleRate == true
+      //   ? {sampleRate: {ideal: this.calibrateSoundHz}}
+      //   : {}),
+      // ...(availableConstraints.sampleSize && availableConstraints.sampleSize == true
+      //   ? {sampleSize: {ideal: this.calibrateSoundSamplingDesiredBits}}
+      //   : {}),
+      // ...(availableConstraints.channelCount && availableConstraints.channelCount == true
+      //   ? {channelCount: {exact: 1}}
+      //   : {}),
       echoCancellation: false,
-      noiseSuppression: false,
-      autoGainControl: false,
+      channelCount: 1,
     };
 
     if (this.microphoneDeviceId !== '') {
-      contraints.deviceId = {exact: this.microphoneDeviceId};
+      contraints.deviceId = {exact: await this.getDeviceIdByLabel(this.microphoneDeviceId)};
     }
 
     console.log(contraints);
 
-    this.displayUpdate(
-      `Listener MediaDevices Contraints - ${JSON.stringify(contraints, undefined, 2)}`
-    );
-
     return contraints;
   };
+  getDeviceIdByLabel = async targetLabel => {
+    try {
+      // Enumerate available media devices
+      const devices = await navigator.mediaDevices.enumerateDevices();
+
+      // Find the device with the matching label
+      const matchingDevice = devices.find(
+        device => device.kind === 'audioinput' && device.label === targetLabel
+      );
+
+      if (matchingDevice) {
+        return matchingDevice.deviceId; // Return the deviceId if found
+      } else {
+        throw new Error(`No audio input device found with label: "${targetLabel}"`);
+      }
+    } catch (error) {
+      console.error('Error finding device ID:', error);
+      return null;
+    }
+  };
 
   openAudioStream = async () => {
     this.displayUpdate('Listener - openAudioStream');
@@ -295,28 +299,35 @@ class Listener extends AudioPeer {
       });
       return;
     }
-
+    const constraints = await this.getMediaDevicesAudioContraints();
+    console.log('Constraints right before getUserMedia:', constraints);
     navigator.mediaDevices
       .getUserMedia({
-        // audio: this.getMediaDevicesAudioContraints(),
-        audio: {echoCancellation: false, channelCount: 1},
+        audio: constraints,
         video: false,
+        //audio: {echoCancellation: false, noiseSuppression: false, autoGainControl: false, deviceId: {exact: await this.getDeviceIdByLabel(this.microphoneDeviceId) }},
       })
       .then(stream => {
-        this.displayUpdate(`Listener Track settings before applied constraints - ${JSON.stringify(stream.getAudioTracks()[0].getSettings(), undefined, 2)}`);
+        this.displayUpdate(
+          `Listener Track settings before applied constraints - ${JSON.stringify(
+            stream.getAudioTracks()[0].getSettings(),
+            undefined,
+            2
+          )}`
+        );
         this.applyHQTrackConstraints(stream)
           .then(settings => {
             console.log(settings);
             this.sendSamplingRate(settings.sampleRate);
             let sampleSize = settings.sampleSize;
-            if (!sampleSize){
+            if (!sampleSize) {
               sampleSize = this.calibrateSoundSamplingDesiredBits;
             }
             this.sendSampleSize(sampleSize);
             this.sendFlags({
-              'autoGainControl':settings.autoGainControl,
-              'noiseSuppression':settings.noiseSuppression,
-              'echoCancellation':settings.echoCancellation
+              autoGainControl: settings.autoGainControl,
+              noiseSuppression: settings.noiseSuppression,
+              echoCancellation: settings.echoCancellation,
             });
             this.peer.call(this.speakerPeerId, stream); // one-way call
             this.displayUpdate('Listener - openAudioStream');
@@ -330,6 +341,15 @@ class Listener extends AudioPeer {
       })
       .catch(err => {
         console.error(err);
+        if (err.name === 'OverconstrainedError') {
+          const constraint = err.constraint;
+          const message = `The constraint "${constraint}" cannot be satisfied by the selected microphone. Please adjust your calibration settings or choose a different microphone.`;
+
+          this.displayUpdate(`Listener - OverconstrainedError: ${message}`);
+          console.error(message);
+
+          alert(`Overconstrained Error: ${message}`);
+        }
         this.displayUpdate(
           `Listener - Error in getUserMedia - ${JSON.stringify(err, undefined, 2)}`
         );

package/src/peer-connection/speaker.js

@@ -7,7 +7,7 @@ import {
   CalibrationTimedOutError,
 } from './peerErrors';
 
-import {phrases} from '../../dist/example/i18n';
+//import {phrases} from '../../dist/example/i18n';
 
 /**
  * @class Handles the speaker's side of the connection. Responsible for initiating the connection,
@@ -41,7 +41,9 @@ class Speaker extends AudioPeer {
     this.timeToCalibrate = params?.timeToCalibrate ?? 10;
     this.isParticipant = params?.isParticipant ?? false;
     this.isLoudspeakerCalibration = params?.isLoudspeakerCalibration ?? false;
+    this.deviceId = params?.micrpohoneIdFromWebAudioApi ?? '';
     this.buttonsContainer = params?.buttonsContainer ?? document.createElement('div');
+    this.phrases = params?. phrases ?? {};
 
     /* Set up callbacks that handle any events related to our peer object. */
   }
@@ -207,6 +209,7 @@ class Speaker extends AudioPeer {
             params.calibrateSoundSamplingDesiredBits,
             params.language,
             params.loudspeakerModelName,
+            params.phrases,
           );
           speaker.#removeUIElems();
           resolve(speaker.result);
@@ -284,6 +287,7 @@ class Speaker extends AudioPeer {
       hz: this.calibrateSoundHz,
       bits: this.calibrateSoundSamplingDesiredBits,
       lang: this.language,
+      deviceId: this.deviceId
     };
     const queryString = this.queryStringFromObject(queryStringParameters);
     this.uri = this.siteUrl + queryString;
@@ -327,10 +331,10 @@ class Speaker extends AudioPeer {
         })
         .then(data => {
           explanation.innerHTML = formatLineBreak(
-            phrases.RC_skipQR_ExplanationWithoutPreferNot[this.language]
+            this.phrases.RC_skipQR_ExplanationWithoutPreferNot[this.language]
               .replace('xxx', `<b style="user-select: text">${data.shortURL}</b>`)
               .replace('XXX', `<b style="user-select: text">${data.shortURL}</b>`),
-            phrases.RC_checkInternetConnection[this.language]
+            this.phrases.RC_checkInternetConnection[this.language]
           );
           const checkConnection = document.createElement('a');
           checkConnection.id = 'check-connection';
@@ -340,7 +344,7 @@ class Speaker extends AudioPeer {
           checkConnection.addEventListener('click', function (event) {
             console.log('clicked');
             event.preventDefault(); // Prevent the default link action
-            createAndShowPopup(lang);
+            createAndShowPopup(lang, this.phrases);
           });
           explanation.querySelector('a#check-connection').replaceWith(checkConnection);
         })
@@ -386,7 +390,7 @@ class Speaker extends AudioPeer {
         const proceedButton = document.createElement('button');
         proceedButton.setAttribute('id', 'calibrationProceedButton');
         proceedButton.setAttribute('class', 'btn btn-success');
-        proceedButton.innerHTML = phrases.T_proceed[this.language];
+        proceedButton.innerHTML = this.phrases.T_proceed[this.language];
         proceedButton.onclick = () => {
           // open the link in a new tab
           window.open(this.uri, '_blank');
@@ -423,7 +427,7 @@ class Speaker extends AudioPeer {
       instructionDisplay.style.whiteSpace = 'nowrap';
       instructionDisplay.style.fontWeight = 'bold';
       instructionDisplay.style.width = 'fit-content';
-      instructionDisplay.innerHTML = phrases.RC_soundRecording[this.language];
+      instructionDisplay.innerHTML = this.phrases.RC_soundRecording[this.language];
       let fontSize = 100;
       instructionDisplay.style.fontSize = fontSize + 'px';
       while (instructionDisplay.scrollWidth > background.scrollWidth * 0.9 && fontSize > 10) {
@@ -442,7 +446,7 @@ class Speaker extends AudioPeer {
 
     const timeToCalibrateDisplay = document.getElementById(this.timeToCalibrateDisplay);
     if (timeToCalibrateDisplay) {
-      const timeToCalibrateText = phrases.RC_howLongToCalibrate[this.language];
+      const timeToCalibrateText = this.phrases.RC_howLongToCalibrate[this.language];
       timeToCalibrateDisplay.innerHTML = timeToCalibrateText.replace('111', this.timeToCalibrate);
       timeToCalibrateDisplay.style.fontWeight = 'normal';
       timeToCalibrateDisplay.style.fontSize = '1rem';
@@ -469,13 +473,13 @@ class Speaker extends AudioPeer {
         } else if (this.isSmartPhone) {
           titleDisplay.innerHTML = titleDisplay.innerHTML.replace('6', '7');
         } else {
-          titleDisplay.innerHTML = titleDisplay.innerHTML.replace('5', '6');
+          titleDisplay.innerHTML = titleDisplay.innerHTML.replace('4', '5');
         }
       } else {
         if (this.isSmartPhone) {
           titleDisplay.innerHTML = titleDisplay.innerHTML.replace('5', '6');
         } else {
-          titleDisplay.innerHTML = titleDisplay.innerHTML.replace('4', '5');
+          titleDisplay.innerHTML = titleDisplay.innerHTML.replace('3', '4');
         }
       }
     }
@@ -714,6 +718,7 @@ class Speaker extends AudioPeer {
         params.calibrateSoundSamplingDesiredBits,
         params.language,
         params.loudspeakerModelName,
+        params.phrases,
       );
       this.#removeUIElems();
       resolve(result);

package/src/tasks/combination/combination.js

@@ -32,7 +32,7 @@ import {
   where,
   Timestamp,
 } from 'firebase/firestore';
-import { phrases } from '../../../dist/example/i18n';
+//import { phrases } from '../../../dist/example/i18n';
 
 /**
  *
@@ -312,7 +312,7 @@ class Combination extends AudioCalibrator {
     let systemSD = '';
     let flags = '';
     const reportWebAudioNames = `<strong>${this.webAudioDeviceNames.loudspeakerText} </strong> <strong>${this.webAudioDeviceNames.microphoneText} </strong>`;
-    const samplingParamText =  phrases.RC_SamplingHzBits[this.language].replace('111', this.sourceSamplingRate).replace('222',this.sinkSamplingRate).replace('333', this.calibrateSoundSamplingDesiredBits);
+    const samplingParamText = this.phrases.RC_SamplingHzBits[this.language].replace('111', this.sourceSamplingRate).replace('222',this.sinkSamplingRate).replace('333', this.calibrateSoundSamplingDesiredBits);
     const reportParameters = `${samplingParamText}`;
     if (this.flags) {
       flags = `<br> autoGainControl: ${this.flags.autoGainControl}; 
@@ -2735,6 +2735,7 @@ class Combination extends AudioCalibrator {
     calibrateSoundSamplingDesiredBits = 24,
     language,
     loudspeakerModelName='',
+    phrases,
 
   ) => {
     this._calibrateSoundBurstPreSec = _calibrateSoundBurstPreSec;
@@ -2772,7 +2773,17 @@ class Combination extends AudioCalibrator {
     this._calibrateSoundBurstScalarDB = _calibrateSoundBurstScalarDB;
     this.webAudioDeviceNames = webAudioDeviceNames;
     this.calibrateSoundSamplingDesiredBits = calibrateSoundSamplingDesiredBits;
-    if (isSmartPhone) this.webAudioDeviceNames.microphone = this.deviceInfo.microphoneFromAPI;
+    this.phrases = phrases;
+    if (isSmartPhone) {
+      const leftQuote = "\u201C"; // “
+       const rightQuote = "\u201D"; // ”
+      this.webAudioDeviceNames.microphone = this.deviceInfo.microphoneFromAPI;
+      const quotedWebAudioMic = leftQuote + this.webAudioDeviceNames.microphone + rightQuote;
+      const combinedMicText = this.micModelName + " " + quotedWebAudioMic;
+      webAudioDeviceNames.microphoneText = this.phrases.RC_nameMicrophone[this.language]
+      .replace("“xxx”", combinedMicText)
+      .replace("“XXX”", combinedMicText);
+    }
     // this.webAudioDeviceNames.microphoneText = this.webAudioDeviceNames.microphoneText
     //   .replace('xxx', this.webAudioDeviceNames.microphone)
     //   .replace('XXX', this.webAudioDeviceNames.microphone);

package/src/utils.js

@@ -1,5 +1,5 @@
 import Swal from "sweetalert2";
-import {phrases} from '../dist/example/i18n.js';
+//import {phrases} from '../dist/example/i18n.js';
 /** .
  * .
  * .
@@ -147,7 +147,7 @@ export const formatLineBreak =(inputStr,checkInternetConnection) => {
 
 
   
-export const createAndShowPopup = (lang) => {
+export const createAndShowPopup = (lang, phrases) => {
   console.log(`
     <div style="text-align: left;"> 
     ${convertAsterisksToList(phrases.RC_NeedInternetConnectedPhone[lang].replace(/\n/g, '<br>'))}