2 Copyright (C) 2006,2007 John Anderson
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.
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.
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.
18 #ifndef ardour_mackie_control_protocol_h
19 #define ardour_mackie_control_protocol_h
26 #include <glibmm/thread.h>
28 #include "ardour/types.h"
29 #include "midi++/types.h"
31 #include "control_protocol/control_protocol.h"
32 #include "midi_byte_array.h"
34 #include "dummy_port.h"
35 #include "route_signal.h"
36 #include "mackie_button_handler.h"
37 #include "mackie_port.h"
38 #include "mackie_jog_wheel.h"
51 This handles the plugin duties, and the midi encoding and decoding,
52 and the signal callbacks, mostly from ARDOUR::Route.
54 The model of the control surface is handled by classes in controls.h
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.
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.
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.
69 class MackieControlProtocol
70 : public ARDOUR::ControlProtocol
71 , public Mackie::MackieButtonHandler
74 MackieControlProtocol( ARDOUR::Session & );
75 virtual ~MackieControlProtocol();
77 int set_active (bool yn);
79 XMLNode& get_state ();
80 int set_state (const XMLNode&, int version);
84 Mackie::Surface & surface();
87 void handle_control_event( Mackie::SurfacePort & port, Mackie::Control & control, const Mackie::ControlState & state );
89 // strip/route related stuff
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( 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::RouteList & );
105 /// Signal handler for Route::active_changed
106 void notify_active_changed( Mackie::RouteSignal * );
108 void notify_remote_id_changed();
110 /// rebuild the current bank. Called on route added/removed and
111 /// remote id changed.
112 void refresh_current_bank();
114 // global buttons (ie button not part of strips)
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( std::string const & );
121 void notify_solo_active_changed( bool );
123 /// Turn timecode on and beats off, or vice versa, depending
124 /// on state of _timecode_type
125 void update_timecode_beats_led();
127 /// this is called to generate the midi to send in response to a button press.
128 void update_led( Mackie::Button & button, Mackie::LedState );
130 void update_global_button( const std::string & name, Mackie::LedState );
131 void update_global_led( const std::string & name, Mackie::LedState );
133 // transport button handler methods from MackieButtonHandler
134 virtual Mackie::LedState frm_left_press( Mackie::Button & );
135 virtual Mackie::LedState frm_left_release( Mackie::Button & );
137 virtual Mackie::LedState frm_right_press( Mackie::Button & );
138 virtual Mackie::LedState frm_right_release( Mackie::Button & );
140 virtual Mackie::LedState stop_press( Mackie::Button & );
141 virtual Mackie::LedState stop_release( Mackie::Button & );
143 virtual Mackie::LedState play_press( Mackie::Button & );
144 virtual Mackie::LedState play_release( Mackie::Button & );
146 virtual Mackie::LedState record_press( Mackie::Button & );
147 virtual Mackie::LedState record_release( Mackie::Button & );
149 virtual Mackie::LedState loop_press( Mackie::Button & );
150 virtual Mackie::LedState loop_release( Mackie::Button & );
152 virtual Mackie::LedState punch_in_press( Mackie::Button & );
153 virtual Mackie::LedState punch_in_release( Mackie::Button & );
155 virtual Mackie::LedState punch_out_press( Mackie::Button & );
156 virtual Mackie::LedState punch_out_release( Mackie::Button & );
158 virtual Mackie::LedState home_press( Mackie::Button & );
159 virtual Mackie::LedState home_release( Mackie::Button & );
161 virtual Mackie::LedState end_press( Mackie::Button & );
162 virtual Mackie::LedState end_release( Mackie::Button & );
164 virtual Mackie::LedState rewind_press( Mackie::Button & button );
165 virtual Mackie::LedState rewind_release( Mackie::Button & button );
167 virtual Mackie::LedState ffwd_press( Mackie::Button & button );
168 virtual Mackie::LedState ffwd_release( Mackie::Button & button );
170 // bank switching button handler methods from MackieButtonHandler
171 virtual Mackie::LedState left_press( Mackie::Button & );
172 virtual Mackie::LedState left_release( Mackie::Button & );
174 virtual Mackie::LedState right_press( Mackie::Button & );
175 virtual Mackie::LedState right_release( Mackie::Button & );
177 virtual Mackie::LedState channel_left_press( Mackie::Button & );
178 virtual Mackie::LedState channel_left_release( Mackie::Button & );
180 virtual Mackie::LedState channel_right_press( Mackie::Button & );
181 virtual Mackie::LedState channel_right_release( Mackie::Button & );
183 virtual Mackie::LedState clicking_press( Mackie::Button & );
184 virtual Mackie::LedState clicking_release( Mackie::Button & );
186 virtual Mackie::LedState global_solo_press( Mackie::Button & );
187 virtual Mackie::LedState global_solo_release( Mackie::Button & );
190 virtual Mackie::LedState marker_press( Mackie::Button & );
191 virtual Mackie::LedState marker_release( Mackie::Button & );
193 virtual Mackie::LedState drop_press( Mackie::Button & );
194 virtual Mackie::LedState drop_release( Mackie::Button & );
196 virtual Mackie::LedState save_press( Mackie::Button & );
197 virtual Mackie::LedState save_release( Mackie::Button & );
199 virtual Mackie::LedState timecode_beats_press( Mackie::Button & );
200 virtual Mackie::LedState timecode_beats_release( Mackie::Button & );
203 virtual Mackie::LedState zoom_press( Mackie::Button & );
204 virtual Mackie::LedState zoom_release( Mackie::Button & );
206 virtual Mackie::LedState scrub_press( Mackie::Button & );
207 virtual Mackie::LedState scrub_release( Mackie::Button & );
209 /// This is the main MCU port, ie not an extender port
210 /// Only for use by JogWheel
211 const Mackie::SurfacePort & mcu_port() const;
212 Mackie::SurfacePort & mcu_port();
213 ARDOUR::Session & get_session() { return *session; }
216 // create instances of MackiePort, depending on what's found in ardour.rc
219 // shut down the surface
222 // create the Surface object, with the correct number
223 // of strips for the currently connected ports and
224 // hook up the control event notification
225 void initialize_surface();
227 // This sets up the notifications and sets the
228 // controls to the correct values
229 void update_surface();
231 // connects global (not strip) signals from the Session to here
232 // so the surface can be notified of changes from the other UIs.
233 void connect_session_signals();
235 // set all controls to their zero position
239 Fetch the set of routes to be considered for control by the
240 surface. Excluding master, hidden and control routes, and inactive routes
242 typedef std::vector<boost::shared_ptr<ARDOUR::Route> > Sorted;
243 Sorted get_sorted_routes();
246 void switch_banks( int initial );
250 // delete all RouteSignal objects connecting Routes to Strips
251 void clear_route_signals();
253 typedef std::vector<Mackie::RouteSignal*> RouteSignals;
254 RouteSignals route_signals;
256 // return which of the ports a particular route_table
258 Mackie::MackiePort & port_for_id( uint32_t index );
261 Handle a button press for the control and return whether
262 the corresponding light should be on or off.
264 bool handle_strip_button( Mackie::Control &, Mackie::ButtonState, boost::shared_ptr<ARDOUR::Route> );
266 /// thread started. Calls monitor_work.
267 static void* _monitor_work (void* arg);
269 /// Polling midi port(s) for incoming messages
270 void* monitor_work ();
272 /// rebuild the set of ports for this surface
275 /// Returns true if there is pending data, false otherwise
278 /// Trigger the MIDI::Parser
281 void add_port( MIDI::Port &, int number );
284 Read session data and send to surface. Includes
285 automation from the currently active routes and
288 void poll_session_data();
290 // called from poll_automation to figure out which automations need to be sent
291 void update_automation( Mackie::RouteSignal & );
293 // also called from poll_automation to update timecode display
294 void update_timecode_display();
296 std::string format_bbt_timecode (ARDOUR::nframes_t now_frame );
297 std::string format_timecode_timecode (ARDOUR::nframes_t now_frame );
300 notification that the port is about to start it's init sequence.
301 We must make sure that before this exits, the port is being polled
304 void handle_port_init( Mackie::SurfacePort * );
306 /// notification from a MackiePort that it's now active
307 void handle_port_active( Mackie::SurfacePort * );
309 /// notification from a MackiePort that it's now inactive
310 void handle_port_inactive( Mackie::SurfacePort * );
312 boost::shared_ptr<ARDOUR::Route> master_route();
313 Mackie::Strip & master_strip();
316 boost::shared_ptr<Mackie::RouteSignal> master_route_signal;
318 static const char * default_port_name;
320 /// The Midi port(s) connected to the units
321 typedef std::vector<Mackie::MackiePort*> MackiePorts;
324 /// Sometimes the real port goes away, and we want to contain the breakage
325 Mackie::DummyPort _dummy_port;
327 // the thread that polls the ports for incoming midi data
330 /// The initial remote_id of the currently switched in bank.
331 uint32_t _current_initial_bank;
333 /// protects the port list, and polling structures
334 Glib::Mutex update_mutex;
336 /// Protects set_active, and allows waiting on the poll thread
337 Glib::Cond update_cond;
339 PBD::ScopedConnectionList session_connections;
340 PBD::ScopedConnectionList port_connections;
341 PBD::ScopedConnectionList route_connections;
343 /// The representation of the physical controls on the surface.
344 Mackie::Surface * _surface;
346 /// If a port is opened or closed, this will be
347 /// true until the port configuration is updated;
354 bool _transport_previously_rolling;
356 // timer for two quick marker left presses
357 Mackie::Timer _frm_left_last;
359 Mackie::JogWheel _jog_wheel;
361 // Timer for controlling midi bandwidth used by automation polls
362 Mackie::Timer _automation_last;
364 // last written timecode string
365 std::string _timecode_last;
367 // Which timecode are we displaying? BBT or Timecode
368 ARDOUR::AnyTime::Type _timecode_type;
371 #endif // ardour_mackie_control_protocol_h