audacia/src/TimeTrack.cpp

314 lines
9.1 KiB
C++

/**********************************************************************
Audacity: A Digital Audio Editor
TimeTrack.cpp
Dr William Bland
*******************************************************************//*!
\class TimeTrack
\brief A kind of Track used to 'warp time'
*//*******************************************************************/
#include <wx/intl.h>
#include "Audacity.h"
#include "AColor.h"
#include "TimeTrack.h"
#include "widgets/Ruler.h"
#include "Prefs.h"
#include "Internat.h"
#include "Resample.h"
//TODO-MB: are these sensible values?
#define TIMETRACK_MIN 0.1
#define TIMETRACK_MAX 10.0
TimeTrack *TrackFactory::NewTimeTrack()
{
return new TimeTrack(mDirManager);
}
TimeTrack::TimeTrack(DirManager *projDirManager):
Track(projDirManager)
{
mHeight = 100;
mRangeLower = 0.9;
mRangeUpper = 1.1;
mDisplayLog = false;
mEnvelope = new Envelope();
mEnvelope->SetTrackLen(1000000000.0);
mEnvelope->SetInterpolateDB(true);
mEnvelope->Flatten(1.0);
mEnvelope->Mirror(false);
mEnvelope->SetOffset(0);
mEnvelope->SetRange(TIMETRACK_MIN, TIMETRACK_MAX);
SetDefaultName(_("Time Track"));
SetName(GetDefaultName());
mRuler = new Ruler();
mRuler->SetLabelEdges(false);
mRuler->SetFormat(Ruler::TimeFormat);
blankBrush.SetColour(214, 214, 214);
blankPen.SetColour(214, 214, 214);
}
TimeTrack::TimeTrack(TimeTrack &orig):
Track(orig)
{
Init(orig); // this copies the TimeTrack metadata (name, range, etc)
///@TODO: Give Envelope:: a copy-constructor instead of this?
mEnvelope = new Envelope();
mEnvelope->SetTrackLen(1000000000.0);
SetInterpolateLog(orig.GetInterpolateLog()); // this calls Envelope::SetInterpolateDB
mEnvelope->Flatten(1.0);
mEnvelope->Mirror(false);
mEnvelope->SetOffset(0);
mEnvelope->SetRange(orig.mEnvelope->GetMinValue(), orig.mEnvelope->GetMaxValue());
mEnvelope->Paste(0.0, orig.mEnvelope);
///@TODO: Give Ruler:: a copy-constructor instead of this?
mRuler = new Ruler();
mRuler->SetLabelEdges(false);
mRuler->SetFormat(Ruler::TimeFormat);
blankBrush.SetColour(214, 214, 214);
blankPen.SetColour(214, 214, 214);
}
// Copy the track metadata but not the contents.
void TimeTrack::Init(const TimeTrack &orig)
{
Track::Init(orig);
SetDefaultName(orig.GetDefaultName());
SetName(orig.GetName());
SetRangeLower(orig.GetRangeLower());
SetRangeUpper(orig.GetRangeUpper());
SetDisplayLog(orig.GetDisplayLog());
}
TimeTrack::~TimeTrack()
{
delete mEnvelope;
mEnvelope = NULL;
delete mRuler;
}
Track *TimeTrack::Duplicate()
{
return new TimeTrack(*this);
}
bool TimeTrack::GetInterpolateLog() const
{
return mEnvelope->GetInterpolateDB();
}
void TimeTrack::SetInterpolateLog(bool interpolateLog) {
mEnvelope->SetInterpolateDB(interpolateLog);
}
//Compute the (average) warp factor between two non-warped time points
double TimeTrack::ComputeWarpFactor(double t0, double t1)
{
return GetEnvelope()->AverageOfInverse(t0, t1);
}
double TimeTrack::ComputeWarpedLength(double t0, double t1)
{
return GetEnvelope()->IntegralOfInverse(t0, t1);
}
double TimeTrack::SolveWarpedLength(double t0, double length)
{
return GetEnvelope()->SolveIntegralOfInverse(t0, length);
}
bool TimeTrack::HandleXMLTag(const wxChar *tag, const wxChar **attrs)
{
if (!wxStrcmp(tag, wxT("timetrack"))) {
mRescaleXMLValues = true; // will be set to false if upper/lower is found
long nValue;
while(*attrs) {
const wxChar *attr = *attrs++;
const wxChar *value = *attrs++;
if (!value)
break;
const wxString strValue = value;
if (!wxStrcmp(attr, wxT("name")) && XMLValueChecker::IsGoodString(strValue))
mName = strValue;
else if (!wxStrcmp(attr, wxT("height")) &&
XMLValueChecker::IsGoodInt(strValue) && strValue.ToLong(&nValue))
mHeight = nValue;
else if (!wxStrcmp(attr, wxT("minimized")) &&
XMLValueChecker::IsGoodInt(strValue) && strValue.ToLong(&nValue))
mMinimized = (nValue != 0);
else if (!wxStrcmp(attr, wxT("rangelower")))
{
mRangeLower = Internat::CompatibleToDouble(value);
mRescaleXMLValues = false;
}
else if (!wxStrcmp(attr, wxT("rangeupper")))
{
mRangeUpper = Internat::CompatibleToDouble(value);
mRescaleXMLValues = false;
}
else if (!wxStrcmp(attr, wxT("displaylog")) &&
XMLValueChecker::IsGoodInt(strValue) && strValue.ToLong(&nValue))
{
SetDisplayLog(nValue != 0);
//TODO-MB: This causes a graphical glitch, TrackPanel should probably be Refresh()ed after loading.
// I don't know where to do this though.
}
else if (!wxStrcmp(attr, wxT("interpolatelog")) &&
XMLValueChecker::IsGoodInt(strValue) && strValue.ToLong(&nValue))
{
SetInterpolateLog(nValue != 0);
}
} // while
if(mRescaleXMLValues)
mEnvelope->SetRange(0.0, 1.0); // this will be restored to the actual range later
return true;
}
return false;
}
void TimeTrack::HandleXMLEndTag(const wxChar * WXUNUSED(tag))
{
if(mRescaleXMLValues)
{
mRescaleXMLValues = false;
mEnvelope->Rescale(mRangeLower, mRangeUpper);
mEnvelope->SetRange(TIMETRACK_MIN, TIMETRACK_MAX);
}
}
XMLTagHandler *TimeTrack::HandleXMLChild(const wxChar *tag)
{
if (!wxStrcmp(tag, wxT("envelope")))
return mEnvelope;
return NULL;
}
void TimeTrack::WriteXML(XMLWriter &xmlFile)
{
xmlFile.StartTag(wxT("timetrack"));
xmlFile.WriteAttr(wxT("name"), mName);
//xmlFile.WriteAttr(wxT("channel"), mChannel);
//xmlFile.WriteAttr(wxT("offset"), mOffset, 8);
xmlFile.WriteAttr(wxT("height"), GetActualHeight());
xmlFile.WriteAttr(wxT("minimized"), GetMinimized());
xmlFile.WriteAttr(wxT("rangelower"), mRangeLower, 12);
xmlFile.WriteAttr(wxT("rangeupper"), mRangeUpper, 12);
xmlFile.WriteAttr(wxT("displaylog"), GetDisplayLog());
xmlFile.WriteAttr(wxT("interpolatelog"), GetInterpolateLog());
mEnvelope->WriteXML(xmlFile);
xmlFile.EndTag(wxT("timetrack"));
}
void TimeTrack::Draw(wxDC & dc, const wxRect & r, double h, double pps)
{
double tstep = 1.0 / pps; // Seconds per point
double t0 = h;
double t1 = h + (r.width * tstep);
//Make sure t1 (the right bound) is greater than 0
if (t1 < 0.0)
t1 = 0.0;
//make sure t1 is greater than t0
if (t0 > t1)
t0 = t1;
dc.SetBrush(blankBrush);
dc.SetPen(blankPen);
dc.DrawRectangle(r);
//copy this rectangle away for future use.
wxRect mid = r;
// Draw the Ruler
mRuler->SetBounds(r.x, r.y, r.x + r.width - 1, r.y + r.height - 1);
double min = t0;
double max = min + r.width / pps;
mRuler->SetRange(min, max);
mRuler->SetFlip(false); // If we don't do this, the Ruler doesn't redraw itself when the envelope is modified.
// I have no idea why!
//
// LL: It's because the ruler only Invalidate()s when the new value is different
// than the current value.
mRuler->SetFlip(GetHeight() > 75 ? true : true); // MB: so why don't we just call Invalidate()? :)
mRuler->Draw(dc, this);
double *envValues = new double[mid.width];
GetEnvelope()->GetValues(envValues, mid.width, t0, tstep);
dc.SetPen(AColor::envelopePen);
double logLower = log(std::max(1.0e-7, mRangeLower)), logUpper = log(std::max(1.0e-7, mRangeUpper));
for (int x = 0; x < mid.width; x++)
{
double y;
if(mDisplayLog)
y = (double)mid.height * (logUpper - log(envValues[x])) / (logUpper - logLower);
else
y = (double)mid.height * (mRangeUpper - envValues[x]) / (mRangeUpper - mRangeLower);
int thisy = r.y + (int)y;
AColor::Line(dc, mid.x + x, thisy - 1, mid.x + x, thisy+2);
}
if (envValues)
delete[]envValues;
}
void TimeTrack::testMe()
{
GetEnvelope()->Flatten(0.0);
GetEnvelope()->Insert( 0.0, 0.2 );
GetEnvelope()->Insert( 5.0 - 0.001, 0.2 );
GetEnvelope()->Insert( 5.0 + 0.001, 1.3 );
GetEnvelope()->Insert( 10.0, 1.3 );
double value1 = GetEnvelope()->Integral(2.0, 13.0);
double expected1 = (5.0 - 2.0) * 0.2 + (13.0 - 5.0) * 1.3;
double value2 = GetEnvelope()->IntegralOfInverse(2.0, 13.0);
double expected2 = (5.0 - 2.0) / 0.2 + (13.0 - 5.0) / 1.3;
if( fabs(value1 - expected1) > 0.01 )
{
printf( "TimeTrack: Integral failed! expected %f got %f\n", expected1, value1);
}
if( fabs(value2 - expected2) > 0.01 )
{
printf( "TimeTrack: IntegralOfInverse failed! expected %f got %f\n", expected2, value2);
}
/*double reqt0 = 10.0 - .1;
double reqt1 = 10.0 + .1;
double t0 = warp( reqt0 );
double t1 = warp( reqt1 );
if( t0 > t1 )
{
printf( "TimeTrack: Warping reverses an interval! [%.2f,%.2f] -> [%.2f,%.2f]\n",
reqt0, reqt1,
t0, t1 );
}*/
}