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

Configuration class for Overlapp Add Processing. More...

#include <OverlapAdd.hxx>

List of all members.

Public Member Functions

 OverlapAdd (const OverlapAddConfig &c=OverlapAddConfig())
 ~OverlapAdd ()
const ProcessingConfigGetConfig () const
 Configuration getter.
bool Do (void)
 Unsupervised Do method, not implemented.
bool Do (const Audio &in, Audio &out)
 Do method.
- 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 Attributes

OverlapAddConfig mConfig
AudioInPort mInput
AudioOutPort mOutput
Audio mTmp
- 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
- 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)

Detailed Description

Configuration class for Overlapp Add Processing.

HopSize configures the write size of the circular buffer (note that the write size is here understood as the portion of the frame that is overwritten, not added). FrameSize configures the read size of the circular buffer. BufferSize configures the overall physical size of the circular buffer. Currently, HopSize must be hop size, FrameSize must be hop size and BufferSize must be twice hop size (as it will do 50% overlap). OverlapAdd Processing class. First half of the input buffer or audio (which is of buffer size) is added to existing data in the circular buffer (ie. 'mixed in'), second half overwrites existing data. When reading, only already overlapped regions should be given as output (this overlapped region and thus the output will be of frame size).

See also:
OverlapAddConfig

Definition at line 63 of file OverlapAdd.hxx.


Constructor & Destructor Documentation

CLAM::OverlapAdd::OverlapAdd ( const OverlapAddConfig c = OverlapAddConfig())

Definition at line 41 of file OverlapAdd.cxx.

References CLAM::Processing::Configure().

CLAM::OverlapAdd::~OverlapAdd ( )

Definition at line 48 of file OverlapAdd.cxx.


Member Function Documentation

bool CLAM::OverlapAdd::Do ( void  )
virtual
bool CLAM::OverlapAdd::Do ( const Audio in,
Audio out 
)

Do method.

Parameters:
in,:input Audio (size must be buffer size).
out,:output Audio (size must be frame size).

Definition at line 86 of file OverlapAdd.cxx.

References CLAM_DEBUG_ASSERT, CLAM::Audio::GetSize(), mConfig, and mTmp.

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

References mConfig.


Member Data Documentation

OverlapAddConfig CLAM::OverlapAdd::mConfig
protected

Definition at line 93 of file OverlapAdd.hxx.

Referenced by Do(), and GetConfig().

AudioInPort CLAM::OverlapAdd::mInput
protected

Definition at line 95 of file OverlapAdd.hxx.

Referenced by Do().

AudioOutPort CLAM::OverlapAdd::mOutput
protected

Definition at line 96 of file OverlapAdd.hxx.

Referenced by Do().

Audio CLAM::OverlapAdd::mTmp
protected

Definition at line 98 of file OverlapAdd.hxx.

Referenced by Do().


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