CLAM-Development  1.4.0
Public Types | Public Member Functions | Protected Member Functions
CLAM::Envelope Class Reference

Envelope class. More...

#include <Envelope.hxx>

List of all members.

Public Types

typedef BPFTmpl< TTime, TDataTEnvelopeBPF

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 ProcessingDataConfigGetProcessingDataConfig () 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.
- Public Member Functions inherited from CLAM::ProcessingData
 ProcessingData (const int n)
 Constructor of an object that will contain the number of attributes passed by parameter.
 ProcessingData (const ProcessingData &prototype, bool shareData=false, bool deep=true)
 Copy constructor of a ProcessingData object.
virtual ~ProcessingData ()
- Public Member Functions inherited from CLAM::DynamicType
 DynamicType (const int nAttr)
 Constructs a DynamicType object that can hold.
 DynamicType (const DynamicType &prototype, const bool shareData, const bool deepCopy)
 Copy constructor of a dynamic Type.
 DynamicType (const DynamicType &prototype)
virtual ~DynamicType ()
virtual const char * GetClassName () const =0
 Return the class name.
void CopyInit (const DynamicType &dt)
 This method allows custom code for the copy-constructor of a dynamic type, since the copy-constructor is macro expanded and can not be overwritted.
bool UpdateData ()
 Method used to resize the data space of the dynamic type, necessary when some AddXXX() / RemoveXXX() (where XXX is an attribute name) has been done.
unsigned GetNDynamicAttributes () const
const char * GetDynamicAttributeName (unsigned i)
virtual const std::type_info & GetTypeId (unsigned i) const =0
bool AttributeIsComponent (unsigned i) const
bool AttributeIsDynamictype (unsigned i) const
bool IsAttributeInstantiated (unsigned i) const
const void * GetAttributeAsVoidPtr (unsigned i) const
const ComponentGetAttributeAsComponent (unsigned i) const
ComponentGetAttributeAsComponent (unsigned i)
void FullfilsInvariant () const
virtual ComponentDeepCopy () const
void Debug () const
virtual void StoreOn (CLAM::Storage &storage) const
 Stores component's subitems on the given Storage.
virtual void LoadFrom (CLAM::Storage &storage)
 Loads component's subitems from the given Storage.
- Public Member Functions inherited from CLAM::Component
virtual ~Component ()

Protected Member Functions

void DefaultInit ()
 Configure the Envelope with an EnvelopeConfig created by default.

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.


Member Typedef Documentation

Definition at line 71 of file Envelope.hxx.


Constructor & Destructor Documentation

CLAM::Envelope::Envelope ( const EnvelopeConfig newConfig)

Constructor class given a concrete configuration.

Parameters:
&newConfigreference 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

void CLAM::Envelope::Configure ( const EnvelopeConfig newConfig)

Create the configuration of Envelope using an EnvelopeConfig instantiation.

Parameters:
&newConfigreference 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().

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

Configuration of Envelope with information about it.

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

BPF, with amplitude returned as TData values.

CLAM::Envelope::DYNAMIC_TYPE_USING_INTERFACE ( Envelope  ,
,
ProcessingData   
)
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().

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.

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::SetBPFSize ( int  s)
inline

Resize the BPF.

Parameters:
sNew size desired

Definition at line 149 of file Envelope.hxx.

void CLAM::Envelope::SetScale ( int  s)
inline

Change the Scale factor.

Parameters:
sNew Scale factor

Definition at line 158 of file Envelope.hxx.


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