---

/root/src/subsynth/syn/Module/OscModule.h

Go to the documentation of this file.

/****************** <SYN heading BEGIN do not edit this line> *****************
 *
 * subsynth - modular audio synthesizer
 * subsynth is (C) Copyright 2001-2002 by Kevin Meinert
 *
 * Original Author: Kevin Meinert
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile: OscModule.h,v $
 * Date modified: $Date: 2002/04/15 07:28:46 $
 * Version:       $Revision: 1.13 $
 * -----------------------------------------------------------------
 *
 ****************** <SYN heading END do not edit this line> ******************/

#ifndef SUBSYNTH_OSC_MODULE_H
#define SUBSYNTH_OSC_MODULE_H

#include <map>
#include "syn/Util/Generator.h" // for some predefined OSCs
#include "syn/Core/SampleBuffer.h"
#include "syn/Core/SampleBufferQueue.h"
#include "syn/Core/Module.h"
#include "syn/Core/Terminal.h"

namespace syn
{
   class OscModuleBase : public Module
   {
   public:
      OscModuleBase() : Module() {}
   
      virtual ~OscModuleBase()
      {
      }
      
      virtual void setFreq( float freq ) = 0;

      virtual void setFreqControl( float param ) = 0;
      
      virtual void setFreqControlSensitivity( float octaves = 1.0f ) = 0;
      
      virtual float freq() const = 0;
      virtual float freqControl() const = 0;
      virtual float freqControlSensitivity() const = 0;
      
      virtual void getParam( const std::string& key, MultivariateType& value )
      {
         if (key == "freq")
            value.setValue<float>( this->freq() );
         else if (key == "freqcontrol")
            value.setValue<float>( this->freqControl() );
         else if (key == "freqcontrolsens")
            value.setValue<float>( this->freqControlSensitivity() );
      }

      virtual void setParam( const std::string& key, const MultivariateType& value )
      {
         if (key == "freq")
            this->setFreq( value.getValue<float>() );
         else if (key == "freqcontrol")
            this->setFreqControl( value.getValue<float>() );
         else if (key == "freqcontrolsens")
            this->setFreqControl( value.getValue<float>() );
      }
   };
   
   template <typename OSC_TYPE>
   class OscModule : public OscModuleBase
   {
   public:
      OscModule(): OscModuleBase(), 
         mWriteBuf( NULL ), 
         mReadBuf( NULL ),
         mFreq( 440.0f ), 
         mFreqControl( 0.0f ), 
         mFreqControlSens( 1.0f ),
         mSkipFreqInputs( 0 )
      {
         mFreqControlInput = this->createInput( "freq" );
         mMonoAudioOutput = this->createOutput( "mono audio" );
      }
   
      virtual ~OscModule()
      {
      }

      virtual Module* clone() const
      {
         OscModule<OSC_TYPE>* mod = new OscModule<OSC_TYPE>;
         mod->setFreq( this->freq() );
         mod->setFreqControl( this->freqControl() );
         mod->setFreqControlSensitivity( this->freqControlSensitivity() );
         return mod;
      }

      virtual float freq() const { return mFreq; }
      virtual float freqControl() const { return mFreqControl; }
      virtual float freqControlSensitivity() const { return mFreqControlSens; }

      virtual void update()
      {  
         // wait for input if it isn't here yet.
         // if we need to wait, but it is empty - or
         // if the output is already too full...
         if ((!mFreqControlInput->done() && mFreqControlInput->empty()) || mMonoAudioOutput->high())
         {
            mMonoAudioOutput->setDone( false );
            return;
         }
         
         // CASE: Freq input terminal is connected
         if (!mFreqControlInput->done())
         {
            if (mReadBuf == NULL)
            {
               mReadBuf = mFreqControlInput->front();
               mFreqControlInput->pop();
               mReadBufIt = 0;
            }

            if (mWriteBuf == NULL)
            {
               SampleBufferRepos::instance()->take( mWriteBuf );
               mWriteBufIt = 0;
            }

            // combine...
            while (mReadBufIt < mReadBuf->size() && mWriteBufIt < mWriteBuf->size())
            {
               // recompute the freq from the input every 10
               mSkipFreqInputs = (mSkipFreqInputs + 1) % 10;
               if (mSkipFreqInputs == 0)
               {
                  mFreqControl = (*(mReadBuf))[mReadBufIt];
                  float freq = Math::fast_exp2( mFreqControl * mFreqControlSens ) * mFreq;
                  mOsc.setFreq( freq );
               }
               (*mWriteBuf)[mWriteBufIt] = mOsc.generate();
               ++mReadBufIt;
               ++mWriteBufIt;
            }

            // if buffer has been emptied, then put it back so we can get a new one next.
            if (mReadBufIt >= mReadBuf->size())
            {
               SampleBufferRepos::instance()->putback( mReadBuf );
               mReadBufIt = 0;
               mReadBuf = NULL;
            }

            // if buffer has been filled, then send it
            if (mWriteBufIt >= mWriteBuf->size())
            {
               mMonoAudioOutput->push( mWriteBuf );
               mMonoAudioOutput->setDone( false );
               this->setPutCount( mWriteBuf->size() );
               mWriteBuf = NULL;
               mWriteBufIt = 0;
            }
         }

         // CASE: not connected, use constant instead
         else
         {
            // compute exponential base2 controlled frequency
            // from the specified control params
            float freq = Math::fast_exp2( mFreqControl * mFreqControlSens ) * mFreq;
            mOsc.setFreq( freq );

            this->setPutCount( 0 );

            SampleBufferRepos::instance()->take( mWriteBuf );

            // fill the buffer values from the osc.
            for (unsigned int x = 0; x < mWriteBuf->size(); ++x)
            {
               (*mWriteBuf)[x] = mOsc.generate();
            }

            this->setPutCount( mWriteBuf->size() );
            mMonoAudioOutput->push( mWriteBuf );
            mWriteBuf = NULL;
            mMonoAudioOutput->setDone( false ); // never done...
         }
      }

      virtual bool open()
      {
         // configure the output terminals
         mMonoAudioOutput->setHighMark( 2 );
         mMonoAudioOutput->setLowMark( 1 );

         return true;
      }

      virtual bool isOpen() { return true; }
      
      virtual void close()
      {
      }

      virtual void setFreq( float freq )
      {
         mFreq = freq;
      } 

      virtual void setFreqControl( float param )
      {
         mFreqControl = param;
      }    
      
      virtual void setFreqControlSensitivity( float octaves = 1.0f )
      {
         mFreqControlSens = octaves;
      } 
      
      OSC_TYPE& osc() { return mOsc; }

   private:
      TerminalPtr mFreqControlInput;
      TerminalPtr mMonoAudioOutput;

      SampleBuffer1f* mWriteBuf, *mReadBuf;
      float mFreq, mFreqControl, mFreqControlSens;

      OSC_TYPE mOsc;
      unsigned int mSkipFreqInputs, mWriteBufIt, mReadBufIt;
            
      /*#  Terminal lnkTerminal; */

      /*#  Terminal lnkTerminal; */
   };

   typedef OscModule<TriangleOsc> TriangleOscModule;
   
   typedef OscModule<WhiteNoiseOsc> WhiteNoiseOscModule;
   
   typedef OscModule<PinkNoiseOsc> PinkNoiseOscModule;
   
   typedef OscModule<SineOsc> SineOscModule;
   
   typedef OscModule<SquareOsc> SquareOscModule;
   
   typedef OscModule<AdsrEnvOsc> AdsrOscModule;
}
#endif

---