CLAM-Development
1.4.0
|
Basic Frequency domain Comb Filter. More...
#include <FDCombFilter.hxx>
Public Member Functions | |
const char * | GetClassName () const |
This method returns the name of the object. | |
FDCombFilter (const Config &c=Config()) | |
Constructor with an object of FDCombFilterConfig class by parameter. | |
~FDCombFilter () | |
Destructor of the class. | |
bool | Do () |
Supervised Do() function, not implemented yet. | |
bool | Do (const Spectrum &input, Spectrum &output) |
Unsupervised Do function, applies an spectral envelope to incoming spectrum. | |
![]() | |
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. | |
virtual const ProcessingConfig & | GetConfig () const |
Configuration getter. | |
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 | mFreq |
Additional Inherited Members | |
![]() | |
enum | ExecState { Unconfigured = 0, Ready, Running } |
Processing Object possible execution states. More... | |
typedef NullProcessingConfig | Config |
![]() | |
virtual bool | ConcreteConfigure (const ProcessingConfig &) |
Configuration method interface. | |
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. | |
InControlRegistry & | GetInControls () |
Accessor to published Controls manager. | |
OutControlRegistry & | GetOutControls () |
Accessor to published Controls manager. | |
InPortRegistry & | GetInPorts () |
Accessor to published Ports manager. | |
OutPortRegistry & | GetOutPorts () |
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) |
![]() | |
ProcessingComposite * | mpParent |
Pointer to the parent (composite) processing object, or 0. | |
Network * | _network |
The parent network if any. |
Basic Frequency domain Comb Filter.
It has one control (mFreq) which sets the fundamental of harmonic series that wants to be amplified.
: add a gain control to be able to filter out harmonic series instead of amplifying it.
: don't know why it does not work correctly with spectrums that have less than 512 bins !!
Definition at line 39 of file FDCombFilter.hxx.
Constructor with an object of FDCombFilterConfig class by parameter.
c | FDCombFilterConfig object created by the user |
Definition at line 32 of file FDCombFilter.cxx.
References CLAM::Processing::Configure(), CLAM::InControl< ControlDataType >::DoControl(), and mFreq.
CLAM::FDCombFilter::~FDCombFilter | ( | ) |
Destructor of the class.
Definition at line 39 of file FDCombFilter.cxx.
|
virtual |
Supervised Do() function, not implemented yet.
Implements CLAM::Processing.
Definition at line 45 of file FDCombFilter.cxx.
References CLAM_ASSERT, and CLASS.
Referenced by CLAM::SMSPitchShift::Do().
Unsupervised Do function, applies an spectral envelope to incoming spectrum.
input | The Spectrum we want to filter |
output | The filtered spectrum |
Definition at line 53 of file FDCombFilter.cxx.
References CLAM_atan2(), CLAM_cos(), CLAM_sin(), CLAM_sqrt(), CLAM::EScale::eLinear, CLAM::EScale::eLog, CLAM::InControl< ControlDataType >::GetLastValue(), CLAM::Spectrum::GetSize(), mFreq, CLAM::Spectrum::SetSize(), CLAM::Spectrum::ToDB(), CLAM::Spectrum::ToLinear(), and TWO_PI.
|
inlinevirtual |
This method returns the name of the object.
Implements CLAM::Processing.
Definition at line 45 of file FDCombFilter.hxx.
FloatInControl CLAM::FDCombFilter::mFreq |
Definition at line 65 of file FDCombFilter.hxx.
Referenced by Do(), CLAM::SMSPitchShift::Do(), and FDCombFilter().