56 fix au validation (#58)

* Clearing out vectors holding spectral processes directory instead of by the parent vector * Removed Logger. This is not useful * Perhaps better clearing of spec processes * validating phase lock * If preparing to play then try not to perform other operations on the audio processors * Added SSF to au validation * added spectral gate to au validation * validating all plugins and exiting early if error * fixed more race conditions * Frequency shift passes validation * fixed bin scrambler out of bounds error * initialising wave table if fft size changed before playback started * Using correct variable when detecting races'
andrewreeman · Jun 20, 2024 · a14a8d8 · a14a8d8
1 parent 26b7b42
commit a14a8d8
Show file tree

Hide file tree

Showing 11 changed files with 187 additions and 50 deletions.
diff --git a/FrequencyShift/Source/FrequencyShiftAudioPlugin.cpp b/FrequencyShift/Source/FrequencyShiftAudioPlugin.cpp
@@ -34,6 +34,14 @@ class Factory : public SpectralAudioPlugin::DependencyFactory {
 // This creates new instances of the plugin..
 AudioProcessor* JUCE_CALLTYPE createPluginFilter()
 {
+    // To debug AUval
+//#if DEBUG
+//    while (!Process::isRunningUnderDebugger())
+//    {
+//        Thread::sleep(250);
+//    }
+//#endif
+
 	return new SpectralAudioPlugin(
 		new Factory()
 	);

diff --git a/PhaseLock/Source/PhaseLockAudioPlugin.cpp b/PhaseLock/Source/PhaseLockAudioPlugin.cpp
@@ -30,5 +30,12 @@ class Factory : public SpectralAudioPlugin::DependencyFactory {
 // This creates new instances of the plugin..
 AudioProcessor* JUCE_CALLTYPE createPluginFilter()
 {
+    // To debug AUval
+//#if DEBUG
+//    while (!Process::isRunningUnderDebugger())
+//    {
+//        Thread::sleep(250);
+//    }
+//#endif
     return new SpectralAudioPlugin(new Factory());
 }
diff --git a/SinusoidalShapedFilter/Source/SSFAudioPlugin.cpp b/SinusoidalShapedFilter/Source/SSFAudioPlugin.cpp
@@ -30,5 +30,12 @@ class Factory : public SpectralAudioPlugin::DependencyFactory {
 // This creates new instances of the plugin..
 AudioProcessor* JUCE_CALLTYPE createPluginFilter()
 {
+    // To debug AUval
+//#if DEBUG
+//    while (!Process::isRunningUnderDebugger())
+//    {
+//        Thread::sleep(250);
+//    }
+//#endif
     return new SpectralAudioPlugin(new Factory());
 }
diff --git a/SinusoidalShapedFilter/Source/SSFInteractor.cpp b/SinusoidalShapedFilter/Source/SSFInteractor.cpp
@@ -31,5 +31,9 @@ std::unique_ptr<StandardFFTProcessor> SSFInteractor::createSpectralProcess(
 }
 
 void SSFInteractor::onFftSizeChanged(){
+    if(m_wavetable == nullptr) {
+        m_wavetable = std::make_shared<Table<float> >(getFftSize() / 2, 1, 1);
+    }
+
     m_wavetable->resize(getFftSize() / 2);
 }
diff --git a/auValidate.sh b/auValidate.sh
@@ -0,0 +1,25 @@
+#!/bin/bash 
+
+# Exit early if any command fails
+set -e
+
+# Frequency shifter
+auval -strict -v aumf SPFS STPW 
+
+# Bin Scrambler
+auval -strict -v aumf SPBS STPW
+
+# Frequency magnet
+auval -strict -v aumf SPFM STPW
+
+# Morph
+auval -strict -v aumf SPMO STPW
+
+# Phase lock
+auval -strict -v aumf SPPL STPW
+
+# Sinusoidal Sharped Filer
+auval -strict -v aumf SPSS STPW
+
+# Spectral Gate
+auval -strict -v aumf SPSG STPW
diff --git a/shared/FftSwitcher.h b/shared/FftSwitcher.h
@@ -19,6 +19,8 @@ class FftSwitcherThread: public Thread {
     /// Thread
     /// Do not call this directly. Instead call `switchFftSize` or `switchOverlapCount`
 	void run() override {
+        if (threadShouldExit()) { return; }
+
         if(m_switchFft) {
             m_switchFft = false;
             m_fftSwitcher->switchFftSize();

diff --git a/shared/FftThread.cpp b/shared/FftThread.cpp
@@ -1,3 +1,4 @@
+// TODO: check if this class is unused
 
 #include "FftThread.h"
 

diff --git a/shared/SpectralAudioPlugin.cpp b/shared/SpectralAudioPlugin.cpp
@@ -33,28 +33,11 @@ SpectralAudioPlugin::SpectralAudioPlugin(
 	m_versionCheckThread(VersionCode, "https://www.andrewreeman.com/spectral_suite_publish.json"),
     m_dependencyFactory(dependencies)
 {
-
-
-	//FileLogger* logger = new FileLogger(FileLogger::getSystemLogFileFolder().getChildFile("logs")
-	//	.getChildFile("spectral_suite" + Time::getCurrentTime().formatted("%Y-%m-%d_%H-%M-%S"))
-	//	.withFileExtension(".log")
-	//	.getNonexistentSibling(),
-	//	"Log started", 0);
-
-	File logFile = FileLogger::getSystemLogFileFolder().getChildFile("SpectralSuite").getChildFile("spectral_suite.log");
-	m_logger = std::unique_ptr<FileLogger>(
-		new FileLogger(
-		logFile,
-			"Log started"
-		)
-	);
-	Logger::setCurrentLogger(m_logger.get());
     this->initialiseParameters();
 }
 
 SpectralAudioPlugin::~SpectralAudioPlugin()
 {    
-	Logger::setCurrentLogger(nullptr);
     if(this->m_versionCheckThread.isThreadRunning()) {
         this->m_versionCheckThread.stopThread(20);
     }
@@ -67,6 +50,9 @@ SpectralAudioPlugin::~SpectralAudioPlugin()
 /* FFT Switcher methods */
 void SpectralAudioPlugin::switchFftSize()
 {
+    if (isInvalidFftModificationState()) { return; }
+//    if (m_audioProcessorInteractor->isPreparingToPlay()) { return; }
+
 	setFftSize(m_fftSizeChoiceAdapter.fftSize());
 
     if(getActiveEditor() != nullptr) {
@@ -76,6 +62,8 @@ void SpectralAudioPlugin::switchFftSize()
 }
 void SpectralAudioPlugin::switchFftStyle()
 {
+    if (isInvalidFftModificationState()) { return; }
+
     FftStyle style = m_fftStyleChoiceAdapter.fftStyle();
     switch(style) {
         case FftStyle::DEFAULT:
@@ -95,24 +83,52 @@ void SpectralAudioPlugin::switchFftStyle()
 }
 
 void SpectralAudioPlugin::switchOverlapCount() {
+    if (isInvalidFftModificationState()) { return; }
+
     int overlaps = m_fftOverlapsChoiceAdapter.overlapCount();
     m_audioProcessorInteractor->setNumOverlaps(overlaps);
 
     const int hopSize = m_audioProcessorInteractor->getHopSize();
-	for(std::vector<float>& output : m_output)
-	{
-		output.resize(hopSize, 0.f);
-	}
-	for(std::vector<float>& input : m_input)
-	{
-		input.resize(hopSize, 0.f);
-	}
-
+
+    for(std::vector<float>& output : m_output)
+    {
+        if (output.size() == hopSize)
+        {
+            continue;
+        }
+
+        if (isInvalidFftModificationState()) { return; }
+        // Because we switch overlaps on a different thread m_output might be empty when we resize
+        // Which means we no longer own the output vector
+        // output vector expected to only be empty if we have been destructed
+        // TODO: use mutex when modifying fft buffers
+        if (!m_output.empty() && !output.empty())
+        {
+            output.resize(hopSize, 0.f);
+        }
+    }
+
+    for(std::vector<float>& input : m_input)
+    {
+        if (input.size() == hopSize)
+        {
+            continue;
+        }
+
+        if (isInvalidFftModificationState()) { return; }
+        if (!m_input.empty() && !input.empty())
+        {
+            input.resize(hopSize, 0.f);
+        }
+    }
+
 	setLatencySamples(m_audioProcessorInteractor->getFftSize() + hopSize);
 }
 
 
 void SpectralAudioPlugin::switchFftWindowType() {
+    if (isInvalidFftModificationState()) { return; }
+
     auto windowType = m_fftWindowChoiceAdapter.fftWindow();
     m_audioProcessorInteractor->setWindowType(windowType);
 }
@@ -184,6 +200,7 @@ void SpectralAudioPlugin::prepareToPlay (double sampleRate, int)
 {    
 	m_output.clear();
 	m_input.clear();
+
 	for (
 		int outputChannelCount = getBusesLayout().getMainOutputChannels();		
 		outputChannelCount > 0;
@@ -193,10 +210,11 @@ void SpectralAudioPlugin::prepareToPlay (double sampleRate, int)
 		m_output.push_back(std::vector<float>());
 		m_input.push_back(std::vector<float>());
 	}
-
-	const int fftSize = m_fftSizeChoiceAdapter.fftSize();
-	m_audioProcessorInteractor->prepareToPlay(fftSize, (int)sampleRate, getBusesLayout().getMainOutputChannels());	
-	setFftSize(fftSize);		
+
+    const int fftSize = m_fftSizeChoiceAdapter.fftSize();
+	m_audioProcessorInteractor->prepareToPlay(fftSize, (int)sampleRate, getBusesLayout().getMainOutputChannels());
+
+	setFftSize(fftSize);
 }
 
 void SpectralAudioPlugin::releaseResources()
@@ -232,9 +250,9 @@ void SpectralAudioPlugin::emptyOutputs() {
 
 void SpectralAudioPlugin::processBlock (AudioBuffer<float>& buffer, MidiBuffer& midiBuffer)
 {
-	if (m_fftSwitcher.isThreadRunning()) {        
+	if (m_fftSwitcher.isThreadRunning()) {
 		m_internalBufferReadWriteIndex = 0;
-		return; 
+		return;
 	}
 
 	if (m_fftSizeChoiceAdapter.shouldChangeFftSize()) {
@@ -329,6 +347,8 @@ void SpectralAudioPlugin::setStateInformation (const void* data, int sizeInBytes
 }
 
 void SpectralAudioPlugin::setFftSize(int size) {	
+    if (isInvalidFftModificationState()) { return; }
+
 	m_audioProcessorInteractor->setFftSize(size);
 	const int hopSize = m_audioProcessorInteractor->getHopSize();
 
@@ -351,7 +371,6 @@ void SpectralAudioPlugin::checkForUpdates(VersionCheckThread::Listener* listener
 }
 
 void SpectralAudioPlugin::initialiseParameters() {
-
     parameters = m_dependencyFactory->createParams(this);
     m_audioProcessorInteractor = m_dependencyFactory->createProcessor(this);
 

diff --git a/shared/SpectralAudioPlugin.h b/shared/SpectralAudioPlugin.h
@@ -12,10 +12,6 @@
 #include "ParameterContainerComponentFactory.h"
 #include "PluginParameters.h"
 
-//==============================================================================
-/**
-*/
-
 class SpectralAudioPluginUi;
 
 class SpectralAudioPlugin : public AudioProcessor, private FftSwitcherThread::FftSwitcher
@@ -30,8 +26,6 @@ class SpectralAudioPlugin : public AudioProcessor, private FftSwitcherThread::Ff
         virtual ~DependencyFactory(){};
 
         virtual std::shared_ptr<PluginParameters> createParams(SpectralAudioPlugin* plugin) = 0;
-//        virtual std::unique_ptr<ParameterContainerComponent> createUi(SpectralAudioPlugin* plugin) = 0;
-//        virtual std::unique_ptr<ParameterContainerComponent> createUi(SpectralAudioPlugin* plugin) = 0;
         virtual ParameterContainerComponent* createUi(SpectralAudioPlugin* plugin) = 0;
         virtual std::unique_ptr<SpectralAudioProcessorInteractor> createProcessor(SpectralAudioPlugin* plugin) = 0;
         virtual Array<int> fftSizesToNotInclude() { return Array<int>(); };
@@ -107,19 +101,25 @@ class SpectralAudioPlugin : public AudioProcessor, private FftSwitcherThread::Ff
 	void emptyOutputs();
 	void setFftSize(int fftSize);
     void initialiseParameters();
-
-	std::shared_ptr<PluginParameters> parameters;
-//    std::unique_ptr<ParameterContainerComponent> m_parameterUiComponent;
-	std::unique_ptr<SpectralAudioProcessorInteractor> m_audioProcessorInteractor;
+    bool isPreparingToPlay() const { return m_audioProcessorInteractor->isPreparingToPlay(); }
+    bool isInvalidFftModificationState() const {
+        return
+            m_fftSwitcher.threadShouldExit()
+            || m_audioProcessorInteractor->isPreparingToPlay()
+            || m_audioProcessorInteractor->isPlaying()
+            || m_output.empty()
+            || m_input.empty();
+    };
+
+    std::shared_ptr<PluginParameters> parameters;
+    std::unique_ptr<SpectralAudioProcessorInteractor> m_audioProcessorInteractor;
 
 	FftSizeChoiceAdapter m_fftSizeChoiceAdapter;
     FftStyleChoiceAdapter m_fftStyleChoiceAdapter;
     FftOverlapsChoiceAdapter m_fftOverlapsChoiceAdapter;
     FftWindowChoiceAdapter m_fftWindowChoiceAdapter;
 	FftSwitcherThread m_fftSwitcher;
 
-	std::unique_ptr<FileLogger> m_logger;
-
 	// io buffers: TODO n chan
 	int m_internalBufferReadWriteIndex;
 	std::vector<std::vector<float>> m_input;
Original file line number	Diff line number	Diff line change
		@@ -1,3 +1,4 @@
		// TODO: check if this class is unused

		#include "FftThread.h"

Expand Down