CLAM::MultiChannelAudioFileReader Class Reference

#include <MultiChannelAudioFileReader.hxx>

Inheritance diagram for CLAM::MultiChannelAudioFileReader:

List of all members.

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 43 of file MultiChannelAudioFileReader.cxx.

References CLAM::Processing::Configure().

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

Definition at line 50 of file MultiChannelAudioFileReader.cxx.

References CLAM::Processing::Configure().

CLAM::MultiChannelAudioFileReader::~MultiChannelAudioFileReader ( )

Definition at line 57 of file MultiChannelAudioFileReader.cxx.

References mNativeStream, and ResizePorts().

Member Function Documentation

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 64 of file MultiChannelAudioFileReader.cxx.

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 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 151 of file MultiChannelAudioFileReader.cxx.

References _outputs, CLAM::Processing::AbleToExecute(), CLAM_ASSERT, CLAM::AudioFile::GetHeader(), GetHeader(), mAudioFile, mCurrentBeginTime, mDeltaTime, mEOFReached, mIsPaused, mNativeStream, mSamplesMatrix, mSelectedChannels, mTimeOutput, CLAM::AudioCodecs::Stream::ReadData(), and CLAM::OutControl< ControlDataType >::SendControl().

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

Definition at line 80 of file MultiChannelAudioFileReader.cxx.

References CLAM::Processing::AbleToExecute(), CLAM_ASSERT, CLAM::AudioFile::GetHeader(), GetHeader(), mAudioFile, mCurrentBeginTime, mDeltaTime, mEOFReached, mIsPaused, mNativeStream, mSamplesMatrix, mSelectedChannels, mTimeOutput, CLAM::AudioCodecs::Stream::ReadData(), and CLAM::OutControl< ControlDataType >::SendControl().

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 69 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.

Referenced by Do().

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

Definition at line 51 of file MultiChannelAudioFileReader.hxx.

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

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

Definition at line 52 of file MultiChannelAudioFileReader.hxx.

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

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

Definition at line 53 of file MultiChannelAudioFileReader.hxx.

References mSelectedChannels.

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

Definition at line 55 of file MultiChannelAudioFileReader.hxx.

References mIsPaused.

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 240 of file MultiChannelAudioFileReader.cxx.

References _outputs, CLAM::Processing::AddConfigErrorMessage(), CLAM::Processing::CopyAsConcreteConfig(), CLAM::AudioFile::GetHeader(), CLAM::Array< T >::GetPtr(), CLAM::AudioFile::GetStream(), CLAM::AudioFile::IsReadable(), mAudioFile, mConfig, mNativeStream, mSamplesMatrix, mSelectedChannels, CLAM::AudioFileSource::OpenExisting(), ResizePorts(), and CLAM::Array< T >::Size().

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 326 of file MultiChannelAudioFileReader.cxx.

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

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 338 of file MultiChannelAudioFileReader.cxx.

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

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

Definition at line 346 of file MultiChannelAudioFileReader.cxx.

References _outputs.

Referenced by ConcreteConfigure(), and ~MultiChannelAudioFileReader().

Member Data Documentation

MultiChannelAudioFileReaderConfig CLAM::MultiChannelAudioFileReader::mConfig [protected]

Definition at line 70 of file MultiChannelAudioFileReader.hxx.

Referenced by ConcreteConfigure(), and GetConfig().

OutputVector CLAM::MultiChannelAudioFileReader::_outputs [protected]

Definition at line 71 of file MultiChannelAudioFileReader.hxx.

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

FloatOutControl CLAM::MultiChannelAudioFileReader::mTimeOutput [protected]

Definition at line 72 of file MultiChannelAudioFileReader.hxx.

Referenced by Do().

std::vector< TIndex > CLAM::MultiChannelAudioFileReader::mSelectedChannels [protected]

Definition at line 73 of file MultiChannelAudioFileReader.hxx.

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

std::vector< TData* > CLAM::MultiChannelAudioFileReader::mSamplesMatrix [protected]

Definition at line 74 of file MultiChannelAudioFileReader.hxx.

Referenced by ConcreteConfigure(), and Do().

AudioCodecs::Stream* CLAM::MultiChannelAudioFileReader::mNativeStream [protected]

Definition at line 75 of file MultiChannelAudioFileReader.hxx.

Referenced by ConcreteConfigure(), ConcreteStart(), ConcreteStop(), Do(), and ~MultiChannelAudioFileReader().

TTime CLAM::MultiChannelAudioFileReader::mCurrentBeginTime [protected]

Definition at line 76 of file MultiChannelAudioFileReader.hxx.

Referenced by ConcreteStart(), and Do().

TTime CLAM::MultiChannelAudioFileReader::mDeltaTime [protected]

Definition at line 77 of file MultiChannelAudioFileReader.hxx.

Referenced by Do().

bool CLAM::MultiChannelAudioFileReader::mEOFReached [protected]

Definition at line 78 of file MultiChannelAudioFileReader.hxx.

Referenced by ConcreteStart(), and Do().

bool CLAM::MultiChannelAudioFileReader::mIsPaused [protected]

Definition at line 79 of file MultiChannelAudioFileReader.hxx.

Referenced by ConcreteStart(), Do(), and Pause().

AudioFileSource CLAM::MultiChannelAudioFileReader::mAudioFile [protected]

Definition at line 80 of file MultiChannelAudioFileReader.hxx.

Referenced by ConcreteConfigure(), ConcreteStart(), Do(), GetCodec(), GetHeader(), and GetTextDescriptors().

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


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