The AUFXPlugin is the ASPiK plugin shell for Audio Units plugin. It contains the plugin kernel and all necessary intefaces, implemented as separate C++ obejcts. More...

#include <aufxplugin.h>

Inheritance diagram for AUFXPlugin:

Public Member Functions
	AUFXPlugin (AudioUnit component)
	constructor for plugin object More...

	~AUFXPlugin ()
	destructor for plugin object More...

virtual ComponentResult	Version ()

virtual ComponentResult	Initialize ()
	the AU init function More...

virtual OSStatus	GetPropertyInfo (AudioUnitPropertyID inID, AudioUnitScope nScope, AudioUnitElement inElement, UInt32 &outDataSize, Boolean &outWritable)
	queries from host about plugin properties More...

virtual OSStatus	GetProperty (AudioUnitPropertyID inID, AudioUnitScope inScope, AudioUnitElement inElement, void *outData)
	queries from host to get property information More...

virtual OSStatus	SetProperty (AudioUnitPropertyID inID, AudioUnitScope inScope, AudioUnitElement inElement, const void *inData, UInt32 inDataSize)
	open and close the GUI object More...

virtual ComponentResult	GetParameterInfo (AudioUnitScope inScope, AudioUnitParameterID inParameterID, AudioUnitParameterInfo &outParameterInfo)
	get information about each AU parameter that was initialized More...

virtual ComponentResult	GetPresets (CFArrayRef *outData) const
	return a static array of preset information structures More...

virtual OSStatus	NewFactoryPresetSet (const AUPreset &inNewFactoryPreset)
	user has selected a new preset More...

virtual bool	SupportsTail ()

virtual Float64	GetTailTime ()

virtual Float64	GetLatency ()

virtual ComponentResult	SetParameter (AudioUnitParameterID inID, AudioUnitScope inScope, AudioUnitElement inElement, AudioUnitParameterValue inValue, UInt32 inBufferOffsetInFrames)
	this just calls base class More...

virtual OSStatus	Render (AudioUnitRenderActionFlags &ioActionFlags, const AudioTimeStamp &inTimeStamp, UInt32 inNumberFrames)
	first function to be called during buffer process cycle More...

virtual OSStatus	ProcessBufferLists (AudioUnitRenderActionFlags &ioActionFlags, const AudioBufferList &inBuffer, AudioBufferList &outBuffer, UInt32 inFramesToProcess)
	process the de-interleaved channel buffers More...

virtual ComponentResult	Reset (AudioUnitScope inScope, AudioUnitElement inElement)
	reset function for AU and core More...

virtual ComponentResult	GetParameterValueStrings (AudioUnitScope inScope, AudioUnitParameterID inParameterID, CFArrayRef *outStrings)
	get parameter string-lists (for string-list params only) More...

virtual ComponentResult	RestoreState (CFPropertyListRef inData)
	called when a user preset is updated; may also be called during init; note the call sequence depends on the host and AULab calls early init functions in a different order that Logic. More...

virtual UInt32	SupportedNumChannels (const AUChannelInfo **outInfo)
	return an array of AUChannelInfo structures with input and output channel combinations More...

virtual OSStatus	HandleNoteOn (UInt8 inChannel, UInt8 inNoteNumber, UInt8 inVelocity, UInt32 inStartFrame)
	specialized MIDI handler for only this message; CURRENTLY NOT USED, see HandleMidiEvent More...

virtual OSStatus	HandleNoteOff (UInt8 inChannel, UInt8 inNoteNumber, UInt8 inVelocity, UInt32 inStartFrame)
	specialized MIDI handler for only this message; CURRENTLY NOT USED, see HandleMidiEvent More...

virtual OSStatus	HandlePitchWheel (UInt8 inChannel, UInt8 inPitch1, UInt8 inPitch2, UInt32 inStartFrame)
	specialized MIDI handler for only this message; CURRENTLY NOT USED, see HandleMidiEvent More...

virtual OSStatus	HandleControlChange (UInt8 inChannel, UInt8 inController, UInt8 inValue, UInt32 inStartFrame)
	specialized MIDI handler for only this message; CURRENTLY NOT USED, see HandleMidiEvent More...

virtual OSStatus	HandleMidiEvent (UInt8 status, UInt8 channel, UInt8 data1, UInt8 data2, UInt32 inStartFrame)
	specialized MIDI handler to add events to the plugin's queue More...

char *	getMyComponentDirectory (CFStringRef bundleID)
	helper function to get a path to the location where THIS library is loaded More...

void	setAUParameterChangeEvent (unsigned int controlID, double actualValue)
	safely issue a parameter change event More...

double	getAUParameter (unsigned int controlID)
	safely get a parameter value More...

Public Attributes
GUIPluginConnector *	guiPluginConnector = nullptr
	GUI -> Plugin interface.

PluginHostConnector *	pluginHostConnector = nullptr
	Plugin -> Host interface.

AUMIDIEventQueue *	midiEventQueue = nullptr
	double-buffered-queue for MIDI messaging

Protected Member Functions
void	initAUParametersWithPluginCore ()
	setup the AU parameter list with the plugin core's parameter list More...

void	updateAUParametersWithPluginCore ()
	send parameter update info (metering, output) More...

void	updatePluginCoreParameters ()
	set the plugin core parameters from the AU parameters (called during each buffer process cycle) More...

void	updateHostInfo (HostInfo *hostInfo)
	set the HostInfo for the core (varies by API) More...

Protected Attributes
PluginCore *	pluginCore = nullptr
	GUI the plugin core: alive for FULL lifecycle of shell.

bool	hasSidechain = false
	sidechain flag

AudioBufferList *	sidechainBufferList = nullptr
	sidechain buffers (if active)

int	sidechainChannelCount = 0
	num sidechain channels

AUChannelInfo *	auChannelInfo = nullptr
	the current channel information

float **	inputBuffers = nullptr
	de-interleaved incoming audio input buffers

float **	outputBuffers = nullptr
	de-interleaved outgoing audio output buffers

float **	sidechainInputBuffers = nullptr
	de-interleaved incoming audio sidechain buffers

void *	presetsArrayData = nullptr
	contiguous memory block for persistent preset data

int	currentPreset = 0
	current preset's index value

Float64	latencyInSeconds = 0
	au latency (seconds!) More...

PluginGUI *	pluginGUI = nullptr

Detailed Description

The AUFXPlugin is the ASPiK plugin shell for Audio Units plugin. It contains the plugin kernel and all necessary intefaces, implemented as separate C++ obejcts.

NOTES:

derived from AUMIDIEffectBase to allow MIDI input/output if desired; it is not necessary to use MIDI but it is bSCAvailable
however, AUMIDIEffectBase does not allow exposing a sidechain so we get around this issue by setting the AU effet type to "aufx" even though it is really "aumu" – this will only generate a warning during validation but is otherwise secure.
the required interfaces are implemented on member objects that handle the thread-safe transfer of parameter information

Author: Will Pirkle http://www.willpirkle.com

Remarks: This object is included in Designing Audio Effects Plugins in C++ 2nd Ed. by Will Pirkle

Version: Revision : 1.0

Date: Date : 2018 / 09 / 7

Constructor & Destructor Documentation

◆ AUFXPlugin()

AUFXPlugin::AUFXPlugin ( AudioUnit component )

constructor for plugin object

NOTES:

creates core
creates ALL ASPiK interfaces
sets up AU parameters
intitializes AU objecgt

◆ ~AUFXPlugin()

AUFXPlugin::~AUFXPlugin ( )

destructor for plugin object

NOTES:

destory core
destory all buffers

Member Function Documentation

◆ getAUParameter()

double AUFXPlugin::getAUParameter ( unsigned int controlID )

safely get a parameter value

safely get an AU parameter's value

Parameters

controlID the AU parameter identifier (same as PluginParameter's controlID)

Returns: the parameter's actualValue

Parameters

controlID the AU parameter ID value

Returns: the actual value of the parameter

◆ GetLatency()

virtual Float64 AUFXPlugin::GetLatency ( )

inlinevirtual

AU override method

◆ getMyComponentDirectory()

char* AUFXPlugin::getMyComponentDirectory ( CFStringRef bundleID )

inline

helper function to get a path to the location where THIS library is loaded

Parameters

bundleID the bundle ID as a string

Returns: the path as a simple, naked char*

◆ GetParameterInfo()

ComponentResult AUFXPlugin::GetParameterInfo	(	AudioUnitScope	inScope,
		AudioUnitParameterID	inParameterID,
		AudioUnitParameterInfo &	outParameterInfo
	)

virtual

get information about each AU parameter that was initialized

AU override method

NOTES:

see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
https://developer.apple.com/documentation/audiounit

◆ GetParameterValueStrings()

ComponentResult AUFXPlugin::GetParameterValueStrings	(	AudioUnitScope	inScope,
		AudioUnitParameterID	inParameterID,
		CFArrayRef *	outStrings
	)

virtual

get parameter string-lists (for string-list params only)

AU override method

NOTES:

see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
- https://developer.apple.com/documentation/audiounit

◆ GetPresets()

ComponentResult AUFXPlugin::GetPresets ( CFArrayRef * outData ) const

virtual

return a static array of preset information structures

AU override method

NOTES:

see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

◆ GetProperty()

ComponentResult AUFXPlugin::GetProperty	(	AudioUnitPropertyID	inID,
		AudioUnitScope	inScope,
		AudioUnitElement	inElement,
		void *	outData
	)

virtual

queries from host to get property information

AU override method

NOTES:

see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

◆ GetPropertyInfo()

ComponentResult AUFXPlugin::GetPropertyInfo	(	AudioUnitPropertyID	inID,
		AudioUnitScope	inScope,
		AudioUnitElement	inElement,
		UInt32 &	outDataSize,
		Boolean &	outWritable
	)

virtual

queries from host about plugin properties

AU override method

NOTES:

see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

◆ HandleControlChange()

OSStatus AUFXPlugin::HandleControlChange	(	UInt8	inChannel,
		UInt8	inController,
		UInt8	inValue,
		UInt32	inStartFrame
	)

virtual

specialized MIDI handler for only this message; CURRENTLY NOT USED, see HandleMidiEvent

AU override method

NOTES:

see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

◆ HandleMidiEvent()

OSStatus AUFXPlugin::HandleMidiEvent	(	UInt8	status,
		UInt8	channel,
		UInt8	data1,
		UInt8	data2,
		UInt32	inStartFrame
	)

virtual

specialized MIDI handler to add events to the plugin's queue

AU override method

NOTES:

see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

◆ HandleNoteOff()

OSStatus AUFXPlugin::HandleNoteOff	(	UInt8	inChannel,
		UInt8	inNoteNumber,
		UInt8	inVelocity,
		UInt32	inStartFrame
	)

virtual

specialized MIDI handler for only this message; CURRENTLY NOT USED, see HandleMidiEvent

AU override method

NOTES:

see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

◆ HandleNoteOn()

OSStatus AUFXPlugin::HandleNoteOn	(	UInt8	inChannel,
		UInt8	inNoteNumber,
		UInt8	inVelocity,
		UInt32	inStartFrame
	)

virtual

specialized MIDI handler for only this message; CURRENTLY NOT USED, see HandleMidiEvent

AU override method

NOTES:

see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

◆ HandlePitchWheel()

OSStatus AUFXPlugin::HandlePitchWheel	(	UInt8	inChannel,
		UInt8	inPitch1,
		UInt8	inPitch2,
		UInt32	inStartFrame
	)

virtual

specialized MIDI handler for only this message; CURRENTLY NOT USED, see HandleMidiEvent

AU override method

NOTES:

see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

◆ initAUParametersWithPluginCore()

void AUFXPlugin::initAUParametersWithPluginCore ( )

protected

setup the AU parameter list with the plugin core's parameter list

set up all AU parameters at once using plugin core's parameters; performed only once

◆ Initialize()

ComponentResult AUFXPlugin::Initialize ( )

virtual

the AU init function

AU override method

NOTES:

set the plugin sample rate and bit depth
set and store the plugin latency in seconds for AU host queries
see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

Returns: the number of AUChannelInfo structures in the array

◆ NewFactoryPresetSet()

OSStatus AUFXPlugin::NewFactoryPresetSet ( const AUPreset & inNewFactoryPreset )

virtual

user has selected a new preset

AU override method

NOTES:

see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

◆ ProcessBufferLists()

OSStatus AUFXPlugin::ProcessBufferLists	(	AudioUnitRenderActionFlags &	ioActionFlags,
		const AudioBufferList &	inBuffer,
		AudioBufferList &	outBuffer,
		UInt32	inFramesToProcess
	)

virtual

process the de-interleaved channel buffers

AU override method

NOTES:

sends buffers into core for processing
see AU SDK for more information on this function and its parameters
see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
https://developer.apple.com/documentation/audiounit

◆ Render()

OSStatus AUFXPlugin::Render	(	AudioUnitRenderActionFlags &	ioActionFlags,
		const AudioTimeStamp &	inTimeStamp,
		UInt32	inNumberFrames
	)

virtual

first function to be called during buffer process cycle

AU override method

NOTES:

handles sidechain input information for upcoming ProcessBufferLists call
see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

◆ Reset()

ComponentResult AUFXPlugin::Reset	(	AudioUnitScope	inScope,
		AudioUnitElement	inElement
	)

virtual

reset function for AU and core

AU override method

NOTES:

call base class
reset core
see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

◆ RestoreState()

ComponentResult AUFXPlugin::RestoreState ( CFPropertyListRef inData )

virtual

called when a user preset is updated; may also be called during init; note the call sequence depends on the host and AULab calls early init functions in a different order that Logic.

AU override method

NOTES:

just calls base class; additions reserved for future
see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

◆ setAUParameterChangeEvent()

void AUFXPlugin::setAUParameterChangeEvent	(	unsigned int	controlID,
		double	actualValue
	)

safely issue a parameter change event

safely set an AU parameter change event

Parameters

controlID	the AU parameter identifier (same as PluginParameter's controlID)
actualValue	the value to set

NOTES:

thread-safe parameter change evengt
https://developer.apple.com/documentation/audiounit

◆ SetParameter()

ComponentResult AUFXPlugin::SetParameter	(	AudioUnitParameterID	inID,
		AudioUnitScope	inScope,
		AudioUnitElement	inElement,
		AudioUnitParameterValue	inValue,
		UInt32	inBufferOffsetInFrames
	)

virtual

this just calls base class

AU override method

NOTES:

do not be tempted into using this for plugin core sync; this function should not be modified
see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

◆ SetProperty()

OSStatus AUFXPlugin::SetProperty	(	AudioUnitPropertyID	inID,
		AudioUnitScope	inScope,
		AudioUnitElement	inElement,
		const void *	inData,
		UInt32	inDataSize
	)

virtual

open and close the GUI object

AU override method

NOTES:

see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

◆ SupportedNumChannels()

UInt32 AUFXPlugin::SupportedNumChannels ( const AUChannelInfo ** outInfo )

virtual

return an array of AUChannelInfo structures with input and output channel combinations

AU override method

NOTES:

query the PluginCore for its channel setup information - it does all work
see Designing Audio Effects in C++ 2nd Ed. by Will Pirkle for more information and an AU Programming Guide
see AU SDK for more information on this function and its parameters
https://developer.apple.com/documentation/audiounit

Returns: the number of AUChannelInfo structures in the array

◆ SupportsTail()

virtual bool AUFXPlugin::SupportsTail ( )

inlinevirtual

AU override method reply to host query

Returns: TRUE if plugin core wants a tail

◆ updateAUParametersWithPluginCore()

void AUFXPlugin::updateAUParametersWithPluginCore ( )

protected

send parameter update info (metering, output)

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

outoing transfer AU parameter changes (meter data) from the Core

◆ updateHostInfo()

void AUFXPlugin::updateHostInfo ( HostInfo * hostInfo )

protected

set the HostInfo for the core (varies by API)

update this buffer run's incoming host data (BPM, etc...)

Parameters

hostInfo a HostInfo structure to fill with incoming data

◆ updatePluginCoreParameters()

void AUFXPlugin::updatePluginCoreParameters ( )

protected

set the plugin core parameters from the AU parameters (called during each buffer process cycle)

safely transfer AU parameter changes into the Core

◆ Version()

virtual ComponentResult AUFXPlugin::Version ( )

inlinevirtual

AU override method

Member Data Documentation

◆ latencyInSeconds

Float64 AUFXPlugin::latencyInSeconds = 0

protected

au latency (seconds!)

VSTGUI4 Editor NOTE: this is only used to open and close the GUI

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

C:/RackAFX_v7/ASPIK_SDK/PluginTemplate/project_source/source/au_source/aufxplugin.h
C:/RackAFX_v7/ASPIK_SDK/PluginTemplate/project_source/source/au_source/aufxplugin.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AUFXPlugin()

◆ ~AUFXPlugin()

Member Function Documentation

◆ getAUParameter()

◆ GetLatency()

◆ getMyComponentDirectory()

◆ GetParameterInfo()

◆ GetParameterValueStrings()

◆ GetPresets()

◆ GetProperty()

◆ GetPropertyInfo()

◆ HandleControlChange()

◆ HandleMidiEvent()

◆ HandleNoteOff()

◆ HandleNoteOn()

◆ HandlePitchWheel()

◆ initAUParametersWithPluginCore()

◆ Initialize()

◆ NewFactoryPresetSet()

◆ ProcessBufferLists()

◆ Render()

◆ Reset()

◆ RestoreState()

◆ setAUParameterChangeEvent()

◆ SetParameter()

◆ SetProperty()

◆ SupportedNumChannels()

◆ SupportsTail()

◆ updateAUParametersWithPluginCore()

◆ updateHostInfo()

◆ updatePluginCoreParameters()

◆ Version()

Member Data Documentation

◆ latencyInSeconds