SqliteSampleBlock Class Reference

Implementation of SampleBlock using Sqlite database. More...

Inheritance diagram for SqliteSampleBlock:

Collaboration diagram for SqliteSampleBlock:

Public Types
using	Sizes = std::pair< size_t, size_t >
	Numbers of bytes needed for 256 and for 64k summaries. More...

Public Member Functions
BlockSampleView	GetFloatSampleView (bool mayThrow) override
	SqliteSampleBlock (const std::shared_ptr< SqliteSampleBlockFactory > &pFactory)
	~SqliteSampleBlock () override
void	CloseLock () noexcept override
void	SetSamples (constSamplePtr src, size_t numsamples, sampleFormat srcformat)
void	Commit (Sizes sizes)
void	Delete ()
SampleBlockID	GetBlockID () const override
size_t	DoGetSamples (samplePtr dest, sampleFormat destformat, size_t sampleoffset, size_t numsamples) override
sampleFormat	GetSampleFormat () const override
size_t	GetSampleCount () const override
bool	GetSummary256 (float *dest, size_t frameoffset, size_t numframes) override
	Non-throwing, should fill with zeroes on failure. More...
bool	GetSummary64k (float *dest, size_t frameoffset, size_t numframes) override
	Non-throwing, should fill with zeroes on failure. More...
double	GetSumMin () const
double	GetSumMax () const
double	GetSumRms () const
MinMaxRMS	DoGetMinMaxRMS (size_t start, size_t len) override
	Gets extreme values for the specified region. More...
MinMaxRMS	DoGetMinMaxRMS () const override
	Gets extreme values for the entire block. More...
size_t	GetSpaceUsage () const override
void	SaveXML (XMLWriter &xmlFile) override
Public Member Functions inherited from SampleBlock
virtual	~SampleBlock ()
virtual void	CloseLock () noexcept=0
virtual SampleBlockID	GetBlockID () const =0
size_t	GetSamples (samplePtr dest, sampleFormat destformat, size_t sampleoffset, size_t numsamples, bool mayThrow=true)
virtual BlockSampleView	GetFloatSampleView (bool mayThrow)=0
virtual sampleFormat	GetSampleFormat () const =0
virtual size_t	GetSampleCount () const =0
virtual bool	GetSummary256 (float *dest, size_t frameoffset, size_t numframes)=0
	Non-throwing, should fill with zeroes on failure. More...
virtual bool	GetSummary64k (float *dest, size_t frameoffset, size_t numframes)=0
	Non-throwing, should fill with zeroes on failure. More...
MinMaxRMS	GetMinMaxRMS (size_t start, size_t len, bool mayThrow=true)
	Gets extreme values for the specified region. More...
MinMaxRMS	GetMinMaxRMS (bool mayThrow=true) const
	Gets extreme values for the entire block. More...
virtual size_t	GetSpaceUsage () const =0
virtual void	SaveXML (XMLWriter &xmlFile)=0

Private Types
enum	{ fields = 3 , bytesPerFrame = fields * sizeof(float) }

Private Member Functions
bool	IsSilent () const
void	Load (SampleBlockID sbid)
bool	GetSummary (float *dest, size_t frameoffset, size_t numframes, DBConnection::StatementID id, const char *sql)
size_t	GetBlob (void *dest, sampleFormat destformat, sqlite3_stmt *stmt, sampleFormat srcformat, size_t srcoffset, size_t srcbytes)
Sizes	SetSizes (size_t numsamples, sampleFormat srcformat)
void	CalcSummary (Sizes sizes)
DBConnection *	Conn () const
	This must never be called for silent blocks. More...
sqlite3 *	DB () const

Private Attributes
std::weak_ptr< std::vector< float > >	mCache
std::mutex	mCacheMutex
friend	SqliteSampleBlockFactory
const std::shared_ptr< SqliteSampleBlockFactory >	mpFactory
bool	mValid { false }
bool	mLocked = false
SampleBlockID	mBlockID { 0 }
ArrayOf< char >	mSamples
size_t	mSampleBytes
size_t	mSampleCount
sampleFormat	mSampleFormat
ArrayOf< char >	mSummary256
ArrayOf< char >	mSummary64k
double	mSumMin
double	mSumMax
double	mSumRms

Additional Inherited Members
virtual size_t	DoGetSamples (samplePtr dest, sampleFormat destformat, size_t sampleoffset, size_t numsamples)=0
virtual MinMaxRMS	DoGetMinMaxRMS (size_t start, size_t len)=0
virtual MinMaxRMS	DoGetMinMaxRMS () const =0

Detailed Description

Implementation of SampleBlock using Sqlite database.

Definition at line 35 of file SqliteSampleBlock.cpp.

Member Typedef Documentation

Sizes

using SqliteSampleBlock::Sizes = std::pair< size_t, size_t >

Numbers of bytes needed for 256 and for 64k summaries.

Definition at line 55 of file SqliteSampleBlock.cpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
fields
bytesPerFrame

Definition at line 99 of file SqliteSampleBlock.cpp.

        {
      fields = 3, /* min, max, rms */
      bytesPerFrame = fields * sizeof(float),
   };

Constructor & Destructor Documentation

SqliteSampleBlock()

SqliteSampleBlock::SqliteSampleBlock ( const std::shared_ptr< SqliteSampleBlockFactory > &  pFactory )

explicit

Definition at line 334 of file SqliteSampleBlock.cpp.

:  mpFactory(pFactory)
{
   mSampleFormat = floatSample;
   mSampleBytes = 0;
   mSampleCount = 0;
 
   mSumMin = 0.0;
   mSumMax = 0.0;
   mSumRms = 0.0;
}

References floatSample, mSampleBytes, mSampleCount, mSampleFormat, mSumMax, mSumMin, and mSumRms.

~SqliteSampleBlock()

SqliteSampleBlock::~SqliteSampleBlock ( )

override

Definition at line 347 of file SqliteSampleBlock.cpp.

{
   if (mpFactory) {
      mpFactory->OnSampleBlockDtor(*this);
   }
 
   if (IsSilent()) {
      // The block object was constructed but failed to Load() or Commit().
      // Or it's a silent block with no row in the database.
      // Just let the stack unwind.  Don't violate the assertion in
      // Delete(), which may do odd recursive things in debug builds when it
      // yields to the UI to put up a dialog, but then dispatches timer
      // events that try again to finish recording.
      return;
   }
 
   // See ProjectFileIO::Bypass() for a description of mIO.mBypass
   GuardedCall( [this]{
      if (!mLocked && !Conn()->ShouldBypass())
      {
         // In case Delete throws, don't let an exception escape a destructor,
         // but we can still enqueue the delayed handler so that an error message
         // is presented to the user.
         // The failure in this case may be a less harmful waste of space in the
         // database, which should not cause aborting of the attempted edit.
         Delete();
      }
   } );
}

References Conn(), Delete(), GuardedCall(), IsSilent(), mLocked, and mpFactory.

Here is the call graph for this function:

Member Function Documentation

CalcSummary()

void SqliteSampleBlock::CalcSummary ( Sizes  sizes )

private

Calculates summary block data describing this sample data.

This method also has the side effect of setting the mSumMin, mSumMax, and mSumRms members of this class.

Definition at line 909 of file SqliteSampleBlock.cpp.

{
   const auto mSummary256Bytes = sizes.first;
   const auto mSummary64kBytes = sizes.second;
 
   Floats samplebuffer;
   float *samples;
 
   if (mSampleFormat == floatSample)
   {
      samples = (float *) mSamples.get();
   }
   else
   {
      samplebuffer.reinit((unsigned) mSampleCount);
      SamplesToFloats(mSamples.get(), mSampleFormat,
         samplebuffer.get(), mSampleCount);
      samples = samplebuffer.get();
   }
 
   mSummary256.reinit(mSummary256Bytes);
   mSummary64k.reinit(mSummary64kBytes);
 
   float *summary256 = (float *) mSummary256.get();
   float *summary64k = (float *) mSummary64k.get();
 
   float min;
   float max;
   float sumsq;
   double totalSquares = 0.0;
   double fraction = 0.0;
 
   // Recalc 256 summaries
   int sumLen = (mSampleCount + 255) / 256;
   int summaries = 256;
 
   for (int i = 0; i < sumLen; ++i)
   {
      min = samples[i * 256];
      max = samples[i * 256];
      sumsq = min * min;
 
      int jcount = 256;
      if (jcount > mSampleCount - i * 256)
      {
         jcount = mSampleCount - i * 256;
         fraction = 1.0 - (jcount / 256.0);
      }
 
      for (int j = 1; j < jcount; ++j)
      {
         float f1 = samples[i * 256 + j];
         sumsq += f1 * f1;
 
         if (f1 < min)
         {
            min = f1;
         }
         else if (f1 > max)
         {
            max = f1;
         }
      }
 
      totalSquares += sumsq;
 
      summary256[i * fields] = min;
      summary256[i * fields + 1] = max;
      // The rms is correct, but this may be for less than 256 samples in last loop.
      summary256[i * fields + 2] = (float) sqrt(sumsq / jcount);
   }
 
   for (int i = sumLen, frames256 = mSummary256Bytes / bytesPerFrame;
        i < frames256; ++i)
   {
      // filling in the remaining bits with non-harming/contributing values
      // rms values are not "non-harming", so keep count of them:
      summaries--;
      summary256[i * fields] = FLT_MAX;        // min
      summary256[i * fields + 1] = -FLT_MAX;   // max
      summary256[i * fields + 2] = 0.0f;       // rms
   }
 
   // Calculate now while we can do it accurately
   mSumRms = sqrt(totalSquares / mSampleCount);
 
   // Recalc 64K summaries
   sumLen = (mSampleCount + 65535) / 65536;
 
   for (int i = 0; i < sumLen; ++i)
   {
      min = summary256[3 * i * 256];
      max = summary256[3 * i * 256 + 1];
      sumsq = summary256[3 * i * 256 + 2];
      sumsq *= sumsq;
 
      for (int j = 1; j < 256; ++j)
      {
         // we can overflow the useful summary256 values here, but have put
         // non-harmful values in them
         if (summary256[3 * (i * 256 + j)] < min)
         {
            min = summary256[3 * (i * 256 + j)];
         }
 
         if (summary256[3 * (i * 256 + j) + 1] > max)
         {
            max = summary256[3 * (i * 256 + j) + 1];
         }
 
         float r1 = summary256[3 * (i * 256 + j) + 2];
         sumsq += r1 * r1;
      }
 
      double denom = (i < sumLen - 1) ? 256.0 : summaries - fraction;
      float rms = (float) sqrt(sumsq / denom);
 
      summary64k[i * fields] = min;
      summary64k[i * fields + 1] = max;
      summary64k[i * fields + 2] = rms;
   }
 
   for (int i = sumLen, frames64k = mSummary64kBytes / bytesPerFrame;
        i < frames64k; ++i)
   {
      wxASSERT_MSG(false, wxT("Out of data for mSummaryInfo"));   // Do we ever get here?
 
      summary64k[i * fields] = 0.0f;     // probably should be FLT_MAX, need a test case
      summary64k[i * fields + 1] = 0.0f; // probably should be -FLT_MAX, need a test case
      summary64k[i * fields + 2] = 0.0f; // just padding
   }
 
   // Recalc block-level summary (mRMS already calculated)
   min = summary64k[0];
   max = summary64k[1];
 
   for (int i = 1; i < sumLen; ++i)
   {
      if (summary64k[i * fields] < min)
      {
         min = summary64k[i * fields];
      }
 
      if (summary64k[i * fields + 1] > max)
      {
         max = summary64k[i * fields + 1];
      }
   }
 
   mSumMin = min;
   mSumMax = max;
}

References bytesPerFrame, fields, floatSample, min(), mSampleCount, mSampleFormat, mSamples, mSummary256, mSummary64k, mSumMax, mSumMin, mSumRms, ArrayOf< X >::reinit(), SamplesToFloats(), staffpad::audio::simd::sqrt(), and wxT().

Referenced by SetSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

CloseLock()

void SqliteSampleBlock::CloseLock ( )

overridevirtualnoexcept

Implements SampleBlock.

Definition at line 395 of file SqliteSampleBlock.cpp.

{
   mLocked = true;
}

References mLocked.

Commit()

void SqliteSampleBlock::Commit

(

Sizes

sizes

)

Definition at line 770 of file SqliteSampleBlock.cpp.

{
   const auto mSummary256Bytes = sizes.first;
   const auto mSummary64kBytes = sizes.second;
 
   auto db = DB();
   int rc;
 
   // Prepare and cache statement...automatically finalized at DB close
   sqlite3_stmt *stmt = Conn()->Prepare(DBConnection::InsertSampleBlock,
      "INSERT INTO sampleblocks (sampleformat, summin, summax, sumrms,"
      "                          summary256, summary64k, samples)"
      "                         VALUES(?1,?2,?3,?4,?5,?6,?7);");
 
   // Bind statement parameters
   // Might return SQLITE_MISUSE which means it's our mistake that we violated
   // preconditions; should return SQL_OK which is 0
   if (sqlite3_bind_int(stmt, 1, static_cast<int>(mSampleFormat)) ||
       sqlite3_bind_double(stmt, 2, mSumMin) ||
       sqlite3_bind_double(stmt, 3, mSumMax) ||
       sqlite3_bind_double(stmt, 4, mSumRms) ||
       sqlite3_bind_blob(stmt, 5, mSummary256.get(), mSummary256Bytes, SQLITE_STATIC) ||
       sqlite3_bind_blob(stmt, 6, mSummary64k.get(), mSummary64kBytes, SQLITE_STATIC) ||
       sqlite3_bind_blob(stmt, 7, mSamples.get(), mSampleBytes, SQLITE_STATIC))
   {
 
      ADD_EXCEPTION_CONTEXT(
         "sqlite3.rc", std::to_string(sqlite3_errcode(Conn()->DB())));
      ADD_EXCEPTION_CONTEXT("sqlite3.context", "SqliteSampleBlock::Commit::bind");
 
 
      wxASSERT_MSG(false, wxT("Binding failed...bug!!!"));
   }
 
   // Execute the statement
   rc = sqlite3_step(stmt);
   if (rc != SQLITE_DONE)
   {
      ADD_EXCEPTION_CONTEXT("sqlite3.rc", std::to_string(rc));
      ADD_EXCEPTION_CONTEXT("sqlite3.context", "SqliteSampleBlock::Commit::step");
 
      wxLogDebug(wxT("SqliteSampleBlock::Commit - SQLITE error %s"), sqlite3_errmsg(db));
 
      // Clear statement bindings and rewind statement
      sqlite3_clear_bindings(stmt);
      sqlite3_reset(stmt);
 
      // Just showing the user a simple message, not the library error too
      // which isn't internationalized
      Conn()->ThrowException( true );
   }
 
   // Retrieve returned data
   mBlockID = sqlite3_last_insert_rowid(db);
 
   // Reset local arrays
   mSamples.reset();
   mSummary256.reset();
   mSummary64k.reset();
   {
      std::lock_guard<std::mutex> lock(mCacheMutex);
      mCache.reset();
   }
 
   // Clear statement bindings and rewind statement
   sqlite3_clear_bindings(stmt);
   sqlite3_reset(stmt);
 
   mValid = true;
}

References ADD_EXCEPTION_CONTEXT, Conn(), DB(), DBConnection::InsertSampleBlock, mBlockID, mCache, mCacheMutex, mSampleBytes, mSampleFormat, mSamples, mSummary256, mSummary64k, mSumMax, mSumMin, mSumRms, mValid, DBConnection::Prepare(), DBConnection::ThrowException(), and wxT().

Referenced by SetSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

Conn()

DBConnection * SqliteSampleBlock::Conn ( ) const

private

This must never be called for silent blocks.

Postcondition

return value is not null

Definition at line 377 of file SqliteSampleBlock.cpp.

{
   if (!mpFactory)
      return nullptr;
 
   auto &pConnection = mpFactory->mppConnection->mpConnection;
   if (!pConnection) {
      throw SimpleMessageBoxException
      {
         ExceptionType::Internal,
         XO("Connection to project file is null"),
         XO("Warning"),
         "Error:_Disk_full_or_not_writable"
      };
   }
   return pConnection.get();
}

References Internal, mpFactory, and XO().

Referenced by Commit(), DB(), Delete(), DoGetSamples(), GetBlob(), GetSpaceUsage(), GetSummary(), Load(), and ~SqliteSampleBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

DB()

sqlite3 * SqliteSampleBlock::DB ( ) const

inlineprivate

Definition at line 110 of file SqliteSampleBlock.cpp.

   {
      return Conn()->DB();
   }

References Conn(), and DBConnection::DB().

Referenced by Commit(), Delete(), GetBlob(), and Load().

Here is the call graph for this function:

Here is the caller graph for this function:

Delete()

void SqliteSampleBlock::Delete

(

)

Definition at line 841 of file SqliteSampleBlock.cpp.

{
   auto db = DB();
   int rc;
 
   wxASSERT(!IsSilent());
 
   // Prepare and cache statement...automatically finalized at DB close
   sqlite3_stmt *stmt = Conn()->Prepare(DBConnection::DeleteSampleBlock,
      "DELETE FROM sampleblocks WHERE blockid = ?1;");
 
   // Bind statement parameters
   // Might return SQLITE_MISUSE which means it's our mistake that we violated
   // preconditions; should return SQL_OK which is 0
   if (sqlite3_bind_int64(stmt, 1, mBlockID))
   {
      ADD_EXCEPTION_CONTEXT(
         "sqlite3.rc", std::to_string(sqlite3_errcode(Conn()->DB())));
      ADD_EXCEPTION_CONTEXT("sqlite3.context", "SqliteSampleBlock::Delete::bind");
 
      wxASSERT_MSG(false, wxT("Binding failed...bug!!!"));
   }
 
   // Execute the statement
   rc = sqlite3_step(stmt);
   if (rc != SQLITE_DONE)
   {
      ADD_EXCEPTION_CONTEXT("sqlite3.rc", std::to_string(rc));
      ADD_EXCEPTION_CONTEXT("sqlite3.context", "SqliteSampleBlock::Delete::step");
 
      wxLogDebug(wxT("SqliteSampleBlock::Load - SQLITE error %s"), sqlite3_errmsg(db));
 
      // Clear statement bindings and rewind statement
      sqlite3_clear_bindings(stmt);
      sqlite3_reset(stmt);
 
      // Just showing the user a simple message, not the library error too
      // which isn't internationalized
      Conn()->ThrowException( true );
   }
 
   // Clear statement bindings and rewind statement
   sqlite3_clear_bindings(stmt);
   sqlite3_reset(stmt);
}

References ADD_EXCEPTION_CONTEXT, Conn(), DB(), DBConnection::DeleteSampleBlock, IsSilent(), mBlockID, DBConnection::Prepare(), DBConnection::ThrowException(), and wxT().

Referenced by ~SqliteSampleBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

DoGetMinMaxRMS() [1/2]

MinMaxRMS SqliteSampleBlock::DoGetMinMaxRMS ( ) const

overridevirtual

Gets extreme values for the entire block.

Retrieves the minimum, maximum, and maximum RMS of this entire block. This is faster than the other GetMinMax function since these values are already computed.

Implements SampleBlock.

Definition at line 565 of file SqliteSampleBlock.cpp.

{
   return { (float) mSumMin, (float) mSumMax, (float) mSumRms };
}

References mSumMax, mSumMin, and mSumRms.

DoGetMinMaxRMS() [2/2]

MinMaxRMS SqliteSampleBlock::DoGetMinMaxRMS ( size_t  start, size_t  len  )

overridevirtual

Gets extreme values for the specified region.

Retrieves the minimum, maximum, and maximum RMS of the specified sample data in this block.

Parameters

start	The offset in this block where the region should begin
len	The number of samples to include in the region

Implements SampleBlock.

Definition at line 518 of file SqliteSampleBlock.cpp.

{
   if (IsSilent())
      return {};
 
   float min = FLT_MAX;
   float max = -FLT_MAX;
   float sumsq = 0;
 
   if (!mValid)
   {
      Load(mBlockID);
   }
 
   if (start < mSampleCount)
   {
      len = std::min(len, mSampleCount - start);
 
      // TODO: actually use summaries
      SampleBuffer blockData(len, floatSample);
      float *samples = (float *) blockData.ptr();
 
      size_t copied = DoGetSamples((samplePtr) samples, floatSample, start, len);
      for (size_t i = 0; i < copied; ++i, ++samples)
      {
         float sample = *samples;
 
         if (sample > max)
         {
            max = sample;
         }
 
         if (sample < min)
         {
            min = sample;
         }
 
         sumsq += (sample * sample);
      }
   }
 
   return { min, max, (float) sqrt(sumsq / len) };
}

References DoGetSamples(), floatSample, IsSilent(), Load(), mBlockID, min(), mSampleCount, mValid, SampleBuffer::ptr(), and staffpad::audio::simd::sqrt().

Here is the call graph for this function:

DoGetSamples()

size_t SqliteSampleBlock::DoGetSamples ( samplePtr  dest, sampleFormat  destformat, size_t  sampleoffset, size_t  numsamples  )

overridevirtual

Implements SampleBlock.

Definition at line 415 of file SqliteSampleBlock.cpp.

{
   if (IsSilent()) {
      auto size = SAMPLE_SIZE(destformat);
      memset(dest, 0, numsamples * size);
      return numsamples;
   }
 
   // Prepare and cache statement...automatically finalized at DB close
   sqlite3_stmt *stmt = Conn()->Prepare(DBConnection::GetSamples,
      "SELECT samples FROM sampleblocks WHERE blockid = ?1;");
 
   return GetBlob(dest,
                  destformat,
                  stmt,
                  mSampleFormat,
                  sampleoffset * SAMPLE_SIZE(mSampleFormat),
                  numsamples * SAMPLE_SIZE(mSampleFormat)) / SAMPLE_SIZE(mSampleFormat);
}

References Conn(), GetBlob(), DBConnection::GetSamples, IsSilent(), mSampleFormat, DBConnection::Prepare(), SAMPLE_SIZE, and size.

Referenced by DoGetMinMaxRMS(), and GetFloatSampleView().

Here is the call graph for this function:

Here is the caller graph for this function:

GetBlob()

size_t SqliteSampleBlock::GetBlob ( void *  dest, sampleFormat  destformat, sqlite3_stmt *  stmt, sampleFormat  srcformat, size_t  srcoffset, size_t  srcbytes  )

private

Definition at line 578 of file SqliteSampleBlock.cpp.

{
   auto db = DB();
 
   wxASSERT(!IsSilent());
 
   if (!mValid)
   {
      Load(mBlockID);
   }
 
   int rc;
   size_t minbytes = 0;
 
   // Bind statement parameters
   // Might return SQLITE_MISUSE which means it's our mistake that we violated
   // preconditions; should return SQL_OK which is 0
   if (sqlite3_bind_int64(stmt, 1, mBlockID))
   {
      ADD_EXCEPTION_CONTEXT(
         "sqlite3.rc", std::to_string(sqlite3_errcode(Conn()->DB())));
      ADD_EXCEPTION_CONTEXT("sqlite3.context", "SqliteSampleBlock::GetBlob::bind");
 
      wxASSERT_MSG(false, wxT("Binding failed...bug!!!"));
   }
 
   // Execute the statement
   rc = sqlite3_step(stmt);
   if (rc != SQLITE_ROW)
   {
      ADD_EXCEPTION_CONTEXT("sqlite3.rc", std::to_string(rc));
      ADD_EXCEPTION_CONTEXT("sqlite3.context", "SqliteSampleBlock::GetBlob::step");
 
      wxLogDebug(wxT("SqliteSampleBlock::GetBlob - SQLITE error %s"), sqlite3_errmsg(db));
 
      // Clear statement bindings and rewind statement
      sqlite3_clear_bindings(stmt);
      sqlite3_reset(stmt);
 
      // Just showing the user a simple message, not the library error too
      // which isn't internationalized
      // Actually this can lead to 'Could not read from file' error message
      // but it can also lead to no error message at all and a flat line,
      // depending on where GetBlob is called from.
      // The latter can happen when repainting the screen.
      // That possibly happens on a very slow machine.  Possibly that's the
      // right trade off when a machine can't keep up?
      // ANSWER-ME: Do we always report an error when we should here?
      Conn()->ThrowException( false );
   }
 
   // Retrieve returned data
   samplePtr src = (samplePtr) sqlite3_column_blob(stmt, 0);
   size_t blobbytes = (size_t) sqlite3_column_bytes(stmt, 0);
 
   srcoffset = std::min(srcoffset, blobbytes);
   minbytes = std::min(srcbytes, blobbytes - srcoffset);
 
   if (srcoffset != 0)
   {
      srcoffset += 0;
   }
 
   /*
    Will dithering happen in CopySamples?  Answering this as of 3.0.3 by
    examining all uses.
 
    As this function is called from GetSummary, no, because destination format
    is float.
 
    There is only one other call to this function, in DoGetSamples.  At one
    call to that function, in DoGetMinMaxRMS, again format is float always.
 
    There is only one other call to DoGetSamples, in SampleBlock::GetSamples().
    In one call to that function, in WaveformView.cpp, again format is float.
 
    That leaves two calls in Sequence.cpp.  One of those can be proved to be
    used only in copy and paste operations, always supplying the same sample
    format as the samples were stored in, therefore no dither.
 
    That leaves uses of Sequence::Read().  There are uses of Read() in internal
    operations also easily shown to use only the saved format, and
    GetWaveDisplay() always reads as float.
 
    The remaining use of Sequence::Read() is in Sequence::Get().  That is used
    by WaveClip::Resample(), always fetching float.  It is also used in
    WaveClip::GetSamples().
 
    There is only one use of that function not always fetching float, in
    WaveTrack::Get().
 
    It can be shown that the only paths to WaveTrack::Get() not specifying
    floatSample are in Benchmark, which is only a diagnostic test, and there
    the sample format is the same as what the track was constructed with.
 
    Therefore, no dithering even there!
    */
   wxASSERT(destformat == floatSample || destformat == srcformat);
 
   CopySamples(src + srcoffset,
               srcformat,
               (samplePtr) dest,
               destformat,
               minbytes / SAMPLE_SIZE(srcformat));
 
   dest = ((samplePtr) dest) + minbytes;
 
   if (srcbytes - minbytes)
   {
      memset(dest, 0, srcbytes - minbytes);
   }
 
   // Clear statement bindings and rewind statement
   sqlite3_clear_bindings(stmt);
   sqlite3_reset(stmt);
 
   return srcbytes;
}

References ADD_EXCEPTION_CONTEXT, Conn(), CopySamples(), DB(), floatSample, IsSilent(), Load(), mBlockID, min(), mValid, SAMPLE_SIZE, DBConnection::ThrowException(), and wxT().

Referenced by DoGetSamples(), and GetSummary().

Here is the call graph for this function:

Here is the caller graph for this function:

GetBlockID()

SampleBlockID SqliteSampleBlock::GetBlockID ( ) const

overridevirtual

Implements SampleBlock.

Definition at line 400 of file SqliteSampleBlock.cpp.

{
   return mBlockID;
}

References mBlockID.

GetFloatSampleView()

BlockSampleView SqliteSampleBlock::GetFloatSampleView ( bool  mayThrow )

overridevirtual

Implements SampleBlock.

Definition at line 301 of file SqliteSampleBlock.cpp.

{
   assert(mSampleCount > 0);
 
   // Double-checked locking.
   // `weak_ptr::lock()` guarantees atomicity, which is important to make this
   // work without races.
   auto cache = mCache.lock();
   if (cache)
      return cache;
   std::lock_guard<std::mutex> lock(mCacheMutex);
   cache = mCache.lock();
   if (cache)
      return cache;
 
   const auto newCache =
      std::make_shared<std::vector<float>>(mSampleCount);
   try {
      const auto cachedSize = DoGetSamples(
         reinterpret_cast<samplePtr>(newCache->data()), floatSample, 0,
         mSampleCount);
      assert(cachedSize == mSampleCount);
   }
   catch (...)
   {
      if (mayThrow)
         std::rethrow_exception(std::current_exception());
      std::fill(newCache->begin(), newCache->end(), 0.f);
   }
   mCache = newCache;
   return newCache;
}

References DoGetSamples(), floatSample, mCache, mCacheMutex, and mSampleCount.

Here is the call graph for this function:

GetSampleCount()

size_t SqliteSampleBlock::GetSampleCount ( ) const

overridevirtual

Implements SampleBlock.

Definition at line 410 of file SqliteSampleBlock.cpp.

{
   return mSampleCount;
}

References mSampleCount.

GetSampleFormat()

sampleFormat SqliteSampleBlock::GetSampleFormat ( ) const

overridevirtual

Implements SampleBlock.

Definition at line 405 of file SqliteSampleBlock.cpp.

{
   return mSampleFormat;
}

References mSampleFormat.

GetSpaceUsage()

size_t SqliteSampleBlock::GetSpaceUsage ( ) const

overridevirtual

Implements SampleBlock.

Definition at line 570 of file SqliteSampleBlock.cpp.

{
   if (IsSilent())
      return 0;
   else
      return ProjectFileIO::GetDiskUsage(*Conn(), mBlockID);
}

References Conn(), ProjectFileIO::GetDiskUsage(), IsSilent(), and mBlockID.

Here is the call graph for this function:

GetSummary()

bool SqliteSampleBlock::GetSummary ( float *  dest, size_t  frameoffset, size_t  numframes, DBConnection::StatementID  id, const char *  sql  )

private

Definition at line 467 of file SqliteSampleBlock.cpp.

{
   // Non-throwing, it returns true for success
   bool silent = IsSilent();
   if (!silent) {
      // Not a silent block
      try {
         // Prepare and cache statement...automatically finalized at DB close
         auto stmt = Conn()->Prepare(id, sql);
         // Note GetBlob returns a size_t, not a bool
         // REVIEW: An error in GetBlob() will throw an exception.
         GetBlob(dest,
                     floatSample,
                     stmt,
                     floatSample,
                     frameoffset * fields * SAMPLE_SIZE(floatSample),
                     numframes * fields * SAMPLE_SIZE(floatSample));
         return true;
      }
      catch ( const AudacityException & ) {
      }
   }
   memset(dest, 0, 3 * numframes * sizeof( float ));
   // Return true for success only if we didn't catch
   return silent;
}

References Conn(), fields, floatSample, GetBlob(), IsSilent(), DBConnection::Prepare(), and SAMPLE_SIZE.

Referenced by GetSummary256(), and GetSummary64k().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSummary256()

bool SqliteSampleBlock::GetSummary256 ( float *  dest, size_t  frameoffset, size_t  numframes  )

overridevirtual

Non-throwing, should fill with zeroes on failure.

Implements SampleBlock.

Definition at line 451 of file SqliteSampleBlock.cpp.

{
   return GetSummary(dest, frameoffset, numframes, DBConnection::GetSummary256,
      "SELECT summary256 FROM sampleblocks WHERE blockid = ?1;");
}

References GetSummary(), and DBConnection::GetSummary256.

Here is the call graph for this function:

GetSummary64k()

bool SqliteSampleBlock::GetSummary64k ( float *  dest, size_t  frameoffset, size_t  numframes  )

overridevirtual

Non-throwing, should fill with zeroes on failure.

Implements SampleBlock.

Definition at line 459 of file SqliteSampleBlock.cpp.

{
   return GetSummary(dest, frameoffset, numframes, DBConnection::GetSummary64k,
      "SELECT summary64k FROM sampleblocks WHERE blockid = ?1;");
}

References GetSummary(), and DBConnection::GetSummary64k.

Here is the call graph for this function:

GetSumMax()

double SqliteSampleBlock::GetSumMax

(

)

const

Definition at line 503 of file SqliteSampleBlock.cpp.

{
   return mSumMax;
}

References mSumMax.

GetSumMin()

double SqliteSampleBlock::GetSumMin

(

)

const

Definition at line 498 of file SqliteSampleBlock.cpp.

{
   return mSumMin;
}

References mSumMin.

GetSumRms()

double SqliteSampleBlock::GetSumRms

(

)

const

Definition at line 508 of file SqliteSampleBlock.cpp.

{
   return mSumRms;
}

References mSumRms.

IsSilent()

bool SqliteSampleBlock::IsSilent ( ) const

inlineprivate

Definition at line 85 of file SqliteSampleBlock.cpp.

{ return mBlockID <= 0; }

References mBlockID.

Referenced by Delete(), DoGetMinMaxRMS(), DoGetSamples(), GetBlob(), GetSpaceUsage(), GetSummary(), and ~SqliteSampleBlock().

Here is the caller graph for this function:

Load()

void SqliteSampleBlock::Load ( SampleBlockID  sbid )

private

Definition at line 702 of file SqliteSampleBlock.cpp.

{
   auto db = DB();
   int rc;
 
   wxASSERT(sbid > 0);
 
   mValid = false;
   mSampleCount = 0;
   mSampleBytes = 0;
   mSumMin = FLT_MAX;
   mSumMax = -FLT_MAX;
   mSumMin = 0.0;
 
   // Prepare and cache statement...automatically finalized at DB close
   sqlite3_stmt *stmt = Conn()->Prepare(DBConnection::LoadSampleBlock,
      "SELECT sampleformat, summin, summax, sumrms,"
      "       length(samples)"
      "  FROM sampleblocks WHERE blockid = ?1;");
 
   // Bind statement parameters
   // Might return SQLITE_MISUSE which means it's our mistake that we violated
   // preconditions; should return SQL_OK which is 0
   if (sqlite3_bind_int64(stmt, 1, sbid))
   {
 
      ADD_EXCEPTION_CONTEXT("sqlite3.rc", std::to_string(sqlite3_errcode(Conn()->DB())));
      ADD_EXCEPTION_CONTEXT("sqlite3.context", "SqliteSampleBlock::Load::bind");
 
      wxASSERT_MSG(false, wxT("Binding failed...bug!!!"));
   }
 
   // Execute the statement
   rc = sqlite3_step(stmt);
   if (rc != SQLITE_ROW)
   {
 
      ADD_EXCEPTION_CONTEXT("sqlite3.rc", std::to_string(rc));
      ADD_EXCEPTION_CONTEXT("sqlite3.context", "SqliteSampleBlock::Load::step");
 
 
      wxLogDebug(wxT("SqliteSampleBlock::Load - SQLITE error %s"), sqlite3_errmsg(db));
 
      // Clear statement bindings and rewind statement
      sqlite3_clear_bindings(stmt);
      sqlite3_reset(stmt);
 
      // Just showing the user a simple message, not the library error too
      // which isn't internationalized
      Conn()->ThrowException( false );
   }
 
   // Retrieve returned data
   mBlockID = sbid;
   mSampleFormat = (sampleFormat) sqlite3_column_int(stmt, 0);
   mSumMin = sqlite3_column_double(stmt, 1);
   mSumMax = sqlite3_column_double(stmt, 2);
   mSumRms = sqlite3_column_double(stmt, 3);
   mSampleBytes = sqlite3_column_int(stmt, 4);
   mSampleCount = mSampleBytes / SAMPLE_SIZE(mSampleFormat);
 
   // Clear statement bindings and rewind statement
   sqlite3_clear_bindings(stmt);
   sqlite3_reset(stmt);
 
   mValid = true;
}

References ADD_EXCEPTION_CONTEXT, Conn(), DB(), DBConnection::LoadSampleBlock, mBlockID, mSampleBytes, mSampleCount, mSampleFormat, mSumMax, mSumMin, mSumRms, mValid, DBConnection::Prepare(), SAMPLE_SIZE, DBConnection::ThrowException(), and wxT().

Referenced by DoGetMinMaxRMS(), and GetBlob().

Here is the call graph for this function:

Here is the caller graph for this function:

SaveXML()

void SqliteSampleBlock::SaveXML ( XMLWriter &  xmlFile )

overridevirtual

Implements SampleBlock.

Definition at line 887 of file SqliteSampleBlock.cpp.

{
   xmlFile.WriteAttr(wxT("blockid"), mBlockID);
}

References mBlockID, XMLWriter::WriteAttr(), and wxT().

Here is the call graph for this function:

SetSamples()

void SqliteSampleBlock::SetSamples	(	constSamplePtr	src,
		size_t	numsamples,
		sampleFormat	srcformat
	)

Definition at line 438 of file SqliteSampleBlock.cpp.

{
   auto sizes = SetSizes(numsamples, srcformat);
   mSamples.reinit(mSampleBytes);
   memcpy(mSamples.get(), src, mSampleBytes);
 
   CalcSummary( sizes );
 
   Commit( sizes );
}

References CalcSummary(), Commit(), mSampleBytes, mSamples, ArrayOf< X >::reinit(), and SetSizes().

Here is the call graph for this function:

SetSizes()

auto SqliteSampleBlock::SetSizes ( size_t  numsamples, sampleFormat  srcformat  )

private

Definition at line 892 of file SqliteSampleBlock.cpp.

{
   mSampleFormat = srcformat;
   mSampleCount = numsamples;
   mSampleBytes = mSampleCount * SAMPLE_SIZE(mSampleFormat);
 
   int frames64k = (mSampleCount + 65535) / 65536;
   int frames256 = frames64k * 256;
   return { frames256 * bytesPerFrame, frames64k * bytesPerFrame };
}

References SAMPLE_SIZE.

Referenced by SetSamples().

Here is the caller graph for this function:

Member Data Documentation

mBlockID

SampleBlockID SqliteSampleBlock::mBlockID { 0 }

private

Definition at line 121 of file SqliteSampleBlock.cpp.

Referenced by Commit(), Delete(), DoGetMinMaxRMS(), GetBlob(), GetBlockID(), GetSpaceUsage(), IsSilent(), Load(), and SaveXML().

mCache

std::weak_ptr<std::vector<float> > SqliteSampleBlock::mCache

private

Definition at line 41 of file SqliteSampleBlock.cpp.

Referenced by Commit(), and GetFloatSampleView().

mCacheMutex

std::mutex SqliteSampleBlock::mCacheMutex

private

Definition at line 42 of file SqliteSampleBlock.cpp.

Referenced by Commit(), and GetFloatSampleView().

mLocked

bool SqliteSampleBlock::mLocked = false

private

Definition at line 119 of file SqliteSampleBlock.cpp.

Referenced by CloseLock(), and ~SqliteSampleBlock().

mpFactory

const std::shared_ptr<SqliteSampleBlockFactory> SqliteSampleBlock::mpFactory

private

Definition at line 117 of file SqliteSampleBlock.cpp.

Referenced by Conn(), and ~SqliteSampleBlock().

mSampleBytes

size_t SqliteSampleBlock::mSampleBytes

private

Definition at line 124 of file SqliteSampleBlock.cpp.

Referenced by Commit(), Load(), SetSamples(), and SqliteSampleBlock().

mSampleCount

size_t SqliteSampleBlock::mSampleCount

private

Definition at line 125 of file SqliteSampleBlock.cpp.

Referenced by CalcSummary(), DoGetMinMaxRMS(), GetFloatSampleView(), GetSampleCount(), Load(), and SqliteSampleBlock().

mSampleFormat

sampleFormat SqliteSampleBlock::mSampleFormat

private

Definition at line 126 of file SqliteSampleBlock.cpp.

Referenced by CalcSummary(), Commit(), DoGetSamples(), GetSampleFormat(), Load(), and SqliteSampleBlock().

mSamples

ArrayOf<char> SqliteSampleBlock::mSamples

private

Definition at line 123 of file SqliteSampleBlock.cpp.

Referenced by CalcSummary(), Commit(), and SetSamples().

mSummary256

ArrayOf<char> SqliteSampleBlock::mSummary256

private

Definition at line 128 of file SqliteSampleBlock.cpp.

Referenced by CalcSummary(), and Commit().

mSummary64k

ArrayOf<char> SqliteSampleBlock::mSummary64k

private

Definition at line 129 of file SqliteSampleBlock.cpp.

Referenced by CalcSummary(), and Commit().

mSumMax

double SqliteSampleBlock::mSumMax

private

Definition at line 131 of file SqliteSampleBlock.cpp.

Referenced by CalcSummary(), Commit(), DoGetMinMaxRMS(), GetSumMax(), Load(), and SqliteSampleBlock().

mSumMin

double SqliteSampleBlock::mSumMin

private

Definition at line 130 of file SqliteSampleBlock.cpp.

Referenced by CalcSummary(), Commit(), DoGetMinMaxRMS(), GetSumMin(), Load(), and SqliteSampleBlock().

mSumRms

double SqliteSampleBlock::mSumRms

private

Definition at line 132 of file SqliteSampleBlock.cpp.

Referenced by CalcSummary(), Commit(), DoGetMinMaxRMS(), GetSumRms(), Load(), and SqliteSampleBlock().

mValid

bool SqliteSampleBlock::mValid { false }

private

Definition at line 118 of file SqliteSampleBlock.cpp.

Referenced by Commit(), DoGetMinMaxRMS(), GetBlob(), and Load().

SqliteSampleBlockFactory

friend SqliteSampleBlock::SqliteSampleBlockFactory

private

Definition at line 115 of file SqliteSampleBlock.cpp.

---

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

• SqliteSampleBlock.cpp