#include <EnvelopeExtractor.hxx>

Public Member Functions
	EnvelopeExtractor (const EnvExtractorConfig &c=EnvExtractorConfig())
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
const ProcessingConfig &	GetConfig () const
	Configuration getter.
void	Attach (Audio &inp, Envelope &env)
bool	Do ()
	Supervised mode execution method (using ports)
bool	Do (const Audio &inp, Envelope &env)
int	NPoints () const
TData	NormalLevel () const
TData	SilenceLevel () const
TTime	InterpolationPeriod () const
TTime	IntegrationLength () const
TData	NormalLevelControl () const
TData	SilenceLevelControl () const
TTime	InterpolationPeriodControl () const
TTime	IntegrationLengthControl () 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.

Public Attributes
FloatInControl	cInterpolationPeriod
FloatInControl	cIntegrationLength
FloatInControl	cNormalLevel
FloatInControl	cSilenceLevel
InPort< Audio >	Input
OutPort< Envelope >	Output

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	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

Definition at line 161 of file EnvelopeExtractor.hxx.

Constructor & Destructor Documentation

CLAM::EnvelopeExtractor::EnvelopeExtractor ( const EnvExtractorConfig & c = EnvExtractorConfig() )

Definition at line 121 of file EnvelopeExtractor.cxx.

References CLAM::Processing::Configure().

Member Function Documentation

void CLAM::EnvelopeExtractor::Attach	(	Audio &	inp,
		Envelope &	env
	)

bool CLAM::EnvelopeExtractor::Do ( )

virtual

Supervised mode execution method (using ports)

Returns:: A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 418 of file EnvelopeExtractor.cxx.

References CLAM::InPort< Token >::Consume(), CLAM::InPort< Token >::GetData(), CLAM::OutPort< Token >::GetData(), Input, Output, and CLAM::OutPort< Token >::Produce().

bool CLAM::EnvelopeExtractor::Do	(	const Audio &	inp,
		Envelope &	env
	)

Definition at line 426 of file EnvelopeExtractor.cxx.

References CLAM::IntervalAmplitudeAverages::Acumulated(), CLAM::IntervalAmplitudeAverages::AdvanceFrame(), CLAM_ASSERT, CLAM::IntervalAmplitudeAverages::Compute(), and CLAM::Audio::GetSize().

const char* CLAM::EnvelopeExtractor::GetClassName ( ) const

inlinevirtual

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

Implements CLAM::Processing.

Definition at line 180 of file EnvelopeExtractor.hxx.

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

TTime CLAM::EnvelopeExtractor::IntegrationLength ( ) const

inline

Definition at line 200 of file EnvelopeExtractor.hxx.

TTime CLAM::EnvelopeExtractor::IntegrationLengthControl ( ) const

inline

Definition at line 208 of file EnvelopeExtractor.hxx.

TTime CLAM::EnvelopeExtractor::InterpolationPeriod ( ) const

inline

Definition at line 198 of file EnvelopeExtractor.hxx.

TTime CLAM::EnvelopeExtractor::InterpolationPeriodControl ( ) const

inline

Definition at line 206 of file EnvelopeExtractor.hxx.

TData CLAM::EnvelopeExtractor::NormalLevel ( ) const

inline

Definition at line 194 of file EnvelopeExtractor.hxx.

TData CLAM::EnvelopeExtractor::NormalLevelControl ( ) const

inline

Definition at line 202 of file EnvelopeExtractor.hxx.

int CLAM::EnvelopeExtractor::NPoints ( ) const

inline

Definition at line 192 of file EnvelopeExtractor.hxx.

TData CLAM::EnvelopeExtractor::SilenceLevel ( ) const

inline

Definition at line 196 of file EnvelopeExtractor.hxx.

TData CLAM::EnvelopeExtractor::SilenceLevelControl ( ) const

inline

Definition at line 204 of file EnvelopeExtractor.hxx.

Member Data Documentation

FloatInControl CLAM::EnvelopeExtractor::cIntegrationLength

Definition at line 171 of file EnvelopeExtractor.hxx.

FloatInControl CLAM::EnvelopeExtractor::cInterpolationPeriod

Definition at line 170 of file EnvelopeExtractor.hxx.

FloatInControl CLAM::EnvelopeExtractor::cNormalLevel

Definition at line 172 of file EnvelopeExtractor.hxx.

FloatInControl CLAM::EnvelopeExtractor::cSilenceLevel

Definition at line 173 of file EnvelopeExtractor.hxx.

InPort<Audio> CLAM::EnvelopeExtractor::Input

Definition at line 175 of file EnvelopeExtractor.hxx.

Referenced by Do().

OutPort<Envelope> CLAM::EnvelopeExtractor::Output

Definition at line 176 of file EnvelopeExtractor.hxx.

Referenced by Do().

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation