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.
19 #ifndef ardour_mackie_control_protocol_h
20 #define ardour_mackie_control_protocol_h
29 #include <boost/smart_ptr.hpp>
31 #include <glibmm/thread.h>
33 #include "pbd/abstract_ui.h"
34 #include "midi++/types.h"
35 #include "ardour/types.h"
36 #include "control_protocol/control_protocol.h"
39 #include "midi_byte_array.h"
41 #include "mackie_jog_wheel.h"
43 #include "device_info.h"
46 class AutomationControl;
61 This handles the plugin duties, and the midi encoding and decoding,
62 and the signal callbacks, mostly from ARDOUR::Route.
64 The model of the control surface is handled by classes in controls.h
66 What happens is that each strip on the control surface has
67 a corresponding route in ControlProtocol::route_table. When
68 an incoming midi message is signaled, the correct route
69 is looked up, and the relevant changes made to it.
71 For each route currently in route_table, there's a RouteSignal object
72 which encapsulates the signals that indicate that there are changes
73 to be sent to the surface. The signals are handled by this class.
75 Calls to signal handlers pass a Route object which is used to look
76 up the relevant Strip in Surface. Then the state is retrieved from
77 the Route and encoded as the correct midi message.
80 struct MackieControlUIRequest : public BaseUI::BaseRequestObject {
82 MackieControlUIRequest () {}
83 ~MackieControlUIRequest () {}
86 class MackieControlProtocol
87 : public ARDOUR::ControlProtocol
88 , public AbstractUI<MackieControlUIRequest>
91 static const int MODIFIER_OPTION;
92 static const int MODIFIER_CONTROL;
93 static const int MODIFIER_SHIFT;
94 static const int MODIFIER_CMDALT;
109 Normal, /* fader controls primary, vpot controls secondary */
110 Mirror, /* fader + vpot control secondary */
111 Swap, /* fader controls secondary, vpot controls primary */
112 Zero, /* fader controls primary, but doesn't move, vpot controls secondary */
115 MackieControlProtocol(ARDOUR::Session &);
116 virtual ~MackieControlProtocol();
118 static MackieControlProtocol* instance() { return _instance; }
120 const Mackie::DeviceInfo& device_info() const { return _device_info; }
122 int set_active (bool yn);
123 void set_device (const std::string&);
125 bool flip_mode () const { return _flip_mode; }
126 ViewMode view_mode () const { return _view_mode; }
128 void set_view_mode (ViewMode);
129 void set_flip_mode (bool);
131 XMLNode& get_state ();
132 int set_state (const XMLNode&, int version);
136 typedef std::list<boost::shared_ptr<Mackie::Surface> > Surfaces;
139 std::list<boost::shared_ptr<ARDOUR::Bundle> > bundles ();
141 void set_master_on_surface_strip (uint32_t surface, uint32_t strip);
142 void set_monitor_on_surface_strip (uint32_t surface, uint32_t strip);
144 uint32_t n_strips () const;
146 bool has_editor () const { return true; }
147 void* get_gui () const;
148 void tear_down_gui ();
150 void handle_button_event (Mackie::Surface&, Mackie::Button& button, Mackie::ButtonState);
152 void notify_route_added (ARDOUR::RouteList &);
153 void notify_remote_id_changed();
155 /// rebuild the current bank. Called on route added/removed and
156 /// remote id changed.
157 void refresh_current_bank();
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);
167 /// Turn timecode on and beats off, or vice versa, depending
168 /// on state of _timecode_type
169 void update_timecode_beats_led();
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);
174 void update_global_button (int id, Mackie::LedState);
175 void update_global_led (int id, Mackie::LedState);
177 ARDOUR::Session & get_session() { return *session; }
178 framepos_t transport_frame() const;
180 void add_in_use_timeout (Mackie::Surface& surface, Mackie::Control& in_use_control, boost::weak_ptr<ARDOUR::AutomationControl> touched);
182 int modifier_state() const { return _modifier_state; }
184 typedef std::list<boost::shared_ptr<ARDOUR::AutomationControl> > ControlList;
186 void add_down_button (ARDOUR::AutomationType, int surface, int strip);
187 void remove_down_button (ARDOUR::AutomationType, int surface, int strip);
188 ControlList down_controls (ARDOUR::AutomationType);
190 void add_down_select_button (int surface, int strip);
191 void remove_down_select_button (int surface, int strip);
192 void select_range ();
194 std::string f_action (uint32_t fn, uint32_t modifier = 0);
197 // shut down the surface
200 // This sets up the notifications and sets the
201 // controls to the correct values
202 void update_surfaces();
204 // connects global (not strip) signals from the Session to here
205 // so the surface can be notified of changes from the other UIs.
206 void connect_session_signals();
208 // set all controls to their zero position
212 Fetch the set of routes to be considered for control by the
213 surface. Excluding master, hidden and control routes, and inactive routes
215 typedef std::vector<boost::shared_ptr<ARDOUR::Route> > Sorted;
216 Sorted get_sorted_routes();
219 void switch_banks (uint32_t first_remote_id, bool force = false);
223 // also called from poll_automation to update timecode display
224 void update_timecode_display();
226 std::string format_bbt_timecode (ARDOUR::framepos_t now_frame);
227 std::string format_timecode_timecode (ARDOUR::framepos_t now_frame);
229 void do_request (MackieControlUIRequest*);
234 /* handling function key presses */
236 void f_press (uint32_t fn);
240 struct ButtonHandlers {
241 Mackie::LedState (MackieControlProtocol::*press) (Mackie::Button&);
242 Mackie::LedState (MackieControlProtocol::*release) (Mackie::Button&);
244 ButtonHandlers (Mackie::LedState (MackieControlProtocol::*p) (Mackie::Button&),
245 Mackie::LedState (MackieControlProtocol::*r) (Mackie::Button&))
250 typedef std::map<Mackie::Button::ID,ButtonHandlers> ButtonMap;
251 typedef std::list<GSource*> PortSources;
253 static MackieControlProtocol* _instance;
255 Mackie::DeviceInfo _device_info;
256 sigc::connection periodic_connection;
257 uint32_t _current_initial_bank;
258 PBD::ScopedConnectionList audio_engine_connections;
259 PBD::ScopedConnectionList session_connections;
260 PBD::ScopedConnectionList port_connections;
261 PBD::ScopedConnectionList route_connections;
262 PBD::ScopedConnectionList gui_connections;
263 bool _transport_previously_rolling;
264 // timer for two quick marker left presses
265 Mackie::Timer _frm_left_last;
266 // last written timecode string
267 std::string _timecode_last;
268 // Which timecode are we displaying? BBT or Timecode
269 ARDOUR::AnyTime::Type _timecode_type;
270 // Bundle to represent our input ports
271 boost::shared_ptr<ARDOUR::Bundle> _input_bundle;
272 // Bundle to represent our output ports
273 boost::shared_ptr<ARDOUR::Bundle> _output_bundle;
279 int _current_selected_track;
281 PortSources port_sources;
282 std::vector<std::string> _f_actions;
283 ButtonMap button_map;
285 void create_surfaces ();
286 void port_connected_or_disconnected (std::string, std::string, bool);
287 bool control_in_use_timeout (Mackie::Surface*, Mackie::Control *, boost::weak_ptr<ARDOUR::AutomationControl>);
290 bool midi_input_handler (Glib::IOCondition ioc, MIDI::Port* port);
292 void force_special_route_to_strip (boost::shared_ptr<ARDOUR::Route> r, uint32_t surface, uint32_t strip_number);
293 void build_button_map ();
295 void gui_track_selection_changed (ARDOUR::RouteNotificationListPtr);
298 /* BUTTON HANDLING */
300 typedef std::set<uint32_t> DownButtonList;
301 typedef std::map<ARDOUR::AutomationType,DownButtonList> DownButtonMap;
302 DownButtonMap _down_buttons;
303 DownButtonList _down_select_buttons;
305 void pull_route_range (DownButtonList&, ARDOUR::RouteList&);
307 /* implemented button handlers */
308 Mackie::LedState frm_left_press(Mackie::Button &);
309 Mackie::LedState frm_left_release(Mackie::Button &);
310 Mackie::LedState frm_right_press(Mackie::Button &);
311 Mackie::LedState frm_right_release(Mackie::Button &);
312 Mackie::LedState stop_press(Mackie::Button &);
313 Mackie::LedState stop_release(Mackie::Button &);
314 Mackie::LedState play_press(Mackie::Button &);
315 Mackie::LedState play_release(Mackie::Button &);
316 Mackie::LedState record_press(Mackie::Button &);
317 Mackie::LedState record_release(Mackie::Button &);
318 Mackie::LedState loop_press(Mackie::Button &);
319 Mackie::LedState loop_release(Mackie::Button &);
320 Mackie::LedState punch_in_press(Mackie::Button &);
321 Mackie::LedState punch_in_release(Mackie::Button &);
322 Mackie::LedState punch_out_press(Mackie::Button &);
323 Mackie::LedState punch_out_release(Mackie::Button &);
324 Mackie::LedState home_press(Mackie::Button &);
325 Mackie::LedState home_release(Mackie::Button &);
326 Mackie::LedState end_press(Mackie::Button &);
327 Mackie::LedState end_release(Mackie::Button &);
328 Mackie::LedState rewind_press(Mackie::Button & button);
329 Mackie::LedState rewind_release(Mackie::Button & button);
330 Mackie::LedState ffwd_press(Mackie::Button & button);
331 Mackie::LedState ffwd_release(Mackie::Button & button);
332 Mackie::LedState cursor_up_press (Mackie::Button &);
333 Mackie::LedState cursor_up_release (Mackie::Button &);
334 Mackie::LedState cursor_down_press (Mackie::Button &);
335 Mackie::LedState cursor_down_release (Mackie::Button &);
336 Mackie::LedState cursor_left_press (Mackie::Button &);
337 Mackie::LedState cursor_left_release (Mackie::Button &);
338 Mackie::LedState cursor_right_press (Mackie::Button &);
339 Mackie::LedState cursor_right_release (Mackie::Button &);
340 Mackie::LedState left_press(Mackie::Button &);
341 Mackie::LedState left_release(Mackie::Button &);
342 Mackie::LedState right_press(Mackie::Button &);
343 Mackie::LedState right_release(Mackie::Button &);
344 Mackie::LedState channel_left_press(Mackie::Button &);
345 Mackie::LedState channel_left_release(Mackie::Button &);
346 Mackie::LedState channel_right_press(Mackie::Button &);
347 Mackie::LedState channel_right_release(Mackie::Button &);
348 Mackie::LedState clicking_press(Mackie::Button &);
349 Mackie::LedState clicking_release(Mackie::Button &);
350 Mackie::LedState global_solo_press(Mackie::Button &);
351 Mackie::LedState global_solo_release(Mackie::Button &);
352 Mackie::LedState marker_press(Mackie::Button &);
353 Mackie::LedState marker_release(Mackie::Button &);
354 Mackie::LedState drop_press(Mackie::Button &);
355 Mackie::LedState drop_release(Mackie::Button &);
356 Mackie::LedState save_press(Mackie::Button &);
357 Mackie::LedState save_release(Mackie::Button &);
358 Mackie::LedState timecode_beats_press(Mackie::Button &);
359 Mackie::LedState timecode_beats_release(Mackie::Button &);
360 Mackie::LedState zoom_press(Mackie::Button &);
361 Mackie::LedState zoom_release(Mackie::Button &);
362 Mackie::LedState scrub_press(Mackie::Button &);
363 Mackie::LedState scrub_release(Mackie::Button &);
364 Mackie::LedState undo_press (Mackie::Button &);
365 Mackie::LedState undo_release (Mackie::Button &);
366 Mackie::LedState redo_press (Mackie::Button &);
367 Mackie::LedState redo_release (Mackie::Button &);
368 Mackie::LedState shift_press (Mackie::Button &);
369 Mackie::LedState shift_release (Mackie::Button &);
370 Mackie::LedState option_press (Mackie::Button &);
371 Mackie::LedState option_release (Mackie::Button &);
372 Mackie::LedState control_press (Mackie::Button &);
373 Mackie::LedState control_release (Mackie::Button &);
374 Mackie::LedState cmd_alt_press (Mackie::Button &);
375 Mackie::LedState cmd_alt_release (Mackie::Button &);
377 Mackie::LedState io_press (Mackie::Button &);
378 Mackie::LedState io_release (Mackie::Button &);
379 Mackie::LedState sends_press (Mackie::Button &);
380 Mackie::LedState sends_release (Mackie::Button &);
381 Mackie::LedState pan_press (Mackie::Button &);
382 Mackie::LedState pan_release (Mackie::Button &);
383 Mackie::LedState plugin_press (Mackie::Button &);
384 Mackie::LedState plugin_release (Mackie::Button &);
385 Mackie::LedState eq_press (Mackie::Button &);
386 Mackie::LedState eq_release (Mackie::Button &);
387 Mackie::LedState dyn_press (Mackie::Button &);
388 Mackie::LedState dyn_release (Mackie::Button &);
389 Mackie::LedState flip_press (Mackie::Button &);
390 Mackie::LedState flip_release (Mackie::Button &);
391 Mackie::LedState edit_press (Mackie::Button &);
392 Mackie::LedState edit_release (Mackie::Button &);
393 Mackie::LedState name_value_press (Mackie::Button &);
394 Mackie::LedState name_value_release (Mackie::Button &);
395 Mackie::LedState F1_press (Mackie::Button &);
396 Mackie::LedState F1_release (Mackie::Button &);
397 Mackie::LedState F2_press (Mackie::Button &);
398 Mackie::LedState F2_release (Mackie::Button &);
399 Mackie::LedState F3_press (Mackie::Button &);
400 Mackie::LedState F3_release (Mackie::Button &);
401 Mackie::LedState F4_press (Mackie::Button &);
402 Mackie::LedState F4_release (Mackie::Button &);
403 Mackie::LedState F5_press (Mackie::Button &);
404 Mackie::LedState F5_release (Mackie::Button &);
405 Mackie::LedState F6_press (Mackie::Button &);
406 Mackie::LedState F6_release (Mackie::Button &);
407 Mackie::LedState F7_press (Mackie::Button &);
408 Mackie::LedState F7_release (Mackie::Button &);
409 Mackie::LedState F8_press (Mackie::Button &);
410 Mackie::LedState F8_release (Mackie::Button &);
411 Mackie::LedState F9_press (Mackie::Button &);
412 Mackie::LedState F9_release (Mackie::Button &);
413 Mackie::LedState F10_press (Mackie::Button &);
414 Mackie::LedState F10_release (Mackie::Button &);
415 Mackie::LedState F11_press (Mackie::Button &);
416 Mackie::LedState F11_release (Mackie::Button &);
417 Mackie::LedState F12_press (Mackie::Button &);
418 Mackie::LedState F12_release (Mackie::Button &);
419 Mackie::LedState F13_press (Mackie::Button &);
420 Mackie::LedState F13_release (Mackie::Button &);
421 Mackie::LedState F14_press (Mackie::Button &);
422 Mackie::LedState F14_release (Mackie::Button &);
423 Mackie::LedState F15_press (Mackie::Button &);
424 Mackie::LedState F15_release (Mackie::Button &);
425 Mackie::LedState F16_press (Mackie::Button &);
426 Mackie::LedState F16_release (Mackie::Button &);
427 Mackie::LedState on_press (Mackie::Button &);
428 Mackie::LedState on_release (Mackie::Button &);
429 Mackie::LedState rec_ready_press (Mackie::Button &);
430 Mackie::LedState rec_ready_release (Mackie::Button &);
431 Mackie::LedState snapshot_press (Mackie::Button &);
432 Mackie::LedState snapshot_release (Mackie::Button &);
433 Mackie::LedState touch_press (Mackie::Button &);
434 Mackie::LedState touch_release (Mackie::Button &);
435 Mackie::LedState enter_press (Mackie::Button &);
436 Mackie::LedState enter_release (Mackie::Button &);
437 Mackie::LedState cancel_press (Mackie::Button &);
438 Mackie::LedState cancel_release (Mackie::Button &);
439 Mackie::LedState mixer_press (Mackie::Button &);
440 Mackie::LedState mixer_release (Mackie::Button &);
441 Mackie::LedState user_a_press (Mackie::Button &);
442 Mackie::LedState user_a_release (Mackie::Button &);
443 Mackie::LedState user_b_press (Mackie::Button &);
444 Mackie::LedState user_b_release (Mackie::Button &);
445 Mackie::LedState fader_touch_press (Mackie::Button &);
446 Mackie::LedState fader_touch_release (Mackie::Button &);
451 #endif // ardour_mackie_control_protocol_h