libs/surfaces/mackie/mackie_control_protocol.h

   1 /*
   2     Copyright (C) 2006,2007 John Anderson
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #ifndef ardour_mackie_control_protocol_h
  20 #define ardour_mackie_control_protocol_h
  21
  22 #include <vector>
  23 #include <map>
  24 #include <list>
  25 #include <set>
  26
  27 #include <sys/time.h>
  28 #include <pthread.h>
  29 #include <boost/smart_ptr.hpp>
  30
  31 #define ABSTRACT_UI_EXPORTS
  32 #include "pbd/abstract_ui.h"
  33 #include "midi++/types.h"
  34 #include "ardour/types.h"
  35 #include "control_protocol/control_protocol.h"
  36
  37 #include "types.h"
  38 #include "midi_byte_array.h"
  39 #include "controls.h"
  40 #include "jog_wheel.h"
  41 #include "timer.h"
  42 #include "device_info.h"
  43 #include "device_profile.h"
  44
  45 namespace ARDOUR {
  46         class AutomationControl;
  47         class Port;
  48 }
  49
  50 namespace MIDI {
  51         class Port;
  52 }
  53
  54 namespace ArdourSurface {
  55
  56 namespace Mackie {
  57         class Surface;
  58         class Control;
  59         class SurfacePort;
  60         class Button;
  61 }
  62
  63 gboolean ipmidi_input_handler (GIOChannel*, GIOCondition condition, void *data);
  64
  65 /**
  66         This handles the plugin duties, and the midi encoding and decoding,
  67         and the signal callbacks, mostly from ARDOUR::Route.
  68
  69         The model of the control surface is handled by classes in controls.h
  70
  71         What happens is that each strip on the control surface has
  72         a corresponding route in ControlProtocol::route_table. When
  73         an incoming midi message is signaled, the correct route
  74         is looked up, and the relevant changes made to it.
  75
  76         For each route currently in route_table, there's a RouteSignal object
  77         which encapsulates the signals that indicate that there are changes
  78         to be sent to the surface. The signals are handled by this class.
  79
  80         Calls to signal handlers pass a Route object which is used to look
  81         up the relevant Strip in Surface. Then the state is retrieved from
  82         the Route and encoded as the correct midi message.
  83 */
  84
  85 struct MackieControlUIRequest : public BaseUI::BaseRequestObject {
  86 public:
  87         MackieControlUIRequest () {}
  88         ~MackieControlUIRequest () {}
  89 };
  90
  91 class MackieControlProtocol
  92         : public ARDOUR::ControlProtocol
  93         , public AbstractUI<MackieControlUIRequest>
  94 {
  95   public:
  96         static const int MODIFIER_OPTION;
  97         static const int MODIFIER_CONTROL;
  98         static const int MODIFIER_SHIFT;
  99         static const int MODIFIER_CMDALT;
 100         static const int MODIFIER_ZOOM;
 101         static const int MODIFIER_SCRUB;
 102         static const int MAIN_MODIFIER_MASK;
 103
 104         enum ViewMode {
 105                 Mixer,
 106                 Loop,
 107                 AudioTracks,
 108                 MidiTracks,
 109                 Busses,
 110         };
 111
 112         enum PotMode {
 113                 Tracks,
 114                 Send,
 115                 Pan,
 116                 PlugIn,
 117                 EQ,
 118                 Instrument,
 119         };
 120
 121         enum FlipMode {
 122                 Normal, /* fader controls primary, vpot controls secondary */
 123                 Mirror, /* fader + vpot control secondary */
 124                 Swap,   /* fader controls secondary, vpot controls primary */
 125                 Zero,   /* fader controls primary, but doesn't move, vpot controls secondary */
 126         };
 127
 128         MackieControlProtocol(ARDOUR::Session &);
 129         virtual ~MackieControlProtocol();
 130
 131         static MackieControlProtocol* instance() { return _instance; }
 132
 133         const Mackie::DeviceInfo& device_info() const { return _device_info; }
 134         Mackie::DeviceProfile& device_profile() { return _device_profile; }
 135
 136         PBD::Signal0<void> DeviceChanged;
 137         PBD::Signal1<void,boost::shared_ptr<Mackie::Surface> > ConnectionChange;
 138
 139         void device_ready ();
 140
 141         int set_active (bool yn);
 142         int  set_device (const std::string&, bool force);
 143         void set_profile (const std::string&);
 144
 145         FlipMode flip_mode () const { return _flip_mode; }
 146         ViewMode view_mode () const { return _view_mode; }
 147         PotMode pot_mode () const { return _pot_mode; }
 148         bool zoom_mode () const { return modifier_state() & MODIFIER_ZOOM; }
 149         bool     metering_active () const { return _metering_active; }
 150
 151         void set_view_mode (ViewMode);
 152         void set_flip_mode (FlipMode);
 153         void set_pot_mode (PotMode);
 154
 155         XMLNode& get_state ();
 156         int set_state (const XMLNode&, int version);
 157
 158         /* Note: because Mackie control is inherently a duplex protocol,
 159            we do not implement get/set_feedback() since this aspect of
 160            support for the protocol is not optional.
 161         */
 162
 163         static bool probe();
 164
 165         mutable Glib::Threads::Mutex surfaces_lock;
 166         typedef std::list<boost::shared_ptr<Mackie::Surface> > Surfaces;
 167         Surfaces surfaces;
 168
 169         boost::shared_ptr<Mackie::Surface> get_surface_by_raw_pointer (void*) const;
 170         boost::shared_ptr<Mackie::Surface> nth_surface (uint32_t) const;
 171
 172         std::list<boost::shared_ptr<ARDOUR::Bundle> > bundles ();
 173
 174         void set_master_on_surface_strip (uint32_t surface, uint32_t strip);
 175         void set_monitor_on_surface_strip (uint32_t surface, uint32_t strip);
 176
 177         uint32_t n_strips (bool with_locked_strips = true) const;
 178
 179         bool has_editor () const { return true; }
 180         void* get_gui () const;
 181         void tear_down_gui ();
 182
 183         void handle_button_event (Mackie::Surface&, Mackie::Button& button, Mackie::ButtonState);
 184
 185         void notify_route_added (ARDOUR::RouteList &);
 186         void notify_remote_id_changed();
 187
 188         void recalibrate_faders ();
 189         void toggle_backlight ();
 190         void set_touch_sensitivity (int);
 191
 192         /// rebuild the current bank. Called on route added/removed and
 193         /// remote id changed.
 194         void refresh_current_bank();
 195
 196         // button-related signals
 197         void notify_record_state_changed();
 198         void notify_transport_state_changed();
 199         void notify_loop_state_changed();
 200         void notify_metering_state_changed();
 201         // mainly to pick up punch-in and punch-out
 202         void notify_parameter_changed(std::string const &);
 203         void notify_solo_active_changed(bool);
 204
 205         /// Turn timecode on and beats off, or vice versa, depending
 206         /// on state of _timecode_type
 207         void update_timecode_beats_led();
 208
 209         /// this is called to generate the midi to send in response to a button press.
 210         void update_led(Mackie::Surface&, Mackie::Button & button, Mackie::LedState);
 211
 212         void update_global_button (int id, Mackie::LedState);
 213         void update_global_led (int id, Mackie::LedState);
 214
 215         ARDOUR::Session & get_session() { return *session; }
 216         framepos_t transport_frame() const;
 217
 218         int modifier_state() const { return _modifier_state; }
 219         int main_modifier_state() const { return _modifier_state & MAIN_MODIFIER_MASK; }
 220
 221         typedef std::list<boost::shared_ptr<ARDOUR::AutomationControl> > ControlList;
 222
 223         void add_down_button (ARDOUR::AutomationType, int surface, int strip);
 224         void remove_down_button (ARDOUR::AutomationType, int surface, int strip);
 225         ControlList down_controls (ARDOUR::AutomationType);
 226
 227         void add_down_select_button (int surface, int strip);
 228         void remove_down_select_button (int surface, int strip);
 229         void select_range ();
 230
 231         int16_t ipmidi_base() const { return _ipmidi_base; }
 232         void    set_ipmidi_base (int16_t);
 233
 234         bool session_load () { return _session_load; }
 235         void not_session_load () { _session_load = false; }
 236
 237         void ping_devices ();
 238
 239   protected:
 240         // shut down the surface
 241         void close();
 242
 243         // This sets up the notifications and sets the
 244         // controls to the correct values
 245         void update_surfaces();
 246
 247         // connects global (not strip) signals from the Session to here
 248         // so the surface can be notified of changes from the other UIs.
 249         void connect_session_signals();
 250
 251         // set all controls to their zero position
 252         void zero_all();
 253
 254         /**
 255            Fetch the set of routes to be considered for control by the
 256            surface. Excluding master, hidden and control routes, and inactive routes
 257         */
 258         typedef std::vector<boost::shared_ptr<ARDOUR::Route> > Sorted;
 259         Sorted get_sorted_routes();
 260
 261         // bank switching
 262         void switch_banks (uint32_t first_remote_id, bool force = false);
 263         void prev_track ();
 264         void next_track ();
 265
 266         // also called from poll_automation to update timecode display
 267         void update_timecode_display();
 268
 269         std::string format_bbt_timecode (ARDOUR::framepos_t now_frame);
 270         std::string format_timecode_timecode (ARDOUR::framepos_t now_frame);
 271
 272         void do_request (MackieControlUIRequest*);
 273         int stop ();
 274
 275         void thread_init ();
 276
 277         bool route_is_locked_to_strip (boost::shared_ptr<ARDOUR::Route>) const;
 278
 279   private:
 280
 281         struct ButtonHandlers {
 282             Mackie::LedState (MackieControlProtocol::*press) (Mackie::Button&);
 283             Mackie::LedState (MackieControlProtocol::*release) (Mackie::Button&);
 284
 285             ButtonHandlers (Mackie::LedState (MackieControlProtocol::*p) (Mackie::Button&),
 286                             Mackie::LedState (MackieControlProtocol::*r) (Mackie::Button&))
 287             : press (p)
 288             , release (r) {}
 289         };
 290
 291         typedef std::map<Mackie::Button::ID,ButtonHandlers> ButtonMap;
 292
 293         static MackieControlProtocol* _instance;
 294
 295         Mackie::DeviceInfo       _device_info;
 296         Mackie::DeviceProfile    _device_profile;
 297         sigc::connection          periodic_connection;
 298         sigc::connection          redisplay_connection;
 299         sigc::connection          hui_connection;
 300         uint32_t                 _current_initial_bank;
 301         PBD::ScopedConnectionList audio_engine_connections;
 302         PBD::ScopedConnectionList session_connections;
 303         PBD::ScopedConnectionList route_connections;
 304         PBD::ScopedConnectionList gui_connections;
 305         // timer for two quick marker left presses
 306         Mackie::Timer            _frm_left_last;
 307         // last written timecode string
 308         std::string              _timecode_last;
 309         // Which timecode are we displaying? BBT or Timecode
 310         ARDOUR::AnyTime::Type    _timecode_type;
 311         // Bundle to represent our input ports
 312         boost::shared_ptr<ARDOUR::Bundle> _input_bundle;
 313         // Bundle to represent our output ports
 314         boost::shared_ptr<ARDOUR::Bundle> _output_bundle;
 315         void*                    _gui;
 316         bool                     _scrub_mode;
 317         FlipMode                 _flip_mode;
 318         ViewMode                 _view_mode;
 319         PotMode                  _pot_mode;
 320         int                      _current_selected_track;
 321         int                      _modifier_state;
 322         ButtonMap                 button_map;
 323         int16_t                  _ipmidi_base;
 324         bool                      needs_ipmidi_restart;
 325         bool                     _metering_active;
 326         bool                     _initialized;
 327         ARDOUR::RouteNotificationList _last_selected_routes;
 328         XMLNode*                                _surfaces_state;
 329         int                                             _surfaces_version;
 330         bool                                    _session_load;
 331         boost::shared_ptr<ArdourSurface::Mackie::Surface>       _master_surface;
 332
 333         struct ipMIDIHandler {
 334                 MackieControlProtocol* mcp;
 335                 MIDI::Port* port;
 336         };
 337         friend struct ipMIDIHandler; /* is this necessary */
 338         friend gboolean ArdourSurface::ipmidi_input_handler (GIOChannel*, GIOCondition condition, void *data);
 339
 340         int create_surfaces ();
 341         bool periodic();
 342         bool redisplay();
 343         bool hui_heartbeat ();
 344         void build_gui ();
 345         bool midi_input_handler (Glib::IOCondition ioc, MIDI::Port* port);
 346         void clear_ports ();
 347         void clear_surfaces ();
 348         void force_special_route_to_strip (boost::shared_ptr<ARDOUR::Route> r, uint32_t surface, uint32_t strip_number);
 349         void build_button_map ();
 350         void gui_track_selection_changed (ARDOUR::RouteNotificationListPtr, bool save_list);
 351         void _gui_track_selection_changed (ARDOUR::RouteNotificationList*, bool save_list);
 352         int ipmidi_restart ();
 353         void initialize ();
 354         int set_device_info (const std::string& device_name);
 355
 356         /* MIDI port connection management */
 357
 358         PBD::ScopedConnection port_connection;
 359         void connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool);
 360
 361         /* BUTTON HANDLING */
 362
 363         typedef std::set<uint32_t> DownButtonList;
 364         typedef std::map<ARDOUR::AutomationType,DownButtonList> DownButtonMap;
 365         DownButtonMap  _down_buttons;
 366         DownButtonList _down_select_buttons;
 367
 368         void pull_route_range (DownButtonList&, ARDOUR::RouteList&);
 369
 370         /* implemented button handlers */
 371         Mackie::LedState stop_press(Mackie::Button &);
 372         Mackie::LedState stop_release(Mackie::Button &);
 373         Mackie::LedState play_press(Mackie::Button &);
 374         Mackie::LedState play_release(Mackie::Button &);
 375         Mackie::LedState record_press(Mackie::Button &);
 376         Mackie::LedState record_release(Mackie::Button &);
 377         Mackie::LedState loop_press(Mackie::Button &);
 378         Mackie::LedState loop_release(Mackie::Button &);
 379         Mackie::LedState rewind_press(Mackie::Button & button);
 380         Mackie::LedState rewind_release(Mackie::Button & button);
 381         Mackie::LedState ffwd_press(Mackie::Button & button);
 382         Mackie::LedState ffwd_release(Mackie::Button & button);
 383         Mackie::LedState cursor_up_press (Mackie::Button &);
 384         Mackie::LedState cursor_up_release (Mackie::Button &);
 385         Mackie::LedState cursor_down_press (Mackie::Button &);
 386         Mackie::LedState cursor_down_release (Mackie::Button &);
 387         Mackie::LedState cursor_left_press (Mackie::Button &);
 388         Mackie::LedState cursor_left_release (Mackie::Button &);
 389         Mackie::LedState cursor_right_press (Mackie::Button &);
 390         Mackie::LedState cursor_right_release (Mackie::Button &);
 391         Mackie::LedState left_press(Mackie::Button &);
 392         Mackie::LedState left_release(Mackie::Button &);
 393         Mackie::LedState right_press(Mackie::Button &);
 394         Mackie::LedState right_release(Mackie::Button &);
 395         Mackie::LedState channel_left_press(Mackie::Button &);
 396         Mackie::LedState channel_left_release(Mackie::Button &);
 397         Mackie::LedState channel_right_press(Mackie::Button &);
 398         Mackie::LedState channel_right_release(Mackie::Button &);
 399         Mackie::LedState clicking_press(Mackie::Button &);
 400         Mackie::LedState clicking_release(Mackie::Button &);
 401         Mackie::LedState global_solo_press(Mackie::Button &);
 402         Mackie::LedState global_solo_release(Mackie::Button &);
 403         Mackie::LedState marker_press(Mackie::Button &);
 404         Mackie::LedState marker_release(Mackie::Button &);
 405         Mackie::LedState save_press(Mackie::Button &);
 406         Mackie::LedState save_release(Mackie::Button &);
 407         Mackie::LedState timecode_beats_press(Mackie::Button &);
 408         Mackie::LedState timecode_beats_release(Mackie::Button &);
 409         Mackie::LedState zoom_press(Mackie::Button &);
 410         Mackie::LedState zoom_release(Mackie::Button &);
 411         Mackie::LedState scrub_press(Mackie::Button &);
 412         Mackie::LedState scrub_release(Mackie::Button &);
 413         Mackie::LedState undo_press (Mackie::Button &);
 414         Mackie::LedState undo_release (Mackie::Button &);
 415         Mackie::LedState shift_press (Mackie::Button &);
 416         Mackie::LedState shift_release (Mackie::Button &);
 417         Mackie::LedState option_press (Mackie::Button &);
 418         Mackie::LedState option_release (Mackie::Button &);
 419         Mackie::LedState control_press (Mackie::Button &);
 420         Mackie::LedState control_release (Mackie::Button &);
 421         Mackie::LedState cmd_alt_press (Mackie::Button &);
 422         Mackie::LedState cmd_alt_release (Mackie::Button &);
 423
 424         Mackie::LedState pan_press (Mackie::Button &);
 425         Mackie::LedState pan_release (Mackie::Button &);
 426         Mackie::LedState plugin_press (Mackie::Button &);
 427         Mackie::LedState plugin_release (Mackie::Button &);
 428         Mackie::LedState eq_press (Mackie::Button &);
 429         Mackie::LedState eq_release (Mackie::Button &);
 430         Mackie::LedState dyn_press (Mackie::Button &);
 431         Mackie::LedState dyn_release (Mackie::Button &);
 432         Mackie::LedState flip_press (Mackie::Button &);
 433         Mackie::LedState flip_release (Mackie::Button &);
 434         Mackie::LedState name_value_press (Mackie::Button &);
 435         Mackie::LedState name_value_release (Mackie::Button &);
 436         Mackie::LedState F1_press (Mackie::Button &);
 437         Mackie::LedState F1_release (Mackie::Button &);
 438         Mackie::LedState F2_press (Mackie::Button &);
 439         Mackie::LedState F2_release (Mackie::Button &);
 440         Mackie::LedState F3_press (Mackie::Button &);
 441         Mackie::LedState F3_release (Mackie::Button &);
 442         Mackie::LedState F4_press (Mackie::Button &);
 443         Mackie::LedState F4_release (Mackie::Button &);
 444         Mackie::LedState F5_press (Mackie::Button &);
 445         Mackie::LedState F5_release (Mackie::Button &);
 446         Mackie::LedState F6_press (Mackie::Button &);
 447         Mackie::LedState F6_release (Mackie::Button &);
 448         Mackie::LedState F7_press (Mackie::Button &);
 449         Mackie::LedState F7_release (Mackie::Button &);
 450         Mackie::LedState F8_press (Mackie::Button &);
 451         Mackie::LedState F8_release (Mackie::Button &);
 452         Mackie::LedState touch_press (Mackie::Button &);
 453         Mackie::LedState touch_release (Mackie::Button &);
 454         Mackie::LedState enter_press (Mackie::Button &);
 455         Mackie::LedState enter_release (Mackie::Button &);
 456         Mackie::LedState cancel_press (Mackie::Button &);
 457         Mackie::LedState cancel_release (Mackie::Button &);
 458         Mackie::LedState user_a_press (Mackie::Button &);
 459         Mackie::LedState user_a_release (Mackie::Button &);
 460         Mackie::LedState user_b_press (Mackie::Button &);
 461         Mackie::LedState user_b_release (Mackie::Button &);
 462         Mackie::LedState fader_touch_press (Mackie::Button &);
 463         Mackie::LedState fader_touch_release (Mackie::Button &);
 464         Mackie::LedState master_fader_touch_press (Mackie::Button &);
 465         Mackie::LedState master_fader_touch_release (Mackie::Button &);
 466
 467         Mackie::LedState read_press (Mackie::Button&);
 468         Mackie::LedState read_release (Mackie::Button&);
 469         Mackie::LedState write_press (Mackie::Button&);
 470         Mackie::LedState write_release (Mackie::Button&);
 471         Mackie::LedState clearsolo_press (Mackie::Button&);
 472         Mackie::LedState clearsolo_release (Mackie::Button&);
 473         Mackie::LedState track_press (Mackie::Button&);
 474         Mackie::LedState track_release (Mackie::Button&);
 475         Mackie::LedState send_press (Mackie::Button&);
 476         Mackie::LedState send_release (Mackie::Button&);
 477         Mackie::LedState miditracks_press (Mackie::Button&);
 478         Mackie::LedState miditracks_release (Mackie::Button&);
 479         Mackie::LedState inputs_press (Mackie::Button&);
 480         Mackie::LedState inputs_release (Mackie::Button&);
 481         Mackie::LedState audiotracks_press (Mackie::Button&);
 482         Mackie::LedState audiotracks_release (Mackie::Button&);
 483         Mackie::LedState audioinstruments_press (Mackie::Button&);
 484         Mackie::LedState audioinstruments_release (Mackie::Button&);
 485         Mackie::LedState aux_press (Mackie::Button&);
 486         Mackie::LedState aux_release (Mackie::Button&);
 487         Mackie::LedState busses_press (Mackie::Button&);
 488         Mackie::LedState busses_release (Mackie::Button&);
 489         Mackie::LedState outputs_press (Mackie::Button&);
 490         Mackie::LedState outputs_release (Mackie::Button&);
 491         Mackie::LedState user_press (Mackie::Button&);
 492         Mackie::LedState user_release (Mackie::Button&);
 493         Mackie::LedState trim_press (Mackie::Button&);
 494         Mackie::LedState trim_release (Mackie::Button&);
 495         Mackie::LedState latch_press (Mackie::Button&);
 496         Mackie::LedState latch_release (Mackie::Button&);
 497         Mackie::LedState grp_press (Mackie::Button&);
 498         Mackie::LedState grp_release (Mackie::Button&);
 499         Mackie::LedState nudge_press (Mackie::Button&);
 500         Mackie::LedState nudge_release (Mackie::Button&);
 501         Mackie::LedState drop_press (Mackie::Button&);
 502         Mackie::LedState drop_release (Mackie::Button&);
 503         Mackie::LedState replace_press (Mackie::Button&);
 504         Mackie::LedState replace_release (Mackie::Button&);
 505         Mackie::LedState click_press (Mackie::Button&);
 506         Mackie::LedState click_release (Mackie::Button&);
 507         Mackie::LedState view_press (Mackie::Button&);
 508         Mackie::LedState view_release (Mackie::Button&);
 509
 510         Mackie::LedState bank_release (Mackie::Button&, uint32_t bank_num);
 511 };
 512
 513 } // namespace
 514
 515 #endif // ardour_mackie_control_protocol_h