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