CLAM::OverlapAdd Class Reference

#include <OverlapAdd.hxx>

Inheritance diagram for CLAM::OverlapAdd:

CLAM::Processing

List of all members.


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.


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.

Protected Attributes

OverlapAddConfig mConfig
AudioInPort mInput
AudioOutPort mOutput
Audio mTmp

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

const ProcessingConfig& CLAM::OverlapAdd::GetConfig (  )  const [inline, virtual]

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.

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.


Member Data Documentation

Definition at line 93 of file OverlapAdd.hxx.

Referenced by Do(), and GetConfig().

Definition at line 95 of file OverlapAdd.hxx.

Referenced by Do().

Definition at line 96 of file OverlapAdd.hxx.

Referenced by Do().

Definition at line 98 of file OverlapAdd.hxx.

Referenced by Do().


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

Generated on Tue Aug 12 22:33:49 2008 for CLAM by  doxygen 1.5.5