CLAM-Development
1.4.0
|
This is the processing object class we are using to group several other processing objects. More...
#include <SpectralSynthesis.hxx>
Public Member Functions | |
SpectralSynthesis (const SpectralSynthesisConfig &cfg) | |
SpectralSynthesis () | |
~SpectralSynthesis () | |
const char * | GetClassName () const |
Override it in every subclass and retur the name of that class. | |
const ProcessingConfig & | GetConfig () const |
Configuration getter. | |
bool | Do (void) |
Supervised mode execution. | |
bool | Do (Spectrum &in, Audio &out) |
Unsupervised mode execution. | |
bool | Do (Frame &in) |
bool | Do (Segment &in) |
![]() | |
virtual | ~ProcessingComposite () |
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. |
Public Attributes | |
InPort< Spectrum > | mInput |
Ports. | |
AudioOutPort | mOutput |
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 | 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) |
This is the processing object class we are using to group several other processing objects.
Definition at line 72 of file SpectralSynthesis.hxx.
CLAM::SpectralSynthesis::SpectralSynthesis | ( | const SpectralSynthesisConfig & | cfg | ) |
Definition at line 59 of file SpectralSynthesis.cxx.
References CLAM::Processing::Configure().
CLAM::SpectralSynthesis::SpectralSynthesis | ( | ) |
Definition at line 51 of file SpectralSynthesis.cxx.
References CLAM::Processing::Configure().
CLAM::SpectralSynthesis::~SpectralSynthesis | ( | ) |
Definition at line 67 of file SpectralSynthesis.cxx.
|
virtual |
Supervised mode execution.
Implements CLAM::ProcessingComposite.
Definition at line 164 of file SpectralSynthesis.cxx.
References CLAM::InPort< Token >::Consume(), CLAM::AudioOutPort::GetAudio(), CLAM::InPort< Token >::GetData(), mInput, mOutput, and CLAM::OutPort< Token >::Produce().
Referenced by CLAM::SinusoidalSynthesis::Do(), CLAM::SMSSynthesis::Do(), Do(), and CLAM::SMSSynthesis::SinusoidalSynthesis().
Unsupervised mode execution.
Definition at line 173 of file SpectralSynthesis.cxx.
References CLAM::CircularShift::Do(), CLAM::BinaryAudioOp< BinOp >::Do(), CLAM::SpectralSynthesisConfig::GetAnalWindowSize(), CLAM::Audio::GetAudioChunk(), and CLAM::SpectralSynthesisConfig::GetHopSize().
bool CLAM::SpectralSynthesis::Do | ( | Frame & | in | ) |
Definition at line 193 of file SpectralSynthesis.cxx.
References Do().
bool CLAM::SpectralSynthesis::Do | ( | Segment & | in | ) |
Definition at line 201 of file SpectralSynthesis.cxx.
References Do(), CLAM::Segment::GetFrame(), and CLAM::Segment::mCurrentFrameIndex.
|
inlinevirtual |
Override it in every subclass and retur the name of that class.
Reimplemented from CLAM::ProcessingComposite.
Definition at line 113 of file SpectralSynthesis.hxx.
|
inlinevirtual |
Configuration getter.
Gets the configuration parameters used to create the object.
Implements CLAM::ProcessingComposite.
Definition at line 116 of file SpectralSynthesis.hxx.
AudioOutPort CLAM::SpectralSynthesis::mOutput |
Definition at line 130 of file SpectralSynthesis.hxx.
Referenced by Do().