LegacyAliasBlockFile Class Reference

An AliasBlockFile that references uncompressed data in an existing file. More...

#include <LegacyAliasBlockFile.h>

Inheritance diagram for LegacyAliasBlockFile:

Collaboration diagram for LegacyAliasBlockFile:

Public Member Functions
	LegacyAliasBlockFile (wxFileNameWrapper &&fileName, wxFileNameWrapper &&aliasedFileName, sampleCount aliasStart, size_t aliasLen, int aliasChannel, size_t summaryLen, bool noRMS)
	Constructs a LegacyAliasBlockFile, writing the summary to disk. More...
virtual	~LegacyAliasBlockFile ()
void	SaveXML (XMLWriter &xmlFile) override
BlockFilePtr	Copy (wxFileNameWrapper &&fileName) override
void	Recover () override
Public Member Functions inherited from PCMAliasBlockFile
	PCMAliasBlockFile (wxFileNameWrapper &&baseFileName, wxFileNameWrapper &&aliasedFileName, sampleCount aliasStart, size_t aliasLen, int aliasChannel)
	Constructs a PCMAliasBlockFile, writing the summary to disk. More...
	PCMAliasBlockFile (wxFileNameWrapper &&fileName, wxFileNameWrapper &&aliasedFileName, sampleCount aliasStart, size_t aliasLen, int aliasChannel, bool writeSummary)
	Constructs a PCMAliasBlockFile with the option of not writing to disk. More...
	PCMAliasBlockFile (wxFileNameWrapper &&existingSummaryFileName, wxFileNameWrapper &&aliasedFileName, sampleCount aliasStart, size_t aliasLen, int aliasChannel, float min, float max, float rms)
virtual	~PCMAliasBlockFile ()
size_t	ReadData (samplePtr data, sampleFormat format, size_t start, size_t len, bool mayThrow) const override
	Reads the specified data from the aliased file using libsndfile. More...
void	SaveXML (XMLWriter &xmlFile) override
BlockFilePtr	Copy (wxFileNameWrapper &&fileName) override
void	Recover () override

Static Public Member Functions
static BlockFilePtr	BuildFromXML (const FilePath &projDir, const wxChar **attrs)
Static Public Member Functions inherited from PCMAliasBlockFile
static BlockFilePtr	BuildFromXML (DirManager &dm, const wxChar **attrs)

Detailed Description

An AliasBlockFile that references uncompressed data in an existing file.

Definition at line 17 of file LegacyAliasBlockFile.h.

Constructor & Destructor Documentation

LegacyAliasBlockFile()

LegacyAliasBlockFile::LegacyAliasBlockFile	(	wxFileNameWrapper &&	fileName,
		wxFileNameWrapper &&	aliasedFileName,
		sampleCount	aliasStart,
		size_t	aliasLen,
		int	aliasChannel,
		size_t	summaryLen,
		bool	noRMS
	)

Constructs a LegacyAliasBlockFile, writing the summary to disk.

Definition at line 24 of file LegacyAliasBlockFile.cpp.

: PCMAliasBlockFile{ std::move(fileName), std::move(aliasedFileName), aliasStart, aliasLen,
                     aliasChannel, 0.0, 0.0, 0.0 }
{
   sampleFormat format;
 
   if (noRMS)
      format = int16Sample;
   else
      format = floatSample;
 
   ComputeLegacySummaryInfo(mFileName,
                            summaryLen, format,
                            &mSummaryInfo, noRMS, FALSE,
                            &mMin, &mMax, &mRMS);
}

~LegacyAliasBlockFile()

LegacyAliasBlockFile::~LegacyAliasBlockFile ( )

virtual

Definition at line 47 of file LegacyAliasBlockFile.cpp.

{
}

Member Function Documentation

BuildFromXML()

BlockFilePtr LegacyAliasBlockFile::BuildFromXML ( const FilePath &  projDir, const wxChar **  attrs  )

static

Definition at line 87 of file LegacyAliasBlockFile.cpp.

{
   wxFileNameWrapper summaryFileName;
   wxFileNameWrapper aliasFileName;
   int aliasStart=0, aliasLen=0, aliasChannel=0;
   int summaryLen=0;
   bool noRMS = false;
   long nValue;
   long long nnValue;
 
   while(*attrs)
   {
      const wxChar *attr =  *attrs++;
      const wxChar *value = *attrs++;
      if (!value)
         break;
 
      const wxString strValue = value;
      if (!wxStricmp(attr, wxT("name")) && XMLValueChecker::IsGoodFileName(strValue, projDir))
         //v Should this be
         //    dm.AssignFile(summaryFileName, strValue, false);
         // as in PCMAliasBlockFile::BuildFromXML? Test with an old project.
         summaryFileName.Assign(projDir, strValue, wxT(""));
      else if ( !wxStricmp(attr, wxT("aliaspath")) )
      {
         if (XMLValueChecker::IsGoodPathName(strValue))
            aliasFileName.Assign(strValue);
         else if (XMLValueChecker::IsGoodFileName(strValue, projDir))
            // Allow fallback of looking for the file name, located in the data directory.
            aliasFileName.Assign(projDir, strValue);
         else if (XMLValueChecker::IsGoodPathString(strValue))
            // If the aliased file is missing, we failed XMLValueChecker::IsGoodPathName()
            // and XMLValueChecker::IsGoodFileName, because both do existence tests,
            // but we want to keep the reference to the missing file because it's a good path string.
            aliasFileName.Assign(strValue);
      }
      else if ( !wxStricmp(attr, wxT("aliasstart")) )
      {
         if (XMLValueChecker::IsGoodInt64(strValue) &&
             strValue.ToLongLong(&nnValue) && (nnValue >= 0))
            aliasStart = nnValue;
      }
      else if (XMLValueChecker::IsGoodInt(strValue) && strValue.ToLong(&nValue))
      {  // integer parameters
         if (!wxStricmp(attr, wxT("aliaslen")) && (nValue >= 0))
            aliasLen = nValue;
         else if (!wxStricmp(attr, wxT("aliaschannel")) && XMLValueChecker::IsValidChannel(aliasChannel))
            aliasChannel = nValue;
         else if (!wxStricmp(attr, wxT("summarylen")) && (nValue > 0))
            summaryLen = nValue;
         else if (!wxStricmp(attr, wxT("norms")))
            noRMS = (nValue != 0);
      }
   }
 
   return make_blockfile<LegacyAliasBlockFile>
      (std::move(summaryFileName), std::move(aliasFileName),
       aliasStart, aliasLen, aliasChannel, summaryLen, noRMS);
}

References XMLValueChecker::IsGoodFileName(), XMLValueChecker::IsGoodInt(), XMLValueChecker::IsGoodInt64(), XMLValueChecker::IsGoodPathName(), XMLValueChecker::IsGoodPathString(), and anonymous_namespace{WaveTrack.cpp}::IsValidChannel().

Here is the call graph for this function:

Copy()

BlockFilePtr LegacyAliasBlockFile::Copy ( wxFileNameWrapper &&  newFileName )

override

Construct a NEW LegacyAliasBlockFile based on this one, but writing the summary data to a NEW file.

Parameters

newFileName

The filename to copy the summary data to.

Definition at line 55 of file LegacyAliasBlockFile.cpp.

{
   auto newBlockFile = make_blockfile<LegacyAliasBlockFile>
      (std::move(newFileName), wxFileNameWrapper{ mAliasedFileName },
       mAliasStart, mLen, mAliasChannel,
       mSummaryInfo.totalSummaryBytes, mSummaryInfo.fields < 3);
 
   return newBlockFile;
}

Recover()

void LegacyAliasBlockFile::Recover ( void  )

override

Definition at line 148 of file LegacyAliasBlockFile.cpp.

                                  {
   WriteSummary();
}

SaveXML()

void LegacyAliasBlockFile::SaveXML ( XMLWriter &  xmlFile )

override

Definition at line 65 of file LegacyAliasBlockFile.cpp.

{
   xmlFile.StartTag(wxT("legacyblockfile"));
 
   xmlFile.WriteAttr(wxT("alias"), 1);
   xmlFile.WriteAttr(wxT("name"), mFileName.GetFullName());
   xmlFile.WriteAttr(wxT("aliaspath"), mAliasedFileName.GetFullPath());
   xmlFile.WriteAttr(wxT("aliasstart"),
                     mAliasStart.as_long_long() );
   xmlFile.WriteAttr(wxT("aliaslen"), mLen);
   xmlFile.WriteAttr(wxT("aliaschannel"), mAliasChannel);
   xmlFile.WriteAttr(wxT("summarylen"), mSummaryInfo.totalSummaryBytes);
   if (mSummaryInfo.fields < 3)
      xmlFile.WriteAttr(wxT("norms"), 1);
 
   xmlFile.EndTag(wxT("legacyblockfile"));
}

References XMLWriter::EndTag(), XMLWriter::StartTag(), and XMLWriter::WriteAttr().

Here is the call graph for this function:

---

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

• LegacyAliasBlockFile.h
• LegacyAliasBlockFile.cpp