Configuration class for SpectralEnvelopeExtract objects. More...

#include <SpectralEnvelopeExtract.hxx>

Public Member Functions
	SpectralEnvelopeExtract ()
	Base constructor of class.
	SpectralEnvelopeExtract (const SpectralEnvelopeExtractConfig &c)
	Constructor with an object of SpectralEnvelopeExtractConfig class by parameter.
	~SpectralEnvelopeExtract ()
	Destructor of the class.
const ProcessingConfig &	GetConfig () const
	This method allows to obtain the SpectralEnvelopeExtractConfig object of the class.
bool	Do (void)
	Supervised Do() function, not implemented yet.
bool	Do (const SpectralPeakArray &input, Spectrum &output)
	Unsupervised Do function, receives an Spectrum object input, and the output of method is an SpectralPeakArray (passed by parameter)
bool	SetPrototypes (const SpectralPeakArray &input, Spectrum &output)
	Change the internal type state.
bool	SetPrototypes ()
bool	UnsetPrototypes ()
bool	MayDisableExecution () const
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)
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.

Additional Inherited Members
Public Types inherited from CLAM::Processing
enum	ExecState { Unconfigured = 0, Ready, Running }
	Processing Object possible execution states. More...
typedef NullProcessingConfig	Config
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.
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 inherited from CLAM::Processing
ProcessingComposite *	mpParent
	Pointer to the parent (composite) processing object, or 0.
Network *	_network
	The parent network if any.

Detailed Description

Configuration class for SpectralEnvelopeExtract objects.

See also:: ProcessingConfig, SpectralEnvelopeExtract Processing to extract spectral envelope from an array of spectral peaks.

Definition at line 45 of file SpectralEnvelopeExtract.hxx.

Constructor & Destructor Documentation

CLAM::SpectralEnvelopeExtract::SpectralEnvelopeExtract ( )

Base constructor of class.

Calls Configure method with a SpectralEnvelopeExtractConfig initialised by default

Definition at line 51 of file SpectralEnvelopeExtract.cxx.

References CLAM::Processing::Configure().

CLAM::SpectralEnvelopeExtract::SpectralEnvelopeExtract ( const SpectralEnvelopeExtractConfig & c = SpectralEnvelopeExtractConfig() )

Constructor with an object of SpectralEnvelopeExtractConfig class by parameter.

Parameters:

c	SpectralEnvelopeExtractConfig object created by the user

Definition at line 56 of file SpectralEnvelopeExtract.cxx.

References CLAM::Processing::Configure().

CLAM::SpectralEnvelopeExtract::~SpectralEnvelopeExtract ( )

Destructor of the class.

Definition at line 61 of file SpectralEnvelopeExtract.cxx.

Member Function Documentation

bool CLAM::SpectralEnvelopeExtract::Do ( void )

virtual

Supervised Do() function, not implemented yet.

Implements CLAM::Processing.

Definition at line 95 of file SpectralEnvelopeExtract.cxx.

References CLAM_ASSERT, and CLASS.

Referenced by CLAM::SMSSpectralShapeShift::Do(), CLAM::SpectralShapeShift::Do(), and CLAM::SMSPitchShift::Do().

bool CLAM::SpectralEnvelopeExtract::Do	(	const SpectralPeakArray &	input,
		Spectrum &	output
	)

Unsupervised Do function, receives an Spectrum object input, and the output of method is an SpectralPeakArray (passed by parameter)

Parameters:

input	The Spectral Peaks we want to extract the envelope from
output	A Spectrum in BPF form that represents the Spectral Envelope

Returns:: Boolean value, true if all has been executed correctly.

Definition at line 103 of file SpectralEnvelopeExtract.cxx.

References CLAM_pow(), CLAM::EScale::eLog, CLAM::SpectralPeakArray::GetnPeaks(), CLAM::Array< T >::Resize(), CLAM::Array< T >::SetSize(), and CLAM::Spectrum::SetSize().

const ProcessingConfig& CLAM::SpectralEnvelopeExtract::GetConfig ( ) const

inlinevirtual

This method allows to obtain the SpectralEnvelopeExtractConfig object of the class.

Returns:: The configuration of the class

Reimplemented from CLAM::Processing.

Definition at line 74 of file SpectralEnvelopeExtract.hxx.

bool CLAM::SpectralEnvelopeExtract::MayDisableExecution ( ) const

inline

Definition at line 96 of file SpectralEnvelopeExtract.hxx.

bool CLAM::SpectralEnvelopeExtract::SetPrototypes	(	const SpectralPeakArray &	input,
		Spectrum &	output
	)

Change the internal type state.

Definition at line 78 of file SpectralEnvelopeExtract.cxx.

bool CLAM::SpectralEnvelopeExtract::SetPrototypes ( )

Definition at line 83 of file SpectralEnvelopeExtract.cxx.

bool CLAM::SpectralEnvelopeExtract::UnsetPrototypes ( )

Definition at line 88 of file SpectralEnvelopeExtract.cxx.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation