NyquistBase::NyxContext Struct Reference

Collaboration diagram for NyquistBase::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 598 of file NyquistBase.cpp.

Member Typedef Documentation

Buffer

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

Definition at line 626 of file NyquistBase.cpp.

ProgressReport

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

Definition at line 600 of file NyquistBase.cpp.

Constructor & Destructor Documentation

NyxContext()

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

inline

Definition at line 602 of file NyquistBase.cpp.

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

Member Function Documentation

GetCallback()

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

Definition at line 2616 of file NyquistBase.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 NyquistBase::NyxContext::PutCallback	(	float *	buffer,
		int	channel,
		int64_t	start,
		int64_t	len,
		int64_t	totlen
	)

Definition at line 2682 of file NyquistBase.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 NyquistBase::NyxContext::StaticGetCallback ( float *  buffer, int  channel, int64_t  start, int64_t  len, int64_t  totlen, void *  userdata  )

static

Definition at line 2608 of file NyquistBase.cpp.

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

References GetCallback().

Referenced by NyquistBase::ProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

StaticPutCallback()

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

static

Definition at line 2674 of file NyquistBase.cpp.

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

References PutCallback().

Referenced by NyquistBase::ProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mCurBuffer

Buffer NyquistBase::NyxContext::mCurBuffer[2]

used only in GetCallback

Definition at line 627 of file NyquistBase.cpp.

mCurBufferLen

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

Definition at line 629 of file NyquistBase.cpp.

mCurBufferStart

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

Definition at line 628 of file NyquistBase.cpp.

mCurChannelGroup

WaveTrack* NyquistBase::NyxContext::mCurChannelGroup {}

Definition at line 620 of file NyquistBase.cpp.

Referenced by NyquistBase::ProcessOne().

mCurLen

sampleCount NyquistBase::NyxContext::mCurLen {}

Definition at line 630 of file NyquistBase.cpp.

Referenced by NyquistBase::ProcessOne().

mCurNumChannels

unsigned NyquistBase::NyxContext::mCurNumChannels {}

Not used in the callbacks.

Definition at line 624 of file NyquistBase.cpp.

Referenced by NyquistBase::ProcessOne().

mCurStart

sampleCount NyquistBase::NyxContext::mCurStart {}

Definition at line 622 of file NyquistBase.cpp.

mCurTrack

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

Definition at line 621 of file NyquistBase.cpp.

Referenced by NyquistBase::ProcessOne().

mOutputTrack

WaveTrack::Holder NyquistBase::NyxContext::mOutputTrack

Definition at line 632 of file NyquistBase.cpp.

Referenced by NyquistBase::ProcessOne().

mpException

std::exception_ptr NyquistBase::NyxContext::mpException {}

Definition at line 641 of file NyquistBase.cpp.

Referenced by NyquistBase::ProcessOne().

mProgressIn

double NyquistBase::NyxContext::mProgressIn {}

Definition at line 634 of file NyquistBase.cpp.

mProgressOut

double NyquistBase::NyxContext::mProgressOut {}

Definition at line 635 of file NyquistBase.cpp.

mProgressReport

const ProgressReport NyquistBase::NyxContext::mProgressReport

Definition at line 637 of file NyquistBase.cpp.

mProgressTot

const double NyquistBase::NyxContext::mProgressTot

Definition at line 639 of file NyquistBase.cpp.

mScale

const double NyquistBase::NyxContext::mScale

Definition at line 638 of file NyquistBase.cpp.

---

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

• NyquistBase.cpp