speaker-calibration 2.1.3 → 2.1.5

package/dist/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "easy-eyes-listener",
+  "version": "1.0.0",
+  "description": "",
+  "main": "example/server.js",
+  "directories": {
+    "example": "example"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "express": "^4.18.2"
+  }
+}

package/makefile

@@ -0,0 +1,74 @@
+##################################### UTILITIES ######################################
+COM_COLOR   = \033[0;34m
+OBJ_COLOR   = \033[0;36m
+OK_COLOR    = \033[0;32m
+ERROR_COLOR = \033[0;31m
+WARN_COLOR  = \033[0;33m
+NO_COLOR    = \033[m
+
+OK_STRING    = "[OK]"
+ERROR_STRING = "[ERROR]"
+WARN_STRING  = "[WARNING]"
+COM_STRING   = "Compiling..."
+
+define run_and_test
+printf "%b" "$(COM_COLOR)$(COM_STRING) $(OBJ_COLOR)$(@F)$(NO_COLOR)\r"; \
+$(1) 2> $@.log; \
+RESULT=$$?; \
+if [ $$RESULT -ne 0 ]; then \
+  printf "%-60b%b" "$(COM_COLOR)$(COM_STRING)$(OBJ_COLOR) $@" "$(ERROR_COLOR)$(ERROR_STRING)$(NO_COLOR)\n"   ; \
+elif [ -s $@.log ]; then \
+  printf "%-60b%b" "$(COM_COLOR)$(COM_STRING)$(OBJ_COLOR) $@" "$(WARN_COLOR)$(WARN_STRING)$(NO_COLOR)\n"   ; \
+else  \
+  printf "%-60b%b" "$(COM_COLOR)$(COM_STRING)$(OBJ_COLOR) $(@F)" "$(OK_COLOR)$(OK_STRING)$(NO_COLOR)\n"   ; \
+fi; \
+cat $@.log; \
+rm -f $@.log; \
+exit $$RESULT
+endef
+
+##################################### WASM ########################################
+PROJECT_NAME = mlsGen
+
+# directories
+DIST_DIR = ./dist/
+SRC_DIR = $(addprefix ./src/tasks/impulse-response/,$(PROJECT_NAME)/)
+
+# WASM files
+SRC_FILE := $(addprefix $(SRC_DIR),$(PROJECT_NAME).cpp) # SRC_DIR + PROJECT_NAME + .cpp
+OBJ_FILE := $(addprefix $(SRC_DIR),$(PROJECT_NAME).o)
+OUTPUT_WASM_JS := $(addprefix $(DIST_DIR),$(PROJECT_NAME).js) # DIST_DIR + PROJECT_NAME + .js
+OUTPUT_WASM := $(addprefix $(DIST_DIR),$(PROJECT_NAME).wasm) # DIST_DIR + PROJECT_NAME + .wasm
+OUTPUT := $(addprefix $(DIST_DIR),$(PROJECT_NAME).*) # DIST_DIR + PROJECT_NAME + .*
+
+# emcc compiler options
+EMCC = em++ # emcc compiler front end
+STD = --std=c++17 # C++ standard
+OPTIMIZE = -O3 # Optimization level O0 ~ 28.8 kB, O1 ~ 20.3 kB, O2 ~ 20.3 kB, O3 ~ 19.7 kB
+ENV = -s ENVIRONMENT='web' # environment
+NOENTRY = --no-entry # no entry point (no main function)
+MODULARIZE = -s MODULARIZE=1 -s 'EXPORT_NAME="createMLSGenModule"' # puts all of the generated JavaScript into a factory function
+BIND = -lembind # links against embind library
+MEMORY_CHECKS = -s ASSERTIONS=1 -fsanitize=address -g2 
+
+# gcc compiler options
+GCC = gcc # gcc compiler front end
+
+# KISSFFT Library
+KISS_LIB= /Users/hugo/Desktop/dev/easyeyes/speaker-calibration/src/tasks/impulse-response/kissfft/libkissfft-float.a
+KISS_H= -I /Users/hugo/Desktop/dev/easyeyes/speaker-calibration/src/tasks/impulse-response/kissfft/
+
+# build the WASM + JS glue module, linked with embind
+$(PROJECT_NAME)_bind: # $(OBJ_FILE)
+	@mkdir -p $(@D)
+	@$(call run_and_test, $(EMCC) $(STD) $(BIND) $(SRC_FILE) -o $(OUTPUT_WASM_JS) $(MODULARIZE) $(OPTIMIZE) $(ENV) $(MEMORY_CHECKS) $(KISS_H) $(KISS_LIB))
+
+# clean the WASM + JS files
+.PHONY: clean
+clean:
+	@mkdir -p $(@D)
+	@$(call run_and_test, rm -f $(OUTPUT))
+
+.PHONY: rebuild
+rebuild:
+	@make clean; make $(PROJECT_NAME)_bind

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "speaker-calibration",
-  "version": "2.1.3",
+  "version": "2.1.5",
   "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,10 +162,10 @@ 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";
+          linkTag.innerHTML = "Use computer's microphone to calibrate?";
           linkTag.target = '_blank';
           document.getElementById(this.targetElement).appendChild(linkTag);
         }

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 = [];
 
@@ -180,7 +181,7 @@ class AudioCalibrator extends AudioRecorder {
   setSamplingRates = samplingRate => {
     this.sinkSamplingRate = samplingRate;
     this.sourceSamplingRate = samplingRate;
-    this.emit('update', {message: `sampling at ${samplingRate}Hz...`});
+    // this.emit('update', {message: `sampling at ${samplingRate}Hz...`});
   };
 
   sampleRatesSet = () => this.sourceSamplingRate && this.sinkSamplingRate;

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,25 +135,43 @@ 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 = [];
 
+    // do one calibration that will be discarded
+    const soundLevelToDiscard = -80;
+    const gainToDiscard = Math.pow(10, soundLevelToDiscard / 20);
+    this.emit('update', {message: `Sound Level: ${soundLevelToDiscard} dB`});
+    do {
+      // eslint-disable-next-line no-await-in-loop
+      await this.volumeCalibrationSteps(
+        stream,
+        this.#playCalibrationAudio,
+        this.#createCalibrationNode,
+        this.#sendToServerForProcessing,
+        gainToDiscard,
+        lCalib //todo make this a class parameter
+      );
+    } while (this.outDBSPL === null);
+    //reset the values
+    this.outDBSPL = null;
+    this.outDBSPL = null;
+    this.outDBSPL1000 = null;
+    this.THD = null;
+
     // 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
       inDB = Math.log10(gainValues[i]) * 20;
+      // precision to 1 decimal place
+      inDB = Math.round(inDB * 10) / 10;
       inDBValues.push(inDB);
-
+      this.emit('update', {message: `Sound Level: ${inDB} dB`});
       do {
         // eslint-disable-next-line no-await-in-loop
         await this.volumeCalibrationSteps(
@@ -170,31 +179,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 +206,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;

package/.gitignore

@@ -1,78 +0,0 @@
-# Ignore files without extentions
-*
-!/**/
-!*.*
-
-# ignore all files starting with . or ~
-.*
-~*
-
-# ignore node/grunt dependency directories
-node_modules/
-
-# ignore composer vendor directory
-/vendor
-
-# ignore components loaded via Bower
-/bower_components
-
-# ignore jekyll build directory
-/_site
-
-# ignore OS generated files
-ehthumbs.db
-Thumbs.db
-
-# ignore Editor files
-*.sublime-project
-*.sublime-workspace
-*.komodoproject
-
-# ignore log files and databases
-*.log
-*.sql
-*.sqlite
-
-# ignore compiled files
-*.com
-*.class
-*.dll
-*.exe
-*.o
-*.so
-
-# ignore packaged files
-*.7z
-*.dmg
-*.gz
-*.iso
-*.jar
-*.rar
-*.tar
-*.zip
-
-# ignore private/secret files
-*.der
-*.key
-*.pem
-
-# ingnore CSV files
-*.csv
-
-# ignore library files
-kfr-master
-kissfft
-
-# --------------------------------------------------------
-# BEGIN Explictly Allowed Files (i.e. do NOT ignore these)
-# --------------------------------------------------------
-
-# track these files, if they exist
-!.gitignore
-!.editorconfig
-!.phpcs.xml.dist
-!.env.example
-!.eslintrc.json
-!.prettierrc
-!.eslintignore
-!.prettierignore