CLAM::EnvExtractorConfig Class Reference
#include <EnvelopeExtractor.hxx>
Detailed Description
Definition at line 91 of file EnvelopeExtractor.hxx.
Public Member Functions | |
| DYNAMIC_TYPE_USING_INTERFACE (EnvExtractorConfig, 9, ProcessingConfig) | |
| DYN_ATTRIBUTE (0, public, TData, SampleRate) | |
| DYN_ATTRIBUTE (1, public, int, FrameSize) | |
| Number of samples in each audio input frame. | |
| DYN_ATTRIBUTE (2, public, ControlConfig, InterpolationPeriod) | |
| Time period between envelope interpolation points, in miliseconds. | |
| DYN_ATTRIBUTE (3, public, ControlConfig, IntegrationLength) | |
| Number of mIlliseconds of audio to use for the "average" of each new envelope interpolation point. | |
| DYN_ATTRIBUTE (4, public, int, NInterpPointsPerFrame) | |
| Number of envelope interpolation points to use for each audio frame. | |
| DYN_ATTRIBUTE (5, public, int, NMemoryPoints) | |
| Number of interpolation segments (possibly from previous audio frames) to add up to the average used to calculate each new interpolation point. | |
| DYN_ATTRIBUTE (6, public, ControlConfig, NormalLevel) | |
| DYN_ATTRIBUTE (7, public, ControlConfig, SilenceLevel) | |
| DYN_ATTRIBUTE (8, public, EInterpolation, InterpolationType) | |
Protected Member Functions | |
| void | DefaultInit (void) |
| The concrete dynamic type constructor calls DefaultInit(). | |
Member Function Documentation
| CLAM::EnvExtractorConfig::DYNAMIC_TYPE_USING_INTERFACE | ( | EnvExtractorConfig | , | |
| 9 | , | |||
| ProcessingConfig | ||||
| ) |
| CLAM::EnvExtractorConfig::DYN_ATTRIBUTE | ( | 0 | , | |
| public | , | |||
| TData | , | |||
| SampleRate | ||||
| ) |
| CLAM::EnvExtractorConfig::DYN_ATTRIBUTE | ( | 1 | , | |
| public | , | |||
| int | , | |||
| FrameSize | ||||
| ) |
Number of samples in each audio input frame.
| CLAM::EnvExtractorConfig::DYN_ATTRIBUTE | ( | 2 | , | |
| public | , | |||
| ControlConfig | , | |||
| InterpolationPeriod | ||||
| ) |
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.
| CLAM::EnvExtractorConfig::DYN_ATTRIBUTE | ( | 3 | , | |
| public | , | |||
| ControlConfig | , | |||
| IntegrationLength | ||||
| ) |
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.
| CLAM::EnvExtractorConfig::DYN_ATTRIBUTE | ( | 4 | , | |
| public | , | |||
| int | , | |||
| NInterpPointsPerFrame | ||||
| ) |
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.
| CLAM::EnvExtractorConfig::DYN_ATTRIBUTE | ( | 5 | , | |
| public | , | |||
| int | , | |||
| NMemoryPoints | ||||
| ) |
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.
| CLAM::EnvExtractorConfig::DYN_ATTRIBUTE | ( | 6 | , | |
| public | , | |||
| ControlConfig | , | |||
| NormalLevel | ||||
| ) |
| CLAM::EnvExtractorConfig::DYN_ATTRIBUTE | ( | 7 | , | |
| public | , | |||
| ControlConfig | , | |||
| SilenceLevel | ||||
| ) |
| CLAM::EnvExtractorConfig::DYN_ATTRIBUTE | ( | 8 | , | |
| public | , | |||
| EInterpolation | , | |||
| InterpolationType | ||||
| ) |
| 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 91 of file EnvelopeExtractor.cxx.
References CLAM::EInterpolation::eLinear, and CLAM::DynamicType::UpdateData().
The documentation for this class was generated from the following files:
