Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce noise floor / dB ceiling parameters for the scope spectrum view. #6862

Merged
merged 7 commits into from
Mar 3, 2023
+79 −43
Merged

Introduce noise floor / dB ceiling parameters for the scope spectrum view. #6862

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a132cc9
Implement noise floor and ceiling.
mx Mar 3, 2023
01cf865
Fix bug by marking spectrum display as dirty.
mx Mar 3, 2023
babcca8
Remove currently unused parts.
mx Mar 3, 2023
ad7b4ac
Have scope properly update when below floor / above ceiling.
mx Mar 3, 2023
d3a5129
Clean up the momentarily bogus appearances when noise floor and db ce…
mx Mar 3, 2023
fd2aaf5
Remove some unused variables.
mx Mar 3, 2023
4ea4358
Clang Format so we can merge
baconpaul Mar 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 68 additions & 35 deletions src/surge-xt/gui/overlays/Oscilloscope.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,11 @@ static float freqToX(float freq, int width)
return xNorm * (float)width;
}

static float dbToY(float db, int height)
static float dbToY(float db, int height, float dbMin = -100.f, float dbMax = 0.f)
{
return (float)height * (SpectrumDisplay::dbMax - db) / SpectrumDisplay::dbRange;
float range = dbMax - dbMin;
// If dbMax/dbMin change and the data hasn't been updated yet due to locking, can get weirdness.
return std::max((float)height * (dbMax - db) / range, 0.f);
}

float WaveformDisplay::Parameters::counterSpeed() const
Expand Down Expand Up @@ -352,19 +354,28 @@ void WaveformDisplay::resized()
SpectrumDisplay::SpectrumDisplay(SurgeGUIEditor *e, SurgeStorage *s)
: editor_(e), storage_(s), last_updated_time_(std::chrono::steady_clock::now())
{
std::fill(new_scope_data_.begin(), new_scope_data_.end(), dbMin);
std::fill(new_scope_data_.begin(), new_scope_data_.end(), -100.f);
}

const SpectrumDisplay::Parameters &SpectrumDisplay::getParameters() const { return params_; }

void SpectrumDisplay::setParameters(Parameters parameters)
{
std::lock_guard l(data_lock_);
// Check if the new params for noise floor/ceiling are different. If they are, consider the
// display "dirty" (ie, stop interpolating distance, jump right to the new thing).
bool changedVisible = params_.dbRange() != parameters.dbRange();
params_ = std::move(parameters);
if (changedVisible)
{
display_dirty_ = true;
recalculateScopeData();
}
}

void SpectrumDisplay::paint(juce::Graphics &g)
{
std::lock_guard l(data_lock_);
auto scopeRect = getLocalBounds().transformedBy(getTransform().inverted());
auto width = scopeRect.getWidth();
auto height = scopeRect.getHeight();
Expand All @@ -373,14 +384,15 @@ void SpectrumDisplay::paint(juce::Graphics &g)
auto path = juce::Path();
bool started = false;
float binHz = storage_->samplerate / static_cast<float>(internal::fftSize);
float zeroPoint = dbToY(dbMin, height);
float maxPoint = dbToY(dbMax, height);
float dbMin = params_.noiseFloor();
float dbMax = params_.maxDb();
float zeroPoint = dbToY(dbMin, height, dbMin, dbMax);
float maxPoint = dbToY(dbMax, height, dbMin, dbMax);
auto now = std::chrono::steady_clock::now();

// Start path.
path.startNewSubPath(freqToX(lowFreq, width), zeroPoint);
{
std::lock_guard l(data_lock_);
mtbs_ = std::chrono::duration<float>(1.f / binHz);

for (int i = 0; i < internal::fftSize / 2; i++)
Expand All @@ -393,10 +405,16 @@ void SpectrumDisplay::paint(juce::Graphics &g)

const float x = freqToX(hz, width);
const float y0 = displayed_data_[i];
const float y1 = dbToY(new_scope_data_[i], height);
const float y = interpolate(y0, y1, now);
const float y1 = dbToY(new_scope_data_[i], height, dbMin, dbMax);
const float y = display_dirty_ ? y1 : interpolate(y0, y1, now);
displayed_data_[i] = y;
if (y > 0)
if (y >= zeroPoint)
{
path.lineTo(x, zeroPoint);
path.closeSubPath();
started = false;
}
else
{
if (started)
{
Expand All @@ -409,12 +427,6 @@ void SpectrumDisplay::paint(juce::Graphics &g)
started = true;
}
}
else
{
path.lineTo(x, zeroPoint);
path.closeSubPath();
started = false;
}
}
}
// End path.
Expand All @@ -425,22 +437,38 @@ void SpectrumDisplay::paint(juce::Graphics &g)
}
g.setColour(curveColor);
g.fillPath(path);
display_dirty_ = false;
}

void SpectrumDisplay::recalculateScopeData()
{
// data_lock_ *must* be held by the caller.
const float dbMin = params_.noiseFloor();
const float dbMax = params_.maxDb();
const float offset = juce::Decibels::gainToDecibels((float)internal::fftSize);
std::transform(incoming_scope_data_.begin(), incoming_scope_data_.end(),
new_scope_data_.begin(), [=](const float f) {
return juce::jlimit(dbMin, dbMax,
juce::Decibels::gainToDecibels(f) - offset);
});
}

void SpectrumDisplay::resized()
{
auto scopeRect = getLocalBounds().transformedBy(getTransform().inverted());
auto height = scopeRect.getHeight();
std::fill(displayed_data_.begin(), displayed_data_.end(), dbToY(-100, height));
std::fill(displayed_data_.begin(), displayed_data_.end(),
dbToY(params_.noiseFloor(), height, params_.noiseFloor(), params_.maxDb()));
}

void SpectrumDisplay::updateScopeData(internal::FftScopeType::iterator begin,
internal::FftScopeType::iterator end)
{
// Data comes in as dB (from dbMin to dbMax).
std::lock_guard l(data_lock_);
std::move(begin, end, new_scope_data_.begin());
std::move(begin, end, incoming_scope_data_.begin());
last_updated_time_ = std::chrono::steady_clock::now();
recalculateScopeData();
}

float SpectrumDisplay::interpolate(const float y0, const float y1,
Expand Down Expand Up @@ -504,8 +532,8 @@ Oscilloscope::Oscilloscope(SurgeGUIEditor *e, SurgeStorage *s)

Oscilloscope::~Oscilloscope()
{
// complete_ should come before any condition variables get signaled, to allow the data thread
// to finish up.
// complete_ should come before any condition variables get signaled, to allow the data
// thread to finish up.
complete_.store(true, std::memory_order_seq_cst);
{
std::lock_guard l(data_lock_);
Expand Down Expand Up @@ -776,9 +804,9 @@ Oscilloscope::SpectrumParameters::SpectrumParameters(SurgeGUIEditor *e, SurgeSto
noise_floor_.setUnit(" dB");
max_db_.setRange(-50, 0);
max_db_.setUnit(" dB");
#if 0
addAndMakeVisible(noise_floor_);
addAndMakeVisible(max_db_);
#if 0
// The toggle button.
auto toggleParam = [this](bool &param) {
std::lock_guard l(params_lock_);
Expand Down Expand Up @@ -861,8 +889,8 @@ void Oscilloscope::updateDrawing()

void Oscilloscope::visibilityChanged()
{
// Not sure aside from construction when visibility might be changed in Juce, so putting this
// here for additional safety.
// Not sure aside from construction when visibility might be changed in Juce, so putting
// this here for additional safety.
if (isVisible())
{
storage_->audioOut.subscribe();
Expand All @@ -885,14 +913,11 @@ void Oscilloscope::calculateSpectrumData()
float hz = binHz * static_cast<float>(i);
if (hz < SpectrumDisplay::lowFreq || hz > SpectrumDisplay::highFreq)
{
scope_data_[i] = SpectrumDisplay::dbMin;
scope_data_[i] = 0;
}
else
{
scope_data_[i] =
juce::jlimit(SpectrumDisplay::dbMin, SpectrumDisplay::dbMax,
juce::Decibels::gainToDecibels(fft_data_[i]) -
juce::Decibels::gainToDecibels((float)internal::fftSize));
scope_data_[i] = fft_data_[i];
}
}
}
Expand Down Expand Up @@ -920,7 +945,7 @@ void Oscilloscope::changeScopeType(ScopeMode type)
scope_mode_ = SPECTRUM;
waveform_.setVisible(false);
waveform_parameters_.setVisible(false);
std::fill(scope_data_.begin(), scope_data_.end(), SpectrumDisplay::dbMin);
std::fill(scope_data_.begin(), scope_data_.end(), 0.f);
spectrum_.setVisible(true);
spectrum_parameters_.setVisible(true);

Expand Down Expand Up @@ -1141,12 +1166,15 @@ void Oscilloscope::Background::paintSpectrumBackground(juce::Graphics &g)
g.setFont(font);

// Draw dB lines.
for (float dB :
{-100.f, -90.f, -80.f, -70.f, -60.f, -50.f, -40.f, -30.f, -20.f, -10.f, 0.f})
float minDb = spectrum_params_.noiseFloor();
float maxDb = spectrum_params_.maxDb();
float step = spectrum_params_.dbRange() / 10.f;
float dB = minDb;
for (int i = 0; i < 11; i++, dB += step)
{
const auto yPos = dbToY(dB, height);
const auto yPos = dbToY(dB, height, minDb, maxDb);

if (dB == 0.f || dB == -100.f)
if (std::abs(dB - minDb) < .005 || std::abs(dB - maxDb) < .005)
{
g.setColour(primaryLine);
}
Expand All @@ -1157,7 +1185,12 @@ void Oscilloscope::Background::paintSpectrumBackground(juce::Graphics &g)

g.drawHorizontalLine(yPos, 0, static_cast<float>(width + 1));

const auto dbString = juce::String(dB) + " dB";
std::ostringstream convert;
convert << std::fixed << std::setprecision(1);
convert << dB;
std::string converted = convert.str();
const auto dbString =
juce::String(converted.substr(0, converted.find_last_not_of('0') + 1) + " dB");
// Label will go past the end of the scopeRect.
const auto labelRect = juce::Rectangle{font.getStringWidth(dbString), labelHeight}
.withBottomY((int)(yPos + (labelHeight / 2)))
Expand Down Expand Up @@ -1226,8 +1259,8 @@ void Oscilloscope::Background::paintWaveformBackground(juce::Graphics &g)
g.addTransform(juce::AffineTransform().translated(scopeRect.getX(), scopeRect.getY()));
g.setFont(font);

// Split the grid into 7 sections, starting from 0 and ending at wherever the counter speed
// says we should end at.
// Split the grid into 7 sections, starting from 0 and ending at wherever the counter
// speed says we should end at.
float counterSpeedInverse = 1.f / waveform_params_.counterSpeed();
float sampleRateInverse = 1.f / static_cast<float>(storage_->samplerate);
float endpoint = counterSpeedInverse * sampleRateInverse * static_cast<float>(width);
Expand Down
19 changes: 11 additions & 8 deletions src/surge-xt/gui/overlays/Oscilloscope.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,23 +139,20 @@ class SpectrumDisplay : public juce::Component, public Surge::GUI::SkinConsuming
public:
static constexpr float lowFreq = 10;
static constexpr float highFreq = 24000;
static constexpr float dbMin = -100;
static constexpr float dbMax = 0;
static constexpr float dbRange = dbMax - dbMin;

struct Parameters
{
float noise_floor = -100.f; // Noise floor level, bottom of the scope. Min -100. Slider.
float max_db = 0.f; // Maximum dB displayed. Slider. Maxes out at 0. Slider.
bool freeze = false; // Freeze display, on/off.
float noise_floor = 0.f; // Noise floor level, bottom of the scope. Min -100. Slider.
float max_db = 1.f; // Maximum dB displayed. Slider. Maxes out at 0. Slider.
bool freeze = false; // Freeze display, on/off.

// Range of decibels shown in the display, calculated from slider values.
float dbRange() const;

// Calculate the noise floor in decibels from the slider value.
// Calculate the noise floor in decibels from the slider value (noise_floor).
float noiseFloor() const;

// Calculate the maximum decibels shown from the slider value.
// Calculate the maximum decibels shown from the slider value (max_db).
float maxDb() const;
};

Expand All @@ -172,6 +169,8 @@ class SpectrumDisplay : public juce::Component, public Surge::GUI::SkinConsuming
private:
float interpolate(const float y0, const float y1,
std::chrono::time_point<std::chrono::steady_clock> t) const;
// data_lock_ *must* be held by the caller.
void recalculateScopeData();

SurgeGUIEditor *editor_;
SurgeStorage *storage_;
Expand All @@ -181,6 +180,10 @@ class SpectrumDisplay : public juce::Component, public Surge::GUI::SkinConsuming
std::mutex data_lock_;
internal::FftScopeType new_scope_data_;
internal::FftScopeType displayed_data_;
// Why a third array? We calculate into the other two, and if the parameters
// change we have to update our calculations from the beginning.
internal::FftScopeType incoming_scope_data_;
bool display_dirty_;
};

class Oscilloscope : public OverlayComponent,
Expand Down