plonk_Channel.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_CHANNEL_H
#define PLONK_CHANNEL_H

#include "../plonk_GraphForwardDeclarations.h"
#include "../../containers/plonk_DynamicContainer.h"
#include "../../containers/variables/plonk_Variable.h"
#include "../../core/plonk_SmartPointer.h"
#include "../../core/plonk_WeakPointer.h"
#include "../../core/plonk_SmartPointerContainer.h"
#include "../utility/plonk_ProcessInfo.h"
#include "../utility/plonk_BlockSize.h"
#include "../utility/plonk_SampleRate.h"
#include "../utility/plonk_TimeStamp.h"
#include "../utility/plonk_InputDictionary.h"

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

template<class SampleType>
class ChannelBase : public SmartPointerContainer< ChannelInternalBase<SampleType> >
{
protected:
    typedef PLONK_UNITBASETYPE<ChannelBase>             UnitType;

public:
    typedef ChannelInternalBase<SampleType>             Internal;
    typedef SmartPointerContainer<Internal>             Base;
    typedef WeakPointerContainer<ChannelBase>           Weak;
    typedef NumericalArray<SampleType>                  Buffer;
    typedef InputDictionary                             Inputs;
    typedef Variable<SampleType>                        VariableType;
    typedef ReceiverInternal<ChannelBase>               Receiver;


    ChannelBase() throw() 
    :   Base (ChannelBase::getNull().getInternal())
    { 
    }
    
    ChannelBase (Internal *internal) throw()
    :   Base (internal)
    {
    }
    
    ChannelBase (UnitType const& unit) throw()
    :   Base (static_cast<Base const&> (unit.atUnchecked (0)))
    {
        plonk_assert (unit.getNumChannels() == 1);
    }
    
    ChannelBase (UnitBase<SampleType> const& unit) throw()
    :   Base (static_cast<Base const&> (unit.atUnchecked (0)))
    {
        plonk_assert (unit.getNumChannels() == 1);
    }

    
    ChannelBase (ChannelBase const& copy) throw()
    :   Base (static_cast<Base const&> (copy))
    {
    }
    
    ChannelBase& operator= (ChannelBase const& other) throw()
        {
                if (this != &other)
            this->setInternal (other.getInternal());//this->setInternal (other.containerCopy().getInternal());
        
        return *this;
        }
    
//    ChannelBase (Dynamic const& other) throw()
//    :   Base (static_cast<Internal*> (other.getItem().getInternal()))
//    {
//        if (this->getInternal() == 0)
//            operator= (ChannelBase());
//        else
//            plonk_assert (other.getTypeCode() == TypeUtility<ChannelBase>::getTypeCode());
//    }            
        
    static ChannelBase fromWeak (Weak const& weak) throw()
    {
        return weak.fromWeak();
    }            
        
    static const ChannelBase& getNull() throw()
        {
                static ChannelBase null (static_cast<Internal*> (new NullChannelInternal<SampleType>()));
                return null;
        }                               
    
    template<class ValueType>
    ChannelBase (ValueType const& valueInit) throw()
    :   Base (new ConstantChannelInternal<SampleType> (valueInit))
    {
    }
        
    inline bool isNull() const throw()                                      { return this->getInternal()->isNull(); }
    inline bool isNotNull() const throw()                                   { return ! this->getInternal()->isNull(); }  
    inline bool isConstant() const throw()                                  { return this->getInternal()->isConstant(); }
    inline bool isNotConstant() const throw()                               { return ! this->getInternal()->isConstant(); }    
    inline bool isTypeConverter() const throw()                             { return this->getInternal()->isTypeConverter(); }

    inline const Text getName() const throw()                               { return this->getInternal()->getName(); }
    inline const Text getLabel() const throw()                              { return this->getInternal()->getLabel(); }
    inline void setLabel(Text const& newId) throw()                         { this->getInternal()->setLabel(newId); }   
    inline const Text getOutputTypeName() const throw()                     { return this->getInternal()->getOutputTypeName(); }
    inline const Text getInputTypeName() const throw()                      { return this->getInternal()->getInputTypeName(); }
    inline int getOutputTypeCode() const throw()                            { return this->getInternal()->getOutputTypeCode(); }
    inline int getInputTypeCode() const throw()                             { return this->getInternal()->getInputTypeCode(); }

    inline const BlockSize& getBlockSize() const throw()                    { return this->getInternal()->getBlockSize(); }
    inline BlockSize& getBlockSize() throw()                                { return this->getInternal()->getBlockSize(); }
    inline void setBlockSize (BlockSize const& newBlockSize) throw()        { this->getInternal()->setBlockSize (newBlockSize); }

    inline const SampleRate& getSampleRate() const throw()                  { return this->getInternal()->getSampleRate(); }
    inline SampleRate& getSampleRate() throw()                              { return this->getInternal()->getSampleRate(); }
    inline void setSampleRate (SampleRate const& newSampleRate) throw()     { this->getInternal()->setSampleRate (newSampleRate); }
    inline double getSampleDurationInTicks() const throw()                  { return this->getInternal()->getSampleDurationInTicks(); }
    inline double getBlockDurationInTicks() const throw()                   { return this->getInternal()->getBlockDurationInTicks(); }
    
    inline const DoubleVariable& getOverlap() const throw()                 { return this->getInternal()->getOverlap(); }
    inline DoubleVariable& getOverlap() throw()                             { return this->getInternal()->getOverlap(); }
    inline void setOverlap (DoubleVariable const& newOverlap) throw()       { this->getInternal()->setOverlap (newOverlap); }
    
    inline const Inputs& getInputs() const throw()                          { return this->getInternal()->getInputs(); }
    inline Inputs getInputs() throw()                                       { return this->getInternal()->getInputs(); }
    
    inline const Buffer& getOutputBuffer() const throw()                    { return this->getInternal()->getOutputBuffer(); }
    inline Buffer& getOutputBuffer() throw()                                { return this->getInternal()->getOutputBuffer(); }
    inline const SampleType* getOutputSamples() const throw()               { return this->getInternal()->getOutputSamples(); }
    inline SampleType* getOutputSamples() throw()                           { return this->getInternal()->getOutputSamples(); }
    inline void setOutputBuffer (Buffer const& externalBuffer) throw()      { this->getInternal()->setOutputBuffer (externalBuffer); }
    
    inline int getNumChannels() const throw()                               { return this->getInternal()->getNumChannels(); }
    
    inline void initValue (SampleType const& value) throw()                 { return this->getInternal()->initValue (value); }
    inline void initChannel (const int index) throw()                       { this->getInternal()->initChannel (index); }
    inline const SampleType& getValue() const throw()                       { return this->getInternal()->getValue(); }
    
    inline ChannelBase getChannel (const int index) throw()                 { return ChannelBase (this->getInternal()->getChannel (index)); }
    inline ChannelBase operator[] (const int index) throw()                 { return ChannelBase (this->getInternal()->getChannel (index)); }

    inline const TimeStamp& getNextTimeStamp() const throw()                { return this->getInternal()->getNextTimeStamp(); }
    inline bool shouldBeDeletedNow (TimeStamp const& time) const throw()    { return this->getInternal()->shouldBeDeletedNow (time); }
    
    inline void resetIfExpired() throw()                                    { this->getInternal()->setExpiryTimeStamp (TimeStamp::getMaximum()); }
    
//    /** Returns @c true if this unit needs to process for the given timestamp. */
//    inline bool needsToProcess (ProcessInfo const& info, const int channel) const throw()
//    {
//              (void)channel;
//
//        const TimeStamp& nextTimeStamp = this->getInternal()->getNextTimeStamp();
//        const TimeStamp& infoTimeStamp = info.getTimeStamp();
//
//        return (infoTimeStamp >= nextTimeStamp);
//    }

    inline bool needsToProcess (ProcessInfo const& info) const throw()
    {
        const TimeStamp& nextTimeStamp = this->getInternal()->getNextTimeStamp();
        const TimeStamp& infoTimeStamp = info.getTimeStamp();
        
        return (infoTimeStamp >= nextTimeStamp);
    }

    inline void process (ProcessInfo& info, const int channel) throw()
    {        
        if (this->needsToProcess (info))
        {
            this->getInternal()->process (info, channel);
            this->getInternal()->setLastTimeStamp (info.getTimeStamp());
            this->getInternal()->updateTimeStamp();
            
            if (info.getShouldDelete() == true)
                this->getInternal()->setExpiryTimeStamp (this->getInternal()->getNextTimeStamp());
        }
    }
    
    int getTypeCode() const throw()
    {
        return TypeUtility<ChannelBase>::getTypeCode();
    }
    
    int getSampleTypeCode() const throw()
    {
        return TypeUtility<SampleType>::getTypeCode();
    }        
    
};



#endif // PLONK_CHANNEL_H