CLAM-Development
1.4.0
|
This class is the interface to an output of an AudioDevice. More...
#include <AudioOut.hxx>
Public Member Functions | |
bool | ConcreteConfigure (const ProcessingConfig &c) throw (ErrProcessingObj) |
Configuration method interface. | |
const ProcessingConfig & | GetConfig () const |
Getter for the configuration of the class. | |
AudioOut () | |
Default constructor for the class. | |
AudioOut (const AudioIOConfig &cfg) | |
Constructor of the class with an AudioIOConfig object constructed by the user as parameter. | |
~AudioOut () | |
Destructor method of the class. | |
const char * | GetClassName () const |
Override it in every subclass and retur the name of that class. | |
bool | Do (void) |
Supervised mode of Do method. | |
bool | Do (const Audio &data) |
Non supervised mode of Do function. | |
void | GetDeviceInfo (AudioDevice::TInfo &) const |
Getter for the Info of Device Object attached to this AudioIn instantiation. | |
int | GetChannelID () const |
bool | IsSyncSource () const |
Wether the processing is a sync source such as audio i/o device, or an audio callback hook (i.e. | |
![]() | |
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 | SupportsVariableAudioSize () const |
This method reports whether the processing supports dynamic buffer-size host. |
Protected Member Functions | |
bool | ConcreteStart () |
Processing objects have to redefine this method when starting them implies some internal changes. | |
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) |
Friends | |
class | AudioManager |
class | AudioDevice |
Additional Inherited Members | |
![]() | |
enum | ExecState { Unconfigured = 0, Ready, Running } |
Processing Object possible execution states. More... | |
typedef NullProcessingConfig | Config |
![]() | |
ProcessingComposite * | mpParent |
Pointer to the parent (composite) processing object, or 0. | |
Network * | _network |
The parent network if any. |
This class is the interface to an output of an AudioDevice.
Definition at line 37 of file AudioOut.hxx.
CLAM::AudioOut::AudioOut | ( | ) |
Default constructor for the class.
Sets the configuration to the default values, calling the base constructor of the AudioIOConfig object
Definition at line 42 of file AudioOut.cxx.
References CLAM::Processing::Configure().
CLAM::AudioOut::AudioOut | ( | const AudioIOConfig & | cfg | ) |
Constructor of the class with an AudioIOConfig object constructed by the user as parameter.
c | The concrete AudioIOConfig that will be used for this construction |
Definition at line 49 of file AudioOut.cxx.
References CLAM::Processing::Configure().
CLAM::AudioOut::~AudioOut | ( | ) |
Destructor method of the class.
Definition at line 56 of file AudioOut.cxx.
References CLAM::AudioDevice::Unregister(), and CLAM::Err::what().
|
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.
The | related ProcessingConfig object |
A | bad_cast exception if the arguments is not the expected configuration class |
Reimplemented from CLAM::Processing.
Definition at line 67 of file AudioOut.cxx.
References CLAM::AudioManager::Current(), CLAM::Err::Embed(), CLAM::AudioManager::Register(), and CLAM::Err::what().
|
protectedvirtual |
Processing objects have to redefine this method when starting them implies some internal changes.
ie: adquiring resources.
Reimplemented from CLAM::Processing.
Definition at line 103 of file AudioOut.cxx.
References CLAM::AudioDevice::Start(), and CLAM::Err::what().
|
protectedvirtual |
Processing objects have to redefine this method when stoping them implies some internal changes.
ie: releasing resources.
Reimplemented from CLAM::Processing.
Definition at line 118 of file AudioOut.cxx.
References CLAM::AudioDevice::Stop().
|
virtual |
Supervised mode of Do method.
Calls the non-supervised method with the Audio data chunk attached before as the parameter where data will be written
Implements CLAM::Processing.
Definition at line 132 of file AudioOut.cxx.
References CLAM::InPort< Token >::Consume(), and CLAM::AudioInPort::GetAudio().
|
inline |
Non supervised mode of Do function.
The object writes in the device attached for the appropiate channel. Values selected to write are provided for the data chunk passed by parameter. On current implementations Do() will return immediately when not all output channels of the device has been 'filled' yet. If this is last channel to be 'filled', Do() will block, until the device is ready to receive more data. The size of the data chunk passed has restrictions which are dependent on the implementation. Most will require the size to be a power-of-two somewhere in the region of 32 samples to 8192 samples.
data | The Audio chunk that we want to pass to the selected Device |
Definition at line 92 of file AudioOut.hxx.
References CLAM::Processing::AbleToExecute(), and CLAM::AudioDevice::Write().
|
inline |
Definition at line 105 of file AudioOut.hxx.
|
inlinevirtual |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Definition at line 76 of file AudioOut.hxx.
|
inlinevirtual |
Getter for the configuration of the class.
Reimplemented from CLAM::Processing.
Definition at line 60 of file AudioOut.hxx.
Referenced by CLAM::AudioDevice::Register().
void CLAM::AudioOut::GetDeviceInfo | ( | AudioDevice::TInfo & | info | ) | const |
Getter for the Info of Device Object attached to this AudioIn instantiation.
info | TInfo object that method will modify with the values of Tinfo internal object |
Definition at line 124 of file AudioOut.cxx.
References CLAM::AudioDevice::GetInfo(), and CLAM::AudioDevice::TInfo::Reset().
|
inlinevirtual |
Wether the processing is a sync source such as audio i/o device, or an audio callback hook (i.e.
Externalizer)
Reimplemented from CLAM::Processing.
Definition at line 109 of file AudioOut.hxx.
|
friend |
Definition at line 40 of file AudioOut.hxx.
|
friend |
Definition at line 39 of file AudioOut.hxx.