LegacyBlockFile Class Reference

Audacity 1.1.0 block file format: More...

#include <LegacyBlockFile.h>

Inheritance diagram for LegacyBlockFile:

Collaboration diagram for LegacyBlockFile:

Public Member Functions
	LegacyBlockFile (wxFileNameWrapper &&existingFile, sampleFormat format, size_t summaryLen, size_t len, bool noRMS)
	Create the memory structure to refer to the given block file. More...
virtual	~LegacyBlockFile ()
bool	ReadSummary (ArrayOf< char > &data) override
	Read the summary section of the disk file. More...
size_t	ReadData (samplePtr data, sampleFormat format, size_t start, size_t len, bool mayThrow) const override
	Read the data section of the disk file. More...
BlockFilePtr	Copy (wxFileNameWrapper &&newFileName) override
	Create a NEW block file identical to this one. More...
void	SaveXML (XMLWriter &xmlFile) override
	Write an XML representation of this file. More...
DiskByteCount	GetSpaceUsage () const override
void	Recover () override

Static Public Member Functions
static BlockFilePtr	BuildFromXML (const FilePath &dir, const wxChar **attrs, size_t len, sampleFormat format)
	static More...

Protected Attributes
sampleFormat	mFormat

Detailed Description

Audacity 1.1.0 block file format:

• Header tag: 20 bytes "AudacityBlockFile110"
• 64K summaries (min, max, RMS, each a 4-byte float)
• 256 summaries (min, max, RMS, each a 4-byte float)

Definition at line 34 of file LegacyBlockFile.h.

Constructor & Destructor Documentation

LegacyBlockFile()

LegacyBlockFile::LegacyBlockFile	(	wxFileNameWrapper &&	existingFile,
		sampleFormat	format,
		size_t	summaryLen,
		size_t	len,
		bool	noRMS
	)

Create the memory structure to refer to the given block file.

Construct a LegacyBlockFile memory structure that will point to an existing block file. This file must exist and be a valid block file.

Parameters

existingFile

The disk file this LegacyBlockFile should use.

Definition at line 126 of file LegacyBlockFile.cpp.

                                            :
   BlockFile{ std::move(existingFile), len },
   mFormat(format)
{
 
   sampleFormat summaryFormat;
 
   if (noRMS)
      summaryFormat = int16Sample;
   else
      summaryFormat = floatSample;
 
   ComputeLegacySummaryInfo(mFileName,
                            summaryLen, summaryFormat,
                            &mSummaryInfo, noRMS, FALSE,
                            &mMin, &mMax, &mRMS);
}

~LegacyBlockFile()

LegacyBlockFile::~LegacyBlockFile ( )

virtual

Definition at line 148 of file LegacyBlockFile.cpp.

{
}

Member Function Documentation

BuildFromXML()

BlockFilePtr LegacyBlockFile::BuildFromXML ( const FilePath &  dir, const wxChar **  attrs, size_t  len, sampleFormat  format  )

static

static

Definition at line 223 of file LegacyBlockFile.cpp.

{
   wxFileNameWrapper fileName;
   size_t summaryLen = 0;
   bool noRMS = false;
   long nValue;
 
   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(fileName, strValue, false);
         // as in PCMAliasBlockFile::BuildFromXML? Test with an old project.
         fileName.Assign(projDir, strValue);
      else if (XMLValueChecker::IsGoodInt(strValue) && strValue.ToLong(&nValue))
      {  // integer parameters
         if (!wxStrcmp(attr, wxT("len")) && (nValue >= 0))
            len = nValue;
         else if (!wxStrcmp(attr, wxT("norms")))
            noRMS = (nValue != 0);
         else if (!wxStrcmp(attr, wxT("format")) && XMLValueChecker::IsValidSampleFormat(nValue))
            format = (sampleFormat)nValue;
         else if (!wxStrcmp(attr, wxT("summarylen")) && (nValue > 0))
            // Note attribute "summarylen" was written as int, no need for 64 bits
            summaryLen = nValue;
      }
   }
 
   return make_blockfile<LegacyBlockFile>
      (std::move(fileName), format, summaryLen, len, noRMS);
}

References format, XMLValueChecker::IsGoodFileName(), and XMLValueChecker::IsGoodInt().

Here is the call graph for this function:

Copy()

BlockFilePtr LegacyBlockFile::Copy ( wxFileNameWrapper &&  newFileName )

override

Create a NEW block file identical to this one.

Create a copy of this BlockFile, but using a different disk file.

Parameters

newFileName

The name of the NEW file to use.

Definition at line 265 of file LegacyBlockFile.cpp.

{
   return make_blockfile<LegacyBlockFile>
       (std::move(newFileName),
        mFormat, mSummaryInfo.totalSummaryBytes,
        mLen, mSummaryInfo.fields < 3);
}

References mFormat.

GetSpaceUsage()

auto LegacyBlockFile::GetSpaceUsage ( ) const

override

Definition at line 273 of file LegacyBlockFile.cpp.

{
   wxFFile dataFile(mFileName.GetFullPath());
   return dataFile.Length();
}

ReadData()

size_t LegacyBlockFile::ReadData ( samplePtr  data, sampleFormat  format, size_t  start, size_t  len, bool  mayThrow  ) const

override

Read the data section of the disk file.

Read the data portion of the block file using libsndfile. Convert it to the given format if it is not already.

Parameters

data	The buffer where the data will be stored
format	The format the data will be stored in
start	The offset in this block file
len	The number of samples to read

Definition at line 195 of file LegacyBlockFile.cpp.

{
   sf_count_t origin = (mSummaryInfo.totalSummaryBytes / SAMPLE_SIZE(mFormat));
   return CommonReadData( mayThrow,
      mFileName, mSilentLog, nullptr, origin, 0, data, format, start, len,
      &mFormat, mLen
   );
}

References format, mFormat, and SAMPLE_SIZE.

ReadSummary()

bool LegacyBlockFile::ReadSummary ( ArrayOf< char > &  data )

override

Read the summary section of the disk file.

Read the summary section of the disk file. Fill with zeroes and return false if data are unavailable for any reason.

Parameters

*data

The buffer to write the data to. It must be at least mSummaryinfo.totalSummaryBytes long.

Definition at line 157 of file LegacyBlockFile.cpp.

{
   data.reinit( mSummaryInfo.totalSummaryBytes );
   wxFFile summaryFile(mFileName.GetFullPath(), wxT("rb"));
   size_t read;
   {
      Optional<wxLogNull> silence{};
      if (mSilentLog)
         silence.emplace();
 
      if (!summaryFile.IsOpened()) {
 
         memset(data.get(), 0, mSummaryInfo.totalSummaryBytes);
 
         mSilentLog = TRUE;
 
         return false;
      }
 
      read = summaryFile.Read(data.get(), mSummaryInfo.totalSummaryBytes);
   }
   mSilentLog = FALSE;
 
   if (read != mSummaryInfo.totalSummaryBytes) {
      memset(data.get(), 0, mSummaryInfo.totalSummaryBytes);
      return false;
   }
 
   return true;
}

References Optional< X >::emplace(), and ArrayOf< X >::reinit().

Here is the call graph for this function:

Recover()

void LegacyBlockFile::Recover ( void  )

override

Definition at line 279 of file LegacyBlockFile.cpp.

{
 
 
}

SaveXML()

void LegacyBlockFile::SaveXML ( XMLWriter &  xmlFile )

override

Write an XML representation of this file.

Definition at line 205 of file LegacyBlockFile.cpp.

{
   xmlFile.StartTag(wxT("legacyblockfile"));
 
   xmlFile.WriteAttr(wxT("name"), mFileName.GetFullName());
   xmlFile.WriteAttr(wxT("len"), mLen);
   if (mSummaryInfo.fields < 3)
      xmlFile.WriteAttr(wxT("norms"), 1);
   xmlFile.WriteAttr(wxT("summarylen"), mSummaryInfo.totalSummaryBytes);
 
   xmlFile.EndTag(wxT("legacyblockfile"));
}

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

Here is the call graph for this function:

Member Data Documentation

mFormat

sampleFormat LegacyBlockFile::mFormat

protected

Definition at line 67 of file LegacyBlockFile.h.

Referenced by Copy(), and ReadData().

---

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

• LegacyBlockFile.h
• LegacyBlockFile.cpp