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

Processing class for performing a STFT. More...

#include <SpectralAnalysis.hxx>

List of all members.

Public Member Functions

const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
 SpectralAnalysis (SpectralAnalysisConfig &config)
 SpectralAnalysis ()
 ~SpectralAnalysis ()
const ProcessingConfigGetConfig () const
 Configuration getter.
bool Do (void)
 Supervised mode execution.
bool Do (const Audio &in, Spectrum &outSp)
 Basic unsupervised Do method.
bool Do (Frame &in)
 Unsupervised Do method that uses a CLAM Frame as input and output.
bool Do (Segment &in)
 Unsupervised Do method that uses an incoming CLAM Segment as input and output.
- Public Member Functions inherited from CLAM::ProcessingComposite
virtual ~ProcessingComposite ()
void Insert (Processing &o) throw (ErrProcessingObj)
void Remove (Processing &o)
iterator composite_begin ()
iterator composite_end ()
std::size_t composite_size ()
- 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::ProcessingComposite
typedef std::list< Processing * >
::iterator 
iterator
 Processing object composite iterator.
- 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::ProcessingComposite
virtual bool ConcreteStart ()
 Concrete start implementation, called when the user calls Start() on the Processing(Composite), should be used to implement any specific start implementation required by classes deriving from this class.
virtual bool ConcreteStop ()
 See ConcreteStart().
- Protected Member Functions inherited from CLAM::Processing
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)

Detailed Description

Processing class for performing a STFT.

Its main functionality is to obtain a spectrum out of an incoming audio signal, applying windowing, circular shift and zero padding. Its different

Definition at line 51 of file SpectralAnalysis.hxx.


Constructor & Destructor Documentation

CLAM::SpectralAnalysis::SpectralAnalysis ( SpectralAnalysisConfig config)

Definition at line 50 of file SpectralAnalysis.cxx.

References CLAM::Processing::Configure().

CLAM::SpectralAnalysis::SpectralAnalysis ( )

Definition at line 42 of file SpectralAnalysis.cxx.

References CLAM::Processing::Configure().

CLAM::SpectralAnalysis::~SpectralAnalysis ( )

Definition at line 58 of file SpectralAnalysis.cxx.


Member Function Documentation

bool CLAM::SpectralAnalysis::Do ( void  )
virtual
bool CLAM::SpectralAnalysis::Do ( const Audio in,
Spectrum outSp 
)

Basic unsupervised Do method.

It returns an output spectrum using an input audio frame

Definition at line 134 of file SpectralAnalysis.cxx.

References CLAM::CircularShift::Do(), CLAM::BinaryAudioOp< BinOp >::Do(), CLAM::Audio::GetAudioChunk(), CLAM::Audio::GetSize(), CLAM::SpectralAnalysisConfig::GetWindowSize(), and CLAM::Audio::SetSize().

bool CLAM::SpectralAnalysis::Do ( Frame in)

Unsupervised Do method that uses a CLAM Frame as input and output.

AudioFrame attribute of the frame is used as input and Spectrum as output.

See also:
Frame

Definition at line 160 of file SpectralAnalysis.cxx.

References Do().

bool CLAM::SpectralAnalysis::Do ( Segment in)

Unsupervised Do method that uses an incoming CLAM Segment as input and output.

It processes the frame that is indicated by the current frame index in the segment and increments that index.

See also:
Segment

Definition at line 165 of file SpectralAnalysis.cxx.

References Do(), CLAM::Segment::GetFrame(), and CLAM::Segment::mCurrentFrameIndex.

const char* CLAM::SpectralAnalysis::GetClassName ( ) const
inlinevirtual

Override it in every subclass and retur the name of that class.

Reimplemented from CLAM::ProcessingComposite.

Definition at line 58 of file SpectralAnalysis.hxx.

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

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.

Implements CLAM::ProcessingComposite.

Definition at line 66 of file SpectralAnalysis.hxx.


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