speaker-calibration 2.2.79 → 2.2.81

package/package.json

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

package/src/config/firebase.js

@@ -1,7 +1,7 @@
 // Import the functions you need from the SDKs you need
 import {initializeApp} from 'firebase/app';
 import {getDatabase} from 'firebase/database';
-
+import {getFirestore} from 'firebase/firestore';
 // TODO: Add SDKs for Firebase products that you want to use
 // https://firebase.google.com/docs/web/setup#available-libraries
 
@@ -20,6 +20,7 @@ const firebaseConfig = {
 
 // Initialize Firebase
 const app = initializeApp(firebaseConfig);
-const database = getDatabase();
+// const database = getDatabase();
+const database = getFirestore(app);
 
 export default database;

package/src/peer-connection/speaker.js

@@ -7,8 +7,6 @@ import {
   CalibrationTimedOutError,
 } from './peerErrors';
 
-import database from '../config/firebase';
-import {ref, set, get, child} from 'firebase/database';
 import {phrases} from '../../dist/example/i18n';
 
 /**
@@ -48,25 +46,6 @@ class Speaker extends AudioPeer {
     this.peer.on('disconnected', this.#onPeerDisconnected);
     this.peer.on('error', this.#onPeerError);
   }
-
-  static getMicrophoneNamesFromDatabase = async () => {
-    const dbRef = ref(database);
-    const snapshot = await get(child(dbRef, 'Microphone'));
-    if (snapshot.exists()) {
-      return Object.keys(snapshot.val());
-    }
-    return null;
-  };
-
-  static doesMicrophoneExist = async (speakerID, OEM) => {
-    const dbRef = ref(database);
-    const snapshot = await get(child(dbRef, `Microphone2/${OEM}/${speakerID}`));
-    if (snapshot.exists()) {
-      return true;
-    }
-    return false;
-  };
-
   /**
    * Async factory method that creates the Speaker object, and returns a promise that resolves to the result of the calibration.
    *
@@ -116,6 +95,7 @@ class Speaker extends AudioPeer {
             params.calibrateSoundBurstSec,
             params.calibrateSoundBurstsWarmup,
             params.calibrateSoundHz,
+            params.calibrateSoundIRSec,
             params.calibrateSoundIIRSec,
             params.calibrateSound1000HzPreSec,
             params.calibrateSound1000HzSec,

package/src/server/PythonServerAPI.js

@@ -275,7 +275,8 @@ class PythonServerAPI {
     componentIRFreqs,
     num_periods,
     sampleRate,
-    calibrateSoundBurstDb
+    calibrateSoundBurstDb,
+    irLength
   }) => {
     const task = 'component-inverse-impulse-response';
     let res = null;
@@ -293,7 +294,8 @@ class PythonServerAPI {
       componentIRFreqs,
       num_periods,
       sampleRate,
-      calibrateSoundBurstDb
+      calibrateSoundBurstDb,
+      irLength
     });
 
     await axios({
@@ -424,7 +426,8 @@ class PythonServerAPI {
     componentIRFreqs,
     num_periods,
     sampleRate,
-    calibrateSoundBurstDb
+    calibrateSoundBurstDb,
+    irLength
   }) => {
     let retryCount = 0;
     let response = null;
@@ -441,7 +444,8 @@ class PythonServerAPI {
           componentIRFreqs,
           num_periods,
           sampleRate,
-          calibrateSoundBurstDb
+          calibrateSoundBurstDb,
+          irLength
         });
         // If the request is successful, break out of the loop
         break;

package/src/tasks/combination/combination.js

@@ -3,6 +3,7 @@ import AudioCalibrator from '../audioCalibrator';
 import {sleep, csvToArray, saveToCSV, saveToJSON, findMinValue, findMaxValue} from '../../utils';
 import database from '../../config/firebase';
 import {ref, set, get, child} from 'firebase/database';
+import {doc, getDoc, collection, addDoc, updateDoc, setDoc} from 'firebase/firestore';
 
 /**
  *
@@ -161,6 +162,8 @@ class Combination extends AudioCalibrator {
 
   iirLength = 0;
 
+  irLength = 0;
+
   componentInvertedImpulseResponseNoBandpass = [];
 
   componentIRInTimeDomain = [];
@@ -293,6 +296,7 @@ class Combination extends AudioCalibrator {
     const mls = this.#mls;
     const lowHz = this.#lowHz;
     const iirLength = this.iirLength;
+    const irLength = this.irLength;
     const num_periods = this.numMLSPerCapture + this.num_mls_to_skip;
     const highHz = this.#highHz;
     this.stepNum += 1;
@@ -312,6 +316,7 @@ class Combination extends AudioCalibrator {
         num_periods,
         sampleRate: this.sourceSamplingRate || 96000,
         calibrateSoundBurstDb: this._calibrateSoundBurstDb,
+        irLength
       })
       .then(res => {
         console.log(res);
@@ -1808,6 +1813,23 @@ class Combination extends AudioCalibrator {
     return result;
   };
 
+  writeFrqGainToFirestore = async (speakerID, frq, gain, OEM, documentID) => {
+    // freq and gain are too large to take samples 1 in every 100 samples
+
+    const sampledFrq = [];
+    const sampledGain = [];
+    for (let i = 0; i < frq.length; i += 100) {
+      sampledFrq.push(frq[i]);
+      sampledGain.push(gain[i]);
+    }
+
+    const data = {Freq: sampledFrq, Gain: sampledGain};
+    // update Microphone/OEM/speakerID/default/linear
+    const docRef = doc(database, 'Microphone', OEM, speakerID, documentID);
+    await updateDoc(docRef, {
+      linear: data,
+    });
+  };
   // function to write frq and gain to firebase database given speakerID
   writeFrqGain = async (speakerID, frq, gain, OEM) => {
     // freq and gain are too large to take samples 1 in every 100 samples
@@ -1826,7 +1848,16 @@ class Combination extends AudioCalibrator {
 
   // Function to Read frq and gain from firebase database given speakerID
   // returns an array of frq and gain if speakerID exists, returns null otherwise
+  readFrqGainFromFirestore = async (speakerID, OEM, documentID) => {
+    const docRef = doc(database, 'Microphone', OEM, speakerID, documentID);
+    const docSnap = await getDoc(docRef);
 
+    if (docSnap.exists()) {
+      return docSnap.data().linear;
+    } else {
+      return null;
+    }
+  };
   readFrqGain = async (speakerID, OEM) => {
     const dbRef = ref(database);
     const snapshot = await get(child(dbRef, `Microphone2/${OEM}/${speakerID}/linear`));
@@ -1835,6 +1866,16 @@ class Combination extends AudioCalibrator {
     }
     return null;
   };
+  readGainat1000HzFromFirestore = async (speakerID, OEM, documentID) => {
+    const docRef = doc(database, 'Microphone', OEM, speakerID, documentID);
+    const docSnap = await getDoc(docRef);
+
+    if (docSnap.exists()) {
+      return docSnap.data().Gain1000;
+    } else {
+      return null;
+    }
+  };
 
   readGainat1000Hz = async (speakerID, OEM) => {
     const dbRef = ref(database);
@@ -1845,16 +1886,58 @@ class Combination extends AudioCalibrator {
     return null;
   };
 
+  writeGainat1000HzToFirestore = async (speakerID, gain, OEM, documentID) => {
+    const docRef = doc(database, 'Microphone', OEM, speakerID, documentID);
+
+    await updateDoc(docRef, {
+      Gain1000: gain,
+    });
+  };
+
   writeGainat1000Hz = async (speakerID, gain, OEM) => {
-    const data = {Gain: gain};
     await set(ref(database, `Microphone2/${OEM}/${speakerID}/Gain1000`), gain);
   };
 
+  writeIsSmartPhoneToFirestore = async (speakerID, isSmartPhone, OEM) => {
+    // if Microphone/OEM/speakerID/default exists, leave it alone and create a new document at Microphone/OEM/speakerID and return the id of the new document
+
+    const docRef = doc(database, 'Microphone', OEM, speakerID, 'default');
+    const docSnap = await getDoc(docRef);
+
+    if (docSnap.exists()) {
+      // add new document
+      const collectionRef = collection(database, 'Microphone', OEM, speakerID);
+      // add the new document and return the id
+      const docRef = await addDoc(collectionRef, {isSmartPhone: isSmartPhone});
+      return docRef.id;
+    } else {
+      // create document at Microphone/OEM/speakerID/default
+      await setDoc(docRef, {isSmartPhone: isSmartPhone});
+      return 'default';
+    }
+  };
+
   writeIsSmartPhone = async (speakerID, isSmartPhone, OEM) => {
     const data = {isSmartPhone: isSmartPhone};
     await set(ref(database, `Microphone2/${OEM}/${speakerID}/isSmartPhone`), isSmartPhone);
   };
 
+  writeMicrophoneInfoToFirestore = async (speakerID, micInfo, OEM, documentID) => {
+    const docRef = doc(database, 'Microphone', OEM, speakerID, documentID);
+    await updateDoc(docRef, {
+      info: micInfo,
+    });
+  };
+
+  doesMicrophoneExistInFirestore = async (speakerID, OEM, documentID) => {
+    const docRef = doc(database, 'Microphone', OEM, speakerID, documentID);
+    const docSnap = await getDoc(docRef);
+    if (docSnap.exists()) {
+      return true;
+    }
+    return false;
+  };
+
   doesMicrophoneExist = async (speakerID, OEM) => {
     const dbRef = ref(database);
     const snapshot = await get(child(dbRef, `Microphone2/${OEM}/${speakerID}`));
@@ -1943,6 +2026,7 @@ class Combination extends AudioCalibrator {
     _calibrateSoundBurstsWarmup = 1,
     _calibrateSoundHz = 48000,
     _calibrateSoundIIRSec = 0.2,
+    _calibrateSoundIRSec = 0.05,
     calibrateSound1000HzPreSec = 3.5,
     calibrateSound1000HzSec = 1.0,
     calibrateSound1000HzPostSec = 0.5,
@@ -1959,6 +2043,7 @@ class Combination extends AudioCalibrator {
     this.calibrateSound1000HzSec = calibrateSound1000HzSec;
     this.calibrateSound1000HzPostSec = calibrateSound1000HzPostSec;
     this.iirLength = Math.floor(_calibrateSoundIIRSec * this.sourceSamplingRate);
+    this.irLength = Math.floor(_calibrateSoundIRSec * this.sourceSamplingRate);
     console.log('device info:', this.deviceInfo);
     this.numMLSPerCapture = _calibrateSoundBurstRepeats;
     this.desired_time_per_mls = _calibrateSoundBurstSec;
@@ -1997,15 +2082,20 @@ class Combination extends AudioCalibrator {
       }
     }
 
-    this.addMicrophoneInfo(ID, OEM, micInfo);
+    // this.writeMicrophoneInfoToFirestore(ID, micInfo, OEM, 'default');
+    // this.addMicrophoneInfo(ID, OEM, micInfo);
     if (componentIR == null) {
       //mode 'ir'
       //global variable this.componentIR must be set
-      this.componentIR = await this.readFrqGain(ID, OEM).then(data => {
+      this.componentIR = await this.readFrqGainFromFirestore(ID, OEM, 'default').then(data => {
         return data;
       });
+      // await this.readFrqGain(ID, OEM).then(data => {
+      //   return data;
+      // });
 
-      lCalib = await this.readGainat1000Hz(ID, OEM);
+      // lCalib = await this.readGainat1000Hz(ID, OEM);
+      lCalib = await this.readGainat1000HzFromFirestore(ID, OEM, 'default');
       micInfo['gainDBSPL'] = lCalib;
       // this.componentGainDBSPL = this.convertToDB(lCalib);
       this.componentGainDBSPL = lCalib;
@@ -2021,7 +2111,7 @@ class Combination extends AudioCalibrator {
       lCalib = this.findGainatFrequency(this.componentIR.Freq, this.componentIR.Gain, 1000);
       // this.componentGainDBSPL = this.convertToDB(lCalib);
       this.componentGainDBSPL = lCalib;
-      await this.writeIsSmartPhone(ID, isSmartPhone, OEM);
+      // await this.writeIsSmartPhone(ID, isSmartPhone, OEM);
     }
 
     this.oldComponentIR = this.componentIR;
@@ -2043,10 +2133,19 @@ class Combination extends AudioCalibrator {
       //   impulseResponseResults.component.ir.Gain,
       //   OEM
       // );
+      const id = await this.writeIsSmartPhoneToFirestore(ID, isSmartPhone, OEM);
+      await this.writeMicrophoneInfoToFirestore(ID, micInfo, OEM, id);
+      await this.writeFrqGainToFirestore(
+        ID,
+        impulseResponseResults.component.ir.Freq,
+        impulseResponseResults.component.ir.Gain,
+        OEM,
+        id
+      );
+      await this.writeGainat1000HzToFirestore(ID, micInfo['gainDBSPL'], OEM, id);
       micInfo['gainDBSPL'] = impulseResponseResults.component.gainDBSPL;
       // await this.writeGainat1000Hz(ID, micInfo['gainDBSPL'], OEM);
     }
-
     const total_results = {...volumeResults, ...impulseResponseResults};
     total_results['filteredMLSRange'] = this.filteredMLSRange;
     total_results['micInfo'] = micInfo;