faderport: remove wierd shift use design; make user+shift work again
[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> (name())
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, ButtonState(ShiftDown|UserDown));
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::request_factory (uint32_t num_requests)
215 {
216         /* AbstractUI<T>::request_buffer_factory() is a template method only
217            instantiated in this source module. To provide something visible for
218            use in the interface/descriptor, we have this static method that is
219            template-free.
220         */
221         return request_buffer_factory (num_requests);
222 }
223
224 void
225 FaderPort::start_midi_handling ()
226 {
227         /* handle device inquiry response */
228         _input_port->parser()->sysex.connect_same_thread (midi_connections, boost::bind (&FaderPort::sysex_handler, this, _1, _2, _3));
229         /* handle buttons */
230         _input_port->parser()->poly_pressure.connect_same_thread (midi_connections, boost::bind (&FaderPort::button_handler, this, _1, _2));
231         /* handle encoder */
232         _input_port->parser()->pitchbend.connect_same_thread (midi_connections, boost::bind (&FaderPort::encoder_handler, this, _1, _2));
233         /* handle fader */
234         _input_port->parser()->controller.connect_same_thread (midi_connections, boost::bind (&FaderPort::fader_handler, this, _1, _2));
235
236         /* This connection means that whenever data is ready from the input
237          * port, the relevant thread will invoke our ::midi_input_handler()
238          * method, which will read the data, and invoke the parser.
239          */
240
241         _input_port->xthread().set_receive_handler (sigc::bind (sigc::mem_fun (this, &FaderPort::midi_input_handler), _input_port));
242         _input_port->xthread().attach (main_loop()->get_context());
243 }
244
245 void
246 FaderPort::stop_midi_handling ()
247 {
248         midi_connections.drop_connections ();
249
250         /* Note: the input handler is still active at this point, but we're no
251          * longer connected to any of the parser signals
252          */
253 }
254
255 void
256 FaderPort::do_request (FaderPortRequest* req)
257 {
258         if (req->type == CallSlot) {
259
260                 call_slot (MISSING_INVALIDATOR, req->the_slot);
261
262         } else if (req->type == Quit) {
263
264                 stop ();
265         }
266 }
267
268 int
269 FaderPort::stop ()
270 {
271         BaseUI::quit ();
272
273         return 0;
274 }
275
276 void
277 FaderPort::thread_init ()
278 {
279         struct sched_param rtparam;
280
281         pthread_set_name (event_loop_name().c_str());
282
283         PBD::notify_event_loops_about_thread_creation (pthread_self(), event_loop_name(), 2048);
284         ARDOUR::SessionEvent::create_per_thread_pool (event_loop_name(), 128);
285
286         memset (&rtparam, 0, sizeof (rtparam));
287         rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
288
289         if (pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam) != 0) {
290                 // do we care? not particularly.
291         }
292 }
293
294 void
295 FaderPort::all_lights_out ()
296 {
297         for (ButtonMap::iterator b = buttons.begin(); b != buttons.end(); ++b) {
298                 b->second.set_led_state (_output_port, false);
299         }
300 }
301
302 FaderPort::Button&
303 FaderPort::get_button (ButtonID id) const
304 {
305         ButtonMap::const_iterator b = buttons.find (id);
306         assert (b != buttons.end());
307         return const_cast<Button&>(b->second);
308 }
309
310 bool
311 FaderPort::button_long_press_timeout (ButtonID id)
312 {
313         if (buttons_down.find (id) != buttons_down.end()) {
314                 get_button (id).invoke (ButtonState (LongPress|button_state), false);
315         } else {
316                 /* release happened and somehow we were not cancelled */
317         }
318
319         /* whichever button this was, we've used it ... don't invoke the
320            release action.
321         */
322         consumed.insert (id);
323
324         return false; /* don't get called again */
325 }
326
327 void
328 FaderPort::start_press_timeout (Button& button, ButtonID id)
329 {
330         Glib::RefPtr<Glib::TimeoutSource> timeout = Glib::TimeoutSource::create (500); // milliseconds
331         button.timeout_connection = timeout->connect (sigc::bind (sigc::mem_fun (*this, &FaderPort::button_long_press_timeout), id));
332         timeout->attach (main_loop()->get_context());
333 }
334
335 void
336 FaderPort::button_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
337 {
338         ButtonID id (ButtonID (tb->controller_number));
339         Button& button (get_button (id));
340
341         DEBUG_TRACE (DEBUG::FaderPort, string_compose ("button event for ID %1 named %3, press ? %2\n", (int) tb->controller_number, (tb->value ? "yes" : "no"), button.name));
342
343         if (tb->value) {
344                 buttons_down.insert (id);
345         } else {
346                 buttons_down.erase (id);
347                 button.timeout_connection.disconnect ();
348         }
349
350         ButtonState bs (ButtonState (0));
351
352         switch (id) {
353         case Shift:
354                 bs = ShiftDown;
355                 break;
356         case Stop:
357                 bs = StopDown;
358                 break;
359         case Rewind:
360                 bs = RewindDown;
361                 break;
362         case User:
363                 bs = UserDown;
364                 break;
365         case FaderTouch:
366                 fader_is_touched = tb->value;
367                 if (_current_route) {
368                         boost::shared_ptr<AutomationControl> gain = _current_route->gain_control ();
369                         if (gain) {
370                                 framepos_t now = session->engine().sample_time();
371                                 if (tb->value) {
372                                         gain->start_touch (now);
373                                 } else {
374                                         gain->stop_touch (true, now);
375                                 }
376                         }
377                 }
378                 break;
379         default:
380                 if (tb->value) {
381                         start_press_timeout (button, id);
382                 }
383                 break;
384         }
385
386         if (bs) {
387                 button_state = (tb->value ? ButtonState (button_state|bs) : ButtonState (button_state&~bs));
388                 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("reset button state to %1 using %2\n", button_state, (int) bs));
389         }
390
391         if (button.uses_flash()) {
392                 button.set_led_state (_output_port, (int)tb->value);
393         }
394
395         set<ButtonID>::iterator c = consumed.find (id);
396
397         if (c == consumed.end()) {
398                 button.invoke (button_state, tb->value ? true : false);
399         } else {
400                 DEBUG_TRACE (DEBUG::FaderPort, "button was consumed, ignored\n");
401                 consumed.erase (c);
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         DEBUG_TRACE (DEBUG::FaderPort, string_compose ("sysex message received, size = %1\n", sz));
508
509         if (sz < 17) {
510                 return;
511         }
512
513         if (buf[2] != 0x7f ||
514             buf[3] != 0x06 ||
515             buf[4] != 0x02 ||
516             buf[5] != 0x0 ||
517             buf[6] != 0x1 ||
518             buf[7] != 0x06 ||
519             buf[8] != 0x02 ||
520             buf[9] != 0x0 ||
521             buf[10] != 0x01 ||
522             buf[11] != 0x0) {
523                 return;
524         }
525
526         _device_active = true;
527
528         DEBUG_TRACE (DEBUG::FaderPort, "FaderPort identified via MIDI Device Inquiry response\n");
529
530         /* put it into native mode */
531
532         MIDI::byte native[3];
533         native[0] = 0x91;
534         native[1] = 0x00;
535         native[2] = 0x64;
536
537         _output_port->write (native, 3, 0);
538
539         all_lights_out ();
540
541         /* catch up on state */
542
543         map_transport_state ();
544         map_recenable_state ();
545 }
546
547 int
548 FaderPort::set_active (bool yn)
549 {
550         DEBUG_TRACE (DEBUG::FaderPort, string_compose("Faderport::set_active init with yn: '%1'\n", yn));
551
552         if (yn == active()) {
553                 return 0;
554         }
555
556         if (yn) {
557
558                 /* start event loop */
559
560                 BaseUI::run ();
561
562                 connect_session_signals ();
563
564                 Glib::RefPtr<Glib::TimeoutSource> blink_timeout = Glib::TimeoutSource::create (200); // milliseconds
565                 blink_connection = blink_timeout->connect (sigc::mem_fun (*this, &FaderPort::blink));
566                 blink_timeout->attach (main_loop()->get_context());
567
568                 Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
569                 periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &FaderPort::periodic));
570                 periodic_timeout->attach (main_loop()->get_context());
571
572         } else {
573
574                 BaseUI::quit ();
575                 close ();
576
577         }
578
579         ControlProtocol::set_active (yn);
580
581         DEBUG_TRACE (DEBUG::FaderPort, string_compose("Faderport::set_active done with yn: '%1'\n", yn));
582
583         return 0;
584 }
585
586 bool
587 FaderPort::periodic ()
588 {
589         if (!_current_route) {
590                 return true;
591         }
592
593         ARDOUR::AutoState gain_state = _current_route->gain_control()->automation_state();
594
595         if (gain_state == ARDOUR::Touch || gain_state == ARDOUR::Play) {
596                 map_gain ();
597         }
598
599         return true;
600 }
601
602 void
603 FaderPort::stop_blinking (ButtonID id)
604 {
605         blinkers.remove (id);
606         get_button (id).set_led_state (_output_port, false);
607 }
608
609 void
610 FaderPort::start_blinking (ButtonID id)
611 {
612         blinkers.push_back (id);
613         get_button (id).set_led_state (_output_port, true);
614 }
615
616 bool
617 FaderPort::blink ()
618 {
619         blink_state = !blink_state;
620
621         for (Blinkers::iterator b = blinkers.begin(); b != blinkers.end(); b++) {
622                 get_button(*b).set_led_state (_output_port, blink_state);
623         }
624
625         return true;
626 }
627
628 void
629 FaderPort::close ()
630 {
631         all_lights_out ();
632
633         stop_midi_handling ();
634         session_connections.drop_connections ();
635         port_connection.disconnect ();
636         blink_connection.disconnect ();
637         selection_connection.disconnect ();
638         route_connections.drop_connections ();
639
640 #if 0
641         route_connections.drop_connections ();
642 #endif
643 }
644
645 void
646 FaderPort::map_recenable_state ()
647 {
648         switch (session->record_status()) {
649         case Session::Disabled:
650                 stop_blinking (RecEnable);
651                 break;
652         case Session::Enabled:
653                 start_blinking (RecEnable);
654                 break;
655         case Session::Recording:
656                 stop_blinking (RecEnable);
657                 break;
658         }
659 }
660
661 void
662 FaderPort::map_transport_state ()
663 {
664         get_button (Loop).set_led_state (_output_port, session->get_play_loop());
665
666         float ts = session->transport_speed();
667
668         if (ts == 0) {
669                 stop_blinking (Play);
670         } else if (fabs (ts) == 1.0) {
671                 stop_blinking (Play);
672                 get_button (Play).set_led_state (_output_port, true);
673         } else {
674                 start_blinking (Play);
675         }
676
677         get_button (Stop).set_led_state (_output_port, session->transport_stopped ());
678         get_button (Rewind).set_led_state (_output_port, session->transport_speed() < 0.0);
679         get_button (Ffwd).set_led_state (_output_port, session->transport_speed() > 1.0);
680 }
681
682 void
683 FaderPort::parameter_changed (string what)
684 {
685         if (what == "punch-in" || what == "punch-out") {
686                 bool in = session->config.get_punch_in ();
687                 bool out = session->config.get_punch_out ();
688                 if (in && out) {
689                         get_button (Punch).set_led_state (_output_port, true);
690                         blinkers.remove (Punch);
691                 } else if (in || out) {
692                         start_blinking (Punch);
693                 } else {
694                         stop_blinking (Punch);
695                 }
696         }
697 }
698
699 void
700 FaderPort::connect_session_signals()
701 {
702         session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_recenable_state, this), this);
703         session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_transport_state, this), this);
704         /* not session, but treat it similarly */
705         session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::parameter_changed, this, _1), this);
706 }
707
708 bool
709 FaderPort::midi_input_handler (Glib::IOCondition ioc, boost::shared_ptr<ARDOUR::AsyncMIDIPort> port)
710 {
711         DEBUG_TRACE (DEBUG::FaderPort, string_compose ("something happend on  %1\n", boost::shared_ptr<MIDI::Port>(port)->name()));
712
713         if (ioc & ~IO_IN) {
714                 return false;
715         }
716
717         if (ioc & IO_IN) {
718
719                 port->clear ();
720                 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("data available on %1\n", boost::shared_ptr<MIDI::Port>(port)->name()));
721                 framepos_t now = session->engine().sample_time();
722                 port->parse (now);
723         }
724
725         return true;
726 }
727
728
729 XMLNode&
730 FaderPort::get_state ()
731 {
732         XMLNode& node (ControlProtocol::get_state());
733
734         XMLNode* child;
735
736         child = new XMLNode (X_("Input"));
737         child->add_child_nocopy (boost::shared_ptr<ARDOUR::Port>(_input_port)->get_state());
738         node.add_child_nocopy (*child);
739
740
741         child = new XMLNode (X_("Output"));
742         child->add_child_nocopy (boost::shared_ptr<ARDOUR::Port>(_output_port)->get_state());
743         node.add_child_nocopy (*child);
744
745         /* Save action state for Mix, Proj, Trns and User buttons, since these
746          * are user controlled. We can only save named-action operations, since
747          * internal functions are just pointers to functions and hard to
748          * serialize without enumerating them all somewhere.
749          */
750
751         node.add_child_nocopy (get_button (Mix).get_state());
752         node.add_child_nocopy (get_button (Proj).get_state());
753         node.add_child_nocopy (get_button (Trns).get_state());
754         node.add_child_nocopy (get_button (User).get_state());
755
756         return node;
757 }
758
759 int
760 FaderPort::set_state (const XMLNode& node, int version)
761 {
762         XMLNodeList nlist;
763         XMLNodeConstIterator niter;
764         XMLNode const* child;
765
766         if (ControlProtocol::set_state (node, version)) {
767                 return -1;
768         }
769
770         if ((child = node.child (X_("Input"))) != 0) {
771                 XMLNode* portnode = child->child (Port::state_node_name.c_str());
772                 if (portnode) {
773                         boost::shared_ptr<ARDOUR::Port>(_input_port)->set_state (*portnode, version);
774                 }
775         }
776
777         if ((child = node.child (X_("Output"))) != 0) {
778                 XMLNode* portnode = child->child (Port::state_node_name.c_str());
779                 if (portnode) {
780                         boost::shared_ptr<ARDOUR::Port>(_output_port)->set_state (*portnode, version);
781                 }
782         }
783
784         for (XMLNodeList::const_iterator n = node.children().begin(); n != node.children().end(); ++n) {
785                 if ((*n)->name() == X_("Button")) {
786                         XMLProperty const * prop = (*n)->property (X_("id"));
787                         if (!prop) {
788                                 continue;
789                         }
790                         int xid = atoi (prop->value());
791                         ButtonMap::iterator b = buttons.find (ButtonID (xid));
792                         if (b == buttons.end()) {
793                                 continue;
794                         }
795                         b->second.set_state (**n);
796                 }
797         }
798
799         return 0;
800 }
801
802 bool
803 FaderPort::connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool yn)
804 {
805         DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler  start\n");
806         if (!_input_port || !_output_port) {
807                 return false;
808         }
809
810         string ni = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_input_port)->name());
811         string no = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_output_port)->name());
812
813         if (ni == name1 || ni == name2) {
814                 if (yn) {
815                         connection_state |= InputConnected;
816                 } else {
817                         connection_state &= ~InputConnected;
818                 }
819         } else if (no == name1 || no == name2) {
820                 if (yn) {
821                         connection_state |= OutputConnected;
822                 } else {
823                         connection_state &= ~OutputConnected;
824                 }
825         } else {
826                 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("Connections between %1 and %2 changed, but I ignored it\n", name1, name2));
827                 /* not our ports */
828                 return false;
829         }
830
831         if ((connection_state & (InputConnected|OutputConnected)) == (InputConnected|OutputConnected)) {
832
833                 /* XXX this is a horrible hack. Without a short sleep here,
834                    something prevents the device wakeup messages from being
835                    sent and/or the responses from being received.
836                 */
837
838                 g_usleep (100000);
839                 DEBUG_TRACE (DEBUG::FaderPort, "device now connected for both input and output\n");
840                 connected ();
841
842         } else {
843                 DEBUG_TRACE (DEBUG::FaderPort, "Device disconnected (input or output or both) or not yet fully connected\n");
844                 _device_active = false;
845         }
846
847         ConnectionChange (); /* emit signal for our GUI */
848
849         DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler  end\n");
850
851         return true; /* connection status changed */
852 }
853
854 void
855 FaderPort::connected ()
856 {
857         DEBUG_TRACE (DEBUG::FaderPort, "sending device inquiry message...\n");
858
859         start_midi_handling ();
860
861         /* send device inquiry */
862
863         MIDI::byte buf[6];
864
865         buf[0] = 0xf0;
866         buf[1] = 0x7e;
867         buf[2] = 0x7f;
868         buf[3] = 0x06;
869         buf[4] = 0x01;
870         buf[5] = 0xf7;
871
872         _output_port->write (buf, 6, 0);
873 }
874
875 void
876 FaderPort::Button::invoke (FaderPort::ButtonState bs, bool press)
877 {
878         DEBUG_TRACE (DEBUG::FaderPort, string_compose ("invoke button %1 for %2 state %3%4%5\n", id, (press ? "press":"release"), hex, bs, dec));
879
880         ToDoMap::iterator x;
881
882         if (press) {
883                 if ((x = on_press.find (bs)) == on_press.end()) {
884                         DEBUG_TRACE (DEBUG::FaderPort, string_compose ("no press action for button %1 state %2 @ %3 in %4\n", id, bs, this, &on_press));
885                         return;
886                 }
887         } else {
888                 if ((x = on_release.find (bs)) == on_release.end()) {
889                         DEBUG_TRACE (DEBUG::FaderPort, string_compose ("no release action for button %1 state %2 @%3 in %4\n", id, bs, this, &on_release));
890                         return;
891                 }
892         }
893
894         switch (x->second.type) {
895         case NamedAction:
896                 if (!x->second.action_name.empty()) {
897                         fp.access_action (x->second.action_name);
898                 }
899                 break;
900         case InternalFunction:
901                 if (x->second.function) {
902                         x->second.function ();
903                 }
904         }
905 }
906
907 void
908 FaderPort::Button::set_action (string const& name, bool when_pressed, FaderPort::ButtonState bs)
909 {
910         ToDo todo;
911
912         todo.type = NamedAction;
913
914         if (when_pressed) {
915                 if (name.empty()) {
916                         on_press.erase (bs);
917                 } else {
918                         DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 to action %2 on press + %3%4%5\n", id, name, bs));
919                         todo.action_name = name;
920                         on_press[bs] = todo;
921                 }
922         } else {
923                 if (name.empty()) {
924                         on_release.erase (bs);
925                 } else {
926                         DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 to action %2 on release + %3%4%5\n", id, name, bs));
927                         todo.action_name = name;
928                         on_release[bs] = todo;
929                 }
930         }
931 }
932
933 string
934 FaderPort::Button::get_action (bool press, FaderPort::ButtonState bs)
935 {
936         ToDoMap::iterator x;
937
938         if (press) {
939                 if ((x = on_press.find (bs)) == on_press.end()) {
940                         return string();
941                 }
942                 if (x->second.type != NamedAction) {
943                         return string ();
944                 }
945                 return x->second.action_name;
946         } else {
947                 if ((x = on_release.find (bs)) == on_release.end()) {
948                         return string();
949                 }
950                 if (x->second.type != NamedAction) {
951                         return string ();
952                 }
953                 return x->second.action_name;
954         }
955 }
956
957 void
958 FaderPort::Button::set_action (boost::function<void()> f, bool when_pressed, FaderPort::ButtonState bs)
959 {
960         ToDo todo;
961         todo.type = InternalFunction;
962
963         if (when_pressed) {
964                 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 (%2) @ %5 to some functor on press + %3 in %4\n", id, name, bs, &on_press, this));
965                 todo.function = f;
966                 on_press[bs] = todo;
967         } else {
968                 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 (%2) @ %5 to some functor on release + %3\n", id, name, bs, this));
969                 todo.function = f;
970                 on_release[bs] = todo;
971         }
972 }
973
974 void
975 FaderPort::Button::set_led_state (boost::shared_ptr<MIDI::Port> port, bool onoff)
976 {
977         if (out < 0) {
978                 /* fader button ID - no LED */
979                 return;
980         }
981
982         MIDI::byte buf[3];
983         buf[0] = 0xa0;
984         buf[1] = out;
985         buf[2] = onoff ? 1 : 0;
986         port->write (buf, 3, 0);
987 }
988
989 int
990 FaderPort::Button::set_state (XMLNode const& node)
991 {
992         const XMLProperty* prop = node.property ("id");
993         if (!prop) {
994                 return -1;
995         }
996
997         int xid = atoi (prop->value());
998         if (xid != id) {
999                 return -1;
1000         }
1001
1002         typedef pair<string,FaderPort::ButtonState> state_pair_t;
1003         vector<state_pair_t> state_pairs;
1004
1005         state_pairs.push_back (make_pair (string ("plain"), ButtonState (0)));
1006         state_pairs.push_back (make_pair (string ("shift"), ShiftDown));
1007         state_pairs.push_back (make_pair (string ("long"), LongPress));
1008
1009         for (vector<state_pair_t>::const_iterator sp = state_pairs.begin(); sp != state_pairs.end(); ++sp) {
1010                 string propname;
1011
1012                 propname = sp->first + X_("-press");
1013                 if ((prop = node.property (propname)) != 0) {
1014                         set_action (prop->value(), true, sp->second);
1015                 }
1016
1017                 propname = sp->first + X_("-release");
1018                 if ((prop = node.property (propname)) != 0) {
1019                         set_action (prop->value(), false, sp->second);
1020                 }
1021         }
1022
1023         return 0;
1024 }
1025
1026 XMLNode&
1027 FaderPort::Button::get_state () const
1028 {
1029         XMLNode* node = new XMLNode (X_("Button"));
1030         char buf[16];
1031         snprintf (buf, sizeof (buf), "%d", id);
1032
1033         node->add_property (X_("id"), buf);
1034
1035         ToDoMap::const_iterator x;
1036         ToDo null;
1037         null.type = NamedAction;
1038
1039         typedef pair<string,FaderPort::ButtonState> state_pair_t;
1040         vector<state_pair_t> state_pairs;
1041
1042         state_pairs.push_back (make_pair (string ("plain"), ButtonState (0)));
1043         state_pairs.push_back (make_pair (string ("shift"), ShiftDown));
1044         state_pairs.push_back (make_pair (string ("long"), LongPress));
1045
1046         for (vector<state_pair_t>::const_iterator sp = state_pairs.begin(); sp != state_pairs.end(); ++sp) {
1047                 if ((x = on_press.find (sp->second)) != on_press.end()) {
1048                         if (x->second.type == NamedAction) {
1049                                 node->add_property (string (sp->first + X_("-press")).c_str(), x->second.action_name);
1050                         }
1051                 }
1052
1053                 if ((x = on_release.find (sp->second)) != on_release.end()) {
1054                         if (x->second.type == NamedAction) {
1055                                 node->add_property (string (sp->first + X_("-release")).c_str(), x->second.action_name);
1056                         }
1057                 }
1058         }
1059
1060         return *node;
1061 }
1062
1063 void
1064 FaderPort::gui_track_selection_changed (RouteNotificationListPtr routes)
1065 {
1066         boost::shared_ptr<Route> r;
1067
1068         if (!routes->empty()) {
1069                 r = routes->front().lock();
1070         }
1071
1072         set_current_route (r);
1073 }
1074
1075 void
1076 FaderPort::drop_current_route ()
1077 {
1078         if (_current_route) {
1079                 if (_current_route == session->monitor_out()) {
1080                         set_current_route (session->master_out());
1081                 } else {
1082                         set_current_route (boost::shared_ptr<Route>());
1083                 }
1084         }
1085 }
1086
1087 void
1088 FaderPort::set_current_route (boost::shared_ptr<Route> r)
1089 {
1090         route_connections.drop_connections ();
1091
1092         _current_route = r;
1093
1094         /* turn this off. It will be turned on back on in use_master() or
1095            use_monitor() as appropriate.
1096         */
1097         get_button(Output).set_led_state (_output_port, false);
1098
1099         if (_current_route) {
1100                 _current_route->DropReferences.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::drop_current_route, this), this);
1101
1102                 _current_route->mute_changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_mute, this, _1), this);
1103                 _current_route->solo_changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_solo, this, _1, _2, _3), this);
1104                 _current_route->listen_changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_listen, this, _1, _2), this);
1105
1106                 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_route);
1107                 if (t) {
1108                         t->RecordEnableChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_recenable, this), this);
1109                 }
1110
1111                 boost::shared_ptr<AutomationControl> control = _current_route->gain_control ();
1112                 if (control) {
1113                         control->Changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_gain, this), this);
1114                         control->alist()->automation_state_changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_auto, this), this);
1115                 }
1116
1117                 boost::shared_ptr<MonitorProcessor> mp = _current_route->monitor_control();
1118                 if (mp) {
1119                         mp->cut_control()->Changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_cut, this), this);
1120                 }
1121         }
1122
1123         //ToDo: subscribe to the fader automation modes so we can light the LEDs
1124
1125         map_route_state ();
1126 }
1127
1128 void
1129 FaderPort::map_auto ()
1130 {
1131         /* Under no circumstances send a message to "enable" the LED state of
1132          * the Off button, because this will disable the fader.
1133          */
1134
1135         boost::shared_ptr<AutomationControl> control = _current_route->gain_control ();
1136         const AutoState as = control->automation_state ();
1137
1138         switch (as) {
1139                 case ARDOUR::Play:
1140                         get_button (FP_Read).set_led_state (_output_port, true);
1141                         get_button (FP_Write).set_led_state (_output_port, false);
1142                         get_button (FP_Touch).set_led_state (_output_port, false);
1143                 break;
1144                 case ARDOUR::Write:
1145                         get_button (FP_Read).set_led_state (_output_port, false);
1146                         get_button (FP_Write).set_led_state (_output_port, true);
1147                         get_button (FP_Touch).set_led_state (_output_port, false);
1148                 break;
1149                 case ARDOUR::Touch:
1150                         get_button (FP_Read).set_led_state (_output_port, false);
1151                         get_button (FP_Write).set_led_state (_output_port, false);
1152                         get_button (FP_Touch).set_led_state (_output_port, true);
1153                 break;
1154                 case ARDOUR::Off:
1155                         get_button (FP_Read).set_led_state (_output_port, false);
1156                         get_button (FP_Write).set_led_state (_output_port, false);
1157                         get_button (FP_Touch).set_led_state (_output_port, false);
1158                 break;
1159         }
1160
1161 }
1162
1163
1164 void
1165 FaderPort::map_cut ()
1166 {
1167         boost::shared_ptr<MonitorProcessor> mp = _current_route->monitor_control();
1168
1169         if (mp) {
1170                 bool yn = mp->cut_all ();
1171                 if (yn) {
1172                         start_blinking (Mute);
1173                 } else {
1174                         stop_blinking (Mute);
1175                 }
1176         } else {
1177                 stop_blinking (Mute);
1178         }
1179 }
1180
1181 void
1182 FaderPort::map_mute (void*)
1183 {
1184         if (_current_route) {
1185                 if (_current_route->muted()) {
1186                         stop_blinking (Mute);
1187                         get_button (Mute).set_led_state (_output_port, true);
1188                 } else if (_current_route->muted_by_others()) {
1189                         start_blinking (Mute);
1190                 } else {
1191                         stop_blinking (Mute);
1192                 }
1193         } else {
1194                 stop_blinking (Mute);
1195         }
1196 }
1197
1198 void
1199 FaderPort::map_solo (bool, void*, bool)
1200 {
1201         if (_current_route) {
1202                 get_button (Solo).set_led_state (_output_port, _current_route->soloed() || _current_route->listening_via_monitor());
1203         } else {
1204                 get_button (Solo).set_led_state (_output_port, false);
1205         }
1206 }
1207
1208 void
1209 FaderPort::map_listen (void*, bool)
1210 {
1211         if (_current_route) {
1212                 get_button (Solo).set_led_state (_output_port, _current_route->listening_via_monitor());
1213         } else {
1214                 get_button (Solo).set_led_state (_output_port, false);
1215         }
1216 }
1217
1218 void
1219 FaderPort::map_recenable ()
1220 {
1221         boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_route);
1222         if (t) {
1223                 get_button (Rec).set_led_state (_output_port, t->record_enabled());
1224         } else {
1225                 get_button (Rec).set_led_state (_output_port, false);
1226         }
1227 }
1228
1229 void
1230 FaderPort::map_gain ()
1231 {
1232         if (fader_is_touched) {
1233                 /* Do not send fader moves while the user is touching the fader */
1234                 return;
1235         }
1236
1237         if (!_current_route) {
1238                 return;
1239         }
1240
1241         boost::shared_ptr<AutomationControl> control = _current_route->gain_control ();
1242         double val;
1243
1244         if (!control) {
1245                 val = 0.0;
1246         } else {
1247                 val = control->internal_to_interface (control->get_value ());
1248         }
1249
1250         /* Faderport sends fader position with range 0..16384 (though some of
1251          * the least-significant bits at the top end are missing - it may only
1252          * get to 1636X or so).
1253          *
1254          * But ... position must be sent in the range 0..1023.
1255          *
1256          * Thanks, Obama.
1257          */
1258
1259         int ival = (int) lrintf (val * 1023.0);
1260
1261         /* MIDI normalization requires that we send two separate messages here,
1262          * not one single 6 byte one.
1263          */
1264
1265         MIDI::byte buf[3];
1266
1267         buf[0] = 0xb0;
1268         buf[1] = 0x0;
1269         buf[2] = ival >> 7;
1270
1271         _output_port->write (buf, 3, 0);
1272
1273         buf[1] = 0x20;
1274         buf[2] = ival & 0x7f;
1275
1276         _output_port->write (buf, 3, 0);
1277 }
1278
1279 void
1280 FaderPort::map_route_state ()
1281 {
1282         if (!_current_route) {
1283                 stop_blinking (Mute);
1284                 stop_blinking (Solo);
1285                 get_button (Rec).set_led_state (_output_port, false);
1286         } else {
1287                 /* arguments to these map_*() methods are all ignored */
1288                 map_solo (false, 0, false);
1289                 map_recenable ();
1290                 map_gain ();
1291                 map_auto ();
1292
1293                 if (_current_route == session->monitor_out()) {
1294                         map_cut ();
1295                 } else {
1296                         map_mute (0);
1297                 }
1298         }
1299 }
1300
1301 list<boost::shared_ptr<ARDOUR::Bundle> >
1302 FaderPort::bundles ()
1303 {
1304         list<boost::shared_ptr<ARDOUR::Bundle> > b;
1305
1306         if (_input_bundle) {
1307                 b.push_back (_input_bundle);
1308                 b.push_back (_output_bundle);
1309         }
1310
1311         return b;
1312 }
1313
1314 boost::shared_ptr<Port>
1315 FaderPort::output_port()
1316 {
1317         return _output_port;
1318 }
1319
1320 boost::shared_ptr<Port>
1321 FaderPort::input_port()
1322 {
1323         return _input_port;
1324 }
1325
1326 void
1327 FaderPort::set_action (ButtonID id, std::string const& action_name, bool on_press, ButtonState bs)
1328 {
1329         get_button(id).set_action (action_name, on_press, bs);
1330 }
1331
1332 string
1333 FaderPort::get_action (ButtonID id, bool press, ButtonState bs)
1334 {
1335         return get_button(id).get_action (press, bs);
1336 }