EffectOutputTracks.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  EffectOutputTracks.h
 
  Paul Licameli split from EffectBase.h
 
**********************************************************************/
#ifndef __AUDACITY_EFFECT_OUTPUT_TRACKS__
#define __AUDACITY_EFFECT_OUTPUT_TRACKS__
 
class Track;
class TrackList;
 
#include "EffectInterface.h"
 
#include <memory>
#include <optional>
#include <vector>
 
/*
 Do the processing on temporaries, and then the originals are replaced only on
 Commit().
 If not all sync-locked selected, then only selected wave tracks.
*/
class EFFECTS_API EffectOutputTracks
{
public:
   // A global counter of all the successful Effect invocations.
   static int nEffectsDone;
   static void IncEffectCounter() { ++nEffectsDone; }
 
   using TimeInterval = std::pair<double, double>;
   EffectOutputTracks(
      TrackList& tracks, EffectType effectType,
      std::optional<TimeInterval> effectTimeInterval,
      bool allSyncLockSelected = false, bool stretchSyncLocked = false);
   EffectOutputTracks(const EffectOutputTracks&) = delete;
 
   ~EffectOutputTracks();
 
 
   Track *AddToOutputTracks(const std::shared_ptr<Track> &t);
 
 
   const Track* GetMatchingInput(const Track& outTrack) const;
 
   /*
    @pre `Commit()` was not previously called
    */
   void Commit();
 
   /*
    @pre `Commit()` was not previously called
    */
   TrackList &Get() { return *mOutputTracks; }
 
private:
   TrackList &mTracks;
   const EffectType mEffectType;
   std::vector<Track*> mIMap;
   std::vector<Track*> mOMap;
   std::shared_ptr<TrackList> mOutputTracks;
};
 
#endif