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 #ifndef ardour_mackie_control_protocol_h
  19 #define ardour_mackie_control_protocol_h
  20
  21 #include <vector>
  22
  23 #include <sys/time.h>
  24 #include <pthread.h>
  25
  26 #include <glibmm/thread.h>
  27
  28 #include <ardour/types.h>
  29 #include <ardour/session.h>
  30 #include <midi++/types.h>
  31
  32 #include <control_protocol/control_protocol.h>
  33 #include "midi_byte_array.h"
  34 #include "controls.h"
  35 #include "route_signal.h"
  36 #include "mackie_button_handler.h"
  37 #include "mackie_port.h"
  38 #include "mackie_jog_wheel.h"
  39 #include "timer.h"
  40
  41 namespace MIDI {
  42         class Port;
  43         class Parser;
  44 }
  45
  46 namespace Mackie {
  47         class Surface;
  48 }
  49
  50 /**
  51         This handles the plugin duties, and the midi encoding and decoding,
  52         and the signal callbacks, mostly from ARDOUR::Route.
  53
  54         The model of the control surface is handled by classes in controls.h
  55
  56         What happens is that each strip on the control surface has
  57         a corresponding route in ControlProtocol::route_table. When
  58         an incoming midi message is signaled, the correct route
  59         is looked up, and the relevant changes made to it.
  60
  61         For each route currently in route_table, there's a RouteSignal object
  62         which encapsulates the signals that indicate that there are changes
  63         to be sent to the surface. The signals are handled by this class.
  64
  65         Calls to signal handlers pass a Route object which is used to look
  66         up the relevant Strip in Surface. Then the state is retrieved from
  67         the Route and encoded as the correct midi message.
  68 */
  69 class MackieControlProtocol
  70 : public ARDOUR::ControlProtocol
  71 , public Mackie::MackieButtonHandler
  72 {
  73   public:
  74         MackieControlProtocol( ARDOUR::Session & );
  75         virtual ~MackieControlProtocol();
  76
  77         int set_active (bool yn);
  78
  79         XMLNode& get_state ();
  80         int set_state (const XMLNode&);
  81
  82         static bool probe();
  83
  84         Mackie::Surface & surface();
  85
  86    // control events
  87    void handle_control_event( Mackie::SurfacePort & port, Mackie::Control & control, const Mackie::ControlState & state );
  88
  89   // strip/route related stuff
  90   public:
  91         /// Signal handler for Route::solo
  92         void notify_solo_changed( Mackie::RouteSignal * );
  93         /// Signal handler for Route::mute
  94         void notify_mute_changed( Mackie::RouteSignal * );
  95         /// Signal handler for Route::record_enable_changed
  96         void notify_record_enable_changed( Mackie::RouteSignal * );
  97         /// Signal handler for Route::gain_changed ( from IO )
  98         void notify_gain_changed( Mackie::RouteSignal *, bool force_update = true );
  99         /// Signal handler for Route::name_change
 100         void notify_name_changed( void *, Mackie::RouteSignal * );
 101         /// Signal handler from Panner::Change
 102         void notify_panner_changed( Mackie::RouteSignal *, bool force_update = true );
 103         /// Signal handler for new routes added
 104         void notify_route_added( ARDOUR::Session::RouteList & );
 105         /// Signal handler for Route::active_changed
 106         void notify_active_changed( Mackie::RouteSignal * );
 107
 108         void notify_remote_id_changed();
 109
 110         /// rebuild the current bank. Called on route added/removed and
 111    /// remote id changed.
 112         void refresh_current_bank();
 113
 114   // global buttons (ie button not part of strips)
 115   public:
 116    // button-related signals
 117         void notify_record_state_changed();
 118    void notify_transport_state_changed();
 119    // mainly to pick up punch-in and punch-out
 120         void notify_parameter_changed( const char * );
 121    void notify_solo_active_changed( bool );
 122
 123         // this is called to generate the midi to send in response to
 124    // a button press.
 125         void update_led( Mackie::Button & button, Mackie::LedState );
 126
 127         // calls update_led, but looks up the button by name
 128         void update_global_button( const std::string & name, Mackie::LedState );
 129
 130    // transport button handler methods from MackieButtonHandler
 131         virtual Mackie::LedState frm_left_press( Mackie::Button & );
 132         virtual Mackie::LedState frm_left_release( Mackie::Button & );
 133
 134         virtual Mackie::LedState frm_right_press( Mackie::Button & );
 135         virtual Mackie::LedState frm_right_release( Mackie::Button & );
 136
 137         virtual Mackie::LedState stop_press( Mackie::Button & );
 138         virtual Mackie::LedState stop_release( Mackie::Button & );
 139
 140         virtual Mackie::LedState play_press( Mackie::Button & );
 141         virtual Mackie::LedState play_release( Mackie::Button & );
 142
 143         virtual Mackie::LedState record_press( Mackie::Button & );
 144         virtual Mackie::LedState record_release( Mackie::Button & );
 145
 146         virtual Mackie::LedState loop_press( Mackie::Button & );
 147         virtual Mackie::LedState loop_release( Mackie::Button & );
 148
 149         virtual Mackie::LedState punch_in_press( Mackie::Button & );
 150         virtual Mackie::LedState punch_in_release( Mackie::Button & );
 151
 152         virtual Mackie::LedState punch_out_press( Mackie::Button & );
 153         virtual Mackie::LedState punch_out_release( Mackie::Button & );
 154
 155         virtual Mackie::LedState home_press( Mackie::Button & );
 156         virtual Mackie::LedState home_release( Mackie::Button & );
 157
 158         virtual Mackie::LedState end_press( Mackie::Button & );
 159         virtual Mackie::LedState end_release( Mackie::Button & );
 160
 161         virtual Mackie::LedState rewind_press( Mackie::Button & button );
 162         virtual Mackie::LedState rewind_release( Mackie::Button & button );
 163
 164         virtual Mackie::LedState ffwd_press( Mackie::Button & button );
 165         virtual Mackie::LedState ffwd_release( Mackie::Button & button );
 166
 167         // bank switching button handler methods from MackieButtonHandler
 168         virtual Mackie::LedState left_press( Mackie::Button & );
 169         virtual Mackie::LedState left_release( Mackie::Button & );
 170
 171         virtual Mackie::LedState right_press( Mackie::Button & );
 172         virtual Mackie::LedState right_release( Mackie::Button & );
 173
 174         virtual Mackie::LedState channel_left_press( Mackie::Button & );
 175         virtual Mackie::LedState channel_left_release( Mackie::Button & );
 176
 177         virtual Mackie::LedState channel_right_press( Mackie::Button & );
 178         virtual Mackie::LedState channel_right_release( Mackie::Button & );
 179
 180         virtual Mackie::LedState clicking_press( Mackie::Button & );
 181         virtual Mackie::LedState clicking_release( Mackie::Button & );
 182
 183         virtual Mackie::LedState global_solo_press( Mackie::Button & );
 184         virtual Mackie::LedState global_solo_release( Mackie::Button & );
 185
 186         // function buttons
 187         virtual Mackie::LedState marker_press( Mackie::Button & );
 188         virtual Mackie::LedState marker_release( Mackie::Button & );
 189
 190         virtual Mackie::LedState drop_press( Mackie::Button & );
 191         virtual Mackie::LedState drop_release( Mackie::Button & );
 192
 193         virtual Mackie::LedState save_press( Mackie::Button & );
 194         virtual Mackie::LedState save_release( Mackie::Button & );
 195
 196         // jog wheel states
 197         virtual Mackie::LedState zoom_press( Mackie::Button & );
 198         virtual Mackie::LedState zoom_release( Mackie::Button & );
 199
 200         virtual Mackie::LedState scrub_press( Mackie::Button & );
 201         virtual Mackie::LedState scrub_release( Mackie::Button & );
 202
 203    /// This is the main MCU port, ie not an extender port
 204         /// Only for use by JogWheel
 205         const Mackie::MackiePort & mcu_port() const;
 206         Mackie::MackiePort & mcu_port();
 207         ARDOUR::Session & get_session() { return *session; }
 208
 209   protected:
 210         // create instances of MackiePort, depending on what's found in ardour.rc
 211         void create_ports();
 212
 213         // shut down the surface
 214         void close();
 215
 216         // create the Surface object, with the correct number
 217         // of strips for the currently connected ports and
 218         // hook up the control event notification
 219         void initialize_surface();
 220
 221         // This sets up the notifications and sets the
 222    // controls to the correct values
 223         void update_surface();
 224
 225    // connects global (not strip) signals from the Session to here
 226    // so the surface can be notified of changes from the other UIs.
 227    void connect_session_signals();
 228
 229    // set all controls to their zero position
 230         void zero_all();
 231
 232         /**
 233                 Fetch the set of routes to be considered for control by the
 234                 surface. Excluding master, hidden and control routes, and inactive routes
 235         */
 236         typedef std::vector<boost::shared_ptr<ARDOUR::Route> > Sorted;
 237         Sorted get_sorted_routes();
 238
 239    // bank switching
 240    void switch_banks( int initial );
 241    void prev_track();
 242    void next_track();
 243
 244    // delete all RouteSignal objects connecting Routes to Strips
 245    void clear_route_signals();
 246
 247         typedef std::vector<Mackie::RouteSignal*> RouteSignals;
 248         RouteSignals route_signals;
 249
 250    // return which of the ports a particular route_table
 251    // index belongs to
 252         Mackie::MackiePort & port_for_id( uint32_t index );
 253
 254         /**
 255                 Handle a button press for the control and return whether
 256                 the corresponding light should be on or off.
 257         */
 258         bool handle_strip_button( Mackie::Control &, Mackie::ButtonState, boost::shared_ptr<ARDOUR::Route> );
 259
 260         /// thread started. Calls monitor_work.
 261         static void* _monitor_work (void* arg);
 262
 263         /// Polling midi port(s) for incoming messages
 264         void* monitor_work ();
 265
 266         /// rebuild the set of ports for this surface
 267         void update_ports();
 268
 269         /// Returns true if there is pending data, false otherwise
 270         bool poll_ports();
 271
 272         /// Trigger the MIDI::Parser
 273         void read_ports();
 274
 275         void add_port( MIDI::Port &, int number );
 276
 277         /// read automation data from the currently active routes and send to surface
 278         void poll_automation();
 279
 280         // called from poll_automation to figure out which automations need to be sent
 281         void update_automation( Mackie::RouteSignal & );
 282
 283         /**
 284                 notification that the port is about to start it's init sequence.
 285                 We must make sure that before this exits, the port is being polled
 286                 for new data.
 287         */
 288         void handle_port_init( Mackie::SurfacePort * );
 289
 290         /// notification from a MackiePort that it's now active
 291         void handle_port_active( Mackie::SurfacePort * );
 292
 293         /// notification from a MackiePort that it's now inactive
 294         void handle_port_inactive( Mackie::SurfacePort * );
 295
 296         boost::shared_ptr<ARDOUR::Route> master_route();
 297         Mackie::Strip & master_strip();
 298
 299   private:
 300         boost::shared_ptr<Mackie::RouteSignal> master_route_signal;
 301
 302    static const char * default_port_name;
 303
 304         /// The Midi port(s) connected to the units
 305         typedef vector<Mackie::MackiePort*> MackiePorts;
 306         MackiePorts _ports;
 307
 308    // the thread that polls the ports for incoming midi data
 309         pthread_t thread;
 310
 311         /// The initial remote_id of the currently switched in bank.
 312    uint32_t _current_initial_bank;
 313
 314    /// protects the port list, and polling structures
 315         Glib::Mutex update_mutex;
 316
 317         /// Protects set_active, and allows waiting on the poll thread
 318         Glib::Cond update_cond;
 319
 320         // because sigc::trackable doesn't seem to be working
 321         std::vector<sigc::connection> _connections;
 322         std::back_insert_iterator<std::vector<sigc::connection> > connections_back;
 323
 324    /// The representation of the physical controls on the surface.
 325         Mackie::Surface * _surface;
 326
 327         /// If a port is opened or closed, this will be
 328         /// true until the port configuration is updated;
 329         bool _ports_changed;
 330
 331         bool _polling;
 332         struct pollfd * pfd;
 333         int nfds;
 334
 335         bool _transport_previously_rolling;
 336
 337         // timer for two quick marker left presses
 338         Mackie::Timer _frm_left_last;
 339
 340         Mackie::JogWheel _jog_wheel;
 341
 342         // Timer for controlling midi bandwidth used by automation polls
 343         Mackie::Timer _automation_last;
 344 };
 345
 346 #endif // ardour_mackie_control_protocol_h