CLAM::MultiChannelAudioFileReader Class Reference

#include <MultiChannelAudioFileReader.hxx>

Public Member Functions
	MultiChannelAudioFileReader ()
	MultiChannelAudioFileReader (const ProcessingConfig &cfg)
	~MultiChannelAudioFileReader ()
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 ()
	Supervised mode execution method (using ports).
virtual bool	Do (std::vector< Audio > &outputs)
bool	ModifiesPortsAndControlsAtConfiguration ()
	This method is used to determine if a given processing can change its interface of ports/controls after its construction (i.e.
const AudioFileHeader &	GetHeader () const
const AudioTextDescriptors &	GetTextDescriptors () const
const EAudioFileCodec	GetCodec () const
const std::vector< TIndex > &	GetSelectedChannels () const
void	Pause ()
Protected Types
typedef std::vector < AudioOutPort * >	OutputVector
typedef std::vector< Audio * >	OutRefsVector
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.
void	ResizePorts (unsigned nPorts)
Protected Attributes
MultiChannelAudioFileReaderConfig	mConfig
OutputVector	_outputs
FloatOutControl	mTimeOutput
std::vector< TIndex >	mSelectedChannels
std::vector< TData * >	mSamplesMatrix
AudioCodecs::Stream *	mNativeStream
TTime	mCurrentBeginTime
TTime	mDeltaTime
bool	mEOFReached
bool	mIsPaused
AudioFileSource	mAudioFile

Detailed Description

Definition at line 37 of file MultiChannelAudioFileReader.hxx.

Member Typedef Documentation

typedef std::vector< AudioOutPort* > CLAM::MultiChannelAudioFileReader::OutputVector [protected]

Definition at line 67 of file MultiChannelAudioFileReader.hxx.

typedef std::vector< Audio* > CLAM::MultiChannelAudioFileReader::OutRefsVector [protected]

Definition at line 68 of file MultiChannelAudioFileReader.hxx.

Constructor & Destructor Documentation

CLAM::MultiChannelAudioFileReader::MultiChannelAudioFileReader ( )

Definition at line 37 of file MultiChannelAudioFileReader.cxx.

CLAM::MultiChannelAudioFileReader::MultiChannelAudioFileReader ( const ProcessingConfig & cfg )

Definition at line 44 of file MultiChannelAudioFileReader.cxx.

CLAM::MultiChannelAudioFileReader::~MultiChannelAudioFileReader ( )

Definition at line 51 of file MultiChannelAudioFileReader.cxx.

Member Function Documentation

bool CLAM::MultiChannelAudioFileReader::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 234 of file MultiChannelAudioFileReader.cxx.

bool CLAM::MultiChannelAudioFileReader::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 320 of file MultiChannelAudioFileReader.cxx.

bool CLAM::MultiChannelAudioFileReader::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 332 of file MultiChannelAudioFileReader.cxx.

bool CLAM::MultiChannelAudioFileReader::Do ( std::vector< Audio > & outputs ) [virtual]

Definition at line 74 of file MultiChannelAudioFileReader.cxx.

References mConfig.

bool CLAM::MultiChannelAudioFileReader::Do ( ) [virtual]

Supervised mode execution method (using ports).

Returns:: A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 145 of file MultiChannelAudioFileReader.cxx.

const char * CLAM::MultiChannelAudioFileReader::GetClassName ( ) const [virtual]

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

Implements CLAM::Processing.

Definition at line 58 of file MultiChannelAudioFileReader.cxx.

References mNativeStream, and ResizePorts().

const EAudioFileCodec CLAM::MultiChannelAudioFileReader::GetCodec ( ) const [inline]

Definition at line 52 of file MultiChannelAudioFileReader.hxx.

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

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

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

Definition at line 50 of file MultiChannelAudioFileReader.hxx.

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

const std::vector<TIndex>& CLAM::MultiChannelAudioFileReader::GetSelectedChannels ( ) const [inline]

Definition at line 53 of file MultiChannelAudioFileReader.hxx.

References mSelectedChannels.

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

Definition at line 51 of file MultiChannelAudioFileReader.hxx.

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

bool CLAM::MultiChannelAudioFileReader::ModifiesPortsAndControlsAtConfiguration ( ) [virtual]

This method is used to determine if a given processing can change its interface of ports/controls after its construction (i.e.

changing the name of ports in ConcreteConfigure). If a concrete processing can do this, it should reimplement the method returning true, in order to notify networks, graphical interfaces, etc.

Reimplemented from CLAM::Processing.

Definition at line 63 of file MultiChannelAudioFileReader.cxx.

void CLAM::MultiChannelAudioFileReader::Pause ( ) [inline]

Definition at line 55 of file MultiChannelAudioFileReader.hxx.

References mIsPaused.

void CLAM::MultiChannelAudioFileReader::ResizePorts ( unsigned nPorts ) [protected]

Definition at line 340 of file MultiChannelAudioFileReader.cxx.

Referenced by GetClassName().