CLAM-Development
1.4.0
|
This is the processing object class we are using to group several other processing objects. More...
#include <SMSSynthesis.hxx>
Public Member Functions | |
SMSSynthesis (const Config &cfg=Config()) | |
~SMSSynthesis () | |
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 | SinusoidalSynthesis (const SpectralPeakArray &in, Spectrum &outSpec, Audio &outAudio) |
Sinusoidal synthesis, gives also the output spectrum. | |
bool | SinusoidalSynthesis (const SpectralPeakArray &in, Audio &out) |
Sinusoidal synthesis. | |
bool | Do (SpectralPeakArray &inputSinusoidalPeaks, Spectrum &inputResidualSpectrum, Spectrum &outputSinusoidalSpectrum, Spectrum &outputSpectrum, Audio &outputAudio, Audio &outputSinusoidalAudio, Audio &outputResidualAudio) |
non-supervised Do method. | |
bool | Do (SpectralPeakArray &inputSinusoidalPeaks, Spectrum &inputResidualSpectrum, Spectrum &outputSinusoidalSpectrum, Spectrum &outputSpectrum, Audio &outputAudio) |
non-supervised Do method. | |
bool | Do (SpectralPeakArray &inputSinusoidal, Spectrum &inputSpectrum, Audio &outputAudio, Audio &outputSinusoidal, Audio &outputResidual) |
non-supervised Do method. | |
bool | Do (Frame &in) |
non-supervised Do method: works on a CLAM::Frame | |
bool | Do (Frame &in, bool isSynthesizeSinusoidsAndResidual) |
If isSynthesizeSinusoidsAndResidual is false, this method synthesizes only the mixdown of the sinusoids and residual rather than synthesizing each separately. | |
bool | Do (Segment &in) |
non-supervised Do method: works on a CLAM::Segment. | |
![]() | |
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 | |
FloatInControl | mCurrentTimeControl |
FloatInControl | mCurrentPitch |
Protected Member Functions | |
void | InitFrame (Frame &in) |
![]() | |
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) |
Protected Attributes | |
InPort< SpectralPeakArray > | mInputSinSpectralPeaks |
Ports. | |
InPort< Spectrum > | mInputResSpectrum |
OutPort< Spectrum > | mOutputSinSpectrum |
OutPort< Spectrum > | mOutputSpectrum |
AudioOutPort | mOutputAudio |
AudioOutPort | mOutputResAudio |
AudioOutPort | mOutputSinAudio |
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... |
This is the processing object class we are using to group several other processing objects.
Definition at line 57 of file SMSSynthesis.hxx.
Definition at line 56 of file SMSSynthesis.cxx.
References CLAM::Processing::Configure().
CLAM::SMSSynthesis::~SMSSynthesis | ( | ) |
Definition at line 72 of file SMSSynthesis.cxx.
|
virtual |
Supervised mode execution.
Implements CLAM::ProcessingComposite.
Definition at line 168 of file SMSSynthesis.cxx.
References CLAM::InPort< Token >::Consume(), CLAM::AudioOutPort::GetAudio(), CLAM::InPort< Token >::GetData(), CLAM::OutPort< Token >::GetData(), CLAM::OutPortBase::HasConnections(), mInputResSpectrum, mInputSinSpectralPeaks, mOutputAudio, mOutputResAudio, mOutputSinAudio, mOutputSinSpectrum, mOutputSpectrum, and CLAM::OutPort< Token >::Produce().
Referenced by Do().
bool CLAM::SMSSynthesis::Do | ( | SpectralPeakArray & | inputSinusoidalPeaks, |
Spectrum & | inputResidualSpectrum, | ||
Spectrum & | outputSinusoidalSpectrum, | ||
Spectrum & | outputSpectrum, | ||
Audio & | outputAudio, | ||
Audio & | outputSinusoidalAudio, | ||
Audio & | outputResidualAudio | ||
) |
non-supervised Do method.
Produces as output the sinusoidal spectrum, the global spectrum. and the sinusoidal, residual and globar audio frames. If this overload is used directly you must set the controls for current time and current pitch from the outside.
Definition at line 215 of file SMSSynthesis.cxx.
References CLAM::PhaseManagement::Do(), CLAM::OverlapAdd::Do(), CLAM::SpectralSynthesis::Do(), CLAM::SpectrumAdder2::Do(), CLAM::InControl< ControlDataType >::DoControl(), CLAM::InControl< ControlDataType >::GetLastValue(), CLAM::Audio::GetSize(), CLAM::Spectrum::GetSize(), CLAM::PhaseManagement::mCurrentPitch, mCurrentPitch, CLAM::PhaseManagement::mCurrentTime, mCurrentTimeControl, CLAM::Spectrum::SetSize(), and SinusoidalSynthesis().
bool CLAM::SMSSynthesis::Do | ( | SpectralPeakArray & | inputSinusoidalPeaks, |
Spectrum & | inputResidualSpectrum, | ||
Spectrum & | outputSinusoidalSpectrum, | ||
Spectrum & | outputSpectrum, | ||
Audio & | outputAudio | ||
) |
non-supervised Do method.
Produces as output the sinusoidal spectrum, the global spectrum. and the global audio frames. If this overload is used directly you must set the controls for current time and current pitch from the outside.
Definition at line 276 of file SMSSynthesis.cxx.
References CLAM::PhaseManagement::Do(), CLAM::SynthSineSpectrum::Do(), CLAM::OverlapAdd::Do(), CLAM::SpectralSynthesis::Do(), CLAM::SpectrumAdder2::Do(), CLAM::InControl< ControlDataType >::DoControl(), CLAM::InControl< ControlDataType >::GetLastValue(), CLAM::Audio::GetSize(), CLAM::Spectrum::GetSize(), CLAM::SMSSynthesisConfig::GetSpectrumSize(), CLAM::PhaseManagement::mCurrentPitch, mCurrentPitch, CLAM::PhaseManagement::mCurrentTime, mCurrentTimeControl, and CLAM::Spectrum::SetSize().
bool CLAM::SMSSynthesis::Do | ( | SpectralPeakArray & | inputSinusoidal, |
Spectrum & | inputSpectrum, | ||
Audio & | outputAudio, | ||
Audio & | outputSinusoidal, | ||
Audio & | outputResidual | ||
) |
non-supervised Do method.
SMSSynthesis produces, as side effect, also some output Spectrums. Use this overload if you do not care about these spectrums and just need the output audio. If this overload is used directly you must set the controls for current time and current pitch from the outside.
Definition at line 197 of file SMSSynthesis.cxx.
References Do(), CLAM::Spectrum::GetSize(), and CLAM::Spectrum::SetSize().
bool CLAM::SMSSynthesis::Do | ( | Frame & | in | ) |
non-supervised Do method: works on a CLAM::Frame
Definition at line 328 of file SMSSynthesis.cxx.
References Do().
bool CLAM::SMSSynthesis::Do | ( | Frame & | in, |
bool | isSynthesizeSinusoidsAndResidual | ||
) |
If isSynthesizeSinusoidsAndResidual is false, this method synthesizes only the mixdown of the sinusoids and residual rather than synthesizing each separately.
If you don't need the separate audio representations of the sinusoid and residual, use this with isSynthesizeSinusoidsAndResidual set to false, because then this method only performs one IFFT rather than three which saves a considerable number of CPU cycles.
Definition at line 334 of file SMSSynthesis.cxx.
References Do(), CLAM::InControl< ControlDataType >::DoControl(), CLAM::SMSSynthesisConfig::GetSpectrumSize(), InitFrame(), and mCurrentPitch.
bool CLAM::SMSSynthesis::Do | ( | Segment & | in | ) |
non-supervised Do method: works on a CLAM::Segment.
Processes current frame in the segment and increments segment internal counter.
Definition at line 363 of file SMSSynthesis.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 105 of file SMSSynthesis.hxx.
|
inlinevirtual |
Configuration getter.
Gets the configuration parameters used to create the object.
Implements CLAM::ProcessingComposite.
Definition at line 108 of file SMSSynthesis.hxx.
|
protected |
Definition at line 369 of file SMSSynthesis.cxx.
References CLAM::SMSSynthesisConfig::GetFrameSize(), and CLAM::DynamicType::UpdateData().
Referenced by Do().
bool CLAM::SMSSynthesis::SinusoidalSynthesis | ( | const SpectralPeakArray & | in, |
Spectrum & | outSpec, | ||
Audio & | outAudio | ||
) |
Sinusoidal synthesis, gives also the output spectrum.
Definition at line 155 of file SMSSynthesis.cxx.
References CLAM::SynthSineSpectrum::Do(), CLAM::OverlapAdd::Do(), and CLAM::SpectralSynthesis::Do().
Referenced by Do(), and SinusoidalSynthesis().
bool CLAM::SMSSynthesis::SinusoidalSynthesis | ( | const SpectralPeakArray & | in, |
Audio & | out | ||
) |
Sinusoidal synthesis.
Definition at line 145 of file SMSSynthesis.cxx.
References CLAM::EScale::eLinear, and SinusoidalSynthesis().
FloatInControl CLAM::SMSSynthesis::mCurrentPitch |
Definition at line 169 of file SMSSynthesis.hxx.
Referenced by Do().
FloatInControl CLAM::SMSSynthesis::mCurrentTimeControl |
Definition at line 168 of file SMSSynthesis.hxx.
Referenced by Do().
Definition at line 159 of file SMSSynthesis.hxx.
Referenced by Do().
|
protected |
|
protected |
Definition at line 162 of file SMSSynthesis.hxx.
Referenced by Do().
|
protected |
Definition at line 163 of file SMSSynthesis.hxx.
Referenced by Do().
|
protected |
Definition at line 164 of file SMSSynthesis.hxx.
Referenced by Do().
Definition at line 160 of file SMSSynthesis.hxx.
Referenced by Do().
Definition at line 161 of file SMSSynthesis.hxx.
Referenced by Do().