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