2 Copyright (C) 2006,2007 John Anderson
3 Copyright (C) 2012 Paul Davis
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include "midi++/port.h"
28 #include "pbd/compose.h"
29 #include "pbd/convert.h"
31 #include "ardour/debug.h"
32 #include "ardour/midi_ui.h"
33 #include "ardour/route.h"
34 #include "ardour/track.h"
35 #include "ardour/pannable.h"
36 #include "ardour/panner.h"
37 #include "ardour/panner_shell.h"
38 #include "ardour/rc_configuration.h"
39 #include "ardour/meter.h"
41 #include "mackie_control_protocol.h"
42 #include "surface_port.h"
51 using namespace Mackie;
53 using namespace ARDOUR;
56 #define ui_context() MackieControlProtocol::instance() /* a UICallback-derived object that specifies the event loop for signal handling */
57 #define ui_bind(f, ...) boost::protect (boost::bind (f, __VA_ARGS__))
59 extern PBD::EventLoop::InvalidationRecord* __invalidator (sigc::trackable& trackable, const char*, int);
60 #define invalidator() __invalidator (*(MackieControlProtocol::instance()), __FILE__, __LINE__)
62 Strip::Strip (Surface& s, const std::string& name, int index, const map<Button::ID,StripButtonInfo>& strip_buttons)
74 , _controls_locked (false)
75 , _reset_display_at (0)
76 , _last_gain_position_written (-1.0)
77 , _last_pan_position_written (-1.0)
79 _fader = dynamic_cast<Fader*> (Fader::factory (*_surface, index, "fader", *this));
80 _vpot = dynamic_cast<Pot*> (Pot::factory (*_surface, Pot::ID + index, "vpot", *this));
81 _meter = dynamic_cast<Meter*> (Meter::factory (*_surface, index, "meter", *this));
83 for (map<Button::ID,StripButtonInfo>::const_iterator b = strip_buttons.begin(); b != strip_buttons.end(); ++b) {
84 (void) Button::factory (*_surface, b->first, b->second.base_id + index, b->second.name, *this);
90 /* surface is responsible for deleting all controls */
94 Strip::add (Control & control)
100 /* fader, vpot, meter were all set explicitly */
102 if ((button = dynamic_cast<Button*>(&control)) != 0) {
103 switch (button->bid()) {
104 case Button::RecEnable:
116 case Button::VSelect:
119 case Button::FaderTouch:
120 _fader_touch = button;
128 Strip::set_route (boost::shared_ptr<Route> r)
130 if (_controls_locked) {
134 route_connections.drop_connections ();
140 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 strip %2 now mapping route %3\n",
141 _surface->number(), _index, _route->name()));
145 _solo->set_normal_control (_route->solo_control());
146 _solo->set_modified_control (boost::shared_ptr<AutomationControl>());
147 _route->solo_control()->Changed.connect(route_connections, invalidator(), ui_bind (&Strip::notify_solo_changed, this), ui_context());
151 _mute->set_normal_control (_route->mute_control());
152 _mute->set_modified_control (boost::shared_ptr<AutomationControl>());
153 _route->mute_control()->Changed.connect(route_connections, invalidator(), ui_bind (&Strip::notify_mute_changed, this), ui_context());
156 _route->gain_control()->Changed.connect(route_connections, invalidator(), ui_bind (&Strip::notify_gain_changed, this, false), ui_context());
158 _route->PropertyChanged.connect (route_connections, invalidator(), ui_bind (&Strip::notify_property_changed, this, _1), ui_context());
160 if (_route->pannable()) {
161 _route->pannable()->pan_azimuth_control->Changed.connect(route_connections, invalidator(), ui_bind (&Strip::notify_panner_changed, this, false), ui_context());
162 _route->pannable()->pan_width_control->Changed.connect(route_connections, invalidator(), ui_bind (&Strip::notify_panner_changed, this, false), ui_context());
165 /* bind fader & pan pot, as appropriate for current flip mode */
167 flip_mode_changed (false);
169 boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<ARDOUR::Track>(_route);
172 _recenable->set_normal_control (trk->rec_enable_control());
173 _recenable->set_modified_control (boost::shared_ptr<AutomationControl>());
174 trk->rec_enable_control()->Changed .connect(route_connections, invalidator(), ui_bind (&Strip::notify_record_enable_changed, this), ui_context());
177 // TODO this works when a currently-banked route is made inactive, but not
178 // when a route is activated which should be currently banked.
180 _route->active_changed.connect (route_connections, invalidator(), ui_bind (&Strip::notify_active_changed, this), ui_context());
181 _route->DropReferences.connect (route_connections, invalidator(), ui_bind (&Strip::notify_route_deleted, this), ui_context());
185 // RemoteControlIDChanged. Better handled at Session level.
191 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 strip %2 now unmapped\n",
192 _surface->number(), _index));
199 notify_solo_changed ();
200 notify_mute_changed ();
201 notify_gain_changed ();
202 notify_property_changed (PBD::PropertyChange (ARDOUR::Properties::name));
203 notify_panner_changed ();
204 notify_record_enable_changed ();
208 Strip::notify_solo_changed ()
210 if (_route && _solo) {
211 _surface->write (_solo->set_state (_route->soloed() ? on : off));
216 Strip::notify_mute_changed ()
218 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Strip %1 mute changed\n", _index));
219 if (_route && _mute) {
220 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("\troute muted ? %1\n", _route->muted()));
221 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("mute message: %1\n", _mute->set_state (_route->muted() ? on : off)));
223 _surface->write (_mute->set_state (_route->muted() ? on : off));
228 Strip::notify_record_enable_changed ()
230 if (_route && _recenable) {
231 _surface->write (_recenable->set_state (_route->record_enabled() ? on : off));
236 Strip::notify_active_changed ()
238 _surface->mcp().refresh_current_bank();
242 Strip::notify_route_deleted ()
244 _surface->mcp().refresh_current_bank();
248 Strip::notify_gain_changed (bool force_update)
250 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("gain changed for strip %1, flip mode %2\n", _index, _surface->mcp().flip_mode()));
256 if (_surface->mcp().flip_mode()) {
262 if (!control->in_use()) {
264 float pos = _route->gain_control()->internal_to_interface (_route->gain_control()->get_value());
266 if (force_update || pos != _last_gain_position_written) {
268 if (_surface->mcp().flip_mode()) {
269 _surface->write (_vpot->set_all (pos, true, Pot::wrap));
270 do_parameter_display (GainAutomation, pos);
272 _surface->write (_fader->set_position (pos));
273 do_parameter_display (GainAutomation, pos);
276 queue_display_reset (2000);
277 _last_gain_position_written = pos;
280 DEBUG_TRACE (DEBUG::MackieControl, "value is stale, no message sent\n");
283 DEBUG_TRACE (DEBUG::MackieControl, "fader in use, no message sent\n");
286 DEBUG_TRACE (DEBUG::MackieControl, "no route or no fader\n");
291 Strip::notify_property_changed (const PropertyChange& what_changed)
293 if (!what_changed.contains (ARDOUR::Properties::name)) {
299 string fullname = _route->name();
301 if (fullname.length() <= 6) {
304 line1 = PBD::short_version (fullname, 6);
307 _surface->write (display (0, line1));
312 Strip::notify_panner_changed (bool force_update)
316 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("pan change for strip %1\n", _index));
318 boost::shared_ptr<Pannable> pannable = _route->pannable();
321 _surface->write (_vpot->zero());
327 if (_surface->mcp().flip_mode()) {
333 if (!control->in_use()) {
335 double pos = pannable->pan_azimuth_control->internal_to_interface (pannable->pan_azimuth_control->get_value());
337 if (force_update || pos != _last_pan_position_written) {
339 if (_surface->mcp().flip_mode()) {
341 _surface->write (_fader->set_position (pos));
342 do_parameter_display (PanAzimuthAutomation, pos);
344 _surface->write (_vpot->set_all (pos, true, Pot::dot));
345 do_parameter_display (PanAzimuthAutomation, pos);
348 queue_display_reset (2000);
349 _last_pan_position_written = pos;
356 Strip::handle_button (Button& button, ButtonState bs)
359 button.set_in_use (true);
361 button.set_in_use (false);
364 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("strip %1 handling button %2 press ? %3\n", _index, button.bid(), (bs == press)));
366 int lock_mod = (MackieControlProtocol::MODIFIER_CONTROL|MackieControlProtocol::MODIFIER_SHIFT);
367 int ms = _surface->mcp().modifier_state();
368 bool modified = (ms & MackieControlProtocol::MODIFIER_CONTROL);
370 if (button.bid() == Button::Select) {
372 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("select touch, lock ? %1\n", ((ms & lock_mod) == lock_mod) ? 1 : 0));
376 if ((ms & lock_mod) == lock_mod) {
377 _controls_locked = !_controls_locked;
381 DEBUG_TRACE (DEBUG::MackieControl, "add select button on press\n");
382 _surface->mcp().add_down_select_button (_surface->number(), _index);
384 _surface->mcp().select_range ();
387 DEBUG_TRACE (DEBUG::MackieControl, "remove select button on release\n");
388 _surface->mcp().remove_down_select_button (_surface->number(), _index);
394 if (button.bid() == Button::FaderTouch) {
396 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("fader touch, press ? %1\n", (bs == press)));
398 /* never use the modified control for fader stuff */
402 _fader->set_in_use (true);
403 _fader->start_touch (_surface->mcp().transport_frame(), false);
404 boost::shared_ptr<AutomationControl> ac = _fader->control (false);
406 do_parameter_display ((AutomationType) ac->parameter().type(), ac->internal_to_interface (ac->get_value()));
407 queue_display_reset (2000);
412 _fader->set_in_use (false);
413 _fader->stop_touch (_surface->mcp().transport_frame(), true, false);
420 boost::shared_ptr<AutomationControl> control = button.control (modified);
425 DEBUG_TRACE (DEBUG::MackieControl, "add button on release\n");
426 _surface->mcp().add_down_button ((AutomationType) control->parameter().type(), _surface->number(), _index);
430 if (ms & MackieControlProtocol::MODIFIER_OPTION) {
431 /* reset to default/normal value */
432 new_value = control->normal();
434 new_value = control->get_value() ? 0.0 : 1.0;
437 /* get all controls that either have their
438 * button down or are within a range of
439 * several down buttons
442 MackieControlProtocol::ControlList controls = _surface->mcp().down_controls ((AutomationType) control->parameter().type());
445 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("there are %1 buttons down for control type %2, new value = %3\n",
446 controls.size(), control->parameter().type(), new_value));
450 for (MackieControlProtocol::ControlList::iterator c = controls.begin(); c != controls.end(); ++c) {
451 (*c)->set_value (new_value);
455 DEBUG_TRACE (DEBUG::MackieControl, "remove button on release\n");
456 _surface->mcp().remove_down_button ((AutomationType) control->parameter().type(), _surface->number(), _index);
460 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("button has no control at present (modified ? %1)\n", modified));
465 Strip::do_parameter_display (AutomationType type, float val)
471 dB = fast_coefficient_to_dB (val);
473 _surface->write (display (1, " -inf "));
477 snprintf (buf, sizeof (buf), "%6.1f", dB);
478 _surface->write (display (1, buf));
482 case PanAzimuthAutomation:
484 boost::shared_ptr<Pannable> p = _route->pannable();
485 if (p && p->panner()) {
486 string str = p->panner()->value_as_string (p->pan_azimuth_control);
487 _surface->write (display (1, str));
496 Strip::handle_fader (Fader& fader, float position)
498 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("fader to %1\n", position));
500 bool modified = (_surface->mcp().modifier_state() & MackieControlProtocol::MODIFIER_CONTROL);
502 fader.set_value (position, modified);
503 fader.start_touch (_surface->mcp().transport_frame(), modified);
504 queue_display_reset (2000);
506 // must echo bytes back to slider now, because
507 // the notifier only works if the fader is not being
508 // touched. Which it is if we're getting input.
510 _surface->write (fader.set_position (position));
514 Strip::handle_pot (Pot& pot, float delta)
516 /* Pots only emit events when they move, not when they
517 stop moving. So to get a stop event, we need to use a timeout.
520 bool modified = (_surface->mcp().modifier_state() & MackieControlProtocol::MODIFIER_CONTROL);
521 pot.start_touch (_surface->mcp().transport_frame(), modified);
522 _surface->mcp().add_in_use_timeout (*_surface, pot, pot.control (modified));
524 double p = pot.get_value (modified);
528 pot.set_value (p, modified);
532 Strip::periodic (uint64_t usecs)
538 update_automation ();
541 if (_reset_display_at && _reset_display_at < usecs) {
547 Strip::update_automation ()
549 ARDOUR::AutoState gain_state = _route->gain_control()->automation_state();
551 if (gain_state == Touch || gain_state == Play) {
552 notify_gain_changed (false);
555 if (_route->panner()) {
556 ARDOUR::AutoState panner_state = _route->panner()->automation_state();
557 if (panner_state == Touch || panner_state == Play) {
558 notify_panner_changed (false);
564 Strip::update_meter ()
567 float dB = const_cast<PeakMeter&> (_route->peak_meter()).peak_power (0);
568 _surface->write (_meter->update_message (dB));
575 MidiByteArray retval;
577 for (Group::Controls::const_iterator it = _controls.begin(); it != _controls.end(); ++it) {
578 retval << (*it)->zero ();
581 retval << blank_display (0);
582 retval << blank_display (1);
588 Strip::blank_display (uint32_t line_number)
590 return display (line_number, string());
594 Strip::display (uint32_t line_number, const std::string& line)
596 assert (line_number <= 1);
598 MidiByteArray retval;
600 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("strip_display index: %1, line %2 = %3\n", _index, line_number, line));
603 retval << _surface->sysex_hdr();
607 // offset (0 to 0x37 first line, 0x38 to 0x6f for second line)
608 retval << (_index * 7 + (line_number * 0x38));
610 // ascii data to display
612 // pad with " " out to 6 chars
613 for (int i = line.length(); i < 6; ++i) {
617 // column spacer, unless it's the right-hand column
625 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieMidiBuilder::strip_display midi: %1\n", retval));
631 Strip::lock_controls ()
633 _controls_locked = true;
637 Strip::unlock_controls ()
639 _controls_locked = false;
643 Strip::gui_selection_changed (ARDOUR::RouteNotificationListPtr rl)
645 for (ARDOUR::RouteNotificationList::iterator i = rl->begin(); i != rl->end(); ++i) {
646 if ((*i) == _route) {
647 return _select->set_state (on);
651 return _select->set_state (off);
655 Strip::static_display_string () const
657 if (_surface->mcp().flip_mode()) {
665 Strip::flip_mode_changed (bool notify)
671 boost::shared_ptr<Pannable> pannable = _route->pannable();
673 if (_surface->mcp().flip_mode()) {
676 _fader->set_normal_control (pannable->pan_azimuth_control);
677 _fader->set_modified_control (pannable->pan_width_control);
679 _vpot->set_normal_control (_route->gain_control());
680 _vpot->set_modified_control (boost::shared_ptr<AutomationControl>());
682 _surface->write (display (1, static_display_string ()));
687 _vpot->set_normal_control (pannable->pan_azimuth_control);
688 _vpot->set_modified_control (pannable->pan_width_control);
690 _fader->set_normal_control (_route->gain_control());
691 _fader->set_modified_control (boost::shared_ptr<AutomationControl>());
693 _surface->write (display (1, static_display_string()));
702 Strip::queue_display_reset (uint32_t msecs)
705 struct timeval delta;
707 gettimeofday (&now, 0);
709 delta.tv_sec = msecs/1000;
710 delta.tv_usec = (msecs - ((msecs/1000) * 1000)) * 1000;
712 timeradd (&now, &delta, &when);
714 _reset_display_at = (when.tv_sec * 1000000) + when.tv_usec;
718 Strip::clear_display_reset ()
720 _reset_display_at = 0;
724 Strip::reset_display ()
726 _surface->write (display (1, static_display_string()));
727 clear_display_reset ();