speaker-calibration 2.0.0 → 2.1.0

package/src/tasks/volume/volume.js

@@ -0,0 +1,157 @@
+import AudioCalibrator from '../audioCalibrator';
+
+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 */
+  soundGainDBSPL = null;
+
+  handleIncomingData = data => {
+    console.log('Received data: ', data);
+    if (data.type === 'soundGainDBSPL') {
+      this.soundGainDBSPL = data.value;
+    } else {
+      throw new Error(`Unknown data type: ${data.type}`);
+    }
+  };
+
+  #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();
+
+    oscilator.frequency.value = this.#CALIBRATION_TONE_FREQUENCY;
+    oscilator.type = this.#CALIBRATION_TONE_TYPE;
+    gainNode.gain.value = gainValue;
+
+    oscilator.connect(gainNode);
+    gainNode.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 = () => {
+    console.log('Sending data to server');
+    this.pyServerAPI
+      .getVolumeCalibration({
+        sampleRate: this.sourceSamplingRate,
+        payload: this.#getTruncatedSignal(),
+      })
+      .then(res => {
+        if (this.soundGainDBSPL === null) {
+          this.soundGainDBSPL = res;
+        }
+      })
+      .catch(err => {
+        console.warn(err);
+      });
+  };
+
+  startCalibration = async (stream, gainValues) => {
+    const trialIterations = gainValues.length;
+    const soundGainDBSPLValues = [];
+    // run the calibration at different gain values provided by the user
+    for (let i = 0; i < trialIterations; i++) {
+      do {
+        // console.log('Processing gain value: ', gainValues[i]);
+        // eslint-disable-next-line no-await-in-loop
+        await this.volumeCalibrationSteps(
+          stream,
+          this.#playCalibrationAudio,
+          this.#createCalibrationToneWithGainValue,
+          this.#sendToServerForProcessing,
+          gainValues[i]
+        );
+      } while (this.soundGainDBSPL === null);
+      soundGainDBSPLValues.push(this.soundGainDBSPL);
+      this.soundGainDBSPL = null;
+    }
+    // return this.soundGainDBSPL;
+    return soundGainDBSPLValues;
+  };
+}
+
+export default Volume;

package/src/utils.js

@@ -0,0 +1,55 @@
+/** .
+ * .
+ * .
+ * Utlity function to pause execution for a given time
+ *
+ * @param {number} seconds
+ * @returns {Promise}
+ * @example
+ */
+const sleep = seconds =>
+  new Promise(resolve => {
+    setTimeout(resolve, seconds * 1000);
+  });
+
+/** .
+ * .
+ * .
+ * Uiltity function to create and save a CSV file from a buffer
+ *
+ * @param {*} data
+ * @param {*} filename
+ * @example
+ */
+const saveToCSV = (data, filename = 'recordedMLSignal.csv') => {
+  // console.log(data)
+  let csvContent = 'data:text/csv;charset=utf-8,';
+
+  data.forEach((val, idx) => {
+    csvContent += `${idx},${val}\r\n`;
+  });
+  const encodedUri = encodeURI(csvContent);
+  const link = document.createElement('a');
+  link.setAttribute('href', encodedUri);
+  link.setAttribute('download', filename);
+  document.body.appendChild(link);
+  link.click();
+};
+
+/** .
+ * .
+ * .
+ * Utility function to create a buffer from a CSV file
+ *
+ * @param {*} csvString
+ * @param {*} delimiter
+ * @returns
+ * @example
+ */
+const csvToArray = (csvString, delimiter = ',') =>
+  csvString
+    .trim()
+    .split('\n')
+    .map(row => parseFloat(row.trim().split(delimiter)[1]));
+
+export {sleep, saveToCSV, csvToArray};

package/webpack.config.js

@@ -0,0 +1,37 @@
+const path = require('path');
+const {BundleAnalyzerPlugin} = require('webpack-bundle-analyzer');
+
+const config = {
+  entry: {
+    main: './src/main.js',
+  },
+  output: {
+    path: path.resolve(__dirname, 'dist'),
+    filename: '[name].js',
+    library: {
+      name: 'speakerCalibrator',
+      type: 'umd',
+    },
+  },
+  module: {
+    rules: [
+      {
+        test: /\.css$/,
+        use: ['style-loader', 'css-loader'],
+      },
+    ],
+  },
+  plugins: [],
+  resolve: {
+    fallback: {
+      path: require.resolve('path-browserify'),
+      fs: false,
+    },
+  },
+};
+
+if (process.env.WEBPACK_ANALYZE === 'true') {
+  config.plugins.push(new BundleAnalyzerPlugin());
+}
+
+module.exports = config;

package/README

@@ -1,3 +0,0 @@
-# Speaker-Calibration: Javascript Speaker Calibration Library for Auditory Testing
-
-Speaker-Calibration provides a simple API for performing speaker calibration in Javascript. The Library has minimal dependencies and is designed to be used in the browser.