CLAM-Development
1.4.0
|
#include <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. | |
![]() | |
bool | Configure (const ProcessingConfig &config) |
Configuration change method. | |
void | Start (void) |
Method to turn the object into running state. | |
void | Stop (void) |
Method to put the object out of running state When in execution mode, this method must be called before any further call to Configure() methods. | |
Processing () | |
virtual | ~Processing () |
virtual bool | CanProcessInplace () |
Override this method if your processing cannot process inplace. | |
bool | CanConsumeAndProduce () |
Check that Supervised Do() can be safely called. | |
void | ConsumeAndProduce () |
Acknoledges data tokens in published ports as read/writen by calling Produce() for all registered OutPorts and Consume() to all registered InPorts. | |
std::string | GetExecStateString () const |
bool | IsConfigured () const |
bool | IsRunning () const |
void | RegisterOutPort (OutPortBase *out) |
void | RegisterInPort (InPortBase *in) |
void | RegisterOutControl (OutControlBase *out) |
void | RegisterInControl (InControlBase *in) |
void | SetParent (Processing *p) |
void | SetNetworkBackLink (Network *network) |
bool | HasInPort (const std::string &name) |
bool | HasOutPort (const std::string &name) |
bool | HasInControl (const std::string &name) |
bool | HasOutControl (const std::string &name) |
InPortBase & | GetInPort (const std::string &name) |
OutPortBase & | GetOutPort (const std::string &name) |
InControlBase & | GetInControl (const std::string &name) |
OutControlBase & | GetOutControl (const std::string &name) |
InPortBase & | GetInPort (unsigned index) |
OutPortBase & | GetOutPort (unsigned index) |
InControlBase & | GetInControl (unsigned index) |
OutControlBase & | GetOutControl (unsigned index) |
unsigned | GetNInPorts () const |
unsigned | GetNOutPorts () const |
unsigned | GetNInControls () const |
unsigned | GetNOutControls () const |
const std::string & | GetConfigErrorMessage () const |
Returns a string describing configuration errors if any. | |
virtual bool | IsSyncSource () const |
Wether the processing is a sync source such as audio i/o device, or an audio callback hook (i.e. | |
virtual bool | SupportsVariableAudioSize () const |
This method reports whether the processing supports dynamic buffer-size host. |
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 () |
![]() | |
unsigned | BackendBufferSize () |
Given by the NetworkPlayer (backend) if exists. | |
unsigned | BackendSampleRate () |
Given by the NetworkPlayer (backend) if exists. | |
InControlRegistry & | GetInControls () |
Accessor to published Controls manager. | |
OutControlRegistry & | GetOutControls () |
Accessor to published Controls manager. | |
InPortRegistry & | GetInPorts () |
Accessor to published Ports manager. | |
OutPortRegistry & | GetOutPorts () |
Accessor to published Portss manager. | |
bool | AddConfigErrorMessage (const std::string &msg) |
Use this method to append a configuration errors to the processing when implementing ConcreteConfigure. | |
bool | AbleToExecute (void) const |
In debug-mode checks that the processing is configured and started. | |
template<typename ConcreteConfig > | |
void | CopyAsConcreteConfig (ConcreteConfig &concrete, const ProcessingConfig &abstract) const |
Helper template to convert a reference to a ProcessingConfig to the concrete ProcessingConfig specified on the first parameter. | |
void | SetExecState (ExecState state) |
Protected Attributes | |
MultiChannelAudioFileWriterConfig | mConfig |
VectorOfInputs | mInputs |
AudioCodecs::Stream * | mNativeStream |
Array< TIndex > | mChannelsToWrite |
Array< TData * > | mSamplesMatrix |
AudioFileTarget | mAudioFile |
![]() | |
ProcessingComposite * | mpParent |
Pointer to the parent (composite) processing object, or 0. | |
Network * | _network |
The parent network if any. |
Additional Inherited Members | |
![]() | |
enum | ExecState { Unconfigured = 0, Ready, Running } |
Processing Object possible execution states. More... | |
typedef NullProcessingConfig | Config |
Definition at line 36 of file MultiChannelAudioFileWriter.hxx.
|
protected |
Definition at line 61 of file MultiChannelAudioFileWriter.hxx.
|
protected |
Definition at line 60 of file MultiChannelAudioFileWriter.hxx.
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().
|
protectedvirtual |
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.
Reference | to the configuration object. |
true if the processing object is left in a consistent state, and can be executed.
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::Array< T >::Resize(), CLAM::Array< T >::SetSize(), CLAM::AudioFileHeader::SetValues(), and CLAM::FileSystem::UnlockFile().
|
protectedvirtual |
Processing objects have to redefine this method when starting them implies some internal changes.
ie: adquiring resources.
Reimplemented from CLAM::Processing.
Definition at line 243 of file MultiChannelAudioFileWriter.cxx.
References CLAM::AudioFile::GetStream(), mAudioFile, mNativeStream, NULL, and CLAM::AudioCodecs::Stream::PrepareWriting().
|
protectedvirtual |
Processing objects have to redefine this method when stoping them implies some internal changes.
ie: releasing resources.
Reimplemented from CLAM::Processing.
Definition at line 252 of file MultiChannelAudioFileWriter.cxx.
References CLAM::AudioCodecs::Stream::Dispose(), mNativeStream, and NULL.
|
protected |
Definition at line 261 of file MultiChannelAudioFileWriter.cxx.
References CLAM::InPortRegistry::Clear(), CLAM::Processing::GetInPorts(), and mInputs.
Referenced by ConcreteConfigure(), and ~MultiChannelAudioFileWriter().
|
virtual |
Supervised mode execution method (using ports)
Implements CLAM::Processing.
Definition at line 124 of file MultiChannelAudioFileWriter.cxx.
References CLAM::Processing::AbleToExecute(), CLAM_ASSERT, CLAM::Array< T >::GetPtr(), mChannelsToWrite, mInputs, mNativeStream, mSamplesMatrix, CLAM::Array< T >::Size(), and CLAM::AudioCodecs::Stream::WriteData().
|
virtual |
Definition at line 86 of file MultiChannelAudioFileWriter.cxx.
References CLAM::Processing::AbleToExecute(), CLAM_ASSERT, CLAM::Array< T >::GetPtr(), mChannelsToWrite, mNativeStream, mSamplesMatrix, CLAM::Array< T >::Size(), and CLAM::AudioCodecs::Stream::WriteData().
|
virtual |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Definition at line 71 of file MultiChannelAudioFileWriter.cxx.
|
virtual |
Configuration getter.
Gets the configuration parameters used to create the object.
Reimplemented from CLAM::Processing.
Definition at line 81 of file MultiChannelAudioFileWriter.cxx.
References mConfig.
|
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.
|
protected |
Definition at line 68 of file MultiChannelAudioFileWriter.hxx.
Referenced by ConcreteConfigure(), and ConcreteStart().
Definition at line 66 of file MultiChannelAudioFileWriter.hxx.
Referenced by ConcreteConfigure(), and Do().
|
protected |
Definition at line 63 of file MultiChannelAudioFileWriter.hxx.
Referenced by ConcreteConfigure(), GetConfig(), and ~MultiChannelAudioFileWriter().
|
protected |
Definition at line 64 of file MultiChannelAudioFileWriter.hxx.
Referenced by ConcreteConfigure(), DestroyOldInputs(), and Do().
|
protected |
Definition at line 65 of file MultiChannelAudioFileWriter.hxx.
Referenced by ConcreteConfigure(), ConcreteStart(), ConcreteStop(), Do(), and ~MultiChannelAudioFileWriter().
Definition at line 67 of file MultiChannelAudioFileWriter.hxx.
Referenced by ConcreteConfigure(), and Do().