Dependencies.cpp File Reference

#include "Audacity.h"
#include "Dependencies.h"
#include <wx/defs.h>
#include <wx/filename.h>
#include <wx/listctrl.h>
#include <wx/menu.h>
#include <wx/choice.h>
#include <wx/clipbrd.h>
#include <wx/dataobj.h>
#include <wx/frame.h>
#include <wx/stattext.h>
#include "blockfile/SimpleBlockFile.h"
#include "DirManager.h"
#include "FileFormats.h"
#include "Prefs.h"
#include "Project.h"
#include "Sequence.h"
#include "ShuttleGui.h"
#include "WaveTrack.h"
#include "WaveClip.h"
#include "prefs/QualityPrefs.h"
#include "widgets/AudacityMessageBox.h"
#include "widgets/ProgressDialog.h"
#include <unordered_map>

Include dependency graph for Dependencies.cpp:

Go to the source code of this file.

Classes
class	DependencyDialog
	DependencyDialog shows dependencies of an AudacityProject on AliasedFile s. More...

Typedefs
using	AliasedFileHash = std::unordered_map< wxString, AliasedFile * >
using	ReplacedBlockFileHash = std::unordered_map< BlockFile *, BlockFilePtr >
using	BoolBlockFileHash = std::unordered_map< BlockFile *, bool >

Enumerations
enum	{ FileListID = 6000 , CopySelectedFilesButtonID , CopyNamesToClipboardID , FutureActionChoiceID }

Functions
static void	GetAllSeqBlocks (AudacityProject *project, BlockPtrArray *outBlocks)
static void	ReplaceBlockFiles (BlockPtrArray &blocks, ReplacedBlockFileHash &hash)
void	FindDependencies (AudacityProject *project, AliasedFileArray &outAliasedFiles)
static void	RemoveDependencies (AudacityProject *project, AliasedFileArray &aliasedFiles)
	EVT_BUTTON (wxID_NO, DependencyDialog::OnNo) EVT_BUTTON(wxID_YES
DependencyDialog::OnYes	EVT_BUTTON (wxID_CANCEL, DependencyDialog::OnCancel) DependencyDialog
static const TranslatableString	kStdMsg ()
static const TranslatableString	kExtraMsgForMissingFiles ()
bool	ShowDependencyDialogIfNeeded (AudacityProject *project, bool isSaving)

Typedef Documentation

AliasedFileHash

using AliasedFileHash = std::unordered_map<wxString, AliasedFile*>

Definition at line 65 of file Dependencies.cpp.

BoolBlockFileHash

using BoolBlockFileHash = std::unordered_map<BlockFile *, bool>

Definition at line 70 of file Dependencies.cpp.

ReplacedBlockFileHash

using ReplacedBlockFileHash = std::unordered_map<BlockFile *, BlockFilePtr>

Definition at line 69 of file Dependencies.cpp.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
FileListID
CopySelectedFilesButtonID
CopyNamesToClipboardID
FutureActionChoiceID

Definition at line 285 of file Dependencies.cpp.

     {
   FileListID = 6000,
   CopySelectedFilesButtonID,
   CopyNamesToClipboardID,
   FutureActionChoiceID
};

Function Documentation

EVT_BUTTON() [1/2]

DependencyDialog::OnYes EVT_BUTTON	(	wxID_CANCEL	,
		DependencyDialog::OnCancel
	)

Definition at line 300 of file Dependencies.cpp.

: wxDialogWrapper(parent, id, XO("Project Depends on Other Audio Files"),
            wxDefaultPosition, wxDefaultSize,
            (isSaving ?
                  (wxDEFAULT_DIALOG_STYLE & ~wxCLOSE_BOX) : // no close box when saving
                  wxDEFAULT_DIALOG_STYLE) |
               wxRESIZE_BORDER),
   mProject(project),
   mAliasedFiles(aliasedFiles),
   mIsSaving(isSaving),
   mHasMissingFiles(false),
   mHasNonMissingFiles(false),
   mMessageStaticText(NULL),
   mFileListCtrl(NULL),
   mCopySelectedFilesButton(NULL),
   mCopyAllFilesButton(NULL),
   mFutureActionChoice(NULL)
{
   SetName();
   ShuttleGui S(this, eIsCreating);
   PopulateOrExchange(S);
}

References eIsCreating, and S.

EVT_BUTTON() [2/2]

EVT_BUTTON	(	wxID_NO	,
		DependencyDialog::OnNo
	)

FindDependencies()

void FindDependencies	(	AudacityProject *	project,
		AliasedFileArray &	outAliasedFiles
	)

Definition at line 107 of file Dependencies.cpp.

{
   sampleFormat format = QualityPrefs::SampleFormatChoice();
 
   BlockPtrArray blocks;
   GetAllSeqBlocks(project, &blocks);
 
   AliasedFileHash aliasedFileHash;
   BoolBlockFileHash blockFileHash;
 
   for (const auto &blockFile : blocks) {
      const auto &f = blockFile->f;
      if (f->IsAlias() && (blockFileHash.count( &*f ) == 0))
      {
         // f is an alias block we have not yet counted.
         blockFileHash[ &*f ] = true; // Don't count the same blockfile twice.
         auto aliasBlockFile = static_cast<AliasBlockFile*>( &*f );
         const wxFileName &fileName = aliasBlockFile->GetAliasedFileName();
 
         // In ProjectFSCK(), if the user has chosen to
         // "Replace missing audio with silence", the code there puts in an empty wxFileName.
         // Don't count those in dependencies.
         if (!fileName.IsOk())
            continue;
 
         const wxString &fileNameStr = fileName.GetFullPath();
         auto blockBytes = (SAMPLE_SIZE(format) *
                           aliasBlockFile->GetLength());
         if (aliasedFileHash.count(fileNameStr) > 0)
            // Already put this AliasBlockFile in aliasedFileHash.
            // Update block count.
            aliasedFileHash[fileNameStr]->mByteCount += blockBytes;
         else
         {
            // Haven't counted this AliasBlockFile yet.
            // Add to return array and internal hash.
 
            // PRL: do this in two steps so that we move instead of copying.
            // We don't have a moving push_back in all compilers.
            outAliasedFiles.push_back(AliasedFile{});
            outAliasedFiles.back() =
               AliasedFile {
                  wxFileNameWrapper { fileName },
                  wxLongLong(blockBytes), fileName.FileExists()
               };
            aliasedFileHash[fileNameStr] = &outAliasedFiles.back();
         }
      }
   }
}

References anonymous_namespace{ExportPCM.cpp}::format, GetAllSeqBlocks(), project, SAMPLE_SIZE, and QualitySettings::SampleFormatChoice().

Referenced by ShowDependencyDialogIfNeeded().

Here is the call graph for this function:

Here is the caller graph for this function:

GetAllSeqBlocks()

static void GetAllSeqBlocks ( AudacityProject *  project, BlockPtrArray *  outBlocks  )

static

Definition at line 75 of file Dependencies.cpp.

{
   for (auto waveTrack : TrackList::Get( *project ).Any< WaveTrack >()) {
      for(const auto &clip : waveTrack->GetAllClips()) {
         Sequence *sequence = clip->GetSequence();
         BlockArray &blocks = sequence->GetBlockArray();
         for (size_t i = 0; i < blocks.size(); i++)
            outBlocks->push_back(&blocks[i]);
      }
   }
}

References TrackList::Any(), TrackList::Get(), and Sequence::GetBlockArray().

Referenced by FindDependencies(), and RemoveDependencies().

Here is the call graph for this function:

Here is the caller graph for this function:

kExtraMsgForMissingFiles()

static const TranslatableString kExtraMsgForMissingFiles ( )

static

Definition at line 338 of file Dependencies.cpp.

{
   return
XO("\n\nFiles shown as MISSING have been moved or deleted and cannot be copied.\
\nRestore them to their original location to be able to copy into project.");
}

References XO().

Referenced by DependencyDialog::PopulateList().

Here is the call graph for this function:

Here is the caller graph for this function:

kStdMsg()

static const TranslatableString kStdMsg ( )

static

Definition at line 331 of file Dependencies.cpp.

{
   return
XO("Copying these files into your project will remove this dependency.\
\nThis is safer, but needs more disk space.");
}

References XO().

Referenced by DependencyDialog::PopulateList(), and DependencyDialog::PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveDependencies()

static void RemoveDependencies ( AudacityProject *  project, AliasedFileArray &  aliasedFiles  )

static

Definition at line 162 of file Dependencies.cpp.

{
   auto &dirManager = DirManager::Get( *project );
 
   ProgressDialog progress(
      XO("Removing Dependencies"),
      XO("Copying audio data into project..."));
   auto updateResult = ProgressResult::Success;
 
   // Hash aliasedFiles based on their full paths and
   // count total number of bytes to process.
   AliasedFileHash aliasedFileHash;
   wxLongLong totalBytesToProcess = 0;
   for (auto &aliasedFile : aliasedFiles) {
      totalBytesToProcess += aliasedFile.mByteCount;
      const wxString &fileNameStr = aliasedFile.mFileName.GetFullPath();
      aliasedFileHash[fileNameStr] = &aliasedFile;
   }
 
   BlockPtrArray blocks;
   GetAllSeqBlocks(project, &blocks);
 
   const sampleFormat format = QualityPrefs::SampleFormatChoice();
   ReplacedBlockFileHash blockFileHash;
   wxLongLong completedBytes = 0;
   for (const auto blockFile : blocks) {
      const auto &f = blockFile->f;
      if (f->IsAlias() && (blockFileHash.count( &*f ) == 0))
      {
         // f is an alias block we have not yet processed.
         auto aliasBlockFile = static_cast<AliasBlockFile*>( &*f );
         const wxFileName &fileName = aliasBlockFile->GetAliasedFileName();
         const wxString &fileNameStr = fileName.GetFullPath();
 
         if (aliasedFileHash.count(fileNameStr) == 0)
            // This aliased file was not selected to be replaced. Skip it.
            continue;
 
         // Convert it from an aliased file to an actual file in the project.
         auto len = aliasBlockFile->GetLength();
         BlockFilePtr newBlockFile;
         {
            SampleBuffer buffer(len, format);
            // We tolerate exceptions from NewBlockFile
            // and so we can allow exceptions from ReadData too
            f->ReadData(buffer.ptr(), format, 0, len);
            newBlockFile =
               dirManager.NewBlockFile( [&]( wxFileNameWrapper filePath ) {
                  return make_blockfile<SimpleBlockFile>(
                     std::move(filePath), buffer.ptr(), len, format);
               } );
         }
 
         // Update our hash so we know what block files we've done
         blockFileHash[ &*f ] = newBlockFile;
 
         // Update the progress bar
         completedBytes += SAMPLE_SIZE(format) * len;
         updateResult = progress.Update(completedBytes, totalBytesToProcess);
         if (updateResult != ProgressResult::Success)
            // leave the project unchanged
            return;
      }
   }
 
   // COMMIT OPERATIONS needing NOFAIL-GUARANTEE:
 
   // Above, we created a SimpleBlockFile contained in our project
   // to go with each AliasBlockFile that we wanted to migrate.
   // However, that didn't actually change any references to these
   // blockfiles in the Sequences, so we do that next...
   ReplaceBlockFiles(blocks, blockFileHash);
}

References anonymous_namespace{ExportPCM.cpp}::format, BasicUI::Get(), GetAllSeqBlocks(), project, SampleBuffer::ptr(), ReplaceBlockFiles(), SAMPLE_SIZE, QualitySettings::SampleFormatChoice(), BasicUI::Success, ProgressDialog::Update(), and XO().

Referenced by DependencyDialog::OnCopySelectedFiles(), and ShowDependencyDialogIfNeeded().

Here is the call graph for this function:

Here is the caller graph for this function:

ReplaceBlockFiles()

static void ReplaceBlockFiles ( BlockPtrArray &  blocks, ReplacedBlockFileHash &  hash  )

static

Definition at line 93 of file Dependencies.cpp.

{
   for (const auto &pBlock : blocks) {
      auto &f = pBlock->f;
      const auto src = &*f;
      if (hash.count( src ) > 0) {
         const auto &dst = hash[src];
         f = dst;
      }
   }
}

Referenced by RemoveDependencies().

Here is the caller graph for this function:

ShowDependencyDialogIfNeeded()

bool ShowDependencyDialogIfNeeded	(	AudacityProject *	project,
		bool	isSaving
	)

Definition at line 600 of file Dependencies.cpp.

{
   auto pWindow = FindProjectFrame( project );
   AliasedFileArray aliasedFiles;
   FindDependencies(project, aliasedFiles);
 
   if (aliasedFiles.empty()) {
      if (!isSaving)
      {
         auto msg =
XO("Your project is self-contained; it does not depend on any external audio files. \
\n\nSome older Audacity projects may not be self-contained, and care \n\
is needed to keep their external dependencies in the right place.\n\
New projects will be self-contained and are less risky.");
         AudacityMessageBox(
            msg,
            XO("Dependency Check"),
            wxOK | wxICON_INFORMATION,
            pWindow);
      }
      return true; // Nothing to do.
   }
 
   if (isSaving)
   {
      RemoveDependencies(project, aliasedFiles);
      return true;
   }
 
   DependencyDialog dlog(pWindow, -1, project, aliasedFiles, isSaving);
   int returnCode = dlog.ShowModal();
   if (returnCode == wxID_CANCEL)
      return false;
   else if (returnCode == wxID_YES)
      RemoveDependencies(project, aliasedFiles);
 
   return true;
}

References AudacityMessageBox(), FindDependencies(), FindProjectFrame(), project, RemoveDependencies(), and XO().

Here is the call graph for this function: