CLAM::Processing Class Reference

The base class for all the CLAM processing object classes. More...

#include <Processing.hxx>

Public Types
enum	ExecState { Unconfigured = 0, Ready, Running }
	Processing Object possible execution states. More...
typedef NullProcessingConfig	Config
Public Member Functions
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.
virtual const ProcessingConfig &	GetConfig () const
	Configuration getter.
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 Member Functions
virtual bool	ConcreteConfigure (const ProcessingConfig &)
	Configuration method interface.
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.
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)
Protected Attributes
ProcessingComposite *	mpParent
	Pointer to the parent (composite) processing object, or 0.
Network *	_network
	The parent network if any.
Friends
class	InPortBase
class	OutPortBase
class	InControlBase
class	OutControlBase

Detailed Description

The base class for all the CLAM processing object classes.

Processing is the base class for all the CLAM processing object classes. It defines their shared interface and contains common infrastructure. Processings are the building blocks for any CLAM system, they are an abstraction of an audio/music processing step.

Whenever the Do method is called, the processing consumes data tokens from its input ports and produces data tokens for its output ports performing a single processing step. Each port is related to a given C++ data type and the number of tokens that are seen/consumed/produced at every Do step is flexible, even at running mode.

A processing can also receive an event from another one in an asyncronous way in order to change the way the processing is done. Asyncronous comunication is done using the Control abstraction.

See also:: InPortBase, OutPortBase, InControlBase, OutControlBase

An initial setup is needed before using any processing. You can specify this initial setup by providing the procesing with a configuration object (an instance of the proper ProcessingConfig subclass) containing all the parameters.

See also:: ProcessingConfig

Definition at line 185 of file Processing.hxx.

Member Typedef Documentation

typedef NullProcessingConfig CLAM::Processing::Config

Reimplemented in CLAM::AudioFileMemoryLoader, CLAM::BinaryControlOp< BinOp >, CLAM::AudioWindowing, CLAM::WindowGenerator, CLAM::AudioAmplifier, CLAM::AudioBufferAmplifier, CLAM::Control2Data, CLAM::ADSR, CLAM::SimpleOscillator, CLAM::PhaseManagement, CLAM::SMSHarmonizer, CLAM::SMSMorph, and CLAM::SMSTimeStretch.

Definition at line 194 of file Processing.hxx.

Member Enumeration Documentation

enum CLAM::Processing::ExecState

Processing Object possible execution states.

Enumerator:

Unconfigured
Ready
Running

Definition at line 188 of file Processing.hxx.

Constructor & Destructor Documentation

CLAM::Processing::Processing ( )

Definition at line 135 of file Processing.cxx.

CLAM::Processing::~Processing ( ) [virtual]

Definition at line 171 of file Processing.cxx.

Member Function Documentation

bool CLAM::Processing::AbleToExecute ( void ) const [inline, protected]

In debug-mode checks that the processing is configured and started.

And always checks it's not disabled

Definition at line 490 of file Processing.hxx.

References CLAM_BEGIN_DEBUG_CHECK, CLAM_DEBUG_ASSERT, CLAM_END_DEBUG_CHECK, GetClassName(), and IsRunning().

Referenced by CLAM::WindowGenerator::Do(), CLAM::SynthSineSpectrum::Do(), CLAM::SimpleOscillator::Do(), CLAM::PortMonitor< TheDataType, ThePortType >::Do(), CLAM::Oscillator::Do(), CLAM::LPC_AutoCorrelation::Do(), CLAM::AudioOut::Do(), and CLAM::AudioIn::Do().

bool CLAM::Processing::AddConfigErrorMessage ( const std::string & msg ) [protected]

Use this method to append a configuration errors to the processing when implementing ConcreteConfigure.

For convenience, it returns false so when a configuration error is found, you can append the message and return from ConcreteConfigure in a single statement.

Definition at line 256 of file Processing.cxx.

Referenced by CLAM::SDIFOut::ConcreteStart(), CLAM::MultiChannelAudioFileWriter::ConcreteStart(), CLAM::ControlTraceReader::ConcreteStart(), CLAM::ControlTraceWriter::ConcreteStop(), and CLAM::FFT_numrec::FFT_numrec().

unsigned CLAM::Processing::BackendBufferSize ( ) [protected]

Given by the NetworkPlayer (backend) if exists.

Definition at line 203 of file Processing.cxx.

References CLAM_ASSERT, ConcreteStop(), IsRunning(), Ready, and CLAM::Err::what().

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

unsigned CLAM::Processing::BackendSampleRate ( ) [protected]

Given by the NetworkPlayer (backend) if exists.

Definition at line 212 of file Processing.cxx.

bool CLAM::Processing::CanConsumeAndProduce ( )

Check that Supervised Do() can be safely called.

Definition at line 264 of file Processing.cxx.

References _network.

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

virtual bool CLAM::Processing::CanProcessInplace ( ) [inline, virtual]

Override this method if your processing cannot process inplace.

Reimplemented in CLAM::SegmentSMSTimeStretch.

Definition at line 249 of file Processing.hxx.

virtual bool CLAM::Processing::ConcreteConfigure ( const ProcessingConfig & ) [inline, protected, virtual]

Configuration method interface.

The Processing base class forces all the concrete classes derived from it to implement this method, which must actually perform the specific configuration tasks.

Note that the user can not call this method directly. He will use Configure instead. The argument is expected to be an object of the necesary concrete configuration class.

Parameters:

Reference

to the configuration object.

Returns:: false if the object is not yet fully configured. (For example, if some important configuration attribute such as number of ports was set to zero in the config object)

true if the processing object is left in a consistent state, and can be executed.

Exceptions:

This

method must throw a bad_cast exception if the argument is not an object of the expected configuration class.

Reimplemented in CLAM::AudioFileMemoryLoader, CLAM::MonoAudioFileReader, CLAM::MonoAudioFileWriter, CLAM::MultiChannelAudioFileReader, CLAM::MultiChannelAudioFileWriter, CLAM::BinaryControlOp< BinOp >, CLAM::CepstralTransform, CLAM::CircularShift, CLAM::DescriptorComputation, CLAM::FFT_base, CLAM::FFT_fftw3, CLAM::LPC_AutoCorrelation, CLAM::MelFilterBank, CLAM::SpectralPeakDetect, CLAM::TonalAnalysis, CLAM::ZeroPadder, CLAM::AudioAmplifier, CLAM::AudioBufferAmplifier, CLAM::AudioBufferMixer, CLAM::AudioMixer, CLAM::AudioBufferSink, CLAM::AudioBufferSource, CLAM::AudioIn, CLAM::AudioOut, CLAM::AudioSink, CLAM::AudioSource, CLAM::ProcessingComposite, CLAM::TopLevelProcessing, CLAM::AutoPanner, CLAM::Control2Data, CLAM::ControlComparison, CLAM::ControlFade, CLAM::ControlIntervalMapper, CLAM::Controller, CLAM::ControlMapper, CLAM::ControlPrinter, CLAM::ControlPrinterTyped, CLAM::ControlScaler, CLAM::ControlSelector, CLAM::ControlSum, CLAM::ControlTraceReader, CLAM::ControlTraceWriter, CLAM::FlagControl, CLAM::Fundamental2Control, CLAM::OutControlSender, CLAM::ControlSink, CLAM::ControlSource, CLAM::ADSR, CLAM::Dispatcher, CLAM::Oscillator, CLAM::SimpleOscillator, CLAM::MIDI2Melody, CLAM::MIDIClocker, CLAM::MIDIDispatcher, CLAM::MIDIFileReader, CLAM::MIDIFileWriter, CLAM::MIDIIn, CLAM::MIDIInControl, CLAM::MIDIKeyboard, CLAM::MIDIOut, CLAM::MIDIOutControl, CLAM::LadspaWrapper, CLAM::LadspaWrapperBuffer, CLAM::IFFT_base, CLAM::PhaseManagement, CLAM::SynthSineSpectrum, CLAM::EnvelopeGenerator, CLAM::SegmentSMSHarmonizer, CLAM::SegmentSMSMorph, CLAM::SegmentSMSTimeStretch, CLAM::SegmentTransformation, CLAM::SMSGenderChange, CLAM::SMSHarmonizer, CLAM::SMSMorph, CLAM::SMSPitchShift, CLAM::SMSResidualGain, CLAM::SMSSineFilter, CLAM::SMSSinusoidalGain, CLAM::SMSTimeStretch, CLAM::SMSTransformationChain, CLAM::SMSTranspose, CLAM::ThreeBandFilter, CLAM::OscillatingSpectralNotch, CLAM::Robotization, CLAM::SpectralDelay, CLAM::TokenDelay< T >, CLAM::TokenDelay< SpectralPeakArray >, and CLAM::TokenDelay< Spectrum >.

Definition at line 271 of file Processing.hxx.

virtual bool CLAM::Processing::ConcreteStart ( void ) [inline, protected, 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 in CLAM::AudioFileMemoryLoader, CLAM::MonoAudioFileReader, CLAM::MonoAudioFileWriter, CLAM::MultiChannelAudioFileReader, CLAM::MultiChannelAudioFileWriter, CLAM::CepstralTransform, CLAM::SMSAnalysis, CLAM::SMSAnalysisCore, CLAM::TonalAnalysis, CLAM::ZeroPadder, CLAM::AudioIn, CLAM::AudioOut, CLAM::ProcessingComposite, CLAM::ControlTraceReader, CLAM::OutControlSender, CLAM::MIDIClocker, CLAM::MIDIIn, CLAM::MIDIOut, CLAM::PortMonitor< TheDataType, ThePortType >, CLAM::LadspaWrapper, CLAM::LadspaWrapperBuffer, CLAM::SDIFIn, CLAM::SDIFOut, CLAM::FrameTransformation, CLAM::SegmentSMSMorph, CLAM::SegmentSMSTimeStretch, CLAM::SegmentTransformation, CLAM::SMSTimeStretch, CLAM::SMSTransformationChain, CLAM::PortMonitor< Audio, AudioInPort >, CLAM::PortMonitor< SpectralPeakArray >, CLAM::PortMonitor< Fundamental >, and CLAM::PortMonitor< Spectrum >.

Definition at line 278 of file Processing.hxx.

virtual bool CLAM::Processing::ConcreteStop ( ) [inline, protected, virtual]

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

ie: releasing resources.

Returns:: Whether stop changes have been successful

Reimplemented in CLAM::MonoAudioFileReader, CLAM::MonoAudioFileWriter, CLAM::MultiChannelAudioFileReader, CLAM::MultiChannelAudioFileWriter, CLAM::TonalAnalysis, CLAM::ZeroPadder, CLAM::AudioOut, CLAM::ProcessingComposite, CLAM::ControlTraceWriter, CLAM::PortMonitor< TheDataType, ThePortType >, CLAM::LadspaWrapper, CLAM::LadspaWrapperBuffer, CLAM::SDIFIn, CLAM::SDIFOut, CLAM::SegmentSMSTimeStretch, CLAM::SMSTimeStretch, CLAM::PortMonitor< Audio, AudioInPort >, CLAM::PortMonitor< SpectralPeakArray >, CLAM::PortMonitor< Fundamental >, and CLAM::PortMonitor< Spectrum >.

Definition at line 285 of file Processing.hxx.

Referenced by BackendBufferSize().

bool CLAM::Processing::Configure ( const ProcessingConfig & config )

Configuration change method.

This is the method to be used in order to update the configuration of a processing object. Note that the object must NOT be running when calling this method. This method performs some execution state checkings and updates, and calls the ConcreteConfigure method of the concrete class to perform the actual configuration.

Parameters:

config

Reference to the configuration object.

Exceptions:

ErrProcessingObj

if the processing object is in running or disabled state, or if the argument is not an object of the configuration class matching the concrete processing class of the processing object.

TODO we should use here an ErrConfiguring class. PA

Definition at line 142 of file Processing.cxx.

Referenced by CLAM::AudioAmplifier::AudioAmplifier(), CLAM::AudioBufferAmplifier::AudioBufferAmplifier(), CLAM::AudioBufferSink::AudioBufferSink(), CLAM::AudioBufferSource::AudioBufferSource(), CLAM::AudioIn::AudioIn(), CLAM::AudioMixer::AudioMixer(), CLAM::AudioSink::AudioSink(), CLAM::AudioSource::AudioSource(), CLAM::AudioWindowing::AudioWindowing(), CLAM::BinaryAudioOp< Multiply< TData > >::BinaryAudioOp(), CLAM::BinaryControlOp< BinOp >::BinaryControlOp(), CLAM::CircularShift::CircularShift(), CLAM::SynthSineSpectrum::ConcreteConfigure(), CLAM::SegmentSMSHarmonizer::ConcreteConfigure(), CLAM::ControlTraceReader::ConcreteConfigure(), CLAM::ControlTraceWriter::ConcreteConfigure(), CLAM::Control2Data::Control2Data(), CLAM::Controller::Controller(), CLAM::ControlPiano::ControlPiano(), CLAM::ControlPrinter::ControlPrinter(), CLAM::Deesser::Deesser(), CLAM::Dispatcher::Dispatcher(), CLAM::FFT_numrec::Do(), CLAM::EnvelopeExtractor::EnvelopeExtractor(), CLAM::EnvelopeGenerator::EnvelopeGenerator(), CLAM::FDCombFilter::FDCombFilter(), CLAM::FFT_ooura::FFT_ooura(), CLAM::FreqShift::FreqShift(), CLAM::Fund2MIDI::Fund2MIDI(), CLAM::Fundamental2Control::Fundamental2Control(), CLAM::FundFreqDetect::FundFreqDetect(), CLAM::HumRemover::HumRemover(), CLAM::IFFT_ooura::IFFT_ooura(), CLAM::MIDIClocker::MIDIClocker(), CLAM::MIDIIn::MIDIIn(), CLAM::MIDIOut::MIDIOut(), CLAM::NoSpectralTransformation::NoSpectralTransformation(), CLAM::OscillatingSpectralNotch::OscillatingSpectralNotch(), CLAM::Partializer::Partializer(), CLAM::Peakalizer::Peakalizer(), CLAM::PortMonitor< TheDataType, ThePortType >::PortMonitor(), CLAM::RandomPhase::RandomPhase(), CLAM::Robotization::Robotization(), CLAM::SampleAndHold::SampleAndHold(), CLAM::SDIFIn::SDIFIn(), CLAM::SDIFOut::SDIFOut(), CLAM::Segmentator::Segmentator(), CLAM::SegmentSMSHarmonizer::SegmentSMSHarmonizer(), CLAM::SegmentTransformation::SegmentTransformation(), CLAM::SimpleOscillator::SimpleOscillator(), CLAM::SMSAnalysisCore::SMSAnalysisCore(), CLAM::SMSDeesser::SMSDeesser(), CLAM::SMSFreqShift::SMSFreqShift(), CLAM::SMSGenderChange::SMSGenderChange(), CLAM::SMSHarmonizer::SMSHarmonizer(), CLAM::SMSMorph::SMSMorph(), CLAM::SMSOddEvenHarmonicRatio::SMSOddEvenHarmonicRatio(), CLAM::SMSPitchDiscretization::SMSPitchDiscretization(), CLAM::SMSPitchShift::SMSPitchShift(), CLAM::SMSResidualGain::SMSResidualGain(), CLAM::SMSSineFilter::SMSSineFilter(), CLAM::SMSSinusoidalGain::SMSSinusoidalGain(), CLAM::SMSSpectralShapeShift::SMSSpectralShapeShift(), CLAM::SMSTimeStretch::SMSTimeStretch(), CLAM::SMSTranspose::SMSTranspose(), CLAM::SpectralAmplitudeModulation::SpectralAmplitudeModulation(), CLAM::SpectralAnalysis::SpectralAnalysis(), CLAM::SpectralAverage::SpectralAverage(), CLAM::SpectralCombDelta::SpectralCombDelta(), CLAM::SpectralCombTriang::SpectralCombTriang(), CLAM::SpectralDelay::SpectralDelay(), CLAM::SpectralEnvelopeApply::SpectralEnvelopeApply(), CLAM::SpectralEnvelopeExtract::SpectralEnvelopeExtract(), CLAM::SpectralExciter::SpectralExciter(), CLAM::SpectralFocus::SpectralFocus(), CLAM::SpectralGate::SpectralGate(), CLAM::SpectralLimiter::SpectralLimiter(), CLAM::SpectralNotch::SpectralNotch(), CLAM::SpectralPeakArrayAdder::SpectralPeakArrayAdder(), CLAM::SpectralPeakArrayInterpolator::SpectralPeakArrayInterpolator(), CLAM::SpectralPeakDetect::SpectralPeakDetect(), CLAM::SpectralPhaseModulation::SpectralPhaseModulation(), CLAM::SpectralReject::SpectralReject(), CLAM::SpectralReverse::SpectralReverse(), CLAM::SpectralRingModulation::SpectralRingModulation(), CLAM::SpectralShapeShift::SpectralShapeShift(), CLAM::SpectralSpread::SpectralSpread(), CLAM::SpectralSynthesis::SpectralSynthesis(), CLAM::SpectrumAdder2::SpectrumAdder2(), CLAM::SpectrumInterpolator::SpectrumInterpolator(), CLAM::SynthSineSpectrum::SynthSineSpectrum(), CLAM::ThreeBandAM::ThreeBandAM(), CLAM::ThreeBandCompressor::ThreeBandCompressor(), CLAM::ThreeBandFilter::ThreeBandFilter(), CLAM::ThreeBandGate::ThreeBandGate(), CLAM::TokenDelay< Spectrum >::TokenDelay(), CLAM::Vocoder::Vocoder(), CLAM::WaveGenerator::WaveGenerator(), CLAM::WindowGenerator::WindowGenerator(), CLAM::ControlSelector::~ControlSelector(), CLAM::ControlTraceReader::~ControlTraceReader(), and CLAM::ControlTraceWriter::~ControlTraceWriter().

void CLAM::Processing::ConsumeAndProduce ( )

Acknoledges data tokens in published ports as read/writen by calling Produce() for all registered OutPorts and Consume() to all registered InPorts.

Definition at line 275 of file Processing.cxx.

References CLAM::InPortRegistry::AreReadyForReading(), CLAM::OutPortRegistry::AreReadyForWriting(), GetClassName(), GetInPorts(), GetOutPorts(), and IsRunning().

template<typename ConcreteConfig >

void CLAM::Processing::CopyAsConcreteConfig	(	ConcreteConfig &	concrete,
		const ProcessingConfig &	abstract
	)			const `[inline, protected]`

Helper template to convert a reference to a ProcessingConfig to the concrete ProcessingConfig specified on the first parameter.

Parameters:

	concrete	The copy destination (it forces the runtime type for abstract)
	abstract	A reference to the configuration to be copied

Precondition:: The object runtime type must be exactly the type required by the first parameter

Definition at line 505 of file Processing.hxx.

References CLAM_ASSERT.

virtual bool CLAM::Processing::Do ( void ) [pure virtual]

Supervised mode execution method (using ports).

Returns:: A boolean telling whether it has been output

Implemented in CLAM::AudioFileMemoryLoader, CLAM::MonoAudioFileReader, CLAM::MonoAudioFileWriter, CLAM::MultiChannelAudioFileReader, CLAM::MultiChannelAudioFileWriter, CLAM::BinaryControlOp< BinOp >, CLAM::AudioWindowing, CLAM::CepstralTransform, CLAM::CircularShift, CLAM::CleanTracks, CLAM::DescriptorComputation, CLAM::ERB_SpaceGen, CLAM::FFT_base, CLAM::FFT_fftw3, CLAM::FFT_numrec, CLAM::FFT_ooura, CLAM::FundFreqDetect, CLAM::LPC_AutoCorrelation, CLAM::MelFilterBank, CLAM::Segmentator, CLAM::SinTracking, CLAM::SMSAnalysis, CLAM::SMSAnalysisCore, CLAM::SpectralAnalysis, CLAM::SpectralEnvelopeExtract, CLAM::SpectralPeakDetect, CLAM::TonalAnalysis, CLAM::WindowGenerator, CLAM::ZeroPadder, CLAM::AudioAmplifier, CLAM::AudioBufferAmplifier, CLAM::AudioBufferMixer, CLAM::AudioMixer, CLAM::BinaryAudioOp< BinOp >, CLAM::FrameAdder, CLAM::FrameInterpolator, CLAM::SpectralPeakArrayAdder, CLAM::SpectralPeakArrayInterpolator, CLAM::SpectrumAdder, CLAM::SpectrumAdder2, CLAM::SpectrumInterpolator, CLAM::SpectrumProduct, CLAM::SpectrumSubstracter2, CLAM::AudioBufferSink, CLAM::AudioBufferSource, CLAM::AudioIn, CLAM::AudioOut, CLAM::AudioSink, CLAM::AudioSource, CLAM::ProcessingComposite, CLAM::TopLevelProcessing, CLAM::AutoPanner, CLAM::Control2Data, CLAM::ControlComparison, CLAM::ControlFade, CLAM::ControlIntervalMapper, CLAM::Controller, CLAM::ControlMapper, CLAM::ControlPiano, CLAM::ControlPrinter, CLAM::ControlPrinterTyped, CLAM::ControlScaler, CLAM::ControlSelector, CLAM::ControlSum, CLAM::ControlTraceReader, CLAM::ControlTraceWriter, CLAM::FlagControl, CLAM::Fundamental2Control, CLAM::OutControlSender, CLAM::ControlSink, CLAM::ControlSource, CLAM::ADSR, CLAM::Dispatcher, CLAM::Instrument, CLAM::Oscillator, CLAM::SimpleOscillator, CLAM::WaveGenerator, CLAM::Fund2MIDI, CLAM::MIDIClocker, CLAM::MIDIDispatcher, CLAM::MIDIFileReader, CLAM::MIDIFileWriter, CLAM::MIDIIn, CLAM::MIDIKeyboard, CLAM::MIDIOut, CLAM::PortMonitor< TheDataType, ThePortType >, CLAM::LadspaWrapper, CLAM::LadspaWrapperBuffer, CLAM::SDIFIn, CLAM::SDIFInStreaming, CLAM::SDIFOut, CLAM::IFFT_base, CLAM::IFFT_fftw3, CLAM::IFFT_ooura, CLAM::OverlapAdd, CLAM::PhaseManagement, CLAM::SinusoidalSynthesis, CLAM::SMSSynthesis, CLAM::SpectralSynthesis, CLAM::SynthSineSpectrum, CLAM::EnvelopeExtractor, CLAM::EnvelopeGenerator, CLAM::EnvelopeModulator, CLAM::FDCombFilter, CLAM::FDFilterGen, CLAM::Normalization, CLAM::SegmentSMSHarmonizer, CLAM::SegmentSMSMorph, CLAM::SegmentSMSTimeStretch, CLAM::SegmentTransformation, CLAM::SMSDeesser, CLAM::SMSFreqShift, CLAM::SMSGenderChange, CLAM::SMSHarmonizer, CLAM::SMSMorph, CLAM::SMSOddEvenHarmonicRatio, CLAM::SMSPitchDiscretization, CLAM::SMSPitchShift, CLAM::SMSResidualGain, CLAM::SMSSineFilter, CLAM::SMSSinusoidalGain, CLAM::SMSSpectralShapeShift, CLAM::SMSTimeStretch, CLAM::SMSTransformationChain, CLAM::SMSTransformationChainIO, 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, CLAM::Vocoder, CLAM::SpectralEnvelopeApply, CLAM::TokenDelay< T >, CLAM::BinaryAudioOp< Multiply< TData > >, CLAM::PortMonitor< Audio, AudioInPort >, CLAM::PortMonitor< SpectralPeakArray >, CLAM::PortMonitor< Fundamental >, CLAM::PortMonitor< Spectrum >, CLAM::TokenDelay< SpectralPeakArray >, CLAM::TokenDelay< Spectrum >, CLAM::PortMonitor< TheDataType, ThePortType >, and CLAM::PortMonitor< TheDataType, ThePortType >.

virtual const char* CLAM::Processing::GetClassName ( ) const [pure virtual]

Override it in every subclass and retur the name of that class.

Implemented in CLAM::AudioFileMemoryLoader, CLAM::MonoAudioFileReader, CLAM::MonoAudioFileWriter, CLAM::MultiChannelAudioFileReader, CLAM::MultiChannelAudioFileWriter, CLAM::AudioWindowing, CLAM::CepstralTransform, CLAM::CircularShift, CLAM::DescriptorComputation, CLAM::ERB_SpaceGen, CLAM::FFT_fftw3, CLAM::FFT_numrec, CLAM::FFT_ooura, CLAM::LPC_AutoCorrelation, CLAM::MelFilterBank, CLAM::Segmentator, CLAM::SMSAnalysis, CLAM::SMSAnalysisCore, CLAM::SpectralAnalysis, CLAM::SpectralPeakDetect, CLAM::TonalAnalysis, CLAM::ZeroPadder, CLAM::AudioBufferMixer, CLAM::AudioMixer, CLAM::BinaryAudioOp< BinOp >, CLAM::AudioBufferSink, CLAM::AudioBufferSource, CLAM::AudioIn, CLAM::AudioOut, CLAM::AudioSink, CLAM::AudioSource, CLAM::ProcessingComposite, CLAM::TopLevelProcessing, CLAM::AutoPanner, CLAM::Control2Data, CLAM::ControlComparison, CLAM::ControlFade, CLAM::ControlIntervalMapper, CLAM::Controller, CLAM::ControlMapper, CLAM::ControlPiano, CLAM::ControlPrinter, CLAM::ControlPrinterTyped, CLAM::ControlScaler, CLAM::ControlSelector, CLAM::ControlSum, CLAM::ControlTraceReader, CLAM::ControlTraceWriter, CLAM::FlagControl, CLAM::Fundamental2Control, CLAM::OutControlSender, CLAM::ControlSink, CLAM::ControlSource, CLAM::ADSR, CLAM::Dispatcher, CLAM::Instrument, CLAM::Oscillator, CLAM::SimpleOscillator, CLAM::Fund2MIDI, CLAM::MIDIClocker, CLAM::MIDIDispatcher, CLAM::MIDIFileReader, CLAM::MIDIFileWriter, CLAM::MIDIIn, CLAM::MIDIInControl, CLAM::MIDIKeyboard, CLAM::MIDIOut, CLAM::MIDIOutControl, CLAM::PortMonitor< TheDataType, ThePortType >, CLAM::PeaksPortMonitor, CLAM::SinTracksPortMonitor, CLAM::SpectrumPortMonitor, CLAM::SpecgramPortMonitor, CLAM::FundamentalPortMonitor, CLAM::FundTrackPortMonitor, CLAM::AudioPortMonitor, CLAM::AudioBuffPortMonitor, CLAM::LadspaWrapper, CLAM::LadspaWrapperBuffer, CLAM::SDIFIn, CLAM::SDIFInStreaming, CLAM::SDIFOut, CLAM::IFFT_base, CLAM::IFFT_fftw3, CLAM::IFFT_ooura, CLAM::PhaseManagement, CLAM::SinusoidalSynthesis, CLAM::SMSSynthesis, CLAM::SpectralSynthesis, CLAM::SynthSineSpectrum, CLAM::EnvelopeExtractor, CLAM::EnvelopeGenerator, CLAM::EnvelopeModulator, CLAM::FDCombFilter, CLAM::Normalization, CLAM::SegmentSMSMorph, CLAM::SegmentSMSTimeStretch, CLAM::SegmentTransformation, CLAM::SMSFreqShift, 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::SpectralGate, CLAM::SpectralLimiter, CLAM::SpectralNotch, CLAM::SpectralPhaseModulation, CLAM::SpectralReject, CLAM::SpectralReverse, CLAM::SpectralRingModulation, CLAM::Vocoder, CLAM::TokenDelay< T >, CLAM::BinaryAudioOp< Multiply< TData > >, CLAM::PortMonitor< Audio, AudioInPort >, CLAM::PortMonitor< SpectralPeakArray >, CLAM::PortMonitor< Fundamental >, CLAM::PortMonitor< Spectrum >, CLAM::TokenDelay< SpectralPeakArray >, CLAM::TokenDelay< Spectrum >, CLAM::BinaryControlOp< BinOp >, CLAM::BinaryAudioOp< BinOp >, and CLAM::BinaryAudioOp< BinOp >.

Referenced by AbleToExecute(), ConsumeAndProduce(), CLAM::Hidden::ProcessingClass2LadspaBase::CreateDescriptor(), CLAM::NaiveFlowControl::ProcessingAddedToNetwork(), and CLAM::ProcessingDefinitionAdapter::StoreOn().

const ProcessingConfig & CLAM::Processing::GetConfig ( ) const [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 in CLAM::AudioFileMemoryLoader, CLAM::MonoAudioFileReader, CLAM::MonoAudioFileWriter, CLAM::MultiChannelAudioFileReader, CLAM::MultiChannelAudioFileWriter, CLAM::BinaryControlOp< BinOp >, CLAM::AudioWindowing, CLAM::CepstralTransform, CLAM::CircularShift, CLAM::CleanTracks, CLAM::DescriptorComputation, CLAM::ERB_SpaceGen, CLAM::FFT_base, CLAM::FundFreqDetect, CLAM::LPC_AutoCorrelation, CLAM::MelFilterBank, CLAM::Segmentator, CLAM::SinTracking, CLAM::SMSAnalysis, CLAM::SMSAnalysisCore, CLAM::SpectralAnalysis, CLAM::SpectralEnvelopeExtract, CLAM::SpectralPeakDetect, CLAM::TonalAnalysis, CLAM::WindowGenerator, CLAM::ZeroPadder, CLAM::AudioAmplifier, CLAM::AudioBufferAmplifier, CLAM::AudioBufferMixer, CLAM::AudioMixer, CLAM::BinaryAudioOp< BinOp >, CLAM::FrameAdder, CLAM::FrameInterpolator, CLAM::SpectralPeakArrayInterpolator, CLAM::SpectrumAdder, CLAM::SpectrumAdder2, CLAM::SpectrumInterpolator, CLAM::SpectrumSubstracter2, CLAM::AudioBufferSink, CLAM::AudioBufferSource, CLAM::AudioIn, CLAM::AudioOut, CLAM::AudioSink, CLAM::AudioSource, CLAM::ProcessingComposite, CLAM::TopLevelProcessing, CLAM::AutoPanner, CLAM::Control2Data, CLAM::ControlComparison, CLAM::ControlFade, CLAM::ControlIntervalMapper, CLAM::Controller, CLAM::ControlMapper, CLAM::ControlPrinter, CLAM::ControlPrinterTyped, CLAM::ControlScaler, CLAM::ControlSelector, CLAM::ControlSum, CLAM::ControlTraceReader, CLAM::ControlTraceWriter, CLAM::FlagControl, CLAM::Fundamental2Control, CLAM::OutControlSender, CLAM::ControlSink, CLAM::ControlSource, CLAM::ADSR, CLAM::Dispatcher, CLAM::Oscillator, CLAM::SimpleOscillator, CLAM::WaveGenerator, CLAM::MIDIClocker, CLAM::MIDIDispatcher, CLAM::MIDIFileReader, CLAM::MIDIFileWriter, CLAM::MIDIIn, CLAM::MIDIKeyboard, CLAM::MIDIOut, CLAM::SDIFIn, CLAM::SDIFInStreaming, CLAM::SDIFOut, CLAM::IFFT_base, CLAM::OverlapAdd, CLAM::PhaseManagement, CLAM::SinusoidalSynthesis, CLAM::SMSSynthesis, CLAM::SpectralSynthesis, CLAM::SynthSineSpectrum, CLAM::EnvelopeExtractor, CLAM::EnvelopeGenerator, CLAM::EnvelopeModulator, CLAM::FDFilterGen, CLAM::Normalization, CLAM::FrameTransformation, CLAM::SegmentSMSMorph, CLAM::SegmentTransformation, CLAM::SMSHarmonizer, CLAM::SMSMorph, CLAM::SMSSineFilter, CLAM::SMSTimeStretch, CLAM::SMSTransformationChain, CLAM::SpectralEnvelopeApply, CLAM::TokenDelay< T >, CLAM::BinaryAudioOp< Multiply< TData > >, CLAM::TokenDelay< SpectralPeakArray >, and CLAM::TokenDelay< Spectrum >.

Definition at line 287 of file Processing.cxx.

Referenced by CLAM::ProcessingDefinitionAdapter::LoadFrom(), and CLAM::ProcessingDefinitionAdapter::StoreOn().

const std::string& CLAM::Processing::GetConfigErrorMessage ( ) const [inline]

Returns a string describing configuration errors if any.

Definition at line 425 of file Processing.hxx.

std::string CLAM::Processing::GetExecStateString ( ) const

Definition at line 292 of file Processing.cxx.

InControlBase& CLAM::Processing::GetInControl ( unsigned index ) [inline]

Definition at line 386 of file Processing.hxx.

References CLAM::InControlRegistry::GetByNumber().

InControlBase& CLAM::Processing::GetInControl ( const std::string & name ) [inline]

Definition at line 370 of file Processing.hxx.

References CLAM::InControlRegistry::Get().

Referenced by CLAM::Dispatcher::ConcreteConfigure(), and CLAM::Instrument::LinkStateOutWithInControl().

InControlRegistry& CLAM::Processing::GetInControls ( ) [inline, protected]

Accessor to published Controls manager.

Definition at line 413 of file Processing.hxx.

Referenced by CLAM::ControlTraceReaderConfig::DefaultInit(), and CLAM::InControlBase::~InControlBase().

InPortBase& CLAM::Processing::GetInPort ( unsigned index ) [inline]

Definition at line 378 of file Processing.hxx.

References CLAM::InPortRegistry::GetByNumber().

InPortBase& CLAM::Processing::GetInPort ( const std::string & name ) [inline]

Definition at line 362 of file Processing.hxx.

References CLAM::InPortRegistry::Get().

Referenced by CLAM::NetworkPlayer::CacheSourcesAndSinks(), CLAM::SMSAnalysisCore::ConcreteStart(), CLAM::Network::GetOutControlByCompleteName(), and CLAM::Hidden::ProcessingClass2LadspaBase::Instantiate().

InPortRegistry& CLAM::Processing::GetInPorts ( ) [inline, protected]

Accessor to published Ports manager.

Definition at line 419 of file Processing.hxx.

Referenced by ConsumeAndProduce(), and CLAM::InPortBase::~InPortBase().

unsigned CLAM::Processing::GetNInControls ( ) const [inline]

Definition at line 402 of file Processing.hxx.

References CLAM::InControlRegistry::Size().

unsigned CLAM::Processing::GetNInPorts ( ) const [inline]

Definition at line 394 of file Processing.hxx.

References CLAM::InPortRegistry::Size().

Referenced by CLAM::NetworkPlayer::CacheSourcesAndSinks(), CLAM::Network::HasSyncSource(), CLAM::NaiveFlowControl::ProcessingAddedToNetwork(), and SupportsVariableAudioSize().

unsigned CLAM::Processing::GetNOutControls ( ) const [inline]

Definition at line 406 of file Processing.hxx.

References CLAM::OutControlRegistry::Size().

Referenced by CLAM::Network::StoreOn().

unsigned CLAM::Processing::GetNOutPorts ( ) const [inline]

Definition at line 398 of file Processing.hxx.

References CLAM::OutPortRegistry::Size().

Referenced by CLAM::NetworkPlayer::CacheSourcesAndSinks(), CLAM::NaiveFlowControl::ProcessingAddedToNetwork(), CLAM::Network::StoreOn(), and SupportsVariableAudioSize().

OutControlBase& CLAM::Processing::GetOutControl ( unsigned index ) [inline]

Definition at line 390 of file Processing.hxx.

References CLAM::OutControlRegistry::GetByNumber().

OutControlBase& CLAM::Processing::GetOutControl ( const std::string & name ) [inline]

Definition at line 374 of file Processing.hxx.

References CLAM::OutControlRegistry::Get().

Referenced by CLAM::Dispatcher::ConcreteConfigure(), CLAM::Instrument::LinkStateOutWithInControl(), and CLAM::Network::StoreOn().

OutControlRegistry& CLAM::Processing::GetOutControls ( ) [inline, protected]

Accessor to published Controls manager.

Definition at line 416 of file Processing.hxx.

Referenced by CLAM::OutControlBase::~OutControlBase().

OutPortBase& CLAM::Processing::GetOutPort ( unsigned index ) [inline]

Definition at line 382 of file Processing.hxx.

References CLAM::OutPortRegistry::GetByNumber().

OutPortBase& CLAM::Processing::GetOutPort ( const std::string & name ) [inline]

Definition at line 366 of file Processing.hxx.

References CLAM::OutPortRegistry::Get().

Referenced by CLAM::NetworkPlayer::CacheSourcesAndSinks(), CLAM::Network::IsStopped(), and CLAM::Network::StoreOn().

OutPortRegistry& CLAM::Processing::GetOutPorts ( ) [inline, protected]

Accessor to published Portss manager.

Definition at line 422 of file Processing.hxx.

Referenced by ConsumeAndProduce(), and CLAM::OutPortBase::~OutPortBase().

bool CLAM::Processing::HasInControl ( const std::string & name ) [inline]

Definition at line 352 of file Processing.hxx.

References CLAM::InControlRegistry::Has().

bool CLAM::Processing::HasInPort ( const std::string & name ) [inline]

Definition at line 342 of file Processing.hxx.

References CLAM::InPortRegistry::Has().

bool CLAM::Processing::HasOutControl ( const std::string & name ) [inline]

Definition at line 357 of file Processing.hxx.

References CLAM::OutControlRegistry::Has().

bool CLAM::Processing::HasOutPort ( const std::string & name ) [inline]

Definition at line 347 of file Processing.hxx.

References CLAM::OutPortRegistry::Has().

bool CLAM::Processing::IsConfigured ( ) const [inline]

Definition at line 323 of file Processing.hxx.

References Unconfigured.

bool CLAM::Processing::IsRunning ( ) const [inline]

Definition at line 324 of file Processing.hxx.

References Running.

Referenced by AbleToExecute(), BackendBufferSize(), ConsumeAndProduce(), CLAM::SpectrumInterpolator::Do(), CLAM::SpectrumAdder2::Do(), CLAM::SpectralPeakArrayInterpolator::Do(), CLAM::SpectralPeakArrayAdder::Do(), CLAM::Segmentator::Do(), CLAM::IFFT_ooura::Do(), CLAM::FrameInterpolator::Do(), CLAM::FrameAdder::Do(), and CLAM::FFT_ooura::Do().

virtual bool CLAM::Processing::IsSyncSource ( ) const [inline, virtual]

Wether the processing is a sync source such as audio i/o device, or an audio callback hook (i.e.

Externalizer)

Reimplemented in CLAM::AudioIn, and CLAM::AudioOut.

Definition at line 429 of file Processing.hxx.

virtual bool CLAM::Processing::ModifiesPortsAndControlsAtConfiguration ( ) [inline, virtual]

This method is used to determine if a given processing can change its interface of ports/controls after its construction (i.e.

changing the name of ports in ConcreteConfigure). If a concrete processing can do this, it should reimplement the method returning true, in order to notify networks, graphical interfaces, etc.

Reimplemented in CLAM::MultiChannelAudioFileReader, CLAM::MultiChannelAudioFileWriter, CLAM::AudioBufferMixer, CLAM::AudioMixer, and CLAM::MIDIDispatcher.

Definition at line 340 of file Processing.hxx.

void CLAM::Processing::RegisterInControl ( InControlBase * in )

Definition at line 230 of file Processing.cxx.

Referenced by CLAM::InControlBase::InControlBase().

void CLAM::Processing::RegisterInPort ( InPortBase * in )

Definition at line 221 of file Processing.cxx.

Referenced by CLAM::InPortBase::InPortBase().

void CLAM::Processing::RegisterOutControl ( OutControlBase * out )

Definition at line 226 of file Processing.cxx.

Referenced by CLAM::OutControlBase::OutControlBase().

void CLAM::Processing::RegisterOutPort ( OutPortBase * out )