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