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

This Processing class takes an input audio buffer and shifts it to get zero-phase conditions in the STFT. More...

#include <CircularShift.hxx>

List of all members.

Public Member Functions

 CircularShift ()
 CircularShift (const CircularShiftConfig &c)
 ~CircularShift ()
const ProcessingConfigGetConfig () const
 Configuration getter.
bool Do (void)
 Supervised mode execution method (using ports)
bool Do (const DataArray &input, DataArray &out)
bool Do (Spectrum &input, Spectrum &out)
bool Do (const Audio &input, Audio &out)
bool SetPrototypes (Spectrum &inputs, const Spectrum &out)
 Not implemented yet.
bool SetPrototypes ()
 Not implemented yet.
bool UnsetPrototypes ()
 Not implemented yet.
bool MayDisableExecution () const
 Not implemented yet.
void SetAmount (TSize amount)
- 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 Member Functions

const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
bool ConcreteConfigure (const ProcessingConfig &)
 Config change method.
- 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

CircularShiftConfig mConfig
AudioInPort mInput
AudioOutPort mOutput
FloatInControl mSteps
- 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

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

Detailed Description

This Processing class takes an input audio buffer and shifts it to get zero-phase conditions in the STFT.

Definition at line 42 of file CircularShift.hxx.


Constructor & Destructor Documentation

CLAM::CircularShift::CircularShift ( )

Definition at line 31 of file CircularShift.cxx.

References CLAM::Processing::Configure().

CLAM::CircularShift::CircularShift ( const CircularShiftConfig c)

Definition at line 39 of file CircularShift.cxx.

References CLAM::Processing::Configure().

CLAM::CircularShift::~CircularShift ( )

Definition at line 47 of file CircularShift.cxx.


Member Function Documentation

bool CLAM::CircularShift::ConcreteConfigure ( const ProcessingConfig c)
protectedvirtual

Config change method.

Reimplemented from CLAM::Processing.

Definition at line 53 of file CircularShift.cxx.

References CLAM::Processing::CopyAsConcreteConfig(), CLAM::InControl< ControlDataType >::DoControl(), mConfig, and mSteps.

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

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 80 of file CircularShift.cxx.

References CLAM::InPort< Token >::Consume(), CLAM::AudioInPort::GetAudio(), CLAM::AudioOutPort::GetAudio(), mInput, mOutput, and CLAM::OutPort< Token >::Produce().

Referenced by CLAM::AudioWindowing::Do(), Do(), CLAM::SpectralAnalysis::Do(), and CLAM::SpectralSynthesis::Do().

bool CLAM::CircularShift::Do ( const DataArray input,
DataArray out 
)
bool CLAM::CircularShift::Do ( Spectrum input,
Spectrum out 
)

Definition at line 127 of file CircularShift.cxx.

References CLAM_ASSERT, and Do().

bool CLAM::CircularShift::Do ( const Audio input,
Audio out 
)

Definition at line 135 of file CircularShift.cxx.

References Do().

const char* CLAM::CircularShift::GetClassName ( ) const
inlineprotectedvirtual

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

Implements CLAM::Processing.

Definition at line 53 of file CircularShift.hxx.

const ProcessingConfig& CLAM::CircularShift::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 66 of file CircularShift.hxx.

References mConfig.

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

Not implemented yet.

Definition at line 83 of file CircularShift.hxx.

void CLAM::CircularShift::SetAmount ( TSize  amount)
inline

Definition at line 85 of file CircularShift.hxx.

References CLAM::InControl< ControlDataType >::DoControl(), and mSteps.

bool CLAM::CircularShift::SetPrototypes ( Spectrum inputs,
const Spectrum out 
)

Not implemented yet.

Definition at line 63 of file CircularShift.cxx.

bool CLAM::CircularShift::SetPrototypes ( )

Not implemented yet.

Definition at line 68 of file CircularShift.cxx.

bool CLAM::CircularShift::UnsetPrototypes ( )

Not implemented yet.

Definition at line 73 of file CircularShift.cxx.


Member Data Documentation

CircularShiftConfig CLAM::CircularShift::mConfig
protected

Definition at line 45 of file CircularShift.hxx.

Referenced by ConcreteConfigure(), and GetConfig().

AudioInPort CLAM::CircularShift::mInput
protected

Definition at line 47 of file CircularShift.hxx.

Referenced by Do().

AudioOutPort CLAM::CircularShift::mOutput
protected

Definition at line 48 of file CircularShift.hxx.

Referenced by Do().

FloatInControl CLAM::CircularShift::mSteps
protected

Definition at line 50 of file CircularShift.hxx.

Referenced by ConcreteConfigure(), Do(), and SetAmount().


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