CLAM::SMSHarmonizer Class Reference
#include <SMSHarmonizer.hxx>
Detailed Description
Many voices harmonizer using the SMS model.Harmonizes many voices adding pitch-shifted gained versions of the original voice (with the same timbre)
Definition at line 46 of file SMSHarmonizer.hxx.
Public Types | |
| typedef SMSHarmonizerConfig | Config |
Public Member Functions | |
| SMSHarmonizer () | |
| ~SMSHarmonizer () | |
| bool | Do () |
| Supervised mode execution method (using ports). | |
| bool | Do (const Frame &in, Frame &out) |
| bool | Do (const SpectralPeakArray &inPeaks, const Fundamental &inFund, const Spectrum &inSpectrum, SpectralPeakArray &outPeaks, Fundamental &outFund, Spectrum &outSpectrum) |
| int | IgnoreResidual (TControlData value) |
| const ProcessingConfig & | GetConfig () const |
| Configuration getter. | |
Protected Member Functions | |
| bool | ConcreteConfigure (const ProcessingConfig &config) |
| Configuration method interface. | |
Member Typedef Documentation
Constructor & Destructor Documentation
| CLAM::SMSHarmonizer::SMSHarmonizer | ( | ) | [inline] |
| CLAM::SMSHarmonizer::~SMSHarmonizer | ( | ) | [inline] |
Definition at line 98 of file SMSHarmonizer.hxx.
Member Function Documentation
| bool CLAM::SMSHarmonizer::Do | ( | ) | [inline, virtual] |
Supervised mode execution method (using ports).
- Returns:
- A boolean telling whether it has been output
Implements CLAM::Processing.
Definition at line 100 of file SMSHarmonizer.hxx.
Referenced by Do().
Implements CLAM::FrameTransformation.
Definition at line 88 of file SMSHarmonizer.cxx.
References Do().
| bool CLAM::SMSHarmonizer::Do | ( | const SpectralPeakArray & | inPeaks, | |
| const Fundamental & | inFund, | |||
| const Spectrum & | inSpectrum, | |||
| SpectralPeakArray & | outPeaks, | |||
| Fundamental & | outFund, | |||
| Spectrum & | outSpectrum | |||
| ) |
Definition at line 100 of file SMSHarmonizer.cxx.
References CLAM_pow(), CLAM::SpectrumAdder2::Do(), CLAM::SMSPitchShift::Do(), CLAM::SMSSinusoidalGain::Do(), frand, CLAM::InControl::GetLastValue(), and CLAM::SendFloatToInControl().
| int CLAM::SMSHarmonizer::IgnoreResidual | ( | TControlData | value | ) | [inline] |
Definition at line 130 of file SMSHarmonizer.hxx.
References CLAM::InControl::DoControl(), and CLAM::SMSPitchShift::mIgnoreResidual.
| const ProcessingConfig& CLAM::SMSHarmonizer::GetConfig | ( | ) | const [inline, virtual] |
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::FrameTransformation.
Definition at line 137 of file SMSHarmonizer.hxx.
| bool CLAM::SMSHarmonizer::ConcreteConfigure | ( | const ProcessingConfig & | ) | [protected, virtual] |
Configuration method interface.
The Processing base class forces all the concrete classes derived from it to implement this method, which must actually perform the specific configuration tasks.
Note that the user can not call this method directly. He will use Configure instead. The argument is expected to be an object of the necesary concrete configuration class.
- Parameters:
-
Reference to the configuration object.
- Returns:
- false if the object is not yet fully configured. (For example, if some important configuration attribute such as number of ports was set to zero in the config object)
- Exceptions:
-
This method must throw a bad_cast exception if the argument is not an object of the expected configuration class.
Reimplemented from CLAM::Processing.
Definition at line 39 of file SMSHarmonizer.cxx.
References CLAM::Processing::AddConfigErrorMessage(), CLAM::Processing::Configure(), CLAM::Processing::CopyAsConcreteConfig(), CLAM::InControl::DoControl(), MAX_AMOUNT_OF_VOICES, CLAM::SendFloatToInControl(), CLAM::InControl::SetBounds(), and CLAM::InControl::SetDefaultValue().
The documentation for this class was generated from the following files:
