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

Implementation of the FFT using the algorithm in Numerical Recipies in C. More...

#include <FFT_numrec.hxx>

List of all members.

Public Member Functions

 FFT_numrec ()
 FFT_numrec (const FFTConfig &c)
 ~FFT_numrec ()
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 Audio &in, Spectrum &out)
 Standard FFT Do function, with storage class references as arguments.
bool MayDisableExecution () const
- Public Member Functions inherited from CLAM::FFT_base
 FFT_base ()
virtual ~FFT_base ()
const ProcessingConfigGetConfig () const
 Configuration access:
bool SetPrototypes (const Audio &in, const Spectrum &out)
 FFT non-supervised mode SetPrototypes function.
bool SetPrototypes ()
 Standard supervised-mode SetPrototypes function.
bool UnsetPrototypes ()
 Standard UnsetPrototypes function.
void CheckTypes (const Audio &in, const Spectrum &out) const
virtual bool DisableExecution ()
virtual bool EnableExecution ()
virtual void ToOther (Spectrum &out)
- 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::FFT_base
enum  FFTState { sComplex, sComplexSync, sOther }
- Protected Member Functions inherited from CLAM::FFT_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::FFT_base
Spectrum mComplexSpectrum
 Auxiliary spectrum used if output spectrum does not have complex array.
FFTConfig mConfig
 FFT Configuration.
int mSize
 FFT size.
FFTState mState
 I/O Prototype state of the FFT object.
FFTState mBackupState
 When the object enters "Disabled" mode, it stores the previoius state here.
AudioInPort mInput
OutPort< SpectrummOutput
TDatafftbuffer
 Internal output buffer.
- Protected Attributes inherited from CLAM::Processing
ProcessingCompositempParent
 Pointer to the parent (composite) processing object, or 0.
Network_network
 The parent network if any.
- Static Protected Attributes inherited from CLAM::FFT_base
static SpecTypeFlags mComplexflags
 Auxiliary flags structure, used to add the complex attribute.

Detailed Description

Implementation of the FFT using the algorithm in Numerical Recipies in C.

See also:
Numerical Recipies Home Page

Definition at line 41 of file FFT_numrec.hxx.


Constructor & Destructor Documentation

CLAM::FFT_numrec::FFT_numrec ( )

Definition at line 65 of file FFT_numrec.cxx.

References CLAM::Processing::Configure().

CLAM::FFT_numrec::FFT_numrec ( const FFTConfig c)

Definition at line 70 of file FFT_numrec.cxx.

References CLAM::Processing::Configure().

CLAM::FFT_numrec::~FFT_numrec ( )

Definition at line 75 of file FFT_numrec.cxx.


Member Function Documentation

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

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

This method implements the old conversor routines. The resulting spectrum will be of input audio size / 2 + 1. Input audio must be a power-of-two.

Implements CLAM::FFT_base.

Definition at line 88 of file FFT_numrec.cxx.

References CLAM::FFT_base::CheckTypes(), CLAM_ASSERT, CLAM_DEBUG_ASSERT, CLAM::FFT_base::fftbuffer, CLAM::Processing::IsRunning(), CLAM::FFT_base::mComplexflags, CLAM::FFT_base::mSize, CLAM::FFT_base::mState, CLAM::FFT_base::sComplex, CLAM::FFT_base::sComplexSync, CLAM::FFT_base::sOther, CLAM::Spectrum::SynchronizeTo(), and CLAM::FFT_base::ToOther().

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

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

Implements CLAM::Processing.

Definition at line 64 of file FFT_numrec.hxx.

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

Reimplemented from CLAM::FFT_base.

Definition at line 74 of file FFT_numrec.hxx.


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