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