---

/root/src/subsynth/syn/Core/Module.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: Module.h,v $
 * Date modified: $Date: 2002/04/15 07:28:45 $
 * Version:       $Revision: 1.36 $
 * -----------------------------------------------------------------
 *
 ****************** <SYN heading END do not edit this line> ******************/

#ifndef SUBSYNTH_SIGNAL_MODULE_H
#define SUBSYNTH_SIGNAL_MODULE_H

#include <string>
#include <map>

#include "syn/Util/AudioFormat.h"
#include "syn/Util/MultivariateType.h"
#include "syn/Core/SampleBufferQueuePtr.h"
#include "syn/Core/Terminal.h"
#include "syn/Core/SampleBufferQueue.h"
#include "syn/Core/SampleBuffer.h"

#include "syn/Core/ModulePtr.h" // my ptr...

namespace syn
{
   class Module
   {
   public:
       Module (): mName( "Unconfigured Module" ), mPutCount( 0 )
       {
//           mPreferredLOD = getMinimumLOD();
//           mScheduledLOD = mPreferredLOD;
       }

      virtual ~Module() {}

      virtual void update() = 0;
   
      virtual bool open() = 0;
      virtual void close() = 0;

      /* unique instance name */
      virtual void setInstanceName( const std::string& name )
      {
         mName = name;
      }

      virtual std::string getInstanceName() const
      {
          return mName;
      }

      virtual Module* clone() const = 0;

      virtual unsigned int pcount() const { return mPutCount; }

       //virtual LOD getMinimumLOD() 
       //{
       //    return LOD_LOW;
       //}

       //void setPreferredLOD( LOD lod ) 
       //{
       //    assert( ((int)lod >= 0) && ((int)lod < NUM_LODS) );
       //    if ((lod != LOD_DEFAULT) && (lod > getMinimumLOD()))
       //    {
       //        mPreferredLOD = lod;
       //    }
       //}

       //LOD getPreferredLOD() 
       //{
       //    return mPreferredLOD;
       //}

       //void setScheduledLOD( LOD lod ) 
       //{
       //    assert( ((int)lod >= 0) && ((int)lod < NUM_LODS) );
       //    if (lod == LOD_DEFAULT)
       //    {
       //        mScheduledLOD = mPreferredLOD;
       //    }
       //   else
       //    {
       //       mScheduledLOD = lod;
       //    }
       //}

       //LOD getScheduledLOD() 
       //{
       //    return mScheduledLOD;
       //}

      bool isTerminator() { return (mOutputTerminals.size() == 0); }

      bool isInitiator() { return (mInputTerminals.size() == 0); }
             
      
      virtual void getParam( const std::string& key, MultivariateType& value ) = 0;

      virtual void setParam( const std::string& key, const MultivariateType& value ) = 0;

      bool getOutput( const std::string& name, TerminalPtr& output )
      {
         if (mOutputTerminals.count( name ) != 0)
         {
            output = mOutputTerminals[name];
            return true;
         }
         else
         {
            // return something safe...
            this->createOutput( name );
            output = mOutputTerminals[name];
            return true;
         }
      }

      bool getInput( const std::string& name, TerminalPtr& input )
      {
         if (mInputTerminals.count( name ) != 0)
         {
            input = mInputTerminals[name];
            return true;
         }
         else
         {
            // return something safe...
            this->createInput( name );
            input = mInputTerminals[name];
            return true;
         }
      }
       
      std::map<std::string, TerminalPtr>& outputs() { return mOutputTerminals; }
      std::map<std::string, TerminalPtr>& inputs() { return mInputTerminals; }

      TerminalPtr  createOutput( const std::string& name );

      TerminalPtr  createInput( const std::string& name );
     
      void removeOutput( const std::string& name );

      void inputsRemove( const std::string& name );

      
   protected:
      void setPutCount( int p )
      {
         mPutCount = p;
      }
   protected:
      std::map<std::string, TerminalPtr>  mOutputTerminals;
      std::map<std::string, TerminalPtr>  mInputTerminals;
      std::map<std::string, MultivariateType>  mParams;
      std::string mName;
      unsigned int mPutCount;

       //LOD mPreferredLOD;
       //LOD mScheduledLOD;

      /*#  InputTerminal lnkInputTerminal; */

      /*#  OutputTerminal lnkOutputTerminal; */
   };
   
   inline TerminalPtr Module::createOutput( const std::string& name )
   {
      TerminalPtr term = TerminalPtr( new Terminal( *this, name ) );
      term->setName( name );
      mOutputTerminals[name] = term;
      return term;
   }      

   inline TerminalPtr Module::createInput( const std::string& name )
   {
      TerminalPtr term = TerminalPtr( new Terminal( *this, name ) );
      term->setName( name );
      mInputTerminals[name] = term;
      return term;
   }

   inline void Module::removeOutput( const std::string& name )
   {
      mOutputTerminals.erase( name );
   }

   inline void Module::inputsRemove( const std::string& name )
   {
      mInputTerminals.erase( name );
   }
}

#endif //SUBSYNTH_SIGNAL_MODULE_H

---