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