include/Controller.h

   1 /*
   2  * Controller.h - declaration of class controller, which provides a
   3  *                standard for all controllers and controller plugins
   4  *
   5  * Copyright (c) 2008-2009 Paul Giblock <pgllama/at/gmail.com>
   6  *
   7  * This file is part of Linux MultiMedia Studio - http://lmms.sourceforge.net
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public
  20  * License along with this program (see COPYING); if not, write to the
  21  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  22  * Boston, MA 02110-1301 USA.
  23  *
  24  */
  25
  26 #ifndef _CONTROLLER_H
  27 #define _CONTROLLER_H
  28
  29 #include "engine.h"
  30 #include "Mixer.h"
  31 #include "Model.h"
  32 //#include "AudioOutputContext.h"
  33 #include "JournallingObject.h"
  34
  35 class ControllerDialog;
  36 class Controller;
  37
  38 typedef QVector<Controller *> ControllerVector;
  39
  40
  41 class Controller : public Model, public JournallingObject
  42 {
  43         Q_OBJECT
  44 public:
  45         enum ControllerTypes
  46         {
  47                 DummyController,
  48                 LfoController,
  49                 MidiController,
  50                 PeakController,
  51                 /*
  52                 XYController,
  53                 EquationController
  54                 */
  55                 NumControllerTypes
  56         } ;
  57
  58         Controller( ControllerTypes _type, Model * _parent,
  59                                                 const QString & _display_name );
  60
  61         virtual ~Controller();
  62
  63         virtual float currentValue( int _offset );
  64
  65         inline bool isSampleExact() const
  66         {
  67                 return m_sampleExact /*||
  68                         engine::mixer()->audioOutputContext()->
  69                                 qualitySettings().sampleExactControllers()*/;
  70         }
  71
  72         void setSampleExact( bool _exact )
  73         {
  74                 m_sampleExact = _exact;
  75         }
  76
  77         inline ControllerTypes type() const
  78         {
  79                 return m_type;
  80         }
  81
  82         // return whether this controller updates models frequently - used for
  83         // determining when to update GUI
  84         inline bool frequentUpdates() const
  85         {
  86                 switch( m_type )
  87                 {
  88                         case LfoController: return true;
  89                         case PeakController: return true;
  90                         default:
  91                                 break;
  92                 }
  93                 return false;
  94         }
  95
  96         virtual const QString & name() const
  97         {
  98                 return m_name;
  99         }
 100
 101
 102         virtual void saveSettings( QDomDocument & _doc, QDomElement & _this );
 103         virtual void loadSettings( const QDomElement & _this );
 104         virtual QString nodeName() const;
 105
 106         static Controller * create( ControllerTypes _tt, Model * _parent );
 107         static Controller * create( const QDomElement & _this,
 108                                                         Model * _parent );
 109
 110         inline static float fittedValue( float _val )
 111         {
 112                 return tLimit<float>( _val, 0.0f, 1.0f );
 113         }
 114
 115         static unsigned int runningFrames();
 116         static float runningTime();
 117
 118         static void triggerFrameCounter();
 119         static void resetFrameCounter();
 120
 121
 122 public slots:
 123         virtual ControllerDialog * createDialog( QWidget * _parent );
 124
 125         virtual void setName( const QString & _new_name )
 126         {
 127                 m_name = _new_name;
 128         }
 129
 130         bool hasModel( const Model * m );
 131
 132
 133 protected:
 134         // The internal per-controller get-value function
 135         virtual float value( int _offset );
 136
 137         float m_currentValue;
 138         bool  m_sampleExact;
 139
 140         QString m_name;
 141         ControllerTypes m_type;
 142
 143         static ControllerVector s_controllers;
 144
 145         static unsigned int s_frames;
 146
 147
 148 signals:
 149         // The value changed while the mixer isn't running (i.e: MIDI CC)
 150         void valueChanged();
 151
 152         friend class ControllerDialog;
 153
 154 } ;
 155
 156 #endif
 157