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

#include <MonoAudioFileReader.hxx>

List of all members.

Public Member Functions

 MonoAudioFileReader (const ProcessingConfig &cfg=MonoAudioFileReaderConfig())
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 (Audio &outputSamples)
virtual bool Do ()
 Supervised mode execution method (using ports)
virtual ~MonoAudioFileReader ()
const AudioFileHeaderGetHeader () const
const AudioTextDescriptorsGetTextDescriptors () const
const EAudioFileCodec GetCodec () const
- 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 &cfgObject)
 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

MonoAudioFileReaderConfig mConfig
AudioFileSource mAudioFile
AudioOutPort mOutput
FloatInControl mSeekControl
FloatOutControl mTimeOutput
OutControl< unsigned long > mFramePositionOutput
FloatOutControl mProgressOutput
AudioCodecs::StreammNativeStream
bool mEOFReached
- 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 36 of file MonoAudioFileReader.hxx.


Constructor & Destructor Documentation

CLAM::MonoAudioFileReader::MonoAudioFileReader ( const ProcessingConfig cfg = MonoAudioFileReaderConfig())
CLAM::MonoAudioFileReader::~MonoAudioFileReader ( )
virtual

Definition at line 54 of file MonoAudioFileReader.cxx.

References mNativeStream.


Member Function Documentation

bool CLAM::MonoAudioFileReader::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 70 of file MonoAudioFileReader.cxx.

References CLAM::Processing::AddConfigErrorMessage(), CLAM::Processing::CopyAsConcreteConfig(), CLAM::AudioFile::GetHeader(), CLAM::AudioFile::GetStream(), CLAM::AudioFile::IsReadable(), mAudioFile, mConfig, mNativeStream, and CLAM::AudioFileSource::OpenExisting().

bool CLAM::MonoAudioFileReader::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 106 of file MonoAudioFileReader.cxx.

References CLAM::AudioFile::GetStream(), mAudioFile, mEOFReached, mNativeStream, and CLAM::AudioCodecs::Stream::PrepareReading().

bool CLAM::MonoAudioFileReader::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 117 of file MonoAudioFileReader.cxx.

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

bool CLAM::MonoAudioFileReader::Do ( Audio outputSamples)
virtual
bool CLAM::MonoAudioFileReader::Do ( )
virtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 126 of file MonoAudioFileReader.cxx.

References CLAM::AudioOutPort::GetAudio(), mOutput, and CLAM::OutPort< Token >::Produce().

const char * CLAM::MonoAudioFileReader::GetClassName ( ) const
virtual

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

Implements CLAM::Processing.

Definition at line 60 of file MonoAudioFileReader.cxx.

const EAudioFileCodec CLAM::MonoAudioFileReader::GetCodec ( ) const
inline

Definition at line 48 of file MonoAudioFileReader.hxx.

References CLAM::AudioFile::GetCodec(), and mAudioFile.

const ProcessingConfig & CLAM::MonoAudioFileReader::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 65 of file MonoAudioFileReader.cxx.

References mConfig.

const AudioFileHeader& CLAM::MonoAudioFileReader::GetHeader ( ) const
inline
const AudioTextDescriptors& CLAM::MonoAudioFileReader::GetTextDescriptors ( ) const
inline

Definition at line 47 of file MonoAudioFileReader.hxx.

References CLAM::AudioFile::GetTextDescriptors(), and mAudioFile.


Member Data Documentation

AudioFileSource CLAM::MonoAudioFileReader::mAudioFile
protected
MonoAudioFileReaderConfig CLAM::MonoAudioFileReader::mConfig
protected

Definition at line 59 of file MonoAudioFileReader.hxx.

Referenced by ConcreteConfigure(), Do(), and GetConfig().

bool CLAM::MonoAudioFileReader::mEOFReached
protected

Definition at line 67 of file MonoAudioFileReader.hxx.

Referenced by ConcreteStart(), and Do().

OutControl<unsigned long> CLAM::MonoAudioFileReader::mFramePositionOutput
protected

Definition at line 64 of file MonoAudioFileReader.hxx.

Referenced by Do().

AudioCodecs::Stream* CLAM::MonoAudioFileReader::mNativeStream
protected
AudioOutPort CLAM::MonoAudioFileReader::mOutput
protected

Definition at line 61 of file MonoAudioFileReader.hxx.

Referenced by Do().

FloatOutControl CLAM::MonoAudioFileReader::mProgressOutput
protected

Definition at line 65 of file MonoAudioFileReader.hxx.

Referenced by Do().

FloatInControl CLAM::MonoAudioFileReader::mSeekControl
protected

Definition at line 62 of file MonoAudioFileReader.hxx.

Referenced by Do(), and MonoAudioFileReader().

FloatOutControl CLAM::MonoAudioFileReader::mTimeOutput
protected

Definition at line 63 of file MonoAudioFileReader.hxx.

Referenced by Do().


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