ASPiK-GUI

Classes
class	ParamSmoother< T >
	The ParamSmoother object performs parameter smoothing on GUI control information. You can choose linear or exponential smoothing. More...
class	VSTGUI::ControlUpdateReceiver
	The ControlUpdateReceiver object is the connection mechanism between PluginParameter objects and their connected GUI control objects. It was originally designed almost identically to the example code in the VSTGUI4 SDK for the VST3 version. However, once the AU, AAX, VST3 and RAFX2 APIs were consolidated, this object changed significantly. If you are interested in creating your own version, check out the VST3 files that are included with the vstgui SDK. More...
class	VSTGUI::PluginGUI
	The PluginGUI object that maintains the entire GUI operation and has #defines to use with AAX, AU, VST3 and RAFX2 plugins. Note the multiple inheritance inolved with this very complex object. The IGUIView interface is the only non-VSTGUI4 base class. It allows for GUI resizing and manipulation, if and only if the host DAW allows and provides the mechanism for it. More...
class	PluginParameter
	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. More...

Macros
#define	enumToInt(ENUM)   static_cast<int>(ENUM)
	macro helper to cast a typed enum to an int
#define	compareEnumToInt(ENUM, INT)   (static_cast<int>(ENUM) == (INT))
	compare a typed enum value to an int
#define	compareIntToEnum(INT, ENUM)   ((INT) == static_cast<int>(ENUM))
	compare a typed enum value to an int
#define	convertIntToEnum(INT, ENUM)   static_cast<ENUM>(INT)
	convert an int to an enum, e.g. for passing to functions

Functions
bool	isReservedTag (int tag)
	check to see if a tag is reserved: ASPiK defines several reserved control ID values.
bool	isBonusParameter (int tag)
	check to see if a tag is Bonus Parameter: these should NOT be added to API parameter lists
std::string	numberToString (unsigned int number)
	converts unsigned int value to std::string
std::string	numberToString (int number)
	converts int value to std::string
std::string	numberToString (float number)
	converts float value to std::string
std::string	numberToString (double number)
	converts double value to std::string
std::string	boolToStdString (bool value)
	converts bool value to std::string

Detailed Description

The VSTGUI::PluginGUI:

• handles all of the GUI functionality including the GUI designer
• is built using the VSTGUI4 library
• is platform independent
• does not link to any pre-compiled libraries
• encodes the entire GUI in a single XML file, including the graphics file data; this one file may be moved or copied from one project to another, allowing the whole GUI to be easily moved or reused in other projects; advanced users may define multiple GUIs in multiple XML files which may be swapped in and out
• contains API-specific code in the few places where it is absolutely needed (namely for the AU event-listener system)
• supports the VTSGUI4 Custom View and Sub-Controller paradigms to extend its functionality
• exists independently from the PluginCore and does not know, or need to know, of the PluginCore’s existence
• does not hold a pointer to the PluginCore object or share any resources with it
• NOTE: the PluginGUI object is defined within the VSTGUI namespace and is grouped with more VSTGUI objects that you may use

The PluginParameter:

• stores plugin parameters as atomic variables for thread-safe operation
• encapsulates each parameter specific to the plugin as a C++ object
• can store all types of input parameters; ints, floats, doubles, string-lists, and custom user types
• can implement audio meters, complete with meter ballistics (attack and release times) and various envelope detection schemes: peak, MS, RMS and in linear or log format
• implements optional automatic variable-binding to connect GUI parameter changes to plugin variables in a completely thread-safe manner across all APIs
• has an optional auxiliary storage system to maintain other information along with any of the plugin parameters allowing you to easily customize and extend the object
• implements optional parameter smoothing for glitch-free GUI controls with two types of smoothing available: linear and exponential
• automatically implements four types of control tapering: linear, log, anti-log, and volt/octave
• implements optional sample-accurate automation for VST3 plugins (VST3 is the only API that has a specification for sample-accurate automation)

Macro Definition Documentation

compareEnumToInt

#define compareEnumToInt	(		ENUM,
			INT
	)		(static_cast<int>(ENUM) == (INT))

compare a typed enum value to an int

@compareEnumToInt

Parameters

ENUM	- the typed enum to compare with
INT	- the int to compare with

Returns

true if equal false otherwise

compareIntToEnum

#define compareIntToEnum	(		INT,
			ENUM
	)		((INT) == static_cast<int>(ENUM))

compare a typed enum value to an int

@compareIntToEnum

Parameters

INT	- the int to compare with
ENUM	- the typed enum to compare with

Returns

true if equal false otherwise

convertIntToEnum

#define convertIntToEnum	(		INT,
			ENUM
	)		static_cast<ENUM>(INT)

convert an int to an enum, e.g. for passing to functions

@convertIntToEnum

Parameters

INT	- the int to compare with
ENUM	- the typed enum to compare with

Returns

the int value properly cast as the enum type

enumToInt

#define enumToInt

(

ENUM

)

static_cast<int>(ENUM)

macro helper to cast a typed enum to an int

@enumToInt

Parameters

ENUM	- the typed enum to convert

Returns

the enum properly cast as an int (the true underlying datatype for enum class)

Function Documentation

boolToStdString()

std::string boolToStdString ( bool  value )

inline

converts bool value to std::string

@boolToStdString

Parameters

value

- bool to convert

Returns

number as a std::string

isBonusParameter()

bool isBonusParameter ( int  tag )

inline

check to see if a tag is Bonus Parameter: these should NOT be added to API parameter lists

@isBonusParameter

NOTE: PLUGIN_SIDE_BYPASS is not a bonus; it is used in VST3 as the bypass flag

Parameters

tag	- the tag to check

Returns

true if is Bonus Parameter, false otherwise

isReservedTag()

bool isReservedTag ( int  tag )

inline

check to see if a tag is reserved: ASPiK defines several reserved control ID values.

@isReservedTag

Parameters

tag	- the tag to check

Returns

true if is reserved, false otherwise

numberToString() [1/4]

std::string numberToString ( double  number )

inline

converts double value to std::string

@numberToString

Parameters

number

- double value to convert

Returns

number as a std::string

numberToString() [2/4]

std::string numberToString ( float  number )

inline

converts float value to std::string

@numberToString

Parameters

number

- float value to convert

Returns

number as a std::string

numberToString() [3/4]

std::string numberToString ( int  number )

inline

converts int value to std::string

@numberToString

Parameters

number

- int value to convert

Returns

number as a std::string

numberToString() [4/4]

std::string numberToString ( unsigned int  number )

inline

converts unsigned int value to std::string

@numberToString

Parameters

number

- unsigned int to convert

Returns

number as a std::string