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