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

The PhaseManagement Class takes care about either. More...

#include <PhaseManagement.hxx>

List of all members.

Public Types

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

Public Member Functions

 PhaseManagement (const PhaseManagementConfig &c=Config())
 ~PhaseManagement ()
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
bool Do ()
 Supervised mode execution method (using ports)
bool Do (Frame &currentFrame)
bool Do (SpectralPeakArray &in)
 Basic non-supervised Do.
bool ConcreteConfigure (const ProcessingConfig &)
 Configuration method.
const ProcessingConfigGetConfig () const
 Configuration getter.
void Init ()
void ResetPhaseAlignment ()
void DoPhaseAlignment (SpectralPeakArray &peakArray)
void DoRandomPhases (SpectralPeakArray &peakArray)
void DoPhaseContinuation (SpectralPeakArray &p)
void SetLastPhasesAndFreqs (SpectralPeakArray &peakArray)
void GenerateRandomPhases (DataArray &a)
- 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 mCurrentTime
FloatInControl mCurrentPitch

Additional Inherited Members

- Protected Member Functions inherited from CLAM::Processing
virtual bool ConcreteStart ()
 Processing objects have to redefine this method when starting them implies some internal changes.
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::Processing
ProcessingCompositempParent
 Pointer to the parent (composite) processing object, or 0.
Network_network
 The parent network if any.

Detailed Description

The PhaseManagement Class takes care about either.

  1. generating a random set of phases and their continuation
  2. phase alignment

Definition at line 45 of file PhaseManagement.hxx.


Member Typedef Documentation

Reimplemented from CLAM::Processing.

Definition at line 48 of file PhaseManagement.hxx.


Constructor & Destructor Documentation

CLAM::PhaseManagement::PhaseManagement ( const PhaseManagementConfig c = Config())

Definition at line 29 of file PhaseManagement.cxx.

References CLAM::Processing::Configure(), and Init().

CLAM::PhaseManagement::~PhaseManagement ( )

Definition at line 69 of file PhaseManagement.cxx.


Member Function Documentation

bool CLAM::PhaseManagement::ConcreteConfigure ( const ProcessingConfig c)
virtual

Configuration method.

Reimplemented from CLAM::Processing.

Definition at line 37 of file PhaseManagement.cxx.

References CLAM::Processing::CopyAsConcreteConfig().

bool CLAM::PhaseManagement::Do ( )
inlinevirtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 54 of file PhaseManagement.hxx.

Referenced by Do(), CLAM::SinusoidalSynthesis::Do(), and CLAM::SMSSynthesis::Do().

bool CLAM::PhaseManagement::Do ( Frame currentFrame)
bool CLAM::PhaseManagement::Do ( SpectralPeakArray in)

Basic non-supervised Do.

Todo:
: the way the algorithms are now, they just allow inplace processing. This should be changed.

Definition at line 74 of file PhaseManagement.cxx.

References DoPhaseAlignment(), DoPhaseContinuation(), DoRandomPhases(), CLAM::EPhaseGeneration::eAlign, CLAM::EPhaseGeneration::eContinuation, CLAM::EPhaseGeneration::eNone, and CLAM::EPhaseGeneration::eRandom.

void CLAM::PhaseManagement::DoPhaseAlignment ( SpectralPeakArray peakArray)
void CLAM::PhaseManagement::DoPhaseContinuation ( SpectralPeakArray p)
void CLAM::PhaseManagement::DoRandomPhases ( SpectralPeakArray peakArray)
void CLAM::PhaseManagement::GenerateRandomPhases ( DataArray a)

Definition at line 284 of file PhaseManagement.cxx.

References CLAM::Array< T >::Size(), and TWO_PI.

Referenced by Init().

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

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

Implements CLAM::Processing.

Definition at line 52 of file PhaseManagement.hxx.

const ProcessingConfig& CLAM::PhaseManagement::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 64 of file PhaseManagement.hxx.

void CLAM::PhaseManagement::Init ( )
void CLAM::PhaseManagement::ResetPhaseAlignment ( )

Definition at line 111 of file PhaseManagement.cxx.

void CLAM::PhaseManagement::SetLastPhasesAndFreqs ( SpectralPeakArray peakArray)

Member Data Documentation

FloatInControl CLAM::PhaseManagement::mCurrentPitch
FloatInControl CLAM::PhaseManagement::mCurrentTime

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