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

Implementation of the IFFT using the Fastest Fourier in the West version 3. More...

#include <IFFT_fftw3.hxx>

List of all members.

Public Member Functions

 IFFT_fftw3 (const IFFTConfig &c=IFFTConfig())
 ~IFFT_fftw3 ()
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
bool Do ()
 Supervised-mode Do function.
bool Do (const Spectrum &in, Audio &out) const
 Standard IFFT Do function, with storage class references as arguments.
bool MayDisableExecution () const
bool SetPrototypes (const Spectrum &in, const Audio &out)
 IFFT non-supervised mode SetPrototypes function.
bool SetPrototypes ()
 Standard supervised-mode SetPrototypes function.
bool UnsetPrototypes ()
 Standard UnsetPrototypes function.
- Public Member Functions inherited from CLAM::IFFT_base
 IFFT_base ()
virtual ~IFFT_base ()
virtual const ProcessingConfigGetConfig () const
 Config access:
- 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

- Protected Types inherited from CLAM::IFFT_base
enum  { CLAM_DEFAULT_IFFT_SIZE = 1024 }
- Protected Member Functions inherited from CLAM::IFFT_base
void ChangeSize (int n)
int GetSize ()
- 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)
- Protected Attributes inherited from CLAM::IFFT_base
IFFTConfig mConfig
 IFFT Configuration.
int mSize
 IFFT size.
InPort< SpectrummInput
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.

Detailed Description

Implementation of the IFFT using the Fastest Fourier in the West version 3.

See also:
FFTW Home Page

Definition at line 35 of file IFFT_fftw3.hxx.


Constructor & Destructor Documentation

CLAM::IFFT_fftw3::IFFT_fftw3 ( const IFFTConfig c = IFFTConfig())

Definition at line 66 of file IFFT_fftw3.cxx.

References CLAM::Processing::Configure().

CLAM::IFFT_fftw3::~IFFT_fftw3 ( )

Definition at line 88 of file IFFT_fftw3.cxx.


Member Function Documentation

bool CLAM::IFFT_fftw3::Do ( )
virtual
bool CLAM::IFFT_fftw3::Do ( const Spectrum in,
Audio out 
) const
virtual

Standard IFFT Do function, with storage class references as arguments.

This method implements the old conversor routines.

Implements CLAM::IFFT_base.

Definition at line 166 of file IFFT_fftw3.cxx.

References CLAM_ASSERT, CLAM::Audio::GetSize(), CLAM::Processing::IsRunning(), and CLAM::IFFT_base::mSize.

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

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

Reimplemented from CLAM::IFFT_base.

Definition at line 77 of file IFFT_fftw3.hxx.

bool CLAM::IFFT_fftw3::MayDisableExecution ( ) const
inlinevirtual

Reimplemented from CLAM::IFFT_base.

Definition at line 81 of file IFFT_fftw3.hxx.

bool CLAM::IFFT_fftw3::SetPrototypes ( const Spectrum in,
const Audio out 
)
virtual
bool CLAM::IFFT_fftw3::SetPrototypes ( )
virtual

Standard supervised-mode SetPrototypes function.

Reimplemented from CLAM::IFFT_base.

Definition at line 188 of file IFFT_fftw3.cxx.

References CLAM_ASSERT.

bool CLAM::IFFT_fftw3::UnsetPrototypes ( )
virtual

Standard UnsetPrototypes function.

Reimplemented from CLAM::IFFT_base.

Definition at line 159 of file IFFT_fftw3.cxx.


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