CLAM::AudioFileMemoryLoader Class Reference

#include <AudioFileMemoryLoader.hxx>

Inheritance diagram for CLAM::AudioFileMemoryLoader:

Detailed Description

Definition at line 35 of file AudioFileMemoryLoader.hxx.


Public Types
typedef MonoAudioFileReaderConfig	Config
Public Member Functions
	AudioFileMemoryLoader (const ProcessingConfig &cfg=Config())
virtual const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
virtual const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	Do (Audio &outputSamples)
virtual bool	Do ()
	Supervised mode execution method (using ports).
virtual	~AudioFileMemoryLoader ()
unsigned long	GetSamples ()
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.
Protected Attributes
Config	_config
AudioOutPort	_output
OutControl	_timeOutput
InControl	_positionInput
TControlData	_lastPosition
TControlData	_delta
long	_position
Audio	_samples
TData	_sampleRate

Member Typedef Documentation

typedef MonoAudioFileReaderConfig CLAM::AudioFileMemoryLoader::Config

Reimplemented from CLAM::Processing.

Definition at line 39 of file AudioFileMemoryLoader.hxx.

Constructor & Destructor Documentation

CLAM::AudioFileMemoryLoader::AudioFileMemoryLoader ( const ProcessingConfig & cfg = Config() )

Definition at line 42 of file AudioFileMemoryLoader.cxx.

References _positionInput, CLAM::Processing::Configure(), and CLAM::InControl::SetBounds().

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

Definition at line 53 of file AudioFileMemoryLoader.cxx.

Member Function Documentation

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

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

Implements CLAM::Processing.

Definition at line 58 of file AudioFileMemoryLoader.cxx.

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

References _config.

bool CLAM::AudioFileMemoryLoader::Do ( Audio & outputSamples )

Definition at line 107 of file AudioFileMemoryLoader.cxx.

References _config, _delta, _lastPosition, _position, _positionInput, _samples, _timeOutput, CLAM::InControl::GetLastValue(), CLAM::Audio::GetSize(), and CLAM::OutControl::SendControl().

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

Supervised mode execution method (using ports).

Returns:: A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 99 of file AudioFileMemoryLoader.cxx.

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

unsigned long CLAM::AudioFileMemoryLoader::GetSamples ( )

Definition at line 153 of file AudioFileMemoryLoader.cxx.

References _samples, and CLAM::Audio::GetSize().

bool CLAM::AudioFileMemoryLoader::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 68 of file AudioFileMemoryLoader.cxx.

References _config, _delta, _position, _sampleRate, _samples, _timeOutput, CLAM::Processing::AddConfigErrorMessage(), CLAM::Processing::CopyAsConcreteConfig(), CLAM::MonoAudioFileReader::Do(), CLAM::Processing::GetConfigErrorMessage(), CLAM::MonoAudioFileReader::GetHeader(), CLAM::Processing::IsConfigured(), CLAM::OutControl::SendControl(), CLAM::Audio::SetSize(), and CLAM::Processing::Start().