libs/surfaces/mackie/mackie_control_protocol.h

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