CLAM-Development
1.4.0
|
Pitch shift with timbre preservation using the SMS model. More...
#include <SMSPitchShift.hxx>
Public Member Functions | |
SMSPitchShift () | |
~SMSPitchShift () | |
bool | ConcreteConfigure (const ProcessingConfig &config) |
Configuration method interface. | |
bool | Do (const SpectralPeakArray &inPeaks, const Fundamental &inFund, const Spectrum &inRes, SpectralPeakArray &outPeaks, Fundamental &outFund, Spectrum &outRes) |
bool | Do (const Frame &in, Frame &out) |
bool | Do () |
Supervised mode execution method (using ports) | |
![]() | |
FrameTransformation () | |
const ProcessingConfig & | GetConfig () const |
Configuration getter. | |
virtual bool | ConcreteStart () |
Processing objects have to redefine this method when starting them implies some internal changes. | |
virtual bool | InitControls () |
Virtual function to override when needing to give different default values to the controls. | |
![]() | |
bool | Configure (const ProcessingConfig &config) |
Configuration change method. | |
void | Start (void) |
Method to turn the object into running state. | |
void | Stop (void) |
Method to put the object out of running state When in execution mode, this method must be called before any further call to Configure() methods. | |
Processing () | |
virtual | ~Processing () |
virtual bool | CanProcessInplace () |
Override this method if your processing cannot process inplace. | |
bool | CanConsumeAndProduce () |
Check that Supervised Do() can be safely called. | |
void | ConsumeAndProduce () |
Acknoledges data tokens in published ports as read/writen by calling Produce() for all registered OutPorts and Consume() to all registered InPorts. | |
std::string | GetExecStateString () const |
bool | IsConfigured () const |
bool | IsRunning () const |
void | RegisterOutPort (OutPortBase *out) |
void | RegisterInPort (InPortBase *in) |
void | RegisterOutControl (OutControlBase *out) |
void | RegisterInControl (InControlBase *in) |
void | SetParent (Processing *p) |
void | SetNetworkBackLink (Network *network) |
virtual bool | ModifiesPortsAndControlsAtConfiguration () |
This method is used to determine if a given processing can change its interface of ports/controls after its construction (i.e. | |
bool | HasInPort (const std::string &name) |
bool | HasOutPort (const std::string &name) |
bool | HasInControl (const std::string &name) |
bool | HasOutControl (const std::string &name) |
InPortBase & | GetInPort (const std::string &name) |
OutPortBase & | GetOutPort (const std::string &name) |
InControlBase & | GetInControl (const std::string &name) |
OutControlBase & | GetOutControl (const std::string &name) |
InPortBase & | GetInPort (unsigned index) |
OutPortBase & | GetOutPort (unsigned index) |
InControlBase & | GetInControl (unsigned index) |
OutControlBase & | GetOutControl (unsigned index) |
unsigned | GetNInPorts () const |
unsigned | GetNOutPorts () const |
unsigned | GetNInControls () const |
unsigned | GetNOutControls () const |
const std::string & | GetConfigErrorMessage () const |
Returns a string describing configuration errors if any. | |
virtual bool | IsSyncSource () const |
Wether the processing is a sync source such as audio i/o device, or an audio callback hook (i.e. | |
virtual bool | SupportsVariableAudioSize () const |
This method reports whether the processing supports dynamic buffer-size host. |
Public Attributes | |
FloatInControl | mIgnoreResidual |
In some cases, such as in the harmonizer it makes sense to ignore the residual spectrum in order to keep things manageable. |
Additional Inherited Members | |
![]() | |
FrameTransformationConfig | mConfig |
FloatInControl | mAmount |
![]() | |
ProcessingComposite * | mpParent |
Pointer to the parent (composite) processing object, or 0. | |
Network * | _network |
The parent network if any. |
Pitch shift with timbre preservation using the SMS model.
In order to preserve timbre, the original spectral shape is extracted and then applied back.
Definition at line 47 of file SMSPitchShift.hxx.
|
inline |
Definition at line 61 of file SMSPitchShift.hxx.
References CLAM::Processing::Configure().
|
inline |
Definition at line 76 of file SMSPitchShift.hxx.
|
inlinevirtual |
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.
Reference | to the configuration object. |
true if the processing object is left in a consistent state, and can be executed.
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 78 of file SMSPitchShift.hxx.
References CLAM::InControl< ControlDataType >::DoControl(), mIgnoreResidual, CLAM::InControlBase::SetBounds(), and CLAM::InControlBase::SetDefaultValue().
bool CLAM::SMSPitchShift::Do | ( | const SpectralPeakArray & | inPeaks, |
const Fundamental & | inFund, | ||
const Spectrum & | inRes, | ||
SpectralPeakArray & | outPeaks, | ||
Fundamental & | outFund, | ||
Spectrum & | outRes | ||
) |
Definition at line 40 of file SMSPitchShift.cxx.
References CLAM::FDCombFilter::Do(), CLAM::SpectralEnvelopeExtract::Do(), CLAM::SpectralEnvelopeApply::Do(), CLAM::InControl< ControlDataType >::DoControl(), CLAM::Fundamental::GetFreq(), CLAM::InControl< ControlDataType >::GetLastValue(), CLAM::Fundamental::GetnCandidates(), CLAM::SpectralPeakArray::GetnPeaks(), CLAM::FrameTransformation::mConfig, CLAM::FDCombFilter::mFreq, mIgnoreResidual, CLAM::Fundamental::SetFreq(), and CLAM::SpectralPeakArray::SetnPeaks().
Referenced by CLAM::SMSPitchDiscretization::Do(), CLAM::SMSGenderChange::Do(), CLAM::SegmentSMSHarmonizer::Do(), and CLAM::SMSHarmonizer::Do().
Implements CLAM::FrameTransformation.
Definition at line 111 of file SMSPitchShift.cxx.
References Do().
|
inlinevirtual |
Supervised mode execution method (using ports)
Implements CLAM::Processing.
Definition at line 99 of file SMSPitchShift.hxx.
References CLAM::InPort< Token >::Consume(), CLAM::InPort< Token >::GetData(), CLAM::OutPort< Token >::GetData(), and CLAM::OutPort< Token >::Produce().
Referenced by Do().
FloatInControl CLAM::SMSPitchShift::mIgnoreResidual |
In some cases, such as in the harmonizer it makes sense to ignore the residual spectrum in order to keep things manageable.
This should if fact be a configuration param, but we don't want to introduce specific params that prevent us from using the generic one
Definition at line 128 of file SMSPitchShift.hxx.
Referenced by ConcreteConfigure(), Do(), CLAM::SegmentSMSHarmonizer::IgnoreResidual(), and CLAM::SMSHarmonizer::IgnoreResidual().