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

#include <ODPCMAliasBlockFile.h>

Inheritance diagram for ODPCMAliasBlockFile:

Collaboration diagram for ODPCMAliasBlockFile:

Public Member Functions
	ODPCMAliasBlockFile (wxFileNameWrapper &&baseFileName, wxFileNameWrapper &&aliasedFileName, sampleCount aliasStart, size_t aliasLen, int aliasChannel)
	Constructs a PCMAliasBlockFile, writing the summary to disk. More...

	ODPCMAliasBlockFile (wxFileNameWrapper &&existingSummaryFileName, wxFileNameWrapper &&aliasedFileName, sampleCount aliasStart, size_t aliasLen, int aliasChannel, float min, float max, float rms, bool summaryAvailable)
	summaryAvailable should be true if the file has been written already. More...

virtual	~ODPCMAliasBlockFile ()

bool	IsSummaryAvailable () const override

bool	IsSummaryBeingComputed () override
	Returns TRUE if the summary has not yet been written, but is actively being computed and written to disk. More...

DiskByteCount	GetSpaceUsage () const override

MinMaxRMS	GetMinMaxRMS (size_t start, size_t len, bool mayThrow) const override
	Gets extreme values for the specified region. More...

MinMaxRMS	GetMinMaxRMS (bool mayThrow) const override
	Gets extreme values for the entire block. More...

bool	Read256 (float *buffer, size_t start, size_t len) override
	Returns the 256 byte summary data block. More...

bool	Read64K (float *buffer, size_t start, size_t len) override
	Returns the 64K summary data block. More...

BlockFilePtr	Copy (wxFileNameWrapper &&fileName) override
	Makes NEW ODPCMAliasBlockFile or PCMAliasBlockFile depending on summary availability. More...

void	SaveXML (XMLWriter &xmlFile) override
	Saves as xml ODPCMAliasBlockFile or PCMAliasBlockFile depending on summary availability. More...

void	Recover (void) override
	Writes the summary file if summary data is available. More...

void	DoWriteSummary ()
	A public interface to WriteSummary. More...

void	SetStart (sampleCount startSample)
	Sets the value that indicates where the first sample in this block corresponds to the global sequence/clip. Only for display use. More...

sampleCount	GetStart () const
	Gets the value that indicates where the first sample in this block corresponds to the global sequence/clip. Only for display use. More...

void	Lock () override
	Locks the blockfile only if it has a file that exists. More...

void	Unlock () override
	Unlocks the blockfile only if it has a file that exists. More...

void	SetClipOffset (sampleCount numSamples)
	sets the amount of samples the clip associated with this blockfile is offset in the wavetrack (non effecting) More...

sampleCount	GetClipOffset () const
	Gets the number of samples the clip associated with this blockfile is offset by. More...

sampleCount	GetGlobalStart () const

sampleCount	GetGlobalEnd () const

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

bool	ReadSummary (ArrayOf< char > &data) override
	Read the summary into a buffer. More...

void	SetFileName (wxFileNameWrapper &&name) override
	sets the file name the summary info will be saved in. threadsafe. More...

GetFileNameResult	GetFileName () const override
	sets the file name the summary info will be saved in. threadsafe. More...

void	CloseLock () override

void	LockRead () const override
	Prevents a read on other threads. More...

void	UnlockRead () const override
	Allows reading on other threads. More...

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 (DirManager &dm, const wxChar **attrs)
	Reconstructs from XML a ODPCMAliasBlockFile and reschedules it for OD loading. More...

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

Protected Member Functions
void	WriteSummary () override
	Write the summary to disk, using the derived ReadData() to get the data. More...

void *	CalcSummary (samplePtr buffer, size_t len, sampleFormat format, ArrayOf< char > &cleanup) override

Private Attributes
ODLock	mWriteSummaryMutex

ODLock	mFileNameMutex

ODLock	mAliasedFileNameMutex
	Also need to protect the aliased file name. More...

ODLock	mReadDataMutex

ODLock	mSummaryAvailableMutex

bool	mSummaryAvailable

bool	mSummaryBeingComputed

bool	mHasBeenSaved

sampleCount	mStart
	for reporting after task is complete. Only for display use. More...

sampleCount	mClipOffset
	the ODTask needs to know where this blockfile lies in the track, so for convenience, we have this here. More...

Detailed Description

An AliasBlockFile that references uncompressed data in an existing file.

ODPCMAliasBlockFile is a special type of PCMAliasBlockFile that does not necessarily have summary data available The summary is eventually computed and written to a file in a background thread.

Load On-Demand implementation of the AliasBlockFile for PCM files.

to load large files more quickly, we skip computing the summary data and put ODPCMAliasBlockFiles in the sequence as place holders. A background thread loads and computes the summary data into these classes. ODPCMAliasBlockFiles unlike all other BlockFiles are not immutable (for the most part,) because when NEW summary data is computed for an existing ODPCMAliasBlockFile we save the buffer then and write the Summary File.

All BlockFile methods that treat the summary data as a buffer that exists in its BlockFile are implemented here to behave when the data is not available yet.

Some of these methods have been overridden only because they used the unsafe wxLog calls in the base class.

Definition at line 42 of file ODPCMAliasBlockFile.h.

Constructor & Destructor Documentation

◆ ODPCMAliasBlockFile() [1/2]

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

Constructs a PCMAliasBlockFile, writing the summary to disk.

Definition at line 44 of file ODPCMAliasBlockFile.cpp.

 : PCMAliasBlockFile { std::move(fileName), std::move(aliasedFileName),
                       aliasStart, aliasLen, aliasChannel, false }
 {
    mSummaryAvailable = mSummaryBeingComputed = mHasBeenSaved = false;
 }

◆ ODPCMAliasBlockFile() [2/2]

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

summaryAvailable should be true if the file has been written already.

Definition at line 56 of file ODPCMAliasBlockFile.cpp.

 : PCMAliasBlockFile(std::move(existingSummaryFileName), std::move(aliasedFileName),
                     aliasStart, aliasLen,
                     aliasChannel, min, max, rms)
 {
    mSummaryAvailable=summaryAvailable;
    mSummaryBeingComputed=mHasBeenSaved=false;
  }

References mHasBeenSaved, mSummaryAvailable, and mSummaryBeingComputed.

◆ ~ODPCMAliasBlockFile()

ODPCMAliasBlockFile::~ODPCMAliasBlockFile ( )

virtual

Definition at line 70 of file ODPCMAliasBlockFile.cpp.

71 {

72 }

Member Function Documentation

◆ BuildFromXML()

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

static

Reconstructs from XML a ODPCMAliasBlockFile and reschedules it for OD loading.

Constructs a ODPCMAliasBlockFile from the xml output of WriteXML. Does not schedule the ODPCMAliasBlockFile for OD loading. Client code must do this.

Definition at line 272 of file ODPCMAliasBlockFile.cpp.

 {
    wxFileNameWrapper summaryFileName;
    wxFileNameWrapper aliasFileName;
    sampleCount aliasStart = 0;
    size_t aliasLen = 0;
    int aliasChannel=0;
    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;
       }
    }
  
    return make_blockfile<ODPCMAliasBlockFile>
       (std::move(summaryFileName), std::move(aliasFileName),
        aliasStart, aliasLen, aliasChannel, 0, 0, 0, false);
 }

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

Here is the call graph for this function:

◆ CalcSummary()

void * ODPCMAliasBlockFile::CalcSummary	(	samplePtr	buffer,
		size_t	len,
		sampleFormat	format,
		ArrayOf< char > &	cleanup
	)

overrideprotected

A thread-safe version of CalcSummary. BlockFile::CalcSummary uses a static summary array across the class, which we can't use. Get a buffer containing a summary block describing this sample data. This must be called by derived classes when they are constructed, to allow them to construct their summary data, after which they should write that data to their disk file.

This method also has the side effect of setting the mMin, mMax, and mRMS members of this class.

Unlike BlockFile's implementation You SHOULD DELETE the returned buffer. this is protected so it shouldn't be hard to deal with - just override all BlockFile methods that use this method.

Parameters

buffer	A buffer containing the sample data to be analyzed
len	The length of the sample data
format	The format of the sample data.

Definition at line 450 of file ODPCMAliasBlockFile.cpp.

 {
    cleanup.reinit(mSummaryInfo.totalSummaryBytes);
    char* localFullSummary = cleanup.get();
  
    memcpy(localFullSummary, aheaderTag, aheaderTagLen);
  
    float *summary64K = (float *)(localFullSummary + mSummaryInfo.offset64K);
    float *summary256 = (float *)(localFullSummary + mSummaryInfo.offset256);
  
    Floats floats;
    float *fbuffer;
  
    //mchinen: think we can hack this - don't allocate and copy if we don't need to.,
    if(format==floatSample)
    {
       fbuffer = (float*)buffer;
    }
    else
    {
       floats.reinit(len);
       fbuffer = floats.get();
       CopySamples(buffer, format,
                (samplePtr)fbuffer, floatSample, len);
    }
  
    BlockFile::CalcSummaryFromBuffer(fbuffer, len, summary256, summary64K);
  
    return localFullSummary;
 }

References aheaderTag, aheaderTagLen, CopySamples(), floatSample, format, and ArrayOf< X >::reinit().

Referenced by WriteSummary().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CloseLock()

void ODPCMAliasBlockFile::CloseLock ( )

override

Definition at line 104 of file ODPCMAliasBlockFile.cpp.

 {
    if(mHasBeenSaved)
       PCMAliasBlockFile::Lock();
 }

References mHasBeenSaved.

◆ Copy()

BlockFilePtr ODPCMAliasBlockFile::Copy ( wxFileNameWrapper && newFileName )

override

Makes NEW ODPCMAliasBlockFile or PCMAliasBlockFile depending on summary availability.

If the summary has been computed, Construct a NEW PCMAliasBlockFile based on this one. otherwise construct an ODPCMAliasBlockFile that still needs to be computed.

Parameters

newFileName The filename to copy the summary data to.

Definition at line 201 of file ODPCMAliasBlockFile.cpp.

 {
    BlockFilePtr newBlockFile;
  
    //mAliasedFile can change so we lock readdatamutex, which is responsible for it.
    auto locker = LockForRead();
    //If the file has been written AND it has been saved, we create a PCM alias blockfile because for
    //all intents and purposes, it is the same.
    //However, if it hasn't been saved yet, we shouldn't create one because the default behavior of the
    //PCMAliasBlockFile is to lock on exit, and this will cause orphaned blockfiles..
    if(IsSummaryAvailable() && mHasBeenSaved)
    {
       newBlockFile  = make_blockfile<PCMAliasBlockFile>
          (std::move(newFileName), wxFileNameWrapper{mAliasedFileName},
           mAliasStart, mLen, mAliasChannel, mMin, mMax, mRMS);
  
    }
    else
    {
       //Summary File might exist in this case, but it might not.
       newBlockFile  = make_blockfile<ODPCMAliasBlockFile>
          (std::move(newFileName), wxFileNameWrapper{mAliasedFileName},
           mAliasStart, mLen, mAliasChannel, mMin, mMax, mRMS,
           IsSummaryAvailable());
       //The client code will need to schedule this blockfile for OD summarizing if it is going to a NEW track.
    }
  
    return newBlockFile;
 }

References IsSummaryAvailable(), and mHasBeenSaved.

Here is the call graph for this function:

◆ DoWriteSummary()

void ODPCMAliasBlockFile::DoWriteSummary ( )

A public interface to WriteSummary.

Calls write summary, and makes sure it is only done once in a thread-safe fashion.

Definition at line 352 of file ODPCMAliasBlockFile.cpp.

 {
    ODLocker locker { &mWriteSummaryMutex };
    if(!IsSummaryAvailable())
       WriteSummary();
 }

References IsSummaryAvailable(), mWriteSummaryMutex, and WriteSummary().

Here is the call graph for this function:

◆ GetClipOffset()

sampleCount ODPCMAliasBlockFile::GetClipOffset ( ) const

inline

Gets the number of samples the clip associated with this blockfile is offset by.

Definition at line 104 of file ODPCMAliasBlockFile.h.

104 {return mClipOffset;}

References mClipOffset.

Referenced by ODComputeSummaryTask::Update().

Here is the caller graph for this function:

◆ GetFileName()

auto ODPCMAliasBlockFile::GetFileName ( ) const

override

sets the file name the summary info will be saved in. threadsafe.

Definition at line 368 of file ODPCMAliasBlockFile.cpp.

 {
    return { mFileName, ODLocker{ &mFileNameMutex } };
 }

References mFileNameMutex.

◆ GetGlobalEnd()

sampleCount ODPCMAliasBlockFile::GetGlobalEnd ( ) const

inline

Definition at line 110 of file ODPCMAliasBlockFile.h.

110 {return mClipOffset+mStart+GetLength();}

References mClipOffset, and mStart.

Referenced by ODComputeSummaryTask::OrderBlockFiles().

Here is the caller graph for this function:

◆ GetGlobalStart()

sampleCount ODPCMAliasBlockFile::GetGlobalStart ( ) const

inline

Definition at line 107 of file ODPCMAliasBlockFile.h.

107 {return mClipOffset+mStart;}

References mClipOffset, and mStart.

Referenced by ODComputeSummaryTask::OrderBlockFiles().

Here is the caller graph for this function:

◆ GetMinMaxRMS() [1/2]

auto ODPCMAliasBlockFile::GetMinMaxRMS ( bool mayThrow ) const

override

Gets extreme values for the entire block.

Definition at line 144 of file ODPCMAliasBlockFile.cpp.

 {
   if(IsSummaryAvailable())
    {
       return PCMAliasBlockFile::GetMinMaxRMS(mayThrow);
    }
    else
    {
       if (mayThrow)
          throw NotYetAvailableException{ GetAliasedFileName() };
  
       //fake values.  These values are used usually for normalization and amplifying, so we want
       //the max to be maximal and the min to be minimal
       return {
          -JUST_BELOW_MAX_AUDIO,
          JUST_BELOW_MAX_AUDIO,
          0.707f //sin with amp of 1 rms
       };
    }
 }

◆ GetMinMaxRMS() [2/2]

auto ODPCMAliasBlockFile::GetMinMaxRMS	(	size_t	start,
		size_t	len,
		bool	mayThrow
	)		const

override

Gets extreme values for the specified region.

Definition at line 121 of file ODPCMAliasBlockFile.cpp.

 {
    if(IsSummaryAvailable())
    {
       return PCMAliasBlockFile::GetMinMaxRMS(start, len, mayThrow);
    }
    else
    {
       if (mayThrow)
          throw NotYetAvailableException{ GetAliasedFileName() };
  
       //fake values.  These values are used usually for normalization and amplifying, so we want
       //the max to be maximal and the min to be minimal
       return {
          -JUST_BELOW_MAX_AUDIO,
          JUST_BELOW_MAX_AUDIO,
          0.707f //sin with amp of 1 rms
       };
    }
 }

◆ GetSpaceUsage()

auto ODPCMAliasBlockFile::GetSpaceUsage ( ) const

override

Definition at line 77 of file ODPCMAliasBlockFile.cpp.

 {
    if(IsSummaryAvailable())
    {
       DiskByteCount ret;
       mFileNameMutex.Lock();
       wxFFile summaryFile(mFileName.GetFullPath());
       ret= summaryFile.Length();
       mFileNameMutex.Unlock();
       return ret;
    }
    else
    {
       return 0;
    }
 }

References IsSummaryAvailable(), and mFileNameMutex.

Here is the call graph for this function:

◆ GetStart()

sampleCount ODPCMAliasBlockFile::GetStart ( ) const

inline

Gets the value that indicates where the first sample in this block corresponds to the global sequence/clip. Only for display use.

Definition at line 92 of file ODPCMAliasBlockFile.h.

92 {return mStart;}

References mStart.

Referenced by ODComputeSummaryTask::Update().

Here is the caller graph for this function:

◆ IsSummaryAvailable()

bool ODPCMAliasBlockFile::IsSummaryAvailable ( ) const

override

Definition at line 342 of file ODPCMAliasBlockFile.cpp.

 {
    bool retval;
    mSummaryAvailableMutex.Lock();
    retval= mSummaryAvailable;
    mSummaryAvailableMutex.Unlock();
    return retval;
 }

References mSummaryAvailable, and mSummaryAvailableMutex.

Referenced by Copy(), DoWriteSummary(), GetSpaceUsage(), Lock(), Read256(), Read64K(), Recover(), SaveXML(), and Unlock().

Here is the caller graph for this function:

◆ IsSummaryBeingComputed()

bool ODPCMAliasBlockFile::IsSummaryBeingComputed ( )

inlineoverride

Returns TRUE if the summary has not yet been written, but is actively being computed and written to disk.

Definition at line 59 of file ODPCMAliasBlockFile.h.

59 { return mSummaryBeingComputed; }

References mSummaryBeingComputed.

◆ Lock()

void ODPCMAliasBlockFile::Lock ( )

override

Locks the blockfile only if it has a file that exists.

Locks the blockfile only if it has a file that exists. This needs to be done so that the unsaved ODPCMAliasBlockfiles are deleted upon exit

Definition at line 96 of file ODPCMAliasBlockFile.cpp.

 {
    if(IsSummaryAvailable()&&mHasBeenSaved)
       PCMAliasBlockFile::Lock();
 }

References IsSummaryAvailable(), and mHasBeenSaved.

Here is the call graph for this function:

◆ LockRead()

void ODPCMAliasBlockFile::LockRead ( ) const

override

Prevents a read on other threads.

Definition at line 551 of file ODPCMAliasBlockFile.cpp.

 {
    mReadDataMutex.Lock();
 }

References mReadDataMutex.

◆ Read256()

bool ODPCMAliasBlockFile::Read256	(	float *	buffer,
		size_t	start,
		size_t	len
	)

override

Returns the 256 byte summary data block.

Returns the 256 byte summary data block. Fill with zeroes and return false if data are unavailable for any reason.

Definition at line 167 of file ODPCMAliasBlockFile.cpp.

 {
    if(IsSummaryAvailable())
    {
       return PCMAliasBlockFile::Read256(buffer,start,len);
    }
    else
    {
       //return nothing.
       ClearSamples((samplePtr)buffer, floatSample, 0, len);
       return false;
    }
 }

References ClearSamples(), floatSample, and IsSummaryAvailable().

Here is the call graph for this function:

◆ Read64K()

bool ODPCMAliasBlockFile::Read64K	(	float *	buffer,
		size_t	start,
		size_t	len
	)

override

Returns the 64K summary data block.

Returns the 64K summary data block. Fill with zeroes and return false if data are unavailable for any reason.

Definition at line 183 of file ODPCMAliasBlockFile.cpp.

 {
    if(IsSummaryAvailable())
    {
       return PCMAliasBlockFile::Read64K(buffer,start,len);
    }
    else
    {
       //return nothing - it hasn't been calculated yet
       ClearSamples((samplePtr)buffer, floatSample, 0, len);
       return false;
    }
 }

References ClearSamples(), floatSample, and IsSummaryAvailable().

Here is the call graph for this function:

◆ ReadData()

size_t ODPCMAliasBlockFile::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. Copied from PCMAliasBlockFIle but wxLog calls taken out for thread safety

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 493 of file ODPCMAliasBlockFile.cpp.

 {
  
    auto locker = LockForRead();
  
    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.

Referenced by WriteSummary().

Here is the caller graph for this function:

◆ ReadSummary()

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

override

Read the summary into a buffer.

Read the summary of this alias block from disk. Since the audio data is elsewhere, this consists of reading the entire summary file. Fill with zeroes and return false if data are unavailable for any reason.

Parameters

*data The buffer where the summary data will be stored. It must be at least mSummaryInfo.totalSummaryBytes long.

Definition at line 515 of file ODPCMAliasBlockFile.cpp.

 {
    data.reinit( mSummaryInfo.totalSummaryBytes );
  
    ODLocker locker{ &mFileNameMutex };
    wxFFile summaryFile(mFileName.GetFullPath(), wxT("rb"));
  
    if( !summaryFile.IsOpened() ) {
  
       // NEW model; we need to return valid data
       memset(data.get(), 0, mSummaryInfo.totalSummaryBytes);
  
       // we silence the logging for this operation in this object
       // after first occurrence of error; it's already reported and
       // spewing at the user will complicate the user's ability to
       // deal
       mSilentLog = TRUE;
  
       return false;
    }
    else
       mSilentLog = FALSE; // worked properly, any future error is NEW
  
    auto read = summaryFile.Read(data.get(), mSummaryInfo.totalSummaryBytes);
  
    if (read != mSummaryInfo.totalSummaryBytes) {
       memset(data.get(), 0, mSummaryInfo.totalSummaryBytes);
       return false;
    }
    
    FixSummary(data.get());
  
    return true;
 }

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

Here is the call graph for this function:

◆ Recover()

void ODPCMAliasBlockFile::Recover ( void )

override

Writes the summary file if summary data is available.

Definition at line 334 of file ODPCMAliasBlockFile.cpp.

 {
    if(IsSummaryAvailable())
    {
       WriteSummary();
    }
 }

References IsSummaryAvailable(), and WriteSummary().

Here is the call graph for this function:

◆ SaveXML()

void ODPCMAliasBlockFile::SaveXML ( XMLWriter & xmlFile )

override

Saves as xml ODPCMAliasBlockFile or PCMAliasBlockFile depending on summary availability.

Writes the xml as a PCMAliasBlockFile if we can (if we have a summary file) Otherwise writes XML as a subset of attributes with 'odpcmaliasblockfile as the start tag. Most notably, the summaryfile attribute refers to a file that does not yet exist, so when the project file is read back in and this object reconstructed, it needs to avoid trying to open it as well as schedule itself for OD loading

Definition at line 236 of file ODPCMAliasBlockFile.cpp.

 {
    //we lock this so that mAliasedFileName doesn't change.
    auto locker = LockForRead();
    if(IsSummaryAvailable())
    {
       PCMAliasBlockFile::SaveXML(xmlFile);
       mHasBeenSaved = true;
    }
    else
    {
       xmlFile.StartTag(wxT("odpcmaliasblockfile"));
  
       //unlock to prevent deadlock and resume lock after.
       {
          auto suspension = locker.Suspend();
          ODLocker locker2 { &mFileNameMutex };
          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.EndTag(wxT("odpcmaliasblockfile"));
    }
 }

References XMLWriter::EndTag(), IsSummaryAvailable(), mFileNameMutex, mHasBeenSaved, PCMAliasBlockFile::SaveXML(), XMLWriter::StartTag(), and XMLWriter::WriteAttr().

Here is the call graph for this function:

◆ SetClipOffset()

void ODPCMAliasBlockFile::SetClipOffset ( sampleCount numSamples )

inline

sets the amount of samples the clip associated with this blockfile is offset in the wavetrack (non effecting)

Definition at line 101 of file ODPCMAliasBlockFile.h.

101 {mClipOffset= numSamples;}

References mClipOffset.

◆ SetFileName()

void ODPCMAliasBlockFile::SetFileName ( wxFileNameWrapper && name )

override

sets the file name the summary info will be saved in. threadsafe.

Definition at line 360 of file ODPCMAliasBlockFile.cpp.

 {
    mFileNameMutex.Lock();
    mFileName = std::move(name);
    mFileNameMutex.Unlock();
 }

References mFileNameMutex, and name.

◆ SetStart()

void ODPCMAliasBlockFile::SetStart ( sampleCount startSample )

inline

Sets the value that indicates where the first sample in this block corresponds to the global sequence/clip. Only for display use.

Definition at line 89 of file ODPCMAliasBlockFile.h.

89 {mStart = startSample;}

References mStart.

◆ Unlock()

void ODPCMAliasBlockFile::Unlock ( )

override

Unlocks the blockfile only if it has a file that exists.

unlocks the blockfile only if it has a file that exists. This needs to be done so that the unsaved ODPCMAliasBlockfiles are deleted upon exit

Definition at line 113 of file ODPCMAliasBlockFile.cpp.

 {
    if(IsSummaryAvailable() && IsLocked())
       PCMAliasBlockFile::Unlock();
 }

References IsSummaryAvailable().

Here is the call graph for this function:

◆ UnlockRead()

void ODPCMAliasBlockFile::UnlockRead ( ) const

override

Allows reading on other threads.

Definition at line 556 of file ODPCMAliasBlockFile.cpp.

 {
    mReadDataMutex.Unlock();
 }

References mReadDataMutex.

◆ WriteSummary()

void ODPCMAliasBlockFile::WriteSummary ( )

overrideprotected

Write the summary to disk, using the derived ReadData() to get the data.

Definition at line 374 of file ODPCMAliasBlockFile.cpp.

 {
    // To build the summary data, call ReadData (implemented by the
    // derived classes) to get the sample data
    // Call this first, so that in case of exceptions from ReadData, there is
    // no NEW output file
    SampleBuffer sampleData(mLen, floatSample);
    this->ReadData(sampleData.ptr(), floatSample, 0, mLen, true);
  
    ArrayOf< char > fileNameChar;
    FILE *summaryFile{};
    {
       //the mFileName path may change, for example, when the project is saved.
       //(it moves from /tmp/ to wherever it is saved to.
       ODLocker locker { &mFileNameMutex };
  
       //wxFFile is not thread-safe - if any error occurs in opening the file,
       // it posts a wxlog message which WILL crash
       // Audacity because it goes into the wx GUI.
       // For this reason I left the wxFFile method commented out. (mchinen)
       //    wxFFile summaryFile(mFileName.GetFullPath(), wxT("wb"));
  
       // ...and we use fopen instead.
       wxString sFullPath = mFileName.GetFullPath();
       fileNameChar.reinit( strlen(sFullPath.mb_str(wxConvFile)) + 1 );
       strcpy(fileNameChar.get(), sFullPath.mb_str(wxConvFile));
       summaryFile = fopen(fileNameChar.get(), "wb");
    }
  
    // JKC ANSWER-ME: Whay is IsOpened() commented out?
    if (!summaryFile){//.IsOpened() ){
  
       // Never silence the Log w.r.t write errors; they always count
       //however, this is going to be called from a non-main thread,
       //and wxLog calls are not thread safe.
       wxPrintf("Unable to write summary data to file: %s", fileNameChar.get());
  
       throw FileException{
          FileException::Cause::Open, wxFileName{ fileNameChar.get() } };
    }
  
    ArrayOf<char> cleanup;
    void *summaryData = CalcSummary(sampleData.ptr(), mLen,
                                             floatSample, cleanup);
  
    //summaryFile.Write(summaryData, mSummaryInfo.totalSummaryBytes);
    fwrite(summaryData, 1, mSummaryInfo.totalSummaryBytes, summaryFile);
    fclose(summaryFile);
  
  
     //     wxPrintf("write successful. filename: %s\n", fileNameChar);
  
    mSummaryAvailableMutex.Lock();
    mSummaryAvailable=true;
    mSummaryAvailableMutex.Unlock();
 }

References CalcSummary(), floatSample, mFileNameMutex, mSummaryAvailable, mSummaryAvailableMutex, FileException::Open, SampleBuffer::ptr(), ReadData(), and ArrayOf< X >::reinit().

Referenced by DoWriteSummary(), and Recover().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mAliasedFileNameMutex

ODLock ODPCMAliasBlockFile::mAliasedFileNameMutex

private

Also need to protect the aliased file name.

Definition at line 149 of file ODPCMAliasBlockFile.h.

◆ mClipOffset

sampleCount ODPCMAliasBlockFile::mClipOffset

private

the ODTask needs to know where this blockfile lies in the track, so for convenience, we have this here.

Definition at line 163 of file ODPCMAliasBlockFile.h.

Referenced by GetClipOffset(), GetGlobalEnd(), GetGlobalStart(), and SetClipOffset().

◆ mFileNameMutex

ODLock ODPCMAliasBlockFile::mFileNameMutex

mutableprivate

Definition at line 146 of file ODPCMAliasBlockFile.h.

Referenced by GetFileName(), GetSpaceUsage(), ReadSummary(), SaveXML(), SetFileName(), and WriteSummary().

◆ mHasBeenSaved

bool ODPCMAliasBlockFile::mHasBeenSaved

private

Definition at line 157 of file ODPCMAliasBlockFile.h.

Referenced by CloseLock(), Copy(), Lock(), ODPCMAliasBlockFile(), and SaveXML().

◆ mReadDataMutex

ODLock ODPCMAliasBlockFile::mReadDataMutex

mutableprivate

Definition at line 152 of file ODPCMAliasBlockFile.h.

Referenced by LockRead(), and UnlockRead().

◆ mStart

sampleCount ODPCMAliasBlockFile::mStart

private

for reporting after task is complete. Only for display use.

Definition at line 160 of file ODPCMAliasBlockFile.h.

Referenced by GetGlobalEnd(), GetGlobalStart(), GetStart(), and SetStart().

◆ mSummaryAvailable

bool ODPCMAliasBlockFile::mSummaryAvailable

private

Definition at line 155 of file ODPCMAliasBlockFile.h.

Referenced by IsSummaryAvailable(), ODPCMAliasBlockFile(), and WriteSummary().

◆ mSummaryAvailableMutex

ODLock ODPCMAliasBlockFile::mSummaryAvailableMutex

mutableprivate

Definition at line 154 of file ODPCMAliasBlockFile.h.

Referenced by IsSummaryAvailable(), and WriteSummary().

◆ mSummaryBeingComputed

bool ODPCMAliasBlockFile::mSummaryBeingComputed

private

Definition at line 156 of file ODPCMAliasBlockFile.h.

Referenced by IsSummaryBeingComputed(), and ODPCMAliasBlockFile().

◆ mWriteSummaryMutex

ODLock ODPCMAliasBlockFile::mWriteSummaryMutex

private

Definition at line 143 of file ODPCMAliasBlockFile.h.

Referenced by DoWriteSummary().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ODPCMAliasBlockFile() [1/2]

◆ ODPCMAliasBlockFile() [2/2]

◆ ~ODPCMAliasBlockFile()

Member Function Documentation

◆ BuildFromXML()

◆ CalcSummary()

◆ CloseLock()

◆ Copy()

◆ DoWriteSummary()

◆ GetClipOffset()

◆ GetFileName()

◆ GetGlobalEnd()

◆ GetGlobalStart()

◆ GetMinMaxRMS() [1/2]

◆ GetMinMaxRMS() [2/2]

◆ GetSpaceUsage()

◆ GetStart()

◆ IsSummaryAvailable()

◆ IsSummaryBeingComputed()

◆ Lock()

◆ LockRead()

◆ Read256()

◆ Read64K()

◆ ReadData()

◆ ReadSummary()

◆ Recover()

◆ SaveXML()

◆ SetClipOffset()

◆ SetFileName()

◆ SetStart()

◆ Unlock()

◆ UnlockRead()

◆ WriteSummary()

Member Data Documentation

◆ mAliasedFileNameMutex

◆ mClipOffset

◆ mFileNameMutex

◆ mHasBeenSaved

◆ mReadDataMutex

◆ mStart

◆ mSummaryAvailable

◆ mSummaryAvailableMutex

◆ mSummaryBeingComputed

◆ mWriteSummaryMutex