CLAM-Development
1.4.0
|
Time Stretch using the SMS model. More...
#include <SMSTimeStretch.hxx>
Public Types | |
typedef SMSTimeStretchConfig | Config |
![]() | |
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 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. |
Protected Member Functions | |
bool | ConcreteConfigure (const ProcessingConfig &config) |
Configuration method interface. | |
![]() | |
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 | |
TTime | mSynthesisTime |
TTime | mAnalysisTime |
TIndex | mnSynthesisFrames |
Frame | mLeftFrame |
SpectrumInterpolator | mSpectrumInterpolator |
Child processings. | |
SpectralPeakArrayInterpolator | mPeaksInterpolator |
![]() | |
ProcessingComposite * | mpParent |
Pointer to the parent (composite) processing object, or 0. | |
Network * | _network |
The parent network if any. |
Time Stretch using the SMS model.
Definition at line 44 of file SMSTimeStretch.hxx.
Reimplemented from CLAM::Processing.
Definition at line 117 of file SMSTimeStretch.hxx.
|
inline |
Definition at line 59 of file SMSTimeStretch.hxx.
References CLAM::Processing::Configure().
|
inline |
Definition at line 71 of file SMSTimeStretch.hxx.
|
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.
Reference | to the configuration object. |
true if the processing object is left in a consistent state, and can be executed.
This | method 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().
|
virtual |
Processing objects have to redefine this method when starting them implies some internal changes.
ie: adquiring resources.
Reimplemented from CLAM::Processing.
Definition at line 198 of file SMSTimeStretch.cxx.
References mAnalysisTime, mLeftFrame, mnSynthesisFrames, and mSynthesisTime.
|
virtual |
Processing objects have to redefine this method when stoping them implies some internal changes.
ie: releasing resources.
Reimplemented from CLAM::Processing.
Definition at line 191 of file SMSTimeStretch.cxx.
|
inlinevirtual |
Supervised mode execution method (using ports)
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().
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.
|
inlinevirtual |
Configuration getter.
Gets the configuration parameters used to create the object.
Reimplemented from CLAM::Processing.
Definition at line 119 of file SMSTimeStretch.hxx.
|
protected |
Definition at line 135 of file SMSTimeStretch.hxx.
Referenced by ConcreteStart().
|
protected |
Definition at line 138 of file SMSTimeStretch.hxx.
Referenced by ConcreteStart().
|
protected |
Definition at line 136 of file SMSTimeStretch.hxx.
Referenced by ConcreteStart(), and Do().
|
protected |
Definition at line 143 of file SMSTimeStretch.hxx.
|
protected |
Child processings.
Definition at line 142 of file SMSTimeStretch.hxx.
|
protected |
Definition at line 134 of file SMSTimeStretch.hxx.
Referenced by ConcreteStart(), and Do().