StatefulPerTrackEffect.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  StatefulPerTrackEffect.h
 
  Dominic Mazzoni
  Vaughan Johnson
 
  Paul Licameli split from PerTrackEffect.h
 
**********************************************************************/
 
#ifndef __AUDACITY_STATEFUL_PER_TRACK_EFFECT__
#define __AUDACITY_STATEFUL_PER_TRACK_EFFECT__
 
#include "PerTrackEffect.h" // to inherit
#include "StatefulEffectBase.h" // to inherit
#include "StatefulEffectUIServices.h" // to inherit
 
class StatefulPerTrackEffect
   : public StatefulEffectBase
   , public PerTrackEffect
   , public StatefulEffectUIServices
{
public:
 
   class AUDACITY_DLL_API Instance
      : public StatefulEffectBase::Instance
      , public PerTrackEffect::Instance
   {
   public:
      explicit Instance(StatefulPerTrackEffect &effect)
         : StatefulEffectBase::Instance{ effect }
         , PerTrackEffect::Instance{ effect }
      {}
      ~Instance() override;
      bool ProcessInitialize(EffectSettings &settings, double sampleRate,
         ChannelNames chanMap) override;
      bool ProcessFinalize() noexcept override;
      size_t ProcessBlock(EffectSettings &settings,
         const float *const *inBlock, float *const *outBlock, size_t blockLen)
      override;
 
   protected:
      StatefulPerTrackEffect &GetEffect() const
      {
         // Tolerate const_cast in this class while it sun-sets
         return static_cast<StatefulPerTrackEffect &>(
            const_cast<PerTrackEffect &>(mProcessor));
      }
   };
 
   ~StatefulPerTrackEffect() override;
 
   std::shared_ptr<EffectInstance> MakeInstance() const override;
 
   size_t SetBlockSize(size_t maxBlockSize) override;
   size_t GetBlockSize() const override;
 
   bool ProcessInitialize(EffectSettings &settings, double sampleRate,
      ChannelNames chanMap = nullptr) override;
 
   bool ProcessFinalize() noexcept override;
 
   virtual size_t ProcessBlock(EffectSettings &settings,
      const float *const *inBlock, float *const *outBlock, size_t blockLen) = 0;
 
private:
   bool Process(EffectInstance &instance, EffectSettings &settings) final;
 
   size_t mBlockSize{};
};
 
#endif