plonk_Signal.h

/*
 -------------------------------------------------------------------------------
 This file is part of the Plink, Plonk, Plank libraries
  by Martin Robinson
 
 http://code.google.com/p/pl-nk/
 
 Copyright University of the West of England, Bristol 2011-14
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
 * Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 * Neither the name of University of the West of England, Bristol nor 
   the names of its contributors may be used to endorse or promote products
   derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 DISCLAIMED. IN NO EVENT SHALL UNIVERSITY OF THE WEST OF ENGLAND, BRISTOL BE 
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 
 This software makes use of third party libraries. For more information see:
 doc/license.txt included in the distribution.
 -------------------------------------------------------------------------------
 */

#ifndef PLONK_SIGNAL_H
#define PLONK_SIGNAL_H

#include "../core/plonk_CoreForwardDeclarations.h"
#include "plonk_ContainerForwardDeclarations.h"
#include "plonk_DynamicContainer.h"

#include "../core/plonk_SmartPointer.h"
#include "../core/plonk_WeakPointer.h"
#include "plonk_ObjectArray.h"
#include "plonk_SimpleArray.h"

#include "../graph/utility/plonk_SampleRate.h"



template<class SampleType>
class SignalInternal : public SmartPointer
{
public:
    typedef NumericalArray<SampleType>      Buffer;
    typedef NumericalArray2D<SampleType>    Buffers;
    typedef Variable<SampleType>            SampleVariable;
    typedef NumericalArray<SampleVariable>  SampleVariableArray;
    
    inline SignalInternal() throw()
    :   numInterleavedChannels (1)
    {
        init();
    }
   
    inline SignalInternal (Buffers const& buffersToUse, 
                           SampleRate const& sampleRateToUse) throw()
    :   buffers (buffersToUse),
        sampleRate (sampleRateToUse),
        numInterleavedChannels (1)
    {
        plonk_assert ((buffers.length() == 1) || buffers.isMatrix()); // each channel must be the same length
        init();
    }
    
    inline SignalInternal (Buffer const& buffer, 
                           SampleRate const& sampleRateToUse,
                           const int interleavedChannelsInBuffer) throw()
    :   buffers (buffer),
        sampleRate (sampleRateToUse),
        numInterleavedChannels (interleavedChannelsInBuffer)
    {
        plonk_assert (numInterleavedChannels > 0);
        init();
    }
    
    inline int getNumFrames() const throw()
    {   
        const int numFramesPerBuffer = buffers.numColumns();
        return numFramesPerBuffer / numInterleavedChannels;
    }
    
    inline int getNumChannels() const throw()
    {
        if (numInterleavedChannels > 1)
        {
            plonk_assert (buffers.numRows() == 1);
            return numInterleavedChannels;
        }
        else
        {
            return buffers.numRows();
        }
    }
    
    inline int getFrameStride() const throw()
    {
        return isInterleaved() ? getNumChannels() : 1;
    }
    
    SampleType* getSamples (const int channel) throw()
    {
        const int wrappedChannel = plonk::wrap (channel, 0, getNumChannels());
        return isInterleaved() 
               ? 
               buffers.atUnchecked (0).getArray() + wrappedChannel
               :
               buffers.atUnchecked (wrappedChannel).getArray();
    }
    
    const SampleType* getSamples (const int channel) const throw()
    {
        const int wrappedChannel = plonk::wrap (channel, 0, getNumChannels());
        return isInterleaved() 
               ? 
               buffers.atUnchecked (0).getArray() + wrappedChannel
               :
               buffers.atUnchecked (wrappedChannel).getArray();
    }

    inline bool isInterleaved() const throw()
    {
        plonk_assert(buffers.length() > 0);
        return (numInterleavedChannels > 1) || (buffers.numRows() == 1);
    }
    
    inline Buffer getInterleaved() const throw()
    {
        plonk_assert(buffers.length() > 0);
        return (isInterleaved()) ? buffers.atUnchecked (0) : buffers.interleave();
    }
    
    inline Buffers getDeinterleaved() const throw()
    {        
        plonk_assert(buffers.length() > 0);
        if (isInterleaved()) 
            return buffers.atUnchecked (0).deinterleave (numInterleavedChannels);
        else
            return buffers;
    }
    
    friend class SignalBase<SampleType>;
    
private:
    Buffers buffers;
    SampleRate sampleRate;
    const int numInterleavedChannels;
        
    SampleVariableArray sampleVariables;
    IntVariableArray intVariables;
        
    void init() throw()
    {
        sampleVariables.setSize (buffers.length(), false);
        intVariables.setSize (buffers.length(), false);
    }
};

//------------------------------------------------------------------------------

template<class SampleType>
class SignalBase : public SmartPointerContainer< SignalInternal<SampleType> >
{
public:
    typedef SignalInternal<SampleType>              Internal;
    typedef SmartPointerContainer<Internal>         Base;
    typedef WeakPointerContainer<SignalBase>        Weak;    
    
    typedef typename Internal::Buffer               Buffer;
    typedef typename Internal::Buffers              Buffers;
    typedef typename Internal::SampleVariable       SampleVariable;
    typedef typename Internal::SampleVariableArray  SampleVariableArray;
    
    SignalBase() throw()
    :   Base (new Internal ())
    {
    }
    
    SignalBase (Buffers const& buffers, 
                SampleRate const& sampleRate = SampleRate::getDefault()) throw()
    :   Base (new Internal (buffers, sampleRate))
    {
    }
    
    SignalBase (Buffer const& buffer, 
                SampleRate const& sampleRate = SampleRate::getDefault(),
                const int interleavedChannelsInBuffer = 1) throw()
    :   Base (new Internal (buffer, sampleRate, interleavedChannelsInBuffer))
    {
    }
        
    explicit SignalBase (Internal* internalToUse) throw() 
    :   Base (internalToUse)
    {
    } 
    
    SignalBase (SignalBase const& copy) throw()
    :   Base (static_cast<Base const&> (copy))
    {
    }    
    
    SignalBase (Dynamic const& other) throw()
    :   Base (other.as<SignalBase>().getInternal())
    {
    }    
    
    SignalBase& operator= (SignalBase const& other) throw()
        {
        if (this != &other)
            this->setInternal (other.getInternal());//this->setInternal (other.containerCopy().getInternal());
        
        return *this;
        }
    
    static SignalBase fromWeak (Weak const& weak) throw()
    {
        return weak.fromWeak();
    }    
    
    static const SignalBase& getNull() throw()
    {
        static SignalBase null;        
        return null;
    }              
    
    inline const Buffers& getBuffers() const throw()
    {
        return this->getInternal()->buffers;
    }

    inline Buffers& getBuffers() throw()
    {
        return this->getInternal()->buffers;
    }

    inline const SampleRate& getSampleRate() const throw()
    {
        return this->getInternal()->sampleRate;
    }
    
    inline SampleRate& getSampleRate() throw()
    {
        return this->getInternal()->sampleRate;
    }
    
    inline int getNumFrames() const throw()
    {
        return this->getInternal()->getNumFrames();
    }
    
    inline int getNumChannels() const throw()
    {
        return this->getInternal()->getNumChannels();
    }
    
    inline int getFrameStride() const throw()
    {
        return this->getInternal()->getFrameStride();
    }
    
    SampleType* getSamples (const int channel) throw()
    {
        return this->getInternal()->getSamples (channel);
    }
    
    const SampleType* getSamples (const int channel) const throw()
    {
        return this->getInternal()->getSamples (channel);
    }
    
    inline bool isInterleaved() const throw()
    {
        return this->getInternal()->isInterleaved();
    }

    inline Buffer getInterleaved() const throw()
    {
        return this->getInternal()->getInterleaved();
    }
    
    inline Buffers getDeinterleaved() const throw()
    {
        return this->getInternal()->getDeinterleaved();
    }
    
    inline SampleVariableArray& getSampleVariables() throw()
    {
        return this->getInternal()->sampleVariables;
    }

    inline const SampleVariableArray& getSampleVariables() const throw()
    {
        return this->getInternal()->sampleVariables;
    }

    inline IntVariableArray& getIntVariables() throw()
    {
        return this->getInternal()->intVariables;
    }
    
    inline const IntVariableArray& getIntVariables() const throw()
    {
        return this->getInternal()->intVariables;
    }


    PLONK_OBJECTARROWOPERATOR(SignalBase);

};



#endif // PLONK_SIGNAL_H