#include <FrameTransformation.hxx>

Public Member Functions
	FrameTransformation ()
virtual bool	Do (const Frame &in, Frame &out)=0
const ProcessingConfig &	GetConfig () const
	Configuration getter.
virtual bool	ConcreteStart ()
	Processing objects have to redefine this method when starting them implies some internal changes.
virtual bool	InitControls ()
	Virtual function to override when needing to give different default values to the controls.
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.
virtual bool	Do (void)=0
	Supervised mode execution method (using ports)
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 const char *	GetClassName () const =0
	Override it in every subclass and retur the name of that class.
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)
InPortBase &	GetInPort (const std::string &name)
OutPortBase &	GetOutPort (const std::string &name)
InControlBase &	GetInControl (const std::string &name)
OutControlBase &	GetOutControl (const std::string &name)
InPortBase &	GetInPort (unsigned index)
OutPortBase &	GetOutPort (unsigned index)
InControlBase &	GetInControl (unsigned index)
OutControlBase &	GetOutControl (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
FrameTransformationConfig	mConfig
FloatInControl	mAmount
Protected Attributes inherited from CLAM::Processing
ProcessingComposite *	mpParent
	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	ConcreteConfigure (const ProcessingConfig &)
	Configuration method interface.
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.
InControlRegistry &	GetInControls ()
	Accessor to published Controls manager.
OutControlRegistry &	GetOutControls ()
	Accessor to published Controls manager.
InPortRegistry &	GetInPorts ()
	Accessor to published Ports manager.
OutPortRegistry &	GetOutPorts ()
	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

Definition at line 13 of file FrameTransformation.hxx.

Constructor & Destructor Documentation

CLAM::FrameTransformation::FrameTransformation ( )

inline

Definition at line 16 of file FrameTransformation.hxx.

Member Function Documentation

virtual bool CLAM::FrameTransformation::ConcreteStart ( void )

inlinevirtual

Processing objects have to redefine this method when starting them implies some internal changes.

ie: adquiring resources.

Returns:: Whether start changes have been successful

Reimplemented from CLAM::Processing.

Definition at line 24 of file FrameTransformation.hxx.

References InitControls().

virtual bool CLAM::FrameTransformation::Do	(	const Frame &	in,
		Frame &	out
	)

pure virtual

Implemented in CLAM::SMSSineFilter, CLAM::SMSHarmonizer, CLAM::SegmentSMSHarmonizer, CLAM::ThreeBandFilter, CLAM::SMSPitchShift, CLAM::SMSGenderChange, CLAM::ThreeBandCompressor, CLAM::SpectralDelay, CLAM::OscillatingSpectralNotch, CLAM::SpectralFocus, CLAM::SMSPitchDiscretization, CLAM::SpectralShapeShift, CLAM::ThreeBandAM, CLAM::SpectralSpread, CLAM::ThreeBandGate, CLAM::Vocoder, CLAM::Deesser, CLAM::HumRemover, CLAM::SpectralExciter, CLAM::SpectralNotch, CLAM::SpectralPhaseModulation, CLAM::SpectralAmplitudeModulation, CLAM::SpectralRingModulation, CLAM::Partializer, CLAM::Peakalizer, CLAM::SpectralCombDelta, CLAM::SpectralCombTriang, CLAM::SMSSinusoidalGain, CLAM::SMSSpectralShapeShift, CLAM::SMSTranspose, CLAM::Robotization, CLAM::SMSDeesser, CLAM::SMSResidualGain, CLAM::SpectralAverage, CLAM::SpectralGate, CLAM::SpectralReverse, CLAM::SMSOddEvenHarmonicRatio, CLAM::SMSFreqShift, CLAM::FreqShift, CLAM::NoSpectralTransformation, CLAM::SpectralReject, CLAM::RandomPhase, CLAM::SampleAndHold, and CLAM::SpectralLimiter.

Referenced by CLAM::SegmentTransformation::Do().

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

Reimplemented in CLAM::SMSHarmonizer, and CLAM::SMSSineFilter.

Definition at line 22 of file FrameTransformation.hxx.

References mConfig.

virtual bool CLAM::FrameTransformation::InitControls ( )

inlinevirtual

Virtual function to override when needing to give different default values to the controls.

Reimplemented in CLAM::ThreeBandCompressor, CLAM::SpectralFocus, CLAM::SpectralSpread, CLAM::ThreeBandAM, CLAM::Vocoder, CLAM::ThreeBandGate, CLAM::SpectralPhaseModulation, CLAM::Deesser, CLAM::SpectralAmplitudeModulation, CLAM::SpectralRingModulation, CLAM::HumRemover, CLAM::SpectralNotch, CLAM::SampleAndHold, CLAM::SpectralExciter, CLAM::Partializer, CLAM::Peakalizer, CLAM::SpectralCombDelta, CLAM::SpectralCombTriang, CLAM::SpectralAverage, CLAM::SpectralGate, and CLAM::SpectralReverse.