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