PCMAliasBlockFile Class Reference

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

#include <PCMAliasBlockFile.h>

Inheritance diagram for PCMAliasBlockFile:

Collaboration diagram for PCMAliasBlockFile:

Public Member Functions
	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 (DirManager &dm, const wxChar **attrs)

Detailed Description

An AliasBlockFile that references uncompressed data in an existing file.

Definition at line 19 of file PCMAliasBlockFile.h.

Constructor & Destructor Documentation

PCMAliasBlockFile() [1/3]

PCMAliasBlockFile::PCMAliasBlockFile	(	wxFileNameWrapper &&	baseFileName,
		wxFileNameWrapper &&	aliasedFileName,
		sampleCount	aliasStart,
		size_t	aliasLen,
		int	aliasChannel
	)

Constructs a PCMAliasBlockFile, writing the summary to disk.

Definition at line 25 of file PCMAliasBlockFile.cpp.

: AliasBlockFile{ std::move(fileName), std::move(aliasedFileName),
                  aliasStart, aliasLen, aliasChannel }
{
   AliasBlockFile::WriteSummary();
}

PCMAliasBlockFile() [2/3]

PCMAliasBlockFile::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.

Definition at line 36 of file PCMAliasBlockFile.cpp.

: AliasBlockFile{ std::move(fileName), std::move(aliasedFileName),
                  aliasStart, aliasLen, aliasChannel }
{
   if(writeSummary)
      AliasBlockFile::WriteSummary();
}

PCMAliasBlockFile() [3/3]

PCMAliasBlockFile::PCMAliasBlockFile	(	wxFileNameWrapper &&	existingSummaryFileName,
		wxFileNameWrapper &&	aliasedFileName,
		sampleCount	aliasStart,
		size_t	aliasLen,
		int	aliasChannel,
		float	min,
		float	max,
		float	rms
	)

Definition at line 48 of file PCMAliasBlockFile.cpp.

: AliasBlockFile{ std::move(existingSummaryFileName), std::move(aliasedFileName),
                  aliasStart, aliasLen,
                  aliasChannel, min, max, rms }
{
}

References min().

Here is the call graph for this function:

~PCMAliasBlockFile()

PCMAliasBlockFile::~PCMAliasBlockFile ( )

virtual

Definition at line 60 of file PCMAliasBlockFile.cpp.

{
}

Member Function Documentation

BuildFromXML()

BlockFilePtr PCMAliasBlockFile::BuildFromXML ( DirManager &  dm, const wxChar **  attrs  )

static

Definition at line 118 of file PCMAliasBlockFile.cpp.

{
   wxFileNameWrapper summaryFileName;
   wxFileNameWrapper aliasFileName;
   int aliasStart=0, aliasLen=0, aliasChannel=0;
   float min = 0.0f, max = 0.0f, rms = 0.0f;
   double dblValue;
   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("summaryfile")) &&
            // Can't use XMLValueChecker::IsGoodFileName here, but do part of its test.
            XMLValueChecker::IsGoodFileString(strValue) &&
            (strValue.length() + 1 + dm.GetProjectDataDir().length() <= PLATFORM_MAX_PATH))
      {
         if (!dm.AssignFile(summaryFileName, strValue, false))
            // Make sure summaryFileName is back to uninitialized state so we can detect problem later.
            summaryFileName.Clear();
      }
      else if (!wxStricmp(attr, wxT("aliasfile")))
      {
         if (XMLValueChecker::IsGoodPathName(strValue))
            aliasFileName.Assign(strValue);
         else if (XMLValueChecker::IsGoodFileName(strValue, dm.GetProjectDataDir()))
            // Allow fallback of looking for the file name, located in the data directory.
            aliasFileName.Assign(dm.GetProjectDataDir(), 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("min")))
            min = nValue;
         else if (!wxStricmp(attr, wxT("max")))
            max = nValue;
         else if (!wxStricmp(attr, wxT("rms")) && (nValue >= 0))
            rms = nValue;
      }
      // mchinen: the min/max can be (are?) doubles as well, so handle those cases.
      // Vaughan: The code to which I added the XMLValueChecker checks
      // used wxAtoi to convert the string to an int.
      // So it's possible some prior project formats used ints (?), so am keeping
      // those above, but yes, we need to handle floats.
      else if (XMLValueChecker::IsGoodString(strValue) && Internat::CompatibleToDouble(strValue, &dblValue))
      {  // double parameters
         if (!wxStricmp(attr, wxT("min")))
            min = dblValue;
         else if (!wxStricmp(attr, wxT("max")))
            max = dblValue;
         else if (!wxStricmp(attr, wxT("rms")) && (dblValue >= 0.0))
            rms = dblValue;
      }
   }
 
   return make_blockfile<PCMAliasBlockFile>
      (std::move(summaryFileName), std::move(aliasFileName),
       aliasStart, aliasLen, aliasChannel, min, max, rms);
}

References Internat::CompatibleToDouble(), XMLValueChecker::IsGoodFileName(), XMLValueChecker::IsGoodFileString(), XMLValueChecker::IsGoodInt(), XMLValueChecker::IsGoodInt64(), XMLValueChecker::IsGoodPathName(), XMLValueChecker::IsGoodPathString(), XMLValueChecker::IsGoodString(), anonymous_namespace{WaveTrack.cpp}::IsValidChannel(), min(), and PLATFORM_MAX_PATH.

Here is the call graph for this function:

Copy()

BlockFilePtr PCMAliasBlockFile::Copy ( wxFileNameWrapper &&  newFileName )

override

Construct a NEW PCMAliasBlockFile 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 88 of file PCMAliasBlockFile.cpp.

{
   auto newBlockFile = make_blockfile<PCMAliasBlockFile>
      (std::move(newFileName), wxFileNameWrapper{mAliasedFileName},
       mAliasStart, mLen, mAliasChannel, mMin, mMax, mRMS);
 
   return newBlockFile;
}

ReadData()

size_t PCMAliasBlockFile::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.

Reads the specified data from the aliased file, using libsndfile, and converts it to the given sample format.

Parameters

data	The buffer to read the sample data into.
format	The format to convert the data into
start	The offset within the block to begin reading
len	The number of samples to read

Definition at line 71 of file PCMAliasBlockFile.cpp.

{
   if(!mAliasedFileName.IsOk()){ // intentionally silenced
      memset(data, 0, SAMPLE_SIZE(format) * len);
      return len;
   }
 
   return CommonReadData( mayThrow,
      mAliasedFileName, mSilentAliasLog, this, mAliasStart, mAliasChannel,
      data, format, start, len);
}

References format, and SAMPLE_SIZE.

Recover()

void PCMAliasBlockFile::Recover ( void  )

override

Definition at line 198 of file PCMAliasBlockFile.cpp.

{
   WriteSummary();
}

SaveXML()

void PCMAliasBlockFile::SaveXML ( XMLWriter &  xmlFile )

override

Definition at line 97 of file PCMAliasBlockFile.cpp.

{
   xmlFile.StartTag(wxT("pcmaliasblockfile"));
 
   xmlFile.WriteAttr(wxT("summaryfile"), mFileName.GetFullName());
   xmlFile.WriteAttr(wxT("aliasfile"), mAliasedFileName.GetFullPath());
   xmlFile.WriteAttr(wxT("aliasstart"),
                     mAliasStart.as_long_long());
   xmlFile.WriteAttr(wxT("aliaslen"), mLen);
   xmlFile.WriteAttr(wxT("aliaschannel"), mAliasChannel);
   xmlFile.WriteAttr(wxT("min"), mMin);
   xmlFile.WriteAttr(wxT("max"), mMax);
   xmlFile.WriteAttr(wxT("rms"), mRMS);
 
   xmlFile.EndTag(wxT("pcmaliasblockfile"));
}

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

Referenced by ODPCMAliasBlockFile::SaveXML().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• PCMAliasBlockFile.h
• PCMAliasBlockFile.cpp