#include <BinaryAudioOp.hxx>
Public Member Functions | |
| BinaryAudioOp () | |
| BinaryAudioOp (const BinaryAudioOpConfig &c) | |
| ~BinaryAudioOp () | |
| const ProcessingConfig & | GetConfig () const |
| Configuration getter. | |
| const char * | GetClassName () const |
| Override it in every subclass and retur the name of that class. | |
| void | Check (const Audio &in1, const Audio &in2, const Audio &out) |
| bool | Do (void) |
| Supervised mode execution method (using ports) | |
| bool | Do (const Audio &in1, const Audio &in2, Audio &out) |
| bool | SetPrototypes (const Audio &in1, const Audio &in2, const Audio &out) |
| bool | SetPrototypes () |
| bool | UnsetPrototypes () |
| bool | MayDisableExecution () const |
| template<> | |
| const char * | GetClassName () const |
| Override it in every subclass and retur the name of that class. | |
| template<> | |
| const char * | GetClassName () const |
| Override it in every subclass and retur the name of that class. | |
 Public Member Functions inherited from CLAM::Processing | |
| bool | Configure (const ProcessingConfig &config) |
| Configuration change method. | |
| void | Start (void) |
| Method to turn the object into running state. | |
| 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 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. | |
Additional Inherited Members | |
| Public Types inherited from CLAM::Processing | |
| enum | ExecState { Unconfigured = 0, Ready, Running } |
| Processing Object possible execution states. More... | |
| typedef NullProcessingConfig | Config |
| Protected Member Functions inherited from CLAM::Processing | |
| 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 inherited from CLAM::Processing | |
| ProcessingComposite * | mpParent |
| Pointer to the parent (composite) processing object, or 0. | |
| Network * | _network |
| The parent network if any. | |
Detailed Description
template<typename BinOp>
class CLAM::BinaryAudioOp< BinOp >
Definition at line 44 of file BinaryAudioOp.hxx.
Constructor & Destructor Documentation
template<typename BinOp>
|
inline |
Definition at line 73 of file BinaryAudioOp.hxx.
template<typename BinOp>
|
inline |
Definition at line 81 of file BinaryAudioOp.hxx.
template<typename BinOp>
|
inline |
Definition at line 90 of file BinaryAudioOp.hxx.
Member Function Documentation
template<typename BinOp>
|
inline |
Definition at line 97 of file BinaryAudioOp.hxx.
Referenced by CLAM::BinaryAudioOp< Multiply< TData > >::Do().
template<typename BinOp>
|
inlinevirtual |
Supervised mode execution method (using ports)
- Returns:
- A boolean telling whether it has been output
Implements CLAM::Processing.
Definition at line 106 of file BinaryAudioOp.hxx.
Referenced by CLAM::AudioWindowing::Do(), CLAM::SpectralAnalysis::Do(), CLAM::BinaryAudioOp< Multiply< TData > >::Do(), and CLAM::SpectralSynthesis::Do().
template<typename BinOp>
|
inline |
Definition at line 117 of file BinaryAudioOp.hxx.
template<>
|
inlinevirtual |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Definition at line 34 of file AudioAdder.hxx.
template<>
|
inlinevirtual |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Definition at line 34 of file AudioMultiplier.hxx.
template<typename BinOp>
|
inlinevirtual |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Definition at line 96 of file BinaryAudioOp.hxx.
template<typename BinOp>
|
inlinevirtual |
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.
Definition at line 94 of file BinaryAudioOp.hxx.
template<typename BinOp>
|
inline |
Definition at line 155 of file BinaryAudioOp.hxx.
template<typename BinOp>
|
inline |
Definition at line 140 of file BinaryAudioOp.hxx.
template<typename BinOp>
|
inline |
Definition at line 145 of file BinaryAudioOp.hxx.
template<typename BinOp>
|
inline |
Definition at line 150 of file BinaryAudioOp.hxx.
The documentation for this class was generated from the following file:
