CLAM::MonoAudioFileWriter Class Reference

#include <MonoAudioFileWriter.hxx>

Inheritance diagram for CLAM::MonoAudioFileWriter:

Detailed Description

Definition at line 34 of file MonoAudioFileWriter.hxx.


Public Member Functions
	MonoAudioFileWriter ()
	MonoAudioFileWriter (const ProcessingConfig &cfg)
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 (const CLAM::Audio &data)
virtual	~MonoAudioFileWriter ()
Protected Member Functions
virtual bool	ConcreteConfigure (const ProcessingConfig &cfgObj)
	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
MonoAudioFileWriterConfig	mConfig
AudioInPort	mInput
AudioCodecs::Stream *	mOutStream
AudioFileTarget	mFile

Constructor & Destructor Documentation

CLAM::MonoAudioFileWriter::MonoAudioFileWriter ( )

Definition at line 43 of file MonoAudioFileWriter.cxx.

References CLAM::Processing::Configure().

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

Definition at line 50 of file MonoAudioFileWriter.cxx.

References CLAM::Processing::Configure().

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

Definition at line 57 of file MonoAudioFileWriter.cxx.

References CLAM::FileSystem::GetInstance(), mConfig, mOutStream, and CLAM::FileSystem::UnlockFile().

Member Function Documentation

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

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

Implements CLAM::Processing.

Definition at line 65 of file MonoAudioFileWriter.cxx.

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

References mConfig.

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

Supervised mode execution method (using ports).

Returns:: A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 75 of file MonoAudioFileWriter.cxx.

References CLAM::InPort< Token >::Consume(), CLAM::AudioInPort::GetAudio(), and mInput.

bool CLAM::MonoAudioFileWriter::Do ( const CLAM::Audio & data ) [virtual]

Definition at line 82 of file MonoAudioFileWriter.cxx.

References CLAM::Audio::GetSize(), mOutStream, and CLAM::AudioCodecs::Stream::WriteData().

bool CLAM::MonoAudioFileWriter::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 88 of file MonoAudioFileWriter.cxx.

References CLAM::Processing::AddConfigErrorMessage(), CLAM::Processing::CopyAsConcreteConfig(), CLAM::AudioFileTarget::CreateNew(), CLAM::EAudioFileFormat::FormatFromFilename(), CLAM::AudioFile::GetHeader(), CLAM::FileSystem::GetInstance(), CLAM::AudioFile::GetStream(), CLAM::AudioFile::IsWritable(), CLAM::FileSystem::LockFile(), mConfig, mFile, mOutStream, CLAM::AudioFileHeader::SetValues(), and CLAM::FileSystem::UnlockFile().