592 lines
18 KiB
C++
592 lines
18 KiB
C++
/**********************************************************************
|
|
|
|
Audacity: A Digital Audio Editor
|
|
|
|
ODDecodeBlockFile.cpp
|
|
|
|
Created by Michael Chinen (mchinen)
|
|
Audacity(R) is copyright (c) 1999-2008 Audacity Team.
|
|
License: GPL v2. See License.txt.
|
|
|
|
******************************************************************//**
|
|
|
|
\class ODDecodeBlockFile
|
|
\brief ODDecodeBlockFile is a special type of SimpleBlockFile that does not necessarily have summary OR audio data available
|
|
The summary is eventually computed and written to a file in a background thread. See ODPCMAliasBlockFile for a similar class.
|
|
|
|
*//*******************************************************************/
|
|
|
|
#include <float.h>
|
|
#include "ODDecodeBlockFile.h"
|
|
|
|
#include <wx/utils.h>
|
|
#include <wx/wxchar.h>
|
|
#include <wx/log.h>
|
|
#include <wx/thread.h>
|
|
#include <sndfile.h>
|
|
|
|
#include "../FileFormats.h"
|
|
#include "../Internat.h"
|
|
|
|
const int bheaderTagLen = 20;
|
|
char bheaderTag[bheaderTagLen + 1] = "AudacityBlockFile112";
|
|
|
|
|
|
|
|
/// Create a disk file and write summary and sample data to it
|
|
ODDecodeBlockFile::ODDecodeBlockFile(wxFileName baseFileName,wxFileName audioFileName, sampleCount aliasStart,
|
|
sampleCount aliasLen, int aliasChannel,unsigned int decodeType):
|
|
SimpleBlockFile(baseFileName,NULL,aliasLen,floatSample,true,true), //floatSample has no effect. last two bools - bypass writing of blockfile and cache
|
|
|
|
mType(decodeType),
|
|
mAliasStart(aliasStart),
|
|
mAliasChannel(aliasChannel)
|
|
{
|
|
mDecoder = NULL;
|
|
mDataAvailable=false;
|
|
mAudioFileName = audioFileName;
|
|
mFormat = int16Sample;
|
|
}
|
|
|
|
/// Create the memory structure to refer to the given block file
|
|
ODDecodeBlockFile::ODDecodeBlockFile(wxFileName existingFile, wxFileName audioFileName, sampleCount aliasStart,
|
|
sampleCount aliasLen, int aliasChannel, unsigned int decodeType,
|
|
float min, float max, float rms, bool dataAvailable):
|
|
SimpleBlockFile(existingFile,aliasLen,min,max,rms),
|
|
|
|
mType(decodeType),
|
|
mAliasStart(aliasStart),
|
|
mAliasChannel(aliasChannel)
|
|
{
|
|
mDecoder = NULL;
|
|
mDataAvailable=dataAvailable;
|
|
mAudioFileName = audioFileName;
|
|
mFormat = int16Sample;
|
|
}
|
|
|
|
|
|
|
|
ODDecodeBlockFile::~ODDecodeBlockFile()
|
|
{
|
|
|
|
}
|
|
|
|
|
|
//Check to see if we have the file for these calls.
|
|
wxLongLong ODDecodeBlockFile::GetSpaceUsage()
|
|
{
|
|
if(IsSummaryAvailable())
|
|
{
|
|
wxFFile summaryFile(mFileName.GetFullPath());
|
|
return summaryFile.Length();
|
|
}
|
|
else
|
|
{
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
|
|
/// Gets extreme values for the specified region
|
|
void ODDecodeBlockFile::GetMinMax(sampleCount start, sampleCount len,
|
|
float *outMin, float *outMax, float *outRMS)
|
|
{
|
|
if(IsSummaryAvailable())
|
|
{
|
|
SimpleBlockFile::GetMinMax(start,len,outMin,outMax,outRMS);
|
|
}
|
|
else
|
|
{
|
|
//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
|
|
*outMin = -1.0;
|
|
*outMax = 1.0;
|
|
*outRMS = (float)0.707;//sin with amp of 1 rms
|
|
}
|
|
}
|
|
|
|
/// Gets extreme values for the entire block
|
|
void ODDecodeBlockFile::GetMinMax(float *outMin, float *outMax, float *outRMS)
|
|
{
|
|
if(IsSummaryAvailable())
|
|
{
|
|
SimpleBlockFile::GetMinMax(outMin,outMax,outRMS);
|
|
}
|
|
else
|
|
{
|
|
//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
|
|
*outMin = -1.0;
|
|
*outMax = 1.0;
|
|
*outRMS = (float)0.707;//sin with amp of 1 rms
|
|
}
|
|
}
|
|
|
|
/// Returns the 256 byte summary data block
|
|
bool ODDecodeBlockFile::Read256(float *buffer, sampleCount start, sampleCount len)
|
|
{
|
|
if(IsSummaryAvailable())
|
|
{
|
|
return SimpleBlockFile::Read256(buffer,start,len);
|
|
}
|
|
else
|
|
{
|
|
//this should not be reached (client should check IsSummaryAvailable()==true before this.
|
|
buffer = NULL;
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/// Returns the 64K summary data block
|
|
bool ODDecodeBlockFile::Read64K(float *buffer, sampleCount start, sampleCount len)
|
|
{
|
|
if(IsSummaryAvailable())
|
|
{
|
|
return SimpleBlockFile::Read64K(buffer,start,len);
|
|
}
|
|
else
|
|
{
|
|
//this should not be reached (client should check IsSummaryAvailable()==true before this.
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/// If the summary has been computed,
|
|
/// Construct a new PCMAliasBlockFile based on this one.
|
|
/// otherwise construct an ODPCMAliasBlockFile that still needs to be computed.
|
|
/// @param newFileName The filename to copy the summary data to.
|
|
BlockFile *ODDecodeBlockFile::Copy(wxFileName newFileName)
|
|
{
|
|
BlockFile *newBlockFile;
|
|
|
|
//mAliasedFile can change so we lock readdatamutex, which is responsible for it.
|
|
LockRead();
|
|
if(IsSummaryAvailable())
|
|
{
|
|
//create a simpleblockfile, because once it has the summary it is a simpleblockfile for all intents an purposes
|
|
newBlockFile = SimpleBlockFile::Copy(newFileName) ;
|
|
}
|
|
else
|
|
{
|
|
//Summary File might exist in this case, but it probably (99.999% of the time) won't.
|
|
newBlockFile = new ODDecodeBlockFile(newFileName,
|
|
mAudioFileName, mAliasStart,
|
|
mLen, mAliasChannel, mType,
|
|
mMin, mMax, mRMS,IsSummaryAvailable());
|
|
//The client code will need to schedule this blockfile for OD decoding if it is going to a new track.
|
|
//It can do this by checking for IsDataAvailable()==false.
|
|
}
|
|
|
|
UnlockRead();
|
|
|
|
return newBlockFile;
|
|
}
|
|
|
|
|
|
/// Writes the xml as a SimpleBlockFile 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, 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
|
|
void ODDecodeBlockFile::SaveXML(XMLWriter &xmlFile)
|
|
{
|
|
LockRead();
|
|
if(IsSummaryAvailable())
|
|
{
|
|
SimpleBlockFile::SaveXML(xmlFile);
|
|
}
|
|
else
|
|
{
|
|
xmlFile.StartTag(wxT("oddecodeblockfile"));
|
|
//unlock to prevent deadlock and resume lock after.
|
|
UnlockRead();
|
|
mFileNameMutex.Lock();
|
|
xmlFile.WriteAttr(wxT("summaryfile"), mFileName.GetFullName());
|
|
mFileNameMutex.Unlock();
|
|
LockRead();
|
|
xmlFile.WriteAttr(wxT("audiofile"), mAudioFileName.GetFullPath());
|
|
xmlFile.WriteAttr(wxT("aliasstart"), mAliasStart);
|
|
xmlFile.WriteAttr(wxT("aliaslen"), mLen);
|
|
xmlFile.WriteAttr(wxT("aliaschannel"), mAliasChannel);
|
|
xmlFile.WriteAttr(wxT("decodetype"), (size_t)mType);
|
|
|
|
xmlFile.EndTag(wxT("oddecodeblockfile"));
|
|
}
|
|
UnlockRead();
|
|
}
|
|
|
|
/// Constructs a ODPCMAliasBlockFile from the xml output of WriteXML.
|
|
/// Also schedules the ODPCMAliasBlockFile for OD loading.
|
|
// BuildFromXML methods should always return a BlockFile, not NULL,
|
|
// even if the result is flawed (e.g., refers to nonexistent file),
|
|
// as testing will be done in DirManager::ProjectFSCK().
|
|
BlockFile *ODDecodeBlockFile::BuildFromXML(DirManager &dm, const wxChar **attrs)
|
|
{
|
|
wxFileName summaryFileName;
|
|
wxFileName audioFileName;
|
|
sampleCount aliasStart=0, aliasLen=0;
|
|
int aliasChannel=0;
|
|
long nValue;
|
|
unsigned int decodeType=0;
|
|
|
|
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("audiofile")) )
|
|
{
|
|
if (XMLValueChecker::IsGoodPathName(strValue))
|
|
audioFileName.Assign(strValue);
|
|
else if (XMLValueChecker::IsGoodFileName(strValue, dm.GetProjectDataDir()))
|
|
// Allow fallback of looking for the file name, located in the data directory.
|
|
audioFileName.Assign(dm.GetProjectDataDir(), strValue);
|
|
else if (XMLValueChecker::IsGoodPathString(strValue))
|
|
// If the file is missing, we failed XMLValueChecker::IsGoodPathName()
|
|
// and XMLValueChecker::IsGoodFileName, because both do existence tests,
|
|
// but we want to keep the reference to the file because it's a good path string.
|
|
audioFileName.Assign(strValue);
|
|
}
|
|
else if (XMLValueChecker::IsGoodInt(strValue) && strValue.ToLong(&nValue))
|
|
{ // integer parameters
|
|
if (!wxStricmp(attr, wxT("aliasstart")) && (nValue >= 0))
|
|
aliasStart = nValue;
|
|
else 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("decodetype")) )
|
|
decodeType = nValue;
|
|
}
|
|
}
|
|
|
|
return new ODDecodeBlockFile(summaryFileName, audioFileName,
|
|
aliasStart, aliasLen, aliasChannel,decodeType,
|
|
0,0,0, false);
|
|
|
|
}
|
|
|
|
|
|
|
|
void ODDecodeBlockFile::Recover(void)
|
|
{
|
|
if(IsSummaryAvailable())
|
|
{
|
|
WriteODDecodeBlockFile();
|
|
}
|
|
}
|
|
|
|
bool ODDecodeBlockFile::IsSummaryAvailable()
|
|
{
|
|
return IsDataAvailable();
|
|
}
|
|
|
|
bool ODDecodeBlockFile::IsDataAvailable()
|
|
{
|
|
bool retval;
|
|
mDataAvailableMutex.Lock();
|
|
retval= mDataAvailable;
|
|
mDataAvailableMutex.Unlock();
|
|
return retval;
|
|
}
|
|
/// Write the summary to disk, using the derived ReadData() to get the data
|
|
/// Here, the decoder ODTask associated with this file must fetch the samples with
|
|
/// the ODDecodeTask::Decode() method.
|
|
int ODDecodeBlockFile::WriteODDecodeBlockFile()
|
|
{
|
|
|
|
// To build the summary data, call ReadData (implemented by the
|
|
// derived classes) to get the sample data
|
|
SampleBuffer sampleData;// = NewSamples(mLen, floatSample);
|
|
int ret;
|
|
//use the decoder here.
|
|
mDecoderMutex.Lock();
|
|
|
|
if(!mDecoder)
|
|
{
|
|
mDecoderMutex.Unlock();
|
|
return -1;
|
|
}
|
|
|
|
|
|
//sampleData and mFormat are set by the decoder.
|
|
ret = mDecoder->Decode(sampleData, mFormat, mAliasStart, mLen, mAliasChannel);
|
|
|
|
mDecoderMutex.Unlock();
|
|
if(ret < 0) {
|
|
printf("ODDecodeBlockFile Decode failure\n");
|
|
return ret; //failure
|
|
}
|
|
|
|
//the summary is also calculated here.
|
|
mFileNameMutex.Lock();
|
|
//TODO: we may need to write a version of WriteSimpleBlockFile that uses threadsafe FILE vs wxFile
|
|
bool bSuccess =
|
|
WriteSimpleBlockFile(
|
|
sampleData.ptr(),
|
|
mLen,
|
|
mFormat,
|
|
NULL);//summaryData);
|
|
wxASSERT(bSuccess); // TODO: Handle failure here by alert to user and undo partial op.
|
|
|
|
mFileNameMutex.Unlock();
|
|
|
|
// delete [] (char *) summaryData;
|
|
|
|
|
|
mDataAvailableMutex.Lock();
|
|
mDataAvailable=true;
|
|
mDataAvailableMutex.Unlock();
|
|
|
|
return ret;
|
|
}
|
|
|
|
///sets the file name the summary info will be saved in. threadsafe.
|
|
void ODDecodeBlockFile::SetFileName(wxFileName &name)
|
|
{
|
|
mFileNameMutex.Lock();
|
|
mFileName=name;
|
|
/* mchinen oct 9 2009 don't think we need the char* but leaving it in for now just as a reminder that we might
|
|
if wxFileName isn't threadsafe.
|
|
delete [] mFileNameChar;
|
|
mFileNameChar = new char[strlen(mFileName.GetFullPath().mb_str(wxConvUTF8))+1];
|
|
strcpy(mFileNameChar,mFileName.GetFullPath().mb_str(wxConvUTF8)); */
|
|
mFileNameMutex.Unlock();
|
|
}
|
|
|
|
///sets the file name the summary info will be saved in. threadsafe.
|
|
wxFileName ODDecodeBlockFile::GetFileName()
|
|
{
|
|
wxFileName name;
|
|
mFileNameMutex.Lock();
|
|
name = mFileName;
|
|
mFileNameMutex.Unlock();
|
|
return name;
|
|
}
|
|
|
|
/// 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.
|
|
///
|
|
/// @param buffer A buffer containing the sample data to be analyzed
|
|
/// @param len The length of the sample data
|
|
/// @param format The format of the sample data.
|
|
void *ODDecodeBlockFile::CalcSummary(samplePtr buffer, sampleCount len,
|
|
sampleFormat format)
|
|
{
|
|
char* localFullSummary = new char[mSummaryInfo.totalSummaryBytes];
|
|
|
|
memcpy(localFullSummary, bheaderTag, bheaderTagLen);
|
|
|
|
float *summary64K = (float *)(localFullSummary + mSummaryInfo.offset64K);
|
|
float *summary256 = (float *)(localFullSummary + mSummaryInfo.offset256);
|
|
|
|
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
|
|
{
|
|
fbuffer = new float[len];
|
|
CopySamples(buffer, format,
|
|
(samplePtr)fbuffer, floatSample, len);
|
|
}
|
|
sampleCount sumLen;
|
|
sampleCount i, j, jcount;
|
|
|
|
float min, max;
|
|
float sumsq;
|
|
|
|
// Recalc 256 summaries
|
|
sumLen = (len + 255) / 256;
|
|
|
|
|
|
for (i = 0; i < sumLen; i++) {
|
|
min = fbuffer[i * 256];
|
|
max = fbuffer[i * 256];
|
|
sumsq = ((float)min) * ((float)min);
|
|
jcount = 256;
|
|
if (i * 256 + jcount > len)
|
|
jcount = len - i * 256;
|
|
for (j = 1; j < jcount; j++) {
|
|
float f1 = fbuffer[i * 256 + j];
|
|
sumsq += ((float)f1) * ((float)f1);
|
|
if (f1 < min)
|
|
min = f1;
|
|
else if (f1 > max)
|
|
max = f1;
|
|
}
|
|
|
|
float rms = (float)sqrt(sumsq / jcount);
|
|
|
|
summary256[i * 3] = min;
|
|
summary256[i * 3 + 1] = max;
|
|
summary256[i * 3 + 2] = rms;
|
|
}
|
|
|
|
for (i = sumLen; i < mSummaryInfo.frames256; i++) {
|
|
// filling in the remaining bits with non-harming/contributing values
|
|
summary256[i * 3] = FLT_MAX; // min
|
|
summary256[i * 3 + 1] = -FLT_MAX; // max
|
|
summary256[i * 3 + 2] = 0.0f; // rms
|
|
}
|
|
|
|
// Recalc 64K summaries
|
|
sumLen = (len + 65535) / 65536;
|
|
|
|
for (i = 0; i < sumLen; i++) {
|
|
min = summary256[3 * i * 256];
|
|
max = summary256[3 * i * 256 + 1];
|
|
sumsq = (float)summary256[3 * i * 256 + 2];
|
|
sumsq *= sumsq;
|
|
|
|
for (j = 1; j < 256; j++) {
|
|
if (summary256[3 * (i * 256 + j)] < min)
|
|
min = summary256[3 * (i * 256 + j)];
|
|
if (summary256[3 * (i * 256 + j) + 1] > max)
|
|
max = summary256[3 * (i * 256 + j) + 1];
|
|
float r1 = summary256[3 * (i * 256 + j) + 2];
|
|
sumsq += r1*r1;
|
|
}
|
|
|
|
float rms = (float)sqrt(sumsq / 256);
|
|
|
|
summary64K[i * 3] = min;
|
|
summary64K[i * 3 + 1] = max;
|
|
summary64K[i * 3 + 2] = rms;
|
|
}
|
|
for (i = sumLen; i < mSummaryInfo.frames64K; i++) {
|
|
summary64K[i * 3] = 0.0f;
|
|
summary64K[i * 3 + 1] = 0.0f;
|
|
summary64K[i * 3 + 2] = 0.0f;
|
|
}
|
|
|
|
// Recalc block-level summary
|
|
min = summary64K[0];
|
|
max = summary64K[1];
|
|
sumsq = (float)summary64K[2];
|
|
sumsq *= sumsq;
|
|
|
|
for (i = 1; i < sumLen; i++) {
|
|
if (summary64K[3*i] < min)
|
|
min = summary64K[3*i];
|
|
else if (summary64K[3*i+1] > max)
|
|
max = summary64K[3*i+1];
|
|
float r1 = (float)summary64K[3*i+2];
|
|
sumsq += (r1*r1);
|
|
}
|
|
|
|
mMin = min;
|
|
mMax = max;
|
|
mRMS = sqrt(sumsq / sumLen);
|
|
|
|
|
|
//if we've used the float sample..
|
|
if(format!=floatSample)
|
|
{
|
|
delete[] fbuffer;
|
|
}
|
|
return localFullSummary;
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Reads the specified data from the aliased file, using libsndfile,
|
|
/// and converts it to the given sample format.
|
|
///
|
|
/// @param data The buffer to read the sample data into.
|
|
/// @param format The format to convert the data into
|
|
/// @param start The offset within the block to begin reading
|
|
/// @param len The number of samples to read
|
|
int ODDecodeBlockFile::ReadData(samplePtr data, sampleFormat format,
|
|
sampleCount start, sampleCount len)
|
|
{
|
|
int ret;
|
|
LockRead();
|
|
if(IsSummaryAvailable())
|
|
ret= SimpleBlockFile::ReadData(data,format,start,len);
|
|
else
|
|
{
|
|
//we should do an ODRequest to start processing the data here, and wait till it finishes. and just do a SimpleBlockFIle
|
|
//ReadData.
|
|
ClearSamples(data, format, 0, len);
|
|
ret= len;
|
|
}
|
|
UnlockRead();
|
|
return ret;
|
|
}
|
|
|
|
/// Read the summary of this alias block from disk. Since the audio data
|
|
/// is elsewhere, this consists of reading the entire summary file.
|
|
///
|
|
/// @param *data The buffer where the summary data will be stored. It must
|
|
/// be at least mSummaryInfo.totalSummaryBytes long.
|
|
bool ODDecodeBlockFile::ReadSummary(void *data)
|
|
{
|
|
//I dont think we need to add a mutex here because only the main thread changes filenames and calls ReadSummarz
|
|
if(IsSummaryAvailable())
|
|
return SimpleBlockFile::ReadSummary(data);
|
|
|
|
memset(data, 0, (size_t)mSummaryInfo.totalSummaryBytes);
|
|
return true;
|
|
}
|
|
|
|
///set the decoder,
|
|
void ODDecodeBlockFile::SetODFileDecoder(ODFileDecoder* decoder)
|
|
{
|
|
//since this is the only place that writes to mdecoder, it is totally thread-safe to read check without the mutex
|
|
if(decoder == mDecoder)
|
|
return;
|
|
mDecoderMutex.Lock();
|
|
mDecoder = decoder;
|
|
mDecoderMutex.Unlock();
|
|
}
|
|
|
|
|
|
/// Prevents a read on other threads.
|
|
void ODDecodeBlockFile::LockRead()
|
|
{
|
|
mReadDataMutex.Lock();
|
|
}
|
|
/// Allows reading of encoded file on other threads.
|
|
void ODDecodeBlockFile::UnlockRead()
|
|
{
|
|
mReadDataMutex.Unlock();
|
|
}
|
|
|
|
/// Modify this block to point at a different file. This is generally
|
|
/// looked down on, but it is necessary in one case: see
|
|
/// DirManager::EnsureSafeFilename().
|
|
void ODDecodeBlockFile::ChangeAudioFile(wxFileName newAudioFile)
|
|
{
|
|
mAudioFileName = newAudioFile;
|
|
}
|
|
|
|
|
|
|