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