PerTrackEffect.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  PerTrackEffect.h
 
  Dominic Mazzoni
  Vaughan Johnson
 
  Paul Licameli split from Effect.h
 
**********************************************************************/
 
#ifndef __AUDACITY_PER_TRACK_EFFECT__
#define __AUDACITY_PER_TRACK_EFFECT__
 
#include "Effect.h" // to inherit
#include "MemoryX.h"
 
using FloatBuffers = ArraysOf<float>;
 
 
class PerTrackEffect
   : public Effect
{
public:
   ~PerTrackEffect() override;
 
   class AUDACITY_DLL_API Instance : public virtual EffectInstance {
   public:
      explicit Instance(const PerTrackEffect &processor)
         : mProcessor{ processor }
      {}
      ~Instance() override;
   
      bool Process(EffectSettings &settings) final;
 
      virtual bool ProcessInitialize(EffectSettings &settings,
         sampleCount totalLen, ChannelNames chanMap);
 
      virtual bool ProcessFinalize() /* noexcept */ ;
 
      virtual size_t ProcessBlock(EffectSettings &settings,
         const float *const *inBlock, float *const *outBlock, size_t blockLen)
      = 0;
 
      virtual sampleCount GetLatency(const EffectSettings &settings);
 
   protected:
      const PerTrackEffect &mProcessor;
   };
 
protected:
   // These were overridables but the generality wasn't used yet
   /* virtual */ bool DoPass1() const;
   /* virtual */ bool DoPass2() const;
 
   // non-virtual
   bool Process(EffectInstance &instance, EffectSettings &settings) const;
 
   sampleCount    mSampleCnt{};
 
private:
   bool ProcessPass(Instance &instance, EffectSettings &settings);
   bool ProcessTrack(Instance &instance, EffectSettings &settings,
      int count,
      ChannelNames map,
      WaveTrack *left,
      WaveTrack *right,
      sampleCount start,
      sampleCount len,
      FloatBuffers &inBuffer,
      FloatBuffers &outBuffer,
      ArrayOf< float * > &inBufPos,
      ArrayOf< float *> &outBufPos, size_t bufferSize, size_t blockSize,
      unsigned mNumChannels) const;
};
#endif