Merge branch 'master' into windows+cc
[ardour.git] / libs / surfaces / mackie / controls.h
index 1092c40453de6e7aba90264609cdf470aefc4a68..38dad7ef7fa31297fd5d9c54661b30d95601df7c 100644 (file)
@@ -1,5 +1,6 @@
 /*
        Copyright (C) 2006,2007 John Anderson
+       Copyright (C) 2012 Paul Davis
 
        This program is free software; you can redistribute it and/or modify
        it under the terms of the GNU General Public License as published by
        along with this program; if not, write to the Free Software
        Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
-#ifndef mackie_controls_h
-#define mackie_controls_h
+
+#ifndef __mackie_controls_h__
+#define __mackie_controls_h__
 
 #include <map>
 #include <vector>
 #include <string>
+#include <stdint.h>
 
-#include "mackie_control_exception.h"
-
-namespace Mackie
-{
-
-class Control;
+#include <boost/smart_ptr.hpp>
 
-/**
-       This is a loose group of controls, eg cursor buttons,
-       transport buttons, functions buttons etc.
-*/
-class Group
-{
-public:
-       Group( const std::string & name )
-       : _name( name )
-       {
-       }
-       
-       virtual ~Group() {}
-       
-       virtual bool is_strip() const
-       {
-               return false;
-       }
-       
-       virtual bool is_master() const
-       {
-               return false;
-       }
-       
-       virtual void add( Control & control );
-       
-       const std::string & name() const
-       {
-               return _name;
-       }
-       
-       // This is for Surface only
-       void name( const std::string & rhs ) { _name = rhs; }
-       
-       typedef std::vector<Control*> Controls;
-       const Controls & controls() const { return _controls; }
-       
-protected:
-       Controls _controls;
-       
-private:
-       std::string _name;
-};
+#include "pbd/signals.h"
 
-class Button;
-class Pot;
-class Fader;
+#include "mackie_control_exception.h"
+#include "midi_byte_array.h"
 
-/**
-       This is the set of controls that make up a strip.
-*/
-class Strip : public Group
-{
-public:
-       Strip( const std::string & name, int index );
-       
-       virtual bool is_strip() const
-       {
-               return true;
-       }
-       
-       virtual void add( Control & control );
-       
-       /// This is the index of the strip
-       int index() const { return _index; }
-       
-       /// This is for Surface only
-       void index( int rhs ) { _index = rhs; }
-       
-       Button & solo();
-       Button & recenable();
-       Button & mute();
-       Button & select();
-       Button & vselect();
-       Button & fader_touch();
-       Pot & vpot();
-       Fader & gain();
-       
-       bool has_solo() { return _solo != 0; }
-       bool has_recenable() { return _recenable != 0; }
-       bool has_mute() { return _mute != 0; }
-       bool has_select() { return _select != 0; }
-       bool has_vselect() { return _vselect != 0; }
-       bool has_fader_touch() { return _fader_touch != 0; }
-       bool has_vpot() { return _vpot != 0; }
-       bool has_gain() { return _gain != 0; }
-       
-private:
-       Button * _solo;
-       Button * _recenable;
-       Button * _mute;
-       Button * _select;
-       Button * _vselect;
-       Button * _fader_touch;
-       Pot * _vpot;
-       Fader * _gain;
-       int _index;
-};
+namespace ARDOUR {
+       class AutomationControl;
+}
 
-class MasterStrip : public Strip
+namespace Mackie
 {
-public:
-       MasterStrip( const std::string & name, int index )
-       : Strip( name, index )
-       {
-       }
-       
-       virtual bool is_master() const
-       {
-               return true;
-       }
-};
 
-class Led;
+class Strip;
+class Group;
+class Surface;
 
-/**
-       The base class for controls on the surface. They deliberately
-       don't know the midi protocol for updating them.
-*/
 class Control
 {
 public:
-       enum type_t { type_fader, type_button, type_pot, type_led, type_led_ring };
-       
-       Control( int id, int ordinal, std::string name, Group & group )
-       : _id( id ), _ordinal( ordinal ), _name( name ), _group( group )
-       {
-       }
-       
+       Control (int id, std::string name, Group& group);
        virtual ~Control() {}
        
-       virtual const Led & led() const
-       {
-               throw MackieControlException( "no led available" );
-       }
+       int id() const { return _id; }
+       const std::string & name() const  { return _name; }
+       Group & group() const { return _group; }
 
-       /// The midi id of the control
-       int id() const
-       {
-               return _id;
-       }
-       
-       /// The 1-based number of the control
-       int ordinal() const
-       {
-               return _ordinal;
-       }
-       
-       const std::string & name() const
-       {
-               return _name;
-       }
-       
-       const Group & group() const
-       {
-               return _group;
-       }
+       bool in_use () const;
+       void set_in_use (bool);
        
-       const Strip & strip() const
-       {
-               return dynamic_cast<const Strip&>( _group );
-       }
-       
-       Strip & strip()
-       {
-               return dynamic_cast<Strip&>( _group );
-       }
-       
-       virtual bool accepts_feedback() const
-       {
-               return true;
-       }
-       
-       virtual type_t type() const = 0;
-       
-private:
-       int _id;
-       int _ordinal;
-       std::string _name;
-       Group & _group;
-};
+       /// Keep track of the timeout so it can be updated with more incoming events
+       sigc::connection in_use_connection;
 
-std::ostream & operator << ( std::ostream & os, const Control & control );
+       virtual MidiByteArray zero() = 0;
 
-class Fader : public Control
-{
-public:
-       Fader( int id, int ordinal, std::string name, Group & group )
-       : Control( id, ordinal, name, group )
-       , _touch( false )
-       {
-       }
-       
-       bool touch() const { return _touch; }
-       
-       void touch( bool yn ) { _touch = yn; }
+       /** If we are doing an in_use timeout for a fader without touch, this
+        *  is its touch button control; otherwise 0.
+        */
+       Control* in_use_touch_control;
 
-       virtual type_t type() const { return type_fader; }
+       boost::shared_ptr<ARDOUR::AutomationControl> control () const { return normal_ac; }
+       virtual void set_control (boost::shared_ptr<ARDOUR::AutomationControl>);
 
-private:
-       bool _touch;
-};
-
-class Led : public Control
-{
-public:
-       Led( int id, int ordinal, std::string name, Group & group )
-       : Control( id, ordinal, name, group )
-       {
-       }
+       float get_value ();
+       void set_value (float val);
        
-       virtual const Led & led() const { return *this; }
+       virtual void start_touch (double when);
+       virtual void stop_touch (double when, bool mark);
 
-       virtual type_t type() const { return type_led; }
-};
-
-class Button : public Control
-{
-public:
-       Button( int id, int ordinal, std::string name, Group & group )
-       : Control( id, ordinal, name, group )
-       , _led( id, ordinal, name + "_led", group )
-       {
-       }
-       
-       virtual const Led & led() const
-       {
-               return _led;
-       }
-       
-       virtual type_t type() const { return type_button; };
-
-private:
-       Led _led;
-};
-
-class LedRing : public Led
-{
-public:
-       LedRing( int id, int ordinal, std::string name, Group & group )
-       : Led( id, ordinal, name, group )
-       {
-       }
+  protected:
+       boost::shared_ptr<ARDOUR::AutomationControl> normal_ac;
 
-       virtual type_t type() const { return type_led_ring; }
+  private:
+       int _id; /* possibly device-dependent ID */
+       std::string _name;
+       Group& _group;
+       bool _in_use;
 };
 
-class Pot : public Control
-{
-public:
-       Pot( int id, int ordinal, std::string name, Group & group )
-       : Control( id, ordinal, name, group )
-       , _led_ring( id, ordinal, name + "_ring", group )
-       {
-       }
-
-       virtual type_t type() const { return type_pot; }
-
-       virtual const LedRing & led_ring() const
-       {
-               return _led_ring;
-       }
-
-private:
-       LedRing _led_ring;
-};
+std::ostream & operator <<  (std::ostream & os, const Control & control);
 
 }
 
-#endif
+#endif /* __mackie_controls_h__ */