ODWaveTrackTaskQueue Class Reference

A class representing a modular task to be used with the On-Demand structures. More...

#include <ODWaveTrackTaskQueue.h>

Collaboration diagram for ODWaveTrackTaskQueue:

Public Member Functions
	ODWaveTrackTaskQueue ()
	Constructs an ODWaveTrackTaskQueue. More...
virtual	~ODWaveTrackTaskQueue ()
void	AddWaveTrack (const std::shared_ptr< WaveTrack > &track)
	Adds a track to the associated list. More...
void	DemandTrackUpdate (WaveTrack *track, double seconds)
	changes the tasks associated with this Waveform to process the task from a different point in the track More...
void	ReplaceWaveTrack (Track *oldTrack, const std::shared_ptr< Track > &newTrack)
	replaces all instances of a WaveTrack within this task with another. More...
void	MakeWaveTrackIndependent (const std::shared_ptr< WaveTrack > &track)
bool	CanMergeWith (ODWaveTrackTaskQueue *otherQueue)
	returns whether or not this queue's task list and another's can merge together, as when we make two mono tracks stereo. More...
void	MergeWaveTrack (const std::shared_ptr< WaveTrack > &track)
bool	ContainsWaveTrack (const WaveTrack *track)
	returns true if the argument is in the WaveTrack list. More...
int	GetNumWaveTracks ()
	returns the number of wavetracks in this queue. More...
void	AddTask (std::unique_ptr< ODTask > &&mtask)
	Add a task to the queue. More...
bool	IsEmpty ()
bool	IsFrontTaskComplete ()
void	RemoveFrontTask ()
	Removes and deletes the front task from the list. More...
ODTask *	GetFrontTask ()
	Schedules the front task for immediate execution. More...
int	GetNumTasks ()
	returns the number of ODTasks in this queue More...
ODTask *	GetTask (size_t x)
	returns a ODTask at position x More...
void	FillTipForWaveTrack (const WaveTrack *t, TranslatableString &tip)
	fills in the status bar message for a given track More...

Protected Member Functions
void	Compress ()

Protected Attributes
TranslatableString	mTipMsg
std::vector< std::weak_ptr< WaveTrack > >	mTracks
	the list of tracks associated with this queue. More...
ODLock	mTracksMutex
std::vector< std::unique_ptr< ODTask > >	mTasks
	the list of tasks associated with the tracks. This class owns these tasks. More...
ODLock	mTasksMutex

Detailed Description

A class representing a modular task to be used with the On-Demand structures.

watches over all to be done (not yet started and started but not finished) tasks associated with a WaveTrack.

Definition at line 32 of file ODWaveTrackTaskQueue.h.

Constructor & Destructor Documentation

ODWaveTrackTaskQueue()

ODWaveTrackTaskQueue::ODWaveTrackTaskQueue

(

)

Constructs an ODWaveTrackTaskQueue.

Definition at line 26 of file ODWaveTrackTaskQueue.cpp.

{
}

~ODWaveTrackTaskQueue()

ODWaveTrackTaskQueue::~ODWaveTrackTaskQueue ( )

virtual

Definition at line 30 of file ODWaveTrackTaskQueue.cpp.

{
   //we need to DELETE all ODTasks.  We will have to block or wait until block for the active ones.
   for(unsigned int i=0;i<mTasks.size();i++)
   {
      mTasks[i]->TerminateAndBlock();//blocks if active.
      //small chance we may have rea-added the task back into the queue from a diff thread.  - so remove it if we have.
      ODManager::Instance()->RemoveTaskIfInQueue(mTasks[i].get());
      mTasks[i].reset();
   }
 
}

References ODManager::Instance, mTasks, and ODManager::RemoveTaskIfInQueue().

Here is the call graph for this function:

Member Function Documentation

AddTask()

void ODWaveTrackTaskQueue::AddTask

(

std::unique_ptr< ODTask > &&

mtask

)

Add a task to the queue.

Definition at line 108 of file ODWaveTrackTaskQueue.cpp.

{
   ODTask *task = mtask.get();
 
   mTasksMutex.Lock();
   mTasks.push_back(std::move(mtask));
   mTasksMutex.Unlock();
 
   //take all of the tracks in the task.
   mTracksMutex.Lock();
   for(int i=0;i<task->GetNumWaveTracks();i++)
   {
      //task->GetWaveTrack(i) may return NULL, but we handle it by checking before using.
      //The other worry that the WaveTrack returned and was deleted in the meantime is also
      //handled by keeping standard weak pointers to tracks, which give thread safety.
      mTracks.push_back(task->GetWaveTrack(i));
   }
 
   mTracksMutex.Unlock();
 
}

References ODTask::GetNumWaveTracks(), ODTask::GetWaveTrack(), mTasks, mTasksMutex, mTracks, and mTracksMutex.

Referenced by ODManager::AddNewTask().

Here is the call graph for this function:

Here is the caller graph for this function:

AddWaveTrack()

void ODWaveTrackTaskQueue::AddWaveTrack

(

const std::shared_ptr< WaveTrack > &

track

)

Adds a track to the associated list.

Definition at line 97 of file ODWaveTrackTaskQueue.cpp.

{
 
   mTracksMutex.Lock();
   if(track)
      mTracks.push_back(track);
 
   mTracksMutex.Unlock();
}

References mTracks, and mTracksMutex.

Referenced by MergeWaveTrack().

Here is the caller graph for this function:

CanMergeWith()

bool ODWaveTrackTaskQueue::CanMergeWith

(

ODWaveTrackTaskQueue *

otherQueue

)

returns whether or not this queue's task list and another's can merge together, as when we make two mono tracks stereo.

Definition at line 44 of file ODWaveTrackTaskQueue.cpp.

{
   //have to be very careful when dealing with two lists that need to be locked.
   if(GetNumTasks()!=otherQueue->GetNumTasks())
      return false;
 
   mTasksMutex.Lock();
   for(unsigned int i=0;i<mTasks.size();i++)
   {
      if(!mTasks[i]->CanMergeWith(otherQueue->GetTask(i)))
      {
         mTasksMutex.Unlock();
         return false;
      }
   }
   mTasksMutex.Unlock();
   return true;
}

References GetNumTasks(), GetTask(), mTasks, and mTasksMutex.

Referenced by ODManager::MakeWaveTrackDependent().

Here is the call graph for this function:

Here is the caller graph for this function:

Compress()

void ODWaveTrackTaskQueue::Compress ( )

protected

Definition at line 327 of file ODWaveTrackTaskQueue.cpp.

{
   mTracksMutex.Lock();
   auto begin = mTracks.begin(), end = mTracks.end(),
   new_end = std::remove_if( begin, end,
      []( const std::weak_ptr<WaveTrack> &ptr ){ return ptr.expired(); } );
   mTracks.erase( new_end, end );
   mTracksMutex.Unlock();
}

References mTracks, and mTracksMutex.

Referenced by GetNumWaveTracks(), IsEmpty(), and MakeWaveTrackIndependent().

Here is the caller graph for this function:

ContainsWaveTrack()

bool ODWaveTrackTaskQueue::ContainsWaveTrack

(

const WaveTrack *

track

)

returns true if the argument is in the WaveTrack list.

Definition at line 82 of file ODWaveTrackTaskQueue.cpp.

{
   mTracksMutex.Lock();
   for(unsigned int i=0;i<mTracks.size();i++)
   {
      if ( mTracks[i].lock().get() == track )
      {
         mTracksMutex.Unlock();
         return true;
      }
   }
   mTracksMutex.Unlock();
   return false;
}

References mTracks, and mTracksMutex.

Referenced by FillTipForWaveTrack().

Here is the caller graph for this function:

DemandTrackUpdate()

void ODWaveTrackTaskQueue::DemandTrackUpdate	(	WaveTrack *	track,
		double	seconds
	)

changes the tasks associated with this Waveform to process the task from a different point in the track

changes the tasks associated with this Waveform to process the task from a different point in the track

Parameters

track	the track to update
seconds	the point in the track from which the tasks associated with track should begin processing from.

Definition at line 176 of file ODWaveTrackTaskQueue.cpp.

{
   if(track)
   {
      mTracksMutex.Lock();
      for(unsigned int i=0;i<mTasks.size();i++)
      {
         mTasks[i]->DemandTrackUpdate(track,seconds);
      }
 
      mTracksMutex.Unlock();
   }
}

References mTasks, and mTracksMutex.

FillTipForWaveTrack()

void ODWaveTrackTaskQueue::FillTipForWaveTrack	(	const WaveTrack *	t,
		TranslatableString &	tip
	)

fills in the status bar message for a given track

Definition at line 307 of file ODWaveTrackTaskQueue.cpp.

{
   if(ContainsWaveTrack(t) && GetNumTasks())
   {
 
    //  if(GetNumTasks()==1)
      mTipMsg = XO("%s %2.0f%% complete. Click to change task focal point.")
         .Format(
            GetFrontTask()->GetTip(),
            GetFrontTask()->PercentComplete()*100.0 );
     // else
       //  msg = XO("%s %d additional tasks remaining.")
       //     .Format( GetFrontTask()->GetTip(), GetNumTasks());
 
      tip = mTipMsg;
 
   }
}

References ContainsWaveTrack(), GetFrontTask(), GetNumTasks(), mTipMsg, and XO.

Here is the call graph for this function:

GetFrontTask()

ODTask * ODWaveTrackTaskQueue::GetFrontTask

(

)

Schedules the front task for immediate execution.

gets the front task for immediate execution

Definition at line 294 of file ODWaveTrackTaskQueue.cpp.

{
   mTasksMutex.Lock();
   if(mTasks.size())
   {
      mTasksMutex.Unlock();
      return mTasks[0].get();
   }
   mTasksMutex.Unlock();
   return NULL;
}

References mTasks, and mTasksMutex.

Referenced by FillTipForWaveTrack(), and ODManager::UpdateQueues().

Here is the caller graph for this function:

GetNumTasks()

int ODWaveTrackTaskQueue::GetNumTasks

(

)

returns the number of ODTasks in this queue

Definition at line 223 of file ODWaveTrackTaskQueue.cpp.

{
   int ret = 0;
   mTasksMutex.Lock();
   ret=mTasks.size();
   mTasksMutex.Unlock();
   return ret;
}

References mTasks, and mTasksMutex.

Referenced by CanMergeWith(), and FillTipForWaveTrack().

Here is the caller graph for this function:

GetNumWaveTracks()

int ODWaveTrackTaskQueue::GetNumWaveTracks

(

)

returns the number of wavetracks in this queue.

Definition at line 211 of file ODWaveTrackTaskQueue.cpp.

{
   Compress();
 
   int ret = 0;
   mTracksMutex.Lock();
   ret=mTracks.size();
   mTracksMutex.Unlock();
   return ret;
}

References Compress(), mTracks, and mTracksMutex.

Here is the call graph for this function:

GetTask()

ODTask * ODWaveTrackTaskQueue::GetTask

(

size_t

x

)

returns a ODTask at position x

Definition at line 233 of file ODWaveTrackTaskQueue.cpp.

{
   ODTask* ret = NULL;
   mTasksMutex.Lock();
   if (x < mTasks.size())
      ret = mTasks[x].get();
   mTasksMutex.Unlock();
   return ret;
}

References mTasks, and mTasksMutex.

Referenced by CanMergeWith().

Here is the caller graph for this function:

IsEmpty()

bool ODWaveTrackTaskQueue::IsEmpty

(

)

Definition at line 246 of file ODWaveTrackTaskQueue.cpp.

{
   Compress();
 
   bool isEmpty;
   mTracksMutex.Lock();
   isEmpty = mTracks.size()<=0;
   mTracksMutex.Unlock();
 
   mTasksMutex.Lock();
   isEmpty = isEmpty || mTasks.size()<=0;
   mTasksMutex.Unlock();
 
   return isEmpty;
}

References Compress(), mTasks, mTasksMutex, mTracks, and mTracksMutex.

Here is the call graph for this function:

IsFrontTaskComplete()

bool ODWaveTrackTaskQueue::IsFrontTaskComplete

(

)

Definition at line 263 of file ODWaveTrackTaskQueue.cpp.

{
   mTasksMutex.Lock();
   if(mTasks.size())
   {
      //there is a chance the task got updated and now has more to do, (like when it is joined with a NEW track)
      //check.
      mTasks[0]->RecalculatePercentComplete();
      bool ret;
      ret = mTasks[0]->IsComplete();
      mTasksMutex.Unlock();
 
      return ret;
   }
   mTasksMutex.Unlock();
   return false;
}

References mTasks, and mTasksMutex.

MakeWaveTrackIndependent()

void ODWaveTrackTaskQueue::MakeWaveTrackIndependent

(

const std::shared_ptr< WaveTrack > &

track

)

Definition at line 131 of file ODWaveTrackTaskQueue.cpp.

{
   // First remove expired weak pointers
   Compress();
   
   mTracksMutex.Lock();
 
   if(mTracks.size()<2)
   {
      //if there is only one track, it is already independent.
      mTracksMutex.Unlock();
      return;
   }
 
   for(unsigned int i=0;i<mTracks.size();i++)
   {
      if ( mTracks[i].lock() == track )
      {
         mTracks[i].reset();
 
         //clone the items in order and add them to the ODManager.
         mTasksMutex.Lock();
         for(unsigned int j=0;j<mTasks.size();j++)
         {
            auto task = mTasks[j]->Clone();
            mTasks[j]->StopUsingWaveTrack( track.get() );
            //AddNewTask requires us to relinquish this lock. However, it is safe because ODManager::MakeWaveTrackIndependent
            //has already locked the m_queuesMutex.
            mTasksMutex.Unlock();
            //AddNewTask locks the m_queuesMutex which is already locked by ODManager::MakeWaveTrackIndependent,
            //so we pass a boolean flag telling it not to lock again.
            ODManager::Instance()->AddNewTask(std::move(task), false);
            mTasksMutex.Lock();
         }
         mTasksMutex.Unlock();
         break;
      }
   }
   mTracksMutex.Unlock();
}

References ODManager::AddNewTask(), Compress(), ODManager::Instance, mTasks, mTasksMutex, mTracks, and mTracksMutex.

Referenced by ODManager::MakeWaveTrackIndependent().

Here is the call graph for this function:

Here is the caller graph for this function:

MergeWaveTrack()

void ODWaveTrackTaskQueue::MergeWaveTrack

(

const std::shared_ptr< WaveTrack > &

track

)

add track to the masterTrack's queue - this will allow future ODScheduling to affect them together. sets the NeedODUpdateFlag since we don't want the head task to finish without haven't dealt with the dependent

Parameters

track

the track to bring into the tasks AND tracklist for this queue

Definition at line 67 of file ODWaveTrackTaskQueue.cpp.

{
   AddWaveTrack(track);
   mTasksMutex.Lock();
   for(unsigned int i=0;i<mTasks.size();i++)
   {
      mTasks[i]->AddWaveTrack(track);
      mTasks[i]->SetNeedsODUpdate();
   }
   mTasksMutex.Unlock();
 
}

References AddWaveTrack(), mTasks, and mTasksMutex.

Referenced by ODManager::MakeWaveTrackDependent().

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveFrontTask()

void ODWaveTrackTaskQueue::RemoveFrontTask

(

)

Removes and deletes the front task from the list.

Definition at line 282 of file ODWaveTrackTaskQueue.cpp.

{
   mTasksMutex.Lock();
   if(mTasks.size())
   {
      //wait for the task to stop running.
      mTasks.erase(mTasks.begin());
   }
   mTasksMutex.Unlock();
}

References mTasks, and mTasksMutex.

ReplaceWaveTrack()

void ODWaveTrackTaskQueue::ReplaceWaveTrack	(	Track *	oldTrack,
		const std::shared_ptr< Track > &	newTrack
	)

replaces all instances of a WaveTrack within this task with another.

Definition at line 192 of file ODWaveTrackTaskQueue.cpp.

{
   if(oldTrack)
   {
      mTasksMutex.Lock();
      for(unsigned int i=0;i<mTasks.size();i++)
         mTasks[i]->ReplaceWaveTrack( oldTrack, newTrack );
      mTasksMutex.Unlock();
 
      mTracksMutex.Lock();
      for(unsigned int i=0;i<mTracks.size();i++)
         if ( mTracks[i].lock().get() == oldTrack )
            mTracks[i] = std::static_pointer_cast<WaveTrack>( newTrack );
      mTracksMutex.Unlock();
   }
}

References mTasks, mTasksMutex, mTracks, and mTracksMutex.

Member Data Documentation

mTasks

std::vector<std::unique_ptr<ODTask> > ODWaveTrackTaskQueue::mTasks

protected

the list of tasks associated with the tracks. This class owns these tasks.

Definition at line 107 of file ODWaveTrackTaskQueue.h.

Referenced by AddTask(), CanMergeWith(), DemandTrackUpdate(), GetFrontTask(), GetNumTasks(), GetTask(), IsEmpty(), IsFrontTaskComplete(), MakeWaveTrackIndependent(), MergeWaveTrack(), RemoveFrontTask(), ReplaceWaveTrack(), and ~ODWaveTrackTaskQueue().

mTasksMutex

ODLock ODWaveTrackTaskQueue::mTasksMutex

protected

Definition at line 108 of file ODWaveTrackTaskQueue.h.

Referenced by AddTask(), CanMergeWith(), GetFrontTask(), GetNumTasks(), GetTask(), IsEmpty(), IsFrontTaskComplete(), MakeWaveTrackIndependent(), MergeWaveTrack(), RemoveFrontTask(), and ReplaceWaveTrack().

mTipMsg

TranslatableString ODWaveTrackTaskQueue::mTipMsg

protected

Definition at line 99 of file ODWaveTrackTaskQueue.h.

Referenced by FillTipForWaveTrack().

mTracks

std::vector< std::weak_ptr< WaveTrack > > ODWaveTrackTaskQueue::mTracks

protected

the list of tracks associated with this queue.

Definition at line 103 of file ODWaveTrackTaskQueue.h.

Referenced by AddTask(), AddWaveTrack(), Compress(), ContainsWaveTrack(), GetNumWaveTracks(), IsEmpty(), MakeWaveTrackIndependent(), and ReplaceWaveTrack().

mTracksMutex

ODLock ODWaveTrackTaskQueue::mTracksMutex

protected

Definition at line 104 of file ODWaveTrackTaskQueue.h.

Referenced by AddTask(), AddWaveTrack(), Compress(), ContainsWaveTrack(), DemandTrackUpdate(), GetNumWaveTracks(), IsEmpty(), MakeWaveTrackIndependent(), and ReplaceWaveTrack().

---

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

• ODWaveTrackTaskQueue.h
• ODWaveTrackTaskQueue.cpp