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 MAIN_MODIFIER_MASK;
128 Normal, /* fader controls primary, vpot controls secondary */
129 Mirror, /* fader + vpot control secondary */
130 Swap, /* fader controls secondary, vpot controls primary */
131 Zero, /* fader controls primary, but doesn't move, vpot controls secondary */
134 MackieControlProtocol(ARDOUR::Session &);
135 virtual ~MackieControlProtocol();
137 static MackieControlProtocol* instance() { return _instance; }
139 const Mackie::DeviceInfo& device_info() const { return _device_info; }
140 Mackie::DeviceProfile& device_profile() { return _device_profile; }
142 PBD::Signal0<void> DeviceChanged;
143 PBD::Signal1<void,boost::shared_ptr<Mackie::Surface> > ConnectionChange;
145 void device_ready ();
147 int set_active (bool yn);
148 int set_device (const std::string&, bool force);
149 void set_profile (const std::string&);
151 FlipMode flip_mode () const { return _flip_mode; }
152 ViewMode view_mode () const { return _view_mode; }
153 SubViewMode subview_mode () const { return _subview_mode; }
154 boost::shared_ptr<ARDOUR::Route> subview_route() const;
155 PotMode pot_mode () const { return _pot_mode; }
156 bool zoom_mode () const { return modifier_state() & MODIFIER_ZOOM; }
157 bool metering_active () const { return _metering_active; }
159 bool is_track (boost::shared_ptr<ARDOUR::Route>) const;
160 bool is_audio_track (boost::shared_ptr<ARDOUR::Route>) const;
161 bool is_midi_track (boost::shared_ptr<ARDOUR::Route>) const;
162 bool selected (boost::shared_ptr<ARDOUR::Route>) const;
163 boost::shared_ptr<ARDOUR::Route> first_selected_route () const;
165 void set_view_mode (ViewMode);
166 void set_subview_mode (SubViewMode, boost::shared_ptr<ARDOUR::Route>);
167 void set_flip_mode (FlipMode);
168 void set_pot_mode (PotMode);
169 void pot_mode_globals ();
170 void display_view_mode ();
172 XMLNode& get_state ();
173 int set_state (const XMLNode&, int version);
175 /* Note: because Mackie control is inherently a duplex protocol,
176 we do not implement get/set_feedback() since this aspect of
177 support for the protocol is not optional.
182 mutable Glib::Threads::Mutex surfaces_lock;
183 typedef std::list<boost::shared_ptr<Mackie::Surface> > Surfaces;
186 boost::shared_ptr<Mackie::Surface> get_surface_by_raw_pointer (void*) const;
187 boost::shared_ptr<Mackie::Surface> nth_surface (uint32_t) const;
189 uint32_t global_index (Mackie::Strip&);
191 std::list<boost::shared_ptr<ARDOUR::Bundle> > bundles ();
193 void set_master_on_surface_strip (uint32_t surface, uint32_t strip);
194 void set_monitor_on_surface_strip (uint32_t surface, uint32_t strip);
196 uint32_t n_strips (bool with_locked_strips = true) const;
198 bool has_editor () const { return true; }
199 void* get_gui () const;
200 void tear_down_gui ();
202 void handle_button_event (Mackie::Surface&, Mackie::Button& button, Mackie::ButtonState);
204 void notify_subview_route_deleted ();
205 void notify_route_added_or_removed ();
206 void notify_route_added (ARDOUR::RouteList &);
207 void notify_remote_id_changed();
209 void recalibrate_faders ();
210 void toggle_backlight ();
211 void set_touch_sensitivity (int);
213 /// rebuild the current bank. Called on route added/removed and
214 /// remote id changed.
215 void refresh_current_bank();
217 // button-related signals
218 void notify_record_state_changed();
219 void notify_transport_state_changed();
220 void notify_loop_state_changed();
221 void notify_metering_state_changed();
222 // mainly to pick up punch-in and punch-out
223 void notify_parameter_changed(std::string const &);
224 void notify_solo_active_changed(bool);
226 /// Turn timecode on and beats off, or vice versa, depending
227 /// on state of _timecode_type
228 void update_timecode_beats_led();
230 /// this is called to generate the midi to send in response to a button press.
231 void update_led(Mackie::Surface&, Mackie::Button & button, Mackie::LedState);
233 void update_global_button (int id, Mackie::LedState);
234 void update_global_led (int id, Mackie::LedState);
236 ARDOUR::Session & get_session() { return *session; }
237 framepos_t transport_frame() const;
239 int modifier_state() const { return _modifier_state; }
240 int main_modifier_state() const { return _modifier_state & MAIN_MODIFIER_MASK; }
242 typedef std::list<boost::shared_ptr<ARDOUR::AutomationControl> > ControlList;
244 void add_down_button (ARDOUR::AutomationType, int surface, int strip);
245 void remove_down_button (ARDOUR::AutomationType, int surface, int strip);
246 ControlList down_controls (ARDOUR::AutomationType);
248 void add_down_select_button (int surface, int strip);
249 void remove_down_select_button (int surface, int strip);
250 void select_range ();
252 int16_t ipmidi_base() const { return _ipmidi_base; }
253 void set_ipmidi_base (int16_t);
255 void ping_devices ();
258 // shut down the surface
261 // This sets up the notifications and sets the
262 // controls to the correct values
263 void update_surfaces();
265 // connects global (not strip) signals from the Session to here
266 // so the surface can be notified of changes from the other UIs.
267 void connect_session_signals();
269 // set all controls to their zero position
273 Fetch the set of routes to be considered for control by the
274 surface. Excluding master, hidden and control routes, and inactive routes
276 typedef std::vector<boost::shared_ptr<ARDOUR::Route> > Sorted;
277 Sorted get_sorted_routes();
280 void switch_banks (uint32_t first_remote_id, bool force = false);
284 // also called from poll_automation to update timecode display
285 void update_timecode_display();
287 std::string format_bbt_timecode (ARDOUR::framepos_t now_frame);
288 std::string format_timecode_timecode (ARDOUR::framepos_t now_frame);
290 void do_request (MackieControlUIRequest*);
295 bool route_is_locked_to_strip (boost::shared_ptr<ARDOUR::Route>) const;
299 struct ButtonHandlers {
300 Mackie::LedState (MackieControlProtocol::*press) (Mackie::Button&);
301 Mackie::LedState (MackieControlProtocol::*release) (Mackie::Button&);
303 ButtonHandlers (Mackie::LedState (MackieControlProtocol::*p) (Mackie::Button&),
304 Mackie::LedState (MackieControlProtocol::*r) (Mackie::Button&))
309 typedef std::map<Mackie::Button::ID,ButtonHandlers> ButtonMap;
311 static MackieControlProtocol* _instance;
313 Mackie::DeviceInfo _device_info;
314 Mackie::DeviceProfile _device_profile;
315 sigc::connection periodic_connection;
316 sigc::connection redisplay_connection;
317 sigc::connection hui_connection;
318 uint32_t _current_initial_bank;
319 PBD::ScopedConnectionList audio_engine_connections;
320 PBD::ScopedConnectionList session_connections;
321 PBD::ScopedConnectionList route_connections;
322 PBD::ScopedConnectionList subview_route_connections;
323 PBD::ScopedConnectionList gui_connections;
324 // timer for two quick marker left presses
325 Mackie::Timer _frm_left_last;
326 // last written timecode string
327 std::string _timecode_last;
328 framepos_t _frame_last;
329 // Which timecode are we displaying? BBT or Timecode
330 ARDOUR::AnyTime::Type _timecode_type;
331 // Bundle to represent our input ports
332 boost::shared_ptr<ARDOUR::Bundle> _input_bundle;
333 // Bundle to represent our output ports
334 boost::shared_ptr<ARDOUR::Bundle> _output_bundle;
339 SubViewMode _subview_mode;
340 boost::shared_ptr<ARDOUR::Route> _subview_route;
342 int _current_selected_track;
344 ButtonMap button_map;
345 int16_t _ipmidi_base;
346 bool needs_ipmidi_restart;
347 bool _metering_active;
349 ARDOUR::RouteNotificationList _last_selected_routes;
350 XMLNode* configuration_state;
354 boost::shared_ptr<ArdourSurface::Mackie::Surface> _master_surface;
356 struct ipMIDIHandler {
357 MackieControlProtocol* mcp;
360 friend struct ipMIDIHandler; /* is this necessary */
361 friend gboolean ArdourSurface::ipmidi_input_handler (GIOChannel*, GIOCondition condition, void *data);
363 int create_surfaces ();
366 bool hui_heartbeat ();
368 bool midi_input_handler (Glib::IOCondition ioc, MIDI::Port* port);
370 void clear_surfaces ();
371 void force_special_route_to_strip (boost::shared_ptr<ARDOUR::Route> r, uint32_t surface, uint32_t strip_number);
372 void build_button_map ();
373 void gui_track_selection_changed (ARDOUR::RouteNotificationListPtr, bool save_list);
374 void _gui_track_selection_changed (ARDOUR::RouteNotificationList*, bool save_list, bool gui_did_change);
375 int ipmidi_restart ();
377 int set_device_info (const std::string& device_name);
378 void update_configuration_state ();
380 /* MIDI port connection management */
382 PBD::ScopedConnection port_connection;
383 void connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool);
385 /* BUTTON HANDLING */
387 typedef std::set<uint32_t> DownButtonList;
388 typedef std::map<ARDOUR::AutomationType,DownButtonList> DownButtonMap;
389 DownButtonMap _down_buttons;
390 DownButtonList _down_select_buttons;
392 void pull_route_range (DownButtonList&, ARDOUR::RouteList&);
394 /* implemented button handlers */
395 Mackie::LedState stop_press(Mackie::Button &);
396 Mackie::LedState stop_release(Mackie::Button &);
397 Mackie::LedState play_press(Mackie::Button &);
398 Mackie::LedState play_release(Mackie::Button &);
399 Mackie::LedState record_press(Mackie::Button &);
400 Mackie::LedState record_release(Mackie::Button &);
401 Mackie::LedState loop_press(Mackie::Button &);
402 Mackie::LedState loop_release(Mackie::Button &);
403 Mackie::LedState rewind_press(Mackie::Button & button);
404 Mackie::LedState rewind_release(Mackie::Button & button);
405 Mackie::LedState ffwd_press(Mackie::Button & button);
406 Mackie::LedState ffwd_release(Mackie::Button & button);
407 Mackie::LedState cursor_up_press (Mackie::Button &);
408 Mackie::LedState cursor_up_release (Mackie::Button &);
409 Mackie::LedState cursor_down_press (Mackie::Button &);
410 Mackie::LedState cursor_down_release (Mackie::Button &);
411 Mackie::LedState cursor_left_press (Mackie::Button &);
412 Mackie::LedState cursor_left_release (Mackie::Button &);
413 Mackie::LedState cursor_right_press (Mackie::Button &);
414 Mackie::LedState cursor_right_release (Mackie::Button &);
415 Mackie::LedState left_press(Mackie::Button &);
416 Mackie::LedState left_release(Mackie::Button &);
417 Mackie::LedState right_press(Mackie::Button &);
418 Mackie::LedState right_release(Mackie::Button &);
419 Mackie::LedState channel_left_press(Mackie::Button &);
420 Mackie::LedState channel_left_release(Mackie::Button &);
421 Mackie::LedState channel_right_press(Mackie::Button &);
422 Mackie::LedState channel_right_release(Mackie::Button &);
423 Mackie::LedState clicking_press(Mackie::Button &);
424 Mackie::LedState clicking_release(Mackie::Button &);
425 Mackie::LedState global_solo_press(Mackie::Button &);
426 Mackie::LedState global_solo_release(Mackie::Button &);
427 Mackie::LedState marker_press(Mackie::Button &);
428 Mackie::LedState marker_release(Mackie::Button &);
429 Mackie::LedState save_press(Mackie::Button &);
430 Mackie::LedState save_release(Mackie::Button &);
431 Mackie::LedState timecode_beats_press(Mackie::Button &);
432 Mackie::LedState timecode_beats_release(Mackie::Button &);
433 Mackie::LedState zoom_press(Mackie::Button &);
434 Mackie::LedState zoom_release(Mackie::Button &);
435 Mackie::LedState scrub_press(Mackie::Button &);
436 Mackie::LedState scrub_release(Mackie::Button &);
437 Mackie::LedState undo_press (Mackie::Button &);
438 Mackie::LedState undo_release (Mackie::Button &);
439 Mackie::LedState shift_press (Mackie::Button &);
440 Mackie::LedState shift_release (Mackie::Button &);
441 Mackie::LedState option_press (Mackie::Button &);
442 Mackie::LedState option_release (Mackie::Button &);
443 Mackie::LedState control_press (Mackie::Button &);
444 Mackie::LedState control_release (Mackie::Button &);
445 Mackie::LedState cmd_alt_press (Mackie::Button &);
446 Mackie::LedState cmd_alt_release (Mackie::Button &);
448 Mackie::LedState pan_press (Mackie::Button &);
449 Mackie::LedState pan_release (Mackie::Button &);
450 Mackie::LedState plugin_press (Mackie::Button &);
451 Mackie::LedState plugin_release (Mackie::Button &);
452 Mackie::LedState eq_press (Mackie::Button &);
453 Mackie::LedState eq_release (Mackie::Button &);
454 Mackie::LedState dyn_press (Mackie::Button &);
455 Mackie::LedState dyn_release (Mackie::Button &);
456 Mackie::LedState flip_press (Mackie::Button &);
457 Mackie::LedState flip_release (Mackie::Button &);
458 Mackie::LedState name_value_press (Mackie::Button &);
459 Mackie::LedState name_value_release (Mackie::Button &);
460 Mackie::LedState F1_press (Mackie::Button &);
461 Mackie::LedState F1_release (Mackie::Button &);
462 Mackie::LedState F2_press (Mackie::Button &);
463 Mackie::LedState F2_release (Mackie::Button &);
464 Mackie::LedState F3_press (Mackie::Button &);
465 Mackie::LedState F3_release (Mackie::Button &);
466 Mackie::LedState F4_press (Mackie::Button &);
467 Mackie::LedState F4_release (Mackie::Button &);
468 Mackie::LedState F5_press (Mackie::Button &);
469 Mackie::LedState F5_release (Mackie::Button &);
470 Mackie::LedState F6_press (Mackie::Button &);
471 Mackie::LedState F6_release (Mackie::Button &);
472 Mackie::LedState F7_press (Mackie::Button &);
473 Mackie::LedState F7_release (Mackie::Button &);
474 Mackie::LedState F8_press (Mackie::Button &);
475 Mackie::LedState F8_release (Mackie::Button &);
476 Mackie::LedState touch_press (Mackie::Button &);
477 Mackie::LedState touch_release (Mackie::Button &);
478 Mackie::LedState enter_press (Mackie::Button &);
479 Mackie::LedState enter_release (Mackie::Button &);
480 Mackie::LedState cancel_press (Mackie::Button &);
481 Mackie::LedState cancel_release (Mackie::Button &);
482 Mackie::LedState user_a_press (Mackie::Button &);
483 Mackie::LedState user_a_release (Mackie::Button &);
484 Mackie::LedState user_b_press (Mackie::Button &);
485 Mackie::LedState user_b_release (Mackie::Button &);
486 Mackie::LedState fader_touch_press (Mackie::Button &);
487 Mackie::LedState fader_touch_release (Mackie::Button &);
488 Mackie::LedState master_fader_touch_press (Mackie::Button &);
489 Mackie::LedState master_fader_touch_release (Mackie::Button &);
491 Mackie::LedState read_press (Mackie::Button&);
492 Mackie::LedState read_release (Mackie::Button&);
493 Mackie::LedState write_press (Mackie::Button&);
494 Mackie::LedState write_release (Mackie::Button&);
495 Mackie::LedState clearsolo_press (Mackie::Button&);
496 Mackie::LedState clearsolo_release (Mackie::Button&);
497 Mackie::LedState track_press (Mackie::Button&);
498 Mackie::LedState track_release (Mackie::Button&);
499 Mackie::LedState send_press (Mackie::Button&);
500 Mackie::LedState send_release (Mackie::Button&);
501 Mackie::LedState miditracks_press (Mackie::Button&);
502 Mackie::LedState miditracks_release (Mackie::Button&);
503 Mackie::LedState inputs_press (Mackie::Button&);
504 Mackie::LedState inputs_release (Mackie::Button&);
505 Mackie::LedState audiotracks_press (Mackie::Button&);
506 Mackie::LedState audiotracks_release (Mackie::Button&);
507 Mackie::LedState audioinstruments_press (Mackie::Button&);
508 Mackie::LedState audioinstruments_release (Mackie::Button&);
509 Mackie::LedState aux_press (Mackie::Button&);
510 Mackie::LedState aux_release (Mackie::Button&);
511 Mackie::LedState busses_press (Mackie::Button&);
512 Mackie::LedState busses_release (Mackie::Button&);
513 Mackie::LedState outputs_press (Mackie::Button&);
514 Mackie::LedState outputs_release (Mackie::Button&);
515 Mackie::LedState user_press (Mackie::Button&);
516 Mackie::LedState user_release (Mackie::Button&);
517 Mackie::LedState trim_press (Mackie::Button&);
518 Mackie::LedState trim_release (Mackie::Button&);
519 Mackie::LedState latch_press (Mackie::Button&);
520 Mackie::LedState latch_release (Mackie::Button&);
521 Mackie::LedState grp_press (Mackie::Button&);
522 Mackie::LedState grp_release (Mackie::Button&);
523 Mackie::LedState nudge_press (Mackie::Button&);
524 Mackie::LedState nudge_release (Mackie::Button&);
525 Mackie::LedState drop_press (Mackie::Button&);
526 Mackie::LedState drop_release (Mackie::Button&);
527 Mackie::LedState replace_press (Mackie::Button&);
528 Mackie::LedState replace_release (Mackie::Button&);
529 Mackie::LedState click_press (Mackie::Button&);
530 Mackie::LedState click_release (Mackie::Button&);
531 Mackie::LedState view_press (Mackie::Button&);
532 Mackie::LedState view_release (Mackie::Button&);
534 Mackie::LedState bank_release (Mackie::Button&, uint32_t bank_num);
539 #endif // ardour_mackie_control_protocol_h