Public Member Functions | Protected Attributes | List of all members
MidiProcessor Class Referenceabstract

A MidiProcessor processes a MidiBuffer. More...

Inheritance diagram for MidiProcessor:
Processor SafeChangeBroadcaster RestorableObject ControlledObject Dispatchable MidiDelay SampleRaster ScriptBaseMidiProcessor Transposer HardcodedScriptProcessor JavascriptMidiProcessor Arpeggiator CCSwapper ChannelFilterScriptProcessor ChannelSetterScriptProcessor DemoHardcodedScriptProcessor LegatoProcessor MuteAllScriptProcessor ReleaseTriggerScriptProcessor

Public Member Functions

virtual ProcessorEditorBodycreateEditor (ProcessorEditor *parentEditor) override
 If you want an editor that is more than the header, overwrite this method and return a subclass of ProcessorEditorBody. More...
 
virtual ProcessorgetChildProcessor (int) override
 Normally a MidiProcessor has no child processors, but it is virtual for the MidiProcessorChain. More...
 
virtual int getNumChildProcessors () const override
 Normally a MidiProcessor has no child processors, but it is virtual for the MidiProcessorChain. More...
 
void ignoreEvent ()
 If this method is called within processMidiMessage(), the message will be ignored. More...
 
 MidiProcessor (MainController *m, const String &id)
 Creates a new MidiProcessor. More...
 
virtual void processHiseEvent (HiseEvent &e)=0
 Process the incoming event. More...
 
- Public Member Functions inherited from Processor
void enableConsoleOutput (bool shouldBeEnabled)
 Enables the Processor to output messages to the Console. More...
 
virtual ValueTree exportAsValueTree () const override
 This saves the Processor. More...
 
virtual float getAttribute (int parameterIndex) const =0
 returns the attribute with the specified index (use a enum in the derived class). More...
 
virtual float getDefaultValue (int) const
 Overwrite this and return the default value. More...
 
bool getEditorState (int state) const
 Restores the state of the Processor's editor. More...
 
const String & getId () const
 Returns the unique id of the Processor instance (!= the Processor name). More...
 
virtual Identifier getIdentifierForParameterIndex (int parameterIndex) const
 This returns a Identifier with the name of the parameter. More...
 
float getInputValue () const
 This can be used to display the Processors input value. More...
 
int getLargestBlockSize () const
 Returns the block size. More...
 
virtual const String getName () const
 Overwrite this and return a pretty name. More...
 
virtual int getNumInternalChains () const
 If your processor uses internal chains, you can return the number here. More...
 
int getNumParameters () const
 This returns the number of (named) parameters. More...
 
float getOutputValue () const
 This can be used to display the Processors output value. More...
 
double getSampleRate () const
 Returns the sample rate. More...
 
const Path getSymbol () const
 Returns the symbol of the Processor. More...
 
virtual const Identifier getType () const =0
 Overwrite this method to specify the name. More...
 
int getVoiceAmount () const noexcept
 getNumVoices() is occupied by the Synthesiser class, d'oh!
 
bool isBypassed () const noexcept
 Returns true if the processor is bypassed. More...
 
virtual void prepareToPlay (double sampleRate_, int samplesPerBlock_)
 Sets the sample rate and the block size. More...
 
 Processor (MainController *m, const String &id_, int numVoices)
 Creates a new Processor with the given Identifier. More...
 
void restoreCompleteEditorState (const XmlElement *storedState)
 Restores the EditorState from a BigInteger that was retrieved using getCompleteEditorState. More...
 
virtual void restoreFromValueTree (const ValueTree &previouslyExportedProcessorState) override
 Restores a previously saved ValueTree. More...
 
void setAttribute (int parameterIndex, float newValue, juce::NotificationType notifyEditor)
 Changes a Processor parameter. More...
 
virtual void setBypassed (bool shouldBeBypassed, NotificationType notifyChangeHandler=dontSendNotification) noexcept
 This bypasses the processor. More...
 
void setEditorState (int state, bool isOn, NotificationType notifyView=sendNotification)
 Saves the state of the Processor's editor. More...
 
void setIsOnAir (bool isBeingProcessedInAudioThread)
 Call this method after inserting the processor in the signal chain. More...
 
void setSymbol (Path newSymbol)
 Sets a special symbol for the Processor. More...
 
virtual ~Processor ()
 Overwrite this if you need custom destruction behaviour. More...
 
- Public Member Functions inherited from SafeChangeBroadcaster
void addChangeListener (SafeChangeListener *listener)
 Registers a listener to receive change callbacks from this broadcaster. More...
 
void removeAllChangeListeners ()
 Removes all listeners from the list. More...
 
void removeChangeListener (SafeChangeListener *listener)
 Unregisters a listener from the list. More...
 
void sendAllocationFreeChangeMessage ()
 This will send a message without allocating a message slot. More...
 
void sendChangeMessage (const String &=String())
 Causes an asynchronous change message to be sent to all the registered listeners. More...
 
void sendSynchronousChangeMessage ()
 Sends a synchronous change message to all the registered listeners. More...
 
- Public Member Functions inherited from ControlledObject
 ControlledObject (MainController *m)
 Creates a new ControlledObject. More...
 
const MainControllergetMainController () const noexcept
 Provides read-only access to the main controller. More...
 
MainControllergetMainController () noexcept
 Provides write access to the main controller. More...
 

Protected Attributes

int samplePos
 the sample position within the processBlock. More...
 

Additional Inherited Members

- Public Types inherited from Processor
enum  InternalChains
 Overwrite this enum and list all internal chains. More...
 
enum  SpecialParameters
 Overwrite this enum and add new parameters. More...
 
- Protected Member Functions inherited from Processor
void setInputValue (float newValue, NotificationType notify=sendNotification)
 Call this from the baseclass whenever you want its editor to display a input value change. More...
 
virtual void setInternalAttribute (int parameterIndex, float newValue)=0
 Changes a Processor parameter. More...
 
void setOutputValue (float newValue)
 Call this from the baseclass whenever you want its editor to display a value change. More...
 

Detailed Description

A MidiProcessor processes a MidiBuffer.

It can be used to change the incoming MIDI data before it is sent to a ModulatorSynth. Note that if you want to create your own MIDI processors, you should use the HardcodedScriptProcessor as base class since it offers a simpler integration of existing Javascript code and a cleaner API.

Constructor & Destructor Documentation

MidiProcessor ( MainController m,
const String &  id 
)

Creates a new MidiProcessor.

You can supply a ModulatorSynth which owns the MidiProcessor to allow the processor to change its properties.

Member Function Documentation

ProcessorEditorBody * createEditor ( ProcessorEditor *  parentEditor)
overridevirtual

If you want an editor that is more than the header, overwrite this method and return a subclass of ProcessorEditorBody.

Implements Processor.

virtual Processor* getChildProcessor ( int  )
inlineoverridevirtual

Normally a MidiProcessor has no child processors, but it is virtual for the MidiProcessorChain.

Implements Processor.

virtual int getNumChildProcessors ( ) const
inlineoverridevirtual

Normally a MidiProcessor has no child processors, but it is virtual for the MidiProcessorChain.

Implements Processor.

void ignoreEvent ( )
inline

If this method is called within processMidiMessage(), the message will be ignored.

virtual void processHiseEvent ( HiseEvent e)
pure virtual

Process the incoming event.

Implemented in SampleRaster.

Member Data Documentation

int samplePos
protected

the sample position within the processBlock.

©2017 HISE. This documentation is autogenerated from the HISE source code using Doxygen.