Inheritance diagram for audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock:

Collaboration diagram for audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock:

Public Member Functions
	ProjectBlocksLock (ProjectCloudExtension &extension, AudacityProject &project, std::function< void()> onBlocksLocked)

	~ProjectBlocksLock () override

void	VisitBlocks (TrackList &tracks)

void	CollectHashes ()

void	UpdateProjectHashesInCache ()

bool	GetHash (int64_t blockId, std::string &hash) const override

void	UpdateHash (int64_t blockId, const std::string &hash) override

void	FillMissingBlocks (const std::vector< UploadUrls > &missingBlockUrls)

Public Attributes
ProjectCloudExtension &	Extension

SampleBlockIDSet	BlockIds

std::vector< LockedBlock >	Blocks

std::vector< BlockUploadTask >	MissingBlocks

std::unordered_map< int64_t, size_t >	BlockIdToIndex

std::unordered_map< std::string, size_t >	BlockHashToIndex

std::unique_ptr< BlockHasher >	Hasher

std::future< void >	UpdateCacheFuture

std::vector< std::pair< int64_t, std::string > >	NewHashes

std::function< void()>	OnBlocksLocked

Additional Inherited Members
Private Member Functions inherited from audacity::cloud::audiocom::sync::BlockHashCache
virtual	~BlockHashCache ()=default

virtual bool	GetHash (int64_t blockId, std::string &hash) const =0

virtual void	UpdateHash (int64_t blockId, const std::string &hash)=0

Detailed Description

Definition at line 49 of file LocalProjectSnapshot.cpp.

Constructor & Destructor Documentation

◆ ProjectBlocksLock()

audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock::ProjectBlocksLock	(	ProjectCloudExtension &	extension,
		AudacityProject &	project,
		std::function< void()>	onBlocksLocked
	)

inlineexplicit

Definition at line 68 of file LocalProjectSnapshot.cpp.

       : Extension { extension }
       , OnBlocksLocked { std::move(onBlocksLocked) }
   {
      VisitBlocks(TrackList::Get(project));
 
      if (Extension.IsCloudProject())
      {
         CloudProjectsDatabase::Get().UpdateProjectBlockList(
            Extension.GetCloudProjectId(), BlockIds);
      }
 
      Hasher = std::make_unique<BlockHasher>();
 
      Hasher->ComputeHashes(*this, Blocks, [this] { CollectHashes(); });
   }

References BlockIds, Blocks, CollectHashes(), Extension, audacity::cloud::audiocom::sync::CloudProjectsDatabase::Get(), TrackList::Get(), audacity::cloud::audiocom::sync::ProjectCloudExtension::GetCloudProjectId(), Hasher, audacity::cloud::audiocom::sync::ProjectCloudExtension::IsCloudProject(), project, audacity::cloud::audiocom::sync::CloudProjectsDatabase::UpdateProjectBlockList(), and VisitBlocks().

Here is the call graph for this function:

◆ ~ProjectBlocksLock()

audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock::~ProjectBlocksLock ( )

inlineoverride

Definition at line 87 of file LocalProjectSnapshot.cpp.

88 {

89 }

Member Function Documentation

◆ CollectHashes()

void audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock::CollectHashes ( )

inline

Definition at line 112 of file LocalProjectSnapshot.cpp.

   {
      // TakeResult() will call UpdateHash() for each block
      // not found in the cache
      const auto result = Hasher->TakeResult();
 
      for (auto [id, hash] : result)
      {
         auto it = BlockIdToIndex.find(id);
 
         if (it == BlockIdToIndex.end())
         {
            assert(false);
            continue;
         }
 
         while (BlockHashToIndex.find(hash) != BlockHashToIndex.end())
         {
            // Hash is used by another block, rehash
            hash = crypto::sha256(hash);
         }
 
         BlockHashToIndex[hash]  = BlockIdToIndex[id];
         Blocks[it->second].Hash = std::move(hash);
      }
 
      // This will potentially block, if the cache is being updated
      // already
      UpdateProjectHashesInCache();
 
      if (OnBlocksLocked)
         OnBlocksLocked();
   }

References BlockHashToIndex, BlockIdToIndex, Blocks, Hasher, id, OnBlocksLocked, crypto::sha256(), and UpdateProjectHashesInCache().

Referenced by ProjectBlocksLock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FillMissingBlocks()

void audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock::FillMissingBlocks ( const std::vector< UploadUrls > & missingBlockUrls )

inline

Definition at line 181 of file LocalProjectSnapshot.cpp.

   {
      for (const auto& urls : missingBlockUrls)
      {
         auto it = BlockHashToIndex.find(ToUpper(urls.Id));
 
         if (it == BlockHashToIndex.end())
         {
            assert(false);
            continue;
         }
 
         const auto index = it->second;
 
         MissingBlocks.push_back(BlockUploadTask { urls, Blocks[index] });
      }
   }

References BlockHashToIndex, Blocks, MissingBlocks, and ToUpper().

Here is the call graph for this function:

◆ GetHash()

bool audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock::GetHash	(	int64_t	blockId,
		std::string &	hash
	)		const

inlineoverridevirtual

Implements audacity::cloud::audiocom::sync::BlockHashCache.

Definition at line 160 of file LocalProjectSnapshot.cpp.

   {
      if (!Extension.IsCloudProject())
         return false;
 
      auto cachedResult = CloudProjectsDatabase::Get().GetBlockHash(
         Extension.GetCloudProjectId(), blockId);
 
      if (!cachedResult)
         return false;
 
      hash = std::move(*cachedResult);
 
      return true;
   }

References Extension, audacity::cloud::audiocom::sync::CloudProjectsDatabase::Get(), audacity::cloud::audiocom::sync::CloudProjectsDatabase::GetBlockHash(), audacity::cloud::audiocom::sync::ProjectCloudExtension::GetCloudProjectId(), and audacity::cloud::audiocom::sync::ProjectCloudExtension::IsCloudProject().

Here is the call graph for this function:

◆ UpdateHash()

void audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock::UpdateHash	(	int64_t	blockId,
		const std::string &	hash
	)

inlineoverridevirtual

Implements audacity::cloud::audiocom::sync::BlockHashCache.

Definition at line 176 of file LocalProjectSnapshot.cpp.

   {
      NewHashes.emplace_back(blockId, hash);
   }

References NewHashes.

◆ UpdateProjectHashesInCache()

void audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock::UpdateProjectHashesInCache ( )

inline

Definition at line 146 of file LocalProjectSnapshot.cpp.

   {
      if (!Extension.IsCloudProject())
         return;
 
      UpdateCacheFuture = std::async(
         std::launch::async,
         [this, hashes = std::move(NewHashes)]
         {
            CloudProjectsDatabase::Get().UpdateBlockHashes(
               Extension.GetCloudProjectId(), hashes);
         });
   }

References Extension, audacity::cloud::audiocom::sync::CloudProjectsDatabase::Get(), audacity::cloud::audiocom::sync::ProjectCloudExtension::GetCloudProjectId(), audacity::cloud::audiocom::sync::ProjectCloudExtension::IsCloudProject(), NewHashes, audacity::cloud::audiocom::sync::CloudProjectsDatabase::UpdateBlockHashes(), and UpdateCacheFuture.

Referenced by CollectHashes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VisitBlocks()

void audacity::cloud::audiocom::sync::LocalProjectSnapshot::ProjectBlocksLock::VisitBlocks ( TrackList & tracks )

inline

Definition at line 91 of file LocalProjectSnapshot.cpp.

   {
      const auto visitor = [this](const SampleBlockPtr &pBlock){
         const auto id = pBlock->GetBlockID();
         if(id >= 0)
         {
            Blocks.push_back({
               id, pBlock->GetSampleFormat(), pBlock });
            BlockIdToIndex[id] = Blocks.size() - 1;
         }
         //Do not compute hashes for negative id's, which describe
         //the length of a silenced sequence. Making an id record in
         //project blob is enough to restore block contents fully.
         //VS: Older versions of Audacity encoded them as a regular
         //blocks, but due to wrong sanity checks in `WavPackCompressor`
         //attempt to load them could fail. The check above will purge
         //such blocks if they are present in old project.
      };
      WaveTrackUtilities::VisitBlocks(tracks, visitor, &BlockIds);
   }