CLAM-Development
1.4.0
|
Processing which does sinusoidal peak tracking (or continuation). More...
#include <SinTracking.hxx>
Public Member Functions | |
SinTracking () | |
SinTracking (const SinTrackingConfig &c) | |
~SinTracking () | |
const ProcessingConfig & | GetConfig () const |
Configuration getter. | |
bool | Do (const SpectralPeakArray &iPeakArray, SpectralPeakArray &oPeakArray) |
bool | Do (void) |
Supervised mode execution method (using ports) | |
int | GetnTracks () const |
![]() | |
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. |
Additional Inherited Members | |
![]() | |
enum | ExecState { Unconfigured = 0, Ready, Running } |
Processing Object possible execution states. More... | |
typedef NullProcessingConfig | Config |
![]() | |
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. |
Processing which does sinusoidal peak tracking (or continuation).
In order for SinTracking to produce meaningful results, it must be called repeatively using SpectralPeakArrays generated from the different 'frames' of the same input material (ie, if you want to track two different sources, you must use two seperate SinTrackings).
Definition at line 62 of file SinTracking.hxx.
CLAM::SinTracking::SinTracking | ( | ) |
Definition at line 30 of file SinTracking.cxx.
References CLAM::Processing::Configure().
CLAM::SinTracking::SinTracking | ( | const SinTrackingConfig & | c | ) |
Definition at line 38 of file SinTracking.cxx.
References CLAM::Processing::Configure().
CLAM::SinTracking::~SinTracking | ( | ) |
Definition at line 47 of file SinTracking.cxx.
bool CLAM::SinTracking::Do | ( | const SpectralPeakArray & | iPeakArray, |
SpectralPeakArray & | oPeakArray | ||
) |
Definition at line 101 of file SinTracking.cxx.
References CLAM::InControl< ControlDataType >::GetLastValue(), and CLAM::DynamicType::UpdateData().
Referenced by CLAM::SMSAnalysisCore::Do().
|
virtual |
Supervised mode execution method (using ports)
Implements CLAM::Processing.
Definition at line 93 of file SinTracking.cxx.
References CLAM::InPort< Token >::Consume(), CLAM::InPort< Token >::GetData(), CLAM::OutPort< Token >::GetData(), and CLAM::OutPort< Token >::Produce().
|
inlinevirtual |
Configuration getter.
Gets the configuration parameters used to create the object.
Reimplemented from CLAM::Processing.
Definition at line 84 of file SinTracking.hxx.
|
inline |
Definition at line 90 of file SinTracking.hxx.