#include <juce_AudioProcessor.h>

Inheritance diagram for juce::AudioProcessor:

Classes
struct	BusesLayout
class	Bus
struct	CurveData
struct	TrackProperties
struct	BusProperties
struct	BusesProperties
struct	InOutChannelPair

Public Types
enum	ProcessingPrecision { singlePrecision , doublePrecision }
enum class	Realtime { no , yes }
enum	WrapperType { wrapperType_Undefined = 0 , wrapperType_VST , wrapperType_VST3 , wrapperType_AudioUnit , wrapperType_AudioUnitv3 , wrapperType_AAX , wrapperType_Standalone , wrapperType_Unity , wrapperType_LV2 }
using	ChangeDetails = AudioProcessorListener::ChangeDetails

Public Member Functions
virtual	~AudioProcessor ()
virtual const String	getName () const =0
virtual StringArray	getAlternateDisplayNames () const
virtual void	prepareToPlay (double sampleRate, int maximumExpectedSamplesPerBlock)=0
virtual void	releaseResources ()=0
virtual void	memoryWarningReceived ()
virtual void	processBlock (AudioBuffer< float > &buffer, MidiBuffer &midiMessages)=0
virtual void	processBlock (AudioBuffer< double > &buffer, MidiBuffer &midiMessages)
virtual void	processBlockBypassed (AudioBuffer< float > &buffer, MidiBuffer &midiMessages)
virtual void	processBlockBypassed (AudioBuffer< double > &buffer, MidiBuffer &midiMessages)
int	getBusCount (bool isInput) const noexcept
Bus *	getBus (bool isInput, int busIndex) noexcept
const Bus *	getBus (bool isInput, int busIndex) const noexcept
virtual bool	canAddBus (bool isInput) const
virtual bool	canRemoveBus (bool isInput) const
bool	addBus (bool isInput)
bool	removeBus (bool isInput)
bool	setBusesLayout (const BusesLayout &)
bool	setBusesLayoutWithoutEnabling (const BusesLayout &)
BusesLayout	getBusesLayout () const
AudioChannelSet	getChannelLayoutOfBus (bool isInput, int busIndex) const noexcept
bool	setChannelLayoutOfBus (bool isInput, int busIndex, const AudioChannelSet &layout)
int	getChannelCountOfBus (bool isInput, int busIndex) const noexcept
bool	enableAllBuses ()
bool	disableNonMainBuses ()
int	getChannelIndexInProcessBlockBuffer (bool isInput, int busIndex, int channelIndex) const noexcept
int	getOffsetInBusBufferForAbsoluteChannelIndex (bool isInput, int absoluteChannelIndex, int &busIndex) const noexcept
template<typename FloatType>
AudioBuffer< FloatType >	getBusBuffer (AudioBuffer< FloatType > &processBlockBuffer, bool isInput, int busIndex) const
bool	checkBusesLayoutSupported (const BusesLayout &) const
virtual bool	supportsDoublePrecisionProcessing () const
ProcessingPrecision	getProcessingPrecision () const noexcept
bool	isUsingDoublePrecision () const noexcept
void	setProcessingPrecision (ProcessingPrecision newPrecision) noexcept
AudioPlayHead *	getPlayHead () const noexcept
int	getTotalNumInputChannels () const noexcept
int	getTotalNumOutputChannels () const noexcept
int	getMainBusNumInputChannels () const noexcept
int	getMainBusNumOutputChannels () const noexcept
template<size_t numLayouts>
BusesLayout	getNextBestLayoutInLayoutList (const BusesLayout &layouts, const short(&channelLayoutList)[numLayouts][2])
double	getSampleRate () const noexcept
int	getBlockSize () const noexcept
int	getLatencySamples () const noexcept
void	setLatencySamples (int newLatency)
virtual double	getTailLengthSeconds () const =0
virtual bool	acceptsMidi () const =0
virtual bool	producesMidi () const =0
virtual bool	supportsMPE () const
virtual bool	isMidiEffect () const
const CriticalSection &	getCallbackLock () const noexcept
void	suspendProcessing (bool shouldBeSuspended)
bool	isSuspended () const noexcept
virtual void	reset ()
virtual AudioProcessorParameter *	getBypassParameter () const
bool	isNonRealtime () const noexcept
Realtime	isRealtime () const noexcept
virtual void	setNonRealtime (bool isNonRealtime) noexcept
virtual AudioProcessorEditor *	createEditor ()=0
virtual bool	hasEditor () const =0
AudioProcessorEditor *	getActiveEditor () const noexcept
AudioProcessorEditor *	createEditorIfNeeded ()
void	updateHostDisplay (const ChangeDetails &details=ChangeDetails::getDefaultFlags())
void	addParameter (AudioProcessorParameter *)
void	addParameterGroup (std::unique_ptr< AudioProcessorParameterGroup >)
const AudioProcessorParameterGroup &	getParameterTree () const
void	setParameterTree (AudioProcessorParameterGroup &&newTree)
virtual void	refreshParameterList ()
const Array< AudioProcessorParameter * > &	getParameters () const
virtual int	getNumPrograms ()=0
virtual int	getCurrentProgram ()=0
virtual void	setCurrentProgram (int index)=0
virtual const String	getProgramName (int index)=0
virtual void	changeProgramName (int index, const String &newName)=0
virtual void	getStateInformation (juce::MemoryBlock &destData)=0
virtual void	getCurrentProgramStateInformation (juce::MemoryBlock &destData)
virtual void	setStateInformation (const void *data, int sizeInBytes)=0
virtual void	setCurrentProgramStateInformation (const void *data, int sizeInBytes)
virtual void	numChannelsChanged ()
virtual void	numBusesChanged ()
virtual void	processorLayoutsChanged ()
virtual void	addListener (AudioProcessorListener *newListener)
virtual void	removeListener (AudioProcessorListener *listenerToRemove)
virtual void	setPlayHead (AudioPlayHead *newPlayHead)
void	setPlayConfigDetails (int numIns, int numOuts, double sampleRate, int blockSize)
void	setRateAndBufferSizeDetails (double sampleRate, int blockSize) noexcept
virtual int32	getAAXPluginIDForMainBusConfig (const AudioChannelSet &mainInputLayout, const AudioChannelSet &mainOutputLayout, bool idForAudioSuite) const
virtual CurveData	getResponseCurve (CurveData::Type) const
void	editorBeingDeleted (AudioProcessorEditor *) noexcept
virtual void	updateTrackProperties (const TrackProperties &properties)
virtual int	getNumParameters ()
virtual const String	getParameterName (int parameterIndex)
virtual String	getParameterID (int index)
virtual float	getParameter (int parameterIndex)
virtual String	getParameterName (int parameterIndex, int maximumStringLength)
virtual const String	getParameterText (int parameterIndex)
virtual String	getParameterText (int parameterIndex, int maximumStringLength)
virtual int	getParameterNumSteps (int parameterIndex)
virtual bool	isParameterDiscrete (int parameterIndex) const
virtual float	getParameterDefaultValue (int parameterIndex)
virtual String	getParameterLabel (int index) const
virtual bool	isParameterOrientationInverted (int index) const
virtual void	setParameter (int parameterIndex, float newValue)
virtual bool	isParameterAutomatable (int parameterIndex) const
virtual bool	isMetaParameter (int parameterIndex) const
virtual AudioProcessorParameter::Category	getParameterCategory (int parameterIndex) const
void	beginParameterChangeGesture (int parameterIndex)
void	endParameterChangeGesture (int parameterIndex)
void	setParameterNotifyingHost (int parameterIndex, float newValue)
int	getNumInputChannels () const noexcept
int	getNumOutputChannels () const noexcept
const String	getInputSpeakerArrangement () const noexcept
const String	getOutputSpeakerArrangement () const noexcept
virtual const String	getInputChannelName (int channelIndex) const
virtual const String	getOutputChannelName (int channelIndex) const
virtual bool	isInputChannelStereoPair (int index) const
virtual bool	isOutputChannelStereoPair (int index) const

Static Public Member Functions
static bool	containsLayout (const BusesLayout &layouts, const std::initializer_list< const short[2]> &channelLayoutList)
template<size_t numLayouts>
static bool	containsLayout (const BusesLayout &layouts, const short(&channelLayoutList)[numLayouts][2])
static int	getDefaultNumParameterSteps () noexcept
static const char *	getWrapperTypeDescription (AudioProcessor::WrapperType) noexcept
static void	copyXmlToBinary (const XmlElement &xml, juce::MemoryBlock &destData)
static std::unique_ptr< XmlElement >	getXmlFromBinary (const void *data, int sizeInBytes)
static void JUCE_CALLTYPE	setTypeOfNextNewPlugin (WrapperType)

Public Attributes
const WrapperType	wrapperType

Protected Member Functions
	AudioProcessor ()
	AudioProcessor (const BusesProperties &ioLayouts)
	AudioProcessor (const std::initializer_list< const short[2]> &channelLayoutList)
virtual bool	isBusesLayoutSupported (const BusesLayout &) const
virtual bool	canApplyBusesLayout (const BusesLayout &layouts) const
virtual bool	applyBusLayouts (const BusesLayout &layouts)
virtual bool	canApplyBusCountChange (bool isInput, bool isAddingBuses, BusProperties &outNewBusProperties)
void	sendParamChangeMessageToListeners (int parameterIndex, float newValue)

Protected Attributes
std::atomic< AudioPlayHead * >	playHead { nullptr }

Private Member Functions
BusesLayout	getNextBestLayoutInList (const BusesLayout &, const Array< InOutChannelPair > &) const
void	createBus (bool isInput, const BusProperties &)
AudioProcessorParameter *	getParamChecked (int) const
void	checkForDuplicateTrimmedParamID (AudioProcessorParameter *)
void	validateParameter (AudioProcessorParameter *)
void	checkForDuplicateParamID (AudioProcessorParameter *)
void	checkForDuplicateGroupIDs (const AudioProcessorParameterGroup &)
AudioProcessorListener *	getListenerLocked (int) const noexcept
void	updateSpeakerFormatStrings ()
void	audioIOChanged (bool busNumberChanged, bool channelNumChanged)
void	getNextBestLayout (const BusesLayout &, BusesLayout &) const
template<typename floatType>
void	processBypassed (AudioBuffer< floatType > &, MidiBuffer &)
virtual bool	silenceInProducesSilenceOut () const

Static Private Member Functions
template<size_t numLayouts>
static Array< InOutChannelPair >	layoutListToArray (const short(&configuration)[numLayouts][2])
static Array< InOutChannelPair >	layoutListToArray (const std::initializer_list< const short[2]> &configuration)
template<typename This>
static auto	getBusImpl (This &t, bool isInput, int busIndex) -> decltype(t.getBus(isInput, busIndex))
static BusesProperties	busesPropertiesFromLayoutArray (const Array< InOutChannelPair > &)
static bool	containsLayout (const BusesLayout &, const Array< InOutChannelPair > &)

Private Attributes
Array< AudioProcessorListener * >	listeners
Component::SafePointer< AudioProcessorEditor >	activeEditor
double	currentSampleRate = 0
int	blockSize = 0
int	latencySamples = 0
bool	suspended = false
std::atomic< bool >	nonRealtime { false }
ProcessingPrecision	processingPrecision = singlePrecision
CriticalSection	callbackLock
CriticalSection	listenerLock
CriticalSection	activeEditorLock
OwnedArray< Bus >	inputBuses
OwnedArray< Bus >	outputBuses
String	cachedInputSpeakerArrString
String	cachedOutputSpeakerArrString
int	cachedTotalIns = 0
int	cachedTotalOuts = 0
AudioProcessorParameterGroup	parameterTree
Array< AudioProcessorParameter * >	flatParameterList

Friends
class	Bus
class	AudioProcessorParameter
class	LADSPAPluginInstance

Detailed Description

Base class for audio processing classes or plugins.

This is intended to act as a base class of audio processor that is general enough to be wrapped as a VST, AU, AAX, etc, or used internally.

It is also used by the plugin hosting code as the wrapper around an instance of a loaded plugin.

You should derive your own class from this base class, and if you're building a plugin, you should implement a global function called createPluginFilter() which creates and returns a new instance of your subclass.

@tags{Audio}

Member Typedef Documentation

◆ ChangeDetails

using juce::AudioProcessor::ChangeDetails = AudioProcessorListener::ChangeDetails

Member Enumeration Documentation

◆ ProcessingPrecision

enum juce::AudioProcessor::ProcessingPrecision

Enumerator
singlePrecision
doublePrecision

◆ Realtime

enum class juce::AudioProcessor::Realtime

strong

Enumerator
no
yes

◆ WrapperType

enum juce::AudioProcessor::WrapperType

Flags to indicate the type of plugin context in which a processor is being used.

Enumerator
wrapperType_Undefined
wrapperType_VST
wrapperType_VST3
wrapperType_AudioUnit
wrapperType_AudioUnitv3
wrapperType_AAX
wrapperType_Standalone
wrapperType_Unity
wrapperType_LV2

Constructor & Destructor Documentation

◆ AudioProcessor() [1/3]

juce::AudioProcessor::AudioProcessor ( )

protected

Constructor.

This constructor will create a main input and output bus which are disabled by default. If you need more fine-grained control then use the other constructors.

◆ AudioProcessor() [2/3]

juce::AudioProcessor::AudioProcessor ( const BusesProperties & ioLayouts )

protected

Constructor for multi-bus AudioProcessors

If your AudioProcessor supports multiple buses than use this constructor to initialise the bus layouts and bus names of your plug-in.

◆ AudioProcessor() [3/3]

juce::AudioProcessor::AudioProcessor ( const std::initializer_list< const short[2]> & channelLayoutList )

inlineprotected

Constructor for AudioProcessors which use layout maps If your AudioProcessor uses layout maps then use this constructor.

◆ ~AudioProcessor()

juce::AudioProcessor::~AudioProcessor ( )

virtual

Destructor.

Member Function Documentation

◆ acceptsMidi()

virtual bool juce::AudioProcessor::acceptsMidi ( ) const

pure virtual

Returns true if the processor wants MIDI messages.

Implemented in juce::AudioProcessorGraph, and juce::AudioProcessorGraph::AudioGraphIOProcessor.

◆ addBus()

bool juce::AudioProcessor::addBus ( bool isInput )

Dynamically request an additional bus.

Request an additional bus from the audio processor. If the audio processor does not support adding additional buses then this method will return false.

Most audio processors will not allow you to dynamically add/remove audio buses and will return false.

This method will invoke the canApplyBusCountChange callback to probe if a bus can be added and, if yes, will use the supplied bus properties of the canApplyBusCountChange callback to create a new bus.

See also: canApplyBusCountChange, removeBus

◆ addListener()

void juce::AudioProcessor::addListener ( AudioProcessorListener * newListener )

virtual

Adds a listener that will be called when an aspect of this processor changes.

◆ addParameter()

void juce::AudioProcessor::addParameter ( AudioProcessorParameter * param )

Adds a parameter to the AudioProcessor.

The parameter object will be managed and deleted automatically by the AudioProcessor when no longer needed.

◆ addParameterGroup()

void juce::AudioProcessor::addParameterGroup ( std::unique_ptr< AudioProcessorParameterGroup > group )

Adds a group of parameters to the AudioProcessor.

All the parameter objects contained within the group will be managed and deleted automatically by the AudioProcessor when no longer needed.

See also: addParameter

◆ applyBusLayouts()

bool juce::AudioProcessor::applyBusLayouts ( const BusesLayout & layouts )

protectedvirtual

This method will be called when a new bus layout needs to be applied.

Most subclasses will not need to override this method and should just use the default implementation.

◆ audioIOChanged()

void juce::AudioProcessor::audioIOChanged	(	bool	busNumberChanged,
		bool	channelNumChanged )

private

◆ beginParameterChangeGesture()

void juce::AudioProcessor::beginParameterChangeGesture ( int parameterIndex )

◆ busesPropertiesFromLayoutArray()

AudioProcessor::BusesProperties juce::AudioProcessor::busesPropertiesFromLayoutArray ( const Array< InOutChannelPair > & config )

staticprivate

◆ canAddBus()

virtual bool juce::AudioProcessor::canAddBus ( bool isInput ) const

inlinevirtual

Callback to query if a bus can currently be added.

This callback probes if a bus can currently be added. You should override this callback if you want to support dynamically adding/removing buses by the host. This is useful for mixer audio processors.

The default implementation will always return false.

See also: addBus

◆ canApplyBusCountChange()

bool juce::AudioProcessor::canApplyBusCountChange	(	bool	isInput,
		bool	isAddingBuses,
		AudioProcessor::BusProperties &	outProperties )

protectedvirtual

Callback to query if adding/removing buses currently possible.

This callback is called when the host calls addBus or removeBus. Similar to canApplyBusesLayout, this callback is only called while the AudioProcessor is stopped and gives the processor a last chance to reject a requested bus change. It can also be used to apply the bus count change to an underlying wrapped plug-in.

When adding a bus, isAddingBuses will be true and the plug-in is expected to fill out outNewBusProperties with the properties of the bus which will be created just after the successful return of this callback.

Implementations of AudioProcessor will rarely need to override this method. Only override this method if your processor supports adding and removing buses and if it needs more fine grain control over the naming of new buses or may reject bus number changes although canAddBus or canRemoveBus returned true.

The default implementation will return false if canAddBus/canRemoveBus returns false (the default behavior). Otherwise, this method returns "Input #busIndex" for input buses and "Output #busIndex" for output buses where busIndex is the index for newly created buses. The default layout in this case will be the layout of the previous bus of the same direction.

◆ canApplyBusesLayout()

virtual bool juce::AudioProcessor::canApplyBusesLayout ( const BusesLayout & layouts ) const

inlineprotectedvirtual

Callback to check if a certain bus layout can now be applied.

Most subclasses will not need to override this method and should instead override the isBusesLayoutSupported callback to reject certain layout changes.

This callback is called when the user requests a layout change. It will only be called if processing of the AudioProcessor has been stopped by a previous call to releaseResources or after the construction of the AudioProcessor. It will be called just before the actual layout change. By returning false you will abort the layout change and setBusesLayout will return false indicating that the layout change was not successful.

The default implementation will simply call isBusesLayoutSupported.

You only need to override this method if there is a chance that your AudioProcessor may not accept a layout although you have previously claimed to support it via the isBusesLayoutSupported callback. This can occur if your AudioProcessor's supported layouts depend on other plug-in parameters which may have changed since the last call to isBusesLayoutSupported, such as the format of an audio file which can be selected by the user in the AudioProcessor's editor. This callback gives the AudioProcessor a last chance to reject a layout if conditions have changed as it is always called just before the actual layout change.

As it is never called while the AudioProcessor is processing audio, it can also be used for AudioProcessors which wrap other plug-in formats to apply the current layout to the underlying plug-in. This callback gives such AudioProcessors a chance to reject the layout change should an error occur with the underlying plug-in during the layout change.

See also: isBusesLayoutSupported, setBusesLayout

◆ canRemoveBus()

virtual bool juce::AudioProcessor::canRemoveBus ( bool isInput ) const

inlinevirtual

Callback to query if the last bus can currently be removed.

This callback probes if the last bus can currently be removed. You should override this callback if you want to support dynamically adding/removing buses by the host. This is useful for mixer audio processors.

If you return true in this callback then the AudioProcessor will go ahead and delete the bus.

The default implementation will always return false.

◆ changeProgramName()

virtual void juce::AudioProcessor::changeProgramName	(	int	index,
		const String &	newName )

pure virtual

Called by the host to rename a program.

Implemented in juce::AudioProcessorGraph::AudioGraphIOProcessor, and juce::AudioProcessorGraph.

◆ checkBusesLayoutSupported()

bool juce::AudioProcessor::checkBusesLayoutSupported ( const BusesLayout & layouts ) const

Returns true if the Audio processor is likely to support a given layout. This can be called regardless if the processor is currently running.

◆ checkForDuplicateGroupIDs()

void juce::AudioProcessor::checkForDuplicateGroupIDs ( const AudioProcessorParameterGroup & newGroup )

private

◆ checkForDuplicateParamID()

void juce::AudioProcessor::checkForDuplicateParamID ( AudioProcessorParameter * param )

private

◆ checkForDuplicateTrimmedParamID()

void juce::AudioProcessor::checkForDuplicateTrimmedParamID ( AudioProcessorParameter * param )

private

◆ containsLayout() [1/3]

bool juce::AudioProcessor::containsLayout	(	const BusesLayout &	layouts,
		const Array< InOutChannelPair > &	channelLayouts )

staticprivate

◆ containsLayout() [2/3]

template<size_t numLayouts>

bool juce::AudioProcessor::containsLayout	(	const BusesLayout &	layouts,
		const short(&)	channelLayoutList[numLayouts][2] )

inlinestatic

◆ containsLayout() [3/3]

bool juce::AudioProcessor::containsLayout	(	const BusesLayout &	layouts,
		const std::initializer_list< const short[2]> &	channelLayoutList )

inlinestatic

Returns true if the channel layout map contains a certain layout.

You can use this method to help you implement the checkBusesLayoutSupported method. For example

bool checkBusesLayoutSupported (const BusesLayout& layouts) override
{
    return containsLayout (layouts, {{1,1},{2,2}});
}

◆ copyXmlToBinary()

void juce::AudioProcessor::copyXmlToBinary	(	const XmlElement &	xml,
		juce::MemoryBlock &	destData )

static

Helper function that just converts an xml element into a binary blob.

Use this in your processor's getStateInformation() method if you want to store its state as xml.

Then use getXmlFromBinary() to reverse this operation and retrieve the XML from a binary blob.

◆ createBus()

void juce::AudioProcessor::createBus	(	bool	isInput,
		const BusProperties &	ioConfig )

private

◆ createEditor()

virtual AudioProcessorEditor * juce::AudioProcessor::createEditor ( )

pure virtual

Creates the processor's GUI.

This can return nullptr if you want a GUI-less processor, in which case the host may create a generic UI that lets the user twiddle the parameters directly.

If you do want to pass back a component, the component should be created and set to the correct size before returning it. If you implement this method, you must also implement the hasEditor() method and make it return true.

Remember not to do anything silly like allowing your processor to keep a pointer to the component that gets created - it could be deleted later without any warning, which would make your pointer into a dangler. Use the getActiveEditor() method instead.

The correct way to handle the connection between an editor component and its processor is to use something like a ChangeBroadcaster so that the editor can register itself as a listener, and be told when a change occurs. This lets them safely unregister themselves when they are deleted.

Here are a few things to bear in mind when writing an editor:

Initially there won't be an editor, until the user opens one, or they might not open one at all. Your processor mustn't rely on it being there.
An editor object may be deleted and a replacement one created again at any time.
It's safe to assume that an editor will be deleted before its processor.

See also: hasEditor

Implemented in juce::AudioProcessorGraph::AudioGraphIOProcessor, and juce::AudioProcessorGraph.

◆ createEditorIfNeeded()

AudioProcessorEditor * juce::AudioProcessor::createEditorIfNeeded ( )

Returns the active editor, or if there isn't one, it will create one. This may call createEditor() internally to create the component.

◆ disableNonMainBuses()

bool juce::AudioProcessor::disableNonMainBuses ( )

Disables all non-main buses (aux and sidechains).

◆ editorBeingDeleted()

void juce::AudioProcessor::editorBeingDeleted ( AudioProcessorEditor * editor )

noexcept

Not for public use - this is called before deleting an editor component.

◆ enableAllBuses()

bool juce::AudioProcessor::enableAllBuses ( )

Enables all buses

◆ endParameterChangeGesture()

void juce::AudioProcessor::endParameterChangeGesture ( int parameterIndex )

◆ getAAXPluginIDForMainBusConfig()

int32 juce::AudioProcessor::getAAXPluginIDForMainBusConfig	(	const AudioChannelSet &	mainInputLayout,
		const AudioChannelSet &	mainOutputLayout,
		bool	idForAudioSuite ) const

virtual

AAX plug-ins need to report a unique "plug-in id" for every audio layout configuration that your AudioProcessor supports on the main bus. Override this function if you want your AudioProcessor to use a custom "plug-in id" (for example to stay backward compatible with older versions of JUCE).

The default implementation will compute a unique integer from the input and output layout and add this value to the 4 character code 'jcaa' (for native AAX) or 'jyaa' (for AudioSuite plug-ins).

◆ getActiveEditor()

AudioProcessorEditor * juce::AudioProcessor::getActiveEditor ( ) const

noexcept

Returns the active editor, if there is one. Bear in mind this can return nullptr even if an editor has previously been opened.

Note that you should only call this method from the message thread as the active editor may be deleted by the message thread, causing a dangling pointer.

◆ getAlternateDisplayNames()

StringArray juce::AudioProcessor::getAlternateDisplayNames ( ) const

virtual

Returns a list of alternative names to use for this processor.

Some hosts truncate the name of your AudioProcessor when there isn't enough space in the GUI to show the full name. Overriding this method, allows the host to choose an alternative name (such as an abbreviation) to better fit the available space.

◆ getBlockSize()

int juce::AudioProcessor::getBlockSize ( ) const

inlinenoexcept

Returns the current typical block size that is being used.

This can be called from your processBlock() method - it's not guaranteed to be valid at any other time.

Remember it's not the ONLY block size that may be used when calling processBlock, it's just the normal one. The actual block sizes used may be larger or smaller than this, and will vary between successive calls.

◆ getBus() [1/2]

const Bus * juce::AudioProcessor::getBus	(	bool	isInput,
		int	busIndex ) const

inlinenoexcept

Returns the audio bus with a given index and direction. If busIndex is invalid then this method will return a nullptr.

◆ getBus() [2/2]

Bus * juce::AudioProcessor::getBus	(	bool	isInput,
		int	busIndex )

inlinenoexcept

Returns the audio bus with a given index and direction. If busIndex is invalid then this method will return a nullptr.

◆ getBusBuffer()

template<typename FloatType>

AudioBuffer< FloatType > juce::AudioProcessor::getBusBuffer	(	AudioBuffer< FloatType > &	processBlockBuffer,
		bool	isInput,
		int	busIndex ) const

inline

Returns an AudioBuffer containing a set of channel pointers for a specific bus. This can be called in processBlock to get a buffer containing a sub-group of the master AudioBuffer which contains all the plugin channels.

◆ getBusCount()

int juce::AudioProcessor::getBusCount ( bool isInput ) const

inlinenoexcept

Returns the number of buses on the input or output side

◆ getBusesLayout()

AudioProcessor::BusesLayout juce::AudioProcessor::getBusesLayout ( ) const

Provides the current channel layouts of this audio processor.

◆ getBusImpl()

template<typename This>

auto juce::AudioProcessor::getBusImpl	(	This &	t,
		bool	isInput,
		int	busIndex ) -> decltype(t.getBus(isInput, busIndex))

inlinestaticprivate

◆ getBypassParameter()

virtual AudioProcessorParameter * juce::AudioProcessor::getBypassParameter ( ) const

inlinevirtual

Returns the parameter that controls the AudioProcessor's bypass state.

If this method returns a nullptr then you can still control the bypass by calling processBlockBypassed instead of processBlock. On the other hand, if this method returns a non-null value, you should never call processBlockBypassed but use the returned parameter to control the bypass state instead.

A plug-in can override this function to return a parameter which controls your plug-in's bypass. You should always check the value of this parameter in your processBlock callback and bypass any effects if it is non-zero.

◆ getCallbackLock()

const CriticalSection & juce::AudioProcessor::getCallbackLock ( ) const

inlinenoexcept

This returns a critical section that will automatically be locked while the host is calling the processBlock() method.

Use it from your UI or other threads to lock access to variables that are used by the process callback, but obviously be careful not to keep it locked for too long, because that could cause stuttering playback. If you need to do something that'll take a long time and need the processing to stop while it happens, use the suspendProcessing() method instead.

See also: suspendProcessing

◆ getChannelCountOfBus()

int juce::AudioProcessor::getChannelCountOfBus	(	bool	isInput,
		int	busIndex ) const

inlinenoexcept

Provides the number of channels of the bus with a given index and direction.

If the index, direction combination is invalid then this will return zero.

◆ getChannelIndexInProcessBlockBuffer()

int juce::AudioProcessor::getChannelIndexInProcessBlockBuffer	(	bool	isInput,
		int	busIndex,
		int	channelIndex ) const

noexcept

Returns the position of a bus's channels within the processBlock buffer. This can be called in processBlock to figure out which channel of the master AudioBuffer maps onto a specific bus's channel.

◆ getChannelLayoutOfBus()

AudioChannelSet juce::AudioProcessor::getChannelLayoutOfBus	(	bool	isInput,
		int	busIndex ) const

noexcept

Provides the channel layout of the bus with a given index and direction.

If the index, direction combination is invalid then this will return an AudioChannelSet with no channels.

◆ getCurrentProgram()

virtual int juce::AudioProcessor::getCurrentProgram ( )

pure virtual

Returns the number of the currently active program.

Implemented in juce::AudioProcessorGraph::AudioGraphIOProcessor, and juce::AudioProcessorGraph.

◆ getCurrentProgramStateInformation()

void juce::AudioProcessor::getCurrentProgramStateInformation ( juce::MemoryBlock & destData )

virtual

The host will call this method if it wants to save the state of just the processor's current program.

Unlike getStateInformation, this should only return the current program's state.

Not all hosts support this, and if you don't implement it, the base class method just calls getStateInformation() instead. If you do implement it, be sure to also implement getCurrentProgramStateInformation.

See also: getStateInformation, setCurrentProgramStateInformation

◆ getDefaultNumParameterSteps()

int juce::AudioProcessor::getDefaultNumParameterSteps ( )

staticnoexcept

Returns the default number of steps for a parameter.

NOTE! This method is deprecated! It's recommended that you use AudioProcessorParameter::getNumSteps() instead.

See also: getParameterNumSteps

◆ getInputChannelName()

const String juce::AudioProcessor::getInputChannelName ( int channelIndex ) const

virtual

◆ getInputSpeakerArrangement()

const String juce::AudioProcessor::getInputSpeakerArrangement ( ) const

inlinenoexcept

◆ getLatencySamples()

int juce::AudioProcessor::getLatencySamples ( ) const

inlinenoexcept

This returns the number of samples delay that the processor imposes on the audio passing through it.

The host will call this to find the latency - the processor itself should set this value by calling setLatencySamples() as soon as it can during its initialisation.

◆ getListenerLocked()

AudioProcessorListener * juce::AudioProcessor::getListenerLocked ( int index ) const

privatenoexcept

◆ getMainBusNumInputChannels()

int juce::AudioProcessor::getMainBusNumInputChannels ( ) const

inlinenoexcept

Returns the number of input channels on the main bus.

◆ getMainBusNumOutputChannels()

int juce::AudioProcessor::getMainBusNumOutputChannels ( ) const

inlinenoexcept

Returns the number of output channels on the main bus.

◆ getName()

virtual const String juce::AudioProcessor::getName ( ) const

pure virtual

Returns the name of this processor.

Implemented in juce::AudioProcessorGraph::AudioGraphIOProcessor, and juce::AudioProcessorGraph.

◆ getNextBestLayout()

void juce::AudioProcessor::getNextBestLayout	(	const BusesLayout &	desiredLayout,
		BusesLayout &	actualLayouts ) const

private

◆ getNextBestLayoutInLayoutList()

template<size_t numLayouts>

BusesLayout juce::AudioProcessor::getNextBestLayoutInLayoutList	(	const BusesLayout &	layouts,
		const short(&)	channelLayoutList[numLayouts][2] )

inline

Returns the next best layout which is contained in a channel layout map.

You can use this method to help you implement getNextBestLayout. For example:

BusesLayout getNextBestLayout (const BusesLayout& layouts) override
{
    return getNextBestLayoutInLayoutList (layouts, {{1,1},{2,2}});
}

◆ getNextBestLayoutInList()

AudioProcessor::BusesLayout juce::AudioProcessor::getNextBestLayoutInList	(	const BusesLayout &	layouts,
		const Array< InOutChannelPair > &	legacyLayouts ) const

private

◆ getNumInputChannels()

int juce::AudioProcessor::getNumInputChannels ( ) const

inlinenoexcept

◆ getNumOutputChannels()

int juce::AudioProcessor::getNumOutputChannels ( ) const

inlinenoexcept

◆ getNumParameters()

int juce::AudioProcessor::getNumParameters ( )

virtual

◆ getNumPrograms()

virtual int juce::AudioProcessor::getNumPrograms ( )

pure virtual

Returns the number of preset programs the processor supports.

The value returned must be valid as soon as this object is created, and must not change over its lifetime.

This value shouldn't be less than 1.

Implemented in juce::AudioProcessorGraph::AudioGraphIOProcessor, and juce::AudioProcessorGraph.

◆ getOffsetInBusBufferForAbsoluteChannelIndex()

int juce::AudioProcessor::getOffsetInBusBufferForAbsoluteChannelIndex	(	bool	isInput,
		int	absoluteChannelIndex,
		int &	busIndex ) const

noexcept

Returns the offset in a bus's buffer from an absolute channel index.

This method returns the offset in a bus's buffer given an absolute channel index. It also provides the bus index. For example, this method would return one for a processor with two stereo buses when given the absolute channel index.

◆ getOutputChannelName()

const String juce::AudioProcessor::getOutputChannelName ( int channelIndex ) const

virtual

◆ getOutputSpeakerArrangement()

const String juce::AudioProcessor::getOutputSpeakerArrangement ( ) const

inlinenoexcept

◆ getParamChecked()

AudioProcessorParameter * juce::AudioProcessor::getParamChecked ( int index ) const

private

◆ getParameter()

float juce::AudioProcessor::getParameter ( int parameterIndex )

virtual

Reimplemented in juce::AudioPluginInstance.

◆ getParameterCategory()

AudioProcessorParameter::Category juce::AudioProcessor::getParameterCategory ( int parameterIndex ) const

virtual

Reimplemented in juce::AudioPluginInstance.

◆ getParameterDefaultValue()

float juce::AudioProcessor::getParameterDefaultValue ( int parameterIndex )

virtual

Reimplemented in juce::AudioPluginInstance.

◆ getParameterID()

String juce::AudioProcessor::getParameterID ( int index )

virtual

Reimplemented in juce::AudioPluginInstance.

◆ getParameterLabel()

String juce::AudioProcessor::getParameterLabel ( int index ) const

virtual

Reimplemented in juce::AudioPluginInstance.

◆ getParameterName() [1/2]

const String juce::AudioProcessor::getParameterName ( int parameterIndex )

virtual

Reimplemented in juce::AudioPluginInstance.

◆ getParameterName() [2/2]

String juce::AudioProcessor::getParameterName	(	int	parameterIndex,
		int	maximumStringLength )

virtual

Reimplemented in juce::AudioPluginInstance.

◆ getParameterNumSteps()

int juce::AudioProcessor::getParameterNumSteps ( int parameterIndex )

virtual

Reimplemented in juce::AudioPluginInstance.

◆ getParameters()

const Array< AudioProcessorParameter * > & juce::AudioProcessor::getParameters ( ) const

Returns a flat list of the parameters in the current tree.

◆ getParameterText() [1/2]

const String juce::AudioProcessor::getParameterText ( int parameterIndex )

virtual

Reimplemented in juce::AudioPluginInstance.

◆ getParameterText() [2/2]

String juce::AudioProcessor::getParameterText	(	int	parameterIndex,
		int	maximumStringLength )

virtual

Reimplemented in juce::AudioPluginInstance.

◆ getParameterTree()

const AudioProcessorParameterGroup & juce::AudioProcessor::getParameterTree ( ) const

Returns the group of parameters managed by this AudioProcessor.

◆ getPlayHead()

AudioPlayHead * juce::AudioProcessor::getPlayHead ( ) const

inlinenoexcept

Returns the current AudioPlayHead object that should be used to find out the state and position of the playhead.

You can ONLY call this from your processBlock() method! Calling it at other times will produce undefined behaviour, as the host may not have any context in which a time would make sense, and some hosts will almost certainly have multithreading issues if it's not called on the audio thread.

The AudioPlayHead object that is returned can be used to get the details about the time of the start of the block currently being processed. But do not store this pointer or use it outside of the current audio callback, because the host may delete or re-use it.

If the host can't or won't provide any time info, this will return nullptr.

◆ getProcessingPrecision()

ProcessingPrecision juce::AudioProcessor::getProcessingPrecision ( ) const

inlinenoexcept

Returns the precision-mode of the processor. Depending on the result of this method you MUST call the corresponding version of processBlock. The default processing precision is single precision.

See also: setProcessingPrecision, supportsDoublePrecisionProcessing

◆ getProgramName()

virtual const String juce::AudioProcessor::getProgramName ( int index )

pure virtual

Must return the name of a given program.

Implemented in juce::AudioProcessorGraph::AudioGraphIOProcessor, and juce::AudioProcessorGraph.

◆ getResponseCurve()

virtual CurveData juce::AudioProcessor::getResponseCurve ( CurveData::Type ) const

inlinevirtual

◆ getSampleRate()

double juce::AudioProcessor::getSampleRate ( ) const

inlinenoexcept

Returns the current sample rate.

This can be called from your processBlock() method - it's not guaranteed to be valid at any other time, and may return 0 if it's unknown.

◆ getStateInformation()

virtual void juce::AudioProcessor::getStateInformation ( juce::MemoryBlock & destData )

pure virtual

The host will call this method when it wants to save the processor's internal state.

This must copy any info about the processor's state into the block of memory provided, so that the host can store this and later restore it using setStateInformation().

Note that there's also a getCurrentProgramStateInformation() method, which only stores the current program, not the state of the entire processor.

See also the helper function copyXmlToBinary() for storing settings as XML.

See also: getCurrentProgramStateInformation

Implemented in juce::AudioProcessorGraph::AudioGraphIOProcessor, and juce::AudioProcessorGraph.

◆ getTailLengthSeconds()

virtual double juce::AudioProcessor::getTailLengthSeconds ( ) const

pure virtual

Returns the length of the processor's tail, in seconds.

Implemented in juce::AudioProcessorGraph::AudioGraphIOProcessor, and juce::AudioProcessorGraph.

◆ getTotalNumInputChannels()

int juce::AudioProcessor::getTotalNumInputChannels ( ) const

inlinenoexcept

Returns the total number of input channels.

This method will return the total number of input channels by accumulating the number of channels on each input bus. The number of channels of the buffer passed to your processBlock callback will be equivalent to either getTotalNumInputChannels or getTotalNumOutputChannels - which ever is greater.

Note that getTotalNumInputChannels is equivalent to getMainBusNumInputChannels if your processor does not have any sidechains or aux buses.

◆ getTotalNumOutputChannels()

int juce::AudioProcessor::getTotalNumOutputChannels ( ) const

inlinenoexcept

Returns the total number of output channels.

This method will return the total number of output channels by accumulating the number of channels on each output bus. The number of channels of the buffer passed to your processBlock callback will be equivalent to either getTotalNumInputChannels or getTotalNumOutputChannels - which ever is greater.

Note that getTotalNumOutputChannels is equivalent to getMainBusNumOutputChannels if your processor does not have any sidechains or aux buses.

◆ getWrapperTypeDescription()

const char * juce::AudioProcessor::getWrapperTypeDescription ( AudioProcessor::WrapperType type )

staticnoexcept

Returns a textual description of a WrapperType value

◆ getXmlFromBinary()

std::unique_ptr< XmlElement > juce::AudioProcessor::getXmlFromBinary	(	const void *	data,
		int	sizeInBytes )

static

Retrieves an XML element that was stored as binary with the copyXmlToBinary() method. This might return nullptr if the data's unsuitable or corrupted.

◆ hasEditor()

virtual bool juce::AudioProcessor::hasEditor ( ) const

pure virtual

Your processor subclass must override this and return true if it can create an editor component.

See also: createEditor

Implemented in juce::AudioProcessorGraph::AudioGraphIOProcessor, and juce::AudioProcessorGraph.

◆ isBusesLayoutSupported()

virtual bool juce::AudioProcessor::isBusesLayoutSupported ( const BusesLayout & ) const

inlineprotectedvirtual

Callback to query if the AudioProcessor supports a specific layout.

This callback is called when the host probes the supported bus layouts via the checkBusesLayoutSupported method. You should override this callback if you would like to limit the layouts that your AudioProcessor supports. The default implementation will accept any layout. JUCE does basic sanity checks so that the provided layouts parameter will have the same number of buses as your AudioProcessor.

See also: checkBusesLayoutSupported

◆ isInputChannelStereoPair()

bool juce::AudioProcessor::isInputChannelStereoPair ( int index ) const

virtual

◆ isMetaParameter()

bool juce::AudioProcessor::isMetaParameter ( int parameterIndex ) const

virtual

Reimplemented in juce::AudioPluginInstance.

◆ isMidiEffect()

virtual bool juce::AudioProcessor::isMidiEffect ( ) const

inlinevirtual

Returns true if this is a MIDI effect plug-in and does no audio processing.

◆ isNonRealtime()

bool juce::AudioProcessor::isNonRealtime ( ) const

inlinenoexcept

Returns true if the processor is being run in an offline mode for rendering.

If the processor is being run live on realtime signals, this returns false. If the mode is unknown, this will assume it's realtime and return false.

This value may be unreliable until the prepareToPlay() method has been called, and could change each time prepareToPlay() is called.

See also: setNonRealtime()

◆ isOutputChannelStereoPair()

bool juce::AudioProcessor::isOutputChannelStereoPair ( int index ) const

virtual

◆ isParameterAutomatable()

bool juce::AudioProcessor::isParameterAutomatable ( int parameterIndex ) const

virtual

Reimplemented in juce::AudioPluginInstance.

◆ isParameterDiscrete()

bool juce::AudioProcessor::isParameterDiscrete ( int parameterIndex ) const

virtual

Reimplemented in juce::AudioPluginInstance.

◆ isParameterOrientationInverted()

bool juce::AudioProcessor::isParameterOrientationInverted ( int index ) const

virtual

Reimplemented in juce::AudioPluginInstance.

◆ isRealtime()

Realtime juce::AudioProcessor::isRealtime ( ) const

inlinenoexcept

Returns no if the processor is being run in an offline mode for rendering.

If the processor is being run live on realtime signals, this returns yes. If the mode is unknown, this will assume it's realtime and return yes.

This value may be unreliable until the prepareToPlay() method has been called, and could change each time prepareToPlay() is called.

See also: setNonRealtime()

◆ isSuspended()

bool juce::AudioProcessor::isSuspended ( ) const

inlinenoexcept

Returns true if processing is currently suspended.

See also: suspendProcessing

◆ isUsingDoublePrecision()

bool juce::AudioProcessor::isUsingDoublePrecision ( ) const

inlinenoexcept

Returns true if the current precision is set to doublePrecision.

◆ layoutListToArray() [1/2]

template<size_t numLayouts>

Array< InOutChannelPair > juce::AudioProcessor::layoutListToArray ( const short(&) configuration[numLayouts][2] )

inlinestaticprivate

◆ layoutListToArray() [2/2]

Array< InOutChannelPair > juce::AudioProcessor::layoutListToArray ( const std::initializer_list< const short[2]> & configuration )

inlinestaticprivate

◆ memoryWarningReceived()

virtual void juce::AudioProcessor::memoryWarningReceived ( )

inlinevirtual

Called by the host to indicate that you should reduce your memory footprint.

You should override this method to free up some memory gracefully, if possible, otherwise the host may forcibly unload your AudioProcessor.

At the moment this method is only called when your AudioProcessor is an AUv3 plug-in running on iOS.

◆ numBusesChanged()

void juce::AudioProcessor::numBusesChanged ( )

virtual

This method is called when the number of buses is changed.

◆ numChannelsChanged()

void juce::AudioProcessor::numChannelsChanged ( )

virtual

This method is called when the total number of input or output channels is changed.

◆ prepareToPlay()

virtual void juce::AudioProcessor::prepareToPlay	(	double	sampleRate,
		int	maximumExpectedSamplesPerBlock )

pure virtual

Called before playback starts, to let the processor prepare itself.

The sample rate is the target sample rate, and will remain constant until playback stops.

You can call getTotalNumInputChannels and getTotalNumOutputChannels or query the busLayout member variable to find out the number of channels your processBlock callback must process.

The maximumExpectedSamplesPerBlock value is a strong hint about the maximum number of samples that will be provided in each block. You may want to use this value to resize internal buffers. You should program defensively in case a buggy host exceeds this value. The actual block sizes that the host uses may be different each time the callback happens: completely variable block sizes can be expected from some hosts.

See also: busLayout, getTotalNumInputChannels, getTotalNumOutputChannels

Implemented in juce::AudioProcessorGraph::AudioGraphIOProcessor, and juce::AudioProcessorGraph.

◆ processBlock() [1/2]

void juce::AudioProcessor::processBlock	(	AudioBuffer< double > &	buffer,
		MidiBuffer &	midiMessages )

virtual

Renders the next block.

When this method is called, the buffer contains a number of channels which is at least as great as the maximum number of input and output channels that this processor is using. It will be filled with the processor's input data and should be replaced with the processor's output.

So for example if your processor has a combined total of 2 input channels and 4 output channels, then the buffer will contain 4 channels, the first two being filled with the input data. Your processor should read these, do its processing, and replace the contents of all 4 channels with its output.

Or if your processor has 5 inputs and 2 outputs, the buffer will have 5 channels, all filled with data, and your processor should overwrite the first 2 of these with its output. But be VERY careful not to write anything to the last 3 channels, as these might be mapped to memory that the host assumes is read-only!

If your plug-in has more than one input or output buses then the buffer passed to the processBlock methods will contain a bundle of all channels of each bus. Use getBusBuffer to obtain a audio buffer for a particular bus.

Note that if you have more outputs than inputs, then only those channels that correspond to an input channel are guaranteed to contain sensible data - e.g. in the case of 2 inputs and 4 outputs, the first two channels contain the input, but the last two channels may contain garbage, so you should be careful not to let this pass through without being overwritten or cleared.

Also note that the buffer may have more channels than are strictly necessary, but you should only read/write from the ones that your processor is supposed to be using.

If your plugin uses buses, then you should use getBusBuffer() or getChannelIndexInProcessBlockBuffer() to find out which of the input and output channels correspond to which of the buses.

The number of samples in these buffers is NOT guaranteed to be the same for every callback, and may be more or less than the estimated value given to prepareToPlay(). Your code must be able to cope with variable-sized blocks, or you're going to get clicks and crashes!

Also note that some hosts will occasionally decide to pass a buffer containing zero samples, so make sure that your algorithm can deal with that!

If the processor is receiving a MIDI input, then the midiMessages array will be filled with the MIDI messages for this block. Each message's timestamp will indicate the message's time, as a number of samples from the start of the block.

Any messages left in the MIDI buffer when this method has finished are assumed to be the processor's MIDI output. This means that your processor should be careful to clear any incoming messages from the array if it doesn't want them to be passed-on.

If you have implemented the getBypassParameter method, then you need to check the value of this parameter in this callback and bypass your processing if the parameter has a non-zero value.

Note that when calling this method as a host, the result may still be bypassed as the parameter that controls the bypass may be non-zero.

Be very careful about what you do in this callback - it's going to be called by the audio thread, so any kind of interaction with the UI is absolutely out of the question. If you change a parameter in here and need to tell your UI to update itself, the best way is probably to inherit from a ChangeBroadcaster, let the UI components register as listeners, and then call sendChangeMessage() inside the processBlock() method to send out an asynchronous message. You could also use the AsyncUpdater class in a similar way.

See also: getBusBuffer

Reimplemented in juce::AudioProcessorGraph::AudioGraphIOProcessor, and juce::AudioProcessorGraph.

◆ processBlock() [2/2]

virtual void juce::AudioProcessor::processBlock	(	AudioBuffer< float > &	buffer,
		MidiBuffer &	midiMessages )

pure virtual

Renders the next block.

When this method is called, the buffer contains a number of channels which is at least as great as the maximum number of input and output channels that this processor is using. It will be filled with the processor's input data and should be replaced with the processor's output.

So for example if your processor has a total of 2 input channels and 4 output channels, then the buffer will contain 4 channels, the first two being filled with the input data. Your processor should read these, do its processing, and replace the contents of all 4 channels with its output.

Or if your processor has a total of 5 inputs and 2 outputs, the buffer will have 5 channels, all filled with data, and your processor should overwrite the first 2 of these with its output. But be VERY careful not to write anything to the last 3 channels, as these might be mapped to memory that the host assumes is read-only!

If your plug-in has more than one input or output buses then the buffer passed to the processBlock methods will contain a bundle of all channels of each bus. Use getBusBuffer to obtain an audio buffer for a particular bus.