Merge pull request #15 from nipunaw/sprint-3

Compiling software changes from Sprint 3

Author: Carlos-Morales-Diaz

README.md

@@ -30,21 +30,21 @@ The HDL is synthesized by the Vivado 2021.1 build system. It has not been tested
 3. Double click on "Generate Bitstream" to generate the bitstream for the Arty A7-35 (xc7a35ticsg324-1L) FPGA, which is preconfigured. Other devices may be selected, however neither performance nor compatibility are guaranteed.
 
 The default pinout, which can also be found in the constraint file, is:
-clk - E3
-rst - C2
-sampleIn[0:7] -  D4,  D3,  F4,  F3,  E2,  D2,  H2,  G2
-sampleOut[0:7] - G13, B11, A11, D12, D13, B18, A18, K16
+- clk - E3
+- rst - C2
+- sampleIn[0:7] -  D4,  D3,  F4,  F3,  E2,  D2,  H2,  G2
+- sampleOut[0:7] - G13, B11, A11, D12, D13, B18, A18, K16
 
 For status of the filter on the Arty A7 devboard, it outputs to a status LED:
-filterActive - H5
+- filterActive - H5
 
 The switch on the devboard enables the filter
-filterEn - A8
+- filterEn - A8
 
 
 The pins for the TLC0820:
-extCS - E15
-extRD - E16
-extReady - D15
+- extCS - E15
+- extRD - E16
+- extReady - D15
 
 The MX7224 is held in transparent mode

package-lock.json

@@ -6,22 +6,27 @@
   "dependencies": {
     "@joe_six/duarte-watanabe-peak-detection": "^0.2.0",
     "@joe_six/smoothed-z-score-peak-signal-detection": "^0.1.2",
+    "@reduxjs/toolkit": "^1.7.2",
     "@testing-library/jest-dom": "^5.11.4",
     "@testing-library/react": "^11.1.0",
     "@testing-library/user-event": "^12.1.10",
     "@types/jest": "^27.4.0",
     "@types/node": "^17.0.10",
     "@types/react": "^17.0.38",
+    "@types/react-redux": "^7.1.22",
     "bootstrap": "^5.1.3",
+    "decibels": "^2.0.0",
     "fft-js": "^0.0.12",
     "fft-windowing": "^0.1.4",
     "fili": "^2.0.3",
+    "fourier-transform": "^1.1.2",
     "nodeplotlib": "^1.0.0",
     "pitchfinder": "^2.3.2",
     "python-shell": "^3.0.1",
     "react": "^17.0.2",
     "react-bootstrap": "^2.0.3",
     "react-dom": "^17.0.2",
+    "react-redux": "^7.2.6",
     "typescript": "^4.5.4",
     "wav-decoder": "^1.3.0",
     "web-vitals": "^1.0.1"
@@ -66,6 +71,7 @@
     "@types/react-dom": "^17.0.11",
     "electron": "^16.0.7",
     "electron-builder": "^22.14.5",
+    "electron-devtools-installer": "^3.2.0",
     "react-scripts": "^4.0.3"
   },
   "build": {

package.json

@@ -1,4 +1,7 @@
-// Generics
+const {
+  default: installExtension,
+  REDUX_DEVTOOLS,
+} = require("electron-devtools-installer");
 const { app, BrowserWindow, Menu, ipcMain } = require("electron");
 const fs = require("fs");
 const { resolve } = require("path");
@@ -17,7 +20,7 @@ function createWindow() {
     },
   });
 
-  //load the index.html from a url
+  // Load the index.html from a url
   win.loadURL("http://localhost:3000");
 
   // Open the DevTools.
@@ -60,24 +63,24 @@ function createWindow() {
     }
   );
 
-
-  ipcMain.on("process-audio", (event, rawRecordedData, sampleRate) => {
-    //Pitch method is deprecated
+  ipcMain.on("process-audio", (event, rawRecordedData, sampleRate, fftData) => {
     try {
-      const pitch = GetPitchValue(rawRecordedData);
-      const noiseTaps = fftAnalysis(rawRecordedData, sampleRate);
+      //Pitch method is deprecated
+      //const pitch = GetPitchValue(rawRecordedData);
+      const noiseTaps = fftAnalysis(rawRecordedData, sampleRate, fftData);
 
       win.webContents.send(
         "audio-finished",
         true,
-        `Sent information over UART if connected`,
+        `No errors occured while processing!`,
         noiseTaps
       );
-    } catch {
+    } catch (e) {
+      console.log(e);
       win.webContents.send(
         "audio-finished",
         false,
-        `An error has occured.`,
+        `An error has occured while processing.`,
         []
       );
     }
@@ -99,10 +102,12 @@ function readFile(filepath, mimeType) {
   });
 }
 
-// This method will be called when Electron has finished
-// initialization and is ready to create browser windows.
-// Some APIs can only be used after this event occurs.
-app.whenReady().then(createWindow);
+app.whenReady().then(() => {
+  installExtension(REDUX_DEVTOOLS)
+    .then((name) => console.log(`Added Extension:  ${name}`))
+    .catch((err) => console.log("An error occurred: ", err));
+  createWindow();
+});
 
 // Quit when all windows are closed, except on macOS. There, it's common
 // for applications and their menu bar to stay active until the user quits

public/main.js

@@ -5,32 +5,46 @@ const fft = require('fft-js').fft;
 const fftUtil = require('fft-js').util;
 const windowing = require('fft-windowing');
 const Fili = require('fili');
+var ft = require('fourier-transform');
+var db = require('decibels');
 // Smoothing and Plots
 const smoothed_z_score = require("@joe_six/smoothed-z-score-peak-signal-detection");
 const detect_peaks = require("@joe_six/duarte-watanabe-peak-detection")
-const { plot, Plot } = require("nodeplotlib");
+const { plot, Plot} = require("nodeplotlib");
 
-const fftAnalysis = (rawRecordedData, sampleRate) => {
-  var windowedRecordedData = windowing.hann(rawRecordedData);
-  var phasors = fft(windowedRecordedData.slice(0, 262144)); // 48000 > samples 
-  var frequencies = fftUtil.fftFreq(phasors, sampleRate); // Sample rate and coef is just used for length, and frequency step
-  var magnitudes = fftUtil.fftMag(phasors);
+const fftAnalysis = (rawData, sampleRate, fftData) => {
+  let N = 32768;
+  let win = windowing.hann(rawData.slice(0, N), N); //rawData.slice(0, N), 
+  let spectrum = fft(win); // 48000 > samples 
+  let frequencies = fftUtil.fftFreq(spectrum, sampleRate); // Sample rate and coef is just used for length, and frequency step
+  let magnitudes = fftUtil.fftMag(spectrum);
+  let spectrum2 = ft(rawData.slice(0, N));
+  let decibels = spectrum2.map((value) => db.fromGain(value))
 
+  console.log("##### META-DATA ON FFT-JS #####");
   console.log("Sample Rate: " + sampleRate);
-  console.log("Length of raw data: " + rawRecordedData.length);
-  console.log("Length of windowed data: " + windowedRecordedData.length);
-  console.log("Length of phasors: " + phasors.length);
+  console.log("Length of raw data: " + rawData.length);
+  console.log("Length of windowed data: " + win.length);
+  console.log("Length of phasors: " + spectrum.length);
   console.log("Length of frequencies: " + frequencies.length);
   console.log("Length of magnitudes: " + magnitudes.length);
   console.log("");
+
+  let fftFreq = new Float32Array(fftData.length);
+  for (let i = 0; i < fftData.length; i++) {
+    fftFreq[i] = i*((sampleRate/2)/(fftData.length));
+  }
+  
+  graphFrequencySpectrum(fftFreq, fftData, {title: "AnalyserNode Frequency Spectrum"}); //{"logFreq": true}
+  graphFrequencySpectrum(frequencies, magnitudes, {title: "FFT-JS Frequency Spectrum"}); //{"scaleMagnitude": true, "logFreq": true}
+  graphFrequencySpectrum(frequencies, decibels, {title: "FFT-ASM Frequency Spectrum"});
   return firFilterTaps(frequencies, magnitudes, sampleRate);
 }
 
 const firFilterTaps = (frequencies, magnitudes, sampleRate) => {
   // TO-DO: Continue testing smoothing methods, for now electing Watanabe method
   //const peaksSmoothed = smoothed_z_score(magnitudes, {lag: 40, threshold: 4.5, influence: 0.2});
-  
-  const noiseTaps = noiseRemoval(frequencies, magnitudes, 101, sampleRate);
+  const noiseTaps = noiseRemoval(frequencies, magnitudes, 101, sampleRate, 150);
   return noiseTaps;
 }
 
@@ -41,25 +55,58 @@ const identifyPeaks = (magnitudes, mpdVal) => {
 }
 
 // Helper function for graphing/testing
-const graphFrequencies= (frequencies, magnitudes, logScale, plotType) => {
-  let logFrequencies = [];
-  if (logScale == true) {
-    for (let i = 0; i < frequencies.length; i++) {
-      logFrequencies.push(Math.log10(frequencies[i]));
+const graphFrequencySpectrum=(frequencies, magnitudes, params={}) => {
+  
+  if (frequencies.length != magnitudes.length) {
+    console.log("Frequency bins length mismatches magnitude length")
+    return
+  }
+
+  let length = frequencies.length;
+  let xaxisType = params["logFreq"] || "log";
+  let scaleMagnitude = params["scaleMagnitude"] || false;
+  let fftSize = params["fftSize"] || 32768;
+  let title = params["title"] || "Frequency Spectrum";
+  let plotType = 'scatter';
+
+  let graphFrequencies = new Array(length);
+  let graphMagnitudes = new Array(length);
+
+
+  for (let i = 0; i < length; i++) {
+    graphFrequencies[i] = frequencies[i];
+  }
+  
+  if (scaleMagnitude == true) {
+    for (let i = 0; i < length; i++) {
+      graphMagnitudes[i] = 20*Math.log10(2*magnitudes[i]/fftSize);
     }
   } else {
-    logFrequencies = frequencies;
+    for (let i = 0; i < length; i++) {
+      graphMagnitudes[i] = magnitudes[i];
+    }
   }
 
   const data = [
     {
-      x: logFrequencies,
-      y: magnitudes,
+      x: graphFrequencies,
+      y: graphMagnitudes,
       type: plotType
-    },
+    }
   ];
+
+  const layout = {
+    title: title,
+    xaxis: {
+      title: "Frequency [Hz]",
+      type: xaxisType
+    },
+    yaxis: {
+      title: "Magnitude [dBFS]"
+    }
+  };
 
-  plot(data);
+  plot(data, layout);
 }
 
 const bandstopTaps = (filterOrder, sampleRate, lowerFreq, upperFreq, attenuation) => {
@@ -74,30 +121,34 @@ const bandstopTaps = (filterOrder, sampleRate, lowerFreq, upperFreq, attenuation
   return firFilterCoeffsK;
 }
 
-const noiseRemoval = (frequencies, magnitudes, filterOrder, sampleRate) => {
+const noiseRemoval = (frequencies, magnitudes, filterOrder, sampleRate, limit) => {
   const peaksWatanabeIndices = identifyPeaks(magnitudes, 50);
-  let noisyFrequencies = [];
+  let strongLowerFreq = [];
   for (let i = 0; i < peaksWatanabeIndices.length; i++) {
-    if (frequencies[peaksWatanabeIndices[i]] < 80) {
-      noisyFrequencies.push(Math.round(frequencies[peaksWatanabeIndices[i]]));
+    if (frequencies[peaksWatanabeIndices[i]] < limit) {
+      strongLowerFreq.push(Math.round(frequencies[peaksWatanabeIndices[i]]));
     }
   }
 
 
   let bands = [];
-  for (let i = 0; i < noisyFrequencies.length; i++) {
-    if (noisyFrequencies[i] > 5) {
-      bands.push(bandstopTaps(filterOrder, sampleRate, noisyFrequencies[i]-5, noisyFrequencies[i]+5, 5)); //Attenuate by 5 dB, order of 101
+  for (let i = 0; i < strongLowerFreq.length; i++) {
+    if (strongLowerFreq[i] > 5) { //Greater than 5Hz
+      bands.push(bandstopTaps(filterOrder, sampleRate, strongLowerFreq[i]-5, strongLowerFreq[i]+5, 5)); //Attenuate by 5 dB, order of 101
     } else {
-      bands.push(bandstopTaps(filterOrder, sampleRate, 0, noisyFrequencies[i]+5, 5)); //Attenuate by 5 dB, order of 101
+      bands.push(bandstopTaps(filterOrder, sampleRate, 0, strongLowerFreq[i]+5, 5)); //Attenuate by 5 dB, order of 101
     }
   }
 
-  // Safely assume independence of bands
-  var sum = (r, a) => r.map((b, i) => a[i] + b);
-  let noisyTaps = bands.reduce(sum);
-
-  return noisyTaps;
+  console.log(strongLowerFreq);
+  if (bands.length > 0) {
+    // Safely assume independence of bands
+    var sum = (r, a) => r.map((b, i) => a[i] + b);
+    let noisyTaps = bands.reduce(sum);
+    return noisyTaps;
+  }
+  return [];
+  
 }
 
 const generalAnalysis = (frequencies, magnitudes) => {

public/main/audioProcess.js

@@ -1,32 +1,27 @@
-import { useState } from "react";
-import "../css/MainContent.css";
-// import MainContent from "./MainContent";
-import AudioRecord from "./AudioRecord";
-import NoiseInfoPrompt from "./NoiseInfoPrompt";
-// const electron = window.require("electron");
-
-enum ContentState {
-  NoiseInfo,
-  NoiseRecording,
-}
+import "css/MainContent.css";
+import AudioRecord from "./calibrate/AudioRecord";
+import NoiseInfoPrompt from "./calibrate/NoiseInfoPrompt";
+import { useAppSelector } from "hooks";
+import { selectCalibrate } from "reducers/calibrateSlice";
+import DeviceConfigure from "./calibrate/DeviceConfigure";
+import { Calibrate } from "enums/calibrate";
+import Process from "./calibrate/Process";
 
 export default function ContentContainer() {
-  const [state, setState] = useState(ContentState.NoiseInfo);
-
-  const stateHandler = () => {
-    switch (state) {
-      case ContentState.NoiseInfo: {
-        setState(ContentState.NoiseRecording);
-      }
-    }
-  };
+  const { currentState: calibrateState } = useAppSelector(selectCalibrate);
 
-  const getContent = (): JSX.Element => {
-    switch (state) {
-      case ContentState.NoiseInfo:
-        return <NoiseInfoPrompt advanceState={stateHandler} />;
-      case ContentState.NoiseRecording:
-        return <AudioRecord />;
+  const getContent = (): JSX.Element | null => {
+    switch (calibrateState) {
+      case Calibrate.initalMenu:
+        return null;
+      case Calibrate.deviceConfig:
+        return <DeviceConfigure />;
+      case Calibrate.prompt1:
+        return <NoiseInfoPrompt />;
+      case Calibrate.audioTest1:
+        return <AudioRecord key={1} />;
+      case Calibrate.process:
+        return <Process />;
     }
   };