SilentBlockFile Class Reference

A BlockFile containing nothing but silence. Saves disk space. More...

#include <SilentBlockFile.h>

Inheritance diagram for SilentBlockFile:

Collaboration diagram for SilentBlockFile:

Public Member Functions
	SilentBlockFile (size_t sampleLen)
virtual	~SilentBlockFile ()
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 (DirManager &dm, const wxChar **attrs)
	static More...

Detailed Description

A BlockFile containing nothing but silence. Saves disk space.

Definition at line 22 of file SilentBlockFile.h.

Constructor & Destructor Documentation

SilentBlockFile()

SilentBlockFile::SilentBlockFile

(

size_t

sampleLen

)

Definition at line 18 of file SilentBlockFile.cpp.

                                                :
BlockFile{ wxFileNameWrapper{}, sampleLen }
{
   mMin = 0.;
   mMax = 0.;
   mRMS = 0.;
}

~SilentBlockFile()

SilentBlockFile::~SilentBlockFile ( )

virtual

Definition at line 26 of file SilentBlockFile.cpp.

{
}

Member Function Documentation

BuildFromXML()

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

static

static

Definition at line 59 of file SilentBlockFile.cpp.

{
   long nValue;
   size_t len = 0;
 
   while(*attrs)
   {
       const wxChar *attr =  *attrs++;
       const wxChar *value = *attrs++;
       if (!value)
         break;
 
       const wxString strValue = value;
       if (!wxStrcmp(attr, wxT("len")) &&
            XMLValueChecker::IsGoodInt(strValue) &&
            strValue.ToLong(&nValue) &&
            nValue > 0)
         len = nValue;
   }
 
   return make_blockfile<SilentBlockFile>(len);
}

References XMLValueChecker::IsGoodInt().

Here is the call graph for this function:

Copy()

BlockFilePtr SilentBlockFile::Copy ( wxFileNameWrapper &&  newFileName )

override

Create a NEW block file identical to this one.

Create a copy of this BlockFile.

Definition at line 83 of file SilentBlockFile.cpp.

{
   auto newBlockFile = make_blockfile<SilentBlockFile>(mLen);
 
   return newBlockFile;
}

GetSpaceUsage()

auto SilentBlockFile::GetSpaceUsage ( ) const

override

Definition at line 90 of file SilentBlockFile.cpp.

{
   return 0;
}

ReadData()

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

override

Read the data section of the disk file.

Definition at line 37 of file SilentBlockFile.cpp.

{
   ClearSamples(data, format, 0, len);
 
   return len;
}

References ClearSamples(), and format.

Here is the call graph for this function:

ReadSummary()

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

override

Read the summary section of the disk file.

Definition at line 30 of file SilentBlockFile.cpp.

{
   data.reinit( mSummaryInfo.totalSummaryBytes );
   memset(data.get(), 0, mSummaryInfo.totalSummaryBytes);
   return true;
}

References ArrayOf< X >::reinit().

Here is the call graph for this function:

Recover()

void SilentBlockFile::Recover ( void  )

inlineoverride

Definition at line 44 of file SilentBlockFile.h.

{ };

SaveXML()

void SilentBlockFile::SaveXML ( XMLWriter &  xmlFile )

override

Write an XML representation of this file.

Definition at line 45 of file SilentBlockFile.cpp.

{
   xmlFile.StartTag(wxT("silentblockfile"));
 
   xmlFile.WriteAttr(wxT("len"), mLen);
 
   xmlFile.EndTag(wxT("silentblockfile"));
}

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:

• SilentBlockFile.h
• SilentBlockFile.cpp