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

This class performs the interpolation of two Frame processing data objects. More...

#include <FrameAdder.hxx>

List of all members.

Public Member Functions

 FrameAdder ()
 FrameAdder (const FrameAdderConfig &c)
 ~FrameAdder ()
const ProcessingConfigGetConfig () const
 Configuration getter.
bool Do (void)
 Supervised mode execution method (using ports)
bool Do (const Frame &in1, const Frame &in2, Frame &out)
- Public Member Functions inherited from CLAM::ProcessingComposite
virtual ~ProcessingComposite ()
void Insert (Processing &o) throw (ErrProcessingObj)
void Remove (Processing &o)
iterator composite_begin ()
iterator composite_end ()
std::size_t composite_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.

Public Attributes

InPort< FramemIn1
 Ports.
InPort< FramemIn2
OutPort< FramemOut

Additional Inherited Members

- Public Types inherited from CLAM::ProcessingComposite
typedef std::list< Processing * >
::iterator 
iterator
 Processing object composite iterator.
- Public Types inherited from CLAM::Processing
enum  ExecState { Unconfigured = 0, Ready, Running }
 Processing Object possible execution states. More...
typedef NullProcessingConfig Config
- Protected Member Functions inherited from CLAM::ProcessingComposite
virtual bool ConcreteStart ()
 Concrete start implementation, called when the user calls Start() on the Processing(Composite), should be used to implement any specific start implementation required by classes deriving from this class.
virtual bool ConcreteStop ()
 See ConcreteStart().
- Protected Member Functions inherited from CLAM::Processing
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 performs the interpolation of two Frame processing data objects.

Note that only spectral peak array for the sinusoidal component and residual spectrum are interpolated.

Todo:
: maybe other attributes in Frame could also be interpolated if so specified in the configuration.

Definition at line 48 of file FrameAdder.hxx.


Constructor & Destructor Documentation

CLAM::FrameAdder::FrameAdder ( )

Definition at line 30 of file FrameAdder.cxx.

References CLAM::Processing::Configure().

CLAM::FrameAdder::FrameAdder ( const FrameAdderConfig c)

Definition at line 39 of file FrameAdder.cxx.

References CLAM::Processing::Configure().

CLAM::FrameAdder::~FrameAdder ( )
inline

Definition at line 68 of file FrameAdder.hxx.


Member Function Documentation

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

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::ProcessingComposite.

Definition at line 91 of file FrameAdder.cxx.

References CLAM_ASSERT.

bool CLAM::FrameAdder::Do ( const Frame in1,
const Frame in2,
Frame out 
)

we set the output fundamental to zero. Note that when adding two frames we have a polyphonic signal and the representation of the resulting sum of harmonics is not trivial.

Now we add spectral peaks

Finally we add residual spectrum

Definition at line 64 of file FrameAdder.cxx.

References CLAM_DEBUG_ASSERT, CLAM::SpectralPeakArrayAdder::Do(), CLAM::SpectrumAdder2::Do(), and CLAM::Processing::IsRunning().

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

Implements CLAM::ProcessingComposite.

Definition at line 70 of file FrameAdder.hxx.


Member Data Documentation

InPort<Frame> CLAM::FrameAdder::mIn1

Ports.

Definition at line 79 of file FrameAdder.hxx.

InPort<Frame> CLAM::FrameAdder::mIn2

Definition at line 80 of file FrameAdder.hxx.

OutPort<Frame> CLAM::FrameAdder::mOut

Definition at line 81 of file FrameAdder.hxx.


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