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

This is a processing object class that performs a sinusoidal resynthesis given a set of spectral peaks. More...

#include <SinusoidalSynthesis.hxx>

List of all members.

Public Member Functions

 SinusoidalSynthesis (const Config &cfg=Config())
 ~SinusoidalSynthesis ()
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
const ProcessingConfigGetConfig () const
 Configuration getter.
bool Do (void)
 Supervised mode execution.
bool Do (SpectralPeakArray &inputSinusoidalPeaks, Spectrum &outputSpectrum, Audio &outputAudio)
 non-supervised Do method.
bool Do (SpectralPeakArray &inputSinusoidal, Audio &outputAudio)
 non-supervised Do method.
bool Do (Frame &in)
 non-supervised Do method: works on a CLAM::Frame
bool Do (Segment &in)
 non-supervised Do method: works on a CLAM::Segment.
- Public Member Functions inherited from CLAM::ProcessingComposite
virtual ~ProcessingComposite ()
void Insert (Processing &o) throw (ErrProcessingObj)
void Remove (Processing &o)
iterator composite_begin ()
iterator composite_end ()
std::size_t composite_size ()
- 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.

Public Attributes

FloatInControl mCurrentTimeControl
FloatInControl mCurrentPitch

Protected Member Functions

void InitFrame (Frame &in)
- Protected Member Functions inherited from CLAM::ProcessingComposite
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().
- Protected Member Functions inherited from CLAM::Processing
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

InPort< SpectralPeakArraymInputSinSpectralPeaks
 Ports.
OutPort< SpectrummOutputSinSpectrum
OutPort< SpectrummOutputSpectrum
AudioOutPort mOutputAudio

Additional Inherited Members

- Public Types inherited from CLAM::ProcessingComposite
typedef std::list< Processing * >
::iterator 
iterator
 Processing object composite iterator.
- Public Types inherited from CLAM::Processing
enum  ExecState { Unconfigured = 0, Ready, Running }
 Processing Object possible execution states. More...

Detailed Description

This is a processing object class that performs a sinusoidal resynthesis given a set of spectral peaks.

Because it performs only one IFFT rather than the three performed by SMSSynthesis and it does not have process the residual, it requires approximately half the CPU cycles needed by SMSSynthesis, and it uses a lot less memory.

Author:
greg kellum [gkell.nosp@m.um@i.nosp@m.ua.up.nosp@m.f.ed.nosp@m.u] 08/02/2007
Since:
CLAM v1.2

Definition at line 63 of file SinusoidalSynthesis.hxx.


Constructor & Destructor Documentation

CLAM::SinusoidalSynthesis::SinusoidalSynthesis ( const Config cfg = Config())

Definition at line 47 of file SinusoidalSynthesis.cxx.

References CLAM::Processing::Configure().

CLAM::SinusoidalSynthesis::~SinusoidalSynthesis ( )

Definition at line 59 of file SinusoidalSynthesis.cxx.


Member Function Documentation

bool CLAM::SinusoidalSynthesis::Do ( void  )
virtual
bool CLAM::SinusoidalSynthesis::Do ( SpectralPeakArray inputSinusoidalPeaks,
Spectrum outputSpectrum,
Audio outputAudio 
)

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 143 of file SinusoidalSynthesis.cxx.

References CLAM::PhaseManagement::Do(), CLAM::SynthSineSpectrum::Do(), CLAM::OverlapAdd::Do(), CLAM::SpectralSynthesis::Do(), CLAM::InControl< ControlDataType >::DoControl(), CLAM::InControl< ControlDataType >::GetLastValue(), CLAM::SMSSynthesisConfig::GetSamplingRate(), CLAM::Audio::GetSize(), CLAM::SMSSynthesisConfig::GetSpectrumSize(), CLAM::PhaseManagement::mCurrentPitch, mCurrentPitch, CLAM::PhaseManagement::mCurrentTime, mCurrentTimeControl, and CLAM::Spectrum::SetSize().

bool CLAM::SinusoidalSynthesis::Do ( SpectralPeakArray inputSinusoidal,
Audio outputAudio 
)

non-supervised Do method.

SinusoidalSynthesis 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 131 of file SinusoidalSynthesis.cxx.

References Do().

bool CLAM::SinusoidalSynthesis::Do ( Frame in)
bool CLAM::SinusoidalSynthesis::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 204 of file SinusoidalSynthesis.cxx.

References Do(), CLAM::Segment::GetFrame(), and CLAM::Segment::mCurrentFrameIndex.

const char* CLAM::SinusoidalSynthesis::GetClassName ( ) const
inlinevirtual

Override it in every subclass and retur the name of that class.

Reimplemented from CLAM::ProcessingComposite.

Definition at line 103 of file SinusoidalSynthesis.hxx.

const ProcessingConfig& CLAM::SinusoidalSynthesis::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.

Implements CLAM::ProcessingComposite.

Definition at line 106 of file SinusoidalSynthesis.hxx.

void CLAM::SinusoidalSynthesis::InitFrame ( Frame in)
protected

Member Data Documentation

FloatInControl CLAM::SinusoidalSynthesis::mCurrentPitch

Definition at line 142 of file SinusoidalSynthesis.hxx.

Referenced by Do().

FloatInControl CLAM::SinusoidalSynthesis::mCurrentTimeControl

Definition at line 141 of file SinusoidalSynthesis.hxx.

Referenced by Do().

InPort<SpectralPeakArray> CLAM::SinusoidalSynthesis::mInputSinSpectralPeaks
protected

Ports.

Definition at line 134 of file SinusoidalSynthesis.hxx.

Referenced by Do().

AudioOutPort CLAM::SinusoidalSynthesis::mOutputAudio
protected

Definition at line 137 of file SinusoidalSynthesis.hxx.

Referenced by Do().

OutPort<Spectrum> CLAM::SinusoidalSynthesis::mOutputSinSpectrum
protected

Definition at line 135 of file SinusoidalSynthesis.hxx.

Referenced by Do().

OutPort<Spectrum> CLAM::SinusoidalSynthesis::mOutputSpectrum
protected

Definition at line 136 of file SinusoidalSynthesis.hxx.

Referenced by Do().


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