CLAM-Development  1.4.0
Public Types | Public Member Functions | Protected Attributes
CLAM::WindowGenerator Class Reference

This class can be used for generating Windows and for zeropadding the windowed data. More...

#include <WindowGenerator.hxx>

List of all members.

Public Types

typedef WindowGeneratorConfig Config
- Public Types inherited from CLAM::Processing
enum  ExecState { Unconfigured = 0, Ready, Running }
 Processing Object possible execution states. More...

Public Member Functions

 WindowGenerator (const WindowGeneratorConfig &c=Config())
 ~WindowGenerator ()
const ProcessingConfigGetConfig () const
 Configuration getter.
bool Do (void)
 Supervised mode execution method (using ports)
bool Do (DataArray &output)
bool Do (Spectrum &output)
bool Do (Audio &output)
bool MayDisableExecution () const
void SetSize (TSize 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.

Protected Attributes

AudioOutPort mOutput
- Protected Attributes inherited from CLAM::Processing
ProcessingCompositempParent
 Pointer to the parent (composite) processing object, or 0.
Network_network
 The parent network if any.

Additional Inherited Members

- 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)

Detailed Description

This class can be used for generating Windows and for zeropadding the windowed data.

The Do functions accept different types of data, which are simple Arrays, Audio and Spectrum.

If the window is smaller as the Data Array then the rest of the Array is filled with Zeroes.

The Size of the window can be changed via a control, the Type (Hamming,Kaiser, etc) is fixed. A configuration option is to generate the window everytime the Do() function is called. This is settable via the UseTable element of the configuration.

Note: The last and the first element of the window always have the same value, therefore, if you want to use it for windowing an FFT, you have to create a window of size FFTSize+1. (if you care for correctness) This class can be used for generating Windows and for zeropadding the windowed data. The Do functions accept different types of data, which are simple Arrays, Audio and Spectrum.

If the window is smaller as the Data Array then the rest of the Array is filled with Zeroes.

The Size of the window can be changed via a control, the Type (Hamming,Kaiser, etc) is fixed. A configuration option is to generate the window everytime the Do() function is called. This is settable via the UseTable element of the configuration.

Note: The last and the first element of the window always have the same value, therefore, if you want to use it for windowing an FFT, you have to create a window of size FFTSize+1. (if you care for correctness)

Definition at line 80 of file WindowGenerator.hxx.


Member Typedef Documentation

Reimplemented from CLAM::Processing.

Definition at line 82 of file WindowGenerator.hxx.


Constructor & Destructor Documentation

CLAM::WindowGenerator::WindowGenerator ( const WindowGeneratorConfig c = Config())

Definition at line 45 of file WindowGenerator.cxx.

References CLAM::Processing::Configure().

CLAM::WindowGenerator::~WindowGenerator ( )

Definition at line 52 of file WindowGenerator.cxx.


Member Function Documentation

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

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 85 of file WindowGenerator.cxx.

References CLAM::Processing::AbleToExecute(), CLAM_ASSERT, CLAM::AudioOutPort::GetAudio(), mOutput, and CLAM::OutPort< Token >::Produce().

Referenced by Do().

bool CLAM::WindowGenerator::Do ( DataArray output)
bool CLAM::WindowGenerator::Do ( Spectrum output)

Definition at line 133 of file WindowGenerator.cxx.

References CLAM_ASSERT, and Do().

bool CLAM::WindowGenerator::Do ( Audio output)

Definition at line 125 of file WindowGenerator.cxx.

References Do().

const ProcessingConfig& CLAM::WindowGenerator::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.

Reimplemented from CLAM::Processing.

Definition at line 98 of file WindowGenerator.hxx.

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

Definition at line 106 of file WindowGenerator.hxx.

void CLAM::WindowGenerator::SetSize ( TSize  size)
inline

Member Data Documentation

AudioOutPort CLAM::WindowGenerator::mOutput
protected

Definition at line 115 of file WindowGenerator.hxx.

Referenced by Do().


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