CLAM::Envelope Class Reference

#include <Envelope.hxx>

Inheritance diagram for CLAM::Envelope:

List of all members.

---

Detailed Description

Envelope class.

This class tipically represents the amplitude envelope of an audio object. The internal representation is a BreakPoint function (BPF). For a floating point abcisa value representing time (in milliseconds), the BPF returns the amplitude value, in an scale from 0.0 to 1.0.

See also:

ProcessingData, EnvelopeExtractor, EnvelopeConfig

Definition at line 67 of file Envelope.hxx.

Public Types
typedef BPFTmpl< TTime, TData >	TEnvelopeBPF
Public Member Functions
	DYNAMIC_TYPE_USING_INTERFACE (Envelope, 2, ProcessingData)
	DYN_ATTRIBUTE (0, public, EnvelopeConfig, Config)
	Configuration of Envelope with information about it.
	DYN_ATTRIBUTE (1, public, TEnvelopeBPF, AmplitudeBPF)
	BPF, with amplitude returned as TData values.
	Envelope (const EnvelopeConfig &newConfig)
	Constructor class given a concrete configuration.
const ProcessingDataConfig &	GetProcessingDataConfig () const
	Method that allows get the configuration of the Envelope.
void	Configure (const EnvelopeConfig &newConfig)
	Create the configuration of Envelope using an EnvelopeConfig instantiation.
int	GetBPFSize () const
	Method to obtain the size of the Break Point Function.
void	SetBPFSize (int s)
	Resize the BPF.
int	GetScale () const
	Method to obtain the value of Scale.
void	SetScale (int s)
	Change the Scale factor.
Protected Member Functions
void	DefaultInit ()
	Configure the Envelope with an EnvelopeConfig created by default.

---

Member Typedef Documentation

typedef BPFTmpl<TTime,TData> CLAM::Envelope::TEnvelopeBPF

Definition at line 71 of file Envelope.hxx.

---

Constructor & Destructor Documentation

CLAM::Envelope::Envelope

(

const EnvelopeConfig &

newConfig

)

Constructor class given a concrete configuration.

Parameters:

&newConfig

reference to an Envelope Configuration established by the user

Definition at line 41 of file Envelope.cxx.

References Configure(), and CLAM::DynamicType::UpdateData().

---

Member Function Documentation

CLAM::Envelope::DYNAMIC_TYPE_USING_INTERFACE	(	Envelope	,
		2	,
		ProcessingData
	)

CLAM::Envelope::DYN_ATTRIBUTE	(	0	,
		public	,
		EnvelopeConfig	,
		Config
	)

Configuration of Envelope with information about it.

CLAM::Envelope::DYN_ATTRIBUTE	(	1	,
		public	,
		TEnvelopeBPF	,
		AmplitudeBPF
	)

BPF, with amplitude returned as TData values.

const ProcessingDataConfig & CLAM::Envelope::GetProcessingDataConfig

(

)

const [inline]

Method that allows get the configuration of the Envelope.

Returns:

The configuration of this Envelope

Definition at line 139 of file Envelope.hxx.

void CLAM::Envelope::Configure

(

const EnvelopeConfig &

newConfig

)

Create the configuration of Envelope using an EnvelopeConfig instantiation.

Parameters:

&newConfig

reference to an Envelope Configuration established by the user

Definition at line 49 of file Envelope.cxx.

References GetBPFSize(), and CLAM::DynamicType::UpdateData().

Referenced by DefaultInit(), and Envelope().

void CLAM::Envelope::DefaultInit

(

void

)

[protected]

Configure the Envelope with an EnvelopeConfig created by default.

Reimplemented from CLAM::DynamicType.

Definition at line 60 of file Envelope.cxx.

References Configure(), and CLAM::DynamicType::UpdateData().

int CLAM::Envelope::GetBPFSize

(

)

const [inline]

Method to obtain the size of the Break Point Function.

Returns:

Value of the size

Definition at line 144 of file Envelope.hxx.

Referenced by Configure().

void CLAM::Envelope::SetBPFSize

(

int

s

)

[inline]

Resize the BPF.

Parameters:

s

New size desired

Definition at line 149 of file Envelope.hxx.

int CLAM::Envelope::GetScale

(

)

const [inline]

Method to obtain the value of Scale.

Returns:

Scale

Definition at line 154 of file Envelope.hxx.

void CLAM::Envelope::SetScale

(

int

s

)

[inline]

Change the Scale factor.

Parameters:

s

New Scale factor

Definition at line 158 of file Envelope.hxx.

---

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

• Envelope.hxx
• Envelope.cxx