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