ODTask.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  ODTask.h
 
  Created by Michael Chinen (mchinen)
  Audacity(R) is copyright (c) 1999-2008 Audacity Team.
  License: GPL v2.  See License.txt.
 
******************************************************************//*******************************************************************/
 
 
 
 
#ifndef __AUDACITY_ODTASK__
#define __AUDACITY_ODTASK__
 
#include "../BlockFile.h"
 
#include <vector>
#include <wx/event.h> // to declare custom event type
class AudacityProject;
class Track;
class WaveTrack;
 
 
wxDECLARE_EXPORTED_EVENT(AUDACITY_DLL_API,
                         EVT_ODTASK_COMPLETE, wxCommandEvent);
 
class ODTask /* not final */
{
 public:
   enum {
      eODNone     =  0x00000000,
      eODFLAC     =  0x00000001,
      eODMP3      =  0x00000002,
      eODFFMPEG   =  0x00000004,
      eODPCMSummary  = 0x00001000,
      eODOTHER    =  0x10000000,
   } ODTypeEnum;
   // Constructor / Destructor
 
   ODTask();
 
   virtual ~ODTask(){};
 
   //clones everything except information about the tracks.
   virtual std::unique_ptr<ODTask> Clone() const = 0;
 
   virtual unsigned int GetODType(){return eODNone;}
 
 
   void DoSome(float amountWork=0.0);
 
   void DoAll();
 
   virtual float PercentComplete();
 
   virtual bool UsesCustomWorkUntilPercentage(){return false;}
   virtual float ComputeNextWorkUntilPercentageComplete(){return 1.0;}
 
   virtual bool CanMergeWith(ODTask* otherTask){return strcmp(GetTaskName(),otherTask->GetTaskName())==0;}
 
   virtual void StopUsingWaveTrack(WaveTrack* track);
 
   virtual void ReplaceWaveTrack(Track *oldTrack,
      const std::shared_ptr< Track > &newTrack);
 
   void AddWaveTrack( const std::shared_ptr< WaveTrack > &track);
   virtual int GetNumWaveTracks();
   virtual std::shared_ptr< WaveTrack > GetWaveTrack(int i);
 
   virtual void DemandTrackUpdate(WaveTrack* track, double seconds);
 
   bool IsComplete();
 
   void TerminateAndBlock();
   virtual void Terminate(){}
 
   virtual const char* GetTaskName(){return "ODTask";}
 
   virtual sampleCount GetDemandSample() const;
 
   virtual void SetDemandSample(sampleCount sample);
 
   virtual void RecalculatePercentComplete();
 
   int GetTaskNumber(){return mTaskNumber;}
 
   void SetNeedsODUpdate();
   bool GetNeedsODUpdate();
   void ResetNeedsODUpdate();
 
   virtual TranslatableString GetTip()=0;
 
   virtual bool IsTaskAssociatedWithProject(AudacityProject* proj);
 
   bool IsRunning();
 
 
 protected:
 
   virtual void CalculatePercentComplete() = 0;
 
   virtual void DoSomeInternal() = 0;
 
   virtual void Update(){}
 
   virtual void ODUpdate();
 
   void SetIsRunning(bool value);
 
 
 
   int   mTaskNumber;
   volatile float mPercentComplete;
   ODLock mPercentCompleteMutex;
   volatile bool  mDoingTask;
   volatile bool  mTaskStarted;
   volatile bool mTerminate;
   ODLock mTerminateMutex;
   //for a function not a member var.
   ODLock mBlockUntilTerminateMutex;
 
   std::vector< std::weak_ptr< WaveTrack > > mWaveTracks;
   ODLock     mWaveTrackMutex;
 
   sampleCount mDemandSample;
   mutable ODLock      mDemandSampleMutex;
 
   volatile bool mIsRunning;
   ODLock mIsRunningMutex;
 
 
   private:
 
   volatile bool mNeedsODUpdate;
   ODLock mNeedsODUpdateMutex;
 
 
 
};
 
#endif