NyquistEffect::NyxContext Struct Reference

Collaboration diagram for NyquistEffect::NyxContext:

Public Types
using	ProgressReport = std::function< bool(double)>
using	Buffer = std::unique_ptr< float[]>

Public Member Functions
	NyxContext (ProgressReport progressReport, double scale, double progressTot)
int	GetCallback (float *buffer, int channel, int64_t start, int64_t len, int64_t totlen)
int	PutCallback (float *buffer, int channel, int64_t start, int64_t len, int64_t totlen)

Static Public Member Functions
static int	StaticGetCallback (float *buffer, int channel, int64_t start, int64_t len, int64_t totlen, void *userdata)
static int	StaticPutCallback (float *buffer, int channel, int64_t start, int64_t len, int64_t totlen, void *userdata)

Public Attributes
WaveTrack *	mCurChannelGroup {}
WaveChannel *	mCurTrack [2] {}
sampleCount	mCurStart {}
unsigned	mCurNumChannels {}
	Not used in the callbacks. More...
Buffer	mCurBuffer [2]
	used only in GetCallback More...
sampleCount	mCurBufferStart [2] {}
size_t	mCurBufferLen [2] {}
sampleCount	mCurLen {}
WaveTrack::Holder	mOutputTrack
double	mProgressIn {}
double	mProgressOut {}
const ProgressReport	mProgressReport
const double	mScale
const double	mProgressTot
std::exception_ptr	mpException {}

Detailed Description

Reads and writes Audacity's track objects, interchanging with Nyquist sound objects (implemented in the library layer written in C)

Definition at line 668 of file Nyquist.cpp.

Member Typedef Documentation

Buffer

using NyquistEffect::NyxContext::Buffer = std::unique_ptr<float[]>

Definition at line 692 of file Nyquist.cpp.

ProgressReport

using NyquistEffect::NyxContext::ProgressReport = std::function<bool(double)>

Definition at line 669 of file Nyquist.cpp.

Constructor & Destructor Documentation

NyxContext()

NyquistEffect::NyxContext::NyxContext ( ProgressReport  progressReport, double  scale, double  progressTot  )

inline

Definition at line 671 of file Nyquist.cpp.

      : mProgressReport{ move(progressReport) }
      , mScale{ scale }
      , mProgressTot{ progressTot }
   {}

Member Function Documentation

GetCallback()

int NyquistEffect::NyxContext::GetCallback	(	float *	buffer,
		int	channel,
		int64_t	start,
		int64_t	len,
		int64_t	totlen
	)

Definition at line 2562 of file Nyquist.cpp.

{
   if (mCurBuffer[ch]) {
      if ((mCurStart + start) < mCurBufferStart[ch] ||
          (mCurStart + start) + len >
          mCurBufferStart[ch] + mCurBufferLen[ch]) {
         mCurBuffer[ch].reset();
      }
   }
 
   if (!mCurBuffer[ch]) {
      mCurBufferStart[ch] = (mCurStart + start);
      mCurBufferLen[ch] = mCurTrack[ch]->GetBestBlockSize(mCurBufferStart[ch]);
 
      if (mCurBufferLen[ch] < (size_t) len)
         mCurBufferLen[ch] = mCurTrack[ch]->GetIdealBlockSize();
 
      mCurBufferLen[ch] = limitSampleBufferSize(mCurBufferLen[ch],
         mCurStart + mCurLen - mCurBufferStart[ch]);
 
      // C++20
      // mCurBuffer[ch] = std::make_unique_for_overwrite(mCurBufferLen[ch]);
      mCurBuffer[ch] = Buffer{ safenew float[ mCurBufferLen[ch] ] };
      try {
         mCurTrack[ch]->GetFloats( mCurBuffer[ch].get(),
            mCurBufferStart[ch], mCurBufferLen[ch]);
      }
      catch ( ... ) {
         // Save the exception object for re-throw when out of the library
         mpException = std::current_exception();
         return -1;
      }
   }
 
   // We have guaranteed above that this is nonnegative and bounded by
   // mCurBufferLen[ch]:
   auto offset = (mCurStart + start - mCurBufferStart[ch]).as_size_t();
   const void *src = &mCurBuffer[ch][offset];
   std::memcpy(buffer, src, len * sizeof(float));
 
   if (ch == 0) {
      double progress = mScale * ((start + len) / mCurLen.as_double());
      if (progress > mProgressIn)
         mProgressIn = progress;
      if (mProgressReport(mProgressIn + mProgressOut + mProgressTot))
         return -1;
   }
 
   return 0;
}

References limitSampleBufferSize(), and safenew.

Referenced by StaticGetCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

PutCallback()

int NyquistEffect::NyxContext::PutCallback	(	float *	buffer,
		int	channel,
		int64_t	start,
		int64_t	len,
		int64_t	totlen
	)

Definition at line 2621 of file Nyquist.cpp.

{
   // Don't let C++ exceptions propagate through the Nyquist library
   return GuardedCall<int>( [&] {
      if (channel == 0) {
         double progress = mScale * ((float)(start + len) / totlen);
         if (progress > mProgressOut)
            mProgressOut = progress;
         if (mProgressReport(mProgressIn + mProgressOut + mProgressTot))
            return -1;
      }
 
      auto iChannel = mOutputTrack->Channels().begin();
      std::advance(iChannel, channel);
      const auto pChannel = *iChannel;
      pChannel->Append((samplePtr)buffer, floatSample, len);
 
      return 0; // success
   }, MakeSimpleGuard(-1)); // translate all exceptions into failure
}

References floatSample, anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, and MakeSimpleGuard().

Referenced by StaticPutCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

StaticGetCallback()

int NyquistEffect::NyxContext::StaticGetCallback ( float *  buffer, int  channel, int64_t  start, int64_t  len, int64_t  totlen, void *  userdata  )

static

Definition at line 2555 of file Nyquist.cpp.

{
   auto This = static_cast<NyxContext*>(userdata);
   return This->GetCallback(buffer, channel, start, len, totlen);
}

References GetCallback().

Referenced by NyquistEffect::ProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

StaticPutCallback()

int NyquistEffect::NyxContext::StaticPutCallback ( float *  buffer, int  channel, int64_t  start, int64_t  len, int64_t  totlen, void *  userdata  )

static

Definition at line 2614 of file Nyquist.cpp.

{
   auto This = static_cast<NyxContext*>(userdata);
   return This->PutCallback(buffer, channel, start, len, totlen);
}

References PutCallback().

Referenced by NyquistEffect::ProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mCurBuffer

Buffer NyquistEffect::NyxContext::mCurBuffer[2]

used only in GetCallback

Definition at line 693 of file Nyquist.cpp.

mCurBufferLen

size_t NyquistEffect::NyxContext::mCurBufferLen[2] {}

Definition at line 695 of file Nyquist.cpp.

mCurBufferStart

sampleCount NyquistEffect::NyxContext::mCurBufferStart[2] {}

Definition at line 694 of file Nyquist.cpp.

mCurChannelGroup

WaveTrack* NyquistEffect::NyxContext::mCurChannelGroup {}

Definition at line 686 of file Nyquist.cpp.

Referenced by NyquistEffect::ProcessOne().

mCurLen

sampleCount NyquistEffect::NyxContext::mCurLen {}

Definition at line 696 of file Nyquist.cpp.

Referenced by NyquistEffect::ProcessOne().

mCurNumChannels

unsigned NyquistEffect::NyxContext::mCurNumChannels {}

Not used in the callbacks.

Definition at line 690 of file Nyquist.cpp.

Referenced by NyquistEffect::ProcessOne().

mCurStart

sampleCount NyquistEffect::NyxContext::mCurStart {}

Definition at line 688 of file Nyquist.cpp.

mCurTrack

WaveChannel* NyquistEffect::NyxContext::mCurTrack[2] {}

Definition at line 687 of file Nyquist.cpp.

Referenced by NyquistEffect::ProcessOne().

mOutputTrack

WaveTrack::Holder NyquistEffect::NyxContext::mOutputTrack

Definition at line 698 of file Nyquist.cpp.

Referenced by NyquistEffect::ProcessOne().

mpException

std::exception_ptr NyquistEffect::NyxContext::mpException {}

Definition at line 707 of file Nyquist.cpp.

Referenced by NyquistEffect::ProcessOne().

mProgressIn

double NyquistEffect::NyxContext::mProgressIn {}

Definition at line 700 of file Nyquist.cpp.

mProgressOut

double NyquistEffect::NyxContext::mProgressOut {}

Definition at line 701 of file Nyquist.cpp.

mProgressReport

const ProgressReport NyquistEffect::NyxContext::mProgressReport

Definition at line 703 of file Nyquist.cpp.

mProgressTot

const double NyquistEffect::NyxContext::mProgressTot

Definition at line 705 of file Nyquist.cpp.

mScale

const double NyquistEffect::NyxContext::mScale

Definition at line 704 of file Nyquist.cpp.

---

The documentation for this struct was generated from the following file:

• Nyquist.cpp