|
| | IPlugWAM (const InstanceInfo &info, const Config &config) |
| |
| const char * | init (uint32_t bufsize, uint32_t sr, void *pDesc) override |
| |
| void | terminate () override |
| |
| void | resize (uint32_t bufsize) override |
| |
| void | onProcess (WAM::AudioBus *pAudio, void *pData) override |
| |
| void | onMidi (byte status, byte data1, byte data2) override |
| |
| void | onSysex (byte *pData, uint32_t size) override |
| |
| void | onMessage (char *verb, char *res, double data) override |
| |
| void | onMessage (char *verb, char *res, char *data) override |
| |
| void | onMessage (char *verb, char *res, void *data, uint32_t size) override |
| |
| void | onParam (uint32_t idparam, double value) override |
| |
| void | SetLatency (int samples) override |
| | Call this if the latency of your plug-in changes after initialization (perhaps from OnReset() ) This may not be supported by the host. More...
|
| |
| bool | SendMidiMsg (const IMidiMsg &msg) override |
| | Send a single MIDI message // TODO: info about what thread should this be called on or not called on! More...
|
| |
| bool | SendSysEx (const ISysEx &msg) override |
| | Send a single MIDI System Exclusive (SysEx) message // TODO: info about what thread should this be called on or not called on! More...
|
| |
| void | SendControlValueFromDelegate (int ctrlTag, double normalizedValue) override |
| |
| void | SendControlMsgFromDelegate (int ctrlTag, int msgTag, int dataSize, const void *pData) override |
| |
| void | SendParameterValueFromDelegate (int paramIdx, double value, bool normalized) override |
| |
| void | SendArbitraryMsgFromDelegate (int msgTag, int dataSize=0, const void *pData=nullptr) override |
| |
| | IPlugAPIBase (Config config, EAPI plugAPI) |
| |
|
| IPlugAPIBase (const IPlugAPIBase &)=delete |
| |
|
IPlugAPIBase & | operator= (const IPlugAPIBase &)=delete |
| |
| virtual bool | CompareState (const uint8_t *pIncomingState, int startPos) const |
| | Override this method to implement a custom comparison of incoming state data with your plug-ins state data, in order to support the ProTools compare light when using custom state chunks. More...
|
| |
| virtual bool | OnHostRequestingAboutBox () |
| |
| virtual bool | OnHostRequestingProductHelp () |
| |
| virtual void | OnHostIdentified () |
| | Implement this to do something specific when IPlug becomes aware of the particular host that is hosting the plug-in. More...
|
| |
| virtual void | OnHostRequestingImportantParameters (int count, WDL_TypedBuf< int > &results) |
| | Called by AUv3 plug-ins to get the "overview parameters". More...
|
| |
| virtual bool | OnHostRequestingSupportedViewConfiguration (int width, int height) |
| | Called by AUv3 plug-in hosts to query support for multiple UI sizes. More...
|
| |
| virtual void | OnHostSelectedViewConfiguration (int width, int height) |
| | Called by some AUv3 plug-in hosts when a particular UI size is selected. More...
|
| |
| virtual bool | GetMidiNoteText (int noteNumber, char *str) const |
| | Override this method to provide custom text linked to MIDI note numbers in API classes that support that (VST2) Typically this might be used for a drum machine plug-in, in order to label a certainty "kick drum" etc. More...
|
| |
| virtual void * | GetAAXViewInterface () |
| | You need to implement this method if you are not using IGraphics and you want to support AAX's view interface functionality (special shortcuts to add automation for a parameter etc.) More...
|
| |
| virtual void | OnIdle () |
| | Override this method to get an "idle"" call on the main thread. More...
|
| |
| void | SetParameterValue (int paramIdx, double normalizedValue) |
| | SetParameterValue is called from the UI in the middle of a parameter change gesture (possibly via delegate) in order to update a parameter's value. More...
|
| |
| virtual void | GetTrackColor (int &r, int &g, int &b) |
| | Get the color of the track that the plug-in is inserted on. More...
|
| |
| virtual void | GetTrackName (WDL_String &str) |
| | Get the name of the track that the plug-in is inserted on. More...
|
| |
| virtual int | GetTrackIndex () |
| | Get the index of the track that the plug-in is inserted on. More...
|
| |
| virtual void | GetTrackNamespace (WDL_String &str) |
| | Get the namespace of the track that the plug-in is inserted on. More...
|
| |
| virtual int | GetTrackNamespaceIndex () |
| | Get the namespace index of the track that the plug-in is inserted on. More...
|
| |
| virtual void | DirtyParametersFromUI () override |
| | In a distributed VST3 or WAM plugin, if you modify the parameters on the UI side (e.g. More...
|
| |
| virtual void | SendParameterValueFromAPI (int paramIdx, double value, bool normalized) |
| | This is called from the plug-in API class in order to update UI controls linked to plug-in parameters, prior to calling OnParamChange() NOTE: It may be called on the high priority audio thread. More...
|
| |
| void | SetHost (const char *host, int version) |
| | Called to set the name of the current host, if known (calls on to HostSpecificInit() and OnHostIdentified()). More...
|
| |
| virtual void | HostSpecificInit () |
| | This method is implemented in some API classes, in order to do specific initialisation for particular problematic hosts. More...
|
| |
| void | BeginInformHostOfParamChangeFromUI (int paramIdx) override |
| |
| void | EndInformHostOfParamChangeFromUI (int paramIdx) override |
| |
| bool | EditorResizeFromUI (int viewWidth, int viewHeight, bool needsPlatformResize) override |
| |
| void | SendParameterValueFromUI (int paramIdx, double normalisedValue) override |
| |
| 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 |
| |
| void | DeferSysexMsg (const ISysEx &msg) override |
| |
| void | CreateTimer () |
| | Called by the API class to create the timer that pumps the parameter/message queues. More...
|
| |
| | IPluginBase (int nParams, int nPresets) |
| |
|
| IPluginBase (const IPluginBase &)=delete |
| |
|
IPluginBase & | operator= (const IPluginBase &)=delete |
| |
| const char * | GetPluginName () const |
| |
| int | GetPluginVersion (bool decimal) const |
| | Get the plug-in version number. More...
|
| |
| void | GetPluginVersionStr (WDL_String &str) const |
| | Gets the plug-in version as a string. More...
|
| |
| const char * | GetMfrName () const |
| | Get the manufacturer name as a CString. More...
|
| |
| const char * | GetProductName () const |
| | Get the product name as a CString. More...
|
| |
| int | GetUniqueID () const |
| |
| int | GetMfrID () const |
| |
| EHost | GetHost () const |
| |
| void | GetHostStr (WDL_String &str) const |
| | Get the host name (name is normalized) More...
|
| |
| void | GetRawHostStr (WDL_String &str) const |
| | Get raw host name (as it is reported from the host) More...
|
| |
| int | GetHostVersion (bool decimal) const |
| | Get the host version number as an integer. More...
|
| |
| void | GetHostVersionStr (WDL_String &str) const |
| | Get the host version number as a string. More...
|
| |
| EAPI | GetAPI () const |
| |
| const char * | GetAPIStr () const |
| |
| const char * | GetArchStr () const |
| |
| void | GetBuildInfoStr (WDL_String &str, const char *date, const char *time) const |
| | Get the build date of the plug-in and architecture/api details in one string. More...
|
| |
| bool | HasUI () const |
| |
| bool | GetHostResizeEnabled () const |
| |
| const char * | GetBundleID () const |
| |
| const char * | GetAppGroupID () const |
| |
| int | NParamGroups () const |
| |
| int | AddParamGroup (const char *name) |
| | Called to add a parameter group name, when a unique group name is discovered. More...
|
| |
| const char * | GetParamGroupName (int idx) const |
| | Get the parameter group name as a particular index. More...
|
| |
| virtual void | InformHostOfParameterDetailsChange () |
| | Implemented by the API class, call this if you update parameter labels and hopefully the host should update it's displays (not applicable to all APIs) More...
|
| |
| bool | DoesStateChunks () const |
| |
| bool | SerializeParams (IByteChunk &chunk) const |
| | Serializes the current double precision floating point, non-normalised values (IParam::mValue) of all parameters, into a binary byte chunk. More...
|
| |
| int | UnserializeParams (const IByteChunk &chunk, int startPos) |
| | Unserializes double precision floating point, non-normalised values from a byte chunk into mParams. More...
|
| |
| virtual bool | SerializeState (IByteChunk &chunk) const |
| | Override this method to serialize custom state data, if your plugin does state chunks. More...
|
| |
| virtual int | UnserializeState (const IByteChunk &chunk, int startPos) |
| | Override this method to unserialize custom state data, if your plugin does state chunks. More...
|
| |
| virtual bool | SerializeVST3CtrlrState (IByteChunk &chunk) const |
| | VST3 ONLY! - THIS IS ONLY INCLUDED FOR COMPATIBILITY - NOONE ELSE SHOULD NEED IT! More...
|
| |
| virtual int | UnserializeVST3CtrlrState (const IByteChunk &chunk, int startPos) |
| | VST3 ONLY! - THIS IS ONLY INCLUDED FOR COMPATIBILITY - NOONE ELSE SHOULD NEED IT! More...
|
| |
| int | GetCurrentPresetIdx () const |
| | Get the index of the current, active preset. More...
|
| |
| void | SetCurrentPresetIdx (int idx) |
| | Set the index of the current, active preset. More...
|
| |
| virtual void | InformHostOfPresetChange () |
| | Implemented by the API class, called by the UI (etc) when the plug-in initiates a program/preset change (not applicable to all APIs) More...
|
| |
| IPreset * | GetPreset (int idx) |
| | Get a ptr to a factory preset @ param idx The index number of the preset you are referring to. More...
|
| |
| void | ModifyCurrentPreset (const char *name=0) |
| | This method should update the current preset with current values NOTE: This is only relevant for VST2 plug-ins, which is the only format to have the notion of banks? More...
|
| |
| int | NPresets () const |
| | Gets the number of factory presets. More...
|
| |
| bool | RestorePreset (int idx) |
| | Restore a preset by index. More...
|
| |
| bool | RestorePreset (const char *name) |
| | Restore a preset by name. More...
|
| |
| const char * | GetPresetName (int idx) const |
| | Get the name a preset. More...
|
| |
| void | CopyPreset (IPreset *pSrc, int destIdx, bool copyname=false) |
| | Copy source preset to preset at index. More...
|
| |
| void | MakeDefaultPreset (const char *name=0, int nPresets=1) |
| | This method can be used to initialize baked-in factory presets with the default parameter values. More...
|
| |
| void | MakePreset (const char *name,...) |
| | Create a baked-in factory preset, specifiying parameter values sequentially usage: MakePreset(name, param1, param2, ..., paramN) See DumpMakePresetSrc() which is a utility that can be used to create the code for MakePreset() calls. More...
|
| |
| void | MakePresetFromNamedParams (const char *name, int nParamsNamed,...) |
| | Create a baked-in factory preset, specifiying parameter values with a list of parameter index and value pairs usage: MakePresetFromNamedParams(name, nParamsNamed, paramEnum1, paramVal1, paramEnum2, paramVal2, ..., paramEnumN, paramVal2) See DumpMakePresetFromNamedParamsSrc() which is a utility that can be used to create the code for MakePreset() calls nParamsNamed may be less than the total number of params. More...
|
| |
| void | MakePresetFromChunk (const char *name, IByteChunk &chunk) |
| | Creates a preset from an IByteChunk containing serialized data. More...
|
| |
| void | MakePresetFromBlob (const char *name, const char *blob, int sizeOfChunk) |
| | Creates a preset from a base64 encoded CString. More...
|
| |
| void | PruneUninitializedPresets () |
| | [AUV2 only] Removes any presets that weren't initialized More...
|
| |
| virtual void | OnPresetsModified () |
| | [VST2 only] Called when the preset name is changed by the host More...
|
| |
| void | EnsureDefaultPreset () |
| | [VST2 only] Called to fill uninitialzed presets More...
|
| |
| bool | SerializePresets (IByteChunk &chunk) const |
| | [VST2 only] Called when the VST2 host calls effGetChunk for a bank *
More...
|
| |
| int | UnserializePresets (const IByteChunk &chunk, int startPos) |
| | [VST2 only] Called when the VST2 host calls effSetChunk for a bank *
More...
|
| |
| void | DumpMakePresetSrc (const char *file) const |
| | Writes a call to MakePreset() for the current preset to a new text file. More...
|
| |
| void | DumpMakePresetFromNamedParamsSrc (const char *file, const char *paramEnumNames[]) const |
| | Writes a call to MakePresetFromNamedParams() for the current preset to a new text file. More...
|
| |
| void | DumpPresetBlob (const char *file) const |
| | Writes a call to MakePresetFromBlob() for the current preset to a new text file. More...
|
| |
| bool | SavePresetAsFXP (const char *file) const |
| | Save current state as a VST2 format preset. More...
|
| |
| bool | SaveBankAsFXB (const char *file) const |
| | Save current bank as a VST2 format bank [VST2 only]. More...
|
| |
| bool | LoadPresetFromFXP (const char *file) |
| | Load VST2 format preset. More...
|
| |
| bool | LoadBankFromFXB (const char *file) |
| | Load VST2 format bank [VST2 only]. More...
|
| |
| 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) |
| | Initialise a range of parameters simultaneously. More...
|
| |
| void | CloneParamRange (int cloneStartIdx, int cloneEndIdx, int startIdx, const char *searchStr="", const char *replaceStr="", const char *newGroup="") |
| | Clone a range of parameters, optionally doing a string substitution on the parameter name. More...
|
| |
| void | ForParamInRange (int startIdx, int endIdx, std::function< void(int paramIdx, IParam ¶m)> func) |
| | Modify a range of parameters with a lamda function. More...
|
| |
| void | ForParamInGroup (const char *paramGroup, std::function< void(int paramIdx, IParam ¶m)> func) |
| | Modify a parameter group simulataneously. More...
|
| |
| void | CopyParamValues (int startIdx, int destIdx, int nParams) |
| | Copy a range of parameter values. More...
|
| |
| void | CopyParamValues (const char *inGroup, const char *outGroup) |
| | Copy a range of parameter values for a parameter group. More...
|
| |
| void | RandomiseParamValues () |
| | Randomise all parameters. More...
|
| |
| void | RandomiseParamValues (int startIdx, int endIdx) |
| | Randomise parameter values within a range. More...
|
| |
| void | RandomiseParamValues (const char *paramGroup) |
| | Randomise parameter values for a parameter group. More...
|
| |
| void | DefaultParamValues () |
| | Set all parameters to their default values. More...
|
| |
| void | DefaultParamValues (int startIdx, int endIdx) |
| | Default parameter values within a range. More...
|
| |
| void | DefaultParamValues (const char *paramGroup) |
| | Default parameter values for a parameter group. More...
|
| |
| void | PrintParamValues () |
| | Default parameter values for a parameter group
More...
|
| |
| | IPlugProcessor (const Config &config, EAPI plugAPI) |
| | IPlugProcessor constructor. More...
|
| |
|
| IPlugProcessor (const IPlugProcessor &)=delete |
| |
|
IPlugProcessor & | operator= (const IPlugProcessor &)=delete |
| |
| virtual void | ProcessBlock (sample **inputs, sample **outputs, int nFrames) |
| | Override in your plug-in class to process audio In ProcessBlock you are always guaranteed to get valid pointers to all the channels the plugin requested (the maximum possible input channel count and the maximum possible output channel count including multiple buses). More...
|
| |
| virtual void | ProcessMidiMsg (const IMidiMsg &msg) |
| | Override this method to handle incoming MIDI messages. More...
|
| |
| virtual void | ProcessSysEx (const ISysEx &msg) |
| | Override this method to handle incoming MIDI System Exclusive (SysEx) messages. More...
|
| |
| virtual void | OnReset () |
| | Override this method in your plug-in class to do something prior to playback etc. More...
|
| |
| virtual void | OnActivate (bool active) |
| | Override OnActivate() which should be called by the API class when a plug-in is "switched on" by the host on a track when the channel count is known. More...
|
| |
| virtual bool | SendMidiMsg (const IMidiMsg &msg)=0 |
| | Send a single MIDI message // TODO: info about what thread should this be called on or not called on! More...
|
| |
| virtual bool | SendMidiMsgs (WDL_TypedBuf< IMidiMsg > &msgs) |
| | Send a collection of MIDI messages // TODO: info about what thread should this be called on or not called on! More...
|
| |
| virtual bool | SendSysEx (const ISysEx &msg) |
| | Send a single MIDI System Exclusive (SysEx) message // TODO: info about what thread should this be called on or not called on! More...
|
| |
| double | GetSampleRate () const |
| |
| int | GetBlockSize () const |
| |
| int | GetLatency () const |
| |
| int | GetTailSize () const |
| |
| bool | GetTailIsInfinite () const |
| |
| bool | GetBypassed () const |
| |
| bool | GetRenderingOffline () const |
| |
| double | GetSamplePos () const |
| |
| double | GetTempo () const |
| |
| double | GetPPQPos () const |
| |
| bool | GetTransportIsRunning () const |
| |
| double | GetSamplesPerBeat () const |
| |
| void | GetTimeSig (int &numerator, int &denominator) const |
| |
| virtual void | GetBusName (ERoute direction, int busIdx, int nBuses, WDL_String &str) const |
| | Get the name for a particular bus. More...
|
| |
| int | NIOConfigs () const |
| |
| const IOConfig * | GetIOConfig (int idx) const |
| |
| int | GetIOConfigWithChanCounts (std::vector< int > &inputBuses, std::vector< int > &outputBuses) |
| |
| int | MaxNBuses (ERoute direction, int *pConfigIdxWithTheMostBuses=nullptr) const |
| | Used to determine the maximum number of input or output buses based on what was specified in the channel I/O config string. More...
|
| |
| int | MaxNChannelsForBus (ERoute direction, int busIdx) const |
| | For a given input or output bus what is the maximum possible number of channels. More...
|
| |
| bool | HasWildcardBus (ERoute direction) const |
| | Check if we have any wildcard characters in the channel I/O configs. More...
|
| |
| int | MaxNChannels (ERoute direction) const |
| |
| bool | IsChannelConnected (ERoute direction, int chIdx) const |
| |
| int | NChannelsConnected (ERoute direction) const |
| |
| int | NInChansConnected () const |
| | Convenience method to find out how many input channels are connected. More...
|
| |
| int | NOutChansConnected () const |
| | Convenience method to find out how many output channels are connected. More...
|
| |
| bool | LegalIO (int NInputChans, int NOutputChans) const |
| | Check if a certain configuration of input channels and output channels is allowed based on the channel I/O configs. More...
|
| |
| bool | HasSidechainInput () const |
| |
| void | LimitToStereoIO () |
| | This is called by IPlugVST in order to limit a plug-in to stereo I/O for certain picky hosts. More...
|
| |
| bool | IsInstrument () const |
| |
| bool | IsMidiEffect () const |
| |
| int | GetAUPluginType () const |
| |
| bool | DoesMIDIIn () const |
| |
| bool | DoesMIDIOut () const |
| |
| bool | DoesMPE () const |
| |
| void | SetChannelLabel (ERoute direction, int idx, const char *formatStr, bool zeroBased=false) |
| | This allows you to label input/output channels in supporting VST2 hosts. More...
|
| |
| virtual void | SetLatency (int latency) |
| | Call this if the latency of your plug-in changes after initialization (perhaps from OnReset() ) This may not be supported by the host. More...
|
| |
| virtual void | SetTailSize (int tailSize) |
| | Call this method if you need to update the tail size at runtime, for example if the decay time of your reverb effect changes Use kTailInfinite for an infinite tail You may also use kTailNone for no tail (but this is default in any case) More...
|
| |
Public Member Functions inherited from IPlugAPIBase