CLAM-Development
1.4.0
|
#include <Instrument.hxx>
Public Member Functions | |
void | SetId (int id) |
Instrument () | |
void | LinkStateOutWithInControl (Processing *inProc, unsigned inId) |
void | UpdateState (TControlData value) |
void | UpdateNote (TControlData value) |
void | UpdateVel (TControlData value) |
virtual bool | Do (Audio &audio)=0 |
bool | Do (void) |
Supervised mode execution method (using ports) | |
const char * | GetClassName () const |
Override it in every subclass and retur the name of that class. | |
![]() | |
virtual | ~ProcessingComposite () |
virtual const ProcessingConfig & | GetConfig () const =0 |
Configuration getter. | |
void | Insert (Processing &o) throw (ErrProcessingObj) |
void | Remove (Processing &o) |
iterator | composite_begin () |
iterator | composite_end () |
std::size_t | composite_size () |
![]() | |
bool | Configure (const ProcessingConfig &config) |
Configuration change method. | |
void | Start (void) |
Method to turn the object into running state. | |
void | Stop (void) |
Method to put the object out of running state When in execution mode, this method must be called before any further call to Configure() methods. | |
Processing () | |
virtual | ~Processing () |
virtual bool | CanProcessInplace () |
Override this method if your processing cannot process inplace. | |
bool | CanConsumeAndProduce () |
Check that Supervised Do() can be safely called. | |
void | ConsumeAndProduce () |
Acknoledges data tokens in published ports as read/writen by calling Produce() for all registered OutPorts and Consume() to all registered InPorts. | |
std::string | GetExecStateString () const |
bool | IsConfigured () const |
bool | IsRunning () const |
void | RegisterOutPort (OutPortBase *out) |
void | RegisterInPort (InPortBase *in) |
void | RegisterOutControl (OutControlBase *out) |
void | RegisterInControl (InControlBase *in) |
void | SetParent (Processing *p) |
void | SetNetworkBackLink (Network *network) |
virtual bool | ModifiesPortsAndControlsAtConfiguration () |
This method is used to determine if a given processing can change its interface of ports/controls after its construction (i.e. | |
bool | HasInPort (const std::string &name) |
bool | HasOutPort (const std::string &name) |
bool | HasInControl (const std::string &name) |
bool | HasOutControl (const std::string &name) |
InPortBase & | GetInPort (const std::string &name) |
OutPortBase & | GetOutPort (const std::string &name) |
InControlBase & | GetInControl (const std::string &name) |
OutControlBase & | GetOutControl (const std::string &name) |
InPortBase & | GetInPort (unsigned index) |
OutPortBase & | GetOutPort (unsigned index) |
InControlBase & | GetInControl (unsigned index) |
OutControlBase & | GetOutControl (unsigned index) |
unsigned | GetNInPorts () const |
unsigned | GetNOutPorts () const |
unsigned | GetNInControls () const |
unsigned | GetNOutControls () const |
const std::string & | GetConfigErrorMessage () const |
Returns a string describing configuration errors if any. | |
virtual bool | IsSyncSource () const |
Wether the processing is a sync source such as audio i/o device, or an audio callback hook (i.e. | |
virtual bool | SupportsVariableAudioSize () const |
This method reports whether the processing supports dynamic buffer-size host. |
Protected Attributes | |
FloatInControl | mStateIn |
FloatInControl | mNoteIn |
FloatInControl | mVelocityIn |
FloatOutControl | mStateOut |
FloatOutControl | mNoteOut |
FloatOutControl | mVelocityOut |
Friends | |
class | Dispatcher |
Additional Inherited Members | |
![]() | |
typedef std::list< Processing * > ::iterator | iterator |
Processing object composite iterator. | |
![]() | |
enum | ExecState { Unconfigured = 0, Ready, Running } |
Processing Object possible execution states. More... | |
typedef NullProcessingConfig | Config |
![]() | |
virtual bool | ConcreteConfigure (const ProcessingConfig &)=0 |
Configuration method interface. | |
virtual bool | ConcreteStart () |
Concrete start implementation, called when the user calls Start() on the Processing(Composite), should be used to implement any specific start implementation required by classes deriving from this class. | |
virtual bool | ConcreteStop () |
See ConcreteStart(). | |
![]() | |
unsigned | BackendBufferSize () |
Given by the NetworkPlayer (backend) if exists. | |
unsigned | BackendSampleRate () |
Given by the NetworkPlayer (backend) if exists. | |
InControlRegistry & | GetInControls () |
Accessor to published Controls manager. | |
OutControlRegistry & | GetOutControls () |
Accessor to published Controls manager. | |
InPortRegistry & | GetInPorts () |
Accessor to published Ports manager. | |
OutPortRegistry & | GetOutPorts () |
Accessor to published Portss manager. | |
bool | AddConfigErrorMessage (const std::string &msg) |
Use this method to append a configuration errors to the processing when implementing ConcreteConfigure. | |
bool | AbleToExecute (void) const |
In debug-mode checks that the processing is configured and started. | |
template<typename ConcreteConfig > | |
void | CopyAsConcreteConfig (ConcreteConfig &concrete, const ProcessingConfig &abstract) const |
Helper template to convert a reference to a ProcessingConfig to the concrete ProcessingConfig specified on the first parameter. | |
void | SetExecState (ExecState state) |
Definition at line 34 of file Instrument.hxx.
|
inline |
Definition at line 59 of file Instrument.hxx.
|
pure virtual |
|
inlinevirtual |
Supervised mode execution method (using ports)
Implements CLAM::ProcessingComposite.
Definition at line 101 of file Instrument.hxx.
References CLAM::AudioOutPort::GetAudio(), and CLAM::OutPort< Token >::Produce().
|
inlinevirtual |
Override it in every subclass and retur the name of that class.
Reimplemented from CLAM::ProcessingComposite.
Definition at line 107 of file Instrument.hxx.
|
inline |
Definition at line 72 of file Instrument.hxx.
References CLAM::OutControlBase::AddLink(), CLAM::Processing::GetInControl(), and CLAM::Processing::GetOutControl().
|
inline |
Definition at line 57 of file Instrument.hxx.
|
inline |
Definition at line 89 of file Instrument.hxx.
References mNoteOut, and CLAM::OutControl< ControlDataType >::SendControl().
|
inline |
Definition at line 78 of file Instrument.hxx.
References mStateOut, and CLAM::OutControl< ControlDataType >::SendControl().
|
inline |
Definition at line 94 of file Instrument.hxx.
References mVelocityOut, and CLAM::OutControl< ControlDataType >::SendControl().
|
friend |
Definition at line 55 of file Instrument.hxx.
|
protected |
Definition at line 47 of file Instrument.hxx.
|
protected |
Definition at line 51 of file Instrument.hxx.
Referenced by UpdateNote().
|
protected |
Definition at line 46 of file Instrument.hxx.
|
protected |
Definition at line 50 of file Instrument.hxx.
Referenced by UpdateState().
|
protected |
Definition at line 48 of file Instrument.hxx.
|
protected |
Definition at line 52 of file Instrument.hxx.
Referenced by UpdateVel().