libs/surfaces/mackie/device_info.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_device_info_h__
  21 #define __ardour_mackie_control_protocol_device_info_h__
  22
  23 #include <iostream>
  24 #include <stdint.h>
  25 #include <string>
  26 #include <map>
  27
  28 #include "button.h"
  29
  30 class XMLNode;
  31
  32 namespace ArdourSurface {
  33
  34 namespace Mackie {
  35
  36 struct GlobalButtonInfo {
  37     std::string label; // visible to user
  38     std::string group; // in case we want to present in a GUI
  39     int32_t id;       // value sent by device
  40
  41     GlobalButtonInfo () : id (-1) {}
  42     GlobalButtonInfo (const std::string& l, const std::string& g, uint32_t i)
  43             : label (l), group (g), id (i) {}
  44 };
  45
  46 struct StripButtonInfo {
  47     int32_t base_id;
  48     std::string name;
  49
  50     StripButtonInfo () : base_id (-1) {}
  51     StripButtonInfo (uint32_t i, const std::string& n)
  52             : base_id (i), name (n) {}
  53 };
  54
  55 class DeviceInfo
  56 {
  57   public:
  58         DeviceInfo();
  59         ~DeviceInfo();
  60
  61         int set_state (const XMLNode&, int version);
  62
  63         uint32_t strip_cnt () const;
  64         uint32_t extenders() const;
  65         uint32_t master_position() const;
  66         bool has_two_character_display() const;
  67         bool has_master_fader () const;
  68         bool has_timecode_display() const;
  69         bool has_global_controls() const;
  70         bool has_jog_wheel () const;
  71         bool has_touch_sense_faders() const;
  72         bool uses_ipmidi() const;
  73         bool no_handshake() const;
  74         bool has_meters() const;
  75         const std::string& name() const;
  76
  77         static std::map<std::string,DeviceInfo> device_info;
  78         static void reload_device_info();
  79
  80         std::string& get_global_button_name(Button::ID);
  81         GlobalButtonInfo& get_global_button(Button::ID);
  82
  83   typedef std::map<Button::ID,GlobalButtonInfo> GlobalButtonsInfo;
  84   typedef std::map<Button::ID,StripButtonInfo> StripButtonsInfo;
  85
  86   const GlobalButtonsInfo& global_buttons() const { return _global_buttons; }
  87   const StripButtonsInfo& strip_buttons() const { return _strip_buttons; }
  88
  89   private:
  90     uint32_t _strip_cnt;
  91     uint32_t _extenders;
  92     uint32_t _master_position;
  93     bool     _has_two_character_display;
  94     bool     _has_master_fader;
  95     bool     _has_timecode_display;
  96     bool     _has_global_controls;
  97     bool     _has_jog_wheel;
  98     bool     _has_touch_sense_faders;
  99     bool     _uses_logic_control_buttons;
 100     bool     _uses_ipmidi;
 101     bool     _no_handshake;
 102     bool     _has_meters;
 103     std::string _name;
 104                 std::string _global_button_name;
 105
 106                 GlobalButtonsInfo _global_buttons;
 107     StripButtonsInfo _strip_buttons;
 108
 109     void logic_control_buttons ();
 110     void mackie_control_buttons ();
 111     void shared_buttons ();
 112 };
 113
 114
 115 } // Mackie namespace
 116 } // ArdourSurface namespace
 117
 118 std::ostream& operator<< (std::ostream& os, const ArdourSurface::Mackie::DeviceInfo& di);
 119
 120 #endif /* __ardour_mackie_control_protocol_device_info_h__ */