MCP: better display of parameter values, off by one error when collecting controls...
[ardour.git] / libs / surfaces / mackie / strip.cc
1 /*
2         Copyright (C) 2006,2007 John Anderson
3         Copyright (C) 2012 Paul Davis
4
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.
9
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.
14
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.
18 */
19
20 #include <sstream>
21 #include <stdint.h>
22 #include "strip.h"
23
24 #include <sys/time.h>
25
26 #include "midi++/port.h"
27
28 #include "pbd/compose.h"
29 #include "pbd/convert.h"
30
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"
40
41 #include "mackie_control_protocol.h"
42 #include "surface_port.h"
43 #include "surface.h"
44 #include "button.h"
45 #include "led.h"
46 #include "pot.h"
47 #include "fader.h"
48 #include "jog.h"
49 #include "meter.h"
50
51 using namespace Mackie;
52 using namespace std;
53 using namespace ARDOUR;
54 using namespace PBD;
55
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__))
58
59 extern PBD::EventLoop::InvalidationRecord* __invalidator (sigc::trackable& trackable, const char*, int);
60 #define invalidator() __invalidator (*(MackieControlProtocol::instance()), __FILE__, __LINE__)
61
62 Strip::Strip (Surface& s, const std::string& name, int index, StripControlDefinition* ctls)
63         : Group (name)
64         , _solo (0)
65         , _recenable (0)
66         , _mute (0)
67         , _select (0)
68         , _vselect (0)
69         , _fader_touch (0)
70         , _vpot (0)
71         , _fader (0)
72         , _index (index)
73         , _surface (&s)
74         , _controls_locked (false)
75         , _reset_display_at (0)
76         , _last_gain_position_written (-1.0)
77         , _last_pan_position_written (-1.0)
78 {
79         /* build the controls for this track, which will automatically add them
80            to the Group 
81         */
82
83         for (uint32_t i = 0; ctls[i].name[0]; ++i) {
84                 ctls[i].factory (*_surface, ctls[i].base_id + index, ctls[i].name, *this);
85         }
86 }       
87
88 Strip::~Strip ()
89 {
90 }
91
92 /**
93         TODO could optimise this to use enum, but it's only
94         called during the protocol class instantiation.
95 */
96 void Strip::add (Control & control)
97 {
98         Group::add (control);
99
100         Fader* fader;
101         Pot* pot;
102         Button* button;
103         Meter* meter;
104
105         if ((fader = dynamic_cast<Fader*>(&control)) != 0) {
106
107                 _fader = fader;
108
109         } else if ((pot = dynamic_cast<Pot*>(&control)) != 0) {
110
111                 _vpot = pot;
112
113         } else if ((button = dynamic_cast<Button*>(&control)) != 0) {
114
115                 if (control.id() >= Button::recenable_base_id &&
116                     control.id() < Button::recenable_base_id + 8) {
117                         
118                         _recenable = button;
119
120                 } else if (control.id() >= Button::mute_base_id &&
121                            control.id() < Button::mute_base_id + 8) {
122
123                         _mute = button;
124
125                 } else if (control.id() >= Button::solo_base_id &&
126                            control.id() < Button::solo_base_id + 8) {
127
128                         _solo = button;
129
130                 } else if (control.id() >= Button::select_base_id &&
131                            control.id() < Button::select_base_id + 8) {
132
133                         _select = button;
134
135                 } else if (control.id() >= Button::vselect_base_id &&
136                            control.id() < Button::vselect_base_id + 8) {
137
138                         _vselect = button;
139
140                 } else if (control.id() >= Button::fader_touch_base_id &&
141                            control.id() < Button::fader_touch_base_id + 8) {
142
143                         _fader_touch = button;
144                 }
145
146         } else if ((meter = dynamic_cast<Meter*>(&control)) != 0) {
147                 _meter = meter;
148         }
149 }
150
151 void
152 Strip::set_route (boost::shared_ptr<Route> r)
153 {
154         if (_controls_locked) {
155                 return;
156         }
157
158         route_connections.drop_connections ();
159
160         _route = r;
161
162         if (r) {
163
164                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 strip %2 now mapping route %3\n",
165                                                                    _surface->number(), _index, _route->name()));
166                 
167
168                 if (_solo) {
169                         _solo->set_normal_control (_route->solo_control());
170                         _solo->set_modified_control (boost::shared_ptr<AutomationControl>());
171                         _route->solo_control()->Changed.connect(route_connections, invalidator(), ui_bind (&Strip::notify_solo_changed, this), ui_context());
172                 }
173
174                 if (_mute) {
175                         _mute->set_normal_control (_route->mute_control());
176                         _mute->set_modified_control (boost::shared_ptr<AutomationControl>());
177                         _route->mute_control()->Changed.connect(route_connections, invalidator(), ui_bind (&Strip::notify_mute_changed, this), ui_context());
178                 }
179                 
180                 _route->gain_control()->Changed.connect(route_connections, invalidator(), ui_bind (&Strip::notify_gain_changed, this, false), ui_context());
181                 
182                 _route->PropertyChanged.connect (route_connections, invalidator(), ui_bind (&Strip::notify_property_changed, this, _1), ui_context());
183                 
184                 if (_route->pannable()) {
185                         _route->pannable()->pan_azimuth_control->Changed.connect(route_connections, invalidator(), ui_bind (&Strip::notify_panner_changed, this, false), ui_context());
186                         _route->pannable()->pan_width_control->Changed.connect(route_connections, invalidator(), ui_bind (&Strip::notify_panner_changed, this, false), ui_context());
187                 }
188
189                 /* bind fader & pan pot, as appropriate for current flip mode */
190
191                 flip_mode_changed (false);
192                 
193                 boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<ARDOUR::Track>(_route);
194         
195                 if (trk) {
196                         _recenable->set_normal_control (trk->rec_enable_control());
197                         _recenable->set_modified_control (boost::shared_ptr<AutomationControl>());
198                         trk->rec_enable_control()->Changed .connect(route_connections, invalidator(), ui_bind (&Strip::notify_record_enable_changed, this), ui_context());
199                 }
200                 
201                 // TODO this works when a currently-banked route is made inactive, but not
202                 // when a route is activated which should be currently banked.
203                 
204                 _route->active_changed.connect (route_connections, invalidator(), ui_bind (&Strip::notify_active_changed, this), ui_context());
205                 _route->DropReferences.connect (route_connections, invalidator(), ui_bind (&Strip::notify_route_deleted, this), ui_context());
206         
207                 // TODO
208                 // SelectedChanged
209                 // RemoteControlIDChanged. Better handled at Session level.
210
211                 /* Update */
212
213                 notify_all ();
214         } else {
215                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 strip %2 now unmapped\n",
216                                                                    _surface->number(), _index));
217         }
218 }
219
220 void 
221 Strip::notify_all()
222 {
223         notify_solo_changed ();
224         notify_mute_changed ();
225         notify_gain_changed ();
226         notify_property_changed (PBD::PropertyChange (ARDOUR::Properties::name));
227         notify_panner_changed ();
228         notify_record_enable_changed ();
229 }
230
231 void 
232 Strip::notify_solo_changed ()
233 {
234         if (_route && _solo) {
235                 _surface->write (_solo->set_state (_route->soloed() ? on : off));
236         }
237 }
238
239 void 
240 Strip::notify_mute_changed ()
241 {
242         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Strip %1 mute changed\n", _index));
243         if (_route && _mute) {
244                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("\troute muted ? %1\n", _route->muted()));
245                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("mute message: %1\n", _mute->set_state (_route->muted() ? on : off)));
246
247                 _surface->write (_mute->set_state (_route->muted() ? on : off));
248         }
249 }
250
251 void 
252 Strip::notify_record_enable_changed ()
253 {
254         if (_route && _recenable)  {
255                 _surface->write (_recenable->set_state (_route->record_enabled() ? on : off));
256         }
257 }
258
259 void 
260 Strip::notify_active_changed ()
261 {
262         _surface->mcp().refresh_current_bank();
263 }
264
265 void 
266 Strip::notify_route_deleted ()
267 {
268         _surface->mcp().refresh_current_bank();
269 }
270
271 void 
272 Strip::notify_gain_changed (bool force_update)
273 {
274         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("gain changed for strip %1, flip mode %2\n", _index, _surface->mcp().flip_mode()));
275
276         if (_route) {
277                 
278                 Control* control;
279
280                 if (_surface->mcp().flip_mode()) {
281                         control = _vpot;
282                 } else {
283                         control = _fader;
284                 }
285
286                 if (!control->in_use()) {
287
288                         float pos = _route->gain_control()->internal_to_interface (_route->gain_control()->get_value());
289
290                         if (force_update || pos != _last_gain_position_written) {
291
292                                 if (_surface->mcp().flip_mode()) {
293                                         _surface->write (_vpot->set_all (pos, true, Pot::wrap));
294                                         do_parameter_display (GainAutomation, pos);
295                                 } else {
296                                         _surface->write (_fader->set_position (pos));
297                                         do_parameter_display (GainAutomation, pos);
298                                 }
299
300                                 queue_display_reset (3000);
301                                 _last_gain_position_written = pos;
302                                 
303                         } else {
304                                 DEBUG_TRACE (DEBUG::MackieControl, "value is stale, no message sent\n");
305                         }
306                 } else {
307                         DEBUG_TRACE (DEBUG::MackieControl, "fader in use, no message sent\n");
308                 }
309         } else {
310                 DEBUG_TRACE (DEBUG::MackieControl, "no route or no fader\n");
311         }
312 }
313
314 void 
315 Strip::notify_property_changed (const PropertyChange& what_changed)
316 {
317         if (!what_changed.contains (ARDOUR::Properties::name)) {
318                 return;
319         }
320
321         if (_route) {
322                 string line1;
323                 string fullname = _route->name();
324                 
325                 if (fullname.length() <= 6) {
326                         line1 = fullname;
327                 } else {
328                         line1 = PBD::short_version (fullname, 6);
329                 }
330                 
331                 _surface->write (display (0, line1));
332         }
333 }
334
335 void 
336 Strip::notify_panner_changed (bool force_update)
337 {
338         if (_route) {
339
340                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("pan change for strip %1\n", _index));
341
342                 boost::shared_ptr<Pannable> pannable = _route->pannable();
343
344                 if (!pannable) {
345                         _surface->write (_vpot->zero());
346                         return;
347                 }
348
349                 Control* control;
350
351                 if (_surface->mcp().flip_mode()) {
352                         control = _fader;
353                 } else {
354                         control = _vpot;
355                 }
356
357                 if (!control->in_use()) {
358                         
359                         double pos = pannable->pan_azimuth_control->internal_to_interface (pannable->pan_azimuth_control->get_value());
360                         
361                         if (force_update || pos != _last_pan_position_written) {
362                                 
363                                 if (_surface->mcp().flip_mode()) {
364                                         
365                                         _surface->write (_fader->set_position (pos));
366                                         do_parameter_display (PanAzimuthAutomation, pos);
367                                 } else {
368                                         _surface->write (_vpot->set_all (pos, true, Pot::dot));
369                                         do_parameter_display (PanAzimuthAutomation, pos);
370                                 }
371
372                                 queue_display_reset (3000);
373                                 _last_pan_position_written = pos;
374                         }
375                 }
376         }
377 }
378
379 void
380 Strip::handle_button (Button& button, ButtonState bs)
381 {
382         if (bs == press) {
383                 button.set_in_use (true);
384         } else {
385                 button.set_in_use (false);
386         }
387
388         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("strip %1 handling button %2\n", _index, button.id()));
389
390         int lock_mod = (MackieControlProtocol::MODIFIER_CONTROL|MackieControlProtocol::MODIFIER_SHIFT);
391         int ms = _surface->mcp().modifier_state();
392         bool modified = (ms & MackieControlProtocol::MODIFIER_CONTROL);
393
394         if (button.id() >= Button::select_base_id &&
395             button.id() < Button::select_base_id + 8) {
396
397                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("select touch, lock ? %1\n", ((ms & lock_mod) == lock_mod) ? 1 : 0));
398
399                 if (bs == press) {
400
401                         if ((ms & lock_mod) == lock_mod) {
402                                 _controls_locked = !_controls_locked;
403                                 return;
404                         }
405                         
406                         DEBUG_TRACE (DEBUG::MackieControl, "add select button on press\n");
407                         _surface->mcp().add_down_select_button (_surface->number(), _index);                    
408
409                         _surface->mcp().select_range ();
410
411                 } else {
412                         DEBUG_TRACE (DEBUG::MackieControl, "remove select button on release\n");
413                         _surface->mcp().remove_down_select_button (_surface->number(), _index);                 
414                 }
415
416                 return;
417         }
418
419         if (button.id() >= Button::fader_touch_base_id &&
420             button.id() < Button::fader_touch_base_id + 8) {
421
422                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("fader touch, press ? %1\n", (bs == press)));
423
424                 /* never use the modified control for fader stuff */
425
426                 if (bs == press) {
427
428                         _fader->set_in_use (true);
429                         _fader->start_touch (_surface->mcp().transport_frame(), false);
430                         boost::shared_ptr<AutomationControl> ac = _fader->control (false);
431                         if (ac) {
432                                 do_parameter_display ((AutomationType) ac->parameter().type(), ac->internal_to_interface (ac->get_value()));
433                                 queue_display_reset (3000);
434                         }
435                 } else {
436                         _fader->set_in_use (false);
437                         _fader->stop_touch (_surface->mcp().transport_frame(), true, false);
438                 }
439                 
440                 return;
441         }
442
443         boost::shared_ptr<AutomationControl> control = button.control (modified);
444                 
445         if (control) {
446
447                 if (bs == press) {
448                         DEBUG_TRACE (DEBUG::MackieControl, "add button on release\n");
449                         _surface->mcp().add_down_button ((AutomationType) control->parameter().type(), _surface->number(), _index);
450                         
451                         float new_value;
452
453                         if (ms & MackieControlProtocol::MODIFIER_OPTION) {
454                                 /* reset to default/normal value */
455                                 new_value = control->normal();
456                         } else {
457                                 new_value = control->get_value() ? 0.0 : 1.0;
458                         }
459
460                         /* get all controls that either have their
461                          * button down or are within a range of
462                          * several down buttons
463                          */
464                         
465                         MackieControlProtocol::ControlList controls = _surface->mcp().down_controls ((AutomationType) control->parameter().type());
466                         
467                         
468                         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("there are %1 buttons down for control type %2, new value = %3\n",
469                                                                             controls.size(), control->parameter().type(), new_value));
470
471                         /* apply change */
472
473                         for (MackieControlProtocol::ControlList::iterator c = controls.begin(); c != controls.end(); ++c) {
474                                 (*c)->set_value (new_value);
475                         }
476
477                 } else {
478                         DEBUG_TRACE (DEBUG::MackieControl, "remove button on release\n");
479                         _surface->mcp().remove_down_button ((AutomationType) control->parameter().type(), _surface->number(), _index);
480                 }
481                         
482         } else {
483                 DEBUG_TRACE (DEBUG::MackieControl, string_compose ("button has no control at present (modified ? %1)\n", modified));
484         }
485 }
486
487 void
488 Strip::do_parameter_display (AutomationType type, float val)
489 {
490         float dB;
491
492         switch (type) {
493         case GainAutomation:
494                 dB = fast_coefficient_to_dB (val);
495                 if (val == 0.0) {
496                         _surface->write (display (1, " -inf "));
497                 } else {
498                         char buf[16];
499                         
500                         snprintf (buf, sizeof (buf), "%6.1f", dB);
501                         _surface->write (display (1, buf));
502                 }               
503                 break;
504
505         case PanAzimuthAutomation:
506                 if (_route) {
507                         boost::shared_ptr<Pannable> p = _route->pannable();
508                         if (p) {
509                                 string str = p->panner()->value_as_string (p->pan_azimuth_control);
510                                 _surface->write (display (1, str));
511                         }
512                 }
513         default:
514                 break;
515         }
516 }
517
518 void
519 Strip::handle_fader (Fader& fader, float position)
520 {
521         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("fader to %1\n", position));
522
523         bool modified = (_surface->mcp().modifier_state() & MackieControlProtocol::MODIFIER_CONTROL);
524
525         fader.set_value (position, modified);
526         fader.start_touch (_surface->mcp().transport_frame(), modified);
527         queue_display_reset (3000);
528
529         // must echo bytes back to slider now, because
530         // the notifier only works if the fader is not being
531         // touched. Which it is if we're getting input.
532
533         _surface->write (fader.set_position (position));
534 }
535
536 void
537 Strip::handle_pot (Pot& pot, float delta)
538 {
539         /* Pots only emit events when they move, not when they
540            stop moving. So to get a stop event, we need to use a timeout.
541         */
542         
543         bool modified = (_surface->mcp().modifier_state() & MackieControlProtocol::MODIFIER_CONTROL);
544         pot.start_touch (_surface->mcp().transport_frame(), modified);
545         _surface->mcp().add_in_use_timeout (*_surface, pot, pot.control (modified));
546
547         double p = pot.get_value (modified);
548         p += delta;
549         p = min (1.0, p);
550         p = max (0.0, p);
551         pot.set_value (p, modified);
552 }
553
554 void
555 Strip::periodic (uint64_t usecs)
556 {
557         if (!_route) {
558                 return;
559         }
560
561         update_automation ();
562         update_meter ();
563
564         if (_reset_display_at && _reset_display_at < usecs) {
565                 reset_display ();
566         }
567 }
568
569 void 
570 Strip::update_automation ()
571 {
572         ARDOUR::AutoState gain_state = _route->gain_control()->automation_state();
573
574         if (gain_state == Touch || gain_state == Play) {
575                 notify_gain_changed (false);
576         }
577
578         if (_route->panner()) {
579                 ARDOUR::AutoState panner_state = _route->panner()->automation_state();
580                 if (panner_state == Touch || panner_state == Play) {
581                         notify_panner_changed (false);
582                 }
583         }
584 }
585
586 void
587 Strip::update_meter ()
588 {
589         if (_meter) {
590                 float dB = const_cast<PeakMeter&> (_route->peak_meter()).peak_power (0);
591                 _surface->write (_meter->update_message (dB));
592         }
593 }
594
595 MidiByteArray
596 Strip::zero ()
597 {
598         MidiByteArray retval;
599
600         for (Group::Controls::const_iterator it = _controls.begin(); it != _controls.end(); ++it) {
601                 retval << (*it)->zero ();
602         }
603
604         retval << blank_display (0);
605         retval << blank_display (1);
606         
607         return retval;
608 }
609
610 MidiByteArray
611 Strip::blank_display (uint32_t line_number)
612 {
613         return display (line_number, string());
614 }
615
616 MidiByteArray
617 Strip::display (uint32_t line_number, const std::string& line)
618 {
619         assert (line_number <= 1);
620
621         MidiByteArray retval;
622
623         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("strip_display index: %1, line %2 = %3\n", _index, line_number, line));
624
625         // sysex header
626         retval << _surface->sysex_hdr();
627         
628         // code for display
629         retval << 0x12;
630         // offset (0 to 0x37 first line, 0x38 to 0x6f for second line)
631         retval << (_index * 7 + (line_number * 0x38));
632         
633         // ascii data to display
634         retval << line;
635         // pad with " " out to 6 chars
636         for (int i = line.length(); i < 6; ++i) {
637                 retval << ' ';
638         }
639         
640         // column spacer, unless it's the right-hand column
641         if (_index < 7) {
642                 retval << ' ';
643         }
644
645         // sysex trailer
646         retval << MIDI::eox;
647         
648         DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieMidiBuilder::strip_display midi: %1\n", retval));
649
650         return retval;
651 }
652
653 void
654 Strip::lock_controls ()
655 {
656         _controls_locked = true;
657 }
658
659 void
660 Strip::unlock_controls ()
661 {
662         _controls_locked = false;
663 }
664
665 MidiByteArray
666 Strip::gui_selection_changed (ARDOUR::RouteNotificationListPtr rl)
667 {
668         for (ARDOUR::RouteNotificationList::iterator i = rl->begin(); i != rl->end(); ++i) {
669                 if ((*i) == _route) {
670                         return _select->set_state (on);
671                 }
672         }
673
674         return _select->set_state (off);
675 }
676
677 string
678 Strip::static_display_string () const
679 {
680         if (_surface->mcp().flip_mode()) {
681                 return "Fader";
682         } else {
683                 return "Pan";
684         }
685 }
686
687 void
688 Strip::flip_mode_changed (bool notify)
689 {
690         if (!_route) {
691                 return;
692         }
693
694         boost::shared_ptr<Pannable> pannable = _route->pannable();
695
696         if (_surface->mcp().flip_mode()) {
697
698                 if (pannable) {
699                         _fader->set_normal_control (pannable->pan_azimuth_control);
700                         _fader->set_modified_control (pannable->pan_width_control);
701                 }
702                 _vpot->set_normal_control (_route->gain_control());
703                 _vpot->set_modified_control (boost::shared_ptr<AutomationControl>());
704
705                 _surface->write (display (1, static_display_string ()));
706
707         } else {
708
709                 if (pannable) {
710                         _vpot->set_normal_control (pannable->pan_azimuth_control);
711                         _vpot->set_modified_control (pannable->pan_width_control);
712                 }
713                 _fader->set_normal_control (_route->gain_control());
714                 _fader->set_modified_control (boost::shared_ptr<AutomationControl>());
715
716                 _surface->write (display (1, static_display_string()));
717         }
718
719         if (notify) {
720                 notify_all ();
721         }
722 }
723
724 void
725 Strip::queue_display_reset (uint32_t msecs)
726 {
727         struct timeval now;
728         struct timeval delta;
729         struct timeval when;
730         gettimeofday (&now, 0);
731         
732         delta.tv_sec = msecs/1000;
733         delta.tv_usec = (msecs - ((msecs/1000) * 1000)) * 1000;
734         
735         timeradd (&now, &delta, &when);
736
737         _reset_display_at = (when.tv_sec * 1000000) + when.tv_usec;
738 }
739
740 void
741 Strip::clear_display_reset ()
742 {
743         _reset_display_at = 0;
744 }
745
746 void
747 Strip::reset_display ()
748 {
749         _surface->write (display (1, static_display_string()));
750         clear_display_reset ();
751 }
752