|
JUCE
|
A special type of AudioProcessor that can live inside an AudioProcessorGraph in order to use the audio that comes into and out of the graph itself. More...
Inheritance diagram for AudioProcessorGraph::AudioGraphIOProcessor:Public Types | |
| enum | IODeviceType { audioInputNode, audioOutputNode, midiInputNode, midiOutputNode } |
| Specifies the mode in which this processor will operate. More... | |
| Public Types inherited from AudioProcessor | |
| enum | ProcessingPrecision { singlePrecision, doublePrecision } |
| enum | WrapperType { wrapperType_Undefined = 0, wrapperType_VST, wrapperType_VST3, wrapperType_AudioUnit, wrapperType_AudioUnitv3, wrapperType_RTAS, wrapperType_AAX, wrapperType_Standalone } |
| Flags to indicate the type of plugin context in which a processor is being used. More... | |
Public Member Functions | |
| IODeviceType | getType () const noexcept |
| Returns the mode of this processor. More... | |
| AudioProcessorGraph * | getParentGraph () const noexcept |
| Returns the parent graph to which this processor belongs, or nullptr if it hasn't yet been added to one. More... | |
| bool | isInput () const noexcept |
| True if this is an audio or midi input. More... | |
| bool | isOutput () const noexcept |
| True if this is an audio or midi output. More... | |
| AudioGraphIOProcessor (const IODeviceType type) | |
| ~AudioGraphIOProcessor () | |
| const String | getName () const override |
| Returns the name of this processor. More... | |
| void | fillInPluginDescription (PluginDescription &) const override |
| Fills-in the appropriate parts of this plugin description object. More... | |
| void | prepareToPlay (double newSampleRate, int estimatedSamplesPerBlock) override |
| Called before playback starts, to let the filter prepare itself. More... | |
| void | releaseResources () override |
| Called after playback has stopped, to let the filter free up any resources it no longer needs. More... | |
| void | processBlock (AudioBuffer< float > &, MidiBuffer &) override |
| Renders the next block. More... | |
| void | processBlock (AudioBuffer< double > &, MidiBuffer &) override |
| Renders the next block. More... | |
| bool | supportsDoublePrecisionProcessing () const override |
| Returns true if the Audio processor supports double precision floating point processing. More... | |
| double | getTailLengthSeconds () const override |
| Returns the length of the filter's tail, in seconds. More... | |
| bool | acceptsMidi () const override |
| Returns true if the processor wants midi messages. More... | |
| bool | producesMidi () const override |
| Returns true if the processor produces midi messages. More... | |
| bool | hasEditor () const override |
| Your filter must override this and return true if it can create an editor component. More... | |
| AudioProcessorEditor * | createEditor () override |
| Creates the filter's UI. More... | |
| int | getNumPrograms () override |
| Returns the number of preset programs the filter supports. More... | |
| int | getCurrentProgram () override |
| Returns the number of the currently active program. More... | |
| void | setCurrentProgram (int) override |
| Called by the host to change the current program. More... | |
| const String | getProgramName (int) override |
| Must return the name of a given program. More... | |
| void | changeProgramName (int, const String &) override |
| Called by the host to rename a program. More... | |
| void | getStateInformation (juce::MemoryBlock &destData) override |
| The host will call this method when it wants to save the filter's internal state. More... | |
| void | setStateInformation (const void *data, int sizeInBytes) override |
| This must restore the filter's state from a block of data previously created using getStateInformation(). More... | |
| void | setParentGraph (AudioProcessorGraph *) |
| Public Member Functions inherited from AudioPluginInstance | |
| virtual | ~AudioPluginInstance () |
| Destructor. More... | |
| PluginDescription | getPluginDescription () const |
| Returns a PluginDescription for this plugin. More... | |
| virtual void * | getPlatformSpecificData () |
| Returns a pointer to some kind of platform-specific data about the plugin. More... | |
| virtual void | refreshParameterList () |
| For some formats (currently AudioUnit), this forces a reload of the list of available parameters. More... | |
| Public Member Functions inherited from AudioProcessor | |
| virtual | ~AudioProcessor () |
| Destructor. More... | |
| virtual void | processBlockBypassed (AudioBuffer< float > &buffer, MidiBuffer &midiMessages) |
| Renders the next block when the processor is being bypassed. More... | |
| virtual void | processBlockBypassed (AudioBuffer< double > &buffer, MidiBuffer &midiMessages) |
| Renders the next block when the processor is being bypassed. More... | |
| virtual bool | setPreferredBusArrangement (bool isInputBus, int busIndex, const AudioChannelSet &preferredSet) |
| Called by the host, this attempts to change the plugin's channel layout on a particular bus. More... | |
| ProcessingPrecision | getProcessingPrecision () const noexcept |
| Returns the precision-mode of the processor. More... | |
| bool | isUsingDoublePrecision () const noexcept |
| Returns true if the current precision is set to doublePrecision. More... | |
| void | setProcessingPrecision (ProcessingPrecision precision) noexcept |
| Changes the processing precision of the receiver. More... | |
| AudioPlayHead * | getPlayHead () const noexcept |
| Returns the current AudioPlayHead object that should be used to find out the state and position of the playhead. More... | |
| int | getTotalNumInputChannels () const noexcept |
| Returns the total number of input channels. More... | |
| int | getTotalNumOutputChannels () const noexcept |
| Returns the total number of output channels. More... | |
| int | getMainBusNumInputChannels () const noexcept |
| Returns the number of input channels on the main bus. More... | |
| int | getMainBusNumOutputChannels () const noexcept |
| Returns the number of output channels on the main bus. More... | |
| double | getSampleRate () const noexcept |
| Returns the current sample rate. More... | |
| int | getBlockSize () const noexcept |
| Returns the current typical block size that is being used. More... | |
| int | getLatencySamples () const noexcept |
| This returns the number of samples delay that the filter imposes on the audio passing through it. More... | |
| void | setLatencySamples (int newLatency) |
| The filter should call this to set the number of samples delay that it introduces. More... | |
| virtual bool | supportsMPE () const |
| Returns true if the processor supports MPE. More... | |
| const CriticalSection & | getCallbackLock () const noexcept |
| This returns a critical section that will automatically be locked while the host is calling the processBlock() method. More... | |
| void | suspendProcessing (bool shouldBeSuspended) |
| Enables and disables the processing callback. More... | |
| bool | isSuspended () const noexcept |
| Returns true if processing is currently suspended. More... | |
| virtual void | reset () |
| A plugin can override this to be told when it should reset any playing voices. More... | |
| bool | isNonRealtime () const noexcept |
| Returns true if the processor is being run in an offline mode for rendering. More... | |
| virtual void | setNonRealtime (bool isNonRealtime) noexcept |
| Called by the host to tell this processor whether it's being used in a non-realtime capacity for offline rendering or bouncing. More... | |
| AudioProcessorEditor * | getActiveEditor () const noexcept |
| Returns the active editor, if there is one. More... | |
| AudioProcessorEditor * | createEditorIfNeeded () |
| Returns the active editor, or if there isn't one, it will create one. More... | |
| virtual int | getNumParameters () |
| This must return the correct value immediately after the object has been created, and mustn't change the number of parameters later. More... | |
| virtual const String | getParameterName (int parameterIndex) |
| Returns the name of a particular parameter. More... | |
| virtual float | getParameter (int parameterIndex) |
| Called by the host to find out the value of one of the filter's parameters. More... | |
| virtual String | getParameterName (int parameterIndex, int maximumStringLength) |
| Returns the name of a parameter as a text string with a preferred maximum length. More... | |
| virtual const String | getParameterText (int parameterIndex) |
| Returns the value of a parameter as a text string. More... | |
| virtual String | getParameterText (int parameterIndex, int maximumStringLength) |
| Returns the value of a parameter as a text string with a preferred maximum length. More... | |
| virtual int | getParameterNumSteps (int parameterIndex) |
| Returns the number of discrete steps that this parameter can represent. More... | |
| virtual float | getParameterDefaultValue (int parameterIndex) |
| Returns the default value for the parameter. More... | |
| virtual String | getParameterLabel (int index) const |
| Some plugin types may be able to return a label string for a parameter's units. More... | |
| virtual bool | isParameterOrientationInverted (int index) const |
| This can be overridden to tell the host that particular parameters operate in the reverse direction. More... | |
| virtual void | setParameter (int parameterIndex, float newValue) |
| The host will call this method to change the value of one of the filter's parameters. More... | |
| void | setParameterNotifyingHost (int parameterIndex, float newValue) |
| Your filter can call this when it needs to change one of its parameters. More... | |
| virtual bool | isParameterAutomatable (int parameterIndex) const |
| Returns true if the host can automate this parameter. More... | |
| virtual bool | isMetaParameter (int parameterIndex) const |
| Should return true if this parameter is a "meta" parameter. More... | |
| void | beginParameterChangeGesture (int parameterIndex) |
| Sends a signal to the host to tell it that the user is about to start changing this parameter. More... | |
| void | endParameterChangeGesture (int parameterIndex) |
| Tells the host that the user has finished changing this parameter. More... | |
| void | updateHostDisplay () |
| The filter can call this when something (apart from a parameter value) has changed. More... | |
| void | addParameter (AudioProcessorParameter *) |
| Adds a parameter to the list. More... | |
| const OwnedArray< AudioProcessorParameter > & | getParameters () const noexcept |
| Returns the current list of parameters. More... | |
| virtual void | getCurrentProgramStateInformation (juce::MemoryBlock &destData) |
| The host will call this method if it wants to save the state of just the filter's current program. More... | |
| virtual void | setCurrentProgramStateInformation (const void *data, int sizeInBytes) |
| The host will call this method if it wants to restore the state of just the filter's current program. More... | |
| virtual void | numChannelsChanged () |
| This method is called when the number of input or output channels is changed. More... | |
| virtual void | addListener (AudioProcessorListener *newListener) |
| Adds a listener that will be called when an aspect of this processor changes. More... | |
| virtual void | removeListener (AudioProcessorListener *listenerToRemove) |
| Removes a previously added listener. More... | |
| virtual void | setPlayHead (AudioPlayHead *newPlayHead) |
| Tells the processor to use this playhead object. More... | |
| void | setPlayConfigDetails (int numIns, int numOuts, double sampleRate, int blockSize) |
| This is called by the processor to specify its details before being played. More... | |
| void | setRateAndBufferSizeDetails (double sampleRate, int blockSize) noexcept |
| This is called by the processor to specify its details before being played. More... | |
| void | editorBeingDeleted (AudioProcessorEditor *) noexcept |
| Not for public use - this is called before deleting an editor component. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from AudioProcessor | |
| static int | getDefaultNumParameterSteps () noexcept |
| Returns the default number of steps for a parameter. More... | |
| static void | copyXmlToBinary (const XmlElement &xml, juce::MemoryBlock &destData) |
| Helper function that just converts an xml element into a binary blob. More... | |
| static XmlElement * | getXmlFromBinary (const void *data, int sizeInBytes) |
| Retrieves an XML element that was stored as binary with the copyXmlToBinary() method. More... | |
| static void JUCE_CALLTYPE | setTypeOfNextNewPlugin (WrapperType) |
| Public Attributes inherited from AudioProcessor | |
| AudioBusArrangement | busArrangement |
| The processor's bus arrangement. More... | |
| WrapperType | wrapperType |
| When loaded by a plugin wrapper, this flag will be set to indicate the type of plugin within which the processor is running. More... | |
| Protected Member Functions inherited from AudioPluginInstance | |
| AudioPluginInstance () | |
| Protected Member Functions inherited from AudioProcessor | |
| AudioProcessor () | |
| Constructor. More... | |
| void | sendParamChangeMessageToListeners (int parameterIndex, float newValue) |
| Protected Attributes inherited from AudioProcessor | |
| AudioPlayHead * | playHead |
A special type of AudioProcessor that can live inside an AudioProcessorGraph in order to use the audio that comes into and out of the graph itself.
If you create an AudioGraphIOProcessor in "input" mode, it will act as a node in the graph which delivers the audio that is coming into the parent graph. This allows you to stream the data to other nodes and process the incoming audio.
Likewise, one of these in "output" mode can be sent data which it will add to the sum of data being sent to the graph's output.
Specifies the mode in which this processor will operate.
| AudioProcessorGraph::AudioGraphIOProcessor::AudioGraphIOProcessor | ( | const IODeviceType | type | ) |
| AudioProcessorGraph::AudioGraphIOProcessor::~AudioGraphIOProcessor | ( | ) |
|
noexcept |
Returns the mode of this processor.
|
noexcept |
Returns the parent graph to which this processor belongs, or nullptr if it hasn't yet been added to one.
References AudioProcessor::acceptsMidi(), AudioProcessor::changeProgramName(), AudioProcessor::createEditor(), AudioPluginInstance::fillInPluginDescription(), AudioProcessor::getCurrentProgram(), AudioProcessor::getName(), AudioProcessor::getNumPrograms(), AudioProcessor::getProgramName(), AudioProcessor::getStateInformation(), AudioProcessor::getTailLengthSeconds(), AudioProcessor::hasEditor(), JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR, AudioProcessor::prepareToPlay(), AudioProcessor::processBlock(), AudioProcessor::producesMidi(), AudioProcessor::releaseResources(), AudioProcessor::reset(), AudioProcessor::setCurrentProgram(), AudioProcessor::setNonRealtime(), AudioProcessor::setPlayHead(), AudioProcessor::setStateInformation(), and AudioProcessor::supportsDoublePrecisionProcessing().
|
noexcept |
True if this is an audio or midi input.
|
noexcept |
True if this is an audio or midi output.
|
overridevirtual |
Returns the name of this processor.
Implements AudioProcessor.
|
overridevirtual |
Fills-in the appropriate parts of this plugin description object.
Implements AudioPluginInstance.
|
overridevirtual |
Called before playback starts, to let the filter 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 busArrangement 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.
Implements AudioProcessor.
|
overridevirtual |
Called after playback has stopped, to let the filter free up any resources it no longer needs.
Implements AudioProcessor.
|
overridevirtual |
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 filter is using. It will be filled with the filter's input data and should be replaced with the filter's output.
So for example if your filter 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 filter should read these, do its processing, and replace the contents of all 4 channels with its output.
Or if your filter has a total of 5 inputs and 2 outputs, the buffer will have 5 channels, all filled with data, and your filter 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 AudioBusArrangement::getBusBuffer to obtain an 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 filter is supposed to be using.
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 filter 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 filter's midi output. This means that your filter should be careful to clear any incoming messages from the array if it doesn't want them to be passed-on.
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.
Implements AudioProcessor.
|
overridevirtual |
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 filter is using. It will be filled with the filter's input data and should be replaced with the filter's output.
So for example if your filter 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 filter should read these, do its processing, and replace the contents of all 4 channels with its output.
Or if your filter has 5 inputs and 2 outputs, the buffer will have 5 channels, all filled with data, and your filter 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 AudioBusArrangement::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 filter is supposed to be using.
If your plugin uses buses, then you should use AudioBusArrangement::getBusBuffer() or AudioBusArrangement::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 filter 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 filter's midi output. This means that your filter should be careful to clear any incoming messages from the array if it doesn't want them to be passed-on.
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.
Reimplemented from AudioProcessor.
|
overridevirtual |
Returns true if the Audio processor supports double precision floating point processing.
The default implementation will always return false. If you return true here then you must override the double precision versions of processBlock. Additionally, you must call getProcessingPrecision() in your prepareToPlay method to determine the precision with which you need to allocate your internal buffers.
Reimplemented from AudioProcessor.
|
overridevirtual |
Returns the length of the filter's tail, in seconds.
Implements AudioProcessor.
|
overridevirtual |
Returns true if the processor wants midi messages.
Implements AudioProcessor.
|
overridevirtual |
Returns true if the processor produces midi messages.
Implements AudioProcessor.
|
overridevirtual |
Your filter must override this and return true if it can create an editor component.
Implements AudioProcessor.
|
overridevirtual |
Creates the filter's UI.
This can return nullptr if you want a UI-less filter, 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 filter 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 filter 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:
Implements AudioProcessor.
|
overridevirtual |
Returns the number of preset programs the filter 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.
Implements AudioProcessor.
|
overridevirtual |
Returns the number of the currently active program.
Implements AudioProcessor.
|
overridevirtual |
Called by the host to change the current program.
Implements AudioProcessor.
|
overridevirtual |
Must return the name of a given program.
Implements AudioProcessor.
|
overridevirtual |
Called by the host to rename a program.
Implements AudioProcessor.
|
overridevirtual |
The host will call this method when it wants to save the filter's internal state.
This must copy any info about the filter'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 filter.
See also the helper function copyXmlToBinary() for storing settings as XML.
Implements AudioProcessor.
|
overridevirtual |
This must restore the filter's state from a block of data previously created using getStateInformation().
Note that there's also a setCurrentProgramStateInformation() method, which tries to restore just the current program, not the state of the entire filter.
See also the helper function getXmlFromBinary() for loading settings as XML.
Implements AudioProcessor.
| void AudioProcessorGraph::AudioGraphIOProcessor::setParentGraph | ( | AudioProcessorGraph * | ) |
