TrackSpectrumTransformer Class Reference

Subclass of SpectrumTransformer that rewrites a track. More...

#include <SpectrumTransformer.h>

Inheritance diagram for TrackSpectrumTransformer:

Collaboration diagram for TrackSpectrumTransformer:

Public Member Functions
	~TrackSpectrumTransformer () override
bool	Process (const WindowProcessor &processor, WaveTrack *track, size_t queueLength, sampleCount start, sampleCount len)
	Invokes Start(), ProcessSamples(), and Finish() More...
	SpectrumTransformer (bool needsOutput, eWindowFunctions inWindowType, eWindowFunctions outWindowType, size_t windowSize, unsigned stepsPerWindow, bool leadingPadding, bool trailingPadding)
Public Member Functions inherited from SpectrumTransformer
	SpectrumTransformer (bool needsOutput, eWindowFunctions inWindowType, eWindowFunctions outWindowType, size_t windowSize, unsigned stepsPerWindow, bool leadingPadding, bool trailingPadding)
virtual	~SpectrumTransformer ()
bool	NeedsOutput () const
bool	Start (size_t queueLength)
	Call once before a sequence of calls to ProcessSamples; Invokes DoStart. More...
bool	ProcessSamples (const WindowProcessor &processor, const float *buffer, size_t len)
	Call multiple times. More...
bool	Finish (const WindowProcessor &processor)
	Call once after a sequence of calls to ProcessSamples; flushes the queue and Invokes DoFinish. More...
virtual std::unique_ptr< Window >	NewWindow (size_t windowSize)
	Allocates a window to place in the queue. More...
virtual bool	DoStart ()
	Called before any calls to ProcessWindow. More...
virtual void	DoOutput (const float *outBuffer, size_t mStepSize)=0
	Called within ProcessSamples if output was requested. More...
virtual bool	DoFinish ()
	Called after the last call to ProcessWindow(). More...
size_t	TotalQueueSize () const
	Useful functions to implement WindowProcesser: More...
size_t	CurrentQueueSize () const
	How many windows in the queue have been filled? More...
bool	QueueIsFull () const
Window &	Nth (int n)
	Access the queue, so you can inspect and modify any window in it. More...
Window &	Newest ()
Window &	Latest ()

Protected Member Functions
bool	DoStart () override
	Called before any calls to ProcessWindow. More...
void	DoOutput (const float *outBuffer, size_t mStepSize) override
	Called within ProcessSamples if output was requested. More...
bool	DoFinish () override
	Called after the last call to ProcessWindow(). More...

Private Attributes
WaveTrack *	mpTrack = nullptr
std::shared_ptr< WaveTrack >	mOutputTrack
sampleCount	mStart = 0
sampleCount	mLen = 0

Additional Inherited Members
Public Types inherited from SpectrumTransformer
using	FloatVector = std::vector< float >
using	WindowProcessor = std::function< bool(SpectrumTransformer &) >
	Type of function that transforms windows in the queue. More...
Protected Attributes inherited from SpectrumTransformer
const size_t	mWindowSize
const size_t	mSpectrumSize
const unsigned	mStepsPerWindow
const size_t	mStepSize
const bool	mLeadingPadding
const bool	mTrailingPadding

Detailed Description

Subclass of SpectrumTransformer that rewrites a track.

Definition at line 183 of file SpectrumTransformer.h.

Constructor & Destructor Documentation

~TrackSpectrumTransformer()

TrackSpectrumTransformer::~TrackSpectrumTransformer ( )

overridedefault

Member Function Documentation

DoFinish()

bool TrackSpectrumTransformer::DoFinish ( )

overrideprotectedvirtual

Called after the last call to ProcessWindow().

Returns

false to abort processing. Default implementation just returns true.

Reimplemented from SpectrumTransformer.

Definition at line 378 of file SpectrumTransformer.cpp.

{
   if (mOutputTrack) {
      // Flush the output WaveTrack (since it's buffered)
      mOutputTrack->Flush();
 
      // Take the output track and insert it in place of the original
      // sample data
      auto t0 = mOutputTrack->LongSamplesToTime(mStart);
      auto tLen = mOutputTrack->LongSamplesToTime(mLen);
      // Filtering effects always end up with more data than they started with.
      // Delete this 'tail'.
      mOutputTrack->HandleClear(tLen, mOutputTrack->GetEndTime(), false, false);
      mpTrack->ClearAndPaste(t0, t0 + tLen, &*mOutputTrack, true, false);
   }
 
   mOutputTrack.reset();
   return true;
}

References WaveTrack::ClearAndPaste(), mLen, mOutputTrack, mpTrack, and mStart.

Referenced by EffectNoiseReduction::Worker::DoFinish(), and SpectralDataManager::Worker::DoFinish().

Here is the call graph for this function:

Here is the caller graph for this function:

DoOutput()

void TrackSpectrumTransformer::DoOutput ( const float *  outBuffer, size_t  mStepSize  )

overrideprotectedvirtual

Called within ProcessSamples if output was requested.

Implements SpectrumTransformer.

Definition at line 104 of file SpectrumTransformer.cpp.

{
   mOutputTrack->Append((constSamplePtr)outBuffer, floatSample, mStepSize);
}

References floatSample, mOutputTrack, and SpectrumTransformer::mStepSize.

DoStart()

bool TrackSpectrumTransformer::DoStart ( )

overrideprotectedvirtual

Called before any calls to ProcessWindow.

More queue initializations can be done here.

Returns

false to abort processing. Default implementation just returns true.

Reimplemented from SpectrumTransformer.

Definition at line 404 of file SpectrumTransformer.cpp.

{
   mOutputTrack = NeedsOutput() && mpTrack ? mpTrack->EmptyCopy() : nullptr;
   return SpectrumTransformer::DoStart();
}

References SpectrumTransformer::DoStart(), WaveTrack::EmptyCopy(), mOutputTrack, mpTrack, and SpectrumTransformer::NeedsOutput().

Referenced by EffectNoiseReduction::Worker::DoStart(), and SpectralDataManager::Worker::DoStart().

Here is the call graph for this function:

Here is the caller graph for this function:

Process()

bool TrackSpectrumTransformer::Process	(	const WindowProcessor &	processor,
		WaveTrack *	track,
		size_t	queueLength,
		sampleCount	start,
		sampleCount	len
	)

Invokes Start(), ProcessSamples(), and Finish()

Definition at line 341 of file SpectrumTransformer.cpp.

{
   if (!track)
      return false;
 
   mpTrack = track;
 
   if (!Start(queueLength))
      return false;
 
   mStart = start;
   mLen = len;
   auto bufferSize = track->GetMaxBlockSize();
   FloatVector buffer(bufferSize);
 
   bool bLoopSuccess = true;
   auto samplePos = start;
   while (bLoopSuccess && samplePos < start + len) {
      //Get a blockSize of samples (smaller than the size of the buffer)
      const auto blockSize = limitSampleBufferSize(
         std::min(bufferSize, track->GetBestBlockSize(samplePos)),
         start + len - samplePos);
 
      //Get the samples from the track and put them in the buffer
      track->GetFloats(buffer.data(), samplePos, blockSize);
      samplePos += blockSize;
 
      bLoopSuccess = ProcessSamples(processor, buffer.data(), blockSize);
   }
 
   if (!Finish(processor))
      return false;
 
   return bLoopSuccess;
}

References SpectrumTransformer::Finish(), WaveTrack::GetBestBlockSize(), SampleTrack::GetFloats(), WaveTrack::GetMaxBlockSize(), limitSampleBufferSize(), min(), mLen, mpTrack, mStart, SpectrumTransformer::ProcessSamples(), and SpectrumTransformer::Start().

Referenced by EffectNoiseReduction::Worker::Process(), SpectralDataManager::Worker::Process(), SpectralDataManager::Worker::ProcessOvertones(), and SpectralDataManager::Worker::ProcessSnapping().

Here is the call graph for this function:

Here is the caller graph for this function:

SpectrumTransformer()

SpectrumTransformer::SpectrumTransformer	(	bool	needsOutput,
		eWindowFunctions	inWindowType,
		eWindowFunctions	outWindowType,
		size_t	windowSize,
		unsigned	stepsPerWindow,
		bool	leadingPadding,
		bool	trailingPadding
	)

Precondition

!(inWindowType == eWinFuncRectangular && outWindowType eWinFuncRectangular)

windowSize % stepsPerWindow == 0

windowSize is a power of 2

Parameters

needsOutput	Whether to do the inverse FFT
inWindowType	Used in FFT transform
outWindowType	Used in inverse FFT transform
windowSize	must be a power of 2
stepsPerWindow	determines the overlap
leadingPadding	Whether to start the queue with windows that partially overlap the first full window of input samples
trailingPadding	Whether to stop the procedure after the last complete window of input is added to the queue

Definition at line 50 of file SpectrumTransformer.cpp.

: mWindowSize{ windowSize }
, mSpectrumSize{ 1 + mWindowSize / 2 }
, mStepsPerWindow{ stepsPerWindow }
, mStepSize{ mWindowSize / mStepsPerWindow }
, mLeadingPadding{ leadingPadding }
, mTrailingPadding{ trailingPadding }
, hFFT{ GetFFT(mWindowSize) }
, mFFTBuffer( mWindowSize )
, mInWaveBuffer( mWindowSize )
, mOutOverlapBuffer( mWindowSize )
, mNeedsOutput{ needsOutput }
{
   // Check preconditions
 
   // Powers of 2 only!
   wxASSERT(mWindowSize > 0 &&
      0 == (mWindowSize & (mWindowSize - 1)));
 
   wxASSERT(mWindowSize % mStepsPerWindow == 0);
 
   wxASSERT(!(inWindowType == eWinFuncRectangular && outWindowType == eWinFuncRectangular));
 
   // To do:  check that inWindowType, outWindowType, and mStepsPerWindow
   // are compatible for correct overlap-add reconstruction.
 
   // Create windows as needed
   if (inWindowType != eWinFuncRectangular) {
      mInWindow.resize(mWindowSize);
      std::fill(mInWindow.begin(), mInWindow.end(), 1.0f);
      NewWindowFunc(inWindowType, mWindowSize, false, mInWindow.data());
   }
   if (outWindowType != eWinFuncRectangular) {
      mOutWindow.resize(mWindowSize);
      std::fill(mOutWindow.begin(), mOutWindow.end(), 1.0f);
      NewWindowFunc(outWindowType, mWindowSize, false, mOutWindow.data());
   }
 
   // Must scale one or the other window so overlap-add
   // comes out right
   double denom = 0;
   for (size_t ii = 0; ii < mWindowSize; ii += mStepSize) {
      denom +=
         (mInWindow.empty() ? 1.0 : mInWindow[ii])
         *
         (mOutWindow.empty() ? 1.0 : mOutWindow[ii]);
   }
   // It is ASSUMED that you have chosen window types and
   // steps per window, so that this sum denom would be the
   // same, starting the march anywhere from 0 to mStepSize - 1.
   // Else, your overlap-add won't be right, and the transformer
   // might not be an identity even when you do nothing to the
   // spectra.
 
   float *pWindow = 0;
   if (!mInWindow.empty())
      pWindow = mInWindow.data();
   else if (!mOutWindow.empty())
      pWindow = mOutWindow.data();
   else
      // Can only happen if both window types were rectangular
      wxASSERT(false);
   for (size_t ii = 0; ii < mWindowSize; ++ii)
      *pWindow++ /= denom;
}

Member Data Documentation

mLen

sampleCount TrackSpectrumTransformer::mLen = 0

private

Definition at line 200 of file SpectrumTransformer.h.

Referenced by DoFinish(), and Process().

mOutputTrack

std::shared_ptr<WaveTrack> TrackSpectrumTransformer::mOutputTrack

private

Definition at line 199 of file SpectrumTransformer.h.

Referenced by DoFinish(), DoOutput(), and DoStart().

mpTrack

WaveTrack* TrackSpectrumTransformer::mpTrack = nullptr

private

Definition at line 198 of file SpectrumTransformer.h.

Referenced by DoFinish(), DoStart(), and Process().

mStart

sampleCount TrackSpectrumTransformer::mStart = 0

private

Definition at line 200 of file SpectrumTransformer.h.

Referenced by DoFinish(), and Process().

---

The documentation for this class was generated from the following files:

• SpectrumTransformer.h
• SpectrumTransformer.cpp