VibroSonics  v1.0.2-mozzi-implementation-613-g6cffbf4
Arduino Library for Translating Audio into Vibrations
Loading...
Searching...
No Matches
VibrosonicsAPI.h
Go to the documentation of this file.
1#ifndef VIBROSONICS_API_H
2#define VIBROSONICS_API_H
3
4// standard library includes
5#include <cmath>
6
7// external dependencies
8#include <Arduino.h>
9#include <AudioLab.h>
10#include <AudioPrism.h>
11#include <Fast4ier.h>
12
13// standard libraries
14#include <complex>
15#include <cstdint>
16
17// internal
18#include "Grain.h"
19#include "Wave.h"
20
21constexpr uint16_t WINDOW_SIZE_OVERLAP = WINDOW_SIZE << WINDOW_OVERLAP;
23
30constexpr float FREQ_RES = (float)SAMPLE_RATE / (float)WINDOW_SIZE_OVERLAP;
31
37constexpr float FREQ_WIDTH = 1.0 / FREQ_RES;
38
40public:
41 // ---- Setup ------------------------------------------------------------------
42
43 void init();
44
45 // --- FFT Input & Storage -----------------------------------------------------
46
47 // we will need more processAudioInput functionality to handle stereo input
48
50 void processAudioInput(float* output);
51
54
56 void dcRemoval();
57
59 void fftWindowing();
60
62 void complexToMagnitude();
63
65 float getMean(float* data, int dataLength);
66
68 float getMean(complex* data, int dataLength);
69
71 void noiseFloor(float* data, float threshold);
72
74 void noiseFloorCFAR(float* data, int numRefs, int numGuards, float bias);
75
76 // --- AudioLab Interactions ---------------------------------------------------
77
79 void assignWave(float freq, float amp, int channel);
80
83 void assignWaves(float* freqs, float* amps, int dataLength, int channel);
84
86 bool isAudioLabReady();
87
88 // --- Wave Manipulation -------------------------------------------------------
89
91 void mapAmplitudes(float* ampData, int dataLength, float minAmpSum = 10000,
92 float smoothFactor = 0.05);
93
96 float mapFrequencyByOctaves(float inFreq, float maxFreq);
97
100 float mapFrequencyMIDI(float inFreq, float minFreq, float maxFreq);
101
102 // --- Grains -----------------------------------------------------------------
103
105 void updateGrains();
106
109 Grain* createGrainArray(int numGrains, uint8_t channel, WaveType waveType);
110
113 Grain* createDynamicGrain(uint8_t channel, WaveType waveType, FreqEnv freqEnv, AmpEnv ampEnv, DurEnv durEnv);
114
116 void triggerGrains(Grain* grains, int numGrains, FreqEnv freqEnv, AmpEnv ampEnv, DurEnv durEnv);
117
119 FreqEnv createFreqEnv(float attackFreq, float decayFreq, float sustainFreq, float releaseFreq);
120
122 AmpEnv createAmpEnv(float attackAmp, float decayAmp, float sustainAmp, float releaseAmp);
123
125 DurEnv createDurEnv(int attackDuration, int decayDuration, int sustainDuration, int releaseDuration, float curve);
126
128 void setGrainFreqEnv(Grain* grains, int numGrains, FreqEnv freqEnv);
129
131 void setGrainAmpEnv(Grain* grains, int numGrains, AmpEnv ampEnv);
132
134 void setGrainDurEnv(Grain* grains, int numGrains, DurEnv durEnv);
135
137 void pause() { AudioLab.pauseSampling(); }
138
140 void resume() { AudioLab.resumeSampling(); }
141
142private:
143 // Fast Fourier Transform uses complex numbers
144 float vReal[WINDOW_SIZE_BY_2];
145 float hamming[WINDOW_SIZE_OVERLAP];
146 complex vData[WINDOW_SIZE_OVERLAP];
147 uint16_t rollingInputBuffer[WINDOW_SIZE_OVERLAP];
148
149 // --- AudioLab Library --------------------------------------------------------
150
151 GrainList grainList;
152};
153
154#endif // VIBROSONICS_API_H
constexpr float FREQ_RES
Frequency range of an FFT bin in Hz.
Definition VibrosonicsAPI.h:30
constexpr float FREQ_WIDTH
Duration of a window, in seconds.
Definition VibrosonicsAPI.h:37
constexpr uint16_t WINDOW_SIZE_OVERLAP
Definition VibrosonicsAPI.h:21
constexpr int WINDOW_SIZE_BY_2
Definition VibrosonicsAPI.h:22
Definition Grain.h:112
Definition Grain.h:248
Definition VibrosonicsAPI.h:39
float getMean(float *data, int dataLength)
Returns the mean of some float data.
Definition VibrosonicsAPI.cpp:91
void processAudioInput(float *output)
Perform fast fourier transform on the AudioLab input buffer.
Definition VibrosonicsAPI.cpp:23
float mapFrequencyMIDI(float inFreq, float minFreq, float maxFreq)
Maps a frequency to the haptic range by quantizing it using MIDI values.
Definition VibrosonicsAPI.cpp:288
Grain * createGrainArray(int numGrains, uint8_t channel, WaveType waveType)
Creates and returns a static array of grains on desired chanel with specified wave type.
Definition VibrosonicsAPI.cpp:314
void pause()
Stops the audio input sampling interrupt.
Definition VibrosonicsAPI.h:137
Grain * createDynamicGrain(uint8_t channel, WaveType waveType, FreqEnv freqEnv, AmpEnv ampEnv, DurEnv durEnv)
Creates and returns a single dynamic grain with the specified channel and wave type....
Definition VibrosonicsAPI.cpp:336
void complexToMagnitude()
Computes frequency magnitudes in vReal data.
Definition VibrosonicsAPI.cpp:78
void noiseFloorCFAR(float *data, int numRefs, int numGuards, float bias)
Floors data using the CFAR algorithm.
Definition VibrosonicsAPI.cpp:143
void setGrainDurEnv(Grain *grains, int numGrains, DurEnv durEnv)
Sets the duration envelope paramaters for an array of grains.
Definition VibrosonicsAPI.cpp:459
DurEnv createDurEnv(int attackDuration, int decayDuration, int sustainDuration, int releaseDuration, float curve)
Creates a duration envelope for a grain.
Definition VibrosonicsAPI.cpp:418
void triggerGrains(Grain *grains, int numGrains, FreqEnv freqEnv, AmpEnv ampEnv, DurEnv durEnv)
Updates an array of numPeaks grains sustain and release windows.
Definition VibrosonicsAPI.cpp:367
void mapAmplitudes(float *ampData, int dataLength, float minAmpSum=10000, float smoothFactor=0.05)
Maps amplitudes in some data to between 0.0-1.0 range.
Definition VibrosonicsAPI.cpp:196
void fftWindowing()
Applies windowing function to vReal data.
Definition VibrosonicsAPI.cpp:67
void assignWaves(float *freqs, float *amps, int dataLength, int channel)
Add waves to a channel from the values in the frequency and amplitude arrays.
Definition VibrosonicsAPI.cpp:256
void init()
Definition VibrosonicsAPI.cpp:11
void resume()
Resumes the audio input sample interrupt.
Definition VibrosonicsAPI.h:140
bool isAudioLabReady()
Check if a new audio window has been recorded.
Definition VibrosonicsAPI.cpp:268
void updateGrains()
Updates all grains in the globalGrainList.
Definition VibrosonicsAPI.cpp:352
void noiseFloor(float *data, float threshold)
Floors data that is below a certain threshold.
Definition VibrosonicsAPI.cpp:121
void assignWave(float freq, float amp, int channel)
Add a wave to a channel with specified frequency and amplitude.
Definition VibrosonicsAPI.cpp:240
FreqEnv createFreqEnv(float attackFreq, float decayFreq, float sustainFreq, float releaseFreq)
Creates a frequency envelope for a grain.
Definition VibrosonicsAPI.cpp:387
AmpEnv createAmpEnv(float attackAmp, float decayAmp, float sustainAmp, float releaseAmp)
Creates an amplitude envelope for a grain.
Definition VibrosonicsAPI.cpp:402
void setGrainFreqEnv(Grain *grains, int numGrains, FreqEnv freqEnv)
Sets the frequency envelope parameters for an array of grains.
Definition VibrosonicsAPI.cpp:431
void computeHammingWindow()
Pre compute hamming windows for FFT operations.
Definition VibrosonicsAPI.cpp:55
void dcRemoval()
Perform DC Removal to reduce noise in vReal.
Definition VibrosonicsAPI.cpp:47
float mapFrequencyByOctaves(float inFreq, float maxFreq)
Maps a frequency to the haptic range (0-230Hz) by transposing it down by octaves.
Definition VibrosonicsAPI.cpp:273
void setGrainAmpEnv(Grain *grains, int numGrains, AmpEnv ampEnv)
Sets the amplitude envelope parameters for an array of grains.
Definition VibrosonicsAPI.cpp:445
Definition Grain.h:60
Definition Grain.h:88
Definition Grain.h:38