VST3Wrapper.h

Go to the documentation of this file.

#pragma once
 
#include <pluginterfaces/base/smartpointer.h>
#include <pluginterfaces/vst/ivstaudioprocessor.h>
#include <pluginterfaces/vst/ivstparameterchanges.h>
#include <pluginterfaces/vst/ivstprocesscontext.h>
#include <public.sdk/source/vst/hosting/module.h>
 
#include "EffectInterface.h"
 
class VST3Wrapper;
 
namespace Steinberg
{
   class IPlugFrame;
   class IPlugView;
}
 
namespace Steinberg
{
   namespace Vst
   {
      class IComponentHandler;
      class IConnectionPoint;
      class IEditController;
      class IParameterChanges;
   }
}
 
class SingleInputParameterValue final : public Steinberg::Vst::IParamValueQueue
{
   Steinberg::Vst::ParamID mParameterId{};
   Steinberg::Vst::ParamValue mValue;
public:
 
   SingleInputParameterValue() { FUNKNOWN_CTOR }
   ~SingleInputParameterValue() { FUNKNOWN_DTOR }
 
   void Set(Steinberg::Vst::ParamID id, const Steinberg::Vst::ParamValue value);
 
   Steinberg::tresult PLUGIN_API addPoint(Steinberg::int32 sampleOffset, Steinberg::Vst::ParamValue value,
      Steinberg::int32& index) override;
 
   Steinberg::Vst::ParamID PLUGIN_API getParameterId() override;
 
   Steinberg::tresult PLUGIN_API getPoint(Steinberg::int32 index, Steinberg::int32& sampleOffset,
      Steinberg::Vst::ParamValue& value) override;
 
   Steinberg::int32 PLUGIN_API getPointCount() override;
 
   DECLARE_FUNKNOWN_METHODS
};
 
class VST3_API VST3Wrapper
{
   EffectSettings mDefaultSettings;
   VST3::Hosting::Module& mModule;
   const VST3::Hosting::ClassInfo& mEffectClassInfo;
public:
 
   struct FactoryPresetDesc
   {
      wxString id;
      wxString displayName;
   };
 
   Steinberg::IPtr<Steinberg::Vst::IAudioProcessor> mAudioProcessor;
   Steinberg::Vst::ProcessSetup mSetup;
   Steinberg::IPtr<Steinberg::Vst::IComponent>      mEffectComponent;
   Steinberg::IPtr<Steinberg::Vst::IEditController> mEditController;
   Steinberg::IPtr<Steinberg::Vst::IConnectionPoint> mComponentConnectionProxy;
   Steinberg::IPtr<Steinberg::Vst::IConnectionPoint> mControllerConnectionProxy;
   Steinberg::IPtr<Steinberg::Vst::IComponentHandler> mComponentHandler;
 
   VST3Wrapper(VST3::Hosting::Module& module, const VST3::Hosting::ClassInfo& effectClassInfo);
   ~VST3Wrapper();
 
   VST3Wrapper(const VST3Wrapper&) = delete;
   VST3Wrapper(VST3Wrapper&&) = delete;
   VST3Wrapper& operator=(const VST3Wrapper&) = delete;
   VST3Wrapper& operator=(VST3Wrapper&&) = delete;
 
   void InitializeComponents();
 
   VST3::Hosting::Module& GetModule() const { return mModule; }
   const VST3::Hosting::ClassInfo& GetEffectClassInfo() const;
 
   bool IsActive() const noexcept;
 
   void FetchSettings(EffectSettings&);
   void StoreSettings(EffectSettings&) const;
 
   void LoadPreset(const wxString& presetId);
   void SavePresetToFile(const wxString& filepath) const;
 
   bool Initialize(EffectSettings& settings,
      Steinberg::Vst::SampleRate sampleRate,
      Steinberg::int32 processMode,
      Steinberg::int32 maxSamplesPerBlock);
   void Finalize(EffectSettings* settings);
 
   void ProcessBlockStart(const EffectSettings& settings);
 
   //Used to send EffectSettings changes to the IAudioProcessor, while effect is inactive(!)
 
   void FlushParameters(EffectSettings& settings, bool* hasChanges = nullptr);
 
   //Intialize first, before calling to Process. It's safe to it use from another thread
   size_t Process(const float* const* inBlock, float* const* outBlock, size_t blockLen);
   
   void SuspendProcessing();
   void ResumeProcessing();
 
   void BeginParameterEdit(EffectSettingsAccess& access);
   void EndParameterEdit();
 
   std::vector<FactoryPresetDesc> FindFactoryPresets() const;
 
   Steinberg::int32 GetLatencySamples() const;
 
   static EffectSettings MakeSettings();
 
   static void LoadSettings(const CommandParameters& parms, EffectSettings& settings);
   static void SaveSettings(const EffectSettings& settings, CommandParameters& parms);
   static OptionalMessage LoadUserPreset(
      const EffectDefinitionInterface& effect, const RegistryPath& name, EffectSettings& settings);
   static void SaveUserPreset(const EffectDefinitionInterface& effect, const RegistryPath& name, const EffectSettings& settings);
 
   static void CopySettingsContents(const EffectSettings& src, EffectSettings& dst);
 
   std::function<void (Steinberg::Vst::ParamID, Steinberg::Vst::ParamValue)> ParamChangedHandler;
 
private:
 
   bool LoadPresetFromStream(Steinberg::IBStream* fileStream);
   bool SavePresetToStream(Steinberg::IBStream* fileStream) const;
 
   //Reads runtime data changes to apply them during next processing pass
   void ConsumeChanges(const EffectSettings& settings);
 
   bool mActive {false};
 
   std::vector<std::pair<Steinberg::Vst::ParamID, Steinberg::Vst::ParamValue>> mParameters;
   //A preallocated array of Steinberg::Vst::IParameterValueQueue
   //used as a view to an actual parameter changes that reside
   //in VST3EffectSettings structure, dynamically assigned during
   //processing
   std::unique_ptr<SingleInputParameterValue[]> mParameterQueues;
 
   Steinberg::Vst::ProcessContext mProcessContext { };
};