CLAM::MultiChannelAudioFileWriter Class Reference

#include <MultiChannelAudioFileWriter.hxx>

Inheritance diagram for CLAM::MultiChannelAudioFileWriter:

Detailed Description

Definition at line 36 of file MultiChannelAudioFileWriter.hxx.


Public Member Functions
	MultiChannelAudioFileWriter ()
	MultiChannelAudioFileWriter (const ProcessingConfig &cfg)
	~MultiChannelAudioFileWriter ()
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 > &inputs)
bool	ModifiesPortsAndControlsAtConfiguration ()
	This method is used to determine if a given processing can change its interface of ports/controls after its construction (i.e.
Protected Types
typedef std::vector < AudioInPort * >	VectorOfInputs
typedef std::vector< const Audio * >	InputsRefVector
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	DestroyOldInputs ()
Protected Attributes
MultiChannelAudioFileWriterConfig	mConfig
VectorOfInputs	mInputs
AudioCodecs::Stream *	mNativeStream
Array< TIndex >	mChannelsToWrite
Array< TData * >	mSamplesMatrix
AudioFileTarget	mAudioFile

Member Typedef Documentation

typedef std::vector< AudioInPort* > CLAM::MultiChannelAudioFileWriter::VectorOfInputs [protected]

Definition at line 60 of file MultiChannelAudioFileWriter.hxx.

typedef std::vector< const Audio* > CLAM::MultiChannelAudioFileWriter::InputsRefVector [protected]

Definition at line 61 of file MultiChannelAudioFileWriter.hxx.

Constructor & Destructor Documentation

CLAM::MultiChannelAudioFileWriter::MultiChannelAudioFileWriter ( )

Definition at line 47 of file MultiChannelAudioFileWriter.cxx.

References CLAM::Processing::Configure().

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

Definition at line 53 of file MultiChannelAudioFileWriter.cxx.

References CLAM::Processing::Configure().

CLAM::MultiChannelAudioFileWriter::~MultiChannelAudioFileWriter ( )

Definition at line 59 of file MultiChannelAudioFileWriter.cxx.

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

Member Function Documentation

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

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

Implements CLAM::Processing.

Definition at line 71 of file MultiChannelAudioFileWriter.cxx.

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

References mConfig.

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

Supervised mode execution method (using ports).

Returns:: A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 124 of file MultiChannelAudioFileWriter.cxx.

References CLAM::Processing::AbleToExecute(), CLAM_ASSERT, mChannelsToWrite, mInputs, mNativeStream, mSamplesMatrix, and CLAM::AudioCodecs::Stream::WriteData().

bool CLAM::MultiChannelAudioFileWriter::Do ( std::vector< Audio > & inputs ) [virtual]

Definition at line 86 of file MultiChannelAudioFileWriter.cxx.

References CLAM::Processing::AbleToExecute(), CLAM_ASSERT, mChannelsToWrite, mNativeStream, mSamplesMatrix, and CLAM::AudioCodecs::Stream::WriteData().

bool CLAM::MultiChannelAudioFileWriter::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 76 of file MultiChannelAudioFileWriter.cxx.

bool CLAM::MultiChannelAudioFileWriter::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 173 of file MultiChannelAudioFileWriter.cxx.

References CLAM::Processing::AddConfigErrorMessage(), CLAM::Processing::CopyAsConcreteConfig(), CLAM::AudioFileTarget::CreateNew(), DestroyOldInputs(), CLAM::EAudioFileFormat::FormatFromFilename(), CLAM::FileSystem::GetInstance(), CLAM::AudioFile::GetStream(), CLAM::AudioFile::IsWritable(), CLAM::FileSystem::LockFile(), mAudioFile, mChannelsToWrite, mConfig, mInputs, mNativeStream, mSamplesMatrix, NULL, CLAM::AudioFileHeader::SetValues(), and CLAM::FileSystem::UnlockFile().