MultiChannelAudioFileWriter.cxx

Go to the documentation of this file.

/*
 * Copyright (c) 2001-2004 MUSIC TECHNOLOGY GROUP (MTG)
 *                         UNIVERSITAT POMPEU FABRA
 *
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#include "MultiChannelAudioFileWriter.hxx"
#include "AudioCodecs_Stream.hxx"
#include "FileSystem.hxx"
#include "AudioInPort.hxx"
#include "Audio.hxx"
#include "XMLStorage.hxx" // TODO: jsut for testing
#include "ProcessingFactory.hxx"



namespace CLAM
{

namespace Hidden
{
        static const char * metadata[] = {
                "key", "MultiChannelAudioFileWriter",
                "category", "Audio File I/O",
                "description", "MultiChannelAudioFileWriter",
                0
        };
        static FactoryRegistrator<ProcessingFactory, MultiChannelAudioFileWriter> reg = metadata;
}
        
        
        MultiChannelAudioFileWriter::MultiChannelAudioFileWriter()
                : mNativeStream( NULL )
        {
                Configure(MultiChannelAudioFileWriterConfig());
        }

        MultiChannelAudioFileWriter::MultiChannelAudioFileWriter( const ProcessingConfig& cfg )
                : mNativeStream( NULL )
        {
                Configure( cfg );
        }

        MultiChannelAudioFileWriter::~MultiChannelAudioFileWriter()
        {
                if ( mNativeStream )
                        delete mNativeStream;

                DestroyOldInputs();

                if ( mConfig.HasTargetFile() )
                        FileSystem::GetInstance().UnlockFile( mConfig.GetTargetFile() );

        }

        const char* MultiChannelAudioFileWriter::GetClassName() const
        {
                return "MultiChannelAudioFileWriter";
        }

        bool MultiChannelAudioFileWriter::ModifiesPortsAndControlsAtConfiguration()
        {
                return true;
        }

        const ProcessingConfig& MultiChannelAudioFileWriter::GetConfig() const
        {
                return mConfig;
        }

        bool MultiChannelAudioFileWriter::Do( std::vector<Audio>& inputs )
        {
                typedef std::vector<Audio> InputVec;

                if ( !AbleToExecute() )
                        return false;

                // Checking that all inputs have the same size
                bool  allInputsSameSize = true;
                TSize inputsSize = 0;

                inputsSize = inputs[0].GetSize();

                for ( InputVec::iterator i = inputs.begin();
                      i!= inputs.end() && allInputsSameSize;
                      i++ )
                  {
                    allInputsSameSize = ( inputsSize == (*i).GetSize() );
                  }


                CLAM_ASSERT( allInputsSameSize, "Input sizes differ!" );

                // Now, let's build the samples matrix

                int j = 0;

                for( InputVec::iterator i = inputs.begin();
                     i != inputs.end(); i++ )
                        mSamplesMatrix[ j++ ] = (*i).GetBuffer().GetPtr();

                mNativeStream->WriteData( mChannelsToWrite.GetPtr(), mChannelsToWrite.Size(),
                                        mSamplesMatrix.GetPtr(), inputsSize );

                return true;

        }

        bool MultiChannelAudioFileWriter::Do()
        {
                if ( !AbleToExecute() )
                        return false;

                // Checking that all inputs have the same size
                bool  allInputsSameSize = true;
                TSize inputsSize = 0;

                InputsRefVector inputsRef;

                for ( VectorOfInputs::iterator i = mInputs.begin();
                      i!= mInputs.end(); i++ )
                {
                    inputsRef.push_back( &((*i)->GetAudio()) );
                }

                inputsSize = inputsRef[0]->GetSize();

                for ( InputsRefVector::iterator i = inputsRef.begin();
                      i!= inputsRef.end() && allInputsSameSize;
                      i++ )
                {
                    allInputsSameSize = ( inputsSize == (*i)->GetSize() );
                }


                CLAM_ASSERT( allInputsSameSize, "Input sizes differ!" );

                // Now, let's build the samples matrix

                int j = 0;

                for( InputsRefVector::iterator i = inputsRef.begin();
                     i != inputsRef.end(); i++ )
                  mSamplesMatrix[ j++ ] = (*i)->GetBuffer().GetPtr();

                mNativeStream->WriteData( mChannelsToWrite.GetPtr(), mChannelsToWrite.Size(),
                                         mSamplesMatrix.GetPtr(), inputsSize );

                for( VectorOfInputs::iterator i = mInputs.begin();
                     i!=mInputs.end(); i++ )
                  {
                    (*i)->Consume();
                  }

                return true;
        }

        bool MultiChannelAudioFileWriter::ConcreteConfigure( const ProcessingConfig& cfg )
        {
                if ( mConfig.HasTargetFile() )
                        FileSystem::GetInstance().UnlockFile( mConfig.GetTargetFile() );

                CopyAsConcreteConfig( mConfig, cfg );

                const AudioOutFilename & filename = mConfig.GetTargetFile();
                if (filename=="")
                {
                        return AddConfigErrorMessage("No file selected");
                }
                
                unsigned nChannels = mConfig.HasNChannels()? mConfig.GetNChannels() : 1;
                if ( nChannels < 1 )
                {
                        return AddConfigErrorMessage("Channels should be, at least, 1.");
                }
                AudioFileHeader header;
                header.SetValues(
                        mConfig.GetSampleRate(),
                        nChannels,
                        CLAM::EAudioFileFormat::FormatFromFilename(filename) );
                mAudioFile.CreateNew(filename, header);
                if ( !mAudioFile.IsWritable() )
                {
                        return AddConfigErrorMessage("The format does not support such number of channels, endiannes or sampling rate.");
                }

                if ( FileSystem::GetInstance().IsFileLocked( filename ) )
                {
                        AddConfigErrorMessage("The file '");
                        AddConfigErrorMessage( filename );
                        AddConfigErrorMessage("' has been locked by another Processing");

                        return false;
                }

                FileSystem::GetInstance().LockFile( filename );


                if ( !mInputs.empty() )
                        DestroyOldInputs();

                mChannelsToWrite.Resize( nChannels );
                mChannelsToWrite.SetSize( nChannels );
                mSamplesMatrix.Resize( nChannels );
                mSamplesMatrix.SetSize( nChannels );

                for ( unsigned i = 0; i < nChannels; i++ )
                {
                        mChannelsToWrite[ i ] = i;
                        mSamplesMatrix[ i ] = NULL;
                        std::stringstream sstr;
                        sstr << i;
                        
                        mInputs.push_back( 
                                new AudioInPort( "Channel #" + sstr.str(), this) );
                }

                mNativeStream = mAudioFile.GetStream();

                if ( !mNativeStream )
                {
                        return AddConfigErrorMessage("Could not acquire an audio file stream!");
                }

                return true;
        }

        bool MultiChannelAudioFileWriter::ConcreteStart()
        {
                if (mNativeStream == NULL )
                        mNativeStream = mAudioFile.GetStream();
                mNativeStream->PrepareWriting();

                return true;
        }

        bool MultiChannelAudioFileWriter::ConcreteStop()
        {
                mNativeStream->Dispose();
                delete mNativeStream;
                mNativeStream = NULL;

                return true;
        }

        void MultiChannelAudioFileWriter::DestroyOldInputs()
        {
                for ( VectorOfInputs::iterator i = mInputs.begin();
                      i != mInputs.end(); i++ )
                {
                        if ( *i ) delete *i;
                }

                mInputs.clear();
                GetInPorts().Clear();
        }
}