CLAM-Development  1.4.0
Public Member Functions
CLAM::SpectralEnvelopeApply Class Reference

Applies an existing spectral envelope to incoming spectral peaks or spectrum. More...

#include <SpectralEnvelopeApply.hxx>

List of all members.

Public Member Functions

 SpectralEnvelopeApply ()
 Base constructor of class.
 SpectralEnvelopeApply (const SpectralEnvelopeApplyConfig &c)
 Constructor with an object of SpectralEnvelopeApplyConfig class by parameter.
 ~SpectralEnvelopeApply ()
 Destructor of the class.
const ProcessingConfigGetConfig () const
 This method allows to obtain the SpectralEnvelopeApplyConfig object of the class.
bool Do (void)
 Supervised Do() function, not implemented yet.
bool Do (const SpectralPeakArray &input, const Spectrum &spectralEnvelope, SpectralPeakArray &output)
 Unsupervised Do function, applies an spectral envelope to incoming Spectral Peaks.
bool Do (const Spectrum &input, const Spectrum &spectralEnvelope, Spectrum &output)
 Unsupervised Do function, applies an spectral envelope to incoming spectrum.
bool SetPrototypes (const SpectralPeakArray &input, Spectrum &output)
 Change the internal type state.
bool SetPrototypes ()
bool UnsetPrototypes ()
bool MayDisableExecution () const
- Public Member Functions inherited from CLAM::Processing
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)
InPortBaseGetInPort (const std::string &name)
OutPortBaseGetOutPort (const std::string &name)
InControlBaseGetInControl (const std::string &name)
OutControlBaseGetOutControl (const std::string &name)
InPortBaseGetInPort (unsigned index)
OutPortBaseGetOutPort (unsigned index)
InControlBaseGetInControl (unsigned index)
OutControlBaseGetOutControl (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.

Additional Inherited Members

- Public Types inherited from CLAM::Processing
enum  ExecState { Unconfigured = 0, Ready, Running }
 Processing Object possible execution states. More...
typedef NullProcessingConfig Config
- Protected Member Functions inherited from CLAM::Processing
virtual bool ConcreteStart ()
 Processing objects have to redefine this method when starting them implies some internal changes.
virtual bool ConcreteStop ()
 Processing objects have to redefine this method when stoping them implies some internal changes.
unsigned BackendBufferSize ()
 Given by the NetworkPlayer (backend) if exists.
unsigned BackendSampleRate ()
 Given by the NetworkPlayer (backend) if exists.
InControlRegistryGetInControls ()
 Accessor to published Controls manager.
OutControlRegistryGetOutControls ()
 Accessor to published Controls manager.
InPortRegistryGetInPorts ()
 Accessor to published Ports manager.
OutPortRegistryGetOutPorts ()
 Accessor to published Portss manager.
bool AddConfigErrorMessage (const std::string &msg)
 Use this method to append a configuration errors to the processing when implementing ConcreteConfigure.
bool AbleToExecute (void) const
 In debug-mode checks that the processing is configured and started.
template<typename ConcreteConfig >
void CopyAsConcreteConfig (ConcreteConfig &concrete, const ProcessingConfig &abstract) const
 Helper template to convert a reference to a ProcessingConfig to the concrete ProcessingConfig specified on the first parameter.
void SetExecState (ExecState state)
- Protected Attributes inherited from CLAM::Processing
ProcessingCompositempParent
 Pointer to the parent (composite) processing object, or 0.
Network_network
 The parent network if any.

Detailed Description

Applies an existing spectral envelope to incoming spectral peaks or spectrum.

Todo:
: the spline interpolation gets a bit out of hand in the ends of the spectral envelope so you may get artifacts in the higher frequencies!!!

Definition at line 48 of file SpectralEnvelopeApply.hxx.


Constructor & Destructor Documentation

CLAM::SpectralEnvelopeApply::SpectralEnvelopeApply ( )

Base constructor of class.

Calls Configure method with a SpectralEnvelopeApplyConfig initialised by default

Definition at line 31 of file SpectralEnvelopeApply.cxx.

References CLAM::Processing::Configure().

CLAM::SpectralEnvelopeApply::SpectralEnvelopeApply ( const SpectralEnvelopeApplyConfig c = SpectralEnvelopeApplyConfig())

Constructor with an object of SpectralEnvelopeApplyConfig class by parameter.

Parameters:
cSpectralEnvelopeApplyConfig object created by the user

Definition at line 36 of file SpectralEnvelopeApply.cxx.

References CLAM::Processing::Configure().

CLAM::SpectralEnvelopeApply::~SpectralEnvelopeApply ( )

Destructor of the class.

Definition at line 41 of file SpectralEnvelopeApply.cxx.


Member Function Documentation

bool CLAM::SpectralEnvelopeApply::Do ( void  )
virtual

Supervised Do() function, not implemented yet.

Implements CLAM::Processing.

Definition at line 73 of file SpectralEnvelopeApply.cxx.

References CLAM_ASSERT, and CLASS.

Referenced by CLAM::SMSSpectralShapeShift::Do(), CLAM::SpectralShapeShift::Do(), and CLAM::SMSPitchShift::Do().

bool CLAM::SpectralEnvelopeApply::Do ( const SpectralPeakArray input,
const Spectrum spectralEnvelope,
SpectralPeakArray output 
)

Unsupervised Do function, applies an spectral envelope to incoming Spectral Peaks.

Parameters:
inputThe SpectralPeaks we want to apply the spectral Envelope to
spectralEnvelopeThe Spectrum that holds the spectral Envelope
outAn SpectralPeakArray object with the new SpectralEnvelope applied
Returns:
Boolean value, true if all has been executed correctly.

Definition at line 80 of file SpectralEnvelopeApply.cxx.

References CLAM_ASSERT, CLAM::SpectralPeakArray::GetnMaxPeaks(), CLAM::SpectralPeakArray::GetnPeaks(), CLAM::BPFTmpl< TX, TY >::GetValue(), CLAM::SpectralPeakArray::SetnMaxPeaks(), and CLAM::SpectralPeakArray::SetnPeaks().

bool CLAM::SpectralEnvelopeApply::Do ( const Spectrum input,
const Spectrum spectralEnvelope,
Spectrum output 
)

Unsupervised Do function, applies an spectral envelope to incoming spectrum.

Parameters:
inputThe Spectrum we want to apply the spectral Envelope to
spectralEnvelopeThe Spectrum that holds the spectral Envelope
outAn Spectrum object with the new SpectralEnvelope applied
Returns:
Boolean value, true if all has been executed correctly.

Definition at line 113 of file SpectralEnvelopeApply.cxx.

References CLAM_ASSERT, CLAM::Spectrum::GetSize(), and CLAM::BPFTmpl< TX, TY >::GetValue().

const ProcessingConfig& CLAM::SpectralEnvelopeApply::GetConfig ( ) const
inlinevirtual

This method allows to obtain the SpectralEnvelopeApplyConfig object of the class.

Returns:
The configuration of the class

Reimplemented from CLAM::Processing.

Definition at line 77 of file SpectralEnvelopeApply.hxx.

bool CLAM::SpectralEnvelopeApply::MayDisableExecution ( ) const
inline

Definition at line 108 of file SpectralEnvelopeApply.hxx.

bool CLAM::SpectralEnvelopeApply::SetPrototypes ( const SpectralPeakArray input,
Spectrum output 
)

Change the internal type state.

Definition at line 56 of file SpectralEnvelopeApply.cxx.

bool CLAM::SpectralEnvelopeApply::SetPrototypes ( )

Definition at line 61 of file SpectralEnvelopeApply.cxx.

bool CLAM::SpectralEnvelopeApply::UnsetPrototypes ( )

Definition at line 66 of file SpectralEnvelopeApply.cxx.


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