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