IPlugAPIBase.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 <cstring>
#include <cstdint>
#include <memory>

#include "ptrlist.h"
#include "mutex.h"

#include "IPlugPlatform.h"
#include "IPlugPluginBase.h"
#include "IPlugConstants.h"
#include "IPlugStructs.h"
#include "IPlugUtilities.h"
#include "IPlugParameter.h"
#include "IPlugQueue.h"
#include "IPlugTimer.h"

BEGIN_IPLUG_NAMESPACE

struct Config;

class IPlugAPIBase : public IPluginBase
{

public:
  IPlugAPIBase(Config config, EAPI plugAPI);
  virtual ~IPlugAPIBase();
  
  IPlugAPIBase(const IPlugAPIBase&) = delete;
  IPlugAPIBase& operator=(const IPlugAPIBase&) = delete;
  
#pragma mark - Methods you can implement/override in your plug-in class - you do not call these methods

  virtual bool CompareState(const uint8_t* pIncomingState, int startPos) const;

  /* implement this and return true to trigger your custom about box, when someone clicks about in the menu of a standalone app or VST3 plugin */
  virtual bool OnHostRequestingAboutBox() { return false; }

  /* implement this and return true to trigger your custom help info, when someone clicks help in the menu of a standalone app or VST3 plugin */
  virtual bool OnHostRequestingProductHelp() { return false; }
  
  virtual void OnHostIdentified() {}
  
  virtual void OnHostRequestingImportantParameters(int count, WDL_TypedBuf<int>& results);
  
  virtual bool OnHostRequestingSupportedViewConfiguration(int width, int height) { return true; }
  
  virtual void OnHostSelectedViewConfiguration(int width, int height) {}

  virtual bool GetMidiNoteText(int noteNumber, char* str) const { *str = '\0'; return false; }

  virtual void* GetAAXViewInterface()
  {
#ifndef NO_IGRAPHICS
    return (void*) GetUI();
#else
    return nullptr;
#endif
  }

  virtual void OnIdle() {}
    
#pragma mark - Methods you can call - some of which have custom implementations in the API classes, some implemented in IPlugAPIBase.cpp

  void SetParameterValue(int paramIdx, double normalizedValue);
  
  virtual void GetTrackColor(int& r, int& g, int& b) { r = 0; g = 0; b = 0; }

  virtual void GetTrackName(WDL_String& str) {}

  virtual int GetTrackIndex() { return 0; }

  virtual void GetTrackNamespace(WDL_String& str) {}

  virtual int GetTrackNamespaceIndex() { return 0; }

  virtual void DirtyParametersFromUI() override;

#pragma mark - Methods called by the API class - you do not call these methods in your plug-in class

  virtual void SendParameterValueFromAPI(int paramIdx, double value, bool normalized);

  void SetHost(const char* host, int version);

  virtual void HostSpecificInit() {}

  //IEditorDelegate
  void BeginInformHostOfParamChangeFromUI(int paramIdx) override { BeginInformHostOfParamChange(paramIdx); }
  
  void EndInformHostOfParamChangeFromUI(int paramIdx) override { EndInformHostOfParamChange(paramIdx); }
  
  bool EditorResizeFromUI(int viewWidth, int viewHeight, bool needsPlatformResize) override;
  
  void SendParameterValueFromUI(int paramIdx, double normalisedValue) override
  {
    SetParameterValue(paramIdx, normalisedValue);
    IPluginBase::SendParameterValueFromUI(paramIdx, normalisedValue);
  }
  
  //These are handled in IPlugAPIBase for non DISTRIBUTED APIs
  void SendMidiMsgFromUI(const IMidiMsg& msg) override;
  
  void SendSysexMsgFromUI(const ISysEx& msg) override;
  
  void SendArbitraryMsgFromUI(int msgTag, int ctrlTag = kNoTag, int dataSize = 0, const void* pData = nullptr) override;
  
  void DeferMidiMsg(const IMidiMsg& msg) override { mMidiMsgsFromEditor.Push(msg); }
  
  void DeferSysexMsg(const ISysEx& msg) override
  {
    SysExData data(msg.mOffset, msg.mSize, msg.mData); // copies data
    mSysExDataFromEditor.Push(data);
  }

  void CreateTimer();
  
private:
  virtual bool EditorResize(int width, int height) { return false; }
  
  virtual void BeginInformHostOfParamChange(int paramIdx) {}

  virtual void EndInformHostOfParamChange(int paramIdx) {}

  virtual void InformHostOfParamChange(int paramIdx, double normalizedValue) {}
  
  //DISTRIBUTED ONLY (Currently only VST3)
  virtual void TransmitMidiMsgFromProcessor(const IMidiMsg& msg) {}
  
  virtual void TransmitSysExDataFromProcessor(const SysExData& data) {}

  void OnTimer(Timer& t);

  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;

private:
  WDL_String mParamDisplayStr;
  std::unique_ptr<Timer> mTimer;
  
  IPlugQueue<ParamTuple> mParamChangeFromProcessor {PARAM_TRANSFER_SIZE};
  IPlugQueue<IMidiMsg> mMidiMsgsFromEditor {MIDI_TRANSFER_SIZE}; // a queue of midi messages generated in the editor by clicking keyboard UI etc
  IPlugQueue<IMidiMsg> mMidiMsgsFromProcessor {MIDI_TRANSFER_SIZE}; // a queue of MIDI messages received (potentially on the high priority thread), by the processor to send to the editor
  IPlugQueue<SysExData> mSysExDataFromEditor {SYSEX_TRANSFER_SIZE}; // a queue of SYSEX data to send to the processor
  IPlugQueue<SysExData> mSysExDataFromProcessor {SYSEX_TRANSFER_SIZE}; // a queue of SYSEX data to send to the editor
  SysExData mSysexBuf;
};

END_IPLUG_NAMESPACE