Skip to content

MichielfromNL/SoundAnalyzer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sound Analyzer

When I was working on a Machine Learning sketch on ESP32 to detect sounds I found that there is suprisingly little easy-to-use Arduino/ESP software for analyzing signals. I needed accurate decibel-SPL measurement, FFT, MFCC's and spectrum features such as crest, rolloff, kurtosis etc, plus Shazam-style fingerprints. The dBSPL requires accurate mvolts AC sampling, the other features require fast FFT and a spectrum analyzer. All of these must be suitable for embedded applications: i.e. robust, little or no dependencies on non-Arduino s/w , Arduino-style c++, and no dynamic memory other than for class constructors / initialization.

For collecting AC signals I created ESP32Sampler class, a wrapper around Audiotools streams. which gets a bunch of 16-bits ADC values in pretty accurate millivolts with 0 CPU. Then I found a very fast FFT in C and adapted / wrapped it to ESPFFT.

For the next stage I found Adam Starks GIST library, and some Java snippets for making Shazam fingerprints for analysis. SoundAnalyzer wraps and optimizes those in a single Arduino class. With just a few methods the requested characteristics: MFCC, Shazam , Yin , FFT and other features are returned as simple static output arrays.

With these three classes making a ML sound analyzer is now pretty straightforward:

  1. Get Samples using ESP32Sampler
  2. Process the signal using SoundAnalyzer
  3. Put relevant features: MFFC, Fingerprints, Yin or spectrum features in an array
  4. Call a Classifier.predict(array) function (from eloquentML) , to get a match on the signal

Extra note: With sound processing and ML, sampling, an important thing is to use RTOS, so that you can put a sampler task on a separate core. Believe me: RTOS is awesome, and very much needed in systems that process lots of data.

Installation

Details

The class has 2 sets of procedures: 3 for the time domain (Pitch , Rms and dbSPL), and 4 + for the frequency domain : FFT, MFCC, Signature and spectrum features. Imput is the signal array. The class optimizes the frequency domain steps, just one FFT operation is required, there is no dynamic memory after config and there are as little loops as possible so it is very fast.

dBSPL

For Decibel sound Pressure Level measurements (dBSPL), commonly known as Sound decibels, you need samples in accurate mvolts and you need to know the sensitivity and gain of the input micro (breakout). This is why you need ESP32Sampler Which calibrates and returns an aray with mV vaues. You can find the microphone sensitivity in the spec sheet of the microphone/ breakout board. The gain level is the dB amplification introduced by the circuit between microphone and GPIO pin. For example the Max4466 has a potmeter to control gain, so the only way to find out what that level is, is by measuring DDB's and comparing to the actual DB with a sound meter on your mobile phone. this thread explains how that works but I'm afraid that it still requires some basic knowledge of signal processing and what Decibels / dBSPL are to know why this works so easy.

To get the frequency domain features you first have to perform the FFT on the signal, then call the relevant functions to get what you need. Each function returns an array (pointer). The getFeatures method returns spectrum features: peak frequency, peak magnitude, average magnitude, crest, spread, flatness, rolloff, kurtosis, skewness and centroid. To get a specific feature from the array there is an enum list that can be used as an index. There also is a list of tags, 'FeatureNames', the index is the const char * with the name of the tag, usefull if you want to push features to Json or csv for feature analysis in python for ML. MFCC returns an array with the Mel Frequency Cepstral Coeffients, an extremely efficient feature for speech regocnition. getSignature returns a fingerprint array and hash with peak frequencies in a logarithmic set of frequency-bands, which is perfect for recognizing a specific sound or piece of music. The algorithm, which is similar to what Shazam does, is pretty usefull to classify / identify specific music / sound parts. See these posts (https://www.toptal.com/algorithms/shazam-it-music-processing-fingerprinting-and-recognition) and (https://www.royvanrijn.com/blog/2010/06/creating-shazam-in-java/) which describe how it works. The basics are published and common knowledge but the entire shazam algorithm is patented, just so you know.

The Sizes of the returned arrays are both config parameters and class members, so that you don't have to 'remember' those after config init

The whole thing is very fast. The combined FFT and features collection take no more than 20 msecs for 1024 samples. If you sample 1024 at reasonable frequencies such as 8192 (44100 is not needed for sound recognition) that gives you plenty time to do the FFT and e.g MFCC, and even do ML classification, Then pass the results on to the next task (on the other ESp32 core) via an RTOS queue for Web stuff. That's what I do and it works very well.

Example use

/*

Example: collect samples from a connected Mic, process and print results

*/

#include <Arduino.h>
#include "ESP32Sampler.h"  // included for completeness
#include "SoundAnalyzer.h"

typedef sample_t int16_t;
sample_t Samples[1024];  // the collect buffer

using namespace SoundAnalyzer;
Analyzer<sample_t> Processor;

// connect analogue breakout e.g MAX 4466 to pin 34
const gpio_num_t micPin = GPIO_NUM_34;

void setup() {
// Get the default config and set parameters
  Serial.begin(115200);

  // configure the sampler
  SamplerConfig SConfig = Sampler.defaultConfig();
  // 8192 Hz at GPIO34 (default), 1024 sample (default), AC mode, 4 x sampling to reduce noise  
  SConfig.samplefrequency = 8192;
  SConfig.pin = micPin;
  SConfig.mode = SMODE_AC;
  SConfig.multisample = 4;
  Sampler.setConfig(SConfig);

  // configure the analyzer
  AnalyzerConfig PConfig = Processor.defaultConfig();

  // 8192 Hz, 512 bytes FFT, MAx466 mic = 5.012 mvs, gain approx 75 DbSPL (needs calibration)
  // 13 MFCC's,  6 ranges for Shamzam signatures
  PConfig.samplefreq = 8192;
  PConfig.gain = 75;
  PConfig.sensitivity = 5.012;
  Processor.setConfig(PConfig);

  Sampler.Begin();
}

void loop() {

  // We collect more samples than needed for the FFT signal, because standard Decibel measurement
  // requires a specific duration (there is even even an ISO standard for that)
  //  But of course there are plenty other methods to collect equially spaced signal data
  //
  Sampler.Collect(Samples, 1024);
  
  // SPL only works if your samples are mvolts, and you know the sensitivity and gain of the micro (breakout)
  decibel_t dB = Processor.decibelSPL(Samples,1024);

  // Yin (Pitch) is a timedomain feature
  float Yin = Processor.getPitch(Samples);

  // Now Make a spectrum by processing the samples. True = to remove DC
  // Then create features, MFCC, Signature, depending on what we need
  // either use the local array, or use the cached data in the class
  // the audiofeature enums are usd to find the feature in the array
  //
  Processor.doFft(Samples,true);
  float * Features  = Processor.getFeatures();
  float * Mfccs     = Processor.getMfcc();
  signature_t * Signature = Processor.getSignature();

  Serial.printf("dBSpl %d, Pitch %0f, % %.2f, Crest %.2f, Rolloff %.2f etc etc\n", 
            dB, Yin, Features[Fpeakfreq], Features[Fcrest], Features[Frolloff]);

  Serial.print("Mfccs: ");
  for (size_t i=0; i<Processor.NumMfccCoeff; i++) {
    Serial.printf("%.2f%s",Processor.Mfccs[i],i<Processor.NumMfccCoeff ? ",": "");
  }
  Serial.println();
  
  Serial.printf("Signature: ");
  for (size_t i=0; i<Processor.SignatureLen; i++) {
    Serial.printf("%d%s",Signature[i],i<Processor.SignatureLen ? ",": "");
  }
  Serial.printf("\nSignaturehash = %ul\n", Processor.getSignatureHash());

}

In another example I will xplain how I use this stuff to classify sound types, with ML from this guy EloquentML . It is pretty easy: the Arduino requires just 2 lines of code. The preparation and feature selection is another story though

Have fun!

About

Arduino / ESP Sound Analyzer

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published