ASPiK SDK
pluginbase.h
1 // -----------------------------------------------------------------------------
2 // ASPiK Plugin Kernel File: pluginbase.h
3 //
12 // -----------------------------------------------------------------------------
192 #ifndef __PluginBase__
193 #define __PluginBase__
194 
195 #include "pluginparameter.h"
196 
197 #include <map>
198 
222 {
223 public:
224  PluginBase();
225  virtual ~PluginBase();
226 
227  // --- PURE VIRTUAL FUNCTIONS ---------------------------------------------------------------------------------------------------- //
229  virtual bool processAudioFrame(ProcessFrameInfo& processFrameInfo) = 0;
230 
232  virtual bool updatePluginParameter(int32_t controlID, double controlValue, ParameterUpdateInfo& paramInfo) = 0;
233 
235  virtual bool updatePluginParameterNormalized(int32_t controlID, double normalizedValue, ParameterUpdateInfo& paramInfo) = 0;
236 
238  virtual bool postUpdatePluginParameter(int32_t controlID, double controlValue, ParameterUpdateInfo& paramInfo) = 0;
239 
241  virtual bool preProcessAudioBuffers(ProcessBufferInfo& processInfo) = 0;
242 
244  virtual bool postProcessAudioBuffers(ProcessBufferInfo& processInfo) = 0;
245  // ----------------------------------------------------------------------------------------------------------------------------- //
246 
248  virtual bool reset(ResetInfo& resetInfo);
249 
251  virtual bool initialize(PluginInfo& _pluginInfo);
252 
254  void syncInBoundVariables();
255 
257  virtual bool processAudioBuffers(ProcessBufferInfo& processInfo);
258 
261 
263  virtual bool guiParameterChanged(int32_t controlID, double actualValue) { return true; }
264 
266  virtual bool processMessage(MessageInfo& messageInfo) { return true; }
267 
269  virtual bool processMIDIEvent(midiEvent& event) { return true; }
270 
273 
275  virtual bool setVectorJoystickParameters(const VectorJoystickData& vectorJoysickData) { return true; }
276 
278  int32_t addPluginParameter(PluginParameter* piParam, double sampleRate = 44100);
279 
281  void setParamAuxAttribute(uint32_t controlID, const AuxParameterAttribute& auxAttribute);
282 
284  size_t getPluginParameterCount(){ return pluginParameters.size(); }
285 
293  PluginParameter* getPluginParameterByIndex(int32_t index) { return pluginParameters[index]; }
294 
302  PluginParameter* getPluginParameterByControlID(int32_t controlID) { return pluginParameterMap[controlID]; }
303 
305  PluginParameter* getNextParameterOfType(int32_t& startIndex, controlVariableType controlType);
306 
308  double getPIParamValueDouble(int32_t controlID);
309 
311  float getPIParamValueFloat(int32_t controlID);
312 
314  int getPIParamValueInt(int32_t controlID);
315 
317  uint32_t getPIParamValueUInt(int32_t controlID);
318 
320  bool hasProToolsGRMeters();
321 
323  double getProToolsGRValue();
324 
326  uint32_t addSupportedIOCombination(ChannelIOConfig ioConfig);
327 
330 
336 
339 
342 
347  int32_t getChannelInputFormat(uint32_t ioConfigIndex) {return pluginDescriptor.supportedIOCombinations[ioConfigIndex].inputChannelFormat;}
348 
353  int32_t getChannelOutputFormat(uint32_t ioConfigIndex) {return pluginDescriptor.supportedIOCombinations[ioConfigIndex].outputChannelFormat;}
354 
356  uint32_t getInputChannelCount(uint32_t ioConfigIndex);
357 
359  uint32_t getOutputChannelCount(uint32_t ioConfigIndex);
360 
369 
371  void setPIParamValue(uint32_t _controlID, double _controlValue);
372 
374  double setPIParamValueNormalized(uint32_t _controlID, double _normalizedValue, bool applyTaper = true);
375 
377  bool updatePIParamBoundValue(uint32_t _controlID);
378 
380  void clearUpdateGUIParameters(std::vector<GUIParameter*>& guiParameters);
381 
383  std::vector<PluginParameter*>* makePluginParameterVectorCopy(bool disableSmoothing = true);
384 
386  bool initPresetParameters(std::vector<PresetParameter>& presetParameters, bool disableSmoothing = true);
387 
389  bool setPresetParameter(std::vector<PresetParameter>& presetParameters, uint32_t _controlID, double _controlValue);
390 
396  void setPluginHostConnector(IPluginHostConnector* _pluginHostConnector){pluginHostConnector = _pluginHostConnector;}
397 
403  size_t getPresetCount(){return presets.size();}
404 
406  const char* getPresetName(uint32_t index);
407 
409  size_t addPreset(PresetInfo* preset);
410 
412  void removePreset(uint32_t index);
413 
415  void removeAllPresets();
416 
418  PresetInfo* getPreset(uint32_t index);
419 
422 
424  bool compareSelectedString(int32_t controlID, const char* compareString);
425 
432 
439 
446 
453 
460 
467 
473  const char* getPluginName() { return pluginDescriptor.pluginName.c_str(); }
474 
480  const char* getShortPluginName() { return pluginDescriptor.shortPluginName.c_str(); }
481 
487  const char* getVendorName() { return pluginDescriptor.vendorName.c_str(); }
488 
495 
502 
509 
516 
522  const uint32_t getAAXProductID() { return apiSpecificInfo.aaxProductID; }
523 
529  const char* getAAXBundleID() { return apiSpecificInfo.aaxBundleID.c_str(); }
530 
536  const char* getAAXEffectID() { return apiSpecificInfo.aaxEffectID.c_str(); }
537 
544 
550  const char* getVST3_FUID() { return apiSpecificInfo.vst3FUID.c_str(); }
551 
558 
565 
571  const char* getVST3BundleID() { return apiSpecificInfo.vst3BundleID.c_str(); }
572 
578  const char* getAUBundleID() { return apiSpecificInfo.auBundleID.c_str(); }
579 
585  const char* getAUBundleName() { return apiSpecificInfo.auBundleName.c_str(); }
586 
587 protected:
592 
593  // --- arrays for frame processing
594  float inputFrame[MAX_CHANNEL_COUNT];
595  float outputFrame[MAX_CHANNEL_COUNT];
596  float auxInputFrame[MAX_CHANNEL_COUNT];
597  float auxOutputFrame[MAX_CHANNEL_COUNT];
598 
599  // --- ultra-fast access for real-time audio processing
601  uint32_t numPluginParameters = 0;
606 
607  // --- vectorized version of pluginParameterMap for fast iteration when key not needed
608  std::vector<PluginParameter*> pluginParameters;
609 
610  // --- map<controlID , PluginParameter*>
611  typedef std::map<uint32_t, PluginParameter*> pluginParameterControlIDMap;
613 
614  // --- plugin core -> host (wrap) connector
616 
617  // --- PRESETS
618  std::vector<PresetInfo*> presets;
619 };
620 
621 #endif /* defined(__PluginBase__) */
uint32_t aaxManufacturerID
aax manu ID
Definition: pluginstructures.h:244
uint32_t numSupportedIOCombinations
should support at least main 3 combos
Definition: pluginstructures.h:1221
std::string shortPluginName
name (up to 15 chars)
Definition: pluginstructures.h:1209
Information package about the current DAW session. Sample rate and bit-depth of audio.
Definition: pluginstructures.h:1150
int32_t getChannelInputFormat(uint32_t ioConfigIndex)
get input cj
Definition: pluginbase.h:347
std::string auBundleName
AU bundle name /* MacOS only: this MUST match the bundle name which is the same as the project name *...
Definition: pluginstructures.h:261
Information that includes the message code as well as the message data.
Definition: pluginstructures.h:705
uint32_t addSupportedIOCombination(ChannelIOConfig ioConfig)
add a new I/O configuration pair
Definition: pluginbase.cpp:477
PluginInfo pluginInfo
info about the DLL (component) itself, includes path to DLL
Definition: pluginbase.h:591
PluginParameter * getPluginParameterByControlID(int32_t controlID)
get a parameter by control ID - uses map (slowest)
Definition: pluginbase.h:302
std::string vst3BundleID
VST bundle ID /* MacOS only: this MUST match the bundle identifier in your info.plist file */...
Definition: pluginstructures.h:257
bool hasCustomGUI
default on
Definition: pluginstructures.h:1216
float inputFrame[MAX_CHANNEL_COUNT]
input array for frame processing
Definition: pluginbase.h:594
virtual bool preProcessAudioBuffers(ProcessBufferInfo &processInfo)=0
uint32_t getPluginType()
Description query: plugin type.
Definition: pluginbase.h:494
PluginParameter * getNextParameterOfType(int32_t &startIndex, controlVariableType controlType)
get a parameter by type
Definition: pluginbase.cpp:349
void clearUpdateGUIParameters(std::vector< GUIParameter *> &guiParameters)
delete GUI update structures in a list
Definition: pluginbase.cpp:644
int32_t addPluginParameter(PluginParameter *piParam, double sampleRate=44100)
adds a new plugin parameter to the parameter map
Definition: pluginbase.cpp:313
virtual bool updatePluginParameterNormalized(int32_t controlID, double normalizedValue, ParameterUpdateInfo &paramInfo)=0
uint32_t pluginTypeCode
FX or synth.
Definition: pluginstructures.h:1211
void setPluginHostConnector(IPluginHostConnector *_pluginHostConnector)
store the plugin host interface pointer: this pointer will never go out of scope or be invalid once s...
Definition: pluginbase.h:396
virtual bool reset(ResetInfo &resetInfo)
initialize object for a new run of audio; called just before audio streams
Definition: pluginbase.cpp:70
bool wantsMIDI
want MIDI (don&#39;t need to actually use it)
Definition: pluginstructures.h:1215
Information package that arrives with each new audio frame; called internally from the buffer process...
Definition: pluginstructures.h:1110
virtual bool setVectorJoystickParameters(const VectorJoystickData &vectorJoysickData)
Definition: pluginbase.h:275
int fourCharCode
the mystic and ancient 4-character code (oooh)
Definition: pluginstructures.h:251
uint32_t numSmoothablePluginParameters
number of smoothable parameters only
Definition: pluginbase.h:603
uint32_t vst3SampleAccurateGranularity
sample accuracy granularity (update interval)
Definition: pluginstructures.h:256
void removeAllPresets()
remove all presets - NOTE: does not delete objects
Definition: pluginbase.cpp:773
pluginParameterControlIDMap pluginParameterMap
member map of parameter list
Definition: pluginbase.h:612
The PluginBase object is the base class for the Plugin Core object.
Definition: pluginbase.h:221
float auxInputFrame[MAX_CHANNEL_COUNT]
aux input array for frame processing
Definition: pluginbase.h:596
virtual bool updatePluginParameter(int32_t controlID, double controlValue, ParameterUpdateInfo &paramInfo)=0
bool enableVST3SampleAccurateAutomation
flag for sample accurate automation
Definition: pluginstructures.h:255
double getLatencyInSamples()
Description query: latency.
Definition: pluginbase.h:452
uint32_t getAAXPluginCategory()
Description query: AAX Category.
Definition: pluginbase.h:543
double getTailTimeInMSec()
Description query: tail time.
Definition: pluginbase.h:459
std::vector< PresetInfo * > presets
preset list
Definition: pluginbase.h:618
uint32_t numOutboundPluginParameters
total number of outbound (meter) parameters
Definition: pluginbase.h:605
std::string pluginName
name (up to 31 chars)
Definition: pluginstructures.h:1208
const char * getShortPluginName()
Description query: short name (AAX)
Definition: pluginbase.h:480
uint32_t numPluginParameters
total number of parameters
Definition: pluginbase.h:601
uint32_t getDefaultChannelIOConfigForChannelCount(uint32_t channelCount)
get the configuration (e.g. kCFStereo) for a given channel count; mainly for AU that does not discrim...
Definition: pluginbase.h:368
void setParamAuxAttribute(uint32_t controlID, const AuxParameterAttribute &auxAttribute)
adds an auxilliary attribute to the plugin parameter; you can have as many auxilliary attributes as y...
Definition: pluginbase.cpp:333
bool hasCustomGUI()
Description query: has GUI.
Definition: pluginbase.h:445
std::string vendorName
manufacturer name
Definition: pluginstructures.h:1210
size_t getPluginParameterCount()
Definition: pluginbase.h:284
void doSampleAccurateParameterUpdates()
combines parameter smoothing and VST3 sample accurate updates
Definition: pluginbase.cpp:246
virtual bool processMessage(MessageInfo &messageInfo)
Definition: pluginbase.h:266
uint32_t getInputChannelCount(uint32_t ioConfigIndex)
get the number of input channels for a configuration at a given index
Definition: pluginbase.cpp:567
Information about a paraemeter being updated. Used when bound variables are updated. Multiple advanced uses.
Definition: pluginstructures.h:834
PresetInfo * getPreset(uint32_t index)
get a preset
Definition: pluginbase.cpp:791
Sample rate and bit-depth information that is passed during the reset( ) function.
Definition: pluginstructures.h:180
double sampleRate
sample rate
Definition: pluginstructures.h:1171
int getFourCharCode()
Description query: 4-char code.
Definition: pluginbase.h:508
float getPIParamValueFloat(int32_t controlID)
value-as-float
Definition: pluginbase.cpp:390
bool hasSupportedOutputChannelFormat(uint32_t channelFormat)
check to see if plugin support a given output channel format
Definition: pluginbase.cpp:550
virtual bool processAudioBuffers(ProcessBufferInfo &processInfo)
THE buffer processing function.
Definition: pluginbase.cpp:134
uint32_t latencyInSamples
latency
Definition: pluginstructures.h:1217
std::vector< PluginParameter * > pluginParameters
vector version of parameter list
Definition: pluginbase.h:608
virtual bool postProcessAudioBuffers(ProcessBufferInfo &processInfo)=0
uint32_t inputChannelFormat
input format for this I/O pair
Definition: pluginstructures.h:545
Information package that arrives with each new audio buffer process cycle. Contains everything needed...
Definition: pluginstructures.h:1056
virtual bool processMIDIEvent(midiEvent &event)
Definition: pluginbase.h:269
AudioProcDescriptor audioProcDescriptor
current audio processing description
Definition: pluginbase.h:590
void syncInBoundVariables()
initialize object for a new run of audio; called just before audio streams
Definition: pluginbase.cpp:104
controlVariableType
Use this strongly typed enum to easily set the control&#39;s behavior; this tells the PluginParameter obj...
Definition: guiconstants.h:288
size_t getPresetCount()
get number of stored presets
Definition: pluginbase.h:403
virtual bool guiParameterChanged(int32_t controlID, double actualValue)
Definition: pluginbase.h:263
uint32_t getVST3SampleAccuracyGranularity()
Description query: VST Sample Accurate Automation granularity.
Definition: pluginbase.h:564
bool hasSupportedInputChannelFormat(uint32_t channelFormat)
check to see if plugin support a given input channel format
Definition: pluginbase.cpp:533
Incoming data from a vector joystick.
Definition: pluginstructures.h:276
bool wantsVST3SampleAccurateAutomation()
Description query: VST Sample Accurate Automation.
Definition: pluginbase.h:557
const uint32_t getAAXProductID()
Description query: AAX Prod ID.
Definition: pluginbase.h:522
Information package about the plugin itself, consisting mainly of simple strings and ID values...
Definition: pluginstructures.h:1187
std::map< uint32_t, PluginParameter * > pluginParameterControlIDMap
map version of parameter list
Definition: pluginbase.h:611
int getPIParamValueInt(int32_t controlID)
value-as-int
Definition: pluginbase.cpp:406
Definition: pluginstructures.h:406
bool wantsMIDI()
Description query: MIDI.
Definition: pluginbase.h:438
std::vector< PluginParameter * > * makePluginParameterVectorCopy(bool disableSmoothing=true)
copies parameters into a new list; used to initialize the GUI - note that this makes true...
Definition: pluginbase.cpp:659
uint32_t getOutputChannelCount(uint32_t ioConfigIndex)
get the number of output channels for a configuration at a given index
Definition: pluginbase.cpp:582
bool updateOutBoundVariables()
copy newly updated metering variables into GUI parameters for display
Definition: pluginbase.cpp:216
PluginParameter ** outboundPluginParameters
old-fashioned C-arrays of pointers for outbound (meter) parameters
Definition: pluginbase.h:604
bool hasSidechain
sidechain flag
Definition: pluginstructures.h:1213
APISpecificInfo apiSpecificInfo
description strings, API specific
Definition: pluginbase.h:589
const char * getAUBundleName()
Description query: AU Bundle Name.
Definition: pluginbase.h:585
bool initPresetParameters(std::vector< PresetParameter > &presetParameters, bool disableSmoothing=true)
creates the preset parameter ID/Value pair PresetParameter objects and adds them to supplied list ...
Definition: pluginbase.cpp:685
void initPluginParameterArray()
called at the end of the initialization phase, this function creates the various non map-versions of ...
Definition: pluginbase.cpp:803
virtual ~PluginBase()
PluginBase destructor.
Definition: pluginbase.cpp:41
Structure of a pair of channel format enumerators that set an input/output channel I/O capability...
Definition: pluginstructures.h:523
const uint32_t getAAXManufacturerID()
Description query: AAX Man ID.
Definition: pluginbase.h:515
void setPIParamValue(uint32_t _controlID, double _controlValue)
set a parameter&#39;s value with the actual value (as double)
Definition: pluginbase.cpp:597
PluginDescriptor pluginDescriptor
description strings
Definition: pluginbase.h:588
Identifiers, GUIDs and other strings and number id values, API specific.
Definition: pluginstructures.h:206
uint32_t getPIParamValueUInt(int32_t controlID)
value-as-uint
Definition: pluginbase.cpp:421
uint32_t aaxProductID
aax ID
Definition: pluginstructures.h:245
double tailTimeInMSec
tail time
Definition: pluginstructures.h:1218
PluginParameter ** smoothablePluginParameters
old-fashioned C-arrays of pointers for smoothable parameters
Definition: pluginbase.h:602
uint32_t addSupportedAuxIOCombination(ChannelIOConfig ioConfig)
add a new I/O configuration pair
Definition: pluginbase.cpp:505
double getPIParamValueDouble(int32_t controlID)
value-as-double
Definition: pluginbase.cpp:375
std::string vst3FUID
VST GUID.
Definition: pluginstructures.h:254
Information about auxilliary parameter details - purely customizeable. This uses the attributeValue u...
Definition: pluginstructures.h:922
virtual bool processAudioFrame(ProcessFrameInfo &processFrameInfo)=0
channelFormat
Use this enum to identify plugin channel formats. Steinberg calls these "speaker arrangements".
Definition: pluginstructures.h:114
const char * getVST3BundleID()
Description query: VST3 Bundle ID.
Definition: pluginbase.h:571
size_t addPreset(PresetInfo *preset)
add a new preset
Definition: pluginbase.cpp:745
const char * getPresetName(uint32_t index)
gets name as a const char* for connecting with all APIs at some level
Definition: pluginbase.cpp:729
double getSampleRate()
Description query: sample rate.
Definition: pluginbase.h:501
const char * getAAXBundleID()
Description query: AAX Bundle ID.
Definition: pluginbase.h:529
bool hasSidechain()
Description query: sidechain.
Definition: pluginbase.h:431
The PluginParameter object stores all of the data needed for any type of plugin parameter. It is a large object, but it is not complex as it really just stores LOTS of information about plugin parameters.
Definition: pluginparameter.h:51
const char * getVST3_FUID()
Description query: VST3 FUID.
Definition: pluginbase.h:550
const char * getAUBundleID()
Description query: AU Bundle ID.
Definition: pluginbase.h:578
std::string aaxBundleID
AAX bundle /* MacOS only: this MUST match the bundle identifier in your info.plist file */...
Definition: pluginstructures.h:247
std::string aaxEffectID
aax Effect ID
Definition: pluginstructures.h:246
bool setPresetParameter(std::vector< PresetParameter > &presetParameters, uint32_t _controlID, double _controlValue)
set a new value for a preset
Definition: pluginbase.cpp:707
virtual bool postUpdatePluginParameter(int32_t controlID, double controlValue, ParameterUpdateInfo &paramInfo)=0
Structure that is used during the base class initilize( ) funciton call, after object instantiation i...
Definition: pluginstructures.h:753
uint32_t outputChannelFormat
output format for this I/O pair
Definition: pluginstructures.h:546
bool updatePIParamBoundValue(uint32_t _controlID)
update a bound-variable with a parameter&#39;s control value; this is the essence of the variable binding...
Definition: pluginbase.cpp:629
bool wantsInfiniteTailVST3()
Description query: infinite tail (VST3 only)
Definition: pluginbase.h:466
PluginParameter ** pluginParameterArray
old-fashioned C-arrays of pointers for ultra-fast access for real-time audio processing ...
Definition: pluginbase.h:600
double getProToolsGRValue()
pro tools GR meter is only ever observed to be single meter; this merges all meter values for meters ...
Definition: pluginbase.cpp:451
bool infiniteTailVST3
VST3 infinite tail flag.
Definition: pluginstructures.h:1219
uint32_t aaxPluginCategoryCode
aax plugin category
Definition: pluginstructures.h:248
uint32_t getDefaultChannelIOConfigForChannelCount(uint32_t channelCount)
Definition: pluginstructures.h:1228
float auxOutputFrame[MAX_CHANNEL_COUNT]
aux output array for frame processing
Definition: pluginbase.h:597
PluginBase()
PluginBase constructor.
Definition: pluginbase.cpp:23
Custom interface to send the plugin shell a message from plugin core.
Definition: pluginstructures.h:1543
int32_t getChannelOutputFormat(uint32_t ioConfigIndex)
get I/O channel pair count
Definition: pluginbase.h:353
IPluginHostConnector * pluginHostConnector
created and destroyed on host
Definition: pluginbase.h:615
void removePreset(uint32_t index)
remove a preset - NOTE: does not delete object
Definition: pluginbase.cpp:756
bool compareSelectedString(int32_t controlID, const char *compareString)
helper function to compare a PluginParameter&#39;s value with a string version of it
Definition: pluginbase.cpp:867
PluginParameter * getPluginParameterByIndex(int32_t index)
get a parameter by index location in vector or array
Definition: pluginbase.h:293
const char * getPluginName()
Description query: name.
Definition: pluginbase.h:473
uint32_t getNumSupportedIOCombinations()
get I/O channel pair count
Definition: pluginbase.h:335
const char * getVendorName()
Description query:vendor name.
Definition: pluginbase.h:487
std::string auBundleID
AU bundle ID /* MacOS only: this MUST match the bundle identifier in your info.plist file */...
Definition: pluginstructures.h:260
double setPIParamValueNormalized(uint32_t _controlID, double _normalizedValue, bool applyTaper=true)
set a parameter&#39;s value with the normalied value (as double)
Definition: pluginbase.cpp:613
bool hasProToolsGRMeters()
checks for at least one meter parameter that has the pro tools GR meter flag set
Definition: pluginbase.cpp:434
const char * getAAXEffectID()
Description query: AAX Effect ID.
Definition: pluginbase.h:536
virtual bool initialize(PluginInfo &_pluginInfo)
one-time initialize function called after object creation and before the first reset( ) call ...
Definition: pluginbase.cpp:89
float outputFrame[MAX_CHANNEL_COUNT]
output array for frame processing
Definition: pluginbase.h:595
Information about a MIDI event.
Definition: pluginstructures.h:561