Steinberg::Vst::IAudioProcessor Class Reference

#include <ivstaudioprocessor.h>

Inheritance diagram for Steinberg::Vst::IAudioProcessor:

Public Member Functions
virtual tresult PLUGIN_API	setBusArrangements (SpeakerArrangement *inputs, int32 numIns, SpeakerArrangement *outputs, int32 numOuts)=0
virtual tresult PLUGIN_API	getBusArrangement (BusDirection dir, int32 index, SpeakerArrangement &arr)=0
virtual tresult PLUGIN_API	canProcessSampleSize (int32 symbolicSampleSize)=0
virtual uint32 PLUGIN_API	getLatencySamples ()=0
virtual tresult PLUGIN_API	setupProcessing (ProcessSetup &setup)=0
virtual tresult PLUGIN_API	setProcessing (TBool state)=0
virtual tresult PLUGIN_API	process (ProcessData &data)=0
virtual uint32 PLUGIN_API	getTailSamples ()=0
Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj)=0
virtual uint32 PLUGIN_API	addRef ()=0
virtual uint32 PLUGIN_API	release ()=0

Static Public Attributes
static const FUID	iid
Static Public Attributes inherited from Steinberg::FUnknown
static const FUID	iid

Detailed Description

Audio processing interface: Vst::IAudioProcessor

• [plug imp]
• [extends IComponent]
• [released: 3.0.0]
• [mandatory]

This interface must always be supported by audio processing plug-ins.

Member Function Documentation

canProcessSampleSize()

virtual tresult PLUGIN_API Steinberg::Vst::IAudioProcessor::canProcessSampleSize ( int32 symbolicSampleSize )

pure virtual

Asks if a given sample size is supported see SymbolicSampleSizes.

getBusArrangement()

virtual tresult PLUGIN_API Steinberg::Vst::IAudioProcessor::getBusArrangement ( BusDirection dir, int32 index, SpeakerArrangement & arr )

pure virtual

Gets the bus arrangement for a given direction (input/output) and index. Note: IComponent::getBusInfo () and IAudioProcessor::getBusArrangement () should be always return the same information about the busses arrangements.

getLatencySamples()

virtual uint32 PLUGIN_API Steinberg::Vst::IAudioProcessor::getLatencySamples ( )

pure virtual

Gets the current Latency in samples. The returned value defines the group delay or the latency of the plug-in. For example, if the plug-in internally needs to look in advance (like compressors) 512 samples then this plug-in should report 512 as latency. If during the use of the plug-in this latency change, the plug-in has to inform the host by using IComponentHandler::restartComponent (kLatencyChanged), this could lead to audio playback interruption because the host has to recompute its internal mixer delay compensation. Note that for player live recording this latency should be zero or small.

getTailSamples()

virtual uint32 PLUGIN_API Steinberg::Vst::IAudioProcessor::getTailSamples ( )

pure virtual

Gets tail size in samples. For example, if the plug-in is a Reverb plug-in and it knows that the maximum length of the Reverb is 2sec, then it has to return in getTailSamples() (in VST2 it was getGetTailSize ()): 2*sampleRate. This information could be used by host for offline processing, process optimization and downmix (avoiding signal cut (clicks)). It should return:

• kNoTail when no tail
• x * sampleRate when x Sec tail.
• kInfiniteTail when infinite tail.

process()

virtual tresult PLUGIN_API Steinberg::Vst::IAudioProcessor::process ( ProcessData & data )

pure virtual

The Process call, where all information (parameter changes, event, audio buffer) are passed.

setBusArrangements()

virtual tresult PLUGIN_API Steinberg::Vst::IAudioProcessor::setBusArrangements ( SpeakerArrangement * inputs, int32 numIns, SpeakerArrangement * outputs, int32 numOuts )

pure virtual

Try to set (host => plug-in) a wanted arrangement for inputs and outputs. The host should always deliver the same number of input and output busses than the plug-in needs (see IComponent::getBusCount). The plug-in has 3 possibilities to react on this setBusArrangements call:

1. The plug-in accepts these arrangements, then it should modify, if needed, its busses to match these new arrangements (later on asked by the host with IComponent::getBusInfo () or IAudioProcessor::getBusArrangement ()) and then should return kResultTrue.
   
2. The plug-in does not accept or support these requested arrangements for all inputs/outputs or just for some or only one bus, but the plug-in can try to adapt its current arrangements according to the requested ones (requested arrangements for kMain busses should be handled with more priority than the ones for kAux busses), then it should modify its busses arrangements and should return kResultFalse.
   
3. Same than the point 2 above the plug-in does not support these requested arrangements but the plug-in cannot find corresponding arrangements, the plug-in could keep its current arrangement or fall back to a default arrangement by modifying its busses arrangements and should return kResultFalse.
   

   Parameters

   inputs	pointer to an array of /ref SpeakerArrangement
   numIns	number of /ref SpeakerArrangement in inputs array
   outputs	pointer to an array of /ref SpeakerArrangement
   numOuts	number of /ref SpeakerArrangement in outputs array Returns kResultTrue when Arrangements is supported and is the current one, else returns kResultFalse.

setProcessing()

virtual tresult PLUGIN_API Steinberg::Vst::IAudioProcessor::setProcessing ( TBool state )

pure virtual

Informs the plug-in about the processing state. This will be called before any process calls start with true and after with false. Note that setProcessing (false) may be called after setProcessing (true) without any process calls. Note this function could be called in the UI or in Processing Thread, thats why the plug-in should only light operation (no memory allocation or big setup reconfiguration), this could be used to reset some buffers (like Delay line or Reverb). The host has to be sure that it is called only when the plug-in is enable (setActive (true) was called).

setupProcessing()

virtual tresult PLUGIN_API Steinberg::Vst::IAudioProcessor::setupProcessing ( ProcessSetup & setup )

pure virtual

Called in disable state (setActive not called with true) before setProcessing is called and processing will begin.

Member Data Documentation

iid

const FUID Steinberg::Vst::IAudioProcessor::iid

static

---

The documentation for this class was generated from the following file:

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/pluginterfaces/vst/ivstaudioprocessor.h