Abstract base class for creating processors.
More...
#include <GenericProcessor.h>
List of all members.
Public Member Functions |
| GenericProcessor (const String &name_) |
virtual | ~GenericProcessor () |
const String | getName () const |
virtual void | prepareToPlay (double sampleRate, int estimatedSamplesPerBlock) |
void | releaseResources () |
virtual void | setParameter (int parameterIndex, float newValue) |
virtual AudioProcessorEditor * | createEditor () |
bool | hasEditor () const |
void | reset () |
void | setCurrentProgramStateInformation (const void *data, int sizeInBytes) |
void | setStateInformation (const void *data, int sizeInBytes) |
void | getCurrentProgramStateInformation (MemoryBlock &destData) |
void | getStateInformation (MemoryBlock &destData) |
void | changeProgramName (int index, const String &newName) |
void | setCurrentProgram (int index) |
const String | getInputChannelName (int channelIndex) const |
const String | getOutputChannelName (int channelIndex) const |
const String | getParameterName (int parameterIndex) |
const String | getParameterText (int parameterIndex) |
const String | getProgramName (int index) |
bool | isInputChannelStereoPair (int index) const |
bool | isOutputChannelStereoPair (int index) const |
bool | acceptsMidi () const |
bool | producesMidi () const |
bool | isParameterAutomatable (int parameterIndex) |
bool | isMetaParameter (int parameterIndex) |
int | getNumParameters () |
int | getNumPrograms () |
int | getCurrentProgram () |
float | getParameter (int parameterIndex) |
Parameter & | getParameterByName (String parameterName) |
Parameter & | getParameterReference (int parameterIndex) |
virtual void | process (AudioSampleBuffer &, MidiBuffer &, int &)=0 |
virtual float | getSampleRate () |
virtual float | getDefaultSampleRate () |
virtual int | getNumInputs () |
virtual int | getNumOutputs () |
virtual int | getDefaultNumOutputs () |
virtual float | getDefaultBitVolts () |
virtual int | getNextChannel (bool) |
virtual void | resetConnections () |
virtual void | setCurrentChannel (int chan) |
int | getNodeId () |
void | setNodeId (int id) |
GenericProcessor * | getSourceNode () |
GenericProcessor * | getDestNode () |
virtual void | switchIO (int) |
virtual void | switchIO () |
virtual void | setPathToProcessor (GenericProcessor *p) |
virtual void | setSourceNode (GenericProcessor *sn) |
virtual void | setDestNode (GenericProcessor *dn) |
virtual void | setMergerSourceNode (GenericProcessor *sn) |
virtual void | setSplitterDestNode (GenericProcessor *dn) |
virtual bool | isSource () |
virtual bool | isSink () |
virtual bool | isSplitter () |
virtual bool | isMerger () |
virtual bool | canSendSignalTo (GenericProcessor *) |
virtual bool | isReady () |
virtual bool | enable () |
virtual bool | disable () |
virtual bool | enabledState () |
virtual void | enabledState (bool t) |
virtual void | enableCurrentChannel (bool) |
virtual bool | stillHasSource () |
virtual AudioSampleBuffer * | getContinuousBuffer () |
virtual MidiBuffer * | getEventBuffer () |
virtual int | checkForEvents (MidiBuffer &mb) |
virtual void | addEvent (MidiBuffer &mb, uint8 type, int sampleNum, uint8 eventID=0, uint8 eventChannel=0, uint8 numBytes=0, uint8 *data=0) |
virtual void | handleEvent (int eventType, MidiMessage &event) |
virtual GenericEditor * | getEditor () |
virtual bool | isAudioOrRecordNode () |
virtual bool | recordStatus (int chan) |
virtual bool | audioStatus (int chan) |
virtual void | clearSettings () |
virtual void | generateDefaultChannelNames (StringArray &) |
virtual void | update () |
virtual void | updateSettings () |
void | setStartChannel (int i) |
int | getStartChannel () |
| AccessClass () |
| ~AccessClass () |
void | setUIComponent (UIComponent *) |
virtual void | updateChildComponents () |
EditorViewport * | getEditorViewport () |
DataViewport * | getDataViewport () |
ProcessorList * | getProcessorList () |
ProcessorGraph * | getProcessorGraph () |
ControlPanel * | getControlPanel () |
MessageCenter * | getMessageCenter () |
UIComponent * | getUIComponent () |
AudioComponent * | getAudioComponent () |
Detailed Description
Abstract base class for creating processors.
All processors must be derived from this class, and must provide an implementation of the process() method.
Any processors that are not filters must override the isSource(), isSink(), isSplitter(), and isMerger() methods.
- See also:
- ProcessorGraph, GenericEditor, SourceNode, FilterNode, LfpDisplayNode
Member Enumeration Documentation
- Enumerator:
GENERIC_EVENT |
|
SINGLE_ELECTRODE |
|
STEREOTRODE |
|
TETRODE |
|
- Enumerator:
TIMESTAMP |
|
BUFFER_SIZE |
|
PARAMETER_CHANGE |
|
TTL |
|
SPIKE |
|
EEG |
|
CONTINUOUS |
|
Constructor & Destructor Documentation
GenericProcessor::GenericProcessor |
( |
const String & |
name_ | ) |
|
virtual GenericProcessor::~GenericProcessor |
( |
| ) |
|
|
virtual |
Member Function Documentation
bool GenericProcessor::acceptsMidi |
( |
| ) |
const |
|
inline |
virtual void GenericProcessor::addEvent |
( |
MidiBuffer & |
mb, |
|
|
uint8 |
type, |
|
|
int |
sampleNum, |
|
|
uint8 |
eventID = 0 , |
|
|
uint8 |
eventChannel = 0 , |
|
|
uint8 |
numBytes = 0 , |
|
|
uint8 * |
data = 0 |
|
) |
| |
|
virtual |
virtual bool GenericProcessor::audioStatus |
( |
int |
chan | ) |
|
|
virtual |
void GenericProcessor::changeProgramName |
( |
int |
index, |
|
|
const String & |
newName |
|
) |
| |
|
inline |
virtual int GenericProcessor::checkForEvents |
( |
MidiBuffer & |
mb | ) |
|
|
virtual |
virtual void GenericProcessor::clearSettings |
( |
| ) |
|
|
virtual |
virtual AudioProcessorEditor* GenericProcessor::createEditor |
( |
| ) |
|
|
virtual |
Reimplemented in SpikeDetector, SourceNode, WiFiOutput, EventNode, SpikeDisplayNode, AudioNode, SignalGenerator, FilterNode, LfpDisplayNode, Splitter, and Merger.
virtual bool GenericProcessor::disable |
( |
| ) |
|
|
inlinevirtual |
virtual bool GenericProcessor::enable |
( |
| ) |
|
|
inlinevirtual |
virtual void GenericProcessor::enableCurrentChannel |
( |
bool |
| ) |
|
|
inlinevirtual |
virtual bool GenericProcessor::enabledState |
( |
| ) |
|
|
inlinevirtual |
virtual void GenericProcessor::enabledState |
( |
bool |
t | ) |
|
|
inlinevirtual |
virtual void GenericProcessor::generateDefaultChannelNames |
( |
StringArray & |
| ) |
|
|
virtual |
virtual AudioSampleBuffer* GenericProcessor::getContinuousBuffer |
( |
| ) |
|
|
inlinevirtual |
int GenericProcessor::getCurrentProgram |
( |
| ) |
|
|
inline |
void GenericProcessor::getCurrentProgramStateInformation |
( |
MemoryBlock & |
destData | ) |
|
|
inline |
virtual float GenericProcessor::getDefaultBitVolts |
( |
| ) |
|
|
inlinevirtual |
virtual int GenericProcessor::getDefaultNumOutputs |
( |
| ) |
|
|
inlinevirtual |
virtual float GenericProcessor::getDefaultSampleRate |
( |
| ) |
|
|
inlinevirtual |
virtual MidiBuffer* GenericProcessor::getEventBuffer |
( |
| ) |
|
|
inlinevirtual |
const String GenericProcessor::getInputChannelName |
( |
int |
channelIndex | ) |
const |
|
inline |
const String GenericProcessor::getName |
( |
| ) |
const |
|
inline |
virtual int GenericProcessor::getNextChannel |
( |
bool |
| ) |
|
|
virtual |
int GenericProcessor::getNodeId |
( |
| ) |
|
|
inline |
virtual int GenericProcessor::getNumInputs |
( |
| ) |
|
|
inlinevirtual |
virtual int GenericProcessor::getNumOutputs |
( |
| ) |
|
|
inlinevirtual |
int GenericProcessor::getNumParameters |
( |
| ) |
|
|
inline |
int GenericProcessor::getNumPrograms |
( |
| ) |
|
|
inline |
const String GenericProcessor::getOutputChannelName |
( |
int |
channelIndex | ) |
const |
|
inline |
float GenericProcessor::getParameter |
( |
int |
parameterIndex | ) |
|
|
inline |
Parameter& GenericProcessor::getParameterByName |
( |
String |
parameterName | ) |
|
const String GenericProcessor::getParameterName |
( |
int |
parameterIndex | ) |
|
Parameter& GenericProcessor::getParameterReference |
( |
int |
parameterIndex | ) |
|
const String GenericProcessor::getParameterText |
( |
int |
parameterIndex | ) |
|
const String GenericProcessor::getProgramName |
( |
int |
index | ) |
|
|
inline |
virtual float GenericProcessor::getSampleRate |
( |
| ) |
|
|
inlinevirtual |
int GenericProcessor::getStartChannel |
( |
| ) |
|
|
inline |
void GenericProcessor::getStateInformation |
( |
MemoryBlock & |
destData | ) |
|
|
inline |
virtual void GenericProcessor::handleEvent |
( |
int |
eventType, |
|
|
MidiMessage & |
event |
|
) |
| |
|
inlinevirtual |
bool GenericProcessor::hasEditor |
( |
| ) |
const |
|
inline |
virtual bool GenericProcessor::isAudioOrRecordNode |
( |
| ) |
|
|
inlinevirtual |
bool GenericProcessor::isInputChannelStereoPair |
( |
int |
index | ) |
const |
|
inline |
virtual bool GenericProcessor::isMerger |
( |
| ) |
|
|
inlinevirtual |
bool GenericProcessor::isMetaParameter |
( |
int |
parameterIndex | ) |
|
|
inline |
bool GenericProcessor::isOutputChannelStereoPair |
( |
int |
index | ) |
const |
|
inline |
bool GenericProcessor::isParameterAutomatable |
( |
int |
parameterIndex | ) |
|
|
inline |
virtual bool GenericProcessor::isReady |
( |
| ) |
|
|
inlinevirtual |
virtual bool GenericProcessor::isSink |
( |
| ) |
|
|
inlinevirtual |
virtual bool GenericProcessor::isSource |
( |
| ) |
|
|
inlinevirtual |
virtual bool GenericProcessor::isSplitter |
( |
| ) |
|
|
inlinevirtual |
virtual void GenericProcessor::prepareToPlay |
( |
double |
sampleRate, |
|
|
int |
estimatedSamplesPerBlock |
|
) |
| |
|
virtual |
virtual void GenericProcessor::process |
( |
AudioSampleBuffer & |
, |
|
|
MidiBuffer & |
, |
|
|
int & |
|
|
) |
| |
|
pure virtual |
Implemented in SpikeDetector, SpikeDisplayNode, SourceNode, WiFiOutput, ResamplingNode, LfpDisplayNode, RecordNode, AudioNode, Splitter, Merger, FilterNode, SignalGenerator, and EventNode.
bool GenericProcessor::producesMidi |
( |
| ) |
const |
|
inline |
virtual bool GenericProcessor::recordStatus |
( |
int |
chan | ) |
|
|
virtual |
void GenericProcessor::releaseResources |
( |
| ) |
|
void GenericProcessor::reset |
( |
| ) |
|
|
inline |
virtual void GenericProcessor::resetConnections |
( |
| ) |
|
|
virtual |
virtual void GenericProcessor::setCurrentChannel |
( |
int |
chan | ) |
|
|
inlinevirtual |
void GenericProcessor::setCurrentProgram |
( |
int |
index | ) |
|
|
inline |
void GenericProcessor::setCurrentProgramStateInformation |
( |
const void * |
data, |
|
|
int |
sizeInBytes |
|
) |
| |
|
inline |
void GenericProcessor::setNodeId |
( |
int |
id | ) |
|
|
inline |
virtual void GenericProcessor::setParameter |
( |
int |
parameterIndex, |
|
|
float |
newValue |
|
) |
| |
|
virtual |
void GenericProcessor::setStartChannel |
( |
int |
i | ) |
|
|
inline |
void GenericProcessor::setStateInformation |
( |
const void * |
data, |
|
|
int |
sizeInBytes |
|
) |
| |
|
inline |
virtual bool GenericProcessor::stillHasSource |
( |
| ) |
|
|
inlinevirtual |
virtual void GenericProcessor::switchIO |
( |
int |
| ) |
|
|
inlinevirtual |
virtual void GenericProcessor::switchIO |
( |
| ) |
|
|
inlinevirtual |
virtual void GenericProcessor::update |
( |
| ) |
|
|
virtual |
virtual void GenericProcessor::updateSettings |
( |
| ) |
|
|
inlinevirtual |
Member Data Documentation
int GenericProcessor::currentChannel |
bool GenericProcessor::isEnabled |
int GenericProcessor::loadOrder |
int GenericProcessor::nextAvailableChannel |
int GenericProcessor::nodeId |
StringArray GenericProcessor::parameterNames |
Array<Parameter> GenericProcessor::parameters |
int GenericProcessor::saveOrder |
bool GenericProcessor::wasConnected |
The documentation for this class was generated from the following file: