libs/surfaces/mackie/surface.h

   1 #ifndef mackie_surface_h
   2 #define mackie_surface_h
   3
   4 #include <stdint.h>
   5
   6 #include <sigc++/trackable.h>
   7
   8 #include "pbd/signals.h"
   9 #include "pbd/xml++.h"
  10 #include "midi++/types.h"
  11
  12 #include "ardour/types.h"
  13
  14 #include "control_protocol/types.h"
  15
  16 #include "controls.h"
  17 #include "types.h"
  18 #include "jog_wheel.h"
  19
  20 namespace MIDI {
  21         class Parser;
  22 }
  23
  24 namespace ARDOUR {
  25         class Route;
  26         class Port;
  27 }
  28
  29 class MidiByteArray;
  30
  31 namespace ArdourSurface {
  32
  33 class MackieControlProtocol;
  34
  35 namespace Mackie
  36 {
  37
  38 class MackieButtonHandler;
  39 class SurfacePort;
  40 class MackieMidiBuilder;
  41 class Button;
  42 class Meter;
  43 class Fader;
  44 class Jog;
  45 class Pot;
  46 class Led;
  47
  48 class Surface : public PBD::ScopedConnectionList, public sigc::trackable
  49 {
  50 public:
  51         Surface (MackieControlProtocol&, const std::string& name, uint32_t number, surface_type_t stype);
  52         virtual ~Surface();
  53
  54         surface_type_t type() const { return _stype; }
  55         uint32_t number() const { return _number; }
  56         const std::string& name() { return _name; }
  57
  58         void connected ();
  59
  60         bool active() const { return _active; }
  61
  62         typedef std::vector<Control*> Controls;
  63         Controls controls;
  64
  65         std::map<int,Fader*> faders;
  66         std::map<int,Pot*> pots;
  67         std::map<int,Button*> buttons; // index is device-DEPENDENT
  68         std::map<int,Led*> leds;
  69         std::map<int,Meter*> meters;
  70         std::map<int,Control*> controls_by_device_independent_id;
  71
  72         Mackie::JogWheel* jog_wheel() const { return _jog_wheel; }
  73         Fader* master_fader() const { return _master_fader; }
  74
  75         /// The collection of all numbered strips.
  76         typedef std::vector<Strip*> Strips;
  77         Strips strips;
  78
  79         uint32_t n_strips (bool with_locked_strips = true) const;
  80         Strip* nth_strip (uint32_t n) const;
  81
  82         bool route_is_locked_to_strip (boost::shared_ptr<ARDOUR::Route>) const;
  83         bool route_is_mapped (boost::shared_ptr<ARDOUR::Route>) const;
  84
  85         /// This collection owns the groups
  86         typedef std::map<std::string,Group*> Groups;
  87         Groups groups;
  88
  89         SurfacePort& port() const { return *_port; }
  90
  91         void map_routes (const std::vector<boost::shared_ptr<ARDOUR::Route> >& routes);
  92
  93         const MidiByteArray& sysex_hdr() const;
  94
  95         void periodic (ARDOUR::microseconds_t now_usecs);
  96         void redisplay (ARDOUR::microseconds_t now_usecs, bool force);
  97         void hui_heartbeat ();
  98
  99         void handle_midi_pitchbend_message (MIDI::Parser&, MIDI::pitchbend_t, uint32_t channel_id);
 100         void handle_midi_controller_message (MIDI::Parser&, MIDI::EventTwoBytes*);
 101         void handle_midi_note_on_message (MIDI::Parser&, MIDI::EventTwoBytes*);
 102
 103         /// Connect the any signal from the parser to handle_midi_any
 104         /// unless it's already connected
 105         void connect_to_signals ();
 106
 107         /// write a sysex message
 108         void write_sysex (const MidiByteArray& mba);
 109         void write_sysex (MIDI::byte msg);
 110         /// proxy write for port
 111         void write (const MidiByteArray&);
 112
 113         /// display an indicator of the first switched-in Route. Do nothing by default.
 114         void display_bank_start (uint32_t /*current_bank*/);
 115
 116         /// called from MackieControlProtocol::zero_all to turn things off
 117         void zero_all ();
 118         void zero_controls ();
 119
 120         /// turn off leds around the jog wheel. This is for surfaces that use a pot
 121         /// pretending to be a jog wheel.
 122         void blank_jog_ring ();
 123
 124         void display_timecode (const std::string & /*timecode*/, const std::string & /*timecode_last*/);
 125
 126         /// sends MCP "reset" message to surface
 127         void reset ();
 128
 129         void recalibrate_faders ();
 130         void toggle_backlight ();
 131         void set_touch_sensitivity (int);
 132
 133         /**
 134                 This is used to calculate the clicks per second that define
 135                 a transport speed of 1.0 for the jog wheel. 100.0 is 10 clicks
 136                 per second, 50.5 is 5 clicks per second.
 137         */
 138         float scrub_scaling_factor() const;
 139
 140         /**
 141                 The scaling factor function for speed increase and decrease. At
 142                 low transport speeds this should return a small value, for high transport
 143                 speeds, this should return an exponentially larger value. This provides
 144                 high definition control at low speeds and quick speed changes to/from
 145                 higher speeds.
 146         */
 147         float scaled_delta (float delta, float current_speed);
 148
 149         // display the first 2 chars of the msg in the 2 char display
 150         // . is appended to the previous character, so A.B. would
 151         // be two characters
 152         void show_two_char_display (const std::string & msg, const std::string & dots = "  ");
 153         void show_two_char_display (unsigned int value, const std::string & dots = "  ");
 154
 155         void update_view_mode_display (bool with_helpful_text);
 156         void update_flip_mode_display ();
 157         void update_potmode ();
 158
 159         void gui_selection_changed (const ARDOUR::StrongRouteNotificationList&);
 160         void subview_mode_changed ();
 161
 162         MackieControlProtocol& mcp() const { return _mcp; }
 163
 164         void next_jog_mode ();
 165         void set_jog_mode (Mackie::JogWheel::Mode);
 166
 167         void notify_metering_state_changed();
 168         void turn_it_on ();
 169
 170         void display_message_for (std::string const& msg, uint64_t msecs);
 171
 172         bool connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool);
 173
 174         void master_monitor_may_have_changed ();
 175
 176         XMLNode& get_state ();
 177         int set_state (const XMLNode&, int version);
 178
 179   private:
 180         MackieControlProtocol& _mcp;
 181         SurfacePort*           _port;
 182         surface_type_t         _stype;
 183         uint32_t               _number;
 184         std::string            _name;
 185         bool                   _active;
 186         bool                   _connected;
 187         Mackie::JogWheel*      _jog_wheel;
 188         Fader*                 _master_fader;
 189         float                  _last_master_gain_written;
 190         PBD::ScopedConnection   master_connection;
 191
 192         void handle_midi_sysex (MIDI::Parser&, MIDI::byte *, size_t count);
 193         MidiByteArray host_connection_query (MidiByteArray& bytes);
 194         MidiByteArray host_connection_confirmation (const MidiByteArray& bytes);
 195
 196         void say_hello ();
 197         void init_controls ();
 198         void init_strips (uint32_t n);
 199         void setup_master ();
 200         void master_gain_changed ();
 201
 202         enum ConnectionState {
 203                 InputConnected = 0x1,
 204                 OutputConnected = 0x2
 205         };
 206
 207         int connection_state;
 208
 209         MidiByteArray display_line (std::string const& msg, int line_num);
 210
 211   public:
 212         /* IP MIDI devices need to keep a handle on this and destroy it */
 213         GSource*    input_source;
 214 };
 215
 216 }
 217 }
 218
 219 #endif