libs/surfaces/mackie/controls.h

   1 /*
   2         Copyright (C) 2006,2007 John Anderson
   3         Copyright (C) 2012 Paul Davis
   4
   5         This program is free software; you can redistribute it and/or modify
   6         it under the terms of the GNU General Public License as published by
   7         the Free Software Foundation; either version 2 of the License, or
   8         (at your option) any later version.
   9
  10         This program is distributed in the hope that it will be useful,
  11         but WITHOUT ANY WARRANTY; without even the implied warranty of
  12         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13         GNU General Public License for more details.
  14
  15         You should have received a copy of the GNU General Public License
  16         along with this program; if not, write to the Free Software
  17         Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #ifndef __mackie_controls_h__
  21 #define __mackie_controls_h__
  22
  23 #include <map>
  24 #include <vector>
  25 #include <string>
  26 #include <stdint.h>
  27
  28 #include "pbd/signals.h"
  29
  30 #include "mackie_control_exception.h"
  31 #include "midi_byte_array.h"
  32
  33 namespace Mackie
  34 {
  35
  36 class Strip;
  37 class Group;
  38 class Surface;
  39
  40 class Control
  41 {
  42 public:
  43         enum base_id_t {
  44                 pot_base_id = 0x30,
  45                 jog_base_id = 0x3c,
  46                 fader_touch_button_base_id = 0xe0,
  47                 vselect_button_base_id = 0x20,
  48                 select_button_base_id = 0x18,
  49                 mute_button_base_id = 0x10,
  50                 solo_button_base_id = 0x08,
  51                 recenable_button_base_id = 0x0,
  52                 meter_base_id = 0xd0,
  53         };
  54
  55         Control (int id, std::string name, Group& group);
  56         virtual ~Control() {}
  57
  58         /// the value of the second bytes of the message. It's
  59         /// the id of the control, but only guaranteed to be
  60         /// unique within the control type.
  61         int raw_id() const { return _id; }
  62
  63         const std::string & name() const  { return _name; }
  64         Group & group() const { return _group; }
  65
  66         virtual bool accepts_feedback() const  { return true; }
  67
  68         bool in_use () const;
  69         void set_in_use (bool);
  70
  71         /// Keep track of the timeout so it can be updated with more incoming events
  72         sigc::connection in_use_connection;
  73
  74         virtual MidiByteArray zero() = 0;
  75
  76         /** If we are doing an in_use timeout for a fader without touch, this
  77          *  is its touch button control; otherwise 0.
  78          */
  79         Control* in_use_touch_control;
  80
  81 private:
  82         int _id;
  83         std::string _name;
  84         Group& _group;
  85         bool _in_use;
  86 };
  87
  88 std::ostream & operator <<  (std::ostream & os, const Control & control);
  89
  90 }
  91
  92 #endif /* __mackie_controls_h__ */