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

Time Stretch using the SMS model. More...

#include <SMSTimeStretch.hxx>

List of all members.

Public Types

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

Public Member Functions

 SMSTimeStretch ()
 ~SMSTimeStretch ()
bool Do ()
 Supervised mode execution method (using ports)
bool Do (const Frame &in, Frame &out)
bool Do (const SpectralPeakArray &inPeaks, const Fundamental &inFund, const Spectrum &inSpectrum, SpectralPeakArray &outPeaks, Fundamental &outFund, Spectrum &outSpectrum)
bool ConcreteStart ()
 Processing objects have to redefine this method when starting them implies some internal changes.
bool ConcreteStop ()
 Processing objects have to redefine this method when stoping them implies some internal changes.
const ProcessingConfigGetConfig () const
 Configuration getter.
- 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 Member Functions

bool ConcreteConfigure (const ProcessingConfig &config)
 Configuration method interface.
- 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

TTime mSynthesisTime
TTime mAnalysisTime
TIndex mnSynthesisFrames
Frame mLeftFrame
SpectrumInterpolator mSpectrumInterpolator
 Child processings.
SpectralPeakArrayInterpolator mPeaksInterpolator
- Protected Attributes inherited from CLAM::Processing
ProcessingCompositempParent
 Pointer to the parent (composite) processing object, or 0.
Network_network
 The parent network if any.

Detailed Description

Time Stretch using the SMS model.

Todo:
: introduce interpolation of spectral shapes, before that, interpolations may be extracted to external Processing's

Definition at line 44 of file SMSTimeStretch.hxx.


Member Typedef Documentation

Reimplemented from CLAM::Processing.

Definition at line 117 of file SMSTimeStretch.hxx.


Constructor & Destructor Documentation

CLAM::SMSTimeStretch::SMSTimeStretch ( )
inline

Definition at line 59 of file SMSTimeStretch.hxx.

References CLAM::Processing::Configure().

CLAM::SMSTimeStretch::~SMSTimeStretch ( )
inline

Definition at line 71 of file SMSTimeStretch.hxx.


Member Function Documentation

bool CLAM::SMSTimeStretch::ConcreteConfigure ( const ProcessingConfig )
protectedvirtual

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.

Definition at line 169 of file SMSTimeStretch.cxx.

References CLAM::Processing::CopyAsConcreteConfig().

bool CLAM::SMSTimeStretch::ConcreteStart ( void  )
virtual

Processing objects have to redefine this method when starting them implies some internal changes.

ie: adquiring resources.

Returns:
Whether start changes have been successful

Reimplemented from CLAM::Processing.

Definition at line 198 of file SMSTimeStretch.cxx.

References mAnalysisTime, mLeftFrame, mnSynthesisFrames, and mSynthesisTime.

bool CLAM::SMSTimeStretch::ConcreteStop ( )
virtual

Processing objects have to redefine this method when stoping them implies some internal changes.

ie: releasing resources.

Returns:
Whether stop changes have been successful

Reimplemented from CLAM::Processing.

Definition at line 191 of file SMSTimeStretch.cxx.

bool CLAM::SMSTimeStretch::Do ( )
inlinevirtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 73 of file SMSTimeStretch.hxx.

References CLAM::InPort< Token >::Consume(), CLAM::InPort< Token >::GetData(), CLAM::OutPort< Token >::GetData(), and CLAM::OutPort< Token >::Produce().

Referenced by Do().

bool CLAM::SMSTimeStretch::Do ( const Frame in,
Frame out 
)

Definition at line 40 of file SMSTimeStretch.cxx.

References Do().

bool CLAM::SMSTimeStretch::Do ( const SpectralPeakArray inPeaks,
const Fundamental inFund,
const Spectrum inSpectrum,
SpectralPeakArray outPeaks,
Fundamental outFund,
Spectrum outSpectrum 
)

TODO: This method does not work if called directly! it must be called from the Segment overload

Definition at line 82 of file SMSTimeStretch.cxx.

References mnSynthesisFrames, and mSynthesisTime.

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

Definition at line 119 of file SMSTimeStretch.hxx.


Member Data Documentation

TTime CLAM::SMSTimeStretch::mAnalysisTime
protected

Definition at line 135 of file SMSTimeStretch.hxx.

Referenced by ConcreteStart().

Frame CLAM::SMSTimeStretch::mLeftFrame
protected

Definition at line 138 of file SMSTimeStretch.hxx.

Referenced by ConcreteStart().

TIndex CLAM::SMSTimeStretch::mnSynthesisFrames
protected

Definition at line 136 of file SMSTimeStretch.hxx.

Referenced by ConcreteStart(), and Do().

SpectralPeakArrayInterpolator CLAM::SMSTimeStretch::mPeaksInterpolator
protected

Definition at line 143 of file SMSTimeStretch.hxx.

SpectrumInterpolator CLAM::SMSTimeStretch::mSpectrumInterpolator
protected

Child processings.

Definition at line 142 of file SMSTimeStretch.hxx.

TTime CLAM::SMSTimeStretch::mSynthesisTime
protected

Definition at line 134 of file SMSTimeStretch.hxx.

Referenced by ConcreteStart(), and Do().


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