CLAM::EnvExtractorConfig Class Reference

#include <EnvelopeExtractor.hxx>

List of all members.

Public Member Functions

 EnvExtractorConfig ()
 EnvExtractorConfig (const EnvExtractorConfig &prototype, const bool shareData=false, const bool deep=true)
 __COMMON_DYNAMIC_TYPE (EnvExtractorConfig, 9)
 __COMMON_DYN_ATTRIBUTE (0, public, TData, SampleRate) protected
bool LoadSampleRate (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (1, public, int, FrameSize) protected
 Number of samples in each audio input frame.
bool LoadFrameSize (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (2, public, ControlConfig, InterpolationPeriod) protected
 Time period between envelope interpolation points, in miliseconds.
bool LoadInterpolationPeriod (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (3, public, ControlConfig, IntegrationLength) protected
 Number of mIlliseconds of audio to use for the "average" of each new envelope interpolation point.
bool LoadIntegrationLength (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (4, public, int, NInterpPointsPerFrame) protected
 Number of envelope interpolation points to use for each audio frame.
bool LoadNInterpPointsPerFrame (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (5, public, int, NMemoryPoints) protected
 Number of interpolation segments (possibly from previous audio frames) to add up to the average used to calculate each new interpolation point.
bool LoadNMemoryPoints (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (6, public, ControlConfig, NormalLevel) protected
bool LoadNormalLevel (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (7, public, ControlConfig, SilenceLevel) protected
bool LoadSilenceLevel (CLAM::Storage &s)
 __COMMON_DYN_ATTRIBUTE (8, public, EInterpolation, InterpolationType) protected
bool LoadInterpolationType (CLAM::Storage &s)

Protected Member Functions

void DefaultInit (void)
 The concrete dynamic type constructor calls DefaultInit().

Detailed Description

Definition at line 91 of file EnvelopeExtractor.hxx.


Constructor & Destructor Documentation

CLAM::EnvExtractorConfig::EnvExtractorConfig (  )  [inline]

Definition at line 94 of file EnvelopeExtractor.hxx.

CLAM::EnvExtractorConfig::EnvExtractorConfig ( const EnvExtractorConfig prototype,
const bool  shareData = false,
const bool  deep = true 
) [inline]

Definition at line 94 of file EnvelopeExtractor.hxx.


Member Function Documentation

CLAM::EnvExtractorConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
EInterpolation  ,
InterpolationType   
) [inline]

Definition at line 154 of file EnvelopeExtractor.hxx.

CLAM::EnvExtractorConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
ControlConfig  ,
SilenceLevel   
) [inline]

Definition at line 152 of file EnvelopeExtractor.hxx.

CLAM::EnvExtractorConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
ControlConfig  ,
NormalLevel   
) [inline]

Definition at line 150 of file EnvelopeExtractor.hxx.

CLAM::EnvExtractorConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
int  ,
NMemoryPoints   
) [inline]

Number of interpolation segments (possibly from previous audio frames) to add up to the average used to calculate each new interpolation point.

At least 1 point must be used, so that the last segment in the previous frame is used in the new one.

The bigger this value is, the smoother the envelope will be. It will also introduce a delay in the envelope from the original audio signal.

If you would rather like to use time units to specify the length of the envelope "integration period", you can use the IntegrationLength attribute, leaving this one to zero. If both are non-zero, this one will be used.

Definition at line 148 of file EnvelopeExtractor.hxx.

CLAM::EnvExtractorConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
int  ,
NInterpPointsPerFrame   
) [inline]

Number of envelope interpolation points to use for each audio frame.

If you prefer to use time units, you can use the InterpolationPeriod attribute instead, (leaving this one to 0). If both are non-zero, this one will be used.

Definition at line 133 of file EnvelopeExtractor.hxx.

CLAM::EnvExtractorConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
ControlConfig  ,
IntegrationLength   
) [inline]

Number of mIlliseconds of audio to use for the "average" of each new envelope interpolation point.

The bigger this value is, the smoother the envelope will be. It will also introduce a delay in the envelope from the original audio signal.

If you would rather like to specify the exact amount of interpolationn segments to use for the average, you can use the InterpolationPeriod attribute, leaving this with a value of 0.0. If both attributes are non-zero, this one will be used.

Definition at line 126 of file EnvelopeExtractor.hxx.

CLAM::EnvExtractorConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
ControlConfig  ,
InterpolationPeriod   
) [inline]

Time period between envelope interpolation points, in miliseconds.

If you prefer to specify the exact amount of interpolation points to use in each audio frame, you can use the NInterpPointsPerFrame attribute, leaving this one with 0.0. If both are non-zero, the other one will be used.

Note that currently the actual interpolation period used in the processing object will be rounded so that there are always interpolation points exactly at the beginning and at the end of each audio frame, for eficiency reasons. This may change in future.

Definition at line 112 of file EnvelopeExtractor.hxx.

CLAM::EnvExtractorConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
int  ,
FrameSize   
) [inline]

Number of samples in each audio input frame.

Definition at line 98 of file EnvelopeExtractor.hxx.

CLAM::EnvExtractorConfig::__COMMON_DYN_ATTRIBUTE ( ,
public  ,
TData  ,
SampleRate   
) [inline]

Definition at line 95 of file EnvelopeExtractor.hxx.

CLAM::EnvExtractorConfig::__COMMON_DYNAMIC_TYPE ( EnvExtractorConfig  ,
 
)
void CLAM::EnvExtractorConfig::DefaultInit ( void   )  [protected]

The concrete dynamic type constructor calls DefaultInit().

This allows user to initialize his/her object. But we define DefaultInit() here because we don't want to force writting one DefaultInit() function for each concrete dynamic type. If a dynamic type concrete class defines some (not-default) constructors, this should also call the DefaultInit().

See also:
CopyInit()

Reimplemented from CLAM::DynamicType.

Definition at line 89 of file EnvelopeExtractor.cxx.

References CLAM::EInterpolation::eLinear, and CLAM::DynamicType::UpdateData().

bool CLAM::EnvExtractorConfig::LoadFrameSize ( CLAM::Storage s  )  [inline]

Definition at line 98 of file EnvelopeExtractor.hxx.

bool CLAM::EnvExtractorConfig::LoadIntegrationLength ( CLAM::Storage s  )  [inline]

Definition at line 126 of file EnvelopeExtractor.hxx.

bool CLAM::EnvExtractorConfig::LoadInterpolationPeriod ( CLAM::Storage s  )  [inline]

Definition at line 112 of file EnvelopeExtractor.hxx.

bool CLAM::EnvExtractorConfig::LoadInterpolationType ( CLAM::Storage s  )  [inline]

Definition at line 154 of file EnvelopeExtractor.hxx.

bool CLAM::EnvExtractorConfig::LoadNInterpPointsPerFrame ( CLAM::Storage s  )  [inline]

Definition at line 133 of file EnvelopeExtractor.hxx.

bool CLAM::EnvExtractorConfig::LoadNMemoryPoints ( CLAM::Storage s  )  [inline]

Definition at line 148 of file EnvelopeExtractor.hxx.

bool CLAM::EnvExtractorConfig::LoadNormalLevel ( CLAM::Storage s  )  [inline]

Definition at line 150 of file EnvelopeExtractor.hxx.

bool CLAM::EnvExtractorConfig::LoadSampleRate ( CLAM::Storage s  )  [inline]

Definition at line 95 of file EnvelopeExtractor.hxx.

bool CLAM::EnvExtractorConfig::LoadSilenceLevel ( CLAM::Storage s  )  [inline]

Definition at line 152 of file EnvelopeExtractor.hxx.


The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.3