StatefulEffectBase.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  StatefulEffectBase.h
 
  Dominic Mazzoni
  Vaughan Johnson
 
  Paul Licameli split from Effect.h
 
**********************************************************************/
 
#ifndef __AUDACITY_STATEFUL_EFFECT_BASE__
#define __AUDACITY_STATEFUL_EFFECT_BASE__
 
#include "EffectPlugin.h"
 
class sampleCount;
 
class EFFECTS_API StatefulEffectBase {
public:
   class EFFECTS_API Instance : public virtual EffectInstanceEx {
   public:
      explicit Instance(StatefulEffectBase &effect);
      ~Instance() override;
 
      bool Init() override;
 
      size_t GetBlockSize() const override;
      size_t SetBlockSize(size_t maxBlockSize) override;
   
      bool RealtimeInitialize(EffectSettings &settings, double sampleRate)
         override;
      bool RealtimeAddProcessor(EffectSettings &settings,
         EffectOutputs *pOutputs,
         unsigned numChannels, float sampleRate) override;
      bool RealtimeSuspend() override;
      bool RealtimeResume() override;
      bool RealtimeProcessStart(MessagePackage &package) override;
      size_t RealtimeProcess(size_t group, EffectSettings &settings,
         const float *const *inBuf, float *const *outBuf, size_t numSamples)
      override;
      bool RealtimeProcessEnd(EffectSettings &settings) noexcept override;
      bool RealtimeFinalize(EffectSettings &settings) noexcept override;
 
      unsigned GetAudioInCount() const override;
      unsigned GetAudioOutCount() const override;
 
      bool NeedsDither() const override;
      
      bool ProcessInitialize(EffectSettings &settings,
         double sampleRate, ChannelNames chanMap) override;
 
      bool ProcessFinalize() noexcept override;
 
   protected:
      StatefulEffectBase &mEffect;
      StatefulEffectBase &GetEffect() const { return mEffect; }
   };
 
   virtual bool Init();
 
   virtual bool Process(EffectInstance &instance, EffectSettings &settings) = 0;
 
   virtual bool RealtimeInitialize(EffectSettings &settings, double sampleRate);
 
   virtual bool RealtimeAddProcessor(EffectSettings &settings,
      EffectOutputs *pOutputs, unsigned numChannels, float sampleRate);
 
   virtual bool RealtimeSuspend();
 
   virtual bool RealtimeResume();
 
   using MessagePackage = EffectInstance::MessagePackage;
 
   virtual bool RealtimeProcessStart(MessagePackage &package);
 
   virtual size_t RealtimeProcess(size_t group, EffectSettings &settings,
      const float *const *inBuf, float *const *outBuf, size_t numSamples);
 
   virtual bool RealtimeProcessEnd(EffectSettings &settings) noexcept;
 
   virtual bool RealtimeFinalize(EffectSettings &settings) noexcept;
 
   virtual size_t SetBlockSize(size_t maxBlockSize);
 
   virtual size_t GetBlockSize() const;
 
   virtual unsigned GetAudioInCount() const;
 
   virtual unsigned GetAudioOutCount() const;
 
   virtual sampleCount GetLatency() const;
 
   virtual bool NeedsDither() const;
 
   virtual bool ProcessInitialize(EffectSettings &settings, double sampleRate,
      ChannelNames chanMap = nullptr);
 
   virtual bool ProcessFinalize() noexcept;
 
private:
 
   size_t mEffectBlockSize{ 0 };
};
 
#endif