speaker-calibration 2.1.3 → 2.1.4

package/package.json

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

package/src/peer-connection/audioPeer.js

@@ -44,7 +44,7 @@ class AudioPeer {
     this.targetElement = param.targetElementId;
 
     this.siteUrl = param.siteUrl;
-
+    this.debug = false;
     // Store for all incoming data
     this.dataStore = [];
 

package/src/peer-connection/speaker.js

@@ -23,10 +23,10 @@ class Speaker extends AudioPeer {
    */
   constructor(params, CalibratorInstance) {
     super(params);
-
     this.siteUrl += '/listener?';
     this.ac = CalibratorInstance;
     this.result = null;
+    this.debug = params?.debug ?? false;
 
     /* Set up callbacks that handle any events related to our peer object. */
     this.peer.on('open', this.#onPeerOpen);
@@ -71,7 +71,11 @@ class Speaker extends AudioPeer {
             await sleep(1);
           }
           // resolve when we have a result
-          speaker.result = await speaker.ac.startCalibration(stream, params.gainValues);
+          speaker.result = await speaker.ac.startCalibration(
+            stream,
+            params.gainValues,
+            params.ICalib
+          );
           speaker.#removeUIElems();
           resolve(speaker.result);
         });
@@ -158,7 +162,7 @@ class Speaker extends AudioPeer {
     // If specified HTML Id is available, show QR code there
     if (document.getElementById(this.targetElement)) {
       if (document.getElementById(this.targetElement)) {
-        if (process.env.NODE_ENV === 'development') {
+        if (this.debug) {
           const linkTag = document.createElement('a');
           linkTag.setAttribute('href', uri);
           linkTag.innerHTML = "Click here to connect to the speaker's microphone";

package/src/server/PythonServerAPI.js

@@ -82,7 +82,7 @@ class PythonServerAPI {
     return res.data[task];
   };
 
-  getVolumeCalibration = async ({payload, sampleRate}) => {
+  getVolumeCalibration = async ({payload, sampleRate, lCalib}) => {
     const task = 'volume';
     let res = null;
 
@@ -92,6 +92,7 @@ class PythonServerAPI {
       task,
       payload,
       'sample-rate': sampleRate,
+      lCalib,
     });
 
     await axios({
@@ -113,7 +114,7 @@ class PythonServerAPI {
     return res.data[task];
   };
 
-  getVolumeCalibrationParameters = async ({inDBValues, outDBSPLValues}) => {
+  getVolumeCalibrationParameters = async ({inDBValues, outDBSPLValues, lCalib}) => {
     const task = 'volume-parameters';
     let res = null;
 
@@ -121,6 +122,7 @@ class PythonServerAPI {
       task,
       inDBValues,
       outDBSPLValues,
+      lCalib,
     });
 
     await axios({
@@ -143,6 +145,7 @@ class PythonServerAPI {
     //below is an example of res.data[task]
     //{
     //  R: 16.56981076554259,
+    //  RMSError: 1.9289162528535229
     //  T: -47.79799120884434,
     //  W: 61.0485247483732,
     //  backgroundDBSPL: 43.88233142069752,

package/src/tasks/audioCalibrator.js

@@ -128,7 +128,8 @@ class AudioCalibrator extends AudioRecorder {
     playCalibrationAudio,
     beforeRecord = () => {},
     afterRecord = () => {},
-    gainValue
+    gainValue,
+    lCalib = 104.92978421490648
   ) => {
     this.numCalibratingRoundsCompleted = 0;
 
@@ -149,7 +150,7 @@ class AudioCalibrator extends AudioRecorder {
       await this.stopRecording();
 
       // after recording
-      await afterRecord();
+      await afterRecord(lCalib);
 
       this.calibrationNodes = [];
 

package/src/tasks/volume/volume.js

@@ -25,14 +25,9 @@ class Volume extends AudioCalibrator {
   #CALIBRATION_TONE_DURATION = 5; // seconds
 
   /** @private */
-  soundGainDBSPL = null;
   outDBSPL = null;
-  power = null;
-  power1000 = null;
-  RMS = null;
   THD = null;
   outDBSPL1000 = null;
-  soundGainDBSPL1000 = null;
 
   handleIncomingData = data => {
     console.log('Received data: ', data);
@@ -120,23 +115,19 @@ class Volume extends AudioCalibrator {
     await sleep(totalDuration);
   };
 
-  #sendToServerForProcessing = () => {
+  #sendToServerForProcessing = (lCalib = 104.92978421490648) => {
     console.log('Sending data to server');
     this.pyServerAPI
       .getVolumeCalibration({
         sampleRate: this.sourceSamplingRate,
         payload: this.#getTruncatedSignal(),
+        lCalib: lCalib,
       })
       .then(res => {
         if (this.outDBSPL === null) {
           this.outDBSPL = res['outDbSPL'];
-          this.soundGainDBSPL = res['soundGainDbSPL'];
           this.outDBSPL1000 = res['outDbSPL1000'];
-          this.power = res['power']
-          this.power1000 = res['power1000']
-          this.THD = res['thd']
-          this.RMS = res['rms']
-          this.soundGainDBSPL1000 = res['soundGainDbSPL1000'];
+          this.THD = res['thd'];
         }
       })
       .catch(err => {
@@ -144,19 +135,13 @@ class Volume extends AudioCalibrator {
       });
   };
 
-  startCalibration = async (stream, gainValues) => {
+  startCalibration = async (stream, gainValues, lCalib = 104.92978421490648) => {
     const trialIterations = gainValues.length;
-    const soundGainDBSPLValues = [];
-    const soundGainDBSPL1000Values = [];
-    const power1000Values = [];
-    const powerValues = [];
-    const rmsValues = [];
     const thdValues = [];
     const inDBValues = [];
     let inDB = 0;
     const outDBSPLValues = [];
     const outDBSPL1000Values = [];
-
     // run the calibration at different gain values provided by the user
     for (let i = 0; i < trialIterations; i++) {
       //convert gain to DB and add to inDB
@@ -170,31 +155,26 @@ class Volume extends AudioCalibrator {
           this.#playCalibrationAudio,
           this.#createCalibrationToneWithGainValue,
           this.#sendToServerForProcessing,
-          gainValues[i]
+          gainValues[i],
+          lCalib //todo make this a class parameter
         );
       } while (this.outDBSPL === null);
       outDBSPL1000Values.push(this.outDBSPL1000);
-      power1000Values.push(this.power1000);
-      powerValues.push(this.power);
-      rmsValues.push(this.RMS);
       thdValues.push(this.THD);
       outDBSPLValues.push(this.outDBSPL);
-      soundGainDBSPLValues.push(this.soundGainDBSPL);
-      soundGainDBSPL1000Values.push(this.soundGainDBSPL1000);
 
       this.outDBSPL = null;
-      this.soundGainDBSPL = null;
-      this.power1000 = null;
-      this.power = null;
       this.outDBSPL1000 = null;
-      this.RMS = null;
       this.THD = null;
-      this.soundGainDBSPL1000=null;
     }
 
     // get the volume calibration parameters from the server
     const parameters = await this.pyServerAPI
-      .getVolumeCalibrationParameters({inDBValues: inDBValues, outDBSPLValues: outDBSPL1000Values})
+      .getVolumeCalibrationParameters({
+        inDBValues: inDBValues,
+        outDBSPLValues: outDBSPL1000Values,
+        lCalib: lCalib,
+      })
       .then(res => {
         return res;
       });
@@ -202,13 +182,8 @@ class Volume extends AudioCalibrator {
       parameters: parameters,
       inDBValues: inDBValues,
       outDBSPLValues: outDBSPLValues,
-      soundGainDBSPLValues: soundGainDBSPLValues,
-      powerValues: powerValues,
-      power1000Values: power1000Values,
       outDBSPL1000Values: outDBSPL1000Values,
-      rmsValues: rmsValues,
       thdValues: thdValues,
-      soundGainDBSPL1000Values: soundGainDBSPL1000Values
     };
 
     return result;