CLAM::FrameTransformation Class Reference

#include <FrameTransformation.hxx>

List of all members.

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.
Protected Attributes
FrameTransformationConfig	mConfig
FloatInControl	mAmount

---

Detailed Description

Definition at line 11 of file FrameTransformation.hxx.

---

Constructor & Destructor Documentation

CLAM::FrameTransformation::FrameTransformation

(

)

[inline]

Definition at line 14 of file FrameTransformation.hxx.

References FrameTransformation(), and mAmount.

Referenced by FrameTransformation().

---

Member Function Documentation

virtual bool CLAM::FrameTransformation::ConcreteStart

(

void

)

[inline, virtual]

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 22 of file FrameTransformation.hxx.

References mConfig.

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

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

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

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

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

Definition at line 20 of file FrameTransformation.hxx.

virtual bool CLAM::FrameTransformation::InitControls

(

)

[inline, virtual]

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

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

Definition at line 25 of file FrameTransformation.hxx.

References CLAM::InControl< ControlDataType >::DoControl(), and mAmount.

---

Member Data Documentation

FloatInControl CLAM::FrameTransformation::mAmount [protected]

Definition at line 35 of file FrameTransformation.hxx.

Referenced by FrameTransformation(), CLAM::SpectralSpread::InitControls(), CLAM::SpectralReverse::InitControls(), CLAM::SpectralNotch::InitControls(), CLAM::SpectralGate::InitControls(), CLAM::SampleAndHold::InitControls(), CLAM::Partializer::InitControls(), and InitControls().

FrameTransformationConfig CLAM::FrameTransformation::mConfig [protected]

Definition at line 33 of file FrameTransformation.hxx.

Referenced by CLAM::SMSSineFilter::ConcreteConfigure(), CLAM::SegmentSMSHarmonizer::ConcreteConfigure(), ConcreteStart(), CLAM::SpectralPhaseModulation::Do(), CLAM::SpectralDelay::Do(), CLAM::SMSSpectralShapeShift::Do(), CLAM::SMSPitchShift::Do(), CLAM::SMSSineFilter::GetConfig(), CLAM::SMSSineFilter::InitBPF(), CLAM::SMSSineFilter::SMSSineFilter(), and CLAM::SegmentSMSHarmonizer::UpdateBPF().

---

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

• FrameTransformation.hxx