CLAM-Development
1.4.0
|
#include <SimpleOscillator.hxx>
Public Member Functions | |
SimpleOscillator (const SimpleOscillatorConfig &c=Config()) | |
virtual | ~SimpleOscillator () |
const char * | GetClassName () const |
Override it in every subclass and retur the name of that class. | |
virtual const ProcessingConfig & | GetConfig () const |
Configuration getter. | |
virtual bool | ConcreteConfigure (const ProcessingConfig &c) |
Configuration method interface. | |
virtual bool | Do (void) |
Supervised mode execution method (using ports) | |
bool | Do (Audio &out) |
bool | Do (TData &out) |
Do for generating one sample at a time: useful to use the oscillator as a LFO. | |
![]() | |
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 Types | |
typedef SimpleOscillatorConfig | Config |
Protected Member Functions | |
void | ApplyFreqAndAmpControls () |
void | UpdateFreq (TControlData) |
void | UpdateAmp (TControlData) |
![]() | |
virtual bool | ConcreteStart () |
Processing objects have to redefine this method when starting them implies some internal changes. | |
virtual bool | ConcreteStop () |
Processing objects have to redefine this method when stoping them implies some internal changes. | |
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) |
Protected Attributes | |
AudioOutPort | mOutput |
SimpleOscillatorConfig | mConfig |
TData | mAmp |
TData | mPhase |
TData | mDeltaPhase |
TData | mSamplingRate |
bool | mFreqUpdated |
bool | mAmpUpdated |
FloatInControl | mFreqCtl |
FloatInControl | mAmpCtl |
FloatInControl | mSamplesBetweenCallsCtl |
![]() | |
ProcessingComposite * | mpParent |
Pointer to the parent (composite) processing object, or 0. | |
Network * | _network |
The parent network if any. |
Additional Inherited Members | |
![]() | |
enum | ExecState { Unconfigured = 0, Ready, Running } |
Processing Object possible execution states. More... |
Definition at line 84 of file SimpleOscillator.hxx.
|
protected |
Reimplemented from CLAM::Processing.
Definition at line 87 of file SimpleOscillator.hxx.
CLAM::SimpleOscillator::SimpleOscillator | ( | const SimpleOscillatorConfig & | c = Config() | ) |
Definition at line 56 of file SimpleOscillator.cxx.
References CLAM::Processing::Configure().
|
virtual |
Definition at line 67 of file SimpleOscillator.cxx.
|
inlineprotected |
Definition at line 104 of file SimpleOscillator.hxx.
References CLAM::InControl< ControlDataType >::GetLastValue(), mAmp, mAmpCtl, mAmpUpdated, mDeltaPhase, mFreqCtl, mFreqUpdated, mSamplingRate, and PI.
Referenced by Do().
|
virtual |
Configuration method interface.
The Processing base class forces all the concrete classes derived from it to implement this method, which must actually perform the specific configuration tasks.
Note that the user can not call this method directly. He will use Configure instead. The argument is expected to be an object of the necesary concrete configuration class.
Reference | to the configuration object. |
true if the processing object is left in a consistent state, and can be executed.
This | method must throw a bad_cast exception if the argument is not an object of the expected configuration class. |
Reimplemented from CLAM::Processing.
Reimplemented in CLAM::Oscillator.
Definition at line 71 of file SimpleOscillator.cxx.
References CLAM::Processing::CopyAsConcreteConfig(), CLAM::InControl< ControlDataType >::DoControl(), mAmp, mConfig, mDeltaPhase, mPhase, mSamplesBetweenCallsCtl, mSamplingRate, and PI.
|
virtual |
Supervised mode execution method (using ports)
Implements CLAM::Processing.
Reimplemented in CLAM::Oscillator.
Definition at line 85 of file SimpleOscillator.cxx.
References CLAM::AudioOutPort::GetAudio(), mOutput, and CLAM::OutPort< Token >::Produce().
Referenced by CLAM::SpectralAmplitudeModulation::Do(), CLAM::SpectralRingModulation::Do(), CLAM::SpectralPhaseModulation::Do(), CLAM::ThreeBandAM::Do(), and CLAM::OscillatingSpectralNotch::Do().
bool CLAM::SimpleOscillator::Do | ( | Audio & | out | ) |
Reimplemented in CLAM::Oscillator.
Definition at line 93 of file SimpleOscillator.cxx.
References CLAM::Processing::AbleToExecute(), ApplyFreqAndAmpControls(), CLAM::Audio::GetSize(), mAmp, mDeltaPhase, mPhase, and PI.
bool CLAM::SimpleOscillator::Do | ( | TData & | out | ) |
Do for generating one sample at a time: useful to use the oscillator as a LFO.
Definition at line 113 of file SimpleOscillator.cxx.
References CLAM::Processing::AbleToExecute(), ApplyFreqAndAmpControls(), CLAM::InControl< ControlDataType >::GetLastValue(), mAmp, mDeltaPhase, mPhase, mSamplesBetweenCallsCtl, and PI.
|
inlinevirtual |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Reimplemented in CLAM::Oscillator.
Definition at line 127 of file SimpleOscillator.hxx.
|
inlinevirtual |
Configuration getter.
Gets the configuration parameters used to create the object.
Reimplemented from CLAM::Processing.
Reimplemented in CLAM::Oscillator.
Definition at line 129 of file SimpleOscillator.hxx.
References mConfig.
|
protected |
Definition at line 134 of file SimpleOscillator.cxx.
References mAmpUpdated.
|
protected |
Definition at line 129 of file SimpleOscillator.cxx.
References mFreqUpdated.
|
protected |
Definition at line 90 of file SimpleOscillator.hxx.
Referenced by ApplyFreqAndAmpControls(), CLAM::Oscillator::ConcreteConfigure(), ConcreteConfigure(), CLAM::Oscillator::Do(), and Do().
|
protected |
Definition at line 98 of file SimpleOscillator.hxx.
Referenced by ApplyFreqAndAmpControls().
|
protected |
Definition at line 96 of file SimpleOscillator.hxx.
Referenced by ApplyFreqAndAmpControls(), and UpdateAmp().
|
protected |
Definition at line 89 of file SimpleOscillator.hxx.
Referenced by ConcreteConfigure(), and GetConfig().
|
protected |
Definition at line 92 of file SimpleOscillator.hxx.
Referenced by ApplyFreqAndAmpControls(), CLAM::Oscillator::ConcreteConfigure(), ConcreteConfigure(), CLAM::Oscillator::Do(), and Do().
|
protected |
Definition at line 97 of file SimpleOscillator.hxx.
Referenced by ApplyFreqAndAmpControls().
|
protected |
Definition at line 95 of file SimpleOscillator.hxx.
Referenced by ApplyFreqAndAmpControls(), and UpdateFreq().
|
protected |
Definition at line 88 of file SimpleOscillator.hxx.
Referenced by CLAM::Oscillator::Do(), and Do().
|
protected |
Definition at line 91 of file SimpleOscillator.hxx.
Referenced by CLAM::Oscillator::ConcreteConfigure(), ConcreteConfigure(), CLAM::Oscillator::Do(), and Do().
|
protected |
Definition at line 100 of file SimpleOscillator.hxx.
Referenced by ConcreteConfigure(), and Do().
|
protected |
Definition at line 93 of file SimpleOscillator.hxx.
Referenced by ApplyFreqAndAmpControls(), CLAM::Oscillator::ConcreteConfigure(), and ConcreteConfigure().