CLAM-Development
1.4.0
|
#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. | |
![]() | |
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 |
![]() | |
ProcessingComposite * | mpParent |
Pointer to the parent (composite) processing object, or 0. | |
Network * | _network |
The parent network if any. |
Additional Inherited Members | |
![]() | |
enum | ExecState { Unconfigured = 0, Ready, Running } |
Processing Object possible execution states. More... | |
typedef NullProcessingConfig | Config |
![]() | |
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) |
Definition at line 13 of file FrameTransformation.hxx.
|
inline |
Definition at line 16 of file FrameTransformation.hxx.
|
inlinevirtual |
Processing objects have to redefine this method when starting them implies some internal changes.
ie: adquiring resources.
Reimplemented from CLAM::Processing.
Definition at line 24 of file FrameTransformation.hxx.
References InitControls().
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().
|
inlinevirtual |
Configuration getter.
Gets the configuration parameters used to create the object.
Reimplemented from CLAM::Processing.
Reimplemented in CLAM::SMSHarmonizer, and CLAM::SMSSineFilter.
Definition at line 22 of file FrameTransformation.hxx.
References mConfig.
|
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.
Definition at line 27 of file FrameTransformation.hxx.
References CLAM::InControl< ControlDataType >::DoControl(), and mAmount.
Referenced by ConcreteStart().
|
protected |
Definition at line 37 of file FrameTransformation.hxx.
Referenced by CLAM::SpectralLimiter::Do(), CLAM::RandomPhase::Do(), CLAM::SpectralGate::Do(), CLAM::SpectralReverse::Do(), CLAM::SampleAndHold::Do(), CLAM::SMSDeesser::Do(), CLAM::Partializer::Do(), CLAM::SpectralSpread::Do(), CLAM::SpectralFocus::Do(), InitControls(), CLAM::SpectralReverse::InitControls(), CLAM::SpectralGate::InitControls(), CLAM::Partializer::InitControls(), CLAM::SampleAndHold::InitControls(), CLAM::SpectralNotch::InitControls(), and CLAM::SpectralSpread::InitControls().
|
protected |
Definition at line 35 of file FrameTransformation.hxx.
Referenced by CLAM::SegmentSMSHarmonizer::ConcreteConfigure(), CLAM::SMSSineFilter::ConcreteConfigure(), CLAM::SpectralLimiter::Do(), CLAM::FreqShift::Do(), CLAM::NoSpectralTransformation::Do(), CLAM::SpectralReject::Do(), CLAM::SMSFreqShift::Do(), CLAM::SpectralGate::Do(), CLAM::SpectralReverse::Do(), CLAM::SampleAndHold::Do(), CLAM::SpectralAverage::Do(), CLAM::SMSSpectralShapeShift::Do(), CLAM::SMSTranspose::Do(), CLAM::SpectralCombDelta::Do(), CLAM::SpectralCombTriang::Do(), CLAM::Peakalizer::Do(), CLAM::Partializer::Do(), CLAM::SpectralRingModulation::Do(), CLAM::SpectralAmplitudeModulation::Do(), CLAM::SpectralPhaseModulation::Do(), CLAM::Vocoder::Do(), CLAM::SpectralSpread::Do(), CLAM::ThreeBandAM::Do(), CLAM::SpectralShapeShift::Do(), CLAM::SpectralFocus::Do(), CLAM::SMSPitchShift::Do(), CLAM::SpectralDelay::Do(), CLAM::SegmentSMSHarmonizer::Do(), CLAM::ThreeBandFilter::Do(), CLAM::SMSSineFilter::Do(), GetConfig(), CLAM::SMSSineFilter::GetConfig(), CLAM::SMSSineFilter::InitBPF(), CLAM::SMSSineFilter::SMSSineFilter(), and CLAM::SegmentSMSHarmonizer::UpdateBPF().