#include <Processing.hxx>
Inheritance diagram for CLAM::Processing:
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.
Definition at line 135 of file 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. | |
| 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 (OutControl *out) |
| void | RegisterInControl (InControl *in) |
| void | SetParent (Processing *p) |
| 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) |
| InControl & | GetInControl (const std::string &name) |
| OutControl & | GetOutControl (const std::string &name) |
| 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. | |
| 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. | |
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. | |
| void | AddConfigErrorMessage (const std::string &msg) |
| Method to prepend a message to mConfigErrorMessage CLAM_ASSERT. | |
| 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. | |
Protected Attributes | |
| ProcessingComposite * | mpParent |
| Pointer to the parent (composite) processing object, or 0. | |
| ExecState | mExecState |
| Processing object execution state. | |
| std::string | mConfigErrorMessage |
| Status description, for debugging. | |
Definition at line 144 of file Processing.hxx.
| CLAM::Processing::Processing | ( | ) |
Definition at line 104 of file Processing.cxx.
| CLAM::Processing::~Processing | ( | ) | [virtual] |
Definition at line 139 of file Processing.cxx.
References mpParent, and CLAM::ProcessingComposite::Remove().
| 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.
| config | Reference to the configuration object. |
| 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 110 of file Processing.cxx.
References CLAM_ASSERT, ConcreteConfigure(), CLAM::TopLevelProcessing::GetInstance(), CLAM::ProcessingComposite::Insert(), IsRunning(), mConfigErrorMessage, mExecState, mpParent, Ready, Unconfigured, and CLAM::Err::what().
Referenced by CLAM::ADSR::ADSR(), CLAM::OnsetDetection::AudioDecimator::AudioDecimator(), CLAM::AudioFileIn::AudioFileIn(), CLAM::AudioFileOut::AudioFileOut(), CLAM::AudioIn::AudioIn(), CLAM::AudioMixer::AudioMixer(), CLAM::AudioOut::AudioOut(), CLAM::AudioWindowing::AudioWindowing(), CLAM::AutoPanner::AutoPanner(), CLAM::BinaryAudioOp< BinOp >::BinaryAudioOp(), CLAM::BinaryControlOp< BinOp >::BinaryControlOp(), CLAM::CepstralTransform::CepstralTransform(), CLAM::CircularShift::CircularShift(), CLAM::CleanTracks::CleanTracks(), CLAM::SynthSineSpectrum::ConcreteConfigure(), CLAM::SMSTimeStretch::ConcreteConfigure(), CLAM::SMSMorph::ConcreteConfigure(), CLAM::SMSHarmonizer::ConcreteConfigure(), CLAM::MIDIKeyboard::ConcreteConfigure(), CLAM::Control2Data::Control2Data(), CLAM::Controller::Controller(), CLAM::ControlMapper::ControlMapper(), CLAM::ControlPrinter::ControlPrinter(), CLAM::ControlScaler::ControlScaler(), CLAM::ControlTraceReader::ControlTraceReader(), CLAM::ControlTraceWriter::ControlTraceWriter(), CLAM::Deesser::Deesser(), CLAM::DescriptorComputation::DescriptorComputation(), CLAM::Dispatcher::Dispatcher(), CLAM::EnvelopeExtractor::EnvelopeExtractor(), CLAM::EnvelopeGenerator::EnvelopeGenerator(), CLAM::EnvelopeModulator::EnvelopeModulator(), CLAM::ERB_SpaceGen::ERB_SpaceGen(), CLAM::FDCombFilter::FDCombFilter(), CLAM::FDFilterGen::FDFilterGen(), CLAM::FFT_fftw3::FFT_fftw3(), CLAM::FFT_numrec::FFT_numrec(), CLAM::FFT_ooura::FFT_ooura(), CLAM::FFT_rfftw::FFT_rfftw(), CLAM::FlagControl::FlagControl(), CLAM::FrameAdder::FrameAdder(), CLAM::FrameInterpolator::FrameInterpolator(), CLAM::FreqShift::FreqShift(), CLAM::Fundamental2Control::Fundamental2Control(), CLAM::FundFreqDetect::FundFreqDetect(), CLAM::GT_FilterBank::GT_FilterBank(), CLAM::HumRemover::HumRemover(), CLAM::IFFT_fftw3::IFFT_fftw3(), CLAM::IFFT_ooura::IFFT_ooura(), CLAM::IFFT_rfftw::IFFT_rfftw(), CLAM::LadspaLoader::LadspaLoader(), CLAM::ProcessingDefinitionAdapter::LoadFrom(), CLAM::SMSMorph::LoadSDIF(), CLAM::LPC_AutoCorrelation::LPC_AutoCorrelation(), CLAM::MelFilterBank::MelFilterBank(), CLAM::MIDIClocker::MIDIClocker(), CLAM::MIDIDispatcher::MIDIDispatcher(), CLAM::MIDIFileReader::MIDIFileReader(), CLAM::MIDIFileWriter::MIDIFileWriter(), CLAM::MIDIIn::MIDIIn(), CLAM::MIDIInControl::MIDIInControl(), CLAM::MIDIKeyboard::MIDIKeyboard(), CLAM::MIDIOut::MIDIOut(), CLAM::MIDIOutControl::MIDIOutControl(), CLAM::MonoAudioFileReader::MonoAudioFileReader(), CLAM::MonoAudioFileWriter::MonoAudioFileWriter(), CLAM::MultiChannelAudioFileReader::MultiChannelAudioFileReader(), CLAM::MultiChannelAudioFileWriter::MultiChannelAudioFileWriter(), CLAM::Normalization::Normalization(), CLAM::NoSpectralTransformation::NoSpectralTransformation(), CLAM::OnsetDetector::OnsetDetector(), CLAM::OscillatingSpectralNotch::OscillatingSpectralNotch(), CLAM::Oscillator::Oscillator(), CLAM::OutControlSender::OutControlSender(), CLAM::OverlapAdd::OverlapAdd(), CLAM::Partializer::Partializer(), CLAM::Peakalizer::Peakalizer(), CLAM::PhaseManagement::PhaseManagement(), CLAM::PortMonitor< TheDataType, ThePortType >::PortMonitor(), CLAM::PortMonitor< Audio, AudioInPort >::PortMonitor(), CLAM::PrintControl::PrintControl(), CLAM::RandomPhase::RandomPhase(), CLAM::Robotization::Robotization(), CLAM::SampleAndHold::SampleAndHold(), CLAM::SDIFIn::SDIFIn(), CLAM::SDIFOut::SDIFOut(), CLAM::Segmentator::Segmentator(), CLAM::SegmentTransformation::SegmentTransformation(), CLAM::SimpleOscillator::SimpleOscillator(), CLAM::SinTracking::SinTracking(), CLAM::SMSAnalysis::SMSAnalysis(), 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::SMSSynthesis::SMSSynthesis(), CLAM::SMSTimeStretch::SMSTimeStretch(), 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::SpectrumAdder::SpectrumAdder(), CLAM::SpectrumAdder2::SpectrumAdder2(), CLAM::SpectrumInterpolator::SpectrumInterpolator(), CLAM::SpectrumProduct::SpectrumProduct(), CLAM::SpectrumSubstracter2::SpectrumSubstracter2(), CLAM::SynthSineSpectrum::SynthSineSpectrum(), CLAM::ThreeBandAM::ThreeBandAM(), CLAM::ThreeBandCompressor::ThreeBandCompressor(), CLAM::ThreeBandFilter::ThreeBandFilter(), CLAM::ThreeBandGate::ThreeBandGate(), CLAM::TokenDelay< Spectrum >::TokenDelay(), CLAM::TonalAnalysis::TonalAnalysis(), CLAM::Vocoder::Vocoder(), CLAM::WaveGenerator::WaveGenerator(), and CLAM::WindowGenerator::WindowGenerator().
| void CLAM::Processing::Start | ( | void | ) |
Method to turn the object into running state.
This method must be called before any call to Do() methods.
Definition at line 145 of file Processing.cxx.
References CLAM_ASSERT, ConcreteStart(), IsConfigured(), IsRunning(), mConfigErrorMessage, mExecState, Running, and CLAM::Err::what().
Referenced by CLAM::SMSTimeStretch::ConcreteStart(), CLAM::SMSMorph::ConcreteStart(), and CLAM::SMSMorph::LoadSDIF().
| virtual bool CLAM::Processing::Do | ( | void | ) | [pure virtual] |
Supervised mode execution method (using ports).
Implemented in CLAM::BinaryControlOp< BinOp >, CLAM::PrintControl, 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::FFT_rfftw, CLAM::FundFreqDetect, CLAM::GT_FilterBank, CLAM::LPC_AutoCorrelation, CLAM::MelFilterBank, CLAM::OnsetDetection::AudioDecimator, CLAM::OnsetDetector, CLAM::Segmentator, CLAM::SinTracking, CLAM::SMSAnalysis, CLAM::SMSAnalysisCore, CLAM::SpectralAnalysis, CLAM::SpectralEnvelopeExtract, CLAM::SpectralPeakDetect, CLAM::TonalAnalysis, CLAM::WindowGenerator, CLAM::ZeroPadder, CLAM::AudioMixer, CLAM::BinaryAudioOp< BinOp >, CLAM::FrameAdder, CLAM::FrameInterpolator, CLAM::SpectralPeakArrayAdder, CLAM::SpectralPeakArrayInterpolator, CLAM::SpectrumAdder, CLAM::SpectrumAdder2, CLAM::SpectrumInterpolator, CLAM::SpectrumProduct, CLAM::SpectrumSubstracter2, CLAM::AudioFileIn, CLAM::AudioFileOut, CLAM::MonoAudioFileReader, CLAM::MonoAudioFileWriter, CLAM::MultiChannelAudioFileReader, CLAM::MultiChannelAudioFileWriter, CLAM::AudioIn, CLAM::AudioOut, CLAM::AudioSink, CLAM::AudioSource, CLAM::ProcessingComposite, CLAM::TopLevelProcessing, CLAM::AutoPanner, CLAM::Control2Data, CLAM::Controller, CLAM::ControlMapper, CLAM::ControlPrinter, CLAM::ControlScaler, CLAM::ControlSink, CLAM::ControlSource, CLAM::ControlTraceReader, CLAM::ControlTraceWriter, CLAM::FlagControl, CLAM::Fundamental2Control, CLAM::OSCSender, CLAM::OutControlSender, CLAM::ADSR, CLAM::Dispatcher, CLAM::Instrument, CLAM::Oscillator, CLAM::SimpleOscillator, CLAM::WaveGenerator, CLAM::MIDIClocker, CLAM::MIDIDispatcher, CLAM::MIDIFileReader, CLAM::MIDIFileWriter, CLAM::MIDIIn, CLAM::MIDIKeyboard, CLAM::MIDIOut, CLAM::PortMonitor< TheDataType, ThePortType >, CLAM::LadspaLoader, CLAM::LadspaWrapper, CLAM::SDIFIn, CLAM::SDIFOut, CLAM::IFFT_base, CLAM::IFFT_fftw3, CLAM::IFFT_ooura, CLAM::IFFT_rfftw, CLAM::OverlapAdd, CLAM::PhaseManagement, CLAM::SMSSynthesis, CLAM::SpectralSynthesis, CLAM::SynthSineSpectrum, CLAM::EnvelopeExtractor, CLAM::EnvelopeGenerator, CLAM::EnvelopeModulator, CLAM::FDCombFilter, CLAM::FDFilterGen, CLAM::Normalization, 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::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::PortMonitor< Audio, AudioInPort >, CLAM::PortMonitor< SpectralPeakArray >, CLAM::PortMonitor< Fundamental >, CLAM::PortMonitor< Spectrum >, and CLAM::TokenDelay< Spectrum >.
| void CLAM::Processing::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.
Definition at line 159 of file Processing.cxx.
References CLAM_ASSERT, ConcreteStop(), IsRunning(), mConfigErrorMessage, mExecState, Ready, and CLAM::Err::what().
Referenced by CLAM::SMSTimeStretch::ConcreteStop(), and CLAM::SMSMorph::LoadSDIF().
| virtual const char* CLAM::Processing::GetClassName | ( | ) | const [pure virtual] |
Override it in every subclass and retur the name of that class.
Implemented in CLAM::PrintControl, CLAM::AudioWindowing, CLAM::CepstralTransform, CLAM::CircularShift, CLAM::DescriptorComputation, CLAM::ERB_SpaceGen, CLAM::FFT_fftw3, CLAM::FFT_numrec, CLAM::FFT_ooura, CLAM::FFT_rfftw, CLAM::GT_FilterBank, CLAM::LPC_AutoCorrelation, CLAM::MelFilterBank, CLAM::OnsetDetection::AudioDecimator, CLAM::OnsetDetector, CLAM::Segmentator, CLAM::SMSAnalysis, CLAM::SMSAnalysisCore, CLAM::SpectralAnalysis, CLAM::SpectralPeakDetect, CLAM::TonalAnalysis, CLAM::ZeroPadder, CLAM::AudioMixer, CLAM::BinaryAudioOp< BinOp >, CLAM::MonoAudioFileReader, CLAM::MonoAudioFileWriter, CLAM::MultiChannelAudioFileReader, CLAM::MultiChannelAudioFileWriter, CLAM::AudioIn, CLAM::AudioOut, CLAM::AudioSink, CLAM::AudioSource, CLAM::ProcessingComposite, CLAM::TopLevelProcessing, CLAM::AutoPanner, CLAM::Control2Data, CLAM::Controller, CLAM::ControlMapper, CLAM::ControlPrinter, CLAM::ControlScaler, CLAM::ControlSink, CLAM::ControlSource, CLAM::ControlTraceReader, CLAM::ControlTraceWriter, CLAM::FlagControl, CLAM::Fundamental2Control, CLAM::OSCSender, CLAM::OutControlSender, CLAM::ADSR, CLAM::Dispatcher, CLAM::Instrument, CLAM::Oscillator, CLAM::SimpleOscillator, 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::LadspaLoader, CLAM::LadspaWrapper, CLAM::SDIFIn, CLAM::SDIFOut, CLAM::IFFT_base, CLAM::IFFT_fftw3, CLAM::IFFT_ooura, CLAM::IFFT_rfftw, CLAM::PhaseManagement, CLAM::SMSSynthesis, CLAM::SpectralSynthesis, CLAM::SynthSineSpectrum, CLAM::EnvelopeExtractor, CLAM::EnvelopeGenerator, CLAM::EnvelopeModulator, CLAM::Normalization, CLAM::SegmentTransformation, CLAM::SMSFreqShift, CLAM::SMSMorph, CLAM::SMSTimeStretch, 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::PortMonitor< Audio, AudioInPort >, CLAM::PortMonitor< SpectralPeakArray >, CLAM::PortMonitor< Fundamental >, CLAM::PortMonitor< Spectrum >, CLAM::TokenDelay< Spectrum >, CLAM::BinaryControlOp< BinOp >, CLAM::BinaryAudioOp< BinOp >, and CLAM::BinaryAudioOp< BinOp >.
Referenced by AbleToExecute(), CanConsumeAndProduce(), CLAM::NaiveFlowControl::ProcessingAddedToNetwork(), CLAM::NaiveFlowControl::ProcessingRemovedFromNetwork(), and CLAM::ProcessingDefinitionAdapter::StoreOn().
| virtual bool CLAM::Processing::CanProcessInplace | ( | ) | [inline, virtual] |
Override this method if your processing cannot process inplace.
Reimplemented in CLAM::SMSTimeStretch.
Definition at line 194 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.
| Reference | to the configuration object. |
| This | method must throw a bad_cast exception if the argument is not an object of the expected configuration class. |
Reimplemented in CLAM::BinaryControlOp< BinOp >, CLAM::PrintControl, CLAM::CepstralTransform, CLAM::CircularShift, CLAM::DescriptorComputation, CLAM::FFT_base, CLAM::LPC_AutoCorrelation, CLAM::MelFilterBank, CLAM::SpectralPeakDetect, CLAM::TonalAnalysis, CLAM::ZeroPadder, CLAM::AudioMixer, CLAM::AudioFileIn, CLAM::MonoAudioFileReader, CLAM::MonoAudioFileWriter, CLAM::MultiChannelAudioFileReader, CLAM::MultiChannelAudioFileWriter, CLAM::AudioIn, CLAM::AudioOut, CLAM::AudioSink, CLAM::AudioSource, CLAM::ProcessingComposite, CLAM::TopLevelProcessing, CLAM::AutoPanner, CLAM::Control2Data, CLAM::Controller, CLAM::ControlMapper, CLAM::ControlPrinter, CLAM::ControlScaler, CLAM::ControlSink, CLAM::ControlSource, CLAM::ControlTraceReader, CLAM::ControlTraceWriter, CLAM::FlagControl, CLAM::Fundamental2Control, CLAM::OSCSender, CLAM::OutControlSender, 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::LadspaLoader, CLAM::IFFT_base, CLAM::PhaseManagement, CLAM::SynthSineSpectrum, CLAM::EnvelopeGenerator, CLAM::SegmentTransformation, CLAM::SMSHarmonizer, CLAM::SMSMorph, CLAM::SMSSineFilter, CLAM::SMSTimeStretch, CLAM::SMSTransformationChain, CLAM::ThreeBandFilter, CLAM::OscillatingSpectralNotch, CLAM::Robotization, CLAM::SpectralDelay, CLAM::TokenDelay< T >, and CLAM::TokenDelay< Spectrum >.
Definition at line 216 of file Processing.hxx.
Referenced by Configure().
| 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.
Reimplemented in CLAM::CepstralTransform, CLAM::SMSAnalysis, CLAM::SMSAnalysisCore, CLAM::ZeroPadder, CLAM::AudioFileIn, CLAM::MonoAudioFileReader, CLAM::MonoAudioFileWriter, CLAM::MultiChannelAudioFileReader, CLAM::MultiChannelAudioFileWriter, CLAM::AudioIn, CLAM::AudioOut, CLAM::ProcessingComposite, CLAM::ControlTraceReader, CLAM::OutControlSender, CLAM::MIDIClocker, CLAM::MIDIIn, CLAM::MIDIOut, CLAM::PortMonitor< TheDataType, ThePortType >, CLAM::LadspaLoader, CLAM::SDIFIn, CLAM::SDIFOut, CLAM::FrameTransformation, CLAM::SegmentTransformation, CLAM::SMSMorph, CLAM::SMSTimeStretch, CLAM::SMSTransformationChain, CLAM::PortMonitor< Audio, AudioInPort >, CLAM::PortMonitor< SpectralPeakArray >, CLAM::PortMonitor< Fundamental >, and CLAM::PortMonitor< Spectrum >.
Definition at line 223 of file Processing.hxx.
Referenced by Start().
| 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.
Reimplemented in CLAM::ZeroPadder, CLAM::AudioFileIn, CLAM::MonoAudioFileReader, CLAM::MonoAudioFileWriter, CLAM::MultiChannelAudioFileReader, CLAM::MultiChannelAudioFileWriter, CLAM::AudioOut, CLAM::ProcessingComposite, CLAM::ControlTraceWriter, CLAM::PortMonitor< TheDataType, ThePortType >, CLAM::LadspaLoader, CLAM::SDIFIn, CLAM::SDIFOut, CLAM::SMSTimeStretch, CLAM::PortMonitor< Audio, AudioInPort >, CLAM::PortMonitor< SpectralPeakArray >, CLAM::PortMonitor< Fundamental >, and CLAM::PortMonitor< Spectrum >.
Definition at line 230 of file Processing.hxx.
Referenced by Stop().
| bool CLAM::Processing::CanConsumeAndProduce | ( | ) |
Check that Supervised Do() can be safely called.
Definition at line 217 of file Processing.cxx.
References CLAM::InPortRegistry::AreReadyForReading(), CLAM::OutPortRegistry::AreReadyForWriting(), GetClassName(), GetInPorts(), GetOutPorts(), and IsRunning().
Referenced by CLAM::SMSAnalysisCore::Do(), and CLAM::SMSAnalysis::Do().
| const ProcessingConfig & CLAM::Processing::GetConfig | ( | ) | const [virtual] |
Configuration getter.
Gets the configuration parameters used to create the object.
Reimplemented in CLAM::BinaryControlOp< BinOp >, CLAM::PrintControl, CLAM::AudioWindowing, CLAM::CepstralTransform, CLAM::CircularShift, CLAM::CleanTracks, CLAM::DescriptorComputation, CLAM::ERB_SpaceGen, CLAM::FFT_base, CLAM::FundFreqDetect, CLAM::GT_FilterBank, CLAM::LPC_AutoCorrelation, CLAM::MelFilterBank, CLAM::OnsetDetection::AudioDecimator, CLAM::OnsetDetector, CLAM::Segmentator, CLAM::SinTracking, CLAM::SMSAnalysis, CLAM::SMSAnalysisCore, CLAM::SpectralAnalysis, CLAM::SpectralEnvelopeExtract, CLAM::SpectralPeakDetect, CLAM::TonalAnalysis, CLAM::WindowGenerator, CLAM::ZeroPadder, CLAM::AudioMixer, CLAM::BinaryAudioOp< BinOp >, CLAM::FrameAdder, CLAM::FrameInterpolator, CLAM::SpectralPeakArrayAdder, CLAM::SpectralPeakArrayInterpolator, CLAM::SpectrumAdder, CLAM::SpectrumAdder2, CLAM::SpectrumInterpolator, CLAM::SpectrumSubstracter2, CLAM::AudioFileIn, CLAM::AudioFileOut, CLAM::MonoAudioFileReader, CLAM::MonoAudioFileWriter, CLAM::MultiChannelAudioFileReader, CLAM::MultiChannelAudioFileWriter, CLAM::AudioIn, CLAM::AudioOut, CLAM::AudioSink, CLAM::AudioSource, CLAM::ProcessingComposite, CLAM::TopLevelProcessing, CLAM::AutoPanner, CLAM::Control2Data, CLAM::Controller, CLAM::ControlMapper, CLAM::ControlPrinter, CLAM::ControlScaler, CLAM::ControlSink, CLAM::ControlSource, CLAM::ControlTraceReader, CLAM::ControlTraceWriter, CLAM::FlagControl, CLAM::Fundamental2Control, CLAM::OSCSender, CLAM::OutControlSender, 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::LadspaLoader, CLAM::SDIFIn, CLAM::SDIFOut, CLAM::IFFT_base, CLAM::OverlapAdd, CLAM::PhaseManagement, CLAM::SMSSynthesis, CLAM::SpectralSynthesis, CLAM::SynthSineSpectrum, CLAM::EnvelopeExtractor, CLAM::EnvelopeGenerator, CLAM::EnvelopeModulator, CLAM::FDCombFilter, CLAM::FDFilterGen, CLAM::Normalization, CLAM::FrameTransformation, CLAM::SegmentTransformation, CLAM::SMSMorph, CLAM::SMSSineFilter, CLAM::SMSTransformationChain, CLAM::SpectralEnvelopeApply, CLAM::TokenDelay< T >, and CLAM::TokenDelay< Spectrum >.
Definition at line 228 of file Processing.cxx.
Referenced by CLAM::ProcessingDefinitionAdapter::LoadFrom(), and