libs/surfaces/mackie/button.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 __ardour_mackie_control_protocol_button_h__
  21 #define __ardour_mackie_control_protocol_button_h__
  22
  23 #include "controls.h"
  24 #include "led.h"
  25
  26 namespace ArdourSurface {
  27
  28 namespace Mackie {
  29
  30 class Surface;
  31
  32 class Button : public Control
  33 {
  34 public:
  35 /* These values uniquely identify each possible button that an MCP device may
  36    send. Each DeviceInfo object contains its own set of button definitions that
  37    define what device ID will be sent for each button, and there is no reason
  38    for them to be the same.  */
  39
  40         enum ID {
  41                 /* Global Buttons */
  42
  43                 Track,
  44                 Send,
  45                 Pan,
  46                 Plugin,
  47                 Eq,
  48                 Dyn,
  49                 Left,
  50                 Right,
  51                 ChannelLeft,
  52                 ChannelRight,
  53                 Flip,
  54                 View,
  55                 NameValue,
  56                 TimecodeBeats,
  57                 F1,
  58                 F2,
  59                 F3,
  60                 F4,
  61                 F5,
  62                 F6,
  63                 F7,
  64                 F8,
  65                 MidiTracks,
  66                 Inputs,
  67                 AudioTracks,
  68                 AudioInstruments,
  69                 Aux,
  70                 Busses,
  71                 Outputs,
  72                 User,
  73                 Shift,
  74                 Option,
  75                 Ctrl,
  76                 CmdAlt,
  77                 Read,
  78                 Write,
  79                 Trim,
  80                 Touch,
  81                 Latch,
  82                 Grp,
  83                 Save,
  84                 Undo,
  85                 Cancel,
  86                 Enter,
  87                 Marker,
  88                 Nudge,
  89                 Loop,
  90                 Drop,
  91                 Replace,
  92                 Click,
  93                 ClearSolo,
  94                 Rewind,
  95                 Ffwd,
  96                 Stop,
  97                 Play,
  98                 Record,
  99                 CursorUp,
 100                 CursorDown,
 101                 CursorLeft,
 102                 CursorRight,
 103                 Zoom,
 104                 Scrub,
 105                 UserA,
 106                 UserB,
 107
 108                 FinalGlobalButton,
 109
 110                 /* Strip buttons */
 111
 112                 RecEnable,
 113                 Solo,
 114                 Mute,
 115                 Select,
 116                 VSelect,
 117                 FaderTouch,
 118
 119                 /* Master fader */
 120
 121                 MasterFaderTouch,
 122         };
 123
 124
 125         Button (ID bid, int did, std::string name, Group & group)
 126                 : Control (did, name, group)
 127                 , _bid (bid)
 128                 , _led  (did, name + "_led", group) {}
 129
 130         MidiByteArray zero() { return _led.zero (); }
 131         MidiByteArray set_state (LedState ls) { return _led.set_state (ls); }
 132
 133         ID bid() const { return _bid; }
 134
 135         static Control* factory (Surface& surface, Button::ID bid, int id, const std::string&, Group& group);
 136         static int name_to_id (const std::string& name);
 137         static std::string id_to_name (Button::ID);
 138
 139 private:
 140         ID  _bid; /* device independent button ID */
 141         Led _led;
 142 };
 143
 144 } // Mackie namespace
 145 } // ArdourSurface namespace
 146
 147 #endif