Simplify sample frame operations (make it a class)

include/AudioDevice.h

@@ -37,6 +37,7 @@ namespace lmms
 
 class AudioEngine;
 class AudioPort;
+class SampleFrame;
 
 
 class AudioDevice
@@ -92,14 +93,14 @@ class AudioDevice
 protected:
 	// subclasses can re-implement this for being used in conjunction with
 	// processNextBuffer()
-	virtual void writeBuffer(const surroundSampleFrame* /* _buf*/, const fpp_t /*_frames*/) {}
+	virtual void writeBuffer(const SampleFrame* /* _buf*/, const fpp_t /*_frames*/) {}
 
 	// called by according driver for fetching new sound-data
-	fpp_t getNextBuffer( surroundSampleFrame * _ab );
+	fpp_t getNextBuffer(SampleFrame* _ab);
 
 	// convert a given audio-buffer to a buffer in signed 16-bit samples
 	// returns num of bytes in outbuf
-	int convertToS16( const surroundSampleFrame * _ab,
+	int convertToS16(const SampleFrame* _ab,
 						const fpp_t _frames,
 						int_sample_t * _output_buffer,
 						const bool _convert_endian = false );
@@ -133,7 +134,7 @@ class AudioDevice
 
 	QMutex m_devMutex;
 
-	surroundSampleFrame * m_buffer;
+	SampleFrame* m_buffer;
 
 };
 

include/AudioDummy.h

@@ -94,7 +94,7 @@ class AudioDummy : public QThread, public AudioDevice
 		while( true )
 		{
 			timer.reset();
-			const surroundSampleFrame* b = audioEngine()->nextBuffer();
+			const SampleFrame* b = audioEngine()->nextBuffer();
 			if( !b )
 			{
 				break;

include/AudioEngine.h

@@ -37,6 +37,7 @@
 #include <vector>
 
 #include "lmms_basics.h"
+#include "SampleFrame.h"
 #include "LocklessList.h"
 #include "FifoBuffer.h"
 #include "AudioEngineProfiler.h"
@@ -57,8 +58,7 @@ const fpp_t DEFAULT_BUFFER_SIZE = 256;
 
 const int BYTES_PER_SAMPLE = sizeof( sample_t );
 const int BYTES_PER_INT_SAMPLE = sizeof( int_sample_t );
-const int BYTES_PER_FRAME = sizeof( sampleFrame );
-const int BYTES_PER_SURROUND_FRAME = sizeof( surroundSampleFrame );
+const int BYTES_PER_FRAME = sizeof( SampleFrame );
 
 const float OUTPUT_SAMPLE_MULTIPLIER = 32767.0f;
 
@@ -266,25 +266,16 @@ class LMMS_EXPORT AudioEngine : public QObject
 	}
 
 
-	struct StereoSample
-	{
-		StereoSample(sample_t _left, sample_t _right) : left(_left), right(_right) {}
-		sample_t left;
-		sample_t right;
-	};
-	StereoSample getPeakValues(sampleFrame * ab, const f_cnt_t _frames) const;
-
-
 	bool criticalXRuns() const;
 
 	inline bool hasFifoWriter() const
 	{
 		return m_fifoWriter != nullptr;
 	}
 
-	void pushInputFrames( sampleFrame * _ab, const f_cnt_t _frames );
+	void pushInputFrames( SampleFrame * _ab, const f_cnt_t _frames );
 
-	inline const sampleFrame * inputBuffer()
+	inline const SampleFrame * inputBuffer()
 	{
 		return m_inputBuffer[ m_inputBufferRead ];
 	}
@@ -294,7 +285,7 @@ class LMMS_EXPORT AudioEngine : public QObject
 		return m_inputBufferFrames[ m_inputBufferRead ];
 	}
 
-	inline const surroundSampleFrame * nextBuffer()
+	inline const SampleFrame* nextBuffer()
 	{
 		return hasFifoWriter() ? m_fifo->read() : renderNextBuffer();
 	}
@@ -320,11 +311,11 @@ class LMMS_EXPORT AudioEngine : public QObject
 signals:
 	void qualitySettingsChanged();
 	void sampleRateChanged();
-	void nextAudioBuffer( const lmms::surroundSampleFrame * buffer );
+	void nextAudioBuffer(const lmms::SampleFrame* buffer);
 
 
 private:
-	using Fifo = FifoBuffer<surroundSampleFrame*>;
+	using Fifo = FifoBuffer<SampleFrame*>;
 
 	class fifoWriter : public QThread
 	{
@@ -341,7 +332,7 @@ class LMMS_EXPORT AudioEngine : public QObject
 
 		void run() override;
 
-		void write( surroundSampleFrame * buffer );
+		void write(SampleFrame* buffer);
 	} ;
 
 
@@ -360,7 +351,7 @@ class LMMS_EXPORT AudioEngine : public QObject
 	void renderStageEffects();
 	void renderStageMix();
 
-	const surroundSampleFrame * renderNextBuffer();
+	const SampleFrame* renderNextBuffer();
 
 	void swapBuffers();
 
@@ -374,14 +365,14 @@ class LMMS_EXPORT AudioEngine : public QObject
 
 	fpp_t m_framesPerPeriod;
 
-	sampleFrame * m_inputBuffer[2];
+	SampleFrame * m_inputBuffer[2];
 	f_cnt_t m_inputBufferFrames[2];
 	f_cnt_t m_inputBufferSize[2];
 	int m_inputBufferRead;
 	int m_inputBufferWrite;
 
-	surroundSampleFrame * m_outputBufferRead;
-	surroundSampleFrame * m_outputBufferWrite;
+	SampleFrame* m_outputBufferRead;
+	SampleFrame* m_outputBufferWrite;
 
 	// worker thread stuff
 	std::vector<AudioEngineWorkerThread *> m_workers;

include/AudioFileFlac.h

@@ -65,7 +65,7 @@ class AudioFileFlac : public AudioFileDevice
 	SF_INFO  m_sfinfo;
 	SNDFILE* m_sf;
 
-	void writeBuffer(surroundSampleFrame const* _ab, fpp_t const frames) override;
+	void writeBuffer(const SampleFrame* _ab, fpp_t const frames) override;
 
 	bool startEncoding();
 	void finishEncoding();

include/AudioFileMP3.h

@@ -58,7 +58,7 @@ class AudioFileMP3 : public AudioFileDevice
 	}
 
 protected:
-	void writeBuffer(const surroundSampleFrame* /* _buf*/, const fpp_t /*_frames*/) override;
+	void writeBuffer(const SampleFrame* /* _buf*/, const fpp_t /*_frames*/) override;
 
 private:
 	void flushRemainingBuffers();

include/AudioFileOgg.h

@@ -58,7 +58,7 @@ class AudioFileOgg : public AudioFileDevice
 
 
 private:
-	void writeBuffer(const surroundSampleFrame* _ab, const fpp_t _frames) override;
+	void writeBuffer(const SampleFrame* _ab, const fpp_t _frames) override;
 
 	bool startEncoding();
 	void finishEncoding();

include/AudioFileWave.h

@@ -56,7 +56,7 @@ class AudioFileWave : public AudioFileDevice
 
 
 private:
-	void writeBuffer(const surroundSampleFrame* _ab, const fpp_t _frames) override;
+	void writeBuffer(const SampleFrame* _ab, const fpp_t _frames) override;
 
 	bool startEncoding();
 	void finishEncoding();

include/AudioJack.h

@@ -111,7 +111,7 @@ private slots:
 	std::atomic<MidiJack*> m_midiClient;
 	std::vector<jack_port_t*> m_outputPorts;
 	jack_default_audio_sample_t** m_tempOutBufs;
-	surroundSampleFrame* m_outBuf;
+	SampleFrame* m_outBuf;
 
 	f_cnt_t m_framesDoneInCurBuf;
 	f_cnt_t m_framesToDoInCurBuf;

include/AudioPort.h

@@ -46,7 +46,7 @@ class AudioPort : public ThreadableJob
 		BoolModel * mutedModel = nullptr );
 	virtual ~AudioPort();
 
-	inline sampleFrame * buffer()
+	inline SampleFrame * buffer()
 	{
 		return m_portBuffer;
 	}
@@ -112,7 +112,7 @@ class AudioPort : public ThreadableJob
 private:
 	volatile bool m_bufferUsage;
 
-	sampleFrame * m_portBuffer;
+	SampleFrame * m_portBuffer;
 	QMutex m_portBufferLock;
 
 	bool m_extOutputEnabled;

include/AudioPortAudio.h

@@ -150,7 +150,7 @@ class AudioPortAudio : public AudioDevice
 
 	bool m_wasPAInitError;
 
-	surroundSampleFrame * m_outBuf;
+	SampleFrame* m_outBuf;
 	int m_outBufPos;
 	int m_outBufSize;
 

include/AudioSampleRecorder.h

@@ -48,9 +48,9 @@ class AudioSampleRecorder : public AudioDevice
 	std::shared_ptr<const SampleBuffer> createSampleBuffer();
 
 private:
-	void writeBuffer(const surroundSampleFrame* _ab, const fpp_t _frames) override;
+	void writeBuffer(const SampleFrame* _ab, const fpp_t _frames) override;
 
-	using BufferList = QList<QPair<sampleFrame*, fpp_t>>;
+	using BufferList = QList<QPair<SampleFrame*, fpp_t>>;
 	BufferList m_buffers;
 
 } ;

include/AudioSdl.h

@@ -85,7 +85,7 @@ class AudioSdl : public AudioDevice
 
 	SDL_AudioSpec m_audioHandle;
 
-	surroundSampleFrame * m_outBuf;
+	SampleFrame* m_outBuf;
 
 #ifdef LMMS_HAVE_SDL2
 	size_t m_currentBufferFramePos;

include/AudioSoundIo.h

@@ -110,7 +110,7 @@ class AudioSoundIo : public AudioDevice
 	SoundIo *m_soundio;
 	SoundIoOutStream *m_outstream;
 
-	surroundSampleFrame * m_outBuf;
+	SampleFrame* m_outBuf;
 	int m_outBufSize;
 	fpp_t m_outBufFramesTotal;
 	fpp_t m_outBufFrameIndex;

include/BufferManager.h

@@ -32,20 +32,18 @@
 namespace lmms
 {
 
+class SampleFrame;
 
 class LMMS_EXPORT BufferManager
 {
 public:
 	static void init( fpp_t fpp );
-	static sampleFrame * acquire();
+	static SampleFrame * acquire();
 	// audio-buffer-mgm
-	static void clear( sampleFrame * ab, const f_cnt_t frames,
+	static void clear( SampleFrame * ab, const f_cnt_t frames,
 						const f_cnt_t offset = 0 );
-#ifndef LMMS_DISABLE_SURROUND
-	static void clear( surroundSampleFrame * ab, const f_cnt_t frames,
-						const f_cnt_t offset = 0 );
-#endif
-	static void release( sampleFrame * buf );
+
+	static void release( SampleFrame * buf );
 
 private:
 	static fpp_t s_framesPerPeriod;

include/DspEffectLibrary.h

@@ -28,7 +28,7 @@
 #include "lmms_math.h"
 #include "lmms_constants.h"
 #include "lmms_basics.h"
-
+#include "SampleFrame.h"
 
 namespace lmms::DspEffectLibrary
 {
@@ -80,6 +80,17 @@ namespace lmms::DspEffectLibrary
 		{
 		}
 
+		void setGain(float gain)
+		{
+			leftFX().setGain(gain);
+			rightFX().setGain(gain);
+		}
+
+		void nextSample(SampleFrame & in)
+		{
+			nextSample(in.left(), in.right());
+		}
+
 		void nextSample( sample_t& inLeft, sample_t& inRight )
 		{
 			inLeft = m_leftFX.nextSample( inLeft );

include/DummyEffect.h

@@ -107,7 +107,7 @@ class DummyEffect : public Effect
 		return &m_controls;
 	}
 
-	bool processAudioBuffer( sampleFrame *, const fpp_t ) override
+	bool processAudioBuffer( SampleFrame *, const fpp_t ) override
 	{
 		return false;
 	}

include/DummyInstrument.h

@@ -49,10 +49,9 @@ class DummyInstrument : public Instrument
 
 	~DummyInstrument() override = default;
 
-	void playNote( NotePlayHandle *, sampleFrame * buffer ) override
+	void playNote( NotePlayHandle *, SampleFrame * buffer ) override
 	{
-		memset( buffer, 0, sizeof( sampleFrame ) *
-			Engine::audioEngine()->framesPerPeriod() );
+		zeroSampleFrames(buffer, Engine::audioEngine()->framesPerPeriod());
 	}
 
 	void saveSettings( QDomDocument &, QDomElement & ) override

include/Effect.h

@@ -64,7 +64,7 @@ class LMMS_EXPORT Effect : public Plugin
 	}
 
 
-	virtual bool processAudioBuffer( sampleFrame * _buf,
+	virtual bool processAudioBuffer( SampleFrame * _buf,
 						const fpp_t _frames ) = 0;
 
 	inline ch_cnt_t processorCount() const
@@ -187,8 +187,8 @@ class LMMS_EXPORT Effect : public Plugin
 
 	// some effects might not be capable of higher sample-rates so they can
 	// sample it down before processing and back after processing
-	inline void sampleDown( const sampleFrame * _src_buf,
-							sampleFrame * _dst_buf,
+	inline void sampleDown( const SampleFrame * _src_buf,
+							SampleFrame * _dst_buf,
 							sample_rate_t _dst_sr )
 	{
 		resample( 0, _src_buf,
@@ -197,8 +197,8 @@ class LMMS_EXPORT Effect : public Plugin
 					Engine::audioEngine()->framesPerPeriod() );
 	}
 
-	inline void sampleBack( const sampleFrame * _src_buf,
-							sampleFrame * _dst_buf,
+	inline void sampleBack( const SampleFrame * _src_buf,
+							SampleFrame * _dst_buf,
 							sample_rate_t _src_sr )
 	{
 		resample( 1, _src_buf, _src_sr, _dst_buf,
@@ -213,9 +213,9 @@ class LMMS_EXPORT Effect : public Plugin
 
 private:
 	EffectChain * m_parent;
-	void resample( int _i, const sampleFrame * _src_buf,
+	void resample( int _i, const SampleFrame * _src_buf,
 					sample_rate_t _src_sr,
-					sampleFrame * _dst_buf, sample_rate_t _dst_sr,
+					SampleFrame * _dst_buf, sample_rate_t _dst_sr,
 					const f_cnt_t _frames );
 
 	ch_cnt_t m_processors;

include/EffectChain.h

@@ -34,6 +34,7 @@ namespace lmms
 {
 
 class Effect;
+class SampleFrame;
 
 namespace gui
 {
@@ -62,7 +63,7 @@ class LMMS_EXPORT EffectChain : public Model, public SerializingObject
 	void removeEffect( Effect * _effect );
 	void moveDown( Effect * _effect );
 	void moveUp( Effect * _effect );
-	bool processAudioBuffer( sampleFrame * _buf, const fpp_t _frames, bool hasInputNoise );
+	bool processAudioBuffer( SampleFrame * _buf, const fpp_t _frames, bool hasInputNoise );
 	void startRunning();
 
 	void clear();