CLAM::MonoAudioFileReader Class Reference

#include <MonoAudioFileReader.hxx>

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 ProcessingConfig &	GetConfig () const
	Configuration getter.
virtual bool	Do (Audio &outputSamples)
virtual bool	Do ()
	Supervised mode execution method (using ports).
virtual	~MonoAudioFileReader ()
const AudioFileHeader &	GetHeader () const
const AudioTextDescriptors &	GetTextDescriptors () const
const EAudioFileCodec	GetCodec () const
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 Attributes
MonoAudioFileReaderConfig	mConfig
AudioFileSource	mAudioFile
AudioOutPort	mOutput
FloatInControl	mSeekControl
FloatOutControl	mTimeOutput
OutControl< unsigned long >	mFramePositionOutput
FloatOutControl	mProgressOutput
AudioCodecs::Stream *	mNativeStream
bool	mEOFReached

Detailed Description

Definition at line 36 of file MonoAudioFileReader.hxx.

Constructor & Destructor Documentation

CLAM::MonoAudioFileReader::MonoAudioFileReader ( const ProcessingConfig & cfg = MonoAudioFileReaderConfig() )

Definition at line 37 of file MonoAudioFileReader.cxx.

CLAM::MonoAudioFileReader::~MonoAudioFileReader ( ) [virtual]

Definition at line 49 of file MonoAudioFileReader.cxx.

Member Function Documentation

bool CLAM::MonoAudioFileReader::ConcreteConfigure ( const ProcessingConfig & ) [protected, 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.

Parameters:

Reference

to 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:

This

method 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 65 of file MonoAudioFileReader.cxx.

References mConfig.

bool CLAM::MonoAudioFileReader::ConcreteStart ( void ) [protected, virtual]

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 101 of file MonoAudioFileReader.cxx.

bool CLAM::MonoAudioFileReader::ConcreteStop ( ) [protected, virtual]

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 112 of file MonoAudioFileReader.cxx.

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 121 of file MonoAudioFileReader.cxx.

bool CLAM::MonoAudioFileReader::Do ( Audio & outputSamples ) [virtual]

Definition at line 130 of file MonoAudioFileReader.cxx.

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 55 of file MonoAudioFileReader.cxx.

References mNativeStream.

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 60 of file MonoAudioFileReader.cxx.

const AudioFileHeader& CLAM::MonoAudioFileReader::GetHeader ( ) const [inline]

Definition at line 46 of file MonoAudioFileReader.hxx.

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

const AudioTextDescriptors& CLAM::MonoAudioFileReader::GetTextDescriptors ( ) const [inline]

Definition at line 47 of file MonoAudioFileReader.hxx.

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