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 #define ABSTRACT_UI_EXPORTS
32 #include "pbd/abstract_ui.h"
33 #include "midi++/types.h"
34 #include "ardour/types.h"
35 #include "control_protocol/control_protocol.h"
38 #include "midi_byte_array.h"
40 #include "jog_wheel.h"
42 #include "device_info.h"
43 #include "device_profile.h"
46 class AutomationControl;
54 namespace ArdourSurface {
64 gboolean ipmidi_input_handler (GIOChannel*, GIOCondition condition, void *data);
67 This handles the plugin duties, and the midi encoding and decoding,
68 and the signal callbacks, mostly from ARDOUR::Route.
70 The model of the control surface is handled by classes in controls.h
72 What happens is that each strip on the control surface has
73 a corresponding route in ControlProtocol::route_table. When
74 an incoming midi message is signaled, the correct route
75 is looked up, and the relevant changes made to it.
77 For each route currently in route_table, there's a RouteSignal object
78 which encapsulates the signals that indicate that there are changes
79 to be sent to the surface. The signals are handled by this class.
81 Calls to signal handlers pass a Route object which is used to look
82 up the relevant Strip in Surface. Then the state is retrieved from
83 the Route and encoded as the correct midi message.
86 struct MackieControlUIRequest : public BaseUI::BaseRequestObject {
88 MackieControlUIRequest () {}
89 ~MackieControlUIRequest () {}
92 class MackieControlProtocol
93 : public ARDOUR::ControlProtocol
94 , public AbstractUI<MackieControlUIRequest>
97 static const int MODIFIER_OPTION;
98 static const int MODIFIER_CONTROL;
99 static const int MODIFIER_SHIFT;
100 static const int MODIFIER_CMDALT;
101 static const int MODIFIER_ZOOM;
102 static const int MODIFIER_SCRUB;
103 static const int MODIFIER_MARKER;
104 static const int MODIFIER_NUDGE;
105 static const int MAIN_MODIFIER_MASK;
127 Normal, /* fader controls primary, vpot controls secondary */
128 Mirror, /* fader + vpot control secondary */
129 Swap, /* fader controls secondary, vpot controls primary */
130 Zero, /* fader controls primary, but doesn't move, vpot controls secondary */
133 MackieControlProtocol(ARDOUR::Session &);
134 virtual ~MackieControlProtocol();
136 static MackieControlProtocol* instance() { return _instance; }
138 const Mackie::DeviceInfo& device_info() const { return _device_info; }
139 Mackie::DeviceProfile& device_profile() { return _device_profile; }
141 PBD::Signal0<void> DeviceChanged;
142 PBD::Signal1<void,boost::shared_ptr<Mackie::Surface> > ConnectionChange;
144 void device_ready ();
146 int set_active (bool yn);
147 int set_device (const std::string&, bool force);
148 void set_profile (const std::string&);
150 FlipMode flip_mode () const { return _flip_mode; }
151 ViewMode view_mode () const { return _view_mode; }
152 SubViewMode subview_mode () const { return _subview_mode; }
153 static bool subview_mode_would_be_ok (SubViewMode, boost::shared_ptr<ARDOUR::Route>);
154 boost::shared_ptr<ARDOUR::Route> subview_route() const;
155 bool zoom_mode () const { return modifier_state() & MODIFIER_ZOOM; }
156 bool metering_active () const { return _metering_active; }
158 bool is_track (boost::shared_ptr<ARDOUR::Route>) const;
159 bool is_audio_track (boost::shared_ptr<ARDOUR::Route>) const;
160 bool is_midi_track (boost::shared_ptr<ARDOUR::Route>) const;
161 bool selected (boost::shared_ptr<ARDOUR::Route>) const;
162 bool is_hidden (boost::shared_ptr<ARDOUR::Route>) const;
163 bool is_mapped (boost::shared_ptr<ARDOUR::Route>) const;
164 boost::shared_ptr<ARDOUR::Route> first_selected_route () const;
166 void check_fader_automation_state ();
167 void update_fader_automation_state ();
168 void set_automation_state (ARDOUR::AutoState);
170 void set_view_mode (ViewMode);
171 int set_subview_mode (SubViewMode, boost::shared_ptr<ARDOUR::Route>);
172 void set_flip_mode (FlipMode);
173 void display_view_mode ();
175 XMLNode& get_state ();
176 int set_state (const XMLNode&, int version);
178 /* Note: because Mackie control is inherently a duplex protocol,
179 we do not implement get/set_feedback() since this aspect of
180 support for the protocol is not optional.
184 static void* request_factory (uint32_t);
186 mutable Glib::Threads::Mutex surfaces_lock;
187 typedef std::list<boost::shared_ptr<Mackie::Surface> > Surfaces;
190 boost::shared_ptr<Mackie::Surface> get_surface_by_raw_pointer (void*) const;
191 boost::shared_ptr<Mackie::Surface> nth_surface (uint32_t) const;
193 uint32_t global_index (Mackie::Strip&);
195 std::list<boost::shared_ptr<ARDOUR::Bundle> > bundles ();
197 void set_master_on_surface_strip (uint32_t surface, uint32_t strip);
198 void set_monitor_on_surface_strip (uint32_t surface, uint32_t strip);
200 uint32_t n_strips (bool with_locked_strips = true) const;
202 bool has_editor () const { return true; }
203 void* get_gui () const;
204 void tear_down_gui ();
206 void handle_button_event (Mackie::Surface&, Mackie::Button& button, Mackie::ButtonState);
208 void notify_subview_route_deleted ();
209 void notify_route_added_or_removed ();
210 void notify_route_added (ARDOUR::RouteList &);
211 void notify_remote_id_changed();
213 void recalibrate_faders ();
214 void toggle_backlight ();
215 void set_touch_sensitivity (int);
217 /// rebuild the current bank. Called on route added/removed and
218 /// remote id changed.
219 void refresh_current_bank();
221 // button-related signals
222 void notify_record_state_changed();
223 void notify_transport_state_changed();
224 void notify_loop_state_changed();
225 void notify_metering_state_changed();
226 // mainly to pick up punch-in and punch-out
227 void notify_parameter_changed(std::string const &);
228 void notify_solo_active_changed(bool);
230 /// Turn timecode on and beats off, or vice versa, depending
231 /// on state of _timecode_type
232 void update_timecode_beats_led();
234 /// this is called to generate the midi to send in response to a button press.
235 void update_led(Mackie::Surface&, Mackie::Button & button, Mackie::LedState);
237 void update_global_button (int id, Mackie::LedState);
238 void update_global_led (int id, Mackie::LedState);
240 ARDOUR::Session & get_session() { return *session; }
241 framepos_t transport_frame() const;
243 int modifier_state() const { return _modifier_state; }
244 int main_modifier_state() const { return _modifier_state & MAIN_MODIFIER_MASK; }
246 typedef std::list<boost::shared_ptr<ARDOUR::AutomationControl> > ControlList;
248 void add_down_button (ARDOUR::AutomationType, int surface, int strip);
249 void remove_down_button (ARDOUR::AutomationType, int surface, int strip);
250 ControlList down_controls (ARDOUR::AutomationType);
252 void add_down_select_button (int surface, int strip);
253 void remove_down_select_button (int surface, int strip);
254 void select_range ();
256 int16_t ipmidi_base() const { return _ipmidi_base; }
257 void set_ipmidi_base (int16_t);
259 void ping_devices ();
262 // shut down the surface
265 // This sets up the notifications and sets the
266 // controls to the correct values
267 void update_surfaces();
269 // connects global (not strip) signals from the Session to here
270 // so the surface can be notified of changes from the other UIs.
271 void connect_session_signals();
273 // set all controls to their zero position
277 Fetch the set of routes to be considered for control by the
278 surface. Excluding master, hidden and control routes, and inactive routes
280 typedef std::vector<boost::shared_ptr<ARDOUR::Route> > Sorted;
281 Sorted get_sorted_routes();
284 int switch_banks (uint32_t first_remote_id, bool force = false);
288 // also called from poll_automation to update timecode display
289 void update_timecode_display();
291 std::string format_bbt_timecode (ARDOUR::framepos_t now_frame);
292 std::string format_timecode_timecode (ARDOUR::framepos_t now_frame);
294 void do_request (MackieControlUIRequest*);
299 bool route_is_locked_to_strip (boost::shared_ptr<ARDOUR::Route>) const;
303 struct ButtonHandlers {
304 Mackie::LedState (MackieControlProtocol::*press) (Mackie::Button&);
305 Mackie::LedState (MackieControlProtocol::*release) (Mackie::Button&);
307 ButtonHandlers (Mackie::LedState (MackieControlProtocol::*p) (Mackie::Button&),
308 Mackie::LedState (MackieControlProtocol::*r) (Mackie::Button&))
313 typedef std::map<Mackie::Button::ID,ButtonHandlers> ButtonMap;
315 static MackieControlProtocol* _instance;
317 Mackie::DeviceInfo _device_info;
318 Mackie::DeviceProfile _device_profile;
319 sigc::connection periodic_connection;
320 sigc::connection redisplay_connection;
321 sigc::connection hui_connection;
322 uint32_t _current_initial_bank;
323 PBD::ScopedConnectionList audio_engine_connections;
324 PBD::ScopedConnectionList session_connections;
325 PBD::ScopedConnectionList route_connections;
326 PBD::ScopedConnectionList subview_route_connections;
327 PBD::ScopedConnectionList gui_connections;
328 PBD::ScopedConnectionList fader_automation_connections;
329 // timer for two quick marker left presses
330 Mackie::Timer _frm_left_last;
331 // last written timecode string
332 std::string _timecode_last;
333 framepos_t _frame_last;
334 // Which timecode are we displaying? BBT or Timecode
335 ARDOUR::AnyTime::Type _timecode_type;
336 // Bundle to represent our input ports
337 boost::shared_ptr<ARDOUR::Bundle> _input_bundle;
338 // Bundle to represent our output ports
339 boost::shared_ptr<ARDOUR::Bundle> _output_bundle;
344 SubViewMode _subview_mode;
345 boost::shared_ptr<ARDOUR::Route> _subview_route;
346 int _current_selected_track;
348 ButtonMap button_map;
349 int16_t _ipmidi_base;
350 bool needs_ipmidi_restart;
351 bool _metering_active;
353 ARDOUR::RouteNotificationList _last_selected_routes;
354 XMLNode* configuration_state;
357 bool marker_modifier_consumed_by_button;
358 bool nudge_modifier_consumed_by_button;
360 boost::shared_ptr<ArdourSurface::Mackie::Surface> _master_surface;
362 struct ipMIDIHandler {
363 MackieControlProtocol* mcp;
366 friend struct ipMIDIHandler; /* is this necessary */
367 friend gboolean ArdourSurface::ipmidi_input_handler (GIOChannel*, GIOCondition condition, void *data);
369 int create_surfaces ();
372 bool redisplay_subview_mode ();
373 bool hui_heartbeat ();
375 bool midi_input_handler (Glib::IOCondition ioc, MIDI::Port* port);
377 void clear_surfaces ();
378 void force_special_route_to_strip (boost::shared_ptr<ARDOUR::Route> r, uint32_t surface, uint32_t strip_number);
379 void build_button_map ();
380 void gui_track_selection_changed (ARDOUR::RouteNotificationListPtr, bool save_list);
381 void _gui_track_selection_changed (ARDOUR::RouteNotificationList*, bool save_list, bool gui_did_change);
382 int ipmidi_restart ();
384 int set_device_info (const std::string& device_name);
385 void update_configuration_state ();
387 /* MIDI port connection management */
389 PBD::ScopedConnection port_connection;
390 void connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool);
392 /* BUTTON HANDLING */
394 typedef std::set<uint32_t> DownButtonList;
395 typedef std::map<ARDOUR::AutomationType,DownButtonList> DownButtonMap;
396 DownButtonMap _down_buttons;
397 DownButtonList _down_select_buttons;
399 void pull_route_range (DownButtonList&, ARDOUR::RouteList&);
401 /* implemented button handlers */
402 Mackie::LedState stop_press(Mackie::Button &);
403 Mackie::LedState stop_release(Mackie::Button &);
404 Mackie::LedState play_press(Mackie::Button &);
405 Mackie::LedState play_release(Mackie::Button &);
406 Mackie::LedState record_press(Mackie::Button &);
407 Mackie::LedState record_release(Mackie::Button &);
408 Mackie::LedState loop_press(Mackie::Button &);
409 Mackie::LedState loop_release(Mackie::Button &);
410 Mackie::LedState rewind_press(Mackie::Button & button);
411 Mackie::LedState rewind_release(Mackie::Button & button);
412 Mackie::LedState ffwd_press(Mackie::Button & button);
413 Mackie::LedState ffwd_release(Mackie::Button & button);
414 Mackie::LedState cursor_up_press (Mackie::Button &);
415 Mackie::LedState cursor_up_release (Mackie::Button &);
416 Mackie::LedState cursor_down_press (Mackie::Button &);
417 Mackie::LedState cursor_down_release (Mackie::Button &);
418 Mackie::LedState cursor_left_press (Mackie::Button &);
419 Mackie::LedState cursor_left_release (Mackie::Button &);
420 Mackie::LedState cursor_right_press (Mackie::Button &);
421 Mackie::LedState cursor_right_release (Mackie::Button &);
422 Mackie::LedState left_press(Mackie::Button &);
423 Mackie::LedState left_release(Mackie::Button &);
424 Mackie::LedState right_press(Mackie::Button &);
425 Mackie::LedState right_release(Mackie::Button &);
426 Mackie::LedState channel_left_press(Mackie::Button &);
427 Mackie::LedState channel_left_release(Mackie::Button &);
428 Mackie::LedState channel_right_press(Mackie::Button &);
429 Mackie::LedState channel_right_release(Mackie::Button &);
430 Mackie::LedState marker_press(Mackie::Button &);
431 Mackie::LedState marker_release(Mackie::Button &);
432 Mackie::LedState save_press(Mackie::Button &);
433 Mackie::LedState save_release(Mackie::Button &);
434 Mackie::LedState timecode_beats_press(Mackie::Button &);
435 Mackie::LedState timecode_beats_release(Mackie::Button &);
436 Mackie::LedState zoom_press(Mackie::Button &);
437 Mackie::LedState zoom_release(Mackie::Button &);
438 Mackie::LedState scrub_press(Mackie::Button &);
439 Mackie::LedState scrub_release(Mackie::Button &);
440 Mackie::LedState undo_press (Mackie::Button &);
441 Mackie::LedState undo_release (Mackie::Button &);
442 Mackie::LedState shift_press (Mackie::Button &);
443 Mackie::LedState shift_release (Mackie::Button &);
444 Mackie::LedState option_press (Mackie::Button &);
445 Mackie::LedState option_release (Mackie::Button &);
446 Mackie::LedState control_press (Mackie::Button &);
447 Mackie::LedState control_release (Mackie::Button &);
448 Mackie::LedState cmd_alt_press (Mackie::Button &);
449 Mackie::LedState cmd_alt_release (Mackie::Button &);
451 Mackie::LedState pan_press (Mackie::Button &);
452 Mackie::LedState pan_release (Mackie::Button &);
453 Mackie::LedState plugin_press (Mackie::Button &);
454 Mackie::LedState plugin_release (Mackie::Button &);
455 Mackie::LedState eq_press (Mackie::Button &);
456 Mackie::LedState eq_release (Mackie::Button &);
457 Mackie::LedState dyn_press (Mackie::Button &);
458 Mackie::LedState dyn_release (Mackie::Button &);
459 Mackie::LedState flip_press (Mackie::Button &);
460 Mackie::LedState flip_release (Mackie::Button &);
461 Mackie::LedState name_value_press (Mackie::Button &);
462 Mackie::LedState name_value_release (Mackie::Button &);
463 Mackie::LedState F1_press (Mackie::Button &);
464 Mackie::LedState F1_release (Mackie::Button &);
465 Mackie::LedState F2_press (Mackie::Button &);
466 Mackie::LedState F2_release (Mackie::Button &);
467 Mackie::LedState F3_press (Mackie::Button &);
468 Mackie::LedState F3_release (Mackie::Button &);
469 Mackie::LedState F4_press (Mackie::Button &);
470 Mackie::LedState F4_release (Mackie::Button &);
471 Mackie::LedState F5_press (Mackie::Button &);
472 Mackie::LedState F5_release (Mackie::Button &);
473 Mackie::LedState F6_press (Mackie::Button &);
474 Mackie::LedState F6_release (Mackie::Button &);
475 Mackie::LedState F7_press (Mackie::Button &);
476 Mackie::LedState F7_release (Mackie::Button &);
477 Mackie::LedState F8_press (Mackie::Button &);
478 Mackie::LedState F8_release (Mackie::Button &);
479 Mackie::LedState touch_press (Mackie::Button &);
480 Mackie::LedState touch_release (Mackie::Button &);
481 Mackie::LedState enter_press (Mackie::Button &);
482 Mackie::LedState enter_release (Mackie::Button &);
483 Mackie::LedState cancel_press (Mackie::Button &);
484 Mackie::LedState cancel_release (Mackie::Button &);
485 Mackie::LedState user_a_press (Mackie::Button &);
486 Mackie::LedState user_a_release (Mackie::Button &);
487 Mackie::LedState user_b_press (Mackie::Button &);
488 Mackie::LedState user_b_release (Mackie::Button &);
489 Mackie::LedState fader_touch_press (Mackie::Button &);
490 Mackie::LedState fader_touch_release (Mackie::Button &);
491 Mackie::LedState master_fader_touch_press (Mackie::Button &);
492 Mackie::LedState master_fader_touch_release (Mackie::Button &);
494 Mackie::LedState read_press (Mackie::Button&);
495 Mackie::LedState read_release (Mackie::Button&);
496 Mackie::LedState write_press (Mackie::Button&);
497 Mackie::LedState write_release (Mackie::Button&);
498 Mackie::LedState clearsolo_press (Mackie::Button&);
499 Mackie::LedState clearsolo_release (Mackie::Button&);
500 Mackie::LedState track_press (Mackie::Button&);
501 Mackie::LedState track_release (Mackie::Button&);
502 Mackie::LedState send_press (Mackie::Button&);
503 Mackie::LedState send_release (Mackie::Button&);
504 Mackie::LedState miditracks_press (Mackie::Button&);
505 Mackie::LedState miditracks_release (Mackie::Button&);
506 Mackie::LedState inputs_press (Mackie::Button&);
507 Mackie::LedState inputs_release (Mackie::Button&);
508 Mackie::LedState audiotracks_press (Mackie::Button&);
509 Mackie::LedState audiotracks_release (Mackie::Button&);
510 Mackie::LedState audioinstruments_press (Mackie::Button&);
511 Mackie::LedState audioinstruments_release (Mackie::Button&);
512 Mackie::LedState aux_press (Mackie::Button&);
513 Mackie::LedState aux_release (Mackie::Button&);
514 Mackie::LedState busses_press (Mackie::Button&);
515 Mackie::LedState busses_release (Mackie::Button&);
516 Mackie::LedState outputs_press (Mackie::Button&);
517 Mackie::LedState outputs_release (Mackie::Button&);
518 Mackie::LedState user_press (Mackie::Button&);
519 Mackie::LedState user_release (Mackie::Button&);
520 Mackie::LedState trim_press (Mackie::Button&);
521 Mackie::LedState trim_release (Mackie::Button&);
522 Mackie::LedState latch_press (Mackie::Button&);
523 Mackie::LedState latch_release (Mackie::Button&);
524 Mackie::LedState grp_press (Mackie::Button&);
525 Mackie::LedState grp_release (Mackie::Button&);
526 Mackie::LedState nudge_press (Mackie::Button&);
527 Mackie::LedState nudge_release (Mackie::Button&);
528 Mackie::LedState drop_press (Mackie::Button&);
529 Mackie::LedState drop_release (Mackie::Button&);
530 Mackie::LedState replace_press (Mackie::Button&);
531 Mackie::LedState replace_release (Mackie::Button&);
532 Mackie::LedState click_press (Mackie::Button&);
533 Mackie::LedState click_release (Mackie::Button&);
534 Mackie::LedState view_press (Mackie::Button&);
535 Mackie::LedState view_release (Mackie::Button&);
537 Mackie::LedState bank_release (Mackie::Button&, uint32_t bank_num);
542 #endif // ardour_mackie_control_protocol_h