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
  25 #include <sys/time.h>
  26 #include <pthread.h>
  27 #include <boost/smart_ptr.hpp>
  28
  29 #include <glibmm/thread.h>
  30
  31 #include "pbd/abstract_ui.h"
  32
  33 #include "midi++/types.h"
  34
  35 #include "ardour/types.h"
  36 #include "control_protocol/control_protocol.h"
  37
  38 #include "types.h"
  39 #include "midi_byte_array.h"
  40 #include "controls.h"
  41 #include "mackie_jog_wheel.h"
  42 #include "timer.h"
  43 #include "device_info.h"
  44
  45 class RouteTimeAxisView;
  46
  47 namespace MIDI {
  48         class Port;
  49 }
  50
  51 namespace Mackie {
  52         class Surface;
  53         class Control;
  54         class SurfacePort;
  55         class Button;
  56 }
  57
  58 /**
  59         This handles the plugin duties, and the midi encoding and decoding,
  60         and the signal callbacks, mostly from ARDOUR::Route.
  61
  62         The model of the control surface is handled by classes in controls.h
  63
  64         What happens is that each strip on the control surface has
  65         a corresponding route in ControlProtocol::route_table. When
  66         an incoming midi message is signaled, the correct route
  67         is looked up, and the relevant changes made to it.
  68
  69         For each route currently in route_table, there's a RouteSignal object
  70         which encapsulates the signals that indicate that there are changes
  71         to be sent to the surface. The signals are handled by this class.
  72
  73         Calls to signal handlers pass a Route object which is used to look
  74         up the relevant Strip in Surface. Then the state is retrieved from
  75         the Route and encoded as the correct midi message.
  76 */
  77
  78 struct MackieControlUIRequest : public BaseUI::BaseRequestObject {
  79 public:
  80         MackieControlUIRequest () {}
  81         ~MackieControlUIRequest () {}
  82 };
  83
  84 class MackieControlProtocol
  85         : public ARDOUR::ControlProtocol
  86         , public AbstractUI<MackieControlUIRequest>
  87 {
  88   public:
  89         static const int MODIFIER_OPTION;
  90         static const int MODIFIER_CONTROL;
  91         static const int MODIFIER_SHIFT;
  92         static const int MODIFIER_CMDALT;
  93
  94         enum ViewMode {
  95                 Global,
  96                 Dynamics,
  97                 EQ,
  98                 Loop,
  99                 AudioTracks,
 100                 MidiTracks,
 101                 Busses,
 102                 Sends,
 103                 Plugins,
 104         };
 105
 106         enum FlipMode {
 107                 Normal, /* fader controls primary, vpot controls secondary */
 108                 Mirror, /* fader + vpot control secondary */
 109                 Swap,   /* fader controls secondary, vpot controls primary */
 110                 Zero,   /* fader controls primary, but doesn't move, vpot controls secondary */
 111         };
 112
 113         MackieControlProtocol(ARDOUR::Session &);
 114         virtual ~MackieControlProtocol();
 115
 116         static MackieControlProtocol* instance() { return _instance; }
 117
 118         const Mackie::DeviceInfo& device_info() const { return _device_info; }
 119
 120         int set_active (bool yn);
 121         void set_device (const std::string&);
 122
 123         FlipMode flip_mode () const { return _flip_mode; }
 124         ViewMode view_mode () const { return _view_mode; }
 125
 126         void set_view_mode (ViewMode);
 127         void set_flip_mode (FlipMode);
 128
 129         XMLNode& get_state ();
 130         int set_state (const XMLNode&, int version);
 131
 132         static bool probe();
 133
 134         typedef std::list<boost::shared_ptr<Mackie::Surface> > Surfaces;
 135         Surfaces surfaces;
 136
 137         std::list<boost::shared_ptr<ARDOUR::Bundle> > bundles ();
 138
 139         void set_master_on_surface_strip (uint32_t surface, uint32_t strip);
 140         void set_monitor_on_surface_strip (uint32_t surface, uint32_t strip);
 141
 142         uint32_t n_strips () const;
 143
 144         bool has_editor () const { return true; }
 145         void* get_gui () const;
 146         void tear_down_gui ();
 147
 148         void select_track (boost::shared_ptr<ARDOUR::Route> r);
 149
 150         void handle_button_event (Mackie::Surface&, Mackie::Button& button, Mackie::ButtonState);
 151
 152         void notify_route_added (ARDOUR::RouteList &);
 153         void notify_remote_id_changed();
 154
 155         /// rebuild the current bank. Called on route added/removed and
 156         /// remote id changed.
 157         void refresh_current_bank();
 158
 159         // button-related signals
 160         void notify_record_state_changed();
 161         void notify_transport_state_changed();
 162         void notify_loop_state_changed();
 163         // mainly to pick up punch-in and punch-out
 164         void notify_parameter_changed(std::string const &);
 165         void notify_solo_active_changed(bool);
 166
 167         /// Turn timecode on and beats off, or vice versa, depending
 168         /// on state of _timecode_type
 169         void update_timecode_beats_led();
 170
 171         /// this is called to generate the midi to send in response to a button press.
 172         void update_led(Mackie::Surface&, Mackie::Button & button, Mackie::LedState);
 173
 174         void update_global_button(const std::string & name, Mackie::LedState);
 175         void update_global_led(const std::string & name, Mackie::LedState);
 176
 177         ARDOUR::Session & get_session() { return *session; }
 178
 179         void add_in_use_timeout (Mackie::Surface& surface, Mackie::Control& in_use_control, Mackie::Control* touch_control);
 180
 181         int modifier_state() const { return _modifier_state; }
 182
 183   protected:
 184         // shut down the surface
 185         void close();
 186
 187         // This sets up the notifications and sets the
 188         // controls to the correct values
 189         void update_surfaces();
 190
 191         // connects global (not strip) signals from the Session to here
 192         // so the surface can be notified of changes from the other UIs.
 193         void connect_session_signals();
 194
 195         // set all controls to their zero position
 196         void zero_all();
 197
 198         /**
 199            Fetch the set of routes to be considered for control by the
 200            surface. Excluding master, hidden and control routes, and inactive routes
 201         */
 202         typedef std::vector<boost::shared_ptr<ARDOUR::Route> > Sorted;
 203         Sorted get_sorted_routes();
 204
 205         // bank switching
 206         void switch_banks (uint32_t first_remote_id, bool force = false);
 207         void prev_track ();
 208         void next_track ();
 209
 210         // also called from poll_automation to update timecode display
 211         void update_timecode_display();
 212
 213         std::string format_bbt_timecode (ARDOUR::framepos_t now_frame);
 214         std::string format_timecode_timecode (ARDOUR::framepos_t now_frame);
 215
 216         void do_request (MackieControlUIRequest*);
 217         int stop ();
 218
 219         void thread_init ();
 220
 221         /* handling function key presses */
 222
 223         std::string f_action (uint32_t fn);
 224         void f_press (uint32_t fn);
 225
 226   private:
 227
 228         struct ButtonHandlers {
 229             Mackie::LedState (MackieControlProtocol::*press) (Mackie::Button&);
 230             Mackie::LedState (MackieControlProtocol::*release) (Mackie::Button&);
 231
 232             ButtonHandlers (Mackie::LedState (MackieControlProtocol::*p) (Mackie::Button&),
 233                             Mackie::LedState (MackieControlProtocol::*r) (Mackie::Button&))
 234             : press (p)
 235             , release (r) {}
 236         };
 237
 238         typedef std::map<int,ButtonHandlers> ButtonMap;
 239         typedef std::list<GSource*> PortSources;
 240
 241         static MackieControlProtocol* _instance;
 242
 243         Mackie::DeviceInfo       _device_info;
 244         sigc::connection          periodic_connection;
 245         uint32_t                 _current_initial_bank;
 246         PBD::ScopedConnectionList audio_engine_connections;
 247         PBD::ScopedConnectionList session_connections;
 248         PBD::ScopedConnectionList port_connections;
 249         PBD::ScopedConnectionList route_connections;
 250         PBD::ScopedConnectionList gui_connections;
 251         bool _transport_previously_rolling;
 252         // timer for two quick marker left presses
 253         Mackie::Timer            _frm_left_last;
 254         // last written timecode string
 255         std::string              _timecode_last;
 256         // Which timecode are we displaying? BBT or Timecode
 257         ARDOUR::AnyTime::Type    _timecode_type;
 258         // Bundle to represent our input ports
 259         boost::shared_ptr<ARDOUR::Bundle> _input_bundle;
 260         // Bundle to represent our output ports
 261         boost::shared_ptr<ARDOUR::Bundle> _output_bundle;
 262         void*                    _gui;
 263         bool                     _zoom_mode;
 264         bool                     _scrub_mode;
 265         FlipMode                 _flip_mode;
 266         ViewMode                 _view_mode;
 267         int                      _current_selected_track;
 268         int                      _modifier_state;
 269         PortSources               port_sources;
 270         std::vector<std::string> _f_actions;
 271         ButtonMap                 button_map;
 272
 273         void create_surfaces ();
 274         void port_connected_or_disconnected (std::string, std::string, bool);
 275         bool control_in_use_timeout (Mackie::Surface*, Mackie::Control *, Mackie::Control *);
 276         bool periodic();
 277         void build_gui ();
 278         bool midi_input_handler (Glib::IOCondition ioc, MIDI::Port* port);
 279         void clear_ports ();
 280         void force_special_route_to_strip (boost::shared_ptr<ARDOUR::Route> r, uint32_t surface, uint32_t strip_number);
 281         void build_button_map ();
 282
 283         void gui_track_selection_changed (ARDOUR::RouteNotificationListPtr);
 284
 285         /* BUTTON HANDLING */
 286
 287         /* implemented button handlers */
 288         Mackie::LedState frm_left_press(Mackie::Button &);
 289         Mackie::LedState frm_left_release(Mackie::Button &);
 290         Mackie::LedState frm_right_press(Mackie::Button &);
 291         Mackie::LedState frm_right_release(Mackie::Button &);
 292         Mackie::LedState stop_press(Mackie::Button &);
 293         Mackie::LedState stop_release(Mackie::Button &);
 294         Mackie::LedState play_press(Mackie::Button &);
 295         Mackie::LedState play_release(Mackie::Button &);
 296         Mackie::LedState record_press(Mackie::Button &);
 297         Mackie::LedState record_release(Mackie::Button &);
 298         Mackie::LedState loop_press(Mackie::Button &);
 299         Mackie::LedState loop_release(Mackie::Button &);
 300         Mackie::LedState punch_in_press(Mackie::Button &);
 301         Mackie::LedState punch_in_release(Mackie::Button &);
 302         Mackie::LedState punch_out_press(Mackie::Button &);
 303         Mackie::LedState punch_out_release(Mackie::Button &);
 304         Mackie::LedState home_press(Mackie::Button &);
 305         Mackie::LedState home_release(Mackie::Button &);
 306         Mackie::LedState end_press(Mackie::Button &);
 307         Mackie::LedState end_release(Mackie::Button &);
 308         Mackie::LedState rewind_press(Mackie::Button & button);
 309         Mackie::LedState rewind_release(Mackie::Button & button);
 310         Mackie::LedState ffwd_press(Mackie::Button & button);
 311         Mackie::LedState ffwd_release(Mackie::Button & button);
 312         Mackie::LedState cursor_up_press (Mackie::Button &);
 313         Mackie::LedState cursor_up_release (Mackie::Button &);
 314         Mackie::LedState cursor_down_press (Mackie::Button &);
 315         Mackie::LedState cursor_down_release (Mackie::Button &);
 316         Mackie::LedState cursor_left_press (Mackie::Button &);
 317         Mackie::LedState cursor_left_release (Mackie::Button &);
 318         Mackie::LedState cursor_right_press (Mackie::Button &);
 319         Mackie::LedState cursor_right_release (Mackie::Button &);
 320         Mackie::LedState left_press(Mackie::Button &);
 321         Mackie::LedState left_release(Mackie::Button &);
 322         Mackie::LedState right_press(Mackie::Button &);
 323         Mackie::LedState right_release(Mackie::Button &);
 324         Mackie::LedState channel_left_press(Mackie::Button &);
 325         Mackie::LedState channel_left_release(Mackie::Button &);
 326         Mackie::LedState channel_right_press(Mackie::Button &);
 327         Mackie::LedState channel_right_release(Mackie::Button &);
 328         Mackie::LedState clicking_press(Mackie::Button &);
 329         Mackie::LedState clicking_release(Mackie::Button &);
 330         Mackie::LedState global_solo_press(Mackie::Button &);
 331         Mackie::LedState global_solo_release(Mackie::Button &);
 332         Mackie::LedState marker_press(Mackie::Button &);
 333         Mackie::LedState marker_release(Mackie::Button &);
 334         Mackie::LedState drop_press(Mackie::Button &);
 335         Mackie::LedState drop_release(Mackie::Button &);
 336         Mackie::LedState save_press(Mackie::Button &);
 337         Mackie::LedState save_release(Mackie::Button &);
 338         Mackie::LedState timecode_beats_press(Mackie::Button &);
 339         Mackie::LedState timecode_beats_release(Mackie::Button &);
 340         Mackie::LedState zoom_press(Mackie::Button &);
 341         Mackie::LedState zoom_release(Mackie::Button &);
 342         Mackie::LedState scrub_press(Mackie::Button &);
 343         Mackie::LedState scrub_release(Mackie::Button &);
 344         Mackie::LedState undo_press (Mackie::Button &);
 345         Mackie::LedState undo_release (Mackie::Button &);
 346         Mackie::LedState redo_press (Mackie::Button &);
 347         Mackie::LedState redo_release (Mackie::Button &);
 348         Mackie::LedState shift_press (Mackie::Button &);
 349         Mackie::LedState shift_release (Mackie::Button &);
 350         Mackie::LedState option_press (Mackie::Button &);
 351         Mackie::LedState option_release (Mackie::Button &);
 352         Mackie::LedState control_press (Mackie::Button &);
 353         Mackie::LedState control_release (Mackie::Button &);
 354         Mackie::LedState cmd_alt_press (Mackie::Button &);
 355         Mackie::LedState cmd_alt_release (Mackie::Button &);
 356
 357         Mackie::LedState io_press (Mackie::Button &);
 358         Mackie::LedState io_release (Mackie::Button &);
 359         Mackie::LedState sends_press (Mackie::Button &);
 360         Mackie::LedState sends_release (Mackie::Button &);
 361         Mackie::LedState pan_press (Mackie::Button &);
 362         Mackie::LedState pan_release (Mackie::Button &);
 363         Mackie::LedState plugin_press (Mackie::Button &);
 364         Mackie::LedState plugin_release (Mackie::Button &);
 365         Mackie::LedState eq_press (Mackie::Button &);
 366         Mackie::LedState eq_release (Mackie::Button &);
 367         Mackie::LedState dyn_press (Mackie::Button &);
 368         Mackie::LedState dyn_release (Mackie::Button &);
 369         Mackie::LedState flip_press (Mackie::Button &);
 370         Mackie::LedState flip_release (Mackie::Button &);
 371         Mackie::LedState edit_press (Mackie::Button &);
 372         Mackie::LedState edit_release (Mackie::Button &);
 373         Mackie::LedState name_value_press (Mackie::Button &);
 374         Mackie::LedState name_value_release (Mackie::Button &);
 375         Mackie::LedState F1_press (Mackie::Button &);
 376         Mackie::LedState F1_release (Mackie::Button &);
 377         Mackie::LedState F2_press (Mackie::Button &);
 378         Mackie::LedState F2_release (Mackie::Button &);
 379         Mackie::LedState F3_press (Mackie::Button &);
 380         Mackie::LedState F3_release (Mackie::Button &);
 381         Mackie::LedState F4_press (Mackie::Button &);
 382         Mackie::LedState F4_release (Mackie::Button &);
 383         Mackie::LedState F5_press (Mackie::Button &);
 384         Mackie::LedState F5_release (Mackie::Button &);
 385         Mackie::LedState F6_press (Mackie::Button &);
 386         Mackie::LedState F6_release (Mackie::Button &);
 387         Mackie::LedState F7_press (Mackie::Button &);
 388         Mackie::LedState F7_release (Mackie::Button &);
 389         Mackie::LedState F8_press (Mackie::Button &);
 390         Mackie::LedState F8_release (Mackie::Button &);
 391         Mackie::LedState F9_press (Mackie::Button &);
 392         Mackie::LedState F9_release (Mackie::Button &);
 393         Mackie::LedState F10_press (Mackie::Button &);
 394         Mackie::LedState F10_release (Mackie::Button &);
 395         Mackie::LedState F11_press (Mackie::Button &);
 396         Mackie::LedState F11_release (Mackie::Button &);
 397         Mackie::LedState F12_press (Mackie::Button &);
 398         Mackie::LedState F12_release (Mackie::Button &);
 399         Mackie::LedState F13_press (Mackie::Button &);
 400         Mackie::LedState F13_release (Mackie::Button &);
 401         Mackie::LedState F14_press (Mackie::Button &);
 402         Mackie::LedState F14_release (Mackie::Button &);
 403         Mackie::LedState F15_press (Mackie::Button &);
 404         Mackie::LedState F15_release (Mackie::Button &);
 405         Mackie::LedState F16_press (Mackie::Button &);
 406         Mackie::LedState F16_release (Mackie::Button &);
 407         Mackie::LedState on_press (Mackie::Button &);
 408         Mackie::LedState on_release (Mackie::Button &);
 409         Mackie::LedState rec_ready_press (Mackie::Button &);
 410         Mackie::LedState rec_ready_release (Mackie::Button &);
 411         Mackie::LedState snapshot_press (Mackie::Button &);
 412         Mackie::LedState snapshot_release (Mackie::Button &);
 413         Mackie::LedState touch_press (Mackie::Button &);
 414         Mackie::LedState touch_release (Mackie::Button &);
 415         Mackie::LedState enter_press (Mackie::Button &);
 416         Mackie::LedState enter_release (Mackie::Button &);
 417         Mackie::LedState cancel_press (Mackie::Button &);
 418         Mackie::LedState cancel_release (Mackie::Button &);
 419         Mackie::LedState mixer_press (Mackie::Button &);
 420         Mackie::LedState mixer_release (Mackie::Button &);
 421         Mackie::LedState user_a_press (Mackie::Button &);
 422         Mackie::LedState user_a_release (Mackie::Button &);
 423         Mackie::LedState user_b_press (Mackie::Button &);
 424         Mackie::LedState user_b_release (Mackie::Button &);
 425         Mackie::LedState fader_touch_press (Mackie::Button &);
 426         Mackie::LedState fader_touch_release (Mackie::Button &);
 427 };
 428
 429
 430
 431 #endif // ardour_mackie_control_protocol_h