SqliteSampleBlockFactory Class Reference

Implementation of SampleBlockFactory using Sqlite database. More...

Inheritance diagram for SqliteSampleBlockFactory:

Collaboration diagram for SqliteSampleBlockFactory:

Public Member Functions
	SqliteSampleBlockFactory (AudacityProject &project)
	~SqliteSampleBlockFactory () override
SampleBlockIDs	GetActiveBlockIDs () override
SampleBlockPtr	DoCreate (constSamplePtr src, size_t numsamples, sampleFormat srcformat) override
SampleBlockPtr	DoCreateSilent (size_t numsamples, sampleFormat srcformat) override
SampleBlockPtr	DoCreateFromXML (sampleFormat srcformat, const AttributesList &attrs) override
SampleBlockPtr	DoCreateFromId (sampleFormat srcformat, SampleBlockID id) override
Public Member Functions inherited from SampleBlockFactory
virtual	~SampleBlockFactory ()
SampleBlockPtr	Create (constSamplePtr src, size_t numsamples, sampleFormat srcformat)
SampleBlockPtr	CreateSilent (size_t numsamples, sampleFormat srcformat)
SampleBlockPtr	CreateFromXML (sampleFormat srcformat, const AttributesList &attrs)
SampleBlockPtr	CreateFromId (sampleFormat srcformat, SampleBlockID id)
virtual SampleBlockIDs	GetActiveBlockIDs ()=0
Public Member Functions inherited from Observer::Publisher< SampleBlockCreateMessage >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Private Types
using	AllBlocksMap = std::map< SampleBlockID, std::weak_ptr< SqliteSampleBlock > >

Private Member Functions
void	OnBeginPurge (size_t begin, size_t end)
void	OnEndPurge ()

Private Attributes
friend	SqliteSampleBlock
AudacityProject &	mProject
Observer::Subscription	mUndoSubscription
std::optional< SampleBlock::DeletionCallback::Scope >	mScope
const std::shared_ptr< ConnectionPtr >	mppConnection
AllBlocksMap	mAllBlocks

Additional Inherited Members
Public Types inherited from SampleBlockFactory
using	SampleBlockIDs = std::unordered_set< SampleBlockID >
Public Types inherited from Observer::Publisher< SampleBlockCreateMessage >
using	message_type = SampleBlockCreateMessage
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const SampleBlockCreateMessage &) >
	Type of functions that can be connected to the Publisher. More...
Static Public Member Functions inherited from SampleBlockFactory
static SampleBlockFactoryPtr	New (AudacityProject &project)
Static Public Attributes inherited from Observer::Publisher< SampleBlockCreateMessage >
static constexpr bool	notifies_all
virtual SampleBlockPtr	DoCreate (constSamplePtr src, size_t numsamples, sampleFormat srcformat)=0
virtual SampleBlockPtr	DoCreateSilent (size_t numsamples, sampleFormat srcformat)=0
virtual SampleBlockPtr	DoCreateFromXML (sampleFormat srcformat, const AttributesList &attrs)=0
virtual SampleBlockPtr	DoCreateFromId (sampleFormat srcformat, SampleBlockID id)=0
Protected Member Functions inherited from Observer::Publisher< SampleBlockCreateMessage >
CallbackReturn	Publish (const SampleBlockCreateMessage &message)
	Send a message to connected callbacks. More...

Detailed Description

Implementation of SampleBlockFactory using Sqlite database.

Definition at line 146 of file SqliteSampleBlock.cpp.

Member Typedef Documentation

AllBlocksMap

using SqliteSampleBlockFactory::AllBlocksMap = std::map< SampleBlockID, std::weak_ptr< SqliteSampleBlock > >

private

Definition at line 187 of file SqliteSampleBlock.cpp.

Constructor & Destructor Documentation

SqliteSampleBlockFactory()

SqliteSampleBlockFactory::SqliteSampleBlockFactory ( AudacityProject &  project )

explicit

Definition at line 192 of file SqliteSampleBlock.cpp.

   : mProject{ project }
   , mppConnection{ ConnectionPtr::Get(project).shared_from_this() }
{
   mUndoSubscription = UndoManager::Get(project)
      .Subscribe([this](UndoRedoMessage message){
         switch (message.type) {
         case UndoRedoMessage::BeginPurge:
            return OnBeginPurge(message.begin, message.end);
         case UndoRedoMessage::EndPurge:
            return OnEndPurge();
         default:
            return;
         }
      });
}

References UndoManager::Get(), mUndoSubscription, project, Observer::Publisher< Message, NotifyAll >::Subscribe(), and UndoRedoMessage::type.

Here is the call graph for this function:

~SqliteSampleBlockFactory()

SqliteSampleBlockFactory::~SqliteSampleBlockFactory ( )

overridedefault

Member Function Documentation

DoCreate()

SampleBlockPtr SqliteSampleBlockFactory::DoCreate ( constSamplePtr  src, size_t  numsamples, sampleFormat  srcformat  )

overridevirtual

Implements SampleBlockFactory.

Definition at line 211 of file SqliteSampleBlock.cpp.

{
   auto sb = std::make_shared<SqliteSampleBlock>(shared_from_this());
   sb->SetSamples(src, numsamples, srcformat);
   // block id has now been assigned
   mAllBlocks[ sb->GetBlockID() ] = sb;
   return sb;
}

References mAllBlocks.

DoCreateFromId()

SampleBlockPtr SqliteSampleBlockFactory::DoCreateFromId ( sampleFormat  srcformat, SampleBlockID  id  )

overridevirtual

Implements SampleBlockFactory.

Definition at line 272 of file SqliteSampleBlock.cpp.

{
   if (id <= 0)
      return DoCreateSilent(-id, floatSample);
 
   // First see if this block id was previously loaded
   auto& wb = mAllBlocks[id];
 
   if (auto block = wb.lock())
      return block;
 
   // First sight of this id
   auto ssb           = std::make_shared<SqliteSampleBlock>(shared_from_this());
   wb                 = ssb;
   ssb->mSampleFormat = srcformat;
   // This may throw database errors
   // It initializes the rest of the fields
   ssb->Load(static_cast<SampleBlockID>(id));
   
   return ssb;
}

References DoCreateSilent(), floatSample, id, and mAllBlocks.

Referenced by DoCreateFromXML().

Here is the call graph for this function:

Here is the caller graph for this function:

DoCreateFromXML()

SampleBlockPtr SqliteSampleBlockFactory::DoCreateFromXML ( sampleFormat  srcformat, const AttributesList &  attrs  )

overridevirtual

Implements SampleBlockFactory.

Definition at line 254 of file SqliteSampleBlock.cpp.

{
   // loop through attrs, which is a null-terminated list of attribute-value pairs
   for (auto pair : attrs)
   {
      auto attr = pair.first;
      auto value = pair.second;
 
      long long nValue;
 
      if (attr == "blockid" && value.TryGet(nValue))
         return DoCreateFromId(srcformat, nValue);
   }
 
   return nullptr;
}

References DoCreateFromId().

Here is the call graph for this function:

DoCreateSilent()

SampleBlockPtr SqliteSampleBlockFactory::DoCreateSilent ( size_t  numsamples, sampleFormat  srcformat  )

overridevirtual

Implements SampleBlockFactory.

Definition at line 236 of file SqliteSampleBlock.cpp.

{
   auto id = -static_cast< SampleBlockID >(numsamples);
   auto &result = sSilentBlocks[ id ];
   if ( !result ) {
      result = std::make_shared<SqliteSampleBlock>(nullptr);
      result->mBlockID = id;
 
      // Ignore the supplied sample format
      result->SetSizes(numsamples, floatSample);
      result->mValid = true;
   }
 
   return result;
}

References floatSample, id, and sSilentBlocks.

Referenced by DoCreateFromId().

Here is the caller graph for this function:

GetActiveBlockIDs()

auto SqliteSampleBlockFactory::GetActiveBlockIDs ( )

overridevirtual

Returns

ids of all sample blocks created by this factory and still extant

Implements SampleBlockFactory.

Definition at line 221 of file SqliteSampleBlock.cpp.

{
   SampleBlockIDs result;
   for (auto end = mAllBlocks.end(), it = mAllBlocks.begin(); it != end;) {
      if (it->second.expired())
         // Tighten up the map
         it = mAllBlocks.erase(it);
      else {
         result.insert( it->first );
         ++it;
      }
   }
   return result;
}

References details::end().

Here is the call graph for this function:

OnBeginPurge()

void SqliteSampleBlockFactory::OnBeginPurge ( size_t  begin, size_t  end  )

private

Definition at line 1092 of file SqliteSampleBlock.cpp.

{
   // Install a callback function that updates a progress indicator
   using namespace BasicUI;
 
   //Avoid showing dialog to the user if purge operation
   //does not take much time, as it will resign focus from main window
   //but dialog itself may not be presented to the user at all.
   //On MacOS 13 (bug #3975) focus isn't restored in that case.
   constexpr auto ProgressDialogShowDelay = std::chrono::milliseconds (200);
   const auto nToDelete = EstimateRemovedBlocks(mProject, begin, end);
   if(nToDelete == 0)
       return;
   auto purgeStartTime = std::chrono::system_clock::now();
   std::shared_ptr<ProgressDialog> progressDialog;
   mScope.emplace([=, nDeleted = 0](auto&) mutable {
      ++nDeleted;
      if(!progressDialog)
      {
         auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
            std::chrono::system_clock::now() - purgeStartTime);
         if(elapsed >= ProgressDialogShowDelay)
            progressDialog = MakeProgress(XO("Progress"), XO("Discarding undo/redo history"), 0);
      }
      else
         progressDialog->Poll(nDeleted, nToDelete);
   });
}

References details::begin(), details::end(), EstimateRemovedBlocks(), BasicUI::MakeProgress(), mProject, mScope, and XO().

Here is the call graph for this function:

OnEndPurge()

void SqliteSampleBlockFactory::OnEndPurge ( )

private

Definition at line 1121 of file SqliteSampleBlock.cpp.

{
   mScope.reset();
}

References mScope.

Member Data Documentation

mAllBlocks

AllBlocksMap SqliteSampleBlockFactory::mAllBlocks

private

Definition at line 189 of file SqliteSampleBlock.cpp.

Referenced by DoCreate(), and DoCreateFromId().

mppConnection

const std::shared_ptr<ConnectionPtr> SqliteSampleBlockFactory::mppConnection

private

Definition at line 181 of file SqliteSampleBlock.cpp.

mProject

AudacityProject& SqliteSampleBlockFactory::mProject

private

Definition at line 178 of file SqliteSampleBlock.cpp.

Referenced by OnBeginPurge().

mScope

std::optional<SampleBlock::DeletionCallback::Scope> SqliteSampleBlockFactory::mScope

private

Definition at line 180 of file SqliteSampleBlock.cpp.

Referenced by OnBeginPurge(), and OnEndPurge().

mUndoSubscription

Observer::Subscription SqliteSampleBlockFactory::mUndoSubscription

private

Definition at line 179 of file SqliteSampleBlock.cpp.

Referenced by SqliteSampleBlockFactory().

SqliteSampleBlock

friend SqliteSampleBlockFactory::SqliteSampleBlock

private

Definition at line 176 of file SqliteSampleBlock.cpp.

---

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

• SqliteSampleBlock.cpp