speaker-calibration 2.2.196 → 2.2.198

package/package.json

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

package/src/powerCheck.js

@@ -0,0 +1,99 @@
+export const volumePowerCheck = (rec, fs, preSec, Sec, _calibrateSoundPowerBinDesiredSec) => {
+    const coarseHz = 1 / _calibrateSoundPowerBinDesiredSec;
+    const power = rec.map(x => Math.pow(x, 2)); // Squared values of the signal
+    
+    // Adjust coarseHz so that fs is an integer multiple of coarseHz.
+    let n = Math.round(fs / coarseHz);
+    
+    // Sampling times for plotting
+    const t = Array.from({ length: power.length }, (_, i) => i / fs);
+    
+    const coarseSamples = Math.ceil(power.length / n);
+    const coarsePowerDb = new Array(coarseSamples).fill(0);
+    const coarseT = new Array(coarseSamples).fill(0);
+
+    for (let i = 0; i < coarseSamples; i++) {
+        const indices = Array.from({ length: Math.min(n, power.length - i * n) }, (_, idx) => i * n + idx);
+        const extremeIndices = [indices[0], indices[indices.length - 1]];
+        
+        const avgPower = indices.reduce((sum, idx) => sum + power[idx], 0) / indices.length;
+        coarsePowerDb[i] = 10 * Math.log10(avgPower);
+        
+        const avgTime = (t[extremeIndices[0]] + t[extremeIndices[1]]) / 2;
+        coarseT[i] = avgTime;
+    }
+
+    const prepSamples = Math.round(coarseHz * preSec);
+    const postSamples = Math.round(coarseHz * (preSec + Sec));
+    const sd = Math.round(standardDeviation(coarsePowerDb.slice(prepSamples)) * 10) / 10;
+    
+    const coarseTRounded = coarseT.map(t => Math.round(t * 1000) / 1000); // Round to 3 decimal places
+    const coarsePowerDbRounded = coarsePowerDb.map(db => Math.round(db * 1000) / 1000); // Round to 3 decimal places
+
+    const start = interpolate(coarseT, coarsePowerDb, preSec);
+    const end = interpolate(coarseT, coarsePowerDb, preSec + Sec);
+    
+    let preT = coarseTRounded.slice(0, prepSamples);
+    let preDb = coarsePowerDbRounded.slice(0, prepSamples);
+    
+    // Adjust starting point of preT and preDb
+    if (preT[preT.length - 1] < preSec) {
+        preT.push(preSec);
+        preDb.push(start);
+    }
+
+    let recT = coarseTRounded.slice(prepSamples, postSamples);
+    let recDb = coarsePowerDbRounded.slice(prepSamples, postSamples);
+    
+    if (recT[0] > preSec) {
+        recT.unshift(preSec);
+        recDb.unshift(start);
+    }
+    
+    if (recT[recT.length - 1] < preSec + Sec) {
+        recT.push(preSec + Sec);
+        recDb.push(end);
+    }
+
+    let postT = coarseTRounded.slice(postSamples);
+    let postDb = coarsePowerDbRounded.slice(postSamples);
+
+    if (postT[0] > preSec + Sec) {
+        postT.unshift(preSec + Sec);
+        postDb.unshift(end);
+    }
+
+    return { preT, preDb, recT, recDb, postT, postDb, sd };
+}
+
+// Helper function for interpolation
+export const interpolate = (x, y, target) => {
+    let lowIdx = 0;
+    while (lowIdx < x.length - 1 && x[lowIdx] < target) {
+        lowIdx++;
+    }
+
+    const x0 = x[lowIdx - 1];
+    const y0 = y[lowIdx - 1];
+    const x1 = x[lowIdx];
+    const y1 = y[lowIdx];
+
+    // Linear interpolation
+    return y0 + ((target - x0) * (y1 - y0)) / (x1 - x0);
+}
+
+// Helper function to calculate standard deviation
+export const standardDeviation = (arr) => {
+    const mean = arr.reduce((sum, val) => sum + val, 0) / arr.length;
+    const variance = arr.reduce((sum, val) => sum + Math.pow(val - mean, 2), 0) / arr.length;
+    return Math.sqrt(variance);
+}
+
+export const getPower = (dataArray) => {
+    const squaredValues = dataArray.map(value => value * value);
+      const sum_of_squares = squaredValues.reduce((total, value) => total + value, 0);
+      const squared_mean = sum_of_squares / dataArray.length;
+      const dbLevel = 20 * Math.log10(Math.sqrt(squared_mean));
+      const roundedDbLevel = Math.round(dbLevel * 10) / 10;
+      return roundedDbLevel;
+}

package/src/server/PythonServerAPI.js

@@ -830,6 +830,40 @@ class PythonServerAPI {
       });
     return res.data[task];
   };
+
+  volumePowerCheckWithRetry = async ({
+    payload, 
+    sampleRate, 
+    preSec,
+    Sec,
+    binDesiredSec
+  }) => {
+    let retryCount = 0;
+    let response = null;
+
+    while (retryCount < this.MAX_RETRY_COUNT) {
+      try {
+        response = await this.volumePowerCheck({
+          payload, 
+          sampleRate, 
+          preSec,
+          Sec,
+          binDesiredSec});
+        // If the request is successful, break out of the loop
+        break;
+      } catch (error) {
+        console.error(`Error occurred. Retrying... (${retryCount + 1}/${this.MAX_RETRY_COUNT})`);
+        retryCount++;
+        await new Promise(resolve => setTimeout(resolve, this.RETRY_DELAY_MS));
+      }
+    }
+
+    if (response) {
+      return response;
+    } else {
+      throw new Error(`Failed to get volume power check after ${this.MAX_RETRY_COUNT} attempts.`);
+    }
+  };
 }
 
 export default PythonServerAPI;

package/src/tasks/audioCalibrator.js

@@ -82,7 +82,6 @@ class AudioCalibrator extends AudioRecorder {
     mode,
     checkRec
   ) => {
-    this.numSuccesfulCaptures = 0;
     console.warn('before recording background noise');
     // calibration loop
     while (loopCondition()) {
@@ -213,7 +212,7 @@ class AudioCalibrator extends AudioRecorder {
       if (this.isCalibrating) break;
       // after recording
       await afterRecord(lCalib);
-      const sd = await checkSD();
+      const sd = await checkSD() || Infinity;
       if (sd <= maxSD) {
         console.log(`SD =${sd}, less than calibrateSound1000HzMaxSD_dB=${maxSD}`);
         this.numCalibratingRoundsCompleted += 2;

package/src/tasks/combination/combination.js

@@ -11,6 +11,12 @@ import {
   standardDeviation,
   interpolate,
 } from '../../utils';
+
+import {
+  volumePowerCheck,
+  getPower
+} from '../../powerCheck';
+
 import database from '../../config/firebase';
 import {ref, set, get, child} from 'firebase/database';
 import {
@@ -353,7 +359,7 @@ class Combination extends AudioCalibrator {
    * @example
    */
   sendSystemImpulseResponsesToServerForProcessing = async () => {
-    this.addTimeStamp('Get system iir');
+    this.addTimeStamp('Get system IIR');
     const computedIRs = await Promise.all(this.impulseResponses);
     const filteredComputedIRs = computedIRs.filter(element => {
       return element != undefined;
@@ -430,7 +436,7 @@ class Combination extends AudioCalibrator {
    * @example
    */
   sendComponentImpulseResponsesToServerForProcessing = async () => {
-    this.addTimeStamp('Get component iir');
+    this.addTimeStamp('Get component IIR');
     const computedIRs = await Promise.all(this.impulseResponses);
     const filteredComputedIRs = computedIRs.filter(element => {
       return element != undefined;
@@ -538,7 +544,7 @@ class Combination extends AudioCalibrator {
     // Slice the array from the calculated start index to the end of the array
     const background_rec = background_rec_whole.slice(startIndex);
     console.log('Sending background recording to server for processing');
-    this.addTimeStamp('Get background PSD');
+    this.addTimeStamp('Compute background PSD');
     this.pyServerAPI
       .getBackgroundNoisePSDWithRetry({
         background_rec,
@@ -601,7 +607,7 @@ class Combination extends AudioCalibrator {
             this.clearLastUnfilteredRecordedSignals();
             this.numSuccessfulCaptured +=1;
           } else {
-            if (result['sd'] < this._calibrateSoundBurstMaxSD_dB) {
+            if (result['sd'] <= this._calibrateSoundBurstMaxSD_dB) {
               console.log('SD: ' + result['sd'] + ', less than _calibrateSoundBurstMaxSD_dB: ' + this._calibrateSoundBurstMaxSD_dB);
             } else {
               console.log('SD: ' + result['sd'] + ', greater than _calibrateSoundBurstMaxSD_dB: ' + this._calibrateSoundBurstMaxSD_dB);
@@ -618,7 +624,6 @@ class Combination extends AudioCalibrator {
               this.recordingChecks['unfiltered'].pop();
             }
             this.recordingChecks['unfiltered'].push(result);
-            await this.pyServerAPI.checkMemory();
             // let start = new Date().getTime() / 1000;
             //   const payloadT = tf.tensor1d(payload);
             //   payloadT.print();
@@ -631,6 +636,7 @@ class Combination extends AudioCalibrator {
             // console.log("dimention:", xfft.shape);
             // let end = new Date().getTime() / 1000;
             // console.log("Time taken:", end - start, "seconds");
+            console.log('start calculate impulse response');
             const usedPeriodStart = this.num_mls_to_skip  * this.sourceSamplingRate;
             const payload_skipped_warmUp = payload.slice(usedPeriodStart);
             await this.pyServerAPI
@@ -645,7 +651,6 @@ class Combination extends AudioCalibrator {
                 this.fs2 = res['fs2'];
                 this.L_new_n = res['L_new_n'];
                 this.dL_n = res['dL_n'];
-                await this.pyServerAPI.checkMemory();
                 this.impulseResponses.push(
                   await this.pyServerAPI
                     .getImpulseResponse({
@@ -658,7 +663,6 @@ class Combination extends AudioCalibrator {
                       dL_n: this.dL_n,
                     })
                     .then(res => {
-                      if (this.numSuccessfulCaptured < this.numCaptures) {
                         this.numSuccessfulCaptured += 2;
                         this.stepNum += 1;
                         console.log('got impulse response ' + this.stepNum);
@@ -670,7 +674,6 @@ class Combination extends AudioCalibrator {
                           message: this.status,
                         });
                         return res['ir'];
-                      }
                     })
                     .catch(err => {
                       console.error(err);
@@ -735,6 +738,7 @@ class Combination extends AudioCalibrator {
       'Waiting ' + this._calibrateSoundBackgroundSecs + ' second(s) to record background noise'
     );
     let time_to_wait = this._calibrateSoundBackgroundSecs + 0.5;
+    this.addTimeStamp(`Record ${time_to_wait.toFixed(1)} s of background.`)
     await sleep(time_to_wait);
   };
 
@@ -779,7 +783,7 @@ class Combination extends AudioCalibrator {
    */
   #afterMLSRecord = async () => {
     console.log('after record');
-    this.addTimeStamp(`After record unfiltered mls version ${this.icapture}`);
+    this.addTimeStamp(`After record unfiltered MLS version ${this.icapture}`);
     await this.sendRecordingToServerForProcessing();
   };
 
@@ -1021,7 +1025,7 @@ class Combination extends AudioCalibrator {
     let knownGain = this.oldComponentIR.Gain;
     let knownFreq = this.oldComponentIR.Freq;
     let sampleRate = this.sourceSamplingRate || 96000;
-    this.addTimeStamp('Get PSD of mls recording');
+    this.addTimeStamp('Get PSD of MLS recording');
     if (this.isCalibrating) return null;
     let component_unconv_rec_psd = await this.pyServerAPI
       .getSubtractedPSDWithRetry(unconv_rec, knownGain, knownFreq, sampleRate)
@@ -1114,7 +1118,7 @@ class Combination extends AudioCalibrator {
     //iir w/ and without bandpass psd. done
     unconv_rec = this.componentInvertedImpulseResponseNoBandpass;
     conv_rec = this.componentInvertedImpulseResponse;
-    this.addTimeStamp('Get PSD of component iir and component iir no band pass');
+    this.addTimeStamp('Get PSD of component IIR and component IIR no band pass');
     if (this.isCalibrating) return null;
     let component_iir_psd = await this.pyServerAPI
       .getPSDWithRetry({
@@ -1135,7 +1139,7 @@ class Combination extends AudioCalibrator {
       });
     unconv_rec = this.systemInvertedImpulseResponseNoBandpass;
     conv_rec = this.systemInvertedImpulseResponse;
-    this.addTimeStamp('Get PSD of system iir and system iir no band pass');
+    this.addTimeStamp('Get PSD of system IIR and system IIR no band pass');
     if (this.isCalibrating) return null;
     let system_iir_psd = await this.pyServerAPI
       .getPSDWithRetry({
@@ -1155,7 +1159,7 @@ class Combination extends AudioCalibrator {
         console.error(err);
       });
 
-    this.addTimeStamp('Get PSD of mls sequence');
+    this.addTimeStamp('Get PSD of MLS sequence');
     if (this.isCalibrating) return null;
     let mls_psd = await this.pyServerAPI
       .getMLSPSDWithRetry({
@@ -1174,7 +1178,7 @@ class Combination extends AudioCalibrator {
         console.error(err);
       });
 
-    this.addTimeStamp('Get PSD of filered mls (system)');
+    this.addTimeStamp('Get PSD of filtered MLS (system)');
     if (this.isCalibrating) return null;
     let system_filtered_mls_psd = await this.pyServerAPI
       .getMLSPSDWithRetry({
@@ -1210,7 +1214,7 @@ class Combination extends AudioCalibrator {
         console.error(err);
       });
 
-    this.addTimeStamp('Get PSD of filered mls (component)');
+    this.addTimeStamp('Get PSD of filtered MLS (component)');
     if (this.isCalibrating) return null;
     let component_filtered_mls_psd = await this.pyServerAPI
       .getMLSPSDWithRetry({
@@ -1405,7 +1409,7 @@ class Combination extends AudioCalibrator {
       let knownGain = this.oldComponentIR.Gain;
       let knownFreq = this.oldComponentIR.Freq;
       let sampleRate = this.sourceSamplingRate || 96000;
-      this.addTimeStamp('Get PSD of mls recording');
+      this.addTimeStamp('Get PSD of MLS recording');
       if (this.isCalibrating) return null;
       let unconv_results = await this.pyServerAPI
         .getSubtractedPSDWithRetry(unconv_rec, knownGain, knownFreq, sampleRate)
@@ -1472,7 +1476,7 @@ class Combination extends AudioCalibrator {
 
       unconv_rec = this.componentInvertedImpulseResponseNoBandpass;
       conv_rec = this.componentInvertedImpulseResponse;
-      this.addTimeStamp('Get PSD of component iir and component iir no bandpass');
+      this.addTimeStamp('Get PSD of component IIR and component IIR no bandpass');
       if (this.isCalibrating) return null;
       let component_iir_psd = await this.pyServerAPI
         .getPSDWithRetry({
@@ -1493,7 +1497,7 @@ class Combination extends AudioCalibrator {
         });
       unconv_rec = this.systemInvertedImpulseResponseNoBandpass;
       conv_rec = this.systemInvertedImpulseResponse;
-      this.addTimeStamp('Get PSD of system iir and system iir no bandpass');
+      this.addTimeStamp('Get PSD of system IIR and system IIR no bandpass');
       if (this.isCalibrating) return null;
       let system_iir_psd = await this.pyServerAPI
         .getPSDWithRetry({
@@ -1513,7 +1517,7 @@ class Combination extends AudioCalibrator {
           console.error(err);
         });
 
-      this.addTimeStamp('Get PSD of mls sequence');
+      this.addTimeStamp('Get PSD of MLS sequence');
       if (this.isCalibrating) return null;
       let mls_psd = await this.pyServerAPI
         .getMLSPSDWithRetry({
@@ -1532,7 +1536,7 @@ class Combination extends AudioCalibrator {
           console.error(err);
         });
 
-      this.addTimeStamp('Get PSD of filtered mls (component)');
+      this.addTimeStamp('Get PSD of filtered MLS (component)');
       if (this.isCalibrating) return null;
       let filtered_mls_psd = await this.pyServerAPI
         .getMLSPSDWithRetry({
@@ -1679,7 +1683,7 @@ class Combination extends AudioCalibrator {
       //iir w/ and without bandpass psd
       unconv_rec = this.componentInvertedImpulseResponseNoBandpass;
       conv_rec = this.componentInvertedImpulseResponse;
-      this.addTimeStamp('Get PSD of component iir and component iir no band pass');
+      this.addTimeStamp('Get PSD of component IIR and component IIR no band pass');
       if (this.isCalibrating) return null;
       let component_iir_psd = await this.pyServerAPI
         .getPSDWithRetry({
@@ -1700,7 +1704,7 @@ class Combination extends AudioCalibrator {
         });
       unconv_rec = this.systemInvertedImpulseResponseNoBandpass;
       conv_rec = this.systemInvertedImpulseResponse;
-      this.addTimeStamp('Get PSD of system iir and system iir no band pass');
+      this.addTimeStamp('Get PSD of system IIR and system IIR no band pass');
       if (this.isCalibrating) return null;
       let system_iir_psd = await this.pyServerAPI
         .getPSDWithRetry({
@@ -1720,7 +1724,7 @@ class Combination extends AudioCalibrator {
           console.error(err);
         });
 
-      this.addTimeStamp('Get PSD of mls sequence');
+      this.addTimeStamp('Get PSD of MLS sequence');
       if (this.isCalibrating) return null;
       let mls_psd = await this.pyServerAPI
         .getMLSPSDWithRetry({
@@ -1739,7 +1743,7 @@ class Combination extends AudioCalibrator {
           console.error(err);
         });
 
-      this.addTimeStamp('Get PSD of filtered mls (system)');
+      this.addTimeStamp('Get PSD of filtered MLS (system)');
       if (this.isCalibrating) return null;
       let filtered_mls_psd = await this.pyServerAPI
         .getMLSPSDWithRetry({
@@ -1910,7 +1914,7 @@ class Combination extends AudioCalibrator {
 
     const amplitude = Math.pow(10, this.power_dB / 20);
     //MLSpower = Math.pow(10,this.power_dB/20);
-    this.addTimeStamp('Get MLS sequence');
+    this.addTimeStamp('Compute MLS sequence');
     if (this.isCalibrating) return null;
     await this.pyServerAPI
       .getMLSWithRetry({
@@ -2255,9 +2259,11 @@ class Combination extends AudioCalibrator {
 
   #playCalibrationAudioVolume = async () => {
     if (this.numCalibratingRoundsCompleted==1) {
-      this.recordingChecks['warnings'].push(`Redo 1000 Hz, ${this.inDB} dB, recording because SD ${this.recordingChecks['volume'][this.inDB]['sd']} dB> ${this.calibrateSound1000HzMaxSD_dB} dB`);
+      this.recordingChecks['warnings'].push(`Redo 1000 Hz, ${this.inDB} dB, recording because SD ${(this.recordingChecks['volume'][this.inDB]['sd'])} dB> ${this.calibrateSound1000HzMaxSD_dB} dB`);
       this.status =
-      `Redoing 1000 Hz recording because SD ${this.recordingChecks['volume'][this.inDB]} dB> ${this.calibrateSound1000HzMaxSD_dB} dB`.toString() +
+      `Redoing 1000 Hz recording because SD 
+      ${this.recordingChecks['volume'][this.inDB]['sd']} dB> 
+      ${this.calibrateSound1000HzMaxSD_dB} dB`.toString() +
       this.generateTemplate().toString();
       this.emit('update', {
         message: this.status,
@@ -2280,7 +2286,10 @@ class Combination extends AudioCalibrator {
 
   #sendToServerForProcessing = async lCalib => {
     console.log('Sending data to server');
-    this.addTimeStamp('Send volume data to server');
+    const total_dur = this.calibrateSound1000HzPreSec + this.calibrateSound1000HzSec + this.calibrateSound1000HzPostSec;
+    this.addTimeStamp(`Record ${total_dur.toFixed(1)} s of 1000 Hz at ${this.inDB} dB. 
+    (${this.calibrateSound1000HzPreSec.toFixed(1)} s pre + ${this.calibrateSound1000HzSec.toFixed(1)}
+       s used + ${this.calibrateSound1000HzPostSec.toFixed(1)} s post) ”`);
     let left = this.calibrateSound1000HzPreSec;
     let right = this.calibrateSound1000HzPreSec + this.calibrateSound1000HzSec;
     if (this.isCalibrating) return null;
@@ -2301,18 +2310,22 @@ class Combination extends AudioCalibrator {
       .catch(err => {
         console.warn(err);
       });
-
-    await this.pyServerAPI
-      .volumePowerCheck({
-        payload: this.getLastVolumeRecordedSignal(),
-        sampleRate: this.sourceSamplingRate || 96000,
-        binDesiredSec: this._calibrateSoundPowerBinDesiredSec,
-        preSec: this.calibrateSound1000HzPreSec,
-        Sec: this.calibrateSound1000HzSec,
-      })
-      .then(res => {
-        this.recordingChecks['volume'][this.inDB] = res;
-      });
+      const rec = this.getLastVolumeRecordedSignal();
+      console.log('pre period power: ', getPower(rec.slice(0,this.calibrateSound1000HzPreSec * this.sourceSamplingRate)).toFixed(1));
+      console.log('pre period power: ', 
+        getPower(rec.slice(
+          this.calibrateSound1000HzPreSec * this.sourceSamplingRate,
+          (this.calibrateSound1000HzPreSec + this.calibrateSound1000HzSec)* this.sourceSamplingRate)).toFixed(1));
+      console.log('pre period power: ', getPower(rec.slice(
+        (this.calibrateSound1000HzPreSec + this.calibrateSound1000HzSec)* this.sourceSamplingRate)).toFixed(1));
+     const res =  volumePowerCheck(
+      rec,
+      this.sourceSamplingRate || 96000,
+      this.calibrateSound1000HzPreSec,
+      this.calibrateSound1000HzSec, 
+      this._calibrateSoundPowerBinDesiredSec);
+     console.log(res);
+     this.recordingChecks['volume'][this.inDB] = res;
   };
 
   startCalibrationVolume = async (stream, gainValues, lCalib, componentGainDBSPL) => {
@@ -2358,7 +2371,6 @@ class Combination extends AudioCalibrator {
     //reset the values
     //this.incrementStatusBar();
 
-    console.log(this.recordingChecks['warnings']);
     this.outDBSPL = null;
     this.outDBSPL = null;
     this.outDBSPL1000 = null;
@@ -2394,7 +2406,7 @@ class Combination extends AudioCalibrator {
           gainValues[i],
           lCalib, //todo make this a class parameter
           checkRec,
-          () => {return this.recordingChecks['volume'][this.inDB]['sd']},
+          () => {return this.recordingChecks?.['volume']?.[this.inDB]?.['sd'] || 0},
           this.calibrateSound1000HzMaxSD_dB
         );
       } while (this.outDBSPL === null);
@@ -2408,7 +2420,7 @@ class Combination extends AudioCalibrator {
     }
     if (this.isCalibrating) return null;
     // get the volume calibration parameters from the server
-    this.addTimeStamp('Get Volume Calibration Parameters');
+    this.addTimeStamp('Get sound calibration parameters');
 
     const parameters = await this.pyServerAPI
       .getVolumeCalibrationParameters({