CLAM-Development
1.4.0
|
Configuration class for the SynthSineSpectrum Processing. More...
#include <SynthSineSpectrum.hxx>
Public Member Functions | |
SynthSineSpectrum () | |
SynthSineSpectrum (SynthSineSpectrumConfig &cfg) | |
~SynthSineSpectrum () | |
const char * | GetClassName () const |
Override it in every subclass and retur the name of that class. | |
bool | Do (const SpectralPeakArray &peakArray, Spectrum &residualSpectrumOut, double gain=1.0) |
bool | Do (void) |
Supervised mode execution method (using ports) | |
bool | ConcreteConfigure (const ProcessingConfig &) |
Configuration method. | |
const ProcessingConfig & | GetConfig () const |
Configuration getter. | |
![]() | |
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. |
Additional Inherited Members | |
![]() | |
enum | ExecState { Unconfigured = 0, Ready, Running } |
Processing Object possible execution states. More... | |
typedef NullProcessingConfig | Config |
![]() | |
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) |
![]() | |
ProcessingComposite * | mpParent |
Pointer to the parent (composite) processing object, or 0. | |
Network * | _network |
The parent network if any. |
Configuration class for the SynthSineSpectrum Processing.
Processing which can synthesize a spectrum out of an array of spectral peaks. It does this by convolving the spectral peaks with the significant part of the fourier transformed Blackman-Harris92 window, it's main lobe. WARNING: the do method changes the type of the output spectrum to complex regardless its original format. This behaviour may result in inconsistencies and should be taken into account.
Definition at line 57 of file SynthSineSpectrum.hxx.
SynthSineSpectrum::SynthSineSpectrum | ( | ) |
Definition at line 35 of file SynthSineSpectrum.cxx.
References CLAM::Processing::Configure().
SynthSineSpectrum::SynthSineSpectrum | ( | SynthSineSpectrumConfig & | cfg | ) |
Definition at line 42 of file SynthSineSpectrum.cxx.
References CLAM::Processing::Configure().
SynthSineSpectrum::~SynthSineSpectrum | ( | ) |
Definition at line 66 of file SynthSineSpectrum.cxx.
|
virtual |
Configuration method.
Reimplemented from CLAM::Processing.
Definition at line 50 of file SynthSineSpectrum.cxx.
References CLAM::Processing::Configure(), CLAM::Processing::CopyAsConcreteConfig(), CLAM::EWindowType::eBlackmanHarris92, CLAM::EWindowNormalize::eNone, and MAINLOBE_TABLE_SIZE.
bool SynthSineSpectrum::Do | ( | const SpectralPeakArray & | peakArray, |
Spectrum & | residualSpectrumOut, | ||
double | gain = 1.0 |
||
) |
Definition at line 84 of file SynthSineSpectrum.cxx.
References CLAM::Processing::AbleToExecute(), CLAM::SpecTypeFlags::bComplex, CLAM::SpecTypeFlags::bMagPhase, CLAM::SpecTypeFlags::bMagPhaseBPF, CLAM::SpecTypeFlags::bPolar, CLAM_DEBUG_ASSERT, CLAM::Spectrum::Configure(), CLAM::EScale::eLinear, and CLAM::Array< T >::Size().
Referenced by CLAM::SMSAnalysisCore::Do(), CLAM::SinusoidalSynthesis::Do(), CLAM::SMSSynthesis::Do(), and CLAM::SMSSynthesis::SinusoidalSynthesis().
|
virtual |
Supervised mode execution method (using ports)
Implements CLAM::Processing.
Definition at line 70 of file SynthSineSpectrum.cxx.
References CLAM::InPort< Token >::Consume(), Do(), CLAM::InPort< Token >::GetData(), CLAM::OutPort< Token >::GetData(), and CLAM::OutPort< Token >::Produce().
Referenced by Do().
|
inlinevirtual |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Definition at line 68 of file SynthSineSpectrum.hxx.
|
inlinevirtual |
Configuration getter.
Gets the configuration parameters used to create the object.
Reimplemented from CLAM::Processing.
Definition at line 77 of file SynthSineSpectrum.hxx.