speaker-calibration 2.2.10 → 2.2.12

package/package.json

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

package/src/peer-connection/listener.js

@@ -21,6 +21,10 @@ class Listener extends AudioPeer {
     this.receiverPeerId = null;
 
     const urlParameters = this.parseURLSearchParams();
+    this.calibrateSoundHz =
+      urlParameters.calibrateSoundHz !== null && urlParameters.calibrateSoundHz !== undefined
+        ? urlParameters.calibrateSoundHz
+        : 48000;
     this.speakerPeerId = urlParameters.speakerPeerId;
 
     this.peer.on('open', this.onPeerOpen);
@@ -99,7 +103,7 @@ class Listener extends AudioPeer {
     this.displayUpdate('Created connection');
     this.conn.on('open', async () => {
       this.displayUpdate('Listener - conn open');
-      // await this.getDeviceType();
+      await this.getDeviceInfo();
       // this.sendSamplingRate();
       await this.openAudioStream();
     });
@@ -134,27 +138,35 @@ class Listener extends AudioPeer {
     });
   };
 
-  getDeviceType = async () => {
-    const deviceType = deviceAPI.deviceType;
-    var deviceName = deviceAPI.deviceName;
-
-    // if deviceName is a comma separated string, only send the first part
-    if (deviceName.includes(',')) {
-      deviceName = deviceName.split(',')[0];
+  getDeviceInfo = async () => {
+    try {
+      const deviceInfo = {};
+      fod.complete(function (data) {
+        deviceInfo['IsMobile'] = data.device['ismobile'];
+        deviceInfo['HardwareName'] = data.device['hardwarename'];
+        deviceInfo['HardwareFamily'] = data.device['hardwarefamily'];
+        deviceInfo['HardwareModel'] = data.device['hardwaremodel'];
+        deviceInfo['OEM'] = data.device['oem'];
+        deviceInfo['HardwareModelVariants'] = data.device['hardwaremodelvariants'];
+        deviceInfo['DeviceId'] = data.device['deviceid'];
+        deviceInfo['PlatformName'] = data.device['platformname'];
+        deviceInfo['PlatformVersion'] = data.device['platformversion'];
+        deviceInfo['DeviceType'] = data.device['devicetype'];
+      });
+      this.conn.send({
+        name: 'deviceInfo',
+        payload: deviceInfo,
+      });
+      return deviceInfo;
+    } catch (error) {
+      console.error('Error fetching or executing script:', error.message);
+      return null;
     }
-
-    this.conn.send({
-      name: 'deviceType',
-      payload: deviceType,
-    });
-    this.conn.send({
-      name: 'deviceName',
-      payload: deviceName,
-    });
   };
 
   applyHQTrackConstraints = async stream => {
     // Contraint the incoming audio to the sampling rate we want
+
     const track = stream.getAudioTracks()[0];
     const capabilities = track.getCapabilities();
 
@@ -169,7 +181,7 @@ class Listener extends AudioPeer {
     }
 
     if (capabilities.sampleRate) {
-      constraints.sampleRate = 48000;
+      constraints.sampleRate = this.calibrateSoundHz;
     }
 
     if (capabilities.sampleSize) {
@@ -211,7 +223,7 @@ class Listener extends AudioPeer {
       //   ? {echoCancellation: {exact: false}}
       //   : {}),
       ...(availableConstraints.sampleRate && availableConstraints.sampleRate == true
-        ? {sampleRate: {ideal: 48000}}
+        ? {sampleRate: {ideal: this.calibrateSoundHz}}
         : {}),
       ...(availableConstraints.sampleSize && availableConstraints.sampleSize == true
         ? {sampleSize: {ideal: 24}}
@@ -219,9 +231,9 @@ class Listener extends AudioPeer {
       ...(availableConstraints.channelCount && availableConstraints.channelCount == true
         ? {channelCount: {exact: 1}}
         : {}),
-        echoCancellation: false,
-        noiseSuppression: false,
-        autoGainControl: false
+      echoCancellation: false,
+      noiseSuppression: false,
+      autoGainControl: false,
     };
 
     console.log(contraints);

package/src/peer-connection/speaker.js

@@ -32,6 +32,7 @@ class Speaker extends AudioPeer {
     this.result = null;
     this.debug = params?.debug ?? false;
     this.isSmartPhone = params?.isSmartPhone ?? false;
+    this.calibrateSoundHz = params?.calibrateSoundHz ?? 48000;
     this.instructionDisplayId = params?.instructionDisplayId ?? '';
     this.titleDisplayId = params?.titleDisplayId ?? '';
     this.timeToCalibrate = params?.timeToCalibrate ?? 10;
@@ -99,7 +100,11 @@ class Speaker extends AudioPeer {
             params.calibrateSoundBurstRepeats,
             params.calibrateSoundBurstSec,
             params.calibrateSoundBurstsWarmup,
-            params.calibrateSoundHz
+            params.calibrateSoundHz,
+            params.micManufacturer,
+            params.micSerialNumber,
+            params.micModelNumber,
+            params.micModelName
           );
           speaker.#removeUIElems();
           resolve(speaker.result);
@@ -173,6 +178,7 @@ class Speaker extends AudioPeer {
     const queryStringParameters = {
       speakerPeerId: this.peer.id,
       isSmartPhone: this.isSmartPhone,
+      calibrateSoundHz: this.calibrateSoundHz,
     };
     const queryString = this.queryStringFromObject(queryStringParameters);
     const uri = this.siteUrl + queryString;
@@ -379,6 +385,8 @@ class Speaker extends AudioPeer {
       case 'deviceName':
         this.ac.setDeviceName(data.payload);
         break;
+      case 'deviceInfo':
+        this.ac.setDeviceInfo(data.payload);
       case UnsupportedDeviceError.name:
       case MissingSpeakerIdError.name:
         throw data.payload;

package/src/tasks/combination/combination.js

@@ -141,6 +141,8 @@ class Combination extends AudioCalibrator {
 
   deviceName = null;
 
+  deviceInfo = null;
+
   desired_time_per_mls = 0;
 
   num_mls_to_skip = 0;
@@ -153,6 +155,8 @@ class Combination extends AudioCalibrator {
 
   sourceNode;
 
+  autocorrelations = [];
+
   /**generate string template that gets reevaluated as variable increases */
   generateTemplate = () => {
     if (this.percent_complete > 100) {
@@ -176,6 +180,10 @@ class Combination extends AudioCalibrator {
     this.deviceName = deviceName;
   };
 
+  setDeviceInfo = deviceInfo => {
+    this.deviceInfo = deviceInfo;
+  };
+
   /** .
    * .
    * .
@@ -319,7 +327,8 @@ class Combination extends AudioCalibrator {
             this.emit('update', {
               message: this.status,
             });
-            return res;
+            this.autocorrelations.push(res['autocorrelation']);
+            return res['ir'];
           }
         })
         .catch(err => {
@@ -347,16 +356,16 @@ class Combination extends AudioCalibrator {
       message: this.status,
     });
     let time_to_wait = 0;
-    if (this.mode === 'unfiltered'){
+    if (this.mode === 'unfiltered') {
       time_to_wait = (this.#mls.length / this.sourceSamplingRate) * this.numMLSPerCapture;
-    }else if (this.mode === 'filtered'){
+    } else if (this.mode === 'filtered') {
       time_to_wait =
-      (this.#currentConvolution.length / this.sourceSamplingRate) * this.numMLSPerCapture;
-    }else{
-      throw new Error("Mode broke in awaitDesiredMLSLength");
+        (this.#currentConvolution.length / this.sourceSamplingRate) * this.numMLSPerCapture;
+    } else {
+      throw new Error('Mode broke in awaitDesiredMLSLength');
     }
-    
-    await sleep(time_to_wait*1.1);
+
+    await sleep(time_to_wait * 1.1);
   };
 
   /** .
@@ -377,12 +386,12 @@ class Combination extends AudioCalibrator {
     });
     let number_of_bursts_to_skip = this.num_mls_to_skip;
     let time_to_sleep = 0;
-    if (this.mode === 'unfiltered'){
+    if (this.mode === 'unfiltered') {
       time_to_sleep = this.#mls.length / this.sourceSamplingRate;
-    }else if (this.mode === 'filtered'){
+    } else if (this.mode === 'filtered') {
       time_to_sleep = this.#currentConvolution.length / this.sourceSamplingRate;
-    }else{
-      throw new Error("Mode broke in awaitSignalOnset");
+    } else {
+      throw new Error('Mode broke in awaitSignalOnset');
     }
     await sleep(time_to_sleep);
   };
@@ -455,10 +464,10 @@ class Combination extends AudioCalibrator {
   #createCalibrationNodeFromBuffer = dataBuffer => {
     console.log('databuffer');
     console.log(dataBuffer);
-    if (!this.sourceAudioContext){
+    if (!this.sourceAudioContext) {
       this.makeNewSourceAudioContext();
     }
-    
+
     const buffer = this.sourceAudioContext.createBuffer(
       1, // number of channels
       dataBuffer.length,
@@ -474,10 +483,8 @@ class Combination extends AudioCalibrator {
     } catch (error) {
       console.error(error);
     }
-   
+
     this.sourceNode = this.sourceAudioContext.createBufferSource();
-    
-    
 
     this.sourceNode.buffer = buffer;
     this.sourceNode.loop = true;
@@ -568,23 +575,23 @@ class Combination extends AudioCalibrator {
    * @example
    */
   #playCalibrationAudio = () => {
-    if (this.mode === 'unfiltered'){
+    if (this.mode === 'unfiltered') {
       this.calibrationNodes[0].start(0);
       this.#mls = this.calibrationNodes[0].buffer.getChannelData(0);
       console.log('play calibration audio ' + this.stepNum);
       this.status =
-      `All Hz Calibration: playing the calibration tone...`.toString() +
-      this.generateTemplate().toString();
+        `All Hz Calibration: playing the calibration tone...`.toString() +
+        this.generateTemplate().toString();
       this.emit('update', {message: this.status});
-    } else if (this.mode === 'filtered'){
+    } else if (this.mode === 'filtered') {
       this.calibrationNodes[0].start(0);
       console.log('play convolved audio ' + this.stepNum);
       this.status =
         `All Hz Calibration: playing the convolved calibration tone...`.toString() +
-      this.generateTemplate().toString();
+        this.generateTemplate().toString();
       this.emit('update', {message: this.status});
-    } else{
-      throw new Error("Mode is incorrect");
+    } else {
+      throw new Error('Mode is incorrect');
     }
     this.stepNum += 1;
     console.log('sink sampling rate');
@@ -593,7 +600,6 @@ class Combination extends AudioCalibrator {
     console.log(this.sourceSamplingRate);
   };
 
-
   /** .
    * .
    * .
@@ -602,7 +608,6 @@ class Combination extends AudioCalibrator {
    * @example
    */
   #stopCalibrationAudio = () => {
-
     this.calibrationNodes[0].stop(0);
     this.calibrationNodes = [];
     this.sourceNode.disconnect();
@@ -628,7 +633,7 @@ class Combination extends AudioCalibrator {
       this.#awaitDesiredMLSLength, // during record
       this.#afterMLSwIIRRecord, // after record
       this.mode
-    )
+    );
   };
 
   /**
@@ -641,11 +646,9 @@ class Combination extends AudioCalibrator {
    * @example
    */
   startCalibrationImpulseResponse = async stream => {
-
     let desired_time = this.desired_time_per_mls;
 
-    console.log("MLS sequence should be of length: " + (this.sourceSamplingRate * desired_time));
-
+    console.log('MLS sequence should be of length: ' + this.sourceSamplingRate * desired_time);
 
     length = this.sourceSamplingRate * desired_time;
     //get mls here
@@ -669,8 +672,7 @@ class Combination extends AudioCalibrator {
       this.#afterMLSRecord, // after record
       this.mode
     ),
-
-    this.#stopCalibrationAudio();
+      this.#stopCalibrationAudio();
 
     // at this stage we've captured all the required signals,
     // and have received IRs for each one
@@ -684,7 +686,7 @@ class Combination extends AudioCalibrator {
     if (this._calibrateSoundCheck != 'none') {
       if (this._calibrateSoundCheck != 'system') {
         this.#currentConvolution = this.componentConvolution;
-      }else{
+      } else {
         this.#currentConvolution = this.systemConvolution;
       }
       await this.playMLSwithIIR(stream, this.invertedImpulseResponse);
@@ -773,6 +775,9 @@ class Combination extends AudioCalibrator {
         saveToCSV(this.systemConvolution, 'python_system_convolution_mls_iir.csv');
         saveToCSV(this.componentInvertedImpulseResponse, 'componentIIR.csv');
         saveToCSV(this.systemInvertedImpulseResponse, 'systemIIR.csv');
+        for (let i = 0; i < this.autocorrelations.length; i++){
+          saveToCSV(this.autocorrelations[i],`autocorrelation_${i}`);
+        }
         const computedIRagain = await Promise.all(this.impulseResponses).then(res => {
           for (let i = 0; i < res.length; i++) {
             if (res[i] != undefined) {
@@ -798,6 +803,9 @@ class Combination extends AudioCalibrator {
         saveToCSV(this.systemConvolution, 'python_system_convolution_mls_iir.csv');
         saveToCSV(this.componentInvertedImpulseResponse, 'componentIIR.csv');
         saveToCSV(this.systemInvertedImpulseResponse, 'systemIIR.csv');
+        for (let i = 0; i < this.autocorrelations.length; i++){
+          saveToCSV(this.autocorrelations[i],`autocorrelation_${i}`);
+        }
         const computedIRagain = await Promise.all(this.impulseResponses).then(res => {
           for (let i = 0; i < res.length; i++) {
             if (res[i] != undefined) {
@@ -841,8 +849,8 @@ class Combination extends AudioCalibrator {
       j += 1 / this.sourceSamplingRate;
     }
     return curve;
-    };
-    
+  };
+
   #getTruncatedSignal = (left = 3.5, right = 4.5) => {
     const start = Math.floor(left * this.sourceSamplingRate);
     const end = Math.floor(right * this.sourceSamplingRate);
@@ -1141,7 +1149,11 @@ class Combination extends AudioCalibrator {
     _calibrateSoundBurstRepeats = 4,
     _calibrateSoundBurstSec = 1,
     _calibrateSoundBurstsWarmup = 1,
-    _calibrateSoundHz = 48000
+    _calibrateSoundHz = 48000,
+    micManufacturer = '',
+    micSerialNumber = '',
+    micModelNumber = '',
+    micModelName = ''
   ) => {
     this.numMLSPerCapture = _calibrateSoundBurstRepeats;
     this.desired_time_per_mls = _calibrateSoundBurstSec;