VSTPluginFormat Class Reference

Implements a plugin format manager for VSTs. More...

Inheritance diagram for VSTPluginFormat:

Static Public Member Functions
static std::unique_ptr< AudioPluginInstance >	createCustomVSTFromMainCall (void *entryPointFunction, double initialSampleRate, int initialBufferSize)
Static Public Member Functions inherited from VSTPluginFormatHeadless
static const XmlElement *	getVSTXML (AudioPluginInstance *plugin)
	Attempts to retrieve the VSTXML data from a plugin.
static bool	loadFromFXBFile (AudioPluginInstance *plugin, const void *data, size_t dataSize)
	Attempts to reload a VST plugin's state from some FXB or FXP data.
static bool	saveToFXBFile (AudioPluginInstance *plugin, MemoryBlock &result, bool asFXB)
	Attempts to save a VST's state to some FXP or FXB data.
static bool	getChunkData (AudioPluginInstance *plugin, MemoryBlock &result, bool isPreset)
	Attempts to get a VST's state as a chunk of memory.
static bool	setChunkData (AudioPluginInstance *plugin, const void *data, int size, bool isPreset)
	Attempts to set a VST's state from a chunk of memory.
static AudioPluginInstance *	createCustomVSTFromMainCall (void *entryPointFunction, double initialSampleRate, int initialBufferSize)
	Given a suitable function pointer to a VSTPluginMain function, this will attempt to instantiate and return a plugin for it.
static void	setExtraFunctions (AudioPluginInstance *plugin, ExtraFunctions *functions)
	Provides an ExtraFunctions callback object for a plugin to use.
static pointer_sized_int JUCE_CALLTYPE	dispatcher (AudioPluginInstance *, int32, int32, pointer_sized_int, void *, float)
	This simply calls directly to the VST's AEffect::dispatcher() function.
static AudioPluginInstance *	getPluginInstanceFromVstEffectInterface (void *aEffect)
	Given a VstEffectInterface* (aka vst::AEffect*), this will return the juce AudioPluginInstance that is being used to wrap it.
static String	getFormatName ()

Additional Inherited Members
Public Types inherited from AudioPluginFormat
using	PluginCreationCallback = std::function<void (std::unique_ptr<AudioPluginInstance>, const String&)>
	A callback lambda that is passed to createPluginInstanceAsync()
using	ARAFactoryCreationCallback = std::function<void (ARAFactoryResult)>
	A callback lambda that is passed to getARAFactory()
Public Member Functions inherited from VSTPluginFormatHeadless
	VSTPluginFormatHeadless ()=default
String	getName () const override
	Returns the format name.
bool	canScanForPlugins () const override
	Returns true if this format needs to run a scan to find its list of plugins.
bool	isTrivialToScan () const override
	Should return true if this format is both safe and quick to scan - i.e.
void	findAllTypesForFile (OwnedArray< PluginDescription > &, const String &fileOrIdentifier) override
	This tries to create descriptions for all the plugin types available in a binary module file.
bool	fileMightContainThisPluginType (const String &fileOrIdentifier) override
	Should do a quick check to see if this file or directory might be a plugin of this format.
String	getNameOfPluginFromIdentifier (const String &fileOrIdentifier) override
	Returns a readable version of the name of the plugin that this identifier refers to.
bool	pluginNeedsRescanning (const PluginDescription &) override
	Returns true if this plugin's version or date has changed and it should be re-checked.
StringArray	searchPathsForPlugins (const FileSearchPath &, bool recursive, bool) override
	Searches a suggested set of directories for any plugins in this format.
bool	doesPluginStillExist (const PluginDescription &) override
	Checks whether this plugin could possibly be loaded.
FileSearchPath	getDefaultLocationsToSearch () override
	Returns the typical places to look for this kind of plugin.
virtual void	aboutToScanVSTShellPlugin (const PluginDescription &)
	Can be overridden to receive a callback when each member of a shell plugin is about to be tested during a call to findAllTypesForFile().
Public Member Functions inherited from AudioPluginFormat
	~AudioPluginFormat () override
	Destructor.
std::unique_ptr< AudioPluginInstance >	createInstanceFromDescription (const PluginDescription &, double initialSampleRate, int initialBufferSize)
	Tries to recreate a type from a previously generated PluginDescription.
std::unique_ptr< AudioPluginInstance >	createInstanceFromDescription (const PluginDescription &, double initialSampleRate, int initialBufferSize, String &errorMessage)
	Same as above but with the possibility of returning an error message.
void	createPluginInstanceAsync (const PluginDescription &description, double initialSampleRate, int initialBufferSize, PluginCreationCallback)
	Tries to recreate a type from a previously generated PluginDescription.
virtual void	createARAFactoryAsync (const PluginDescription &, ARAFactoryCreationCallback callback)
	Tries to create an ARAFactoryWrapper for this description.
Protected Member Functions inherited from AudioPluginFormat
	AudioPluginFormat ()

Detailed Description

Implements a plugin format manager for VSTs.

Member Function Documentation

createCustomVSTFromMainCall()

std::unique_ptr< AudioPluginInstance > VSTPluginFormat::createCustomVSTFromMainCall ( void * entryPointFunction, double initialSampleRate, int initialBufferSize )

static