CLAM-Development
1.4.0
|
This class can be used for generating Windows and for zeropadding the windowed data. More...
#include <WindowGenerator.hxx>
Public Types | |
typedef WindowGeneratorConfig | Config |
![]() | |
enum | ExecState { Unconfigured = 0, Ready, Running } |
Processing Object possible execution states. More... |
Public Member Functions | |
WindowGenerator (const WindowGeneratorConfig &c=Config()) | |
~WindowGenerator () | |
const ProcessingConfig & | GetConfig () 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) |
![]() | |
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. |
Protected Attributes | |
AudioOutPort | mOutput |
![]() | |
ProcessingComposite * | mpParent |
Pointer to the parent (composite) processing object, or 0. | |
Network * | _network |
The parent network if any. |
Additional Inherited Members | |
![]() | |
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) |
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.
Reimplemented from CLAM::Processing.
Definition at line 82 of file WindowGenerator.hxx.
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.
|
virtual |
Supervised mode execution method (using ports)
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 | ) |
Definition at line 96 of file WindowGenerator.cxx.
References CLAM::EWindowType::eHamming, CLAM::InControl< ControlDataType >::GetLastValue(), CLAM::Array< T >::GetPtr(), and CLAM::Array< T >::Size().
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().
|
inlinevirtual |
Configuration getter.
Gets the configuration parameters used to create the object.
Reimplemented from CLAM::Processing.
Definition at line 98 of file WindowGenerator.hxx.
|
inline |
Definition at line 106 of file WindowGenerator.hxx.
|
inline |
Definition at line 108 of file WindowGenerator.hxx.
References CLAM_DEBUG_ASSERT, and CLAM::InControl< ControlDataType >::DoControl().
|
protected |
Definition at line 115 of file WindowGenerator.hxx.
Referenced by Do().