faderport: long press on fader mode buttons switches fader automation to manual/off...
[ardour.git] / libs / surfaces / faderport / faderport.cc
1 /*
2     Copyright (C) 2015 Paul Davis
3
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.
8
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.
13
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.
17
18 */
19
20 #include <cstdlib>
21 #include <sstream>
22 #include <algorithm>
23
24 #include <stdint.h>
25
26 #include <glibmm/fileutils.h>
27 #include <glibmm/miscutils.h>
28
29 #include "pbd/controllable_descriptor.h"
30 #include "pbd/error.h"
31 #include "pbd/failed_constructor.h"
32 #include "pbd/file_utils.h"
33 #include "pbd/pthread_utils.h"
34 #include "pbd/compose.h"
35 #include "pbd/xml++.h"
36
37 #include "midi++/port.h"
38
39 #include "ardour/async_midi_port.h"
40 #include "ardour/audioengine.h"
41 #include "ardour/amp.h"
42 #include "ardour/bundle.h"
43 #include "ardour/debug.h"
44 #include "ardour/filesystem_paths.h"
45 #include "ardour/midi_port.h"
46 #include "ardour/midiport_manager.h"
47 #include "ardour/monitor_processor.h"
48 #include "ardour/profile.h"
49 #include "ardour/rc_configuration.h"
50 #include "ardour/route.h"
51 #include "ardour/session.h"
52 #include "ardour/session_configuration.h"
53 #include "ardour/track.h"
54
55 #include "faderport.h"
56
57 using namespace ARDOUR;
58 using namespace ArdourSurface;
59 using namespace PBD;
60 using namespace Glib;
61 using namespace std;
62
63 #include "i18n.h"
64
65 #include "pbd/abstract_ui.cc" // instantiate template
66
67 FaderPort::FaderPort (Session& s)
68         : ControlProtocol (s, _("Faderport"))
69         , AbstractUI<FaderPortRequest> ("faderport")
70         , gui (0)
71         , connection_state (ConnectionState (0))
72         , _device_active (false)
73         , fader_msb (0)
74         , fader_lsb (0)
75         , fader_is_touched (false)
76         , button_state (ButtonState (0))
77         , blink_state (false)
78 {
79         last_encoder_time = 0;
80
81         boost::shared_ptr<ARDOUR::Port> inp;
82         boost::shared_ptr<ARDOUR::Port> outp;
83
84         inp  = AudioEngine::instance()->register_input_port (DataType::MIDI, "Faderport Recv", true);
85         outp = AudioEngine::instance()->register_output_port (DataType::MIDI, "Faderport Send", true);
86
87         _input_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(inp);
88         _output_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(outp);
89
90         if (_input_port == 0 || _output_port == 0) {
91                 throw failed_constructor();
92         }
93
94         _input_bundle.reset (new ARDOUR::Bundle (_("Faderport Support (Receive)"), true));
95         _output_bundle.reset (new ARDOUR::Bundle (_("Faderport Support (Send) "), false));
96
97         _input_bundle->add_channel (
98                 inp->name(),
99                 ARDOUR::DataType::MIDI,
100                 session->engine().make_port_name_non_relative (inp->name())
101                 );
102
103         _output_bundle->add_channel (
104                 outp->name(),
105                 ARDOUR::DataType::MIDI,
106                 session->engine().make_port_name_non_relative (outp->name())
107                 );
108
109
110         TrackSelectionChanged.connect (selection_connection, MISSING_INVALIDATOR, boost::bind (&FaderPort::gui_track_selection_changed, this, _1), this);
111
112         /* Catch port connections and disconnections */
113         ARDOUR::AudioEngine::instance()->PortConnectedOrDisconnected.connect (port_connection, MISSING_INVALIDATOR, boost::bind (&FaderPort::connection_handler, this, _1, _2, _3, _4, _5), this);
114
115         buttons.insert (std::make_pair (Mute, Button (*this, _("Mute"), Mute, 21)));
116         buttons.insert (std::make_pair (Solo, Button (*this, _("Solo"), Solo, 22)));
117         buttons.insert (std::make_pair (Rec, Button (*this, _("Rec"), Rec, 23)));
118         buttons.insert (std::make_pair (Left, Button (*this, _("Left"), Left, 20)));
119         buttons.insert (std::make_pair (Bank, Button (*this, _("Bank"), Bank, 19)));
120         buttons.insert (std::make_pair (Right, Button (*this, _("Right"), Right, 18)));
121         buttons.insert (std::make_pair (Output, Button (*this, _("Output"), Output, 17)));
122         buttons.insert (std::make_pair (FP_Read, Button (*this, _("Read"), FP_Read, 13)));
123         buttons.insert (std::make_pair (FP_Write, Button (*this, _("Write"), FP_Write, 14)));
124         buttons.insert (std::make_pair (FP_Touch, Button (*this, _("Touch"), FP_Touch, 15)));
125         buttons.insert (std::make_pair (FP_Off, Button (*this, _("Off"), FP_Off, 16)));
126         buttons.insert (std::make_pair (Mix, Button (*this, _("Mix"), Mix, 12)));
127         buttons.insert (std::make_pair (Proj, Button (*this, _("Proj"), Proj, 11)));
128         buttons.insert (std::make_pair (Trns, Button (*this, _("Trns"), Trns, 10)));
129         buttons.insert (std::make_pair (Undo, Button (*this, _("Undo"), Undo, 9)));
130         buttons.insert (std::make_pair (Shift, Button (*this, _("Shift"), Shift, 5)));
131         buttons.insert (std::make_pair (Punch, Button (*this, _("Punch"), Punch, 6)));
132         buttons.insert (std::make_pair (User, Button (*this, _("User"), User, 7)));
133         buttons.insert (std::make_pair (Loop, Button (*this, _("Loop"), Loop, 8)));
134         buttons.insert (std::make_pair (Rewind, Button (*this, _("Rewind"), Rewind, 4)));
135         buttons.insert (std::make_pair (Ffwd, Button (*this, _("Ffwd"), Ffwd, 3)));
136         buttons.insert (std::make_pair (Stop, Button (*this, _("Stop"), Stop, 2)));
137         buttons.insert (std::make_pair (Play, Button (*this, _("Play"), Play, 1)));
138         buttons.insert (std::make_pair (RecEnable, Button (*this, _("RecEnable"), RecEnable, 0)));
139         buttons.insert (std::make_pair (FaderTouch, Button (*this, _("Fader (touch)"), FaderTouch, -1)));
140
141         get_button (Shift).set_flash (true);
142         get_button (Mix).set_flash (true);
143         get_button (Proj).set_flash (true);
144         get_button (Trns).set_flash (true);
145         get_button (User).set_flash (true);
146
147         get_button (Left).set_action ( boost::bind (&FaderPort::left, this), true);
148         get_button (Right).set_action ( boost::bind (&FaderPort::right, this), true);
149
150         get_button (Undo).set_action (boost::bind (&FaderPort::undo, this), true);
151         get_button (Undo).set_action (boost::bind (&FaderPort::redo, this), true, ShiftDown);
152         get_button (Undo).set_flash (true);
153
154         get_button (FP_Read).set_action (boost::bind (&FaderPort::read, this), true);
155         get_button (FP_Read).set_action (boost::bind (&FaderPort::off, this), false, LongPress);
156         get_button (FP_Write).set_action (boost::bind (&FaderPort::write, this), true);
157         get_button (FP_Write).set_action (boost::bind (&FaderPort::off, this), false, LongPress);
158         get_button (FP_Touch).set_action (boost::bind (&FaderPort::touch, this), true);
159         get_button (FP_Touch).set_action (boost::bind (&FaderPort::off, this), false, LongPress);
160         get_button (FP_Off).set_action (boost::bind (&FaderPort::off, this), true);
161
162         get_button (Play).set_action (boost::bind (&BasicUI::transport_play, this, true), true);
163         get_button (RecEnable).set_action (boost::bind (&BasicUI::rec_enable_toggle, this), true);
164         /* Stop is a modifier, so we have to use its own button state to get
165            the default action (since StopDown will be set when looking for the
166            action to invoke.
167         */
168         get_button (Stop).set_action (boost::bind (&BasicUI::transport_stop, this), true, StopDown);
169         get_button (Ffwd).set_action (boost::bind (&BasicUI::ffwd, this), true);
170
171         /* See comments about Stop above .. */
172         get_button (Rewind).set_action (boost::bind (&BasicUI::rewind, this), true, RewindDown);
173         get_button (Rewind).set_action (boost::bind (&BasicUI::goto_zero, this), true, ButtonState (RewindDown|StopDown));
174         get_button (Rewind).set_action (boost::bind (&BasicUI::goto_start, this), true, ButtonState (RewindDown|ShiftDown));
175
176         get_button (Ffwd).set_action (boost::bind (&BasicUI::ffwd, this), true);
177         get_button (Ffwd).set_action (boost::bind (&BasicUI::goto_end, this), true, ShiftDown);
178
179         get_button (Punch).set_action (boost::bind (&FaderPort::punch, this), true);
180
181         get_button (Loop).set_action (boost::bind (&BasicUI::loop_toggle, this), true);
182         get_button (Loop).set_action (boost::bind (&BasicUI::add_marker, this, string()), true, ShiftDown);
183
184         get_button (Punch).set_action (boost::bind (&BasicUI::prev_marker, this), true, ShiftDown);
185         get_button (User).set_action (boost::bind (&BasicUI::next_marker, this), true, ShiftDown);
186
187         get_button (Mute).set_action (boost::bind (&FaderPort::mute, this), true);
188         get_button (Solo).set_action (boost::bind (&FaderPort::solo, this), true);
189         get_button (Rec).set_action (boost::bind (&FaderPort::rec_enable, this), true);
190
191         get_button (Output).set_action (boost::bind (&FaderPort::use_master, this), true);
192         get_button (Output).set_action (boost::bind (&FaderPort::use_monitor, this), true, ShiftDown);
193 }
194
195 FaderPort::~FaderPort ()
196 {
197         if (_input_port) {
198                 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("unregistering input port %1\n", boost::shared_ptr<ARDOUR::Port>(_input_port)->name()));
199                 AudioEngine::instance()->unregister_port (_input_port);
200                 _input_port.reset ();
201         }
202
203         if (_output_port) {
204 //              _output_port->drain (10000);  //ToDo:  is this necessary?  It hangs the shutdown, for me
205                 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("unregistering output port %1\n", boost::shared_ptr<ARDOUR::Port>(_output_port)->name()));
206                 AudioEngine::instance()->unregister_port (_output_port);
207                 _output_port.reset ();
208         }
209
210         tear_down_gui ();
211 }
212
213 void
214 FaderPort::start_midi_handling ()
215 {
216         /* handle device inquiry response */
217         _input_port->parser()->sysex.connect_same_thread (midi_connections, boost::bind (&FaderPort::sysex_handler, this, _1, _2, _3));
218         /* handle buttons */
219         _input_port->parser()->poly_pressure.connect_same_thread (midi_connections, boost::bind (&FaderPort::button_handler, this, _1, _2));
220         /* handle encoder */
221         _input_port->parser()->pitchbend.connect_same_thread (midi_connections, boost::bind (&FaderPort::encoder_handler, this, _1, _2));
222         /* handle fader */
223         _input_port->parser()->controller.connect_same_thread (midi_connections, boost::bind (&FaderPort::fader_handler, this, _1, _2));
224
225         /* This connection means that whenever data is ready from the input
226          * port, the relevant thread will invoke our ::midi_input_handler()
227          * method, which will read the data, and invoke the parser.
228          */
229
230         _input_port->xthread().set_receive_handler (sigc::bind (sigc::mem_fun (this, &FaderPort::midi_input_handler), _input_port));
231         _input_port->xthread().attach (main_loop()->get_context());
232 }
233
234 void
235 FaderPort::stop_midi_handling ()
236 {
237         midi_connections.drop_connections ();
238
239         /* Note: the input handler is still active at this point, but we're no
240          * longer connected to any of the parser signals
241          */
242 }
243
244 void
245 FaderPort::do_request (FaderPortRequest* req)
246 {
247         if (req->type == CallSlot) {
248
249                 call_slot (MISSING_INVALIDATOR, req->the_slot);
250
251         } else if (req->type == Quit) {
252
253                 stop ();
254         }
255 }
256
257 int
258 FaderPort::stop ()
259 {
260         BaseUI::quit ();
261
262         return 0;
263 }
264
265 void
266 FaderPort::thread_init ()
267 {
268         struct sched_param rtparam;
269
270         pthread_set_name (X_("FaderPort"));
271
272         PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self(), X_("FaderPort"), 2048);
273         ARDOUR::SessionEvent::create_per_thread_pool (X_("FaderPort"), 128);
274
275         memset (&rtparam, 0, sizeof (rtparam));
276         rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
277
278         if (pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam) != 0) {
279                 // do we care? not particularly.
280         }
281 }
282
283 void
284 FaderPort::all_lights_out ()
285 {
286         for (ButtonMap::iterator b = buttons.begin(); b != buttons.end(); ++b) {
287                 b->second.set_led_state (_output_port, false);
288         }
289 }
290
291 FaderPort::Button&
292 FaderPort::get_button (ButtonID id) const
293 {
294         ButtonMap::const_iterator b = buttons.find (id);
295         assert (b != buttons.end());
296         return const_cast<Button&>(b->second);
297 }
298
299 bool
300 FaderPort::button_long_press_timeout (ButtonID id)
301 {
302         if (buttons_down.find (id) != buttons_down.end()) {
303                 get_button (id).invoke (ButtonState (LongPress|button_state), false);
304         } else {
305                 /* release happened and somehow we were not cancelled */
306         }
307
308         /* whichever button this was, we've used it ... don't invoke the
309            release action.
310         */
311         consumed.insert (id);
312
313         return false; /* don't get called again */
314 }
315
316 void
317 FaderPort::start_press_timeout (Button& button, ButtonID id)
318 {
319         Glib::RefPtr<Glib::TimeoutSource> timeout = Glib::TimeoutSource::create (500); // milliseconds
320         button.timeout_connection = timeout->connect (sigc::bind (sigc::mem_fun (*this, &FaderPort::button_long_press_timeout), id));
321         timeout->attach (main_loop()->get_context());
322 }
323
324 void
325 FaderPort::button_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
326 {
327         ButtonID id (ButtonID (tb->controller_number));
328         Button& button (get_button (id));
329
330         if (tb->value) {
331                 buttons_down.insert (id);
332         } else {
333                 buttons_down.erase (id);
334                 button.timeout_connection.disconnect ();
335         }
336
337         ButtonState bs (ButtonState (0));
338
339         switch (id) {
340         case Shift:
341                 /* set this bit on press, do NOT clear it on release */
342                 if (tb->value) {
343                         bs = ShiftDown;
344                 }
345                 break;
346         case Stop:
347                 bs = StopDown;
348                 break;
349         case Rewind:
350                 bs = RewindDown;
351                 break;
352         case User:
353                 bs = UserDown;
354                 break;
355         case FaderTouch:
356                 fader_is_touched = tb->value;
357                 if (_current_route) {
358                         boost::shared_ptr<AutomationControl> gain = _current_route->gain_control ();
359                         if (gain) {
360                                 framepos_t now = session->engine().sample_time();
361                                 if (tb->value) {
362                                         gain->start_touch (now);
363                                 } else {
364                                         gain->stop_touch (true, now);
365                                 }
366                         }
367                 }
368                 break;
369         default:
370                 if (tb->value) {
371                         start_press_timeout (button, id);
372                 }
373                 break;
374         }
375
376         if (bs) {
377                 button_state = (tb->value ? ButtonState (button_state|bs) : ButtonState (button_state&~bs));
378                 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("reset button state to %1%2 using %3%4\n", hex, button_state, bs, dec));
379         }
380
381         if (button.uses_flash()) {
382                 button.set_led_state (_output_port, (int)tb->value);
383         }
384
385         set<ButtonID>::iterator c = consumed.find (id);
386
387         if (c == consumed.end()) {
388                 button.invoke (button_state, tb->value ? true : false);
389         } else {
390                 consumed.erase (c);
391         }
392
393         if (!tb->value && (id != Shift)) {
394                 /* non-shift key was released, clear shift modifier */
395                 button_state = ButtonState (button_state&~ShiftDown);
396                 DEBUG_TRACE (DEBUG::FaderPort, "clear shift modifier\n");
397         }
398
399         if (!tb->value && (id != User)) {
400                 consumed.insert (User);
401                 DEBUG_TRACE (DEBUG::FaderPort, "clear user modifier\n");
402         }
403 }
404
405 void
406 FaderPort::encoder_handler (MIDI::Parser &, MIDI::pitchbend_t pb)
407 {
408         int delta = 1;
409
410         if (pb >= 8192) {
411                 delta = -1;
412         }
413
414         //knob debouncing and hysteresis.  The presonus encoder often sends bursts of events, or goes the wrong direction
415         {
416                 last_last_encoder_delta = last_encoder_delta;
417                 last_encoder_delta = delta;
418                 microseconds_t now = get_microseconds ();
419                 if ((now - last_encoder_time) < 10*1000) { //require at least 10ms interval between changes, because the device sometimes sends multiple deltas
420                         return;
421                 }
422                 if ((now - last_encoder_time) < 100*1000) { //avoid directional changes while "spinning", 100ms window
423                         if ( (delta == last_encoder_delta) && (delta == last_last_encoder_delta) ) {
424                                 last_good_encoder_delta = delta;  //3 in a row, grudgingly accept this as the new direction
425                         }
426                         if (delta != last_good_encoder_delta) {  //otherwise ensure we keep going the same way
427                                 delta = last_good_encoder_delta;
428                         }
429                 } else {  //we aren't yet in a spin window, just assume this move is really what we want
430                         //NOTE:  if you are worried about where these get initialized, here it is.
431                         last_last_encoder_delta = delta;
432                         last_encoder_delta = delta;
433                 }
434                 last_encoder_time = now;
435                 last_good_encoder_delta = delta;
436         }
437
438         if (_current_route) {
439
440                 ButtonState trim_modifier;
441                 ButtonState width_modifier;
442
443                 if (Profile->get_mixbus()) {
444                         trim_modifier = ShiftDown;
445                         width_modifier = ButtonState (0);
446                 } else {
447                         trim_modifier = UserDown;
448                         width_modifier = ShiftDown;
449                 }
450
451                 if ((button_state & trim_modifier) == trim_modifier ) {    // mod+encoder = input trim
452                         boost::shared_ptr<AutomationControl> trim = _current_route->trim()->gain_control ();
453                         if (trim) {
454                                 float val = trim->get_user();  //for gain elements, the "user" value is in dB
455                                 val += delta;
456                                 trim->set_user(val);
457                         }
458                 } else if (width_modifier && ((button_state & width_modifier) == width_modifier)) {
459                         ardour_pan_width (delta);
460
461                 } else {  // pan/balance
462                         if (!Profile->get_mixbus()) {
463                                 ardour_pan_azimuth (delta);
464                         } else {
465                                 mixbus_pan (delta);
466                         }
467                 }
468         }
469
470         /* if the user button was pressed, mark it as consumed so that its
471          * release action has no effect.
472          */
473
474         if (!Profile->get_mixbus() && (button_state & UserDown)) {
475                 consumed.insert (User);
476         }
477 }
478
479 void
480 FaderPort::fader_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
481 {
482         bool was_fader = false;
483
484         if (tb->controller_number == 0x0) {
485                 fader_msb = tb->value;
486                 was_fader = true;
487         } else if (tb->controller_number == 0x20) {
488                 fader_lsb = tb->value;
489                 was_fader = true;
490         }
491
492         if (was_fader) {
493                 if (_current_route) {
494                         boost::shared_ptr<AutomationControl> gain = _current_route->gain_control ();
495                         if (gain) {
496                                 int ival = (fader_msb << 7) | fader_lsb;
497                                 float val = gain->interface_to_internal (ival/16384.0);
498                                 _current_route->set_gain (val, this);
499                         }
500                 }
501         }
502 }
503
504 void
505 FaderPort::sysex_handler (MIDI::Parser &p, MIDI::byte *buf, size_t sz)
506 {
507         if (sz < 17) {
508                 return;
509         }
510
511         if (buf[2] != 0x7f ||
512             buf[3] != 0x06 ||
513             buf[4] != 0x02 ||
514             buf[5] != 0x0 ||
515             buf[6] != 0x1 ||
516             buf[7] != 0x06 ||
517             buf[8] != 0x02 ||
518             buf[9] != 0x0 ||
519             buf[10] != 0x01 ||
520             buf[11] != 0x0) {
521                 return;
522         }
523
524         _device_active = true;
525
526         DEBUG_TRACE (DEBUG::FaderPort, "FaderPort identified via MIDI Device Inquiry response\n");
527
528         /* put it into native mode */
529
530         MIDI::byte native[3];
531         native[0] = 0x91;
532         native[1] = 0x00;
533         native[2] = 0x64;
534
535         _output_port->write (native, 3, 0);
536
537         all_lights_out ();
538
539         /* catch up on state */
540
541         map_transport_state ();
542         map_recenable_state ();
543 }
544
545 int
546 FaderPort::set_active (bool yn)
547 {
548         DEBUG_TRACE (DEBUG::FaderPort, string_compose("Faderport::set_active init with yn: '%1'\n", yn));
549
550         if (yn == active()) {
551                 return 0;
552         }
553
554         if (yn) {
555
556                 /* start event loop */
557
558                 BaseUI::run ();
559
560                 connect_session_signals ();
561
562                 Glib::RefPtr<Glib::TimeoutSource> blink_timeout = Glib::TimeoutSource::create (200); // milliseconds
563                 blink_connection = blink_timeout->connect (sigc::mem_fun (*this, &FaderPort::blink));
564                 blink_timeout->attach (main_loop()->get_context());
565
566                 Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
567                 periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &FaderPort::periodic));
568                 periodic_timeout->attach (main_loop()->get_context());
569
570         } else {
571
572                 BaseUI::quit ();
573                 close ();
574
575         }
576
577         ControlProtocol::set_active (yn);
578
579         DEBUG_TRACE (DEBUG::FaderPort, string_compose("Faderport::set_active done with yn: '%1'\n", yn));
580
581         return 0;
582 }
583
584 bool
585 FaderPort::periodic ()
586 {
587         if (!_current_route) {
588                 return true;
589         }
590
591         ARDOUR::AutoState gain_state = _current_route->gain_control()->automation_state();
592
593         if (gain_state == ARDOUR::Touch || gain_state == ARDOUR::Play) {
594                 map_gain ();
595         }
596
597         return true;
598 }
599
600 void
601 FaderPort::stop_blinking (ButtonID id)
602 {
603         blinkers.remove (id);
604         get_button (id).set_led_state (_output_port, false);
605 }
606
607 void
608 FaderPort::start_blinking (ButtonID id)
609 {
610         blinkers.push_back (id);
611         get_button (id).set_led_state (_output_port, true);
612 }
613
614 bool
615 FaderPort::blink ()
616 {
617         blink_state = !blink_state;
618
619         for (Blinkers::iterator b = blinkers.begin(); b != blinkers.end(); b++) {
620                 get_button(*b).set_led_state (_output_port, blink_state);
621         }
622
623         return true;
624 }
625
626 void
627 FaderPort::close ()
628 {
629         all_lights_out ();
630
631         stop_midi_handling ();
632         session_connections.drop_connections ();
633         port_connection.disconnect ();
634         blink_connection.disconnect ();
635         selection_connection.disconnect ();
636         route_connections.drop_connections ();
637
638 #if 0
639         route_connections.drop_connections ();
640 #endif
641 }
642
643 void
644 FaderPort::map_recenable_state ()
645 {
646         switch (session->record_status()) {
647         case Session::Disabled:
648                 stop_blinking (RecEnable);
649                 break;
650         case Session::Enabled:
651                 start_blinking (RecEnable);
652                 break;
653         case Session::Recording:
654                 stop_blinking (RecEnable);
655                 break;
656         }
657 }
658
659 void
660 FaderPort::map_transport_state ()
661 {
662         get_button (Loop).set_led_state (_output_port, session->get_play_loop());
663
664         float ts = session->transport_speed();
665
666         if (ts == 0) {
667                 stop_blinking (Play);
668         } else if (fabs (ts) == 1.0) {
669                 stop_blinking (Play);
670                 get_button (Play).set_led_state (_output_port, true);
671         } else {
672                 start_blinking (Play);
673         }
674
675         get_button (Stop).set_led_state (_output_port, session->transport_stopped ());
676         get_button (Rewind).set_led_state (_output_port, session->transport_speed() < 0.0);
677         get_button (Ffwd).set_led_state (_output_port, session->transport_speed() > 1.0);
678 }
679
680 void
681 FaderPort::parameter_changed (string what)
682 {
683         if (what == "punch-in" || what == "punch-out") {
684                 bool in = session->config.get_punch_in ();
685                 bool out = session->config.get_punch_out ();
686                 if (in && out) {
687                         get_button (Punch).set_led_state (_output_port, true);
688                         blinkers.remove (Punch);
689                 } else if (in || out) {
690                         start_blinking (Punch);
691                 } else {
692                         stop_blinking (Punch);
693                 }
694         }
695 }
696
697 void
698 FaderPort::connect_session_signals()
699 {
700         session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_recenable_state, this), this);
701         session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_transport_state, this), this);
702         /* not session, but treat it similarly */
703         session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::parameter_changed, this, _1), this);
704 }
705
706 bool
707 FaderPort::midi_input_handler (Glib::IOCondition ioc, boost::shared_ptr<ARDOUR::AsyncMIDIPort> port)
708 {
709         DEBUG_TRACE (DEBUG::FaderPort, string_compose ("something happend on  %1\n", boost::shared_ptr<MIDI::Port>(port)->name()));
710
711         if (ioc & ~IO_IN) {
712                 return false;
713         }
714
715         if (ioc & IO_IN) {
716
717                 port->clear ();
718                 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("data available on %1\n", boost::shared_ptr<MIDI::Port>(port)->name()));
719                 framepos_t now = session->engine().sample_time();
720                 port->parse (now);
721         }
722
723         return true;
724 }
725
726
727 XMLNode&
728 FaderPort::get_state ()
729 {
730         XMLNode& node (ControlProtocol::get_state());
731
732         XMLNode* child;
733
734         child = new XMLNode (X_("Input"));
735         child->add_child_nocopy (boost::shared_ptr<ARDOUR::Port>(_input_port)->get_state());
736         node.add_child_nocopy (*child);
737
738
739         child = new XMLNode (X_("Output"));
740         child->add_child_nocopy (boost::shared_ptr<ARDOUR::Port>(_output_port)->get_state());
741         node.add_child_nocopy (*child);
742
743         /* Save action state for Mix, Proj, Trns and User buttons, since these
744          * are user controlled. We can only save named-action operations, since
745          * internal functions are just pointers to functions and hard to
746          * serialize without enumerating them all somewhere.
747          */
748
749         node.add_child_nocopy (get_button (Mix).get_state());
750         node.add_child_nocopy (get_button (Proj).get_state());
751         node.add_child_nocopy (get_button (Trns).get_state());
752         node.add_child_nocopy (get_button (User).get_state());
753
754         return node;
755 }
756
757 int
758 FaderPort::set_state (const XMLNode& node, int version)
759 {
760         XMLNodeList nlist;
761         XMLNodeConstIterator niter;
762         XMLNode const* child;
763
764         if (ControlProtocol::set_state (node, version)) {
765                 return -1;
766         }
767
768         if ((child = node.child (X_("Input"))) != 0) {
769                 XMLNode* portnode = child->child (Port::state_node_name.c_str());
770                 if (portnode) {
771                         boost::shared_ptr<ARDOUR::Port>(_input_port)->set_state (*portnode, version);
772                 }
773         }
774
775         if ((child = node.child (X_("Output"))) != 0) {
776                 XMLNode* portnode = child->child (Port::state_node_name.c_str());
777                 if (portnode) {
778                         boost::shared_ptr<ARDOUR::Port>(_output_port)->set_state (*portnode, version);
779                 }
780         }
781
782         for (XMLNodeList::const_iterator n = node.children().begin(); n != node.children().end(); ++n) {
783                 if ((*n)->name() == X_("Button")) {
784                         XMLProperty const * prop = (*n)->property (X_("id"));
785                         if (!prop) {
786                                 continue;
787                         }
788                         int xid = atoi (prop->value());
789                         ButtonMap::iterator b = buttons.find (ButtonID (xid));
790                         if (b == buttons.end()) {
791                                 continue;
792                         }
793                         b->second.set_state (**n);
794                 }
795         }
796
797         return 0;
798 }
799
800 bool
801 FaderPort::connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool yn)
802 {
803         DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler  start\n");
804         if (!_input_port || !_output_port) {
805                 return false;
806         }
807
808         string ni = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_input_port)->name());
809         string no = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_output_port)->name());
810
811         if (ni == name1 || ni == name2) {
812                 if (yn) {
813                         connection_state |= InputConnected;
814                 } else {
815                         connection_state &= ~InputConnected;
816                 }
817         } else if (no == name1 || no == name2) {
818                 if (yn) {
819                         connection_state |= OutputConnected;
820                 } else {
821                         connection_state &= ~OutputConnected;
822                 }
823         } else {
824                 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("Connections between %1 and %2 changed, but I ignored it\n", name1, name2));
825                 /* not our ports */
826                 return false;
827         }
828
829         if ((connection_state & (InputConnected|OutputConnected)) == (InputConnected|OutputConnected)) {
830
831                 /* XXX this is a horrible hack. Without a short sleep here,
832                    something prevents the device wakeup messages from being
833                    sent and/or the responses from being received.
834                 */
835
836                 g_usleep (100000);
837                 connected ();
838
839         } else {
840                 DEBUG_TRACE (DEBUG::FaderPort, "Device disconnected (input or output or both) or not yet fully connected\n");
841                 _device_active = false;
842         }
843
844         ConnectionChange (); /* emit signal for our GUI */
845
846         DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler  end\n");
847
848         return true; /* connection status changed */
849 }
850
851 void
852 FaderPort::connected ()
853 {
854         DEBUG_TRACE (DEBUG::FaderPort, "connection status changed\n");
855
856         start_midi_handling ();
857
858         /* send device inquiry */
859
860         MIDI::byte buf[6];
861
862         buf[0] = 0xf0;
863         buf[1] = 0x7e;
864         buf[2] = 0x7f;
865         buf[3] = 0x06;
866         buf[4] = 0x01;
867         buf[5] = 0xf7;
868
869         _output_port->write (buf, 6, 0);
870 }
871
872 void
873 FaderPort::Button::invoke (FaderPort::ButtonState bs, bool press)
874 {
875         DEBUG_TRACE (DEBUG::FaderPort, string_compose ("invoke button %1 for %2 state %3%4%5\n", id, (press ? "press":"release"), hex, bs, dec));
876
877         ToDoMap::iterator x;
878
879         if (press) {
880                 if ((x = on_press.find (bs)) == on_press.end()) {
881                         DEBUG_TRACE (DEBUG::FaderPort, string_compose ("no press action for button %1 state %2%3\%4\n", id, hex, bs, dec));
882                         return;
883                 }
884         } else {
885                 if ((x = on_release.find (bs)) == on_release.end()) {
886                         DEBUG_TRACE (DEBUG::FaderPort, string_compose ("no release action for button %1 state %2%3\%4\n", id, hex, bs, dec));
887                         return;
888                 }
889         }
890
891         switch (x->second.type) {
892         case NamedAction:
893                 if (!x->second.action_name.empty()) {
894                         fp.access_action (x->second.action_name);
895                 }
896                 break;
897         case InternalFunction:
898                 if (x->second.function) {
899                         x->second.function ();
900                 }
901         }
902 }
903
904 void
905 FaderPort::Button::set_action (string const& name, bool when_pressed, FaderPort::ButtonState bs)
906 {
907         ToDo todo;
908
909         todo.type = NamedAction;
910
911         if (when_pressed) {
912                 if (name.empty()) {
913                         on_press.erase (bs);
914                 } else {
915                         DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 to action %2 on press + %3%4%5\n", id, name, bs));
916                         todo.action_name = name;
917                         on_press[bs] = todo;
918                 }
919         } else {
920                 if (name.empty()) {
921                         on_release.erase (bs);
922                 } else {
923                         DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 to action %2 on release + %3%4%5\n", id, name, bs));
924                         todo.action_name = name;
925                         on_release[bs] = todo;
926                 }
927         }
928 }
929
930 string
931 FaderPort::Button::get_action (bool press, FaderPort::ButtonState bs)
932 {
933         ToDoMap::iterator x;
934
935         if (press) {
936                 if ((x = on_press.find (bs)) == on_press.end()) {
937                         return string();
938                 }
939                 if (x->second.type != NamedAction) {
940                         return string ();
941                 }
942                 return x->second.action_name;
943         } else {
944                 if ((x = on_release.find (bs)) == on_release.end()) {
945                         return string();
946                 }
947                 if (x->second.type != NamedAction) {
948                         return string ();
949                 }
950                 return x->second.action_name;
951         }
952 }
953
954 void
955 FaderPort::Button::set_action (boost::function<void()> f, bool when_pressed, FaderPort::ButtonState bs)
956 {
957         ToDo todo;
958         todo.type = InternalFunction;
959
960         if (when_pressed) {
961                 todo.function = f;
962                 on_press[bs] = todo;
963         } else {
964                 todo.function = f;
965                 on_release[bs] = todo;
966         }
967 }
968
969 void
970 FaderPort::Button::set_led_state (boost::shared_ptr<MIDI::Port> port, bool onoff)
971 {
972         if (out < 0) {
973                 /* fader button ID - no LED */
974                 return;
975         }
976
977         MIDI::byte buf[3];
978         buf[0] = 0xa0;
979         buf[1] = out;
980         buf[2] = onoff ? 1 : 0;
981         port->write (buf, 3, 0);
982 }
983
984 int
985 FaderPort::Button::set_state (XMLNode const& node)
986 {
987         const XMLProperty* prop = node.property ("id");
988         if (!prop) {
989                 return -1;
990         }
991
992         int xid = atoi (prop->value());
993         if (xid != id) {
994                 return -1;
995         }
996
997         typedef pair<string,FaderPort::ButtonState> state_pair_t;
998         vector<state_pair_t> state_pairs;
999
1000         state_pairs.push_back (make_pair (string ("plain"), ButtonState (0)));
1001         state_pairs.push_back (make_pair (string ("shift"), ShiftDown));
1002         state_pairs.push_back (make_pair (string ("long"), LongPress));
1003
1004         on_press.clear ();
1005         on_release.clear ();
1006
1007         for (vector<state_pair_t>::const_iterator sp = state_pairs.begin(); sp != state_pairs.end(); ++sp) {
1008                 string propname;
1009
1010                 propname = sp->first + X_("-press");
1011                 if ((prop = node.property (propname)) != 0) {
1012                         set_action (prop->value(), true, sp->second);
1013                 }
1014
1015                 propname = sp->first + X_("-release");
1016                 if ((prop = node.property (propname)) != 0) {
1017                         set_action (prop->value(), false, sp->second);
1018                 }
1019         }
1020
1021         return 0;
1022 }
1023
1024 XMLNode&
1025 FaderPort::Button::get_state () const
1026 {
1027         XMLNode* node = new XMLNode (X_("Button"));
1028         char buf[16];
1029         snprintf (buf, sizeof (buf), "%d", id);
1030
1031         node->add_property (X_("id"), buf);
1032
1033         ToDoMap::const_iterator x;
1034         ToDo null;
1035         null.type = NamedAction;
1036
1037         typedef pair<string,FaderPort::ButtonState> state_pair_t;
1038         vector<state_pair_t> state_pairs;
1039
1040         state_pairs.push_back (make_pair (string ("plain"), ButtonState (0)));
1041         state_pairs.push_back (make_pair (string ("shift"), ShiftDown));
1042         state_pairs.push_back (make_pair (string ("long"), LongPress));
1043
1044         for (vector<state_pair_t>::const_iterator sp = state_pairs.begin(); sp != state_pairs.end(); ++sp) {
1045                 if ((x = on_press.find (sp->second)) != on_press.end()) {
1046                         if (x->second.type == NamedAction) {
1047                                 node->add_property (string (sp->first + X_("-press")).c_str(), x->second.action_name);
1048                         }
1049                 }
1050
1051                 if ((x = on_release.find (sp->second)) != on_release.end()) {
1052                         if (x->second.type == NamedAction) {
1053                                 node->add_property (string (sp->first + X_("-release")).c_str(), x->second.action_name);
1054                         }
1055                 }
1056         }
1057
1058         return *node;
1059 }
1060
1061 void
1062 FaderPort::gui_track_selection_changed (RouteNotificationListPtr routes)
1063 {
1064         boost::shared_ptr<Route> r;
1065
1066         if (!routes->empty()) {
1067                 r = routes->front().lock();
1068         }
1069
1070         set_current_route (r);
1071 }
1072
1073 void
1074 FaderPort::drop_current_route ()
1075 {
1076         if (_current_route) {
1077                 if (_current_route == session->monitor_out()) {
1078                         set_current_route (session->master_out());
1079                 } else {
1080                         set_current_route (boost::shared_ptr<Route>());
1081                 }
1082         }
1083 }
1084
1085 void
1086 FaderPort::set_current_route (boost::shared_ptr<Route> r)
1087 {
1088         route_connections.drop_connections ();
1089
1090         _current_route = r;
1091
1092         /* turn this off. It will be turned on back on in use_master() or
1093            use_monitor() as appropriate.
1094         */
1095         get_button(Output).set_led_state (_output_port, false);
1096
1097         if (_current_route) {
1098                 _current_route->DropReferences.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::drop_current_route, this), this);
1099
1100                 _current_route->mute_changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_mute, this, _1), this);
1101                 _current_route->solo_changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_solo, this, _1, _2, _3), this);
1102                 _current_route->listen_changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_listen, this, _1, _2), this);
1103
1104                 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_route);
1105                 if (t) {
1106                         t->RecordEnableChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_recenable, this), this);
1107                 }
1108
1109                 boost::shared_ptr<AutomationControl> control = _current_route->gain_control ();
1110                 if (control) {
1111                         control->Changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_gain, this), this);
1112                         control->alist()->automation_state_changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_auto, this), this);
1113                 }
1114
1115                 boost::shared_ptr<MonitorProcessor> mp = _current_route->monitor_control();
1116                 if (mp) {
1117                         mp->cut_control()->Changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_cut, this), this);
1118                 }
1119         }
1120
1121         //ToDo: subscribe to the fader automation modes so we can light the LEDs
1122
1123         map_route_state ();
1124 }
1125
1126 void
1127 FaderPort::map_auto ()
1128 {
1129         /* Under no circumstances send a message to "enable" the LED state of
1130          * the Off button, because this will disable the fader.
1131          */
1132
1133         boost::shared_ptr<AutomationControl> control = _current_route->gain_control ();
1134         const AutoState as = control->automation_state ();
1135
1136         switch (as) {
1137                 case ARDOUR::Play:
1138                         get_button (FP_Read).set_led_state (_output_port, true);
1139                         get_button (FP_Write).set_led_state (_output_port, false);
1140                         get_button (FP_Touch).set_led_state (_output_port, false);
1141                 break;
1142                 case ARDOUR::Write:
1143                         get_button (FP_Read).set_led_state (_output_port, false);
1144                         get_button (FP_Write).set_led_state (_output_port, true);
1145                         get_button (FP_Touch).set_led_state (_output_port, false);
1146                 break;
1147                 case ARDOUR::Touch:
1148                         get_button (FP_Read).set_led_state (_output_port, false);
1149                         get_button (FP_Write).set_led_state (_output_port, false);
1150                         get_button (FP_Touch).set_led_state (_output_port, true);
1151                 break;
1152                 case ARDOUR::Off:
1153                         get_button (FP_Read).set_led_state (_output_port, false);
1154                         get_button (FP_Write).set_led_state (_output_port, false);
1155                         get_button (FP_Touch).set_led_state (_output_port, false);
1156                 break;
1157         }
1158
1159 }
1160
1161
1162 void
1163 FaderPort::map_cut ()
1164 {
1165         boost::shared_ptr<MonitorProcessor> mp = _current_route->monitor_control();
1166
1167         if (mp) {
1168                 bool yn = mp->cut_all ();
1169                 if (yn) {
1170                         start_blinking (Mute);
1171                 } else {
1172                         stop_blinking (Mute);
1173                 }
1174         } else {
1175                 stop_blinking (Mute);
1176         }
1177 }
1178
1179 void
1180 FaderPort::map_mute (void*)
1181 {
1182         if (_current_route) {
1183                 if (_current_route->muted()) {
1184                         stop_blinking (Mute);
1185                         get_button (Mute).set_led_state (_output_port, true);
1186                 } else if (_current_route->muted_by_others()) {
1187                         start_blinking (Mute);
1188                 } else {
1189                         stop_blinking (Mute);
1190                 }
1191         } else {
1192                 stop_blinking (Mute);
1193         }
1194 }
1195
1196 void
1197 FaderPort::map_solo (bool, void*, bool)
1198 {
1199         if (_current_route) {
1200                 get_button (Solo).set_led_state (_output_port, _current_route->soloed() || _current_route->listening_via_monitor());
1201         } else {
1202                 get_button (Solo).set_led_state (_output_port, false);
1203         }
1204 }
1205
1206 void
1207 FaderPort::map_listen (void*, bool)
1208 {
1209         if (_current_route) {
1210                 get_button (Solo).set_led_state (_output_port, _current_route->listening_via_monitor());
1211         } else {
1212                 get_button (Solo).set_led_state (_output_port, false);
1213         }
1214 }
1215
1216 void
1217 FaderPort::map_recenable ()
1218 {
1219         boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_route);
1220         if (t) {
1221                 get_button (Rec).set_led_state (_output_port, t->record_enabled());
1222         } else {
1223                 get_button (Rec).set_led_state (_output_port, false);
1224         }
1225 }
1226
1227 void
1228 FaderPort::map_gain ()
1229 {
1230         if (fader_is_touched) {
1231                 /* Do not send fader moves while the user is touching the fader */
1232                 return;
1233         }
1234
1235         if (!_current_route) {
1236                 return;
1237         }
1238
1239         boost::shared_ptr<AutomationControl> control = _current_route->gain_control ();
1240         double val;
1241
1242         if (!control) {
1243                 val = 0.0;
1244         } else {
1245                 val = control->internal_to_interface (control->get_value ());
1246         }
1247
1248         /* Faderport sends fader position with range 0..16384 (though some of
1249          * the least-significant bits at the top end are missing - it may only
1250          * get to 1636X or so).
1251          *
1252          * But ... position must be sent in the range 0..1023.
1253          *
1254          * Thanks, Obama.
1255          */
1256
1257         int ival = (int) lrintf (val * 1023.0);
1258
1259         /* MIDI normalization requires that we send two separate messages here,
1260          * not one single 6 byte one.
1261          */
1262
1263         MIDI::byte buf[3];
1264
1265         buf[0] = 0xb0;
1266         buf[1] = 0x0;
1267         buf[2] = ival >> 7;
1268
1269         _output_port->write (buf, 3, 0);
1270
1271         buf[1] = 0x20;
1272         buf[2] = ival & 0x7f;
1273
1274         _output_port->write (buf, 3, 0);
1275 }
1276
1277 void
1278 FaderPort::map_route_state ()
1279 {
1280         if (!_current_route) {
1281                 stop_blinking (Mute);
1282                 stop_blinking (Solo);
1283                 get_button (Rec).set_led_state (_output_port, false);
1284         } else {
1285                 /* arguments to these map_*() methods are all ignored */
1286                 map_solo (false, 0, false);
1287                 map_recenable ();
1288                 map_gain ();
1289                 map_auto ();
1290
1291                 if (_current_route == session->monitor_out()) {
1292                         map_cut ();
1293                 } else {
1294                         map_mute (0);
1295                 }
1296         }
1297 }
1298
1299 list<boost::shared_ptr<ARDOUR::Bundle> >
1300 FaderPort::bundles ()
1301 {
1302         list<boost::shared_ptr<ARDOUR::Bundle> > b;
1303
1304         if (_input_bundle) {
1305                 b.push_back (_input_bundle);
1306                 b.push_back (_output_bundle);
1307         }
1308
1309         return b;
1310 }
1311
1312 boost::shared_ptr<Port>
1313 FaderPort::output_port()
1314 {
1315         return _output_port;
1316 }
1317
1318 boost::shared_ptr<Port>
1319 FaderPort::input_port()
1320 {
1321         return _input_port;
1322 }
1323
1324 void
1325 FaderPort::set_action (ButtonID id, std::string const& action_name, bool on_press, ButtonState bs)
1326 {
1327         get_button(id).set_action (action_name, on_press, bs);
1328 }
1329
1330 string
1331 FaderPort::get_action (ButtonID id, bool press, ButtonState bs)
1332 {
1333         return get_button(id).get_action (press, bs);
1334 }