• Site en Français
• English Site
• Doc

MModule.h

/*

    This file is part of la Marmite.
    Copyright (C) 2005 Nicolas Falquet.

    La Marmite 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.

    La Marmite 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 la Marmite ; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
    02111-1307  USA

*/

#ifndef M_MODULE_H
#define M_MODULE_H

using namespace std;

#include <qobject.h>
#include <string>

class MPort;
#include "MAudioInputPort.h"
#include "MAudioOutputPort.h"
#include "MControlInputPort.h"
#include "MControlOutputPort.h"

class MModule /* abstract */ : public QObject
{

  Q_OBJECT

public :

  // destructor

  virtual ~ MModule ( ) { }

  // functions

  virtual string Name ( ) const;

  virtual bool IsActive ( ) const;

  virtual MAudioInputPort * ModuleAudioInput ( const unsigned int n ) const = 0;

  virtual MAudioOutputPort * ModuleAudioOutput ( const unsigned int n ) const = 0;

  virtual MControlInputPort * ModuleControlInput ( const unsigned int n ) const = 0;

  virtual MControlOutputPort * ModuleControlOutput ( const unsigned int n ) const = 0;

  virtual unsigned int NumberOfAudioInputs ( ) const = 0;

  virtual unsigned int NumberOfAudioOutputs ( ) const = 0;

  virtual unsigned int NumberOfControlInputs ( ) const = 0;

  virtual unsigned int NumberOfControlOutputs ( ) const = 0;

  virtual MPort * GetPortByName ( const string & name ) const;

  virtual bool IsMine ( MPort * port ) const;

public slots :

  // methods

  virtual void Activate ( ) = 0;

  virtual void Deactivate ( ) = 0;

  virtual void Run ( const unsigned int n ) = 0;

protected :

  // attributes

  string _name;

  bool _active;

  // protected constructor

  MModule ( const string & name = "module", QObject * parent = 0 )
    : QObject ( parent ), _name ( name ), _active ( false )
  {
    setName ( _name.c_str ( ) );
  }

};

#endif // M_MODULE_H

---