JUCE  v5.1.1-3-g1a0b28c73
JUCE API
VSTPluginFormat Class Reference

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

#include <juce_VSTPluginFormat.h>

Inheritance diagram for VSTPluginFormat:
Collaboration diagram for VSTPluginFormat:

Classes

class  ExtraFunctions
 Base class for some extra functions that can be attached to a VST plugin instance. More...
 

Public Member Functions

 VSTPluginFormat ()
 
 ~VSTPluginFormat ()
 
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(). More...
 
bool canScanForPlugins () const override
 Returns true if this format needs to run a scan to find its list of plugins. More...
 
AudioPluginInstancecreateInstanceFromDescription (const PluginDescription &, double initialSampleRate, int initialBufferSize)
 Tries to recreate a type from a previously generated PluginDescription. More...
 
AudioPluginInstancecreateInstanceFromDescription (const PluginDescription &, double initialSampleRate, int initialBufferSize, String &errorMessage)
 Same as above but with the possibility of returning an error message. More...
 
void createPluginInstanceAsync (const PluginDescription &description, double initialSampleRate, int initialBufferSize, InstantiationCompletionCallback *completionCallback)
 Tries to recreate a type from a previously generated PluginDescription. More...
 
void createPluginInstanceAsync (const PluginDescription &description, double initialSampleRate, int initialBufferSize, std::function< void(AudioPluginInstance *, const String &)> completionCallback)
 
bool doesPluginStillExist (const PluginDescription &) override
 Checks whether this plugin could possibly be loaded. More...
 
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. More...
 
void findAllTypesForFile (OwnedArray< PluginDescription > &, const String &fileOrIdentifier) override
 This tries to create descriptions for all the plugin types available in a binary module file. More...
 
FileSearchPath getDefaultLocationsToSearch () override
 Returns the typical places to look for this kind of plugin. More...
 
String getName () const override
 Returns the format name. More...
 
String getNameOfPluginFromIdentifier (const String &fileOrIdentifier) override
 Returns a readable version of the name of the plugin that this identifier refers to. More...
 
bool pluginNeedsRescanning (const PluginDescription &) override
 Returns true if this plugin's version or date has changed and it should be re-checked. More...
 
StringArray searchPathsForPlugins (const FileSearchPath &, bool recursive, bool) override
 Searches a suggested set of directories for any plugins in this format. More...
 

Static Public Member Functions

static AudioPluginInstancecreateCustomVSTFromMainCall (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. More...
 
static pointer_sized_int dispatcher (AudioPluginInstance *, int32, int32, pointer_sized_int, void *, float)
 This simply calls directly to the VST's AEffect::dispatcher() function. More...
 
static bool getChunkData (AudioPluginInstance *plugin, MemoryBlock &result, bool isPreset)
 Attempts to get a VST's state as a chunk of memory. More...
 
static AudioPluginInstancegetPluginInstanceFromVstEffectInterface (void *aEffect)
 Given a VstEffectInterface* (aka vst::AEffect*), this will return the juce AudioPluginInstance that is being used to wrap it. More...
 
static const XmlElementgetVSTXML (AudioPluginInstance *plugin)
 Attempts to retrieve the VSTXML data from a plugin. More...
 
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. More...
 
static bool saveToFXBFile (AudioPluginInstance *plugin, MemoryBlock &result, bool asFXB)
 Attempts to save a VST's state to some FXP or FXB data. More...
 
static bool setChunkData (AudioPluginInstance *plugin, const void *data, int size, bool isPreset)
 Attempts to set a VST's state from a chunk of memory. More...
 
static void setExtraFunctions (AudioPluginInstance *plugin, ExtraFunctions *functions)
 Provides an ExtraFunctions callback object for a plugin to use. More...
 

Private Member Functions

void createPluginInstance (const PluginDescription &, double initialSampleRate, int initialBufferSize, void *userData, void(*callback)(void *, AudioPluginInstance *, const String &)) override
 Implementors must override this function. More...
 
void recursiveFileSearch (StringArray &, const File &, bool recursive)
 
bool requiresUnblockedMessageThreadDuringCreation (const PluginDescription &) const noexcept override
 

Detailed Description

Implements a plugin format manager for VSTs.

Constructor & Destructor Documentation

◆ VSTPluginFormat()

VSTPluginFormat::VSTPluginFormat ( )

◆ ~VSTPluginFormat()

VSTPluginFormat::~VSTPluginFormat ( )

Member Function Documentation

◆ aboutToScanVSTShellPlugin()

virtual void VSTPluginFormat::aboutToScanVSTShellPlugin ( const PluginDescription )
virtual

Can be overridden to receive a callback when each member of a shell plugin is about to be tested during a call to findAllTypesForFile().

Only the name and uid members of the PluginDescription are guaranteed to be valid when this is called.

◆ canScanForPlugins()

bool VSTPluginFormat::canScanForPlugins ( ) const
inlineoverridevirtual

Returns true if this format needs to run a scan to find its list of plugins.

Implements AudioPluginFormat.

References JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR.

◆ createCustomVSTFromMainCall()

static AudioPluginInstance* VSTPluginFormat::createCustomVSTFromMainCall ( void *  entryPointFunction,
double  initialSampleRate,
int  initialBufferSize 
)
static

Given a suitable function pointer to a VSTPluginMain function, this will attempt to instantiate and return a plugin for it.

◆ createInstanceFromDescription() [1/2]

AudioPluginInstance* AudioPluginFormat::createInstanceFromDescription ( const PluginDescription ,
double  initialSampleRate,
int  initialBufferSize 
)
inherited

Tries to recreate a type from a previously generated PluginDescription.

See also
AudioPluginFormatManager::createInstance

◆ createInstanceFromDescription() [2/2]

AudioPluginInstance* AudioPluginFormat::createInstanceFromDescription ( const PluginDescription ,
double  initialSampleRate,
int  initialBufferSize,
String errorMessage 
)
inherited

Same as above but with the possibility of returning an error message.

See also
AudioPluginFormatManager::createInstance

◆ createPluginInstance()

void VSTPluginFormat::createPluginInstance ( const PluginDescription ,
double  initialSampleRate,
int  initialBufferSize,
void *  userData,
void(*)(void *, AudioPluginInstance *, const String &)  callback 
)
overrideprivatevirtual

Implementors must override this function.

This is guaranteed to be called on the message thread. You may call the callback on any thread.

Implements AudioPluginFormat.

◆ createPluginInstanceAsync() [1/2]

void AudioPluginFormat::createPluginInstanceAsync ( const PluginDescription description,
double  initialSampleRate,
int  initialBufferSize,
InstantiationCompletionCallback completionCallback 
)
inherited

Tries to recreate a type from a previously generated PluginDescription.

See also
AudioPluginFormatManager::createInstanceAsync

◆ createPluginInstanceAsync() [2/2]

void AudioPluginFormat::createPluginInstanceAsync ( const PluginDescription description,
double  initialSampleRate,
int  initialBufferSize,
std::function< void(AudioPluginInstance *, const String &)>  completionCallback 
)
inherited

◆ dispatcher()

static pointer_sized_int VSTPluginFormat::dispatcher ( AudioPluginInstance ,
int32  ,
int32  ,
pointer_sized_int  ,
void *  ,
float   
)
static

This simply calls directly to the VST's AEffect::dispatcher() function.

◆ doesPluginStillExist()

bool VSTPluginFormat::doesPluginStillExist ( const PluginDescription )
overridevirtual

Checks whether this plugin could possibly be loaded.

It doesn't actually need to load it, just to check whether the file or component still exists.

Implements AudioPluginFormat.

◆ fileMightContainThisPluginType()

bool VSTPluginFormat::fileMightContainThisPluginType ( const String fileOrIdentifier)
overridevirtual

Should do a quick check to see if this file or directory might be a plugin of this format.

This is for searching for potential files, so it shouldn't actually try to load the plugin or do anything time-consuming.

Implements AudioPluginFormat.

◆ findAllTypesForFile()

void VSTPluginFormat::findAllTypesForFile ( OwnedArray< PluginDescription > &  results,
const String fileOrIdentifier 
)
overridevirtual

This tries to create descriptions for all the plugin types available in a binary module file.

The file will be some kind of DLL or bundle.

Normally there will only be one type returned, but some plugins (e.g. VST shells) can use a single DLL to create a set of different plugin subtypes, so in that case, each subtype is returned as a separate object.

Implements AudioPluginFormat.

◆ getChunkData()

static bool VSTPluginFormat::getChunkData ( AudioPluginInstance plugin,
MemoryBlock result,
bool  isPreset 
)
static

Attempts to get a VST's state as a chunk of memory.

◆ getDefaultLocationsToSearch()

FileSearchPath VSTPluginFormat::getDefaultLocationsToSearch ( )
overridevirtual

Returns the typical places to look for this kind of plugin.

Note that if this returns no paths, it means that the format doesn't search in files or folders, e.g. AudioUnits.

Implements AudioPluginFormat.

◆ getName()

String VSTPluginFormat::getName ( ) const
inlineoverridevirtual

Returns the format name.

E.g. "VST", "AudioUnit", etc.

Implements AudioPluginFormat.

◆ getNameOfPluginFromIdentifier()

String VSTPluginFormat::getNameOfPluginFromIdentifier ( const String fileOrIdentifier)
overridevirtual

Returns a readable version of the name of the plugin that this identifier refers to.

Implements AudioPluginFormat.

◆ getPluginInstanceFromVstEffectInterface()

static AudioPluginInstance* VSTPluginFormat::getPluginInstanceFromVstEffectInterface ( void *  aEffect)
static

Given a VstEffectInterface* (aka vst::AEffect*), this will return the juce AudioPluginInstance that is being used to wrap it.

◆ getVSTXML()

static const XmlElement* VSTPluginFormat::getVSTXML ( AudioPluginInstance plugin)
static

Attempts to retrieve the VSTXML data from a plugin.

Will return nullptr if the plugin isn't a VST, or if it doesn't have any VSTXML.

◆ loadFromFXBFile()

static bool VSTPluginFormat::loadFromFXBFile ( AudioPluginInstance plugin,
const void *  data,
size_t  dataSize 
)
static

Attempts to reload a VST plugin's state from some FXB or FXP data.

◆ pluginNeedsRescanning()

bool VSTPluginFormat::pluginNeedsRescanning ( const PluginDescription )
overridevirtual

Returns true if this plugin's version or date has changed and it should be re-checked.

Implements AudioPluginFormat.

◆ recursiveFileSearch()

void VSTPluginFormat::recursiveFileSearch ( StringArray ,
const File ,
bool  recursive 
)
private

◆ requiresUnblockedMessageThreadDuringCreation()

bool VSTPluginFormat::requiresUnblockedMessageThreadDuringCreation ( const PluginDescription ) const
overrideprivatevirtualnoexcept

Implements AudioPluginFormat.

◆ saveToFXBFile()

static bool VSTPluginFormat::saveToFXBFile ( AudioPluginInstance plugin,
MemoryBlock result,
bool  asFXB 
)
static

Attempts to save a VST's state to some FXP or FXB data.

◆ searchPathsForPlugins()

StringArray VSTPluginFormat::searchPathsForPlugins ( const FileSearchPath directoriesToSearch,
bool  recursive,
bool  allowPluginsWhichRequireAsynchronousInstantiation 
)
overridevirtual

Searches a suggested set of directories for any plugins in this format.

The path might be ignored, e.g. by AUs, which are found by the OS rather than manually.

Parameters
directoriesToSearchThis specifies which directories shall be searched for plug-ins.
recursiveShould the search recursively traverse folders.
allowPluginsWhichRequireAsynchronousInstantiationIf this is false then plug-ins which require asynchronous creation will be excluded.

Implements AudioPluginFormat.

◆ setChunkData()

static bool VSTPluginFormat::setChunkData ( AudioPluginInstance plugin,
const void *  data,
int  size,
bool  isPreset 
)
static

Attempts to set a VST's state from a chunk of memory.

◆ setExtraFunctions()

static void VSTPluginFormat::setExtraFunctions ( AudioPluginInstance plugin,
ExtraFunctions functions 
)
static

Provides an ExtraFunctions callback object for a plugin to use.

The plugin will take ownership of the object and will delete it automatically.


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