IPlugPluginBase.h

Go to the documentation of this file.

/*
 ==============================================================================
 
 This file is part of the iPlug 2 library. Copyright (C) the iPlug 2 developers. 
 
 See LICENSE.txt for  more info.
 
 ==============================================================================
*/
 
#pragma once
 
#include "IPlugDelegate_select.h"
#include "IPlugParameter.h"
#include "IPlugStructs.h"
#include "IPlugLogger.h"
 
BEGIN_IPLUG_NAMESPACE
 
class IPluginBase : public EDITOR_DELEGATE_CLASS
{
public:
  IPluginBase(int nParams, int nPresets);
  virtual ~IPluginBase();
  
  IPluginBase(const IPluginBase&) = delete;
  IPluginBase& operator=(const IPluginBase&) = delete;
 
#pragma mark - Plug-in properties
  const char* GetPluginName() const { return mPluginName.Get(); }
  
  int GetPluginVersion(bool decimal) const;
  
  void GetPluginVersionStr(WDL_String& str) const;
  
  const char* GetMfrName() const { return mMfrName.Get(); }
  
  const char* GetProductName() const { return mProductName.Get(); }
  
  int GetUniqueID() const { return mUniqueID; }
  
  int GetMfrID() const { return mMfrID; }
  
  EHost GetHost() const { return mHost; }
  
  void GetHostStr(WDL_String& str) const { GetHostNameStr(GetHost(), str); }
  
  int GetHostVersion(bool decimal) const;
  
  void GetHostVersionStr(WDL_String& str) const;
  
  EAPI GetAPI() const { return mAPI; }
  
  const char* GetAPIStr() const;
  
  const char* GetArchStr() const;
  
  void GetBuildInfoStr(WDL_String& str, const char* date, const char* time) const;
  
  bool HasUI() const { return mHasUI; }
  
  bool GetHostResizeEnabled() const { return mHostResize; }
  
  /*** @return a CString with the bundle identifier (macOS/IOS only) */
  const char* GetBundleID() const { return mBundleID.Get(); }
 
  /*** @return a CString with the app group identifier (macOS/IOS only) */
  const char* GetAppGroupID() const { return mAppGroupID.Get(); }
 
#pragma mark - Parameters
  
  int NParamGroups() const { return mParamGroups.GetSize(); }
  
  int AddParamGroup(const char* name) { mParamGroups.Add(name); return NParamGroups(); }
  
  const char* GetParamGroupName(int idx) const { return mParamGroups.Get(idx); }
  
  virtual void InformHostOfParameterDetailsChange() {};
    
#pragma mark - State Serialization
  bool DoesStateChunks() const { return mStateChunks; }
  
  bool SerializeParams(IByteChunk& chunk) const;
  
  int UnserializeParams(const IByteChunk& chunk, int startPos);
    
  virtual bool SerializeState(IByteChunk& chunk) const { TRACE return SerializeParams(chunk); }
  
  virtual int UnserializeState(const IByteChunk& chunk, int startPos) { TRACE return UnserializeParams(chunk, startPos); }
  
  virtual bool SerializeVST3CtrlrState(IByteChunk& chunk) const { return true; }
  
  virtual int UnserializeVST3CtrlrState(const IByteChunk& chunk, int startPos) { return startPos; }
  
  int GetCurrentPresetIdx() const { return mCurrentPresetIdx; }
  
  void SetCurrentPresetIdx(int idx) { assert(idx > -1 && idx < NPresets()); mCurrentPresetIdx = idx; }
  
  virtual void InformHostOfPresetChange() {};
 
#pragma mark - Preset Manipulation
  
  IPreset* GetPreset(int idx) { return mPresets.Get(idx); }
  
  void ModifyCurrentPreset(const char* name = 0);
 
  int NPresets() const { return mPresets.GetSize(); }
 
  bool RestorePreset(int idx);
 
  bool RestorePreset(const char* name);
 
  const char* GetPresetName(int idx) const;
  
  void CopyPreset(IPreset* pSrc, int destIdx, bool copyname = false)
  {
    IPreset* pDst = mPresets.Get(destIdx);
 
    pDst->mChunk.Clear();
    pDst->mChunk.PutChunk(&pSrc->mChunk);
    pDst->mInitialized = true;
    strncpy(pDst->mName, pSrc->mName, MAX_PRESET_NAME_LEN - 1);
  }
  
  void MakeDefaultPreset(const char* name = 0, int nPresets = 1);
 
  void MakePreset(const char* name, ...);
 
  void MakePresetFromNamedParams(const char* name, int nParamsNamed, ...);
  
  void MakePresetFromChunk(const char* name, IByteChunk& chunk);
 
  void MakePresetFromBlob(const char* name, const char* blob, int sizeOfChunk);
  
  void PruneUninitializedPresets();
  
  virtual void OnPresetsModified() {}
 
  void EnsureDefaultPreset();
 
  bool SerializePresets(IByteChunk& chunk) const;
 
  int UnserializePresets(const IByteChunk& chunk, int startPos); 
  
  void DumpMakePresetSrc(const char* file) const;
 
  void DumpMakePresetFromNamedParamsSrc(const char* file, const char* paramEnumNames[]) const;
 
  void DumpPresetBlob(const char* file) const;
 
  bool SavePresetAsFXP(const char* file) const;
 
  bool SaveBankAsFXB(const char* file) const;
 
  bool LoadPresetFromFXP(const char* file);
 
  bool LoadBankFromFXB(const char* file);
 
  
#pragma mark - Parameter manipulation
    
  void InitParamRange(int startIdx, int endIdx, int countStart, const char* nameFmtStr, double defaultVal, double minVal, double maxVal, double step, const char* label = "", int flags = 0, const char* group = "", const IParam::Shape& shape = IParam::ShapeLinear(), IParam::EParamUnit unit = IParam::kUnitCustom, IParam::DisplayFunc displayFunc = nullptr);
  
  void CloneParamRange(int cloneStartIdx, int cloneEndIdx, int startIdx, const char* searchStr = "", const char* replaceStr = "", const char* newGroup = "");
  
  void ForParamInRange(int startIdx, int endIdx, std::function<void(int paramIdx, IParam& param)> func);
  
  void ForParamInGroup(const char* paramGroup, std::function<void(int paramIdx, IParam& param)> func);
  
  void CopyParamValues(int startIdx, int destIdx, int nParams);
  
  void CopyParamValues(const char* inGroup, const char* outGroup);
  
  void RandomiseParamValues();
  
  void RandomiseParamValues(int startIdx, int endIdx);
  
  void RandomiseParamValues(const char* paramGroup);
  
  void DefaultParamValues();
 
  void DefaultParamValues(int startIdx, int endIdx);
  
  void DefaultParamValues(const char* paramGroup);
  
  void PrintParamValues();
 
  friend class IPlugAPP;
  friend class IPlugAAX;
  friend class IPlugVST2;
  friend class IPlugVST3;
  friend class IPlugVST3Controller;
  friend class IPlugVST3Processor;
  friend class IPlugAU;
  friend class IPlugAUv3;
  friend class IPlugWEB;
  friend class IPlugWAM;
  friend class IPlugAPIBase;
  
private:
  int mCurrentPresetIdx = 0;
  bool mStateChunks = false;
  WDL_String mPluginName;
  WDL_String mProductName;
  WDL_String mMfrName;
  /* Plug-in unique four char ID as an int */
  int mUniqueID;
  /* Manufacturer unique four char ID as an int */
  int mMfrID;
  int mVersion;
  int mHostVersion = 0;
  EHost mHost = kHostUninit;
  EAPI mAPI;
  WDL_String mBundleID;
  WDL_String mAppGroupID;
  bool mHasUI = false;
  bool mHostResize = false;
  WDL_PtrList<const char> mParamGroups;
  WDL_PtrList<IPreset> mPresets;
 
#ifdef PARAMS_MUTEX
  friend class IPlugVST3ProcessorBase;
protected:
  WDL_Mutex mParams_mutex;
#endif  
};
 
END_IPLUG_NAMESPACE