CLAM-Development  1.4.0
Classes | Public Types | Public Member Functions
CLAM::AudioBufferSink Class Reference

#include <AudioBufferSink.hxx>

List of all members.

Classes

class  Config
struct  Port

Public Types

typedef std::vector< PortPorts
- Public Types inherited from CLAM::Processing
enum  ExecState { Unconfigured = 0, Ready, Running }
 Processing Object possible execution states. More...
typedef NullProcessingConfig Config

Public Member Functions

 AudioBufferSink (const ProcessingConfig &config=Config())
 ~AudioBufferSink ()
void SetFrameAndHopSize (const int val, unsigned index)
void SetExternalBuffer (float *buf, unsigned nframes, unsigned index)
void SetExternalBuffer (double *buf, unsigned nframes, unsigned index)
bool Do ()
 Supervised mode execution method (using ports)
virtual bool SupportsVariableAudioSize () const
 This method reports whether the processing supports dynamic buffer-size host.
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
const ProcessingConfigGetConfig () const
 Configuration getter.
bool ConcreteConfigure (const ProcessingConfig &config)
 Configuration method interface.
PortsGetPorts ()
- 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)
InPortBaseGetInPort (const std::string &name)
OutPortBaseGetOutPort (const std::string &name)
InControlBaseGetInControl (const std::string &name)
OutControlBaseGetOutControl (const std::string &name)
InPortBaseGetInPort (unsigned index)
OutPortBaseGetOutPort (unsigned index)
InControlBaseGetInControl (unsigned index)
OutControlBaseGetOutControl (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.

Additional Inherited Members

- 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.
InControlRegistryGetInControls ()
 Accessor to published Controls manager.
OutControlRegistryGetOutControls ()
 Accessor to published Controls manager.
InPortRegistryGetInPorts ()
 Accessor to published Ports manager.
OutPortRegistryGetOutPorts ()
 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
ProcessingCompositempParent
 Pointer to the parent (composite) processing object, or 0.
Network_network
 The parent network if any.

Detailed Description

Definition at line 12 of file AudioBufferSink.hxx.


Member Typedef Documentation

typedef std::vector<Port> CLAM::AudioBufferSink::Ports

Definition at line 34 of file AudioBufferSink.hxx.


Constructor & Destructor Documentation

CLAM::AudioBufferSink::AudioBufferSink ( const ProcessingConfig config = Config())
inline

Definition at line 65 of file AudioBufferSink.hxx.

References CLAM::Processing::Configure().

CLAM::AudioBufferSink::~AudioBufferSink ( )
inline

Definition at line 73 of file AudioBufferSink.hxx.


Member Function Documentation

bool CLAM::AudioBufferSink::ConcreteConfigure ( const ProcessingConfig )
inlinevirtual

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:
Referenceto 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:
Thismethod must throw a bad_cast exception if the argument is not an object of the expected configuration class.

Reimplemented from CLAM::Processing.

Definition at line 102 of file AudioBufferSink.hxx.

References CLAM::Processing::CopyAsConcreteConfig().

bool CLAM::AudioBufferSink::Do ( )
virtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 24 of file AudioBufferSink.cxx.

References CLAM_DEBUG_ASSERT, CLAM::InPort< Token >::Consume(), CLAM::InPort< Token >::GetData(), CLAM::Audio::GetSize(), CLAM::AudioBufferSink::Port::mDoubleBuffer, CLAM::AudioBufferSink::Port::mFloatBuffer, and CLAM::AudioBufferSink::Port::mPort.

const char* CLAM::AudioBufferSink::GetClassName ( ) const
inlinevirtual

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

Implements CLAM::Processing.

Definition at line 95 of file AudioBufferSink.hxx.

const ProcessingConfig& CLAM::AudioBufferSink::GetConfig ( ) const
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 97 of file AudioBufferSink.hxx.

Ports& CLAM::AudioBufferSink::GetPorts ( )
inline

Definition at line 112 of file AudioBufferSink.hxx.

void CLAM::AudioBufferSink::SetExternalBuffer ( float *  buf,
unsigned  nframes,
unsigned  index 
)

Definition at line 47 of file AudioBufferSink.cxx.

References CLAM_ASSERT.

void CLAM::AudioBufferSink::SetExternalBuffer ( double *  buf,
unsigned  nframes,
unsigned  index 
)

Definition at line 59 of file AudioBufferSink.cxx.

References CLAM_ASSERT.

void CLAM::AudioBufferSink::SetFrameAndHopSize ( const int  val,
unsigned  index 
)
inline
Deprecated:
Delegated to SetExternalBuffer

Definition at line 80 of file AudioBufferSink.hxx.

References CLAM_ASSERT.

virtual bool CLAM::AudioBufferSink::SupportsVariableAudioSize ( ) const
inlinevirtual

This method reports whether the processing supports dynamic buffer-size host.

Reimplemented from CLAM::Processing.

Definition at line 93 of file AudioBufferSink.hxx.


The documentation for this class was generated from the following files: