Dependencies.h File Reference

#include <list>
#include "MemoryX.h"
#include "wxFileNameWrapper.h"

Include dependency graph for Dependencies.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	AliasedFile
	An audio file that is referenced (pointed into) directly from an Audacity .aup file rather than Audacity having its own copies of the data. More...

Typedefs
using	AliasedFileArray = std::list< AliasedFile >

Functions
bool	ShowDependencyDialogIfNeeded (AudacityProject *project, bool isSaving)
void	FindDependencies (AudacityProject *project, AliasedFileArray &outAliasedFiles)

Typedef Documentation

AliasedFileArray

using AliasedFileArray = std::list<AliasedFile>

Definition at line 52 of file Dependencies.h.

Function Documentation

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 format, GetAllSeqBlocks(), SAMPLE_SIZE, and QualitySettings::SampleFormatChoice().

Referenced by ShowDependencyDialogIfNeeded().

Here is the call graph for this function:

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(), RemoveDependencies(), and XO().

Here is the call graph for this function: