#include <InPort.hxx>
Inheritance diagram for CLAM::InPort< Token >:
Definition at line 61 of file InPort.hxx.
Public Member Functions | |
| InPort (const std::string &name="unnamed in port", Processing *proc=0) | |
| virtual | ~InPort () |
| Token & | GetData (int offset=0) |
| void | SetSize (int newSize) |
| int | GetSize () |
| int | GetHop () |
| void | SetHop (int hop) |
| void | Consume () |
| bool | CanConsume () |
| void | AttachRegionToOutPort (OutPortBase *out, ProperWritingRegion &writer) |
| This method is intended to be used only for the OutPort. | |
| void | UnAttachRegion () |
| This method is intended to be used only for the OutPort. | |
Protected Attributes | |
| ProperReadingRegion | mRegion |
| CLAM::InPort< Token >::InPort | ( | const std::string & | name = "unnamed in port", |
|
| Processing * | proc = 0 | |||
| ) | [inline] |
Definition at line 100 of file InPort.hxx.
| CLAM::InPort< Token >::~InPort | ( | ) | [inline, virtual] |
Definition at line 106 of file InPort.hxx.
References CLAM::InPortBase::Disconnect(), and CLAM::InPortBase::mVisuallyConnectedOutPort.
| Token & CLAM::InPort< Token >::GetData | ( | int | offset = 0 |
) | [inline] |
Definition at line 114 of file InPort.hxx.
References CLAM::InPort< Token >::mRegion.
Referenced by CLAM::Vocoder::Do(), CLAM::TokenDelay< T >::Do(), CLAM::SynthSineSpectrum::Do(), CLAM::SpectrumSubstracter2::Do(), CLAM::SpectrumProduct::Do(), CLAM::SpectrumAdder2::Do(), CLAM::SpectralSynthesis::Do(), CLAM::SpectralSpread::Do(), CLAM::SpectralShapeShift::Do(), CLAM::SpectralRingModulation::Do(), CLAM::SpectralReverse::Do(), CLAM::SpectralReject::Do(), CLAM::SpectralPhaseModulation::Do(), CLAM::SpectralPeakDetect::Do(), CLAM::SpectralPeakArrayInterpolator::Do(), CLAM::SpectralNotch::Do(), CLAM::SpectralLimiter::Do(), CLAM::SpectralGate::Do(), CLAM::SpectralFocus::Do(), CLAM::SpectralExciter::Do(), CLAM::SpectralDelay::Do(), CLAM::SpectralCombTriang::Do(), CLAM::SpectralCombDelta::Do(), CLAM::SpectralAverage::Do(), CLAM::SpectralAmplitudeModulation::Do(), CLAM::SMSSynthesis::Do(), CLAM::SMSSpectralShapeShift::Do(), CLAM::SMSSinusoidalGain::Do(), CLAM::SMSSineFilter::Do(), CLAM::SMSResidualGain::Do(), CLAM::SMSPitchShift::Do(), CLAM::SMSPitchDiscretization::Do(), CLAM::SMSOddEvenHarmonicRatio::Do(), CLAM::SMSGenderChange::Do(), CLAM::SMSFreqShift::Do(), CLAM::SMSDeesser::Do(), CLAM::SinTracking::Do(), CLAM::SampleAndHold::Do(), CLAM::Robotization::Do(), CLAM::RandomPhase::Do(), CLAM::Peakalizer::Do(), CLAM::Partializer::Do(), CLAM::OscillatingSpectralNotch::Do(), CLAM::NoSpectralTransformation::Do(), CLAM::MIDIFileWriter::Do(), CLAM::MelFilterBank::Do(), CLAM::LPC_AutoCorrelation::Do(), CLAM::IFFT_rfftw::Do(), CLAM::IFFT_ooura::Do(), CLAM::IFFT_fftw3::Do(), CLAM::HumRemover::Do(), CLAM::FundFreqDetect::Do(), CLAM::Fundamental2Control::Do(), CLAM::FreqShift::Do(), CLAM::EnvelopeModulator::Do(), CLAM::EnvelopeGenerator::Do(), CLAM::EnvelopeExtractor::Do(), CLAM::Deesser::Do(), CLAM::CepstralTransform::Do(), CLAM::ThreeBandAM::Do(), CLAM::ThreeBandGate::Do(), CLAM::ThreeBandFilter::Do(), and CLAM::ThreeBandCompressor::Do().
| void CLAM::InPort< Token >::SetSize | ( | int | newSize | ) | [inline, virtual] |
Implements CLAM::InPortBase.
Definition at line 120 of file InPort.hxx.
References CLAM::InPort< Token >::mRegion, and CLAM::Region::Size().
Referenced by CLAM::TonalAnalysis::ConcreteConfigure(), CLAM::FFT_base::ConcreteConfigure(), CLAM::AudioOut::ConcreteConfigure(), CLAM::AudioSink::SetExternalBuffer(), and CLAM::AudioSink::SetFrameAndHopSize().
| int CLAM::InPort< Token >::GetSize | ( | ) | [inline, virtual] |
Implements CLAM::InPortBase.
Definition at line 126 of file InPort.hxx.
References CLAM::InPort< Token >::mRegion, and CLAM::Region::Size().
Referenced by CLAM::FFT_rfftw::Do(), CLAM::FFT_ooura::Do(), CLAM::FFT_numrec::Do(), and CLAM::FFT_fftw3::Do().
| int CLAM::InPort< Token >::GetHop | ( | ) | [inline, virtual] |
Implements CLAM::InPortBase.
Definition at line 132 of file InPort.hxx.
References CLAM::Region::Hop(), and CLAM::InPort< Token >::mRegion.
| void CLAM::InPort< Token >::SetHop | ( | int | hop | ) | [inline, virtual] |
Implements CLAM::InPortBase.
Definition at line 138 of file InPort.hxx.
References CLAM::Region::Hop(), and CLAM::InPort< Token >::mRegion.
Referenced by CLAM::TonalAnalysis::ConcreteConfigure(), CLAM::FFT_base::ConcreteConfigure(), CLAM::AudioSink::SetExternalBuffer(), and CLAM::AudioSink::SetFrameAndHopSize().
| void CLAM::InPort< Token >::Consume | ( | ) | [inline] |
Definition at line 144 of file InPort.hxx.
References CLAM::ReadingRegion< WritingRegion >::Consume(), and CLAM::InPort< Token >::mRegion.
Referenced by CLAM::Vocoder::Do(), CLAM::TonalAnalysis::Do(), CLAM::TokenDelay< T >::Do(), CLAM::SynthSineSpectrum::Do(), CLAM::SpectrumSubstracter2::Do(), CLAM::SpectrumProduct::Do(), CLAM::SpectrumAdder2::Do(), CLAM::SpectralSynthesis::Do(), CLAM::SpectralSpread::Do(), CLAM::SpectralShapeShift::Do(), CLAM::SpectralRingModulation::Do(), CLAM::SpectralReverse::Do(), CLAM::SpectralReject::Do(), CLAM::SpectralPhaseModulation::Do(), CLAM::SpectralPeakDetect::Do(), CLAM::SpectralNotch::Do(), CLAM::SpectralLimiter::Do(), CLAM::SpectralGate::Do(), CLAM::SpectralFocus::Do(), CLAM::SpectralExciter::Do(), CLAM::SpectralDelay::Do(), CLAM::SpectralCombTriang::Do(), CLAM::SpectralCombDelta::Do(), CLAM::SpectralAverage::Do(), CLAM::SpectralAnalysis::Do(), CLAM::SpectralAmplitudeModulation::Do(), CLAM::SMSSynthesis::Do(), CLAM::SMSSpectralShapeShift::Do(), CLAM::SMSSinusoidalGain::Do(), CLAM::SMSSineFilter::Do(), CLAM::SMSResidualGain::Do(), CLAM::SMSPitchShift::Do(), CLAM::SMSPitchDiscretization::Do(), CLAM::SMSOddEvenHarmonicRatio::Do(), CLAM::SMSGenderChange::Do(), CLAM::SMSFreqShift::Do(), CLAM::SMSDeesser::Do(), CLAM::SinTracking::Do(), CLAM::SampleAndHold::Do(), CLAM::Robotization::Do(), CLAM::RandomPhase::Do(), CLAM::PortMonitor< Audio, AudioInPort >::Do(), CLAM::Peakalizer::Do(), CLAM::Partializer::Do(), CLAM::OverlapAdd::Do(), CLAM::Oscillator::Do(), CLAM::OscillatingSpectralNotch::Do(), CLAM::NoSpectralTransformation::Do(), CLAM::MonoAudioFileWriter::Do(), CLAM::MIDIFileWriter::Do(), CLAM::MelFilterBank::Do(), CLAM::LPC_AutoCorrelation::Do(), CLAM::IFFT_rfftw::Do(), CLAM::IFFT_ooura::Do(), CLAM::IFFT_fftw3::Do(), CLAM::HumRemover::Do(), CLAM::FundFreqDetect::Do(), CLAM::Fundamental2Control::Do(), CLAM::FreqShift::Do(), CLAM::FFT_rfftw::Do(), CLAM::FFT_ooura::Do(), CLAM::FFT_numrec::Do(), CLAM::FFT_fftw3::Do(), CLAM::EnvelopeModulator::Do(), CLAM::EnvelopeGenerator::Do(), CLAM::EnvelopeExtractor::Do(), CLAM::Deesser::Do(), CLAM::CircularShift::Do(), CLAM::CepstralTransform::Do(), CLAM::BinaryAudioOp< BinOp >::Do(), CLAM::AudioWindowing::Do(), CLAM::AudioSink::Do(), CLAM::AudioOut::Do(), CLAM::AudioFileOut::Do(), CLAM::ThreeBandAM::Do(), CLAM::ThreeBandGate::Do(), CLAM::ThreeBandFilter::Do(), and CLAM::ThreeBandCompressor::Do().
| bool CLAM::InPort< Token >::CanConsume | ( | ) | [inline, virtual] |
Implements CLAM::InPortBase.
Definition at line 150 of file InPort.hxx.
References CLAM::ReadingRegion< WritingRegion >::CanConsume(), and CLAM::InPort< Token >::mRegion.
| void CLAM::InPort< Token >::AttachRegionToOutPort | ( | OutPortBase * | out, | |
| ProperWritingRegion & | writer | |||
| ) | [inline] |
This method is intended to be used only for the OutPort.
A user shouldn't call it directly. Instead , use ConnectToIn method in OutPortBase.
Definition at line 156 of file InPort.hxx.
References CLAM::WritingRegion< Token, DataStructure >::LinkRegions(), CLAM::InPort< Token >::mRegion, and CLAM::InPortBase::mVisuallyConnectedOutPort.
Referenced by CLAM::OutPort< Token >::ConnectToConcreteIn().
| void CLAM::InPort< Token >::UnAttachRegion | ( | ) | [inline, virtual] |
This method is intended to be used only for the OutPort.
A user shouldn't call it directly. Instead , use DisconnectFromIn method in OutPortBase.
Implements CLAM::InPortBase.
Definition at line 163 of file InPort.hxx.
References CLAM_DEBUG_ASSERT, CLAM::InPort< Token >::mRegion, CLAM::InPortBase::mVisuallyConnectedOutPort, CLAM::ReadingRegion< WritingRegion >::ProducerRegion(), and CLAM::Region::RemoveRegion().
Referenced by CLAM::OutPort< Token >::DisconnectFromConcreteIn().
ProperReadingRegion CLAM::InPort< Token >::mRegion [protected] |
Definition at line 93 of file InPort.hxx.
Referenced by CLAM::InPort< Token >::AttachRegionToOutPort(), CLAM::InPort< Token >::CanConsume(), CLAM::InPort< Token >::Consume(), CLAM::InPort< Token >::GetData(), CLAM::InPort< Token >::GetHop(), CLAM::InPort< Token >::GetSize(), CLAM::InPort< Token >::SetHop(), CLAM::InPort< Token >::SetSize(), and CLAM::InPort< Token >::UnAttachRegion().
1.5.2