CLAM::SegmentSMSTimeStretch Class Reference

#include <SegmentSMSTimeStretch.hxx>

List of all members.

Public Member Functions

 SegmentSMSTimeStretch ()
 Base constructor of class.
 SegmentSMSTimeStretch (const SegmentTransformationConfig &c)
 Constructor with an object of SegmentTransformationConfig class by parameter.
const char * GetClassName () const
 This method returns the name of the object.
bool ConcreteConfigure (const ProcessingConfig &c)
 Configuration change method.
bool ConcreteStart ()
 Overriding default method to initialize input frame counter.
bool ConcreteStop ()
 Processing objects have to redefine this method when stoping them implies some internal changes.
 ~SegmentSMSTimeStretch ()
 Destructor of the class.
bool Do ()
 Supervised mode execution method (using ports).
bool Do (const Frame &in, Frame &out)
 TODO: This method does not work if called directly! it must be called from the Segment overload.
bool Do (const Segment &in, Segment &out)
 Unsupervised Do function, receives a Segment as input and output.
bool CanProcessInplace ()
 Override this method if your processing cannot process inplace.
bool IsLastFrame ()
 Returns true if there are no more frames to read from input.
FrameGetCurrentFrame (Segment &out)
 formerly corresponded to UnwrappedProcessingData
const FrameGetCurrentFrame (const Segment &in)
 formerly corresponded to UnwrappedProcessingData

Public Attributes

FloatInControl mAmount

Protected Member Functions

bool HaveFinished ()
void UpdateTimeAndIndex (const Segment &in)

Protected Attributes

TTime mSynthesisTime
TTime mAnalysisTime
TIndex mnSynthesisFrames
Frame mLeftFrame
SegmentSMSTimeStretchConfig mConcreteConfig
FrameInterpolator mPO_FrameInterpolator
 Child processings.

Detailed Description

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

Definition at line 36 of file SegmentSMSTimeStretch.hxx.


Constructor & Destructor Documentation

CLAM::SegmentSMSTimeStretch::SegmentSMSTimeStretch (  ) 

Base constructor of class.

Calls Configure method with a SegmentTransformationConfig initialised by default

Definition at line 36 of file SegmentSMSTimeStretch.cxx.

CLAM::SegmentSMSTimeStretch::SegmentSMSTimeStretch ( const SegmentTransformationConfig c  ) 

Constructor with an object of SegmentTransformationConfig class by parameter.

Parameters:
c SegmentTransformationConfig object created by the user

Definition at line 44 of file SegmentSMSTimeStretch.cxx.

CLAM::SegmentSMSTimeStretch::~SegmentSMSTimeStretch (  )  [inline]

Destructor of the class.

Definition at line 57 of file SegmentSMSTimeStretch.hxx.


Member Function Documentation

bool CLAM::SegmentSMSTimeStretch::CanProcessInplace (  )  [inline, virtual]

Override this method if your processing cannot process inplace.

Reimplemented from CLAM::Processing.

Definition at line 67 of file SegmentSMSTimeStretch.hxx.

bool CLAM::SegmentSMSTimeStretch::ConcreteConfigure ( const ProcessingConfig c  )  [virtual]

Configuration change method.

Note that the Amount Control is initialized from the the values in the configuration. Appart from that the member boolean variable that indicates whether a BPF is used is also initialized and the On/Off control also.

Parameters:
The ProcessingConfig object
Returns:
True if the cast has been commited correctly

Reimplemented from CLAM::SegmentTransformation.

Definition at line 52 of file SegmentSMSTimeStretch.cxx.

bool CLAM::SegmentSMSTimeStretch::ConcreteStart ( void   )  [virtual]

Overriding default method to initialize input frame counter.

Reimplemented from CLAM::SegmentTransformation.

Definition at line 79 of file SegmentSMSTimeStretch.cxx.

References mPO_FrameInterpolator, and CLAM::Processing::Stop().

bool CLAM::SegmentSMSTimeStretch::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 73 of file SegmentSMSTimeStretch.cxx.

bool CLAM::SegmentSMSTimeStretch::Do ( const Segment in,
Segment out 
) [virtual]

Unsupervised Do function, receives a Segment as input and output.

This overload is the one called from the supervised Do(). Note that if BPF parameter is used, the Amount control is also updated.

Parameters:
input the Segment that is input to the transformation
out the Segment that is output from the transformation.
Returns:
Boolean value, whether the process has finished successfully or not.

Reimplemented from CLAM::SegmentTransformation.

Definition at line 120 of file SegmentSMSTimeStretch.cxx.

bool CLAM::SegmentSMSTimeStretch::Do ( const Frame in,
Frame out 
) [virtual]

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

Reimplemented from CLAM::SegmentTransformation.

Definition at line 91 of file SegmentSMSTimeStretch.cxx.

bool CLAM::SegmentSMSTimeStretch::Do (  )  [inline, virtual]

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Reimplemented from CLAM::SegmentTransformation.

Definition at line 59 of file SegmentSMSTimeStretch.hxx.

References CLAM_ASSERT.

const char* CLAM::SegmentSMSTimeStretch::GetClassName (  )  const [inline, virtual]

This method returns the name of the object.

Returns:
Char pointer with the name of object

Reimplemented from CLAM::SegmentTransformation.

Definition at line 50 of file SegmentSMSTimeStretch.hxx.

const Frame & CLAM::SegmentSMSTimeStretch::GetCurrentFrame ( const Segment in  )  [virtual]

formerly corresponded to UnwrappedProcessingData

Reimplemented from CLAM::SegmentTransformation.

Definition at line 161 of file SegmentSMSTimeStretch.cxx.

Frame & CLAM::SegmentSMSTimeStretch::GetCurrentFrame ( Segment out  )  [virtual]

formerly corresponded to UnwrappedProcessingData

Reimplemented from CLAM::SegmentTransformation.

Definition at line 167 of file SegmentSMSTimeStretch.cxx.

References CLAM::SegmentTransformation::mCurrentInputFrame.

bool CLAM::SegmentSMSTimeStretch::HaveFinished (  )  [protected]

Definition at line 175 of file SegmentSMSTimeStretch.cxx.

bool CLAM::SegmentSMSTimeStretch::IsLastFrame (  )  [virtual]

Returns true if there are no more frames to read from input.

Reimplemented from CLAM::SegmentTransformation.

Definition at line 180 of file SegmentSMSTimeStretch.cxx.

References CLAM::Segment::GetnFrames(), CLAM::SegmentTransformation::mCurrentInputFrame, and CLAM::SegmentTransformation::mInput.

void CLAM::SegmentSMSTimeStretch::UpdateTimeAndIndex ( const Segment in  )  [protected]

Definition at line 151 of file SegmentSMSTimeStretch.cxx.


Member Data Documentation

Definition at line 73 of file SegmentSMSTimeStretch.hxx.

Definition at line 79 of file SegmentSMSTimeStretch.hxx.

Definition at line 84 of file SegmentSMSTimeStretch.hxx.

Definition at line 82 of file SegmentSMSTimeStretch.hxx.

Definition at line 80 of file SegmentSMSTimeStretch.hxx.

Child processings.

Definition at line 87 of file SegmentSMSTimeStretch.hxx.

Referenced by ConcreteStart().

Definition at line 78 of file SegmentSMSTimeStretch.hxx.


The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.3