Make SaProcessor unfriendly to view classes

plugins/SpectrumAnalyzer/SaProcessor.cpp

@@ -476,6 +476,21 @@ void SaProcessor::clear()
 	std::fill(m_history.begin(), m_history.end(), 0);
 }
 
+// Clear only history work buffer. Used to flush old data when waterfall
+// is shown after a period of inactivity.
+void SaProcessor::clearHistory()
+{
+	QMutexLocker lock(&m_dataAccess);
+	std::fill(m_history_work.begin(), m_history_work.end(), 0);
+}
+
+// Check if result buffers contain any non-zero values
+bool SaProcessor::spectrumNotEmpty()
+{
+	QMutexLocker lock(&m_reallocationAccess);
+	return notEmpty(m_normSpectrumL) || notEmpty(m_normSpectrumR);
+}
+
 
 // --------------------------------------
 // Frequency conversion helpers

plugins/SpectrumAnalyzer/SaProcessor.h

@@ -59,8 +59,21 @@ class SaProcessor
 	void reallocateBuffers();
 	void rebuildWindow();
 	void clear();
+	void clearHistory();
+
+	const float *getSpectrumL() const {return m_normSpectrumL.data();}
+	const float *getSpectrumR() const {return m_normSpectrumR.data();}
+	const uchar *getHistory() const {return m_history.data();}
 
 	// information about results and unit conversion helpers
+	const unsigned int &inBlockSize() const {return m_inBlockSize;}
+	unsigned int binCount() const;			//!< size of output (frequency domain) data block
+	bool spectrumNotEmpty();				//!< check if result buffers contain any non-zero values
+
+	unsigned int waterfallWidth() const;	//!< binCount value capped at 3840 (for display)
+	const unsigned int& waterfallHeight() const {return m_waterfallHeight;}
+	bool waterfallNotEmpty() const {return m_waterfallNotEmpty;}
+
 	float binToFreq(unsigned int bin_index) const;
 	float binBandwidth() const;
 
@@ -103,8 +116,6 @@ class SaProcessor
 	unsigned int m_fftBlockSize;			//!< size of padded block for FFT processing
 	unsigned int m_sampleRate;
 
-	unsigned int binCount() const;			//!< size of output (frequency domain) data block
-
 	// data buffers (roughly in the order of processing, from input to output)
 	unsigned int m_framesFilledUp;
 	std::vector<float> m_bufferL;			//!< time domain samples (left)
@@ -128,20 +139,16 @@ class SaProcessor
 	unsigned int m_waterfallHeight;			//!< number of stored lines in history buffer
 											// Note: high values may make it harder to see transients.
 	const unsigned int m_waterfallMaxWidth = 3840;
-	unsigned int waterfallWidth() const;	//!< binCount value capped at 3840 (for display)
 
 	// book keeping
 	bool m_spectrumActive;
 	bool m_waterfallActive;
-	unsigned int m_waterfallNotEmpty;
+	unsigned int m_waterfallNotEmpty;		//!< number of lines remaining visible on display
 	bool m_reallocating;
 
 	// merge L and R channels and apply gamma correction to make a spectrogram pixel
 	QRgb makePixel(float left, float right) const;
 
-	friend class SaSpectrumView;
-	friend class SaWaterfallView;
-
 	#ifdef SA_DEBUG
 		unsigned int m_last_dump_time;
 		unsigned int m_dump_count;

plugins/SpectrumAnalyzer/SaSpectrumView.cpp

@@ -163,10 +163,8 @@ void SaSpectrumView::drawSpectrum(QPainter &painter)
 	#endif
 
 	// draw the graph only if there is any input, averaging residue or peaks
-	QMutexLocker lock(&m_processor->m_reallocationAccess);
-	if (m_decaySum > 0 || notEmpty(m_processor->m_normSpectrumL) || notEmpty(m_processor->m_normSpectrumR))
+	if (m_decaySum > 0 || m_processor->spectrumNotEmpty())
 	{
-		lock.unlock();
 		// update data buffers and reconstruct paths
 		refreshPaths();
 
@@ -204,10 +202,6 @@ void SaSpectrumView::drawSpectrum(QPainter &painter)
 			draw_time = std::chrono::high_resolution_clock::now().time_since_epoch().count() - draw_time;
 		#endif
 	}
-	else
-	{
-		lock.unlock();
-	}
 
 	#ifdef SA_DEBUG
 		// save performance measurement result
@@ -242,8 +236,8 @@ void SaSpectrumView::refreshPaths()
 		int refresh_time = std::chrono::high_resolution_clock::now().time_since_epoch().count();
 	#endif
 	m_decaySum = 0;
-	updateBuffers(m_processor->m_normSpectrumL.data(), m_displayBufferL.data(), m_peakBufferL.data());
-	updateBuffers(m_processor->m_normSpectrumR.data(), m_displayBufferR.data(), m_peakBufferR.data());
+	updateBuffers(m_processor->getSpectrumL(), m_displayBufferL.data(), m_peakBufferL.data());
+	updateBuffers(m_processor->getSpectrumR(), m_displayBufferR.data(), m_peakBufferR.data());
 	#ifdef SA_DEBUG
 		refresh_time = std::chrono::high_resolution_clock::now().time_since_epoch().count() - refresh_time;
 	#endif
@@ -292,7 +286,7 @@ void SaSpectrumView::refreshPaths()
 // reallocation access lock! Data access lock is not needed: the final result
 // buffer is updated very quickly and the worst case is that one frame will be
 // part new, part old. At reasonable frame rate, such difference is invisible..
-void SaSpectrumView::updateBuffers(float *spectrum, float *displayBuffer, float *peakBuffer)
+void SaSpectrumView::updateBuffers(const float *spectrum, float *displayBuffer, float *peakBuffer)
 {
 	for (int n = 0; n < m_processor->binCount(); n++)
 	{

plugins/SpectrumAnalyzer/SaSpectrumView.h

@@ -85,7 +85,7 @@ private slots:
 	std::vector<float> m_displayBufferR;
 	std::vector<float> m_peakBufferL;
 	std::vector<float> m_peakBufferR;
-	void updateBuffers(float *spectrum, float *displayBuffer, float *peakBuffer);
+	void updateBuffers(const float *spectrum, float *displayBuffer, float *peakBuffer);
 
 	// final paths to be drawn by QPainter and methods to build them
 	QPainterPath m_pathL;

plugins/SpectrumAnalyzer/SaWaterfallView.cpp

@@ -93,11 +93,11 @@ void SaWaterfallView::paintEvent(QPaintEvent *event)
 	painter.setRenderHint(QPainter::Antialiasing, true);
 
 	// check if time labels need to be rebuilt
-	if (secondsPerLine() != m_oldSecondsPerLine || m_processor->m_waterfallHeight != m_oldHeight)
+	if (secondsPerLine() != m_oldSecondsPerLine || m_processor->waterfallHeight() != m_oldHeight)
 	{
 		m_timeTics = makeTimeTics();
 		m_oldSecondsPerLine = secondsPerLine();
-		m_oldHeight = m_processor->m_waterfallHeight;
+		m_oldHeight = m_processor->waterfallHeight();
 	}
 
 	// print time labels
@@ -137,12 +137,12 @@ void SaWaterfallView::paintEvent(QPaintEvent *event)
 	}
 
 	// draw the spectrogram precomputed in SaProcessor
-	if (m_processor->m_waterfallNotEmpty)
+	if (m_processor->waterfallNotEmpty())
 	{
 		QMutexLocker lock(&m_processor->m_reallocationAccess);
-		QImage temp = QImage(m_processor->m_history.data(),		// raw pixel data to display
+		QImage temp = QImage(m_processor->getHistory(),			// raw pixel data to display
 							 m_processor->waterfallWidth(),		// width = number of frequency bins
-							 m_processor->m_waterfallHeight,	// height = number of history lines
+							 m_processor->waterfallHeight(),	// height = number of history lines
 							 QImage::Format_RGB32);
 		lock.unlock();
 		temp.setDevicePixelRatio(devicePixelRatio());			// display at native resolution
@@ -178,7 +178,7 @@ void SaWaterfallView::paintEvent(QPaintEvent *event)
 // Helper functions for time conversion
 float SaWaterfallView::samplesPerLine()
 {
-	return (float)m_processor->m_inBlockSize / m_controls->m_windowOverlapModel.value();
+	return (float)m_processor->inBlockSize() / m_controls->m_windowOverlapModel.value();
 }
 
 float SaWaterfallView::secondsPerLine()
@@ -190,7 +190,7 @@ float SaWaterfallView::secondsPerLine()
 // Convert time value to Y coordinate for display of given height.
 float SaWaterfallView::timeToYPixel(float time, int height)
 {
-	float pixels_per_line = (float)height / m_processor->m_waterfallHeight;
+	float pixels_per_line = (float)height / m_processor->waterfallHeight();
 
 	return pixels_per_line * time / secondsPerLine();
 }
@@ -200,7 +200,7 @@ float SaWaterfallView::timeToYPixel(float time, int height)
 float SaWaterfallView::yPixelToTime(float position, int height)
 {
 	if (height == 0) {height = 1;}
-	float pixels_per_line = (float)height / m_processor->m_waterfallHeight;
+	float pixels_per_line = (float)height / m_processor->waterfallHeight();
 
 	return (position / pixels_per_line) * secondsPerLine();
 }
@@ -258,10 +258,7 @@ void SaWaterfallView::updateVisibility()
 	if (m_controls->m_waterfallModel.value())
 	{
 		// clear old data before showing the waterfall
-		QMutexLocker lock(&m_processor->m_dataAccess);
-		std::fill(m_processor->m_history_work.begin(), m_processor->m_history_work.end(), 0);
-		lock.unlock();
-
+		m_processor->clearHistory();
 		setVisible(true);
 
 		// increase window size if it is too small