CLAM-Development  1.4.0
Public Member Functions
CLAM::SMSTransformationChainIO Class Reference

Pitch shift with timbre preservation using the SMS model. More...

#include <SMSTransformationChainIO.hxx>

List of all members.

Public Member Functions

 SMSTransformationChainIO ()
 Base constructor of class.
 SMSTransformationChainIO (const SegmentTransformationConfig &c)
 Constructor with an object of SegmentTransformationConfig class by parameter.
 ~SMSTransformationChainIO ()
 Destructor of the class.
bool Do ()
 Supervised mode execution method (using ports)
bool Do (const Frame &in, Frame &out)
- Public Member Functions inherited from CLAM::SegmentTransformation
void AttachIn (Segment &data)
void AttachOut (Segment &data)
void WrapFrameTransformation (FrameTransformation *)
virtual bool ConcreteConfigure (const ProcessingConfig &c)
 Configuration change method.
const ProcessingConfigGetConfig () const
 Configuration getter.
 SegmentTransformation ()
 Base constructor of class.
 SegmentTransformation (const SegmentTransformationConfig &c)
 Constructor with an object of SegmentTransformationConfig class by parameter.
virtual ~SegmentTransformation ()
virtual bool DoWithSegments (void)
 Supervised Do() function.
virtual bool UpdateControlValueFromBPF (TData pos)
 Method to update the Amount control from an existing BPF configured in the configuration phase.
virtual bool IsLastFrame ()
 Returns true if there are no more frames to read from input.
bool ConcreteStart ()
 Overriding default method to initialize input frame counter.
- 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.

Additional Inherited Members

- Public Attributes inherited from CLAM::SegmentTransformation
InControlPublisher mAmountCtrl
 Control for the amount of the concrete transformation that will be applied.
- Protected Member Functions inherited from CLAM::SegmentTransformation
void AddFramesToOutputIfInputIsLonger (int frameindex, const Segment &in, Segment &out)
virtual bool Do (const Segment &in, Segment &out)
 Unsupervised Do function, receives a Segment as input and output.
virtual const FrameGetCurrentFrame (const Segment &in)
 formerly corresponded to UnwrappedProcessingData
virtual FrameGetCurrentFrame (Segment &out)
 formerly corresponded to UnwrappedProcessingData
- Protected Member Functions inherited from CLAM::Processing
virtual bool ConcreteStop ()
 Processing objects have to redefine this method when stoping them implies some internal changes.
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 inherited from CLAM::SegmentTransformation
SegmentTransformationConfig mConfig
 Internally stored configuration.
bool mUseTemporalBPF
 Boolean member that indicates whether BPF or single value is to be used.
FloatInControl mOnCtrl
 Control to state whether a particular transformation is on or off.
SegmentmInput
SegmentmOutput
int mCurrentInputFrame
- 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

Pitch shift with timbre preservation using the SMS model.

In order to preserve timbre, the original spectral shape is extracted and then applied back.

Definition at line 39 of file SMSTransformationChainIO.hxx.


Constructor & Destructor Documentation

CLAM::SMSTransformationChainIO::SMSTransformationChainIO ( )
inline

Base constructor of class.

Calls Configure method with a SMSTransformationConfig initialised by default

Definition at line 50 of file SMSTransformationChainIO.hxx.

CLAM::SMSTransformationChainIO::SMSTransformationChainIO ( const SegmentTransformationConfig c)
inline

Constructor with an object of SegmentTransformationConfig class by parameter.

Parameters:
cSegmentTransformationConfig object created by the user

Definition at line 56 of file SMSTransformationChainIO.hxx.

CLAM::SMSTransformationChainIO::~SMSTransformationChainIO ( )
inline

Destructor of the class.

Definition at line 61 of file SMSTransformationChainIO.hxx.


Member Function Documentation

bool CLAM::SMSTransformationChainIO::Do ( )
inlinevirtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Reimplemented from CLAM::SegmentTransformation.

Definition at line 64 of file SMSTransformationChainIO.hxx.

References CLAM_ASSERT.

bool CLAM::SMSTransformationChainIO::Do ( const Frame in,
Frame out 
)
virtual

Reimplemented from CLAM::SegmentTransformation.

Definition at line 40 of file SMSTransformationChainIO.cxx.


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