speaker-calibration 2.2.198 → 2.2.200

package/src/tasks/volume/volume.js

@@ -1,279 +1,279 @@
-import AudioCalibrator from '../audioCalibrator';
-import axios from 'axios';
-import {sleep} from '../../utils';
-
-/**
- *
- */
-class Volume extends AudioCalibrator {
-  /**
-   *
-   * @param root0
-   * @param root0.download
-   * @param root0.numCalibrationRounds
-   * @param root0.numCalibrationNodes
-   * @example
-   */
-
-  /** @private */
-  #CALIBRATION_TONE_FREQUENCY = 1000; // Hz
-
-  /** @private */
-  #CALIBRATION_TONE_TYPE = 'sine';
-
-  /** @private */
-  #CALIBRATION_TONE_DURATION = 5; // seconds
-
-  /** @private */
-  outDBSPL = null;
-  THD = null;
-  outDBSPL1000 = null;
-
-  /** @private */
-  TAPER_SECS = 0.010; // seconds
-
-  /** @private */
-  status_denominator = 2; 
-
-  /** @private */
-  status_numerator = 0; 
-
-  /** @private */
-  percent_complete = 0; 
-
-  /** @private */
-  status = ``;
-
-  /**generate string template that gets reevaluated as variable increases */
-  generateTemplate = () => {
-    if (this.percent_complete > 100){
-      this.percent_complete = 100;
-    }
-    const template = `<div style="display: flex; justify-content: center;"><div style="width: 200px; height: 20px; border: 2px solid #000; border-radius: 10px;"><div style="width: ${this.percent_complete}%; height: 100%; background-color: #00aaff; border-radius: 8px;"></div></div></div>`;
-    return template;
-  }
-
-  /** increment numerator and percent for status bar */
-  incrementStatusBar = () => {
-    this.status_numerator += 1;
-    this.percent_complete = (this.status_numerator/this.status_denominator)*100;
-  }
-
-  handleIncomingData = data => {
-    console.log('Received data: ', data);
-    if (data.type === 'soundGainDBSPL') {
-      this.soundGainDBSPL = data.value;
-    } else {
-      throw new Error(`Unknown data type: ${data.type}`);
-    }
-  };
-
-  createSCurveBuffer = (onSetBool=true) => {
-
-    const curve = new Float32Array(this.TAPER_SECS*this.sourceSamplingRate+1);
-    const frequency = 1 / (4 * this.TAPER_SECS);
-    let j = 0;
-    for (let i = 0; i < this.TAPER_SECS*this.sourceSamplingRate+1; i += 1) {
-      const phase = 2 * Math.PI * frequency * j;
-      const onsetTaper = Math.pow(Math.sin(phase) , 2);
-      const offsetTaper = Math.pow(Math.cos(phase) , 2);
-      curve[i] = onSetBool? onsetTaper : offsetTaper;
-      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);
-    const result = Array.from(this.getLastRecordedSignal().slice(start, end));
-
-    /**
-     * function to check that capture was properly made
-     * @param {*} list
-     */
-    const checkResult = list => {
-      const setItem = new Set(list);
-      if (setItem.size === 1 && setItem.has(0)) {
-        console.warn(
-          'The last capture failed, all recorded signal is zero',
-          this.getAllRecordedSignals()
-        );
-      }
-      if (setItem.size === 0) {
-        console.warn('The last capture failed, no recorded signal');
-      }
-    };
-    checkResult(result);
-    return result;
-  };
-
-  /** 
-   * 
-   * 
-    Construct a calibration Node with the calibration parameters and given gain value
-   * @param {*} gainValue
-   * */
-  #createCalibrationToneWithGainValue = gainValue => {
-    const audioContext = this.makeNewSourceAudioContext();
-    const oscilator = audioContext.createOscillator();
-    const gainNode = audioContext.createGain();
-    const taperGainNode = audioContext.createGain();
-    const offsetGainNode = audioContext.createGain();
-    const totalDuration = this.#CALIBRATION_TONE_DURATION * 1.2;
-
-    oscilator.frequency.value = this.#CALIBRATION_TONE_FREQUENCY;
-    oscilator.type = this.#CALIBRATION_TONE_TYPE;
-    gainNode.gain.value = gainValue;
-
-    oscilator.connect(gainNode);
-    gainNode.connect(taperGainNode);
-    const onsetCurve = this.createSCurveBuffer();
-    taperGainNode.gain.setValueCurveAtTime(onsetCurve, 0, this.TAPER_SECS);
-    taperGainNode.connect(offsetGainNode);
-    const offsetCurve = this.createSCurveBuffer(false);
-    offsetGainNode.gain.setValueCurveAtTime(offsetCurve, (totalDuration-this.TAPER_SECS), this.TAPER_SECS);
-    offsetGainNode.connect(audioContext.destination);
-
-    this.addCalibrationNode(oscilator);
-  };
-
-  /**
-   * Construct a Calibration Node with the calibration parameters.
-   *
-   * @private
-   * @example
-   */
-  #createCalibrationNode = () => {
-    const audioContext = this.makeNewSourceAudioContext();
-    const oscilator = audioContext.createOscillator();
-    const gainNode = audioContext.createGain();
-
-    oscilator.frequency.value = this.#CALIBRATION_TONE_FREQUENCY;
-    oscilator.type = this.#CALIBRATION_TONE_TYPE;
-    gainNode.gain.value = 0.04;
-
-    oscilator.connect(gainNode);
-    gainNode.connect(audioContext.destination);
-
-    this.addCalibrationNode(oscilator);
-  };
-
-  #playCalibrationAudio = async () => {
-    const totalDuration = this.#CALIBRATION_TONE_DURATION * 1.2;
-
-    this.calibrationNodes[0].start(0);
-    this.calibrationNodes[0].stop(totalDuration);
-    console.log(`Playing a buffer of ${this.#CALIBRATION_TONE_DURATION} seconds of audio`);
-    console.log(`Waiting a total of ${totalDuration} seconds`);
-    await sleep(totalDuration);
-  };
-
-  #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.incrementStatusBar();
-          this.outDBSPL = res['outDbSPL'];
-          this.outDBSPL1000 = res['outDbSPL1000'];
-          this.THD = res['thd'];
-        }
-      })
-      .catch(err => {
-        console.warn(err);
-      });
-  };
-
-  startCalibration = async (stream, gainValues, lCalib = 104.92978421490648) => {
-    const trialIterations = gainValues.length;
-    this.status_denominator += trialIterations;
-    const thdValues = [];
-    const inDBValues = [];
-    let inDB = 0;
-    const outDBSPLValues = [];
-    const outDBSPL1000Values = [];
-
-    // do one calibration that will be discarded
-    const soundLevelToDiscard = -60;
-    const gainToDiscard = Math.pow(10, soundLevelToDiscard / 20);
-    this.status = `Sound Level: ${soundLevelToDiscard} dB`.toString() + this.generateTemplate().toString();
-    this.emit('update', {message: this.status});
-    do {
-      // eslint-disable-next-line no-await-in-loop
-      await this.volumeCalibrationSteps(
-        stream,
-        this.#playCalibrationAudio,
-        this.#createCalibrationToneWithGainValue,
-        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.status = `Sound Level: ${inDB} dB`.toString() + this.generateTemplate().toString();
-      this.emit('update', {message: this.status});
-      do {
-        // eslint-disable-next-line no-await-in-loop
-        await this.volumeCalibrationSteps(
-          stream,
-          this.#playCalibrationAudio,
-          this.#createCalibrationToneWithGainValue,
-          this.#sendToServerForProcessing,
-          gainValues[i],
-          lCalib //todo make this a class parameter
-        );
-      } while (this.outDBSPL === null);
-      outDBSPL1000Values.push(this.outDBSPL1000);
-      thdValues.push(this.THD);
-      outDBSPLValues.push(this.outDBSPL);
-
-      this.outDBSPL = null;
-      this.outDBSPL1000 = null;
-      this.THD = null;
-    }
-
-    // get the volume calibration parameters from the server
-    
-    const parameters = await this.pyServerAPI
-      .getVolumeCalibrationParameters({
-        inDBValues: inDBValues,
-        outDBSPLValues: outDBSPL1000Values,
-        lCalib: lCalib,
-      })
-      .then(res => {
-        this.incrementStatusBar();
-        this.status = `done with 1000 Hz calibration`.toString() + this.generateTemplate().toString();
-        this.emit('update', {message: this.status});
-        return res;
-      });
-    const result = {
-      parameters: parameters,
-      inDBValues: inDBValues,
-      outDBSPLValues: outDBSPLValues,
-      outDBSPL1000Values: outDBSPL1000Values,
-      thdValues: thdValues,
-    };
-
-    return result;
-  };
-}
-
-export default Volume;
+import AudioCalibrator from '../audioCalibrator';
+import axios from 'axios';
+import {sleep} from '../../utils';
+
+/**
+ *
+ */
+class Volume extends AudioCalibrator {
+  /**
+   *
+   * @param root0
+   * @param root0.download
+   * @param root0.numCalibrationRounds
+   * @param root0.numCalibrationNodes
+   * @example
+   */
+
+  /** @private */
+  #CALIBRATION_TONE_FREQUENCY = 1000; // Hz
+
+  /** @private */
+  #CALIBRATION_TONE_TYPE = 'sine';
+
+  /** @private */
+  #CALIBRATION_TONE_DURATION = 5; // seconds
+
+  /** @private */
+  outDBSPL = null;
+  THD = null;
+  outDBSPL1000 = null;
+
+  /** @private */
+  TAPER_SECS = 0.010; // seconds
+
+  /** @private */
+  status_denominator = 2; 
+
+  /** @private */
+  status_numerator = 0; 
+
+  /** @private */
+  percent_complete = 0; 
+
+  /** @private */
+  status = ``;
+
+  /**generate string template that gets reevaluated as variable increases */
+  generateTemplate = () => {
+    if (this.percent_complete > 100){
+      this.percent_complete = 100;
+    }
+    const template = `<div style="display: flex; justify-content: center;"><div style="width: 200px; height: 20px; border: 2px solid #000; border-radius: 10px;"><div style="width: ${this.percent_complete}%; height: 100%; background-color: #00aaff; border-radius: 8px;"></div></div></div>`;
+    return template;
+  }
+
+  /** increment numerator and percent for status bar */
+  incrementStatusBar = () => {
+    this.status_numerator += 1;
+    this.percent_complete = (this.status_numerator/this.status_denominator)*100;
+  }
+
+  handleIncomingData = data => {
+    console.log('Received data: ', data);
+    if (data.type === 'soundGainDBSPL') {
+      this.soundGainDBSPL = data.value;
+    } else {
+      throw new Error(`Unknown data type: ${data.type}`);
+    }
+  };
+
+  createSCurveBuffer = (onSetBool=true) => {
+
+    const curve = new Float32Array(this.TAPER_SECS*this.sourceSamplingRate+1);
+    const frequency = 1 / (4 * this.TAPER_SECS);
+    let j = 0;
+    for (let i = 0; i < this.TAPER_SECS*this.sourceSamplingRate+1; i += 1) {
+      const phase = 2 * Math.PI * frequency * j;
+      const onsetTaper = Math.pow(Math.sin(phase) , 2);
+      const offsetTaper = Math.pow(Math.cos(phase) , 2);
+      curve[i] = onSetBool? onsetTaper : offsetTaper;
+      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);
+    const result = Array.from(this.getLastRecordedSignal().slice(start, end));
+
+    /**
+     * function to check that capture was properly made
+     * @param {*} list
+     */
+    const checkResult = list => {
+      const setItem = new Set(list);
+      if (setItem.size === 1 && setItem.has(0)) {
+        console.warn(
+          'The last capture failed, all recorded signal is zero',
+          this.getAllRecordedSignals()
+        );
+      }
+      if (setItem.size === 0) {
+        console.warn('The last capture failed, no recorded signal');
+      }
+    };
+    checkResult(result);
+    return result;
+  };
+
+  /** 
+   * 
+   * 
+    Construct a calibration Node with the calibration parameters and given gain value
+   * @param {*} gainValue
+   * */
+  #createCalibrationToneWithGainValue = gainValue => {
+    const audioContext = this.makeNewSourceAudioContext();
+    const oscilator = audioContext.createOscillator();
+    const gainNode = audioContext.createGain();
+    const taperGainNode = audioContext.createGain();
+    const offsetGainNode = audioContext.createGain();
+    const totalDuration = this.#CALIBRATION_TONE_DURATION * 1.2;
+
+    oscilator.frequency.value = this.#CALIBRATION_TONE_FREQUENCY;
+    oscilator.type = this.#CALIBRATION_TONE_TYPE;
+    gainNode.gain.value = gainValue;
+
+    oscilator.connect(gainNode);
+    gainNode.connect(taperGainNode);
+    const onsetCurve = this.createSCurveBuffer();
+    taperGainNode.gain.setValueCurveAtTime(onsetCurve, 0, this.TAPER_SECS);
+    taperGainNode.connect(offsetGainNode);
+    const offsetCurve = this.createSCurveBuffer(false);
+    offsetGainNode.gain.setValueCurveAtTime(offsetCurve, (totalDuration-this.TAPER_SECS), this.TAPER_SECS);
+    offsetGainNode.connect(audioContext.destination);
+
+    this.addCalibrationNode(oscilator);
+  };
+
+  /**
+   * Construct a Calibration Node with the calibration parameters.
+   *
+   * @private
+   * @example
+   */
+  #createCalibrationNode = () => {
+    const audioContext = this.makeNewSourceAudioContext();
+    const oscilator = audioContext.createOscillator();
+    const gainNode = audioContext.createGain();
+
+    oscilator.frequency.value = this.#CALIBRATION_TONE_FREQUENCY;
+    oscilator.type = this.#CALIBRATION_TONE_TYPE;
+    gainNode.gain.value = 0.04;
+
+    oscilator.connect(gainNode);
+    gainNode.connect(audioContext.destination);
+
+    this.addCalibrationNode(oscilator);
+  };
+
+  #playCalibrationAudio = async () => {
+    const totalDuration = this.#CALIBRATION_TONE_DURATION * 1.2;
+
+    this.calibrationNodes[0].start(0);
+    this.calibrationNodes[0].stop(totalDuration);
+    console.log(`Playing a buffer of ${this.#CALIBRATION_TONE_DURATION} seconds of audio`);
+    console.log(`Waiting a total of ${totalDuration} seconds`);
+    await sleep(totalDuration);
+  };
+
+  #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.incrementStatusBar();
+          this.outDBSPL = res['outDbSPL'];
+          this.outDBSPL1000 = res['outDbSPL1000'];
+          this.THD = res['thd'];
+        }
+      })
+      .catch(err => {
+        console.warn(err);
+      });
+  };
+
+  startCalibration = async (stream, gainValues, lCalib = 104.92978421490648) => {
+    const trialIterations = gainValues.length;
+    this.status_denominator += trialIterations;
+    const thdValues = [];
+    const inDBValues = [];
+    let inDB = 0;
+    const outDBSPLValues = [];
+    const outDBSPL1000Values = [];
+
+    // do one calibration that will be discarded
+    const soundLevelToDiscard = -60;
+    const gainToDiscard = Math.pow(10, soundLevelToDiscard / 20);
+    this.status = `Sound Level: ${soundLevelToDiscard} dB`.toString() + this.generateTemplate().toString();
+    this.emit('update', {message: this.status});
+    do {
+      // eslint-disable-next-line no-await-in-loop
+      await this.volumeCalibrationSteps(
+        stream,
+        this.#playCalibrationAudio,
+        this.#createCalibrationToneWithGainValue,
+        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.status = `Sound Level: ${inDB} dB`.toString() + this.generateTemplate().toString();
+      this.emit('update', {message: this.status});
+      do {
+        // eslint-disable-next-line no-await-in-loop
+        await this.volumeCalibrationSteps(
+          stream,
+          this.#playCalibrationAudio,
+          this.#createCalibrationToneWithGainValue,
+          this.#sendToServerForProcessing,
+          gainValues[i],
+          lCalib //todo make this a class parameter
+        );
+      } while (this.outDBSPL === null);
+      outDBSPL1000Values.push(this.outDBSPL1000);
+      thdValues.push(this.THD);
+      outDBSPLValues.push(this.outDBSPL);
+
+      this.outDBSPL = null;
+      this.outDBSPL1000 = null;
+      this.THD = null;
+    }
+
+    // get the volume calibration parameters from the server
+    
+    const parameters = await this.pyServerAPI
+      .getVolumeCalibrationParameters({
+        inDBValues: inDBValues,
+        outDBSPLValues: outDBSPL1000Values,
+        lCalib: lCalib,
+      })
+      .then(res => {
+        this.incrementStatusBar();
+        this.status = `done with 1000 Hz calibration`.toString() + this.generateTemplate().toString();
+        this.emit('update', {message: this.status});
+        return res;
+      });
+    const result = {
+      parameters: parameters,
+      inDBValues: inDBValues,
+      outDBSPLValues: outDBSPLValues,
+      outDBSPL1000Values: outDBSPL1000Values,
+      thdValues: thdValues,
+    };
+
+    return result;
+  };
+}
+
+export default Volume;