CLAM-Development  1.4.0
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
CLAM::SimpleOscillator Class Reference

#include <SimpleOscillator.hxx>

List of all members.

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 ProcessingConfigGetConfig () 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.
- Public Member Functions inherited from CLAM::Processing
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)
InPortBaseGetInPort (const std::string &name)
OutPortBaseGetOutPort (const std::string &name)
InControlBaseGetInControl (const std::string &name)
OutControlBaseGetOutControl (const std::string &name)
InPortBaseGetInPort (unsigned index)
OutPortBaseGetOutPort (unsigned index)
InControlBaseGetInControl (unsigned index)
OutControlBaseGetOutControl (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)
- Protected Member Functions inherited from CLAM::Processing
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.
InControlRegistryGetInControls ()
 Accessor to published Controls manager.
OutControlRegistryGetOutControls ()
 Accessor to published Controls manager.
InPortRegistryGetInPorts ()
 Accessor to published Ports manager.
OutPortRegistryGetOutPorts ()
 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
- Protected Attributes inherited from CLAM::Processing
ProcessingCompositempParent
 Pointer to the parent (composite) processing object, or 0.
Network_network
 The parent network if any.

Additional Inherited Members

- Public Types inherited from CLAM::Processing
enum  ExecState { Unconfigured = 0, Ready, Running }
 Processing Object possible execution states. More...

Detailed Description

Definition at line 84 of file SimpleOscillator.hxx.


Member Typedef Documentation

Reimplemented from CLAM::Processing.

Definition at line 87 of file SimpleOscillator.hxx.


Constructor & Destructor Documentation

CLAM::SimpleOscillator::SimpleOscillator ( const SimpleOscillatorConfig c = Config())

Definition at line 56 of file SimpleOscillator.cxx.

References CLAM::Processing::Configure().

CLAM::SimpleOscillator::~SimpleOscillator ( )
virtual

Definition at line 67 of file SimpleOscillator.cxx.


Member Function Documentation

void CLAM::SimpleOscillator::ApplyFreqAndAmpControls ( )
inlineprotected
bool CLAM::SimpleOscillator::ConcreteConfigure ( const ProcessingConfig )
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.

Parameters:
Referenceto the configuration object.
Returns:
false if the object is not yet fully configured. (For example, if some important configuration attribute such as number of ports was set to zero in the config object)

true if the processing object is left in a consistent state, and can be executed.

Exceptions:
Thismethod 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.

bool CLAM::SimpleOscillator::Do ( void  )
virtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

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)
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.

const char* CLAM::SimpleOscillator::GetClassName ( ) const
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.

virtual const ProcessingConfig& CLAM::SimpleOscillator::GetConfig ( ) const
inlinevirtual

Configuration getter.

Gets the configuration parameters used to create the object.

Returns:
Const reference to the configuration object. The usual way to perform a configuration change in the processing object is to take a copy of this reference, to change it and to send it with the Configure method. If not overriden, it returns a NullProcessingConfig.

Reimplemented from CLAM::Processing.

Reimplemented in CLAM::Oscillator.

Definition at line 129 of file SimpleOscillator.hxx.

References mConfig.

void CLAM::SimpleOscillator::UpdateAmp ( TControlData  value)
protected

Definition at line 134 of file SimpleOscillator.cxx.

References mAmpUpdated.

void CLAM::SimpleOscillator::UpdateFreq ( TControlData  value)
protected

Definition at line 129 of file SimpleOscillator.cxx.

References mFreqUpdated.


Member Data Documentation

TData CLAM::SimpleOscillator::mAmp
protected
FloatInControl CLAM::SimpleOscillator::mAmpCtl
protected

Definition at line 98 of file SimpleOscillator.hxx.

Referenced by ApplyFreqAndAmpControls().

bool CLAM::SimpleOscillator::mAmpUpdated
protected

Definition at line 96 of file SimpleOscillator.hxx.

Referenced by ApplyFreqAndAmpControls(), and UpdateAmp().

SimpleOscillatorConfig CLAM::SimpleOscillator::mConfig
protected

Definition at line 89 of file SimpleOscillator.hxx.

Referenced by ConcreteConfigure(), and GetConfig().

TData CLAM::SimpleOscillator::mDeltaPhase
protected
FloatInControl CLAM::SimpleOscillator::mFreqCtl
protected

Definition at line 97 of file SimpleOscillator.hxx.

Referenced by ApplyFreqAndAmpControls().

bool CLAM::SimpleOscillator::mFreqUpdated
protected

Definition at line 95 of file SimpleOscillator.hxx.

Referenced by ApplyFreqAndAmpControls(), and UpdateFreq().

AudioOutPort CLAM::SimpleOscillator::mOutput
protected

Definition at line 88 of file SimpleOscillator.hxx.

Referenced by CLAM::Oscillator::Do(), and Do().

TData CLAM::SimpleOscillator::mPhase
protected
FloatInControl CLAM::SimpleOscillator::mSamplesBetweenCallsCtl
protected

Definition at line 100 of file SimpleOscillator.hxx.

Referenced by ConcreteConfigure(), and Do().

TData CLAM::SimpleOscillator::mSamplingRate
protected

The documentation for this class was generated from the following files: