A Track that is used for Midi notes. (Somewhat old code). More...

#include <NoteTrack.h>

Inheritance diagram for NoteTrack:

Collaboration diagram for NoteTrack:

Classes
struct	Interval

Public Types
using	Attachments = NoteTrackAttachments

using	Holder = std::shared_ptr< NoteTrack >

Public Types inherited from Track
using	AttachedObjects = ::AttachedTrackObjects
	Alias for my base type. More...

using	Holder = std::shared_ptr< Track >

Public Types inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
using	DataType = ClientData

using	DataPointer = Pointer< ClientData >

using	DataFactory = std::function< DataPointer(Host &) >
	Type of function from which RegisteredFactory is constructed; it builds attachments. More...

Public Types inherited from ChannelGroup
enum class	LinkType : int { None = 0 , Group = 2 , Aligned }
	For two tracks describes the type of the linkage. More...

using	Attachments = ChannelGroupAttachments

using	Interval = WideChannelGroupInterval

Public Types inherited from Channel
using	Interval = ChannelInterval

Public Member Functions
	NoteTrack ()

	NoteTrack (const NoteTrack &orig)=delete
	Copy construction hasn't been necessary yet. More...

	NoteTrack (const NoteTrack &orig, ProtectedCreationArg &&)=delete

virtual	~NoteTrack ()

void	MoveTo (double origin) override
	Change start time to given time point. More...

Alg_seq &	GetSeq () const

void	WarpAndTransposeNotes (double t0, double t1, const TimeWarper &warper, double semitones)

void	SetSequence (std::unique_ptr< Alg_seq > &&seq)

void	PrintSequence ()

Alg_seq *	MakeExportableSeq (std::unique_ptr< Alg_seq > &cleanup) const

bool	ExportMIDI (const wxString &f) const

bool	ExportAllegro (const wxString &f) const

Track::Holder	Cut (double t0, double t1) override
	Create tracks and modify this track. More...

Track::Holder	Copy (double t0, double t1, bool forClipboard=true) const override
	Create new tracks and don't modify this track. More...

bool	Trim (double t0, double t1)

void	Clear (double t0, double t1) override

void	Paste (double t, const Track &src) override
	Weak precondition allows overrides to replicate one channel into many. More...

void	Silence (double t0, double t1, ProgressReporter reportProgress={}) override

void	InsertSilence (double t, double len) override

bool	Shift (double t)

float	GetVelocity () const

void	SetVelocity (float velocity)

QuantizedTimeAndBeat	NearestBeatTime (double time) const

bool	StretchRegion (QuantizedTimeAndBeat t0, QuantizedTimeAndBeat t1, double newDur)

bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs) override

XMLTagHandler *	HandleXMLChild (const std::string_view &tag) override

void	WriteXML (XMLWriter &xmlFile) const override

unsigned	GetVisibleChannels () const

void	SetVisibleChannels (unsigned value)

bool	IsVisibleChan (int c) const

void	SetVisibleChan (int c)

void	ClearVisibleChan (int c)

void	ToggleVisibleChan (int c)

void	SoloVisibleChan (int c)

const TypeInfo &	GetTypeInfo () const override

Track::Holder	PasteInto (AudacityProject &project, TrackList &list) const override

size_t	NIntervals () const override
	Report the number of intervals. More...

Public Member Functions inherited from UniqueChannelTrack< PlayableTrack >
size_t	NChannels () const override
	Report the number of channels. More...

std::shared_ptr< Channel >	DoGetChannel (size_t iChannel) override

Public Member Functions inherited from PlayableTrack
	PlayableTrack ()

	PlayableTrack (const PlayableTrack &orig, ProtectedCreationArg &&)

bool	GetMute () const

bool	GetSolo () const

bool	GetNotMute () const

bool	GetNotSolo () const

void	SetMute (bool m)

void	SetSolo (bool s)

void	WriteXMLAttributes (XMLWriter &xmlFile) const

bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &value)

Public Member Functions inherited from AudioTrack
	AudioTrack ()

	AudioTrack (const Track &orig, ProtectedCreationArg &&a)

void	WriteXMLAttributes (XMLWriter &WXUNUSED(xmlFile)) const

bool	HandleXMLAttribute (const std::string_view &, const XMLAttributeValueView &)

Public Member Functions inherited from Track
TrackId	GetId () const

template<typename Subclass = Track>
std::shared_ptr< Subclass >	SharedPointer ()

template<typename Subclass = const Track>
auto	SharedPointer () const -> std::enable_if_t< std::is_const_v< Subclass >, std::shared_ptr< Subclass > >

virtual const TypeInfo &	GetTypeInfo () const =0

virtual const TypeNames &	GetTypeNames () const

virtual bool	SupportsBasicEditing () const
	Whether this track type implements cut-copy-paste; by default, true. More...

virtual Holder	PasteInto (AudacityProject &project, TrackList &list) const =0

virtual bool	LinkConsistencyFix (bool doFix=true)
	Check consistency of channel groups, and maybe fix it. More...

bool	LinkConsistencyCheck ()
	Do the non-mutating part of consistency fix only and return status. More...

bool	HasOwner () const

std::shared_ptr< TrackList >	GetOwner () const

LinkType	GetLinkType () const noexcept

	Track ()

	Track (const Track &orig, ProtectedCreationArg &&)

Track &	operator= (const Track &orig)=delete

virtual	~Track ()

void	Init (const Track &orig)

virtual Holder	Duplicate (DuplicateOptions={}) const
	public nonvirtual duplication function that invokes Clone() More...

void	ReparentAllAttachments ()

const wxString &	GetName () const
	Name is always the same for all channels of a group. More...

void	SetName (const wxString &n)

bool	GetSelected () const
	Selectedness is always the same for all channels of a group. More...

virtual void	SetSelected (bool s)

virtual Holder	Cut (double t0, double t1)=0
	Create tracks and modify this track. More...

virtual Holder	Copy (double t0, double t1, bool forClipboard=true) const =0
	Create new tracks and don't modify this track. More...

virtual void	Clear (double t0, double t1)=0

virtual void	Paste (double t, const Track &src)=0
	Weak precondition allows overrides to replicate one channel into many. More...

virtual void	SyncLockAdjust (double oldT1, double newT1)

virtual void	Silence (double t0, double t1, ProgressReporter reportProgress={})=0

virtual void	InsertSilence (double t, double len)=0

bool	SameKindAs (const Track &track) const

template<typename R = void, typename ... Functions>
R	TypeSwitch (const Functions &...functions)

template<typename R = void, typename ... Functions>
R	TypeSwitch (const Functions &...functions) const

virtual void	WriteXML (XMLWriter &xmlFile) const =0

virtual std::optional< TranslatableString >	GetErrorOpening () const

void	Notify (bool allChannels, int code=-1)

bool	Any () const

bool	IsSelected () const

bool	IsLeader () const

void	AdjustPositions ()

void	WriteCommonXMLAttributes (XMLWriter &xmlFile, bool includeNameAndSelected=true) const

bool	HandleCommonXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView)

Public Member Functions inherited from XMLTagHandler
	XMLTagHandler ()

virtual	~XMLTagHandler ()

virtual bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs)=0

virtual void	HandleXMLEndTag (const std::string_view &WXUNUSED(tag))

virtual void	HandleXMLContent (const std::string_view &WXUNUSED(content))

virtual XMLTagHandler *	HandleXMLChild (const std::string_view &tag)=0

void	ReadXMLEndTag (const char *tag)

void	ReadXMLContent (const char *s, int len)

XMLTagHandler *	ReadXMLChild (const char *tag)

Public Member Functions inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
	~Site ()

	Site ()

	Site (const Site &other)

Site &	operator= (const Site &other)

	Site (Site &&other)

Site &	operator= (Site &&other)

size_t	size () const
	How many attachment pointers are in the Site. More...

template<typename Subclass = ClientData>
Subclass &	Get (const RegisteredFactory &key)
	Get reference to an attachment, creating on demand if not present, down-cast it to Subclass. More...

template<typename Subclass = const ClientData>
auto	Get (const RegisteredFactory &key) const -> std::enable_if_t< std::is_const< Subclass >::value, Subclass & >
	Get reference to an attachment, creating on demand if not present, down-cast it to Subclass. More...

template<typename Subclass = ClientData>
Subclass *	Find (const RegisteredFactory &key)
	Get a (bare) pointer to an attachment, or null, down-cast it to Subclass *; will not create on demand. More...

template<typename Subclass = const ClientData>
auto	Find (const RegisteredFactory &key) const -> std::enable_if_t< std::is_const< Subclass >::value, Subclass * >
	Get a (bare) pointer to an attachment, or null, down-cast it to Subclass *; will not create on demand. More...

template<typename ReplacementPointer >
void	Assign (const RegisteredFactory &key, ReplacementPointer &&replacement)
	Reassign Site's pointer to ClientData. More...

Public Member Functions inherited from ChannelGroup
virtual	~ChannelGroup ()

double	GetStartTime () const
	Get the minimum of Start() values of intervals, or 0 when none. More...

double	GetEndTime () const
	Get the maximum of End() values of intervals, or 0 when none. More...

void	ShiftBy (double t)
	Change start time by given duration. More...

virtual void	MoveTo (double o)=0
	Change start time to given time point. More...

template<typename ChannelType = Channel>
std::shared_ptr< ChannelType >	GetChannel (size_t iChannel)
	Retrieve a channel, cast to the given type. More...

template<typename ChannelType = const Channel>
auto	GetChannel (size_t iChannel) const -> std::enable_if_t< std::is_const_v< ChannelType >, std::shared_ptr< ChannelType > >

template<typename ChannelType = Channel>
IteratorRange< ChannelIterator< ChannelType > >	Channels ()
	Get range of channels with mutative access. More...

template<typename ChannelType = const Channel>
auto	Channels () const -> std::enable_if_t< std::is_const_v< ChannelType >, IteratorRange< ChannelIterator< ChannelType > > >
	Get range of channels with read-only access. More...

std::shared_ptr< Channel >	NthChannel (size_t nChannel)

std::shared_ptr< const Channel >	NthChannel (size_t nChannel) const

template<typename IntervalType = Interval>
std::shared_ptr< IntervalType >	GetInterval (size_t iInterval)
	Retrieve an interval, cast to the given type. More...

template<typename IntervalType = const Interval>
auto	GetInterval (size_t iInterval) const -> std::enable_if_t< std::is_const_v< IntervalType >, std::shared_ptr< IntervalType > >

template<typename IntervalType = Interval>
IteratorRange< IntervalIterator< IntervalType > >	Intervals ()
	Get range of intervals with mutative access. More...

template<typename IntervalType = const Interval>
auto	Intervals () const -> std::enable_if_t< std::is_const_v< IntervalType >, IteratorRange< IntervalIterator< IntervalType > > >
	Get range of intervals with read-only access. More...

Public Member Functions inherited from Channel
virtual	~Channel ()

ChannelGroup &	GetChannelGroup ()
	Channel object's lifetime is assumed to be nested in its Track's. More...

const ChannelGroup &	GetChannelGroup () const
	Channel object's lifetime is assumed to be nested in its Track's. More...

size_t	GetChannelIndex () const

size_t	NIntervals () const
	Report the number of intervals. More...

template<typename IntervalType = Interval>
std::shared_ptr< IntervalType >	GetInterval (size_t iInterval)
	Retrieve an interval, cast to the given type. More...

template<typename IntervalType = const Interval>
auto	GetInterval (size_t iInterval) const -> std::enable_if_t< std::is_const_v< IntervalType >, std::shared_ptr< IntervalType > >

template<typename IntervalType = Interval>
IteratorRange< IntervalIterator< IntervalType > >	Intervals ()
	Get range of intervals with mutative access. More...

template<typename IntervalType = const Interval>
auto	Intervals () const -> std::enable_if_t< std::is_const_v< IntervalType >, IteratorRange< IntervalIterator< IntervalType > > >
	Get range of intervals with read-only access. More...

Public Member Functions inherited from OtherPlayableSequence
virtual	~OtherPlayableSequence ()

Static Public Member Functions
static NoteTrack *	New (AudacityProject &project)

static const TypeInfo &	ClassTypeInfo ()

Static Public Member Functions inherited from PlayableTrack
static const TypeInfo &	ClassTypeInfo ()

Static Public Member Functions inherited from AudioTrack
static const TypeInfo &	ClassTypeInfo ()

Static Public Member Functions inherited from Track
template<typename Subclass = Track>
static std::shared_ptr< Subclass >	SharedPointer (Track *pTrack)

template<typename Subclass = const Track>
static std::shared_ptr< Subclass >	SharedPointer (const Track *pTrack)

static const TypeInfo &	ClassTypeInfo ()

static void	CopyAttachments (Track &dst, const Track &src, bool deep)
	Copy (deep) or just share (!deep) AttachedTrackObjects. More...

Static Public Member Functions inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
static size_t	numFactories ()
	How many static factories have been registered with this specialization of Site. More...

Static Public Attributes
static EnumSetting< bool >	AllegroStyleSetting

Private Member Functions
Track::Holder	Clone (bool backup) const override

std::shared_ptr< WideChannelGroupInterval >	DoGetInterval (size_t iInterval) override
	Retrieve an interval. More...

void	DoSetVelocity (float velocity)

void	AddToDuration (double delta)

Private Attributes
std::unique_ptr< Alg_seq >	mSeq

std::unique_ptr< char[]>	mSerializationBuffer

long	mSerializationLength

std::atomic< float >	mVelocity { 0.0f }
	Atomic because it may be read by worker threads in playback. More...

std::atomic< unsigned >	mVisibleChannels { ALL_CHANNELS }
	A bit set; atomic because it may be read by worker threads in playback. More...

double	mOrigin { 0.0 }

Additional Inherited Members
Protected Member Functions inherited from UniqueChannelTrack< PlayableTrack >
ChannelGroup &	DoGetChannelGroup () const override
	Subclass must override. More...

Protected Member Functions inherited from PlayableTrack
bool	DoGetMute () const

void	DoSetMute (bool value)

bool	DoGetSolo () const

void	DoSetSolo (bool value)

Protected Member Functions inherited from Track
void	SetLinkType (LinkType linkType, bool completeList=true)

Protected Member Functions inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
template<typename Function >
void	ForEach (const Function &function)
	Invoke function on each ClientData object that has been created in `this`. More...

template<typename Function >
void	ForEach (const Function &function) const
	Invoke function on each ClientData object that has been created in `this`. More...

template<typename Function >
void	ForCorresponding (Site &other, const Function &function, bool create=true)

template<typename Function >
ClientData *	FindIf (const Function &function)
	Return pointer to first attachment in `this` that is not null and satisfies a predicate, or nullptr. More...

template<typename Function >
const ClientData *	FindIf (const Function &function) const
	Return pointer to first attachment in `this` that is not null and satisfies a predicate, or nullptr. More...

template<typename Function >
void	EraseIf (const Function &function)
	Erase attached objects satisfying a predicate. More...

void	BuildAll ()
	For each RegisteredFactory, if the corresponding attachment is absent in `this`, build and store it. More...

virtual std::shared_ptr< Channel >	DoGetChannel (size_t iChannel)=0

virtual std::shared_ptr< Interval >	DoGetInterval (size_t iInterval)=0
	Retrieve an interval. More...

virtual ChannelGroup &	DoGetChannelGroup () const =0
	Subclass must override. More...

Protected Attributes inherited from Track
std::weak_ptr< TrackList >	mList

TrackNodePointer	mNode {}
	Holds iterator to self, so that TrackList::Find can be constant-time. More...

Detailed Description

A Track that is used for Midi notes. (Somewhat old code).

Definition at line 74 of file NoteTrack.h.

Member Typedef Documentation

◆ Attachments

using NoteTrack::Attachments = NoteTrackAttachments

Definition at line 80 of file NoteTrack.h.

◆ Holder

using NoteTrack::Holder = std::shared_ptr<NoteTrack>

Definition at line 92 of file NoteTrack.h.

Constructor & Destructor Documentation

◆ NoteTrack() [1/3]

NoteTrack::NoteTrack ( )

Definition at line 145 of file NoteTrack.cpp.

   : UniqueChannelTrack{}
{
   SetName(_("Note Track"));
 
   mSeq = NULL;
   mSerializationLength = 0;
}

References _, mSeq, mSerializationLength, and Track::SetName().

Here is the call graph for this function:

◆ NoteTrack() [2/3]

NoteTrack::NoteTrack ( const NoteTrack & orig )

delete

Copy construction hasn't been necessary yet.

◆ NoteTrack() [3/3]

NoteTrack::NoteTrack	(	const NoteTrack &	orig,
		ProtectedCreationArg &&
	)

delete

◆ ~NoteTrack()

NoteTrack::~NoteTrack ( )

virtual

Definition at line 154 of file NoteTrack.cpp.

155{

156}

Member Function Documentation

◆ AddToDuration()

void NoteTrack::AddToDuration ( double delta )

private

Definition at line 602 of file NoteTrack.cpp.

{
   auto &seq = GetSeq();
#if 0
   // PRL:  Would this be better ?
   seq.set_real_dur( seq.get_real_dur() + delta );
#else
   seq.convert_to_seconds();
   seq.set_dur( seq.get_dur() + delta );
#endif
}

References GetSeq().

Referenced by Paste(), and StretchRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClassTypeInfo()

auto NoteTrack::ClassTypeInfo ( )

static

Definition at line 574 of file NoteTrack.cpp.

{
   return typeInfo();
}

References typeInfo().

Here is the call graph for this function:

◆ Clear()

void NoteTrack::Clear	(	double	t0,
		double	t1
	)

overridevirtual

May assume precondition: t0 <= t1

Implements Track.

Definition at line 397 of file NoteTrack.cpp.

{
   if (t1 < t0)
      THROW_INCONSISTENCY_EXCEPTION;
 
   double len = t1-t0;
 
   auto &seq = GetSeq();
 
   auto offset = mOrigin;
   auto start = t0 - offset;
   if (start < 0.0) {
      // AlgSeq::clear will shift the cleared interval, not changing len, if
      // start is negative.  That's not what we want to happen.
      if (len > -start) {
         seq.clear(0, len + start, false);
         MoveTo(t0);
      }
      else
         MoveTo(offset - len);
   }
   else {
      //auto delta = -(
      //( std::min( t1, GetEndTime() ) ) - ( std::max( t0, GetStartTime() ) )
      //);
      seq.clear(start, len, false);
 
      // Not needed
      // Alg_seq::clear seems to handle this
      // AddToDuration( delta );
   }
}

References GetSeq(), mOrigin, MoveTo(), and THROW_INCONSISTENCY_EXCEPTION.

Referenced by anonymous_namespace{EditMenus.cpp}::OnCut().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClearVisibleChan()

void NoteTrack::ClearVisibleChan ( int c )

inline

Definition at line 160 of file NoteTrack.h.

160 {

161 mVisibleChannels.fetch_and(~CHANNEL_BIT(c), std::memory_order_relaxed); }

CHANNEL_BIT

#define CHANNEL_BIT(c)

Definition: NoteTrack.h:148

NoteTrack::mVisibleChannels

std::atomic< unsigned > mVisibleChannels

A bit set; atomic because it may be read by worker threads in playback.

Definition: NoteTrack.h:215

References CHANNEL_BIT.

◆ Clone()

Track::Holder NoteTrack::Clone ( bool backup ) const

overrideprivatevirtual

Subclass responsibility implements only a part of Duplicate(), copying the track data proper (not associated data such as for groups and views) including TrackId

Parameters

backup whether the duplication is for backup purposes while opening a project, instead of other editing operations

Postcondition: result tracks have same TrackIds as the channels of this

Implements Track.

Definition at line 180 of file NoteTrack.cpp.

{
   auto duplicate = std::make_shared<NoteTrack>();
   duplicate->Init(*this);
   // The duplicate begins life in serialized state.  Often the duplicate is
   // pushed on the Undo stack.  Then we want to un-serialize it (or a further
   // copy) only on demand after an Undo.
   if (mSeq) {
      SonifyBeginSerialize();
      wxASSERT(!mSerializationBuffer);
      // serialize from this to duplicate's mSerializationBuffer
      void *buffer;
      mSeq->serialize(&buffer,
                      &duplicate->mSerializationLength);
      duplicate->mSerializationBuffer.reset( (char*)buffer );
      SonifyEndSerialize();
   }
   else if (mSerializationBuffer) {
      // Copy already serialized data.
      wxASSERT(!mSeq);
      duplicate->mSerializationLength = this->mSerializationLength;
      duplicate->mSerializationBuffer.reset
         ( safenew char[ this->mSerializationLength ] );
      memcpy( duplicate->mSerializationBuffer.get(),
              this->mSerializationBuffer.get(), this->mSerializationLength );
   }
   else {
      // We are duplicating a default-constructed NoteTrack, and that's okay
   }
 
   // copy some other fields here
   Attachments &attachments = *duplicate;
   attachments = *this;
 
   duplicate->SetVisibleChannels(GetVisibleChannels());
   duplicate->MoveTo(mOrigin);
   duplicate->SetVelocity(GetVelocity());
   return duplicate;
}

References GetVelocity(), GetVisibleChannels(), mOrigin, mSeq, mSerializationBuffer, mSerializationLength, safenew, SonifyBeginSerialize, and SonifyEndSerialize.

Here is the call graph for this function:

◆ Copy()

Track::Holder NoteTrack::Copy	(	double	t0,
		double	t1,
		bool	forClipboard = `true`
	)		const

overridevirtual

Create new tracks and don't modify this track.

Returns: non-NULL or else throw Note that subclasses may want to distinguish tracks stored in a clipboard from those stored in a project May assume precondition: t0 <= t1 Should invoke Track::Init

Implements Track.

Definition at line 350 of file NoteTrack.cpp.

{
   if (t1 < t0)
      THROW_INCONSISTENCY_EXCEPTION;
 
   double len = t1-t0;
 
   auto newTrack = std::make_shared<NoteTrack>();
 
   newTrack->Init(*this);
 
   auto &seq = GetSeq();
   seq.convert_to_seconds();
   newTrack->mSeq.reset(seq.copy(t0 - mOrigin, len, false));
   newTrack->MoveTo(0);
 
   // What should be done with the rest of newTrack's members?
   // (mBottomNote, mSerializationBuffer,
   // mSerializationLength, mVisibleChannels)
 
   return newTrack;
}

References GetSeq(), mOrigin, and THROW_INCONSISTENCY_EXCEPTION.

Referenced by anonymous_namespace{EditMenus.cpp}::OnCut().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Cut()

Track::Holder NoteTrack::Cut	(	double	t0,
		double	t1
	)

overridevirtual

Create tracks and modify this track.

Returns: non-NULL or else throw May assume precondition: t0 <= t1

Implements Track.

Definition at line 320 of file NoteTrack.cpp.

{
   if (t1 < t0)
      THROW_INCONSISTENCY_EXCEPTION;
 
   double len = t1-t0;
   //auto delta = -(
      //( std::min( t1, GetEndTime() ) ) - ( std::max( t0, GetStartTime() ) )
   //);
 
   auto newTrack = std::make_shared<NoteTrack>();
 
   newTrack->Init(*this);
 
   auto &seq = GetSeq();
   seq.convert_to_seconds();
   newTrack->mSeq.reset(seq.cut(t0 - mOrigin, len, false));
   newTrack->MoveTo(0);
 
   // Not needed
   // Alg_seq::cut seems to handle this
   //AddToDuration( delta );
 
   // What should be done with the rest of newTrack's members?
   //(mBottomNote,
   // mSerializationBuffer, mSerializationLength, mVisibleChannels)
 
   return newTrack;
}

References GetSeq(), mOrigin, and THROW_INCONSISTENCY_EXCEPTION.

Referenced by anonymous_namespace{EditMenus.cpp}::OnCut().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoGetInterval()

std::shared_ptr< WideChannelGroupInterval > NoteTrack::DoGetInterval ( size_t iInterval )

overrideprivatevirtual

Retrieve an interval.

Postcondition: result: !(iInterval < NIntervals()) || result

Implements ChannelGroup.

Definition at line 594 of file NoteTrack.cpp.

{
   if (iInterval == 0)
      // Just one, and no extra info in it!
      return std::make_shared<Interval>(*this);
   return {};
}

◆ DoSetVelocity()

void NoteTrack::DoSetVelocity ( float velocity )

private

Definition at line 516 of file NoteTrack.cpp.

{
   mVelocity.store(velocity, std::memory_order_relaxed);
}

References mVelocity.

Referenced by HandleXMLTag(), and SetVelocity().

Here is the caller graph for this function:

◆ ExportAllegro()

bool NoteTrack::ExportAllegro ( const wxString & f ) const

Definition at line 783 of file NoteTrack.cpp.

{
   double offset = mOrigin;
   auto in_seconds = AllegroStyleSetting.ReadEnum();
   auto &seq = GetSeq();
   if (in_seconds) {
       seq.convert_to_seconds();
   } else {
       seq.convert_to_beats();
   }
   return seq.write(f.mb_str(), offset);
}

References AllegroStyleSetting, GetSeq(), mOrigin, and EnumSetting< Enum >::ReadEnum().

Here is the call graph for this function:

◆ ExportMIDI()

bool NoteTrack::ExportMIDI ( const wxString & f ) const

Definition at line 759 of file NoteTrack.cpp.

{
   std::unique_ptr<Alg_seq> cleanup;
   auto seq = MakeExportableSeq(cleanup);
   bool rslt = seq->smf_write(f.mb_str());
   return rslt;
}

References MakeExportableSeq().

Here is the call graph for this function:

◆ GetSeq()

Alg_seq & NoteTrack::GetSeq ( ) const

Definition at line 158 of file NoteTrack.cpp.

{
   if (!mSeq) {
      if (!mSerializationBuffer)
         mSeq = std::make_unique<Alg_seq>();
      else {
         std::unique_ptr<Alg_track> alg_track
         { Alg_seq::unserialize
            ( mSerializationBuffer.get(), mSerializationLength ) };
         wxASSERT(alg_track->get_type() == 's');
         mSeq.reset( static_cast<Alg_seq*>(alg_track.release()) );
 
         // Preserve the invariant that at most one of the representations is
         // valid
         mSerializationBuffer.reset();
         mSerializationLength = 0;
      }
   }
   wxASSERT(mSeq);
   return *mSeq;
}

References mSeq, mSerializationBuffer, and mSerializationLength.

Referenced by AddToDuration(), Clear(), Copy(), Cut(), DEFINE_ATTACHED_VIRTUAL_OVERRIDE(), anonymous_namespace{NoteTrackView.cpp}::DrawNoteBackground(), anonymous_namespace{NoteTrackView.cpp}::DrawNoteTrack(), ExportAllegro(), anonymous_namespace{ImportMIDI.cpp}::ImportMIDI(), InsertSilence(), MakeExportableSeq(), NearestBeatTime(), Paste(), Shift(), Silence(), StretchRegion(), Trim(), WarpAndTransposeNotes(), and WriteXML().

Here is the caller graph for this function:

◆ GetTypeInfo()

auto NoteTrack::GetTypeInfo ( ) const

overridevirtual

Implements Track.

Definition at line 569 of file NoteTrack.cpp.

{
   return typeInfo();
}

References typeInfo().

Here is the call graph for this function:

◆ GetVelocity()

float NoteTrack::GetVelocity ( ) const

inline

Definition at line 124 of file NoteTrack.h.

124 {

125 return mVelocity.load(std::memory_order_relaxed); }

Referenced by Clone(), anonymous_namespace{MIDIPlay.h}::Iterator::OutputEvent(), SetVelocity(), NoteTrackControls::VelocitySlider(), and WriteXML().

Here is the caller graph for this function:

◆ GetVisibleChannels()

unsigned NoteTrack::GetVisibleChannels ( ) const

inline

Definition at line 149 of file NoteTrack.h.

                                       {
      return mVisibleChannels.load(std::memory_order_relaxed);
   }

Referenced by Clone(), and WriteXML().

Here is the caller graph for this function:

◆ HandleXMLChild()

XMLTagHandler * NoteTrack::HandleXMLChild ( const std::string_view & tag )

overridevirtual

Implements XMLTagHandler.

Definition at line 843 of file NoteTrack.cpp.

{
   return NULL;
}

◆ HandleXMLTag()

bool NoteTrack::HandleXMLTag	(	const std::string_view &	tag,
		const AttributesList &	attrs
	)

overridevirtual

Implements XMLTagHandler.

Definition at line 804 of file NoteTrack.cpp.

{
   if (tag == "notetrack") {
      for (auto pair : attrs)
      {
         auto attr = pair.first;
         auto value = pair.second;
 
         long nValue;
         double dblValue;
         if (this->Track::HandleCommonXMLAttribute(attr, value))
            ;
         else if (this->Attachments::FindIf([&](auto &attachment){
            return attachment.HandleAttribute(pair);
         }))
            ;
         else if (this->PlayableTrack::HandleXMLAttribute(attr, value))
         {}
         else if (attr == "offset" && value.TryGet(dblValue))
            MoveTo(dblValue);
         else if (attr == "visiblechannels") {
             if (!value.TryGet(nValue) ||
                 !IsValidVisibleChannels(nValue))
                 return false;
             SetVisibleChannels(nValue);
         }
         else if (attr == "velocity" && value.TryGet(dblValue))
            DoSetVelocity(static_cast<float>(dblValue));
         else if (attr == "data") {
             std::string s(value.ToWString());
             std::istringstream data(s);
             mSeq = std::make_unique<Alg_seq>(data, false);
         }
      } // while
      return true;
   }
   return false;
}

References DoSetVelocity(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::FindIf(), Track::HandleCommonXMLAttribute(), PlayableTrack::HandleXMLAttribute(), anonymous_namespace{NoteTrack.cpp}::IsValidVisibleChannels(), MoveTo(), mSeq, and SetVisibleChannels().

Here is the call graph for this function:

◆ InsertSilence()

void NoteTrack::InsertSilence	(	double	t,
		double	len
	)

overridevirtual

May assume precondition: t0 <= t1

Implements Track.

Definition at line 495 of file NoteTrack.cpp.

{
   if (len < 0)
      THROW_INCONSISTENCY_EXCEPTION;
 
   auto &seq = GetSeq();
   seq.convert_to_seconds();
   seq.insert_silence(t - mOrigin, len);
 
   // is this needed?
   // AddToDuration( len );
}

References GetSeq(), mOrigin, and THROW_INCONSISTENCY_EXCEPTION.

Referenced by Paste().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsVisibleChan()

bool NoteTrack::IsVisibleChan ( int c ) const

inline

Definition at line 155 of file NoteTrack.h.

                                   {
      return (GetVisibleChannels() & CHANNEL_BIT(c)) != 0;
   }

References CHANNEL_BIT.

Referenced by anonymous_namespace{NoteTrackControls.cpp}::DrawLabelControls(), anonymous_namespace{NoteTrackView.cpp}::DrawNoteTrack(), and anonymous_namespace{MIDIPlay.h}::Iterator::Unmuted().

Here is the caller graph for this function:

◆ MakeExportableSeq()

Alg_seq * NoteTrack::MakeExportableSeq ( std::unique_ptr< Alg_seq > & cleanup ) const

Definition at line 636 of file NoteTrack.cpp.

{
   cleanup.reset();
   double offset = mOrigin;
   if (offset == 0)
      return &GetSeq();
   // make a copy, deleting events that are shifted before time 0
   double start = -offset;
   if (start < 0) start = 0;
   // notes that begin before "start" are not included even if they
   // extend past "start" (because "all" parameter is set to false)
   cleanup.reset( GetSeq().copy(start, GetSeq().get_dur() - start, false) );
   auto seq = cleanup.get();
   if (offset > 0) {
      {
         // swap cleanup and mSeq so that Shift operates on the NEW copy
         swap( this->mSeq, cleanup );
         auto cleanup2 = finally( [&] { swap( this->mSeq, cleanup ); } );
 
         const_cast< NoteTrack *>( this )->Shift(offset);
      }
#ifdef OLD_CODE
      // now shift events by offset. This must be done with an integer
      // number of measures, so first, find the beats-per-measure
      double beats_per_measure = 4.0;
      Alg_time_sig_ptr tsp = NULL;
      if (seq->time_sig.length() > 0 && seq->time_sig[0].beat < ALG_EPS) {
         // there is an initial time signature
         tsp = &(seq->time_sig[0]);
         beats_per_measure = (tsp->num * 4) / tsp->den;
      }
      // also need the initial tempo
      double bps = ALG_DEFAULT_BPM / 60;
      Alg_time_map_ptr map = seq->get_time_map();
      Alg_beat_ptr bp = &(map->beats[0]);
      if (bp->time < ALG_EPS) { // tempo change at time 0
         if (map->beats.len > 1) { // compute slope to get tempo
            bps = (map->beats[1].beat - map->beats[0].beat) /
                  (map->beats[1].time - map->beats[0].time);
         } else if (seq->get_time_map()->last_tempo_flag) {
            bps = seq->get_time_map()->last_tempo;
         }
      }
      // find closest number of measures to fit in the gap
      // number of measures is offset / measure_time
      double measure_time = beats_per_measure / bps; // seconds per measure
      int n = ROUND(offset / measure_time);
      if (n == 0) n = 1;
      // we will insert n measures. Compute the desired duration of each.
      measure_time = offset / n;
      bps = beats_per_measure / measure_time;
      // insert integer multiple of measures at beginning
      seq->convert_to_beats();
      seq->insert_silence(0, beats_per_measure * n);
      // make sure time signature at 0 is correct
      if (tsp) {
         seq->set_time_sig(0, tsp->num, tsp->den);
      }
      // adjust tempo to match offset
      seq->set_tempo(bps * 60.0, 0, beats_per_measure * n);
#endif
   } else {
      auto &mySeq = GetSeq();
      // if offset is negative, it might not be a multiple of beats, but
      // we want to preserve the relative positions of measures. I.e. we
      // should shift barlines and time signatures as well as notes.
      // Insert a time signature at the first bar-line if necessary.
 
      // Translate start from seconds to beats and call it beat:
      double beat = mySeq.get_time_map()->time_to_beat(start);
      // Find the time signature in mySeq in effect at start (beat):
      int i = mySeq.time_sig.find_beat(beat);
      // i is where you would insert a NEW time sig at beat,
      // Case 1: beat coincides with a time sig at i. Time signature
      // at beat means that there is a barline at beat, so when beat
      // is shifted to 0, the relative barline positions are preserved
      if (mySeq.time_sig.length() > 0 &&
          within(beat, mySeq.time_sig[i].beat, ALG_EPS)) {
         // beat coincides with time signature change, so offset must
         // be a multiple of beats
         /* do nothing */ ;
      // Case 2: there is no time signature before beat.
      } else if (i == 0 && (mySeq.time_sig.length() == 0 ||
                            mySeq.time_sig[i].beat > beat)) {
         // If beat does not fall on an implied barline, we need to
         // insert a time signature.
         double measures = beat / 4.0;
         double imeasures = ROUND(measures);
         if (!within(measures, imeasures, ALG_EPS)) {
            double bar_offset = ((int)(measures) + 1) * 4.0 - beat;
            seq->set_time_sig(bar_offset, 4, 4);
         }
      // This case should never be true because if i == 0, either there
      // are no time signatures before beat (Case 2),
      // or there is one time signature at beat (Case 1)
      } else if (i == 0) {
         /* do nothing (might be good to assert(false)) */ ;
      // Case 3: i-1 must be the effective time sig position
      } else {
         i -= 1; // index the time signature in effect at beat
         Alg_time_sig_ptr tsp = &(mySeq.time_sig[i]);
         double beats_per_measure = (tsp->num * 4) / tsp->den;
         double measures = (beat - tsp->beat) / beats_per_measure;
         int imeasures = ROUND(measures);
         if (!within(measures, imeasures, ALG_EPS)) {
            // beat is not on a measure, so we need to insert a time sig
            // to force a bar line at the first measure location after
            // beat
            double bar = tsp->beat + beats_per_measure * ((int)(measures) + 1);
            double bar_offset = bar - beat;
            // insert NEW time signature at bar_offset in NEW sequence
            // It will have the same time signature, but the position will
            // force a barline to match the barlines in mSeq
            seq->set_time_sig(bar_offset, tsp->num, tsp->den);
         }
         // else beat coincides with a barline, so no need for an extra
         // time signature to force barline alignment
      }
   }
   return seq;
}

References staffpad::vo::copy(), GetSeq(), mOrigin, mSeq, ROUND, Shift(), anonymous_namespace{NoteTrack.cpp}::swap(), and within().

Referenced by ExportMIDI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MoveTo()

void NoteTrack::MoveTo ( double o )

inlineoverridevirtual

Change start time to given time point.

Implements ChannelGroup.

Definition at line 98 of file NoteTrack.h.

98{ mOrigin = origin; }

Referenced by Clear(), HandleXMLTag(), anonymous_namespace{ImportMIDI.cpp}::ImportMIDI(), Paste(), and Trim().

Here is the caller graph for this function:

◆ NearestBeatTime()

QuantizedTimeAndBeat NoteTrack::NearestBeatTime ( double time ) const

Definition at line 550 of file NoteTrack.cpp.

{
   // Alg_seq knows nothing about offset, so remove offset time
   double seq_time = time - mOrigin;
   double beat;
   auto &seq = GetSeq();
   seq_time = seq.nearest_beat_time(seq_time, &beat);
   // add the offset back in to get "actual" audacity track time
   return { seq_time + mOrigin, beat };
}

References GetSeq(), and mOrigin.

Here is the call graph for this function:

◆ New()

NoteTrack * NoteTrack::New ( AudacityProject & project )

static

Definition at line 137 of file NoteTrack.cpp.

{
   auto &tracks = TrackList::Get( project );
   auto result = tracks.Add( std::make_shared<NoteTrack>());
   result->AttachedTrackObjects::BuildAll();
   return result;
}

References TrackList::Get(), project, and tracks.

Here is the call graph for this function:

◆ NIntervals()

size_t NoteTrack::NIntervals ( ) const

overridevirtual

Report the number of intervals.

Implements ChannelGroup.

Definition at line 588 of file NoteTrack.cpp.

{
   return 1;
}

◆ Paste()

void NoteTrack::Paste	(	double	t,
		const Track &	src
	)

overridevirtual

Weak precondition allows overrides to replicate one channel into many.

Precondition: SameKindAs(src); src.NChannels() == 1 || src.NChannels() == NChannels()

Implements Track.

Definition at line 430 of file NoteTrack.cpp.

{
   // Paste inserts src at time t. If src has a positive offset,
   // the offset is treated as silence which is also inserted. If
   // the offset is negative, the offset is ignored and the ENTIRE
   // src is inserted (otherwise, we would either lose data from
   // src by not inserting things at negative times, or inserting
   // things at negative times could overlap things already in
   // the destination track).
 
   //Check that src is a non-NULL NoteTrack
   bool bOk = src.TypeSwitch<bool>( [&](const NoteTrack &other) {
 
      auto myOffset = this->mOrigin;
      if (t < myOffset) {
         // workaround strange behavior described at
         // http://bugzilla.audacityteam.org/show_bug.cgi?id=1735#c3
         MoveTo(t);
         InsertSilence(t, myOffset - t);
      }
 
      double delta = 0.0;
      auto &seq = GetSeq();
      auto offset = other.mOrigin;
      if (offset > 0) {
         seq.convert_to_seconds();
         seq.insert_silence(t - mOrigin, offset);
         t += offset;
         // Is this needed or does Alg_seq::insert_silence take care of it?
         //delta += offset;
      }
 
      // This seems to be needed:
      delta += std::max(0.0, t - GetEndTime());
 
      // This, not:
      //delta += other.GetSeq().get_real_dur();
 
      seq.paste(t - mOrigin, &other.GetSeq());
 
      AddToDuration(delta);
 
      return true;
   });
 
   if (!bOk)
      // THROW_INCONSISTENCY_EXCEPTION; // ?
      (void)0;// intentionally do nothing
}

References AddToDuration(), ChannelGroup::GetEndTime(), GetSeq(), InsertSilence(), mOrigin, MoveTo(), and Track::TypeSwitch().

Here is the call graph for this function:

◆ PasteInto()

Track::Holder NoteTrack::PasteInto	(	AudacityProject &	project,
		TrackList &	list
	)		const

overridevirtual

Find or create the destination track for a paste, maybe in a different project

Parameters

list	to which any newly created tracks are added; but left unchanged if an existing track is found in the project instead

Returns: A smart pointer to a track

Implements Track.

Definition at line 579 of file NoteTrack.cpp.

{
   auto pNewTrack = std::make_shared<NoteTrack>();
   pNewTrack->Init(*this);
   pNewTrack->Paste(0.0, *this);
   list.Add(pNewTrack);
   return pNewTrack;
}

References TrackList::Add().

Here is the call graph for this function:

◆ PrintSequence()

void NoteTrack::PrintSequence ( )

Definition at line 261 of file NoteTrack.cpp.

{
   FILE *debugOutput;
 
   debugOutput = fopen("debugOutput.txt", "wt");
   wxFprintf(debugOutput, "Importing MIDI...\n");
 
   // This is called for debugging purposes.  Do not compute mSeq on demand
   // with GetSeq()
   if (mSeq) {
      int i = 0;
 
      while(i < mSeq->length()) {
         wxFprintf(debugOutput, "--\n");
         wxFprintf(debugOutput, "type: %c\n",
            ((Alg_event_ptr)mSeq->track_list.tracks[i])->get_type());
         wxFprintf(debugOutput, "time: %f\n",
            ((Alg_event_ptr)mSeq->track_list.tracks[i])->time);
         wxFprintf(debugOutput, "channel: %li\n",
            ((Alg_event_ptr)mSeq->track_list.tracks[i])->chan);
 
         if(((Alg_event_ptr)mSeq->track_list.tracks[i])->get_type() == wxT('n'))
         {
            wxFprintf(debugOutput, "pitch: %f\n",
               ((Alg_note_ptr)mSeq->track_list.tracks[i])->pitch);
            wxFprintf(debugOutput, "duration: %f\n",
               ((Alg_note_ptr)mSeq->track_list.tracks[i])->dur);
            wxFprintf(debugOutput, "velocity: %f\n",
               ((Alg_note_ptr)mSeq->track_list.tracks[i])->loud);
         }
         else if(((Alg_event_ptr)mSeq->track_list.tracks[i])->get_type() == wxT('n'))
         {
            wxFprintf(debugOutput, "key: %li\n", ((Alg_update_ptr)mSeq->track_list.tracks[i])->get_identifier());
            wxFprintf(debugOutput, "attribute type: %c\n", ((Alg_update_ptr)mSeq->track_list.tracks[i])->parameter.attr_type());
            wxFprintf(debugOutput, "attribute: %s\n", ((Alg_update_ptr)mSeq->track_list.tracks[i])->parameter.attr_name());
 
            if(((Alg_update_ptr)mSeq->track_list.tracks[i])->parameter.attr_type() == wxT('r'))
            {
               wxFprintf(debugOutput, "value: %f\n", ((Alg_update_ptr)mSeq->track_list.tracks[i])->parameter.r);
            }
            else if(((Alg_update_ptr)mSeq->track_list.tracks[i])->parameter.attr_type() == wxT('i')) {
               wxFprintf(debugOutput, "value: %li\n", ((Alg_update_ptr)mSeq->track_list.tracks[i])->parameter.i);
            }
            else if(((Alg_update_ptr)mSeq->track_list.tracks[i])->parameter.attr_type() == wxT('s')) {
               wxFprintf(debugOutput, "value: %s\n", ((Alg_update_ptr)mSeq->track_list.tracks[i])->parameter.s);
            }
            else {}
         }
 
         i++;
      }
   }
   else {
      wxFprintf(debugOutput, "No sequence defined!\n");
   }
 
   fclose(debugOutput);
}

References mSeq, and wxT().

Here is the call graph for this function:

◆ SetSequence()

void NoteTrack::SetSequence ( std::unique_ptr< Alg_seq > && seq )

Definition at line 256 of file NoteTrack.cpp.

{
   mSeq = std::move(seq);
}

References mSeq.

Referenced by anonymous_namespace{ImportMIDI.cpp}::ImportMIDI().

Here is the caller graph for this function:

◆ SetVelocity()

void NoteTrack::SetVelocity ( float velocity )

Definition at line 508 of file NoteTrack.cpp.

{
   if (GetVelocity() != velocity) {
      DoSetVelocity(velocity);
      Notify(false);
   }
}

References DoSetVelocity(), GetVelocity(), and Track::Notify().

Referenced by MixerTrackCluster::HandleSliderVelocity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetVisibleChan()

void NoteTrack::SetVisibleChan ( int c )

inline

Definition at line 158 of file NoteTrack.h.

158 {

159 mVisibleChannels.fetch_or(CHANNEL_BIT(c), std::memory_order_relaxed); }

References CHANNEL_BIT.

◆ SetVisibleChannels()

void NoteTrack::SetVisibleChannels ( unsigned value )

inline

Definition at line 152 of file NoteTrack.h.

                                           {
      mVisibleChannels.store(value, std::memory_order_relaxed);
   }

Referenced by HandleXMLTag().

Here is the caller graph for this function:

◆ Shift()

bool NoteTrack::Shift ( double t )

Definition at line 523 of file NoteTrack.cpp.

{
   if (t > 0) {
      auto &seq = GetSeq();
      // insert an even number of measures
      seq.convert_to_beats();
      // get initial tempo
      double tempo = seq.get_tempo(0.0);
      double beats_per_measure = seq.get_bar_len(0.0);
      int m = ROUND(t * tempo / beats_per_measure);
      // need at least 1 measure, so if we rounded down to zero, fix it
      if (m == 0) m = 1;
      // compute NEW tempo so that m measures at NEW tempo take t seconds
      tempo = beats_per_measure * m / t; // in beats per second
      seq.insert_silence(0.0, beats_per_measure * m);
      seq.set_tempo(tempo * 60.0 /* bpm */, 0.0, beats_per_measure * m);
      seq.write("afterShift.gro");
   } else if (t < 0) {
      auto &seq = GetSeq();
      seq.convert_to_seconds();
      seq.clear(0, t, true);
   } else { // offset is zero, no modifications
      return false;
   }
   return true;
}

References GetSeq(), and ROUND.

Referenced by MakeExportableSeq().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Silence()

void NoteTrack::Silence	(	double	t0,
		double	t1,
		ProgressReporter	reportProgress = `{}`
	)

overridevirtual

Implements Track.

Definition at line 480 of file NoteTrack.cpp.

{
   if (t1 < t0)
      THROW_INCONSISTENCY_EXCEPTION;
 
   auto len = t1 - t0;
 
   auto &seq = GetSeq();
   seq.convert_to_seconds();
   // XXX: do we want to set the all param?
   // If it's set, then it seems like notes are silenced if they start or end in the range,
   // otherwise only if they start in the range. --Poke
   seq.silence(t0 - mOrigin, len, false);
}

References GetSeq(), mOrigin, and THROW_INCONSISTENCY_EXCEPTION.

Here is the call graph for this function:

◆ SoloVisibleChan()

void NoteTrack::SoloVisibleChan ( int c )

inline

Definition at line 166 of file NoteTrack.h.

                               {
      auto visibleChannels = 0u;
      if (GetVisibleChannels() == CHANNEL_BIT(c))
         visibleChannels = ALL_CHANNELS;
      else
         visibleChannels = CHANNEL_BIT(c);
      mVisibleChannels.store(visibleChannels, std::memory_order_relaxed);
   }

References ALL_CHANNELS, and CHANNEL_BIT.

Referenced by LabelClick().

Here is the caller graph for this function:

◆ StretchRegion()

bool NoteTrack::StretchRegion	(	QuantizedTimeAndBeat	t0,
		QuantizedTimeAndBeat	t1,
		double	newDur
	)

Definition at line 614 of file NoteTrack.cpp.

{
   auto &seq = GetSeq();
   bool result = seq.stretch_region( t0.second, t1.second, newDur );
   if (result) {
      const auto oldDur = t1.first - t0.first;
      AddToDuration( newDur - oldDur );
   }
   return result;
}

References AddToDuration(), and GetSeq().

Here is the call graph for this function:

◆ ToggleVisibleChan()

void NoteTrack::ToggleVisibleChan ( int c )

inline

Definition at line 162 of file NoteTrack.h.

162 {

163 mVisibleChannels.fetch_xor(CHANNEL_BIT(c), std::memory_order_relaxed); }

References CHANNEL_BIT.

Referenced by LabelClick().

Here is the caller graph for this function:

◆ Trim()

bool NoteTrack::Trim	(	double	t0,
		double	t1
	)

Definition at line 373 of file NoteTrack.cpp.

{
   if (t1 < t0)
      return false;
   auto &seq = GetSeq();
   //auto delta = -(
      //( GetEndTime() - std::min( GetEndTime(), t1 ) ) +
      //( std::max(t0, GetStartTime()) - GetStartTime() )
   //);
   seq.convert_to_seconds();
   // DELETE way beyond duration just in case something is out there:
   seq.clear(t1 - mOrigin, seq.get_dur() + 10000.0, false);
   // Now that stuff beyond selection is cleared, clear before selection:
   seq.clear(0.0, t0 - mOrigin, false);
   // want starting time to be t0
   MoveTo(t0);
 
   // Not needed
   // Alg_seq::clear seems to handle this
   //AddToDuration( delta );
 
   return true;
}

References GetSeq(), mOrigin, and MoveTo().

Here is the call graph for this function:

◆ WarpAndTransposeNotes()

void NoteTrack::WarpAndTransposeNotes	(	double	t0,
		double	t1,
		const TimeWarper &	warper,
		double	semitones
	)

Definition at line 220 of file NoteTrack.cpp.

{
   double offset = this->mOrigin; // track is shifted this amount
   auto &seq = GetSeq();
   seq.convert_to_seconds(); // make sure time units are right
   t1 -= offset; // adjust time range to compensate for track offset
   t0 -= offset;
   if (t1 > seq.get_dur()) { // make sure t0, t1 are within sequence
      t1 = seq.get_dur();
      if (t0 >= t1) return;
   }
   Alg_iterator iter(mSeq.get(), false);
   iter.begin();
   Alg_event_ptr event;
   while (0 != (event = iter.next()) && event->time < t1) {
      if (event->is_note() && event->time >= t0) {
         event->set_pitch(event->get_pitch() + semitones);
      }
   }
   iter.end();
   // now, use warper to warp the tempo map
   seq.convert_to_beats(); // beats remain the same
   Alg_time_map_ptr map = seq.get_time_map();
   map->insert_beat(t0, map->time_to_beat(t0));
   map->insert_beat(t1, map->time_to_beat(t1));
   int i, len = map->length();
   for (i = 0; i < len; i++) {
      Alg_beat &beat = map->beats[i];
      beat.time = warper.Warp(beat.time + offset) - offset;
   }
   // about to redisplay, so might as well convert back to time now
   seq.convert_to_seconds();
}

References GetSeq(), mOrigin, mSeq, and TimeWarper::Warp().

Here is the call graph for this function:

◆ WriteXML()

void NoteTrack::WriteXML ( XMLWriter & xmlFile ) const

overridevirtual

Implements Track.

Definition at line 848 of file NoteTrack.cpp.

{
   std::ostringstream data;
   Track::Holder holder;
   const NoteTrack *saveme = this;
   if (!mSeq) {
      // replace saveme with an (unserialized) duplicate, which is
      // destroyed at end of function.
      holder = Clone(false);
      saveme = static_cast<NoteTrack*>(holder.get());
   }
   saveme->GetSeq().write(data, true);
   xmlFile.StartTag(wxT("notetrack"));
   saveme->Track::WriteCommonXMLAttributes( xmlFile );
   this->PlayableTrack::WriteXMLAttributes(xmlFile);
   xmlFile.WriteAttr(wxT("offset"), saveme->mOrigin);
   xmlFile.WriteAttr(wxT("visiblechannels"),
      static_cast<int>(saveme->GetVisibleChannels()));
 
   xmlFile.WriteAttr(wxT("velocity"),
      static_cast<double>(saveme->GetVelocity()));
   saveme->Attachments::ForEach([&](auto &attachment){
      attachment.WriteXML(xmlFile);
   });
   xmlFile.WriteAttr(wxT("data"), wxString(data.str().c_str(), wxConvUTF8));
   xmlFile.EndTag(wxT("notetrack"));
}

References GetSeq(), GetVelocity(), GetVisibleChannels(), mOrigin, PlayableTrack::WriteXMLAttributes(), and wxT().

Here is the call graph for this function:

Member Data Documentation

◆ AllegroStyleSetting

EnumSetting< bool > NoteTrack::AllegroStyleSetting

static

Initial value:

{
   wxT("/FileFormats/AllegroStyleChoice"),
   {
      EnumValueSymbol{ wxT("Seconds"), XXO("&Seconds") },
      
      EnumValueSymbol{ wxT("Beats"), XXO("&Beats") },
   },
   0, 
 
   
   {
      true, false,
   },
   wxT("/FileFormats/AllegroStyle"),
}

Definition at line 81 of file NoteTrack.h.

Referenced by anonymous_namespace{ExportMIDI.cpp}::AddControls(), and ExportAllegro().

◆ mOrigin

double NoteTrack::mOrigin { 0.0 }

private

Definition at line 216 of file NoteTrack.h.

Referenced by Clear(), Clone(), Copy(), Cut(), ExportAllegro(), InsertSilence(), MakeExportableSeq(), NearestBeatTime(), Paste(), Silence(), Trim(), WarpAndTransposeNotes(), and WriteXML().

◆ mSeq

std::unique_ptr<Alg_seq> NoteTrack::mSeq

mutableprivate

Definition at line 207 of file NoteTrack.h.

Referenced by Clone(), GetSeq(), HandleXMLTag(), MakeExportableSeq(), NoteTrack(), PrintSequence(), SetSequence(), and WarpAndTransposeNotes().

◆ mSerializationBuffer

std::unique_ptr<char[]> NoteTrack::mSerializationBuffer

mutableprivate

Definition at line 208 of file NoteTrack.h.

Referenced by Clone(), and GetSeq().

◆ mSerializationLength

long NoteTrack::mSerializationLength

mutableprivate

Definition at line 209 of file NoteTrack.h.

Referenced by Clone(), GetSeq(), and NoteTrack().

◆ mVelocity

std::atomic<float> NoteTrack::mVelocity { 0.0f }

private

Atomic because it may be read by worker threads in playback.

Definition at line 212 of file NoteTrack.h.

Referenced by DoSetVelocity().

◆ mVisibleChannels

std::atomic<unsigned> NoteTrack::mVisibleChannels { ALL_CHANNELS }

private

A bit set; atomic because it may be read by worker threads in playback.

Definition at line 215 of file NoteTrack.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Attachments

◆ Holder

Constructor & Destructor Documentation

◆ NoteTrack() [1/3]

◆ NoteTrack() [2/3]

◆ NoteTrack() [3/3]

◆ ~NoteTrack()

Member Function Documentation

◆ AddToDuration()

◆ ClassTypeInfo()

◆ Clear()

◆ ClearVisibleChan()

◆ Clone()

◆ Copy()

◆ Cut()

◆ DoGetInterval()

◆ DoSetVelocity()

◆ ExportAllegro()

◆ ExportMIDI()

◆ GetSeq()

◆ GetTypeInfo()

◆ GetVelocity()

◆ GetVisibleChannels()

◆ HandleXMLChild()

◆ HandleXMLTag()

◆ InsertSilence()

◆ IsVisibleChan()

◆ MakeExportableSeq()

◆ MoveTo()

◆ NearestBeatTime()

◆ New()

◆ NIntervals()

◆ Paste()

◆ PasteInto()

◆ PrintSequence()

◆ SetSequence()

◆ SetVelocity()

◆ SetVisibleChan()

◆ SetVisibleChannels()

◆ Shift()

◆ Silence()

◆ SoloVisibleChan()

◆ StretchRegion()

◆ ToggleVisibleChan()

◆ Trim()

◆ WarpAndTransposeNotes()

◆ WriteXML()

Member Data Documentation

◆ AllegroStyleSetting

◆ mOrigin

◆ mSeq

◆ mSerializationBuffer

◆ mSerializationLength

◆ mVelocity

◆ mVisibleChannels