CLAM::OverlapAdd Class Reference

Configuration class for Overlapp Add Processing. More...

#include <OverlapAdd.hxx>

Public Member Functions
	OverlapAdd (const OverlapAddConfig &c=OverlapAddConfig())
	~OverlapAdd ()
const ProcessingConfig &	GetConfig () 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

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 38 of file OverlapAdd.cxx.

CLAM::OverlapAdd::~OverlapAdd ( )

Definition at line 45 of file OverlapAdd.cxx.

Member Function Documentation

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 83 of file OverlapAdd.cxx.

bool CLAM::OverlapAdd::Do ( void ) [virtual]

Unsupervised Do method, not implemented.

Implements CLAM::Processing.

Definition at line 75 of file OverlapAdd.cxx.

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

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.