CLAM-Development  1.4.0
Public Member Functions | Protected Member Functions | Protected Attributes
CLAM::MonoAudioFileWriter Class Reference

#include <MonoAudioFileWriter.hxx>

List of all members.

Public Member Functions

 MonoAudioFileWriter ()
 MonoAudioFileWriter (const ProcessingConfig &cfg)
virtual const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
virtual const ProcessingConfigGetConfig () const
 Configuration getter.
virtual bool Do ()
 Supervised mode execution method (using ports)
virtual bool Do (const CLAM::Audio &data)
virtual ~MonoAudioFileWriter ()
- 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.
virtual bool SupportsVariableAudioSize () const
 This method reports whether the processing supports dynamic buffer-size host.

Protected Member Functions

virtual bool ConcreteConfigure (const ProcessingConfig &cfgObj)
 Configuration method interface.
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.
- Protected Member Functions inherited from CLAM::Processing
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

MonoAudioFileWriterConfig mConfig
AudioInPort mInput
AudioCodecs::StreammOutStream
AudioFileTarget mFile
- Protected Attributes inherited from CLAM::Processing
ProcessingCompositempParent
 Pointer to the parent (composite) processing object, or 0.
Network_network
 The parent network if any.

Additional Inherited Members

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

Detailed Description

Definition at line 34 of file MonoAudioFileWriter.hxx.


Constructor & Destructor Documentation

CLAM::MonoAudioFileWriter::MonoAudioFileWriter ( )

Definition at line 43 of file MonoAudioFileWriter.cxx.

References CLAM::Processing::Configure().

CLAM::MonoAudioFileWriter::MonoAudioFileWriter ( const ProcessingConfig cfg)

Definition at line 50 of file MonoAudioFileWriter.cxx.

References CLAM::Processing::Configure().

CLAM::MonoAudioFileWriter::~MonoAudioFileWriter ( )
virtual

Member Function Documentation

bool CLAM::MonoAudioFileWriter::ConcreteConfigure ( const ProcessingConfig )
protectedvirtual

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 88 of file MonoAudioFileWriter.cxx.

References CLAM::Processing::AddConfigErrorMessage(), CLAM::Processing::CopyAsConcreteConfig(), CLAM::AudioFileTarget::CreateNew(), CLAM::EAudioFileFormat::FormatFromFilename(), CLAM::AudioFile::GetHeader(), CLAM::FileSystem::GetInstance(), CLAM::AudioFile::GetStream(), CLAM::AudioFile::IsWritable(), CLAM::FileSystem::LockFile(), mConfig, mFile, mOutStream, CLAM::AudioFileHeader::SetValues(), and CLAM::FileSystem::UnlockFile().

bool CLAM::MonoAudioFileWriter::ConcreteStart ( void  )
protectedvirtual

Processing objects have to redefine this method when starting them implies some internal changes.

ie: adquiring resources.

Returns:
Whether start changes have been successful

Reimplemented from CLAM::Processing.

Definition at line 137 of file MonoAudioFileWriter.cxx.

References mOutStream, and CLAM::AudioCodecs::Stream::PrepareWriting().

bool CLAM::MonoAudioFileWriter::ConcreteStop ( )
protectedvirtual

Processing objects have to redefine this method when stoping them implies some internal changes.

ie: releasing resources.

Returns:
Whether stop changes have been successful

Reimplemented from CLAM::Processing.

Definition at line 144 of file MonoAudioFileWriter.cxx.

References CLAM::AudioCodecs::Stream::Dispose(), mOutStream, and NULL.

bool CLAM::MonoAudioFileWriter::Do ( )
virtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 75 of file MonoAudioFileWriter.cxx.

References CLAM::InPort< Token >::Consume(), CLAM::AudioInPort::GetAudio(), and mInput.

bool CLAM::MonoAudioFileWriter::Do ( const CLAM::Audio data)
virtual
const char * CLAM::MonoAudioFileWriter::GetClassName ( ) const
virtual

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

Implements CLAM::Processing.

Definition at line 65 of file MonoAudioFileWriter.cxx.

const ProcessingConfig & CLAM::MonoAudioFileWriter::GetConfig ( ) const
virtual

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 70 of file MonoAudioFileWriter.cxx.

References mConfig.


Member Data Documentation

MonoAudioFileWriterConfig CLAM::MonoAudioFileWriter::mConfig
protected

Definition at line 56 of file MonoAudioFileWriter.hxx.

Referenced by ConcreteConfigure(), GetConfig(), and ~MonoAudioFileWriter().

AudioFileTarget CLAM::MonoAudioFileWriter::mFile
protected

Definition at line 59 of file MonoAudioFileWriter.hxx.

Referenced by ConcreteConfigure().

AudioInPort CLAM::MonoAudioFileWriter::mInput
protected

Definition at line 57 of file MonoAudioFileWriter.hxx.

Referenced by Do().

AudioCodecs::Stream* CLAM::MonoAudioFileWriter::mOutStream
protected

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