Minim core
ugens
analysis
Name FFT
Description FFT stands for Fast Fourier Transform. It is an efficient way to calculate the Complex Discrete Fourier Transform. There is not much to say about this class other than the fact that when you want to analyze the spectrum of an audio buffer you will almost always use this class. One restriction of this class is that the audio buffers you want to analyze must have a length that is a power of two. If you try to construct an FFT with a timeSize that is not a power of two, an IllegalArgumentException will be thrown.

A Fourier Transform is an algorithm that transforms a signal in the time domain, such as a sample buffer, into a signal in the frequency domain, often called the spectrum. The spectrum does not represent individual frequencies, but actually represents frequency bands centered on particular frequencies. The center frequency of each band is usually expressed as a fraction of the sampling rate of the time domain signal and is equal to the index of the frequency band divided by the total number of bands. The total number of frequency bands is usually equal to the length of the time domain signal, but access is only provided to frequency bands with indices less than half the length, because they correspond to frequencies below the Nyquist frequency. In other words, given a signal of length N, there will be N/2 frequency bands in the spectrum.

As an example, if you construct an FFT with a timeSize of 1024 and and a sampleRate of 44100 Hz, then the spectrum will contain values for frequencies below 22010 Hz, which is the Nyquist frequency (half the sample rate). If you ask for the value of band number 5, this will correspond to a frequency band centered on 5/1024 * 44100 = 0.0048828125 * 44100 = 215 Hz. The width of that frequency band is equal to 2/1024, expressed as a fraction of the total bandwidth of the spectrum. The total bandwith of the spectrum is equal to the Nyquist frequency, which in this case is 22050, so the bandwidth is equal to about 50 Hz. It is not necessary for you to remember all of these relationships, though it is good to be aware of them. The function getFreq() allows you to query the spectrum with a frequency in Hz and the function getBandWidth() will return the bandwidth in Hz of each frequency band in the spectrum.

Usage

A typical usage of the FFT is to analyze a signal so that the frequency spectrum may be represented in some way, typically with vertical lines. You could do this in Processing with the following code, where audio is an AudioSource and fft is an FFT.

 fft.forward(audio.left);
 for (int i = 0; i < fft.specSize(); i++)
 {
   // draw the line for frequency band i, scaling it by 4 so we can see it a bit better
   line(i, height, i, height - fft.getBand(i) * 4);
 }
 
Windowing

Windowing is the process of shaping the audio samples before transforming them to the frequency domain. The Fourier Transform assumes the sample buffer is is a repetitive signal, if a sample buffer is not truly periodic within the measured interval sharp discontinuities may arise that can introduce spectral leakage. Spectral leakage is the speading of signal energy across multiple FFT bins. This "spreading" can drown out narrow band signals and hinder detection.

A windowing function attempts to reduce spectral leakage by attenuating the measured sample buffer at its end points to eliminate discontinuities. If you call the window() function with an appropriate WindowFunction, such as HammingWindow(), the sample buffers passed to the object for analysis will be shaped by the current window before being transformed. The result of using a window is to reduce the leakage in the spectrum somewhat.

Averages

FFT also has functions that allow you to request the creation of an average spectrum. An average spectrum is simply a spectrum with fewer bands than the full spectrum where each average band is the average of the amplitudes of some number of contiguous frequency bands in the full spectrum.

linAverages() allows you to specify the number of averages that you want and will group frequency bands into groups of equal number. So if you have a spectrum with 512 frequency bands and you ask for 64 averages, each average will span 8 bands of the full spectrum.

logAverages() will group frequency bands by octave and allows you to specify the size of the smallest octave to use (in Hz) and also how many bands to split each octave into. So you might ask for the smallest octave to be 60 Hz and to split each octave into two bands. The result is that the bandwidth of each average is different. One frequency is an octave above another when it's frequency is twice that of the lower frequency. So, 120 Hz is an octave above 60 Hz, 240 Hz is an octave above 120 Hz, and so on. When octaves are split, they are split based on Hz, so if you split the octave 60-120 Hz in half, you will get 60-90Hz and 90-120Hz. You can see how these bandwidths increase as your octave sizes grow. For instance, the last octave will always span sampleRate/4 - sampleRate/2, which in the case of audio sampled at 44100 Hz is 11025-22010 Hz. These logarithmically spaced averages are usually much more useful than the full spectrum or the linearly spaced averages because they map more directly to how humans perceive sound.

calcAvg() allows you to specify the frequency band you want an average calculated for. You might ask for 60-500Hz and this function will group together the bands from the full spectrum that fall into that range and average their amplitudes for you.

If you don't want any averages calculated, then you can call noAverages(). This will not impact your ability to use calcAvg(), it will merely prevent the object from calculating an average array every time you use forward().

Inverse Transform

FFT also supports taking the inverse transform of a spectrum. This means that a frequency spectrum will be transformed into a time domain signal and placed in a provided sample buffer. The length of the time domain signal will be timeSize() long. The set and scale functions allow you the ability to shape the spectrum already stored in the object before taking the inverse transform. You might use these to filter frequencies in a spectrum or modify it in some other way.

Examples
/**
  * This sketch demonstrates how to use an FFT to analyze
  * the audio being generated by an AudioPlayer.
  * <p>
  * FFT stands for Fast Fourier Transform, which is a 
  * method of analyzing audio that allows you to visualize 
  * the frequency content of a signal. You've seen 
  * visualizations like this before in music players 
  * and car stereos.
  * <p>
  * For more information about Minim and additional features, 
  * visit http://code.compartmental.net/minim/
  */

import ddf.minim.analysis.*;
import ddf.minim.*;

Minim       minim;
AudioPlayer jingle;
FFT         fft;

void setup()
{
  size(512, 200, P3D);
  
  minim = new Minim(this);
  
  // specify that we want the audio buffers of the AudioPlayer
  // to be 1024 samples long because our FFT needs to have 
  // a power-of-two buffer size and this is a good size.
  jingle = minim.loadFile("jingle.mp3", 1024);
  
  // loop the file indefinitely
  jingle.loop();
  
  // create an FFT object that has a time-domain buffer 
  // the same size as jingle's sample buffer
  // note that this needs to be a power of two 
  // and that it means the size of the spectrum will be half as large.
  fft = new FFT( jingle.bufferSize(), jingle.sampleRate() );
  
}

void draw()
{
  background(0);
  stroke(255);
  
  // perform a forward FFT on the samples in jingle's mix buffer,
  // which contains the mix of both the left and right channels of the file
  fft.forward( jingle.mix );
  
  for(int i = 0; i < fft.specSize(); i++)
  {
    // draw the line for frequency band i, scaling it up a bit so we can see it
    line( i, height, i, height - fft.getBand(i)*8 );
  }
}
Constructors
FFT(timeSize, sampleRate);
Parameters
timeSize   int: the length of the sample buffers you will be analyzing
sampleRate   float: the sample rate of the audio you will be analyzing
Fields
BARTLETT   A constant indicating a Bartlett window should be used on sample buffers.

BARTLETTHANN   A constant indicating a Bartlett-Hann window should be used on sample buffers.

BLACKMAN   A constant indicating a Blackman window with a default value should be used on sample buffers.

COSINE   A constant indicating a Cosine window should be used on sample buffers.

GAUSS   A constant indicating a Gauss window with a default value should be used on sample buffers.

HAMMING   A constant indicating a Hamming window should be used on sample buffers.

HANN   A constant indicating a Hann window should be used on sample buffers.

LANCZOS   A constant indicating a Lanczos window should be used on sample buffers.

NONE   A constant indicating no window should be used on sample buffers. Also referred as a Rectangular window.

TRIANGULAR   A constant indicating a Triangular window should be used on sample buffers.

Methods
avgSize ( )   Returns the number of averages currently being calculated.

calcAvg ( )   Calculate the average amplitude of the frequency band bounded by lowFreq and hiFreq, inclusive.

forward ( )   Performs a forward transform on buffer.

freqToIndex ( )   Returns the index of the frequency band that contains the requested frequency.

getAverageBandWidth ( )   Returns the bandwidth of the requested average band. Using this information and the return value of getAverageCenterFrequency you can determine the lower and upper frequency of any average band.

getAverageCenterFrequency ( )   Returns the center frequency of the ith average band.

getAvg ( )   Gets the value of the ith average.

getBand ( )   Returns the amplitude of the requested frequency band.

getBandWidth ( )   Returns the width of each frequency band in the spectrum (in Hz). It should be noted that the bandwidth of the first and last frequency bands is half as large as the value returned by this function.

getFreq ( )   Gets the amplitude of the requested frequency in the spectrum.

getSpectrumImaginary ( )   Get the Imaginary part of the Complex representation of the spectrum.

getSpectrumReal ( )   Get the Real part of the Complex representation of the spectrum.

indexToFreq ( )   Returns the middle frequency of the ith band.

inverse ( )   Performs an inverse transform of the frequency spectrum and places the result in buffer.

linAverages ( )   Sets the number of averages used when computing the spectrum and spaces the averages in a linear manner. In other words, each average band will be specSize() / numAvg bands wide.

logAverages ( )   Sets the number of averages used when computing the spectrum based on the minimum bandwidth for an octave and the number of bands per octave. For example, with audio that has a sample rate of 44100 Hz, logAverages(11, 1) will result in 12 averages, each corresponding to an octave, the first spanning 0 to 11 Hz. To ensure that each octave band is a full octave, the number of octaves is computed by dividing the Nyquist frequency by two, and then the result of that by two, and so on. This means that the actual bandwidth of the lowest octave may not be exactly the value specified.

noAverages ( )   Sets the object to not compute averages.

scaleBand ( )   Scales the amplitude of the ith frequency band by s. You can use this to shape the spectrum before using inverse().

scaleFreq ( )   Scales the amplitude of the requested frequency by a.

setBand ( )   Sets the amplitude of the ith frequency band to a. You can use this to shape the spectrum before using inverse().

setFreq ( )   Sets the amplitude of the requested frequency in the spectrum to a.

specSize ( )   Returns the size of the spectrum created by this transform. In other words, the number of frequency bands produced by this transform. This is typically equal to timeSize()/2 + 1, see above for an explanation.

timeSize ( )   Returns the length of the time domain signal expected by this transform.

window ( )   Sets the window to use on the samples before taking the forward transform. If an invalid window is asked for, an error will be reported and the current window will not be changed.

Usage Web & Application
Related