2 Copyright (C) 2015 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include <glibmm/fileutils.h>
27 #include <glibmm/miscutils.h>
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"
37 #include "midi++/port.h"
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"
55 #include "faderport.h"
57 using namespace ARDOUR;
58 using namespace ArdourSurface;
65 #include "pbd/abstract_ui.cc" // instantiate template
67 FaderPort::FaderPort (Session& s)
68 : ControlProtocol (s, _("Faderport"))
69 , AbstractUI<FaderPortRequest> (name())
71 , connection_state (ConnectionState (0))
72 , _device_active (false)
75 , fader_is_touched (false)
76 , button_state (ButtonState (0))
79 last_encoder_time = 0;
81 boost::shared_ptr<ARDOUR::Port> inp;
82 boost::shared_ptr<ARDOUR::Port> outp;
84 inp = AudioEngine::instance()->register_input_port (DataType::MIDI, "Faderport Recv", true);
85 outp = AudioEngine::instance()->register_output_port (DataType::MIDI, "Faderport Send", true);
87 _input_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(inp);
88 _output_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(outp);
90 if (_input_port == 0 || _output_port == 0) {
91 throw failed_constructor();
94 _input_bundle.reset (new ARDOUR::Bundle (_("Faderport Support (Receive)"), true));
95 _output_bundle.reset (new ARDOUR::Bundle (_("Faderport Support (Send) "), false));
97 _input_bundle->add_channel (
99 ARDOUR::DataType::MIDI,
100 session->engine().make_port_name_non_relative (inp->name())
103 _output_bundle->add_channel (
105 ARDOUR::DataType::MIDI,
106 session->engine().make_port_name_non_relative (outp->name())
110 TrackSelectionChanged.connect (selection_connection, MISSING_INVALIDATOR, boost::bind (&FaderPort::gui_track_selection_changed, this, _1), this);
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);
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)));
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);
147 get_button (Left).set_action ( boost::bind (&FaderPort::left, this), true);
148 get_button (Right).set_action ( boost::bind (&FaderPort::right, this), true);
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);
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);
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
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);
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));
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);
179 get_button (Punch).set_action (boost::bind (&FaderPort::punch, this), true);
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);
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));
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);
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);
195 FaderPort::~FaderPort ()
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 ();
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 ();
214 FaderPort::request_factory (uint32_t num_requests)
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
221 return request_buffer_factory (num_requests);
225 FaderPort::start_midi_handling ()
227 /* handle device inquiry response */
228 _input_port->parser()->sysex.connect_same_thread (midi_connections, boost::bind (&FaderPort::sysex_handler, this, _1, _2, _3));
230 _input_port->parser()->poly_pressure.connect_same_thread (midi_connections, boost::bind (&FaderPort::button_handler, this, _1, _2));
232 _input_port->parser()->pitchbend.connect_same_thread (midi_connections, boost::bind (&FaderPort::encoder_handler, this, _1, _2));
234 _input_port->parser()->controller.connect_same_thread (midi_connections, boost::bind (&FaderPort::fader_handler, this, _1, _2));
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.
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());
246 FaderPort::stop_midi_handling ()
248 midi_connections.drop_connections ();
250 /* Note: the input handler is still active at this point, but we're no
251 * longer connected to any of the parser signals
256 FaderPort::do_request (FaderPortRequest* req)
258 if (req->type == CallSlot) {
260 call_slot (MISSING_INVALIDATOR, req->the_slot);
262 } else if (req->type == Quit) {
277 FaderPort::thread_init ()
279 struct sched_param rtparam;
281 pthread_set_name (event_loop_name().c_str());
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);
286 memset (&rtparam, 0, sizeof (rtparam));
287 rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
289 if (pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam) != 0) {
290 // do we care? not particularly.
295 FaderPort::all_lights_out ()
297 for (ButtonMap::iterator b = buttons.begin(); b != buttons.end(); ++b) {
298 b->second.set_led_state (_output_port, false);
303 FaderPort::get_button (ButtonID id) const
305 ButtonMap::const_iterator b = buttons.find (id);
306 assert (b != buttons.end());
307 return const_cast<Button&>(b->second);
311 FaderPort::button_long_press_timeout (ButtonID id)
313 if (buttons_down.find (id) != buttons_down.end()) {
314 get_button (id).invoke (ButtonState (LongPress|button_state), false);
316 /* release happened and somehow we were not cancelled */
319 /* whichever button this was, we've used it ... don't invoke the
322 consumed.insert (id);
324 return false; /* don't get called again */
328 FaderPort::start_press_timeout (Button& button, ButtonID id)
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());
336 FaderPort::button_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
338 ButtonID id (ButtonID (tb->controller_number));
339 Button& button (get_button (id));
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));
344 buttons_down.insert (id);
346 buttons_down.erase (id);
347 button.timeout_connection.disconnect ();
350 ButtonState bs (ButtonState (0));
366 fader_is_touched = tb->value;
367 if (_current_route) {
368 boost::shared_ptr<AutomationControl> gain = _current_route->gain_control ();
370 framepos_t now = session->engine().sample_time();
372 gain->start_touch (now);
374 gain->stop_touch (true, now);
381 start_press_timeout (button, id);
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));
391 if (button.uses_flash()) {
392 button.set_led_state (_output_port, (int)tb->value);
395 set<ButtonID>::iterator c = consumed.find (id);
397 if (c == consumed.end()) {
398 button.invoke (button_state, tb->value ? true : false);
400 DEBUG_TRACE (DEBUG::FaderPort, "button was consumed, ignored\n");
406 FaderPort::encoder_handler (MIDI::Parser &, MIDI::pitchbend_t pb)
414 //knob debouncing and hysteresis. The presonus encoder often sends bursts of events, or goes the wrong direction
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
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
426 if (delta != last_good_encoder_delta) { //otherwise ensure we keep going the same way
427 delta = last_good_encoder_delta;
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;
434 last_encoder_time = now;
435 last_good_encoder_delta = delta;
438 if (_current_route) {
440 ButtonState trim_modifier;
441 ButtonState width_modifier;
443 if (Profile->get_mixbus()) {
444 trim_modifier = ShiftDown;
445 width_modifier = ButtonState (0);
447 trim_modifier = UserDown;
448 width_modifier = ShiftDown;
451 if ((button_state & trim_modifier) == trim_modifier ) { // mod+encoder = input trim
452 boost::shared_ptr<AutomationControl> trim = _current_route->trim()->gain_control ();
454 float val = trim->get_user(); //for gain elements, the "user" value is in dB
458 } else if (width_modifier && ((button_state & width_modifier) == width_modifier)) {
459 ardour_pan_width (delta);
461 } else { // pan/balance
462 if (!Profile->get_mixbus()) {
463 ardour_pan_azimuth (delta);
470 /* if the user button was pressed, mark it as consumed so that its
471 * release action has no effect.
474 if (!Profile->get_mixbus() && (button_state & UserDown)) {
475 consumed.insert (User);
480 FaderPort::fader_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
482 bool was_fader = false;
484 if (tb->controller_number == 0x0) {
485 fader_msb = tb->value;
487 } else if (tb->controller_number == 0x20) {
488 fader_lsb = tb->value;
493 if (_current_route) {
494 boost::shared_ptr<AutomationControl> gain = _current_route->gain_control ();
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);
505 FaderPort::sysex_handler (MIDI::Parser &p, MIDI::byte *buf, size_t sz)
507 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("sysex message received, size = %1\n", sz));
513 if (buf[2] != 0x7f ||
526 _device_active = true;
528 DEBUG_TRACE (DEBUG::FaderPort, "FaderPort identified via MIDI Device Inquiry response\n");
530 /* put it into native mode */
532 MIDI::byte native[3];
537 _output_port->write (native, 3, 0);
541 /* catch up on state */
543 map_transport_state ();
544 map_recenable_state ();
548 FaderPort::set_active (bool yn)
550 DEBUG_TRACE (DEBUG::FaderPort, string_compose("Faderport::set_active init with yn: '%1'\n", yn));
552 if (yn == active()) {
558 /* start event loop */
562 connect_session_signals ();
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());
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());
579 ControlProtocol::set_active (yn);
581 DEBUG_TRACE (DEBUG::FaderPort, string_compose("Faderport::set_active done with yn: '%1'\n", yn));
587 FaderPort::periodic ()
589 if (!_current_route) {
593 ARDOUR::AutoState gain_state = _current_route->gain_control()->automation_state();
595 if (gain_state == ARDOUR::Touch || gain_state == ARDOUR::Play) {
603 FaderPort::stop_blinking (ButtonID id)
605 blinkers.remove (id);
606 get_button (id).set_led_state (_output_port, false);
610 FaderPort::start_blinking (ButtonID id)
612 blinkers.push_back (id);
613 get_button (id).set_led_state (_output_port, true);
619 blink_state = !blink_state;
621 for (Blinkers::iterator b = blinkers.begin(); b != blinkers.end(); b++) {
622 get_button(*b).set_led_state (_output_port, blink_state);
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 ();
641 route_connections.drop_connections ();
646 FaderPort::map_recenable_state ()
648 switch (session->record_status()) {
649 case Session::Disabled:
650 stop_blinking (RecEnable);
652 case Session::Enabled:
653 start_blinking (RecEnable);
655 case Session::Recording:
656 stop_blinking (RecEnable);
662 FaderPort::map_transport_state ()
664 get_button (Loop).set_led_state (_output_port, session->get_play_loop());
666 float ts = session->transport_speed();
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);
674 start_blinking (Play);
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);
683 FaderPort::parameter_changed (string what)
685 if (what == "punch-in" || what == "punch-out") {
686 bool in = session->config.get_punch_in ();
687 bool out = session->config.get_punch_out ();
689 get_button (Punch).set_led_state (_output_port, true);
690 blinkers.remove (Punch);
691 } else if (in || out) {
692 start_blinking (Punch);
694 stop_blinking (Punch);
700 FaderPort::connect_session_signals()
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);
709 FaderPort::midi_input_handler (Glib::IOCondition ioc, boost::shared_ptr<ARDOUR::AsyncMIDIPort> port)
711 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("something happend on %1\n", boost::shared_ptr<MIDI::Port>(port)->name()));
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();
730 FaderPort::get_state ()
732 XMLNode& node (ControlProtocol::get_state());
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);
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);
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.
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());
760 FaderPort::set_state (const XMLNode& node, int version)
763 XMLNodeConstIterator niter;
764 XMLNode const* child;
766 if (ControlProtocol::set_state (node, version)) {
770 if ((child = node.child (X_("Input"))) != 0) {
771 XMLNode* portnode = child->child (Port::state_node_name.c_str());
773 boost::shared_ptr<ARDOUR::Port>(_input_port)->set_state (*portnode, version);
777 if ((child = node.child (X_("Output"))) != 0) {
778 XMLNode* portnode = child->child (Port::state_node_name.c_str());
780 boost::shared_ptr<ARDOUR::Port>(_output_port)->set_state (*portnode, version);
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"));
790 int xid = atoi (prop->value());
791 ButtonMap::iterator b = buttons.find (ButtonID (xid));
792 if (b == buttons.end()) {
795 b->second.set_state (**n);
803 FaderPort::connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool yn)
805 DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler start\n");
806 if (!_input_port || !_output_port) {
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());
813 if (ni == name1 || ni == name2) {
815 connection_state |= InputConnected;
817 connection_state &= ~InputConnected;
819 } else if (no == name1 || no == name2) {
821 connection_state |= OutputConnected;
823 connection_state &= ~OutputConnected;
826 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("Connections between %1 and %2 changed, but I ignored it\n", name1, name2));
831 if ((connection_state & (InputConnected|OutputConnected)) == (InputConnected|OutputConnected)) {
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.
839 DEBUG_TRACE (DEBUG::FaderPort, "device now connected for both input and output\n");
843 DEBUG_TRACE (DEBUG::FaderPort, "Device disconnected (input or output or both) or not yet fully connected\n");
844 _device_active = false;
847 ConnectionChange (); /* emit signal for our GUI */
849 DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler end\n");
851 return true; /* connection status changed */
855 FaderPort::connected ()
857 DEBUG_TRACE (DEBUG::FaderPort, "sending device inquiry message...\n");
859 start_midi_handling ();
861 /* send device inquiry */
872 _output_port->write (buf, 6, 0);
876 FaderPort::Button::invoke (FaderPort::ButtonState bs, bool press)
878 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("invoke button %1 for %2 state %3%4%5\n", id, (press ? "press":"release"), hex, bs, dec));
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));
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));
894 switch (x->second.type) {
896 if (!x->second.action_name.empty()) {
897 fp.access_action (x->second.action_name);
900 case InternalFunction:
901 if (x->second.function) {
902 x->second.function ();
908 FaderPort::Button::set_action (string const& name, bool when_pressed, FaderPort::ButtonState bs)
912 todo.type = NamedAction;
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;
924 on_release.erase (bs);
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;
934 FaderPort::Button::get_action (bool press, FaderPort::ButtonState bs)
939 if ((x = on_press.find (bs)) == on_press.end()) {
942 if (x->second.type != NamedAction) {
945 return x->second.action_name;
947 if ((x = on_release.find (bs)) == on_release.end()) {
950 if (x->second.type != NamedAction) {
953 return x->second.action_name;
958 FaderPort::Button::set_action (boost::function<void()> f, bool when_pressed, FaderPort::ButtonState bs)
961 todo.type = InternalFunction;
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));
968 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 (%2) @ %5 to some functor on release + %3\n", id, name, bs, this));
970 on_release[bs] = todo;
975 FaderPort::Button::set_led_state (boost::shared_ptr<MIDI::Port> port, bool onoff)
978 /* fader button ID - no LED */
985 buf[2] = onoff ? 1 : 0;
986 port->write (buf, 3, 0);
990 FaderPort::Button::set_state (XMLNode const& node)
992 const XMLProperty* prop = node.property ("id");
997 int xid = atoi (prop->value());
1002 typedef pair<string,FaderPort::ButtonState> state_pair_t;
1003 vector<state_pair_t> state_pairs;
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));
1009 for (vector<state_pair_t>::const_iterator sp = state_pairs.begin(); sp != state_pairs.end(); ++sp) {
1012 propname = sp->first + X_("-press");
1013 if ((prop = node.property (propname)) != 0) {
1014 set_action (prop->value(), true, sp->second);
1017 propname = sp->first + X_("-release");
1018 if ((prop = node.property (propname)) != 0) {
1019 set_action (prop->value(), false, sp->second);
1027 FaderPort::Button::get_state () const
1029 XMLNode* node = new XMLNode (X_("Button"));
1031 snprintf (buf, sizeof (buf), "%d", id);
1033 node->add_property (X_("id"), buf);
1035 ToDoMap::const_iterator x;
1037 null.type = NamedAction;
1039 typedef pair<string,FaderPort::ButtonState> state_pair_t;
1040 vector<state_pair_t> state_pairs;
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));
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);
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);
1064 FaderPort::gui_track_selection_changed (RouteNotificationListPtr routes)
1066 boost::shared_ptr<Route> r;
1068 if (!routes->empty()) {
1069 r = routes->front().lock();
1072 set_current_route (r);
1076 FaderPort::drop_current_route ()
1078 if (_current_route) {
1079 if (_current_route == session->monitor_out()) {
1080 set_current_route (session->master_out());
1082 set_current_route (boost::shared_ptr<Route>());
1088 FaderPort::set_current_route (boost::shared_ptr<Route> r)
1090 route_connections.drop_connections ();
1094 /* turn this off. It will be turned on back on in use_master() or
1095 use_monitor() as appropriate.
1097 get_button(Output).set_led_state (_output_port, false);
1099 if (_current_route) {
1100 _current_route->DropReferences.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::drop_current_route, this), this);
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);
1106 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_route);
1108 t->RecordEnableChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_recenable, this), this);
1111 boost::shared_ptr<AutomationControl> control = _current_route->gain_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);
1117 boost::shared_ptr<MonitorProcessor> mp = _current_route->monitor_control();
1119 mp->cut_control()->Changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_cut, this), this);
1123 //ToDo: subscribe to the fader automation modes so we can light the LEDs
1129 FaderPort::map_auto ()
1131 /* Under no circumstances send a message to "enable" the LED state of
1132 * the Off button, because this will disable the fader.
1135 boost::shared_ptr<AutomationControl> control = _current_route->gain_control ();
1136 const AutoState as = control->automation_state ();
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);
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);
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);
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);
1165 FaderPort::map_cut ()
1167 boost::shared_ptr<MonitorProcessor> mp = _current_route->monitor_control();
1170 bool yn = mp->cut_all ();
1172 start_blinking (Mute);
1174 stop_blinking (Mute);
1177 stop_blinking (Mute);
1182 FaderPort::map_mute (void*)
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);
1191 stop_blinking (Mute);
1194 stop_blinking (Mute);
1199 FaderPort::map_solo (bool, void*, bool)
1201 if (_current_route) {
1202 get_button (Solo).set_led_state (_output_port, _current_route->soloed() || _current_route->listening_via_monitor());
1204 get_button (Solo).set_led_state (_output_port, false);
1209 FaderPort::map_listen (void*, bool)
1211 if (_current_route) {
1212 get_button (Solo).set_led_state (_output_port, _current_route->listening_via_monitor());
1214 get_button (Solo).set_led_state (_output_port, false);
1219 FaderPort::map_recenable ()
1221 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_route);
1223 get_button (Rec).set_led_state (_output_port, t->record_enabled());
1225 get_button (Rec).set_led_state (_output_port, false);
1230 FaderPort::map_gain ()
1232 if (fader_is_touched) {
1233 /* Do not send fader moves while the user is touching the fader */
1237 if (!_current_route) {
1241 boost::shared_ptr<AutomationControl> control = _current_route->gain_control ();
1247 val = control->internal_to_interface (control->get_value ());
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).
1254 * But ... position must be sent in the range 0..1023.
1259 int ival = (int) lrintf (val * 1023.0);
1261 /* MIDI normalization requires that we send two separate messages here,
1262 * not one single 6 byte one.
1271 _output_port->write (buf, 3, 0);
1274 buf[2] = ival & 0x7f;
1276 _output_port->write (buf, 3, 0);
1280 FaderPort::map_route_state ()
1282 if (!_current_route) {
1283 stop_blinking (Mute);
1284 stop_blinking (Solo);
1285 get_button (Rec).set_led_state (_output_port, false);
1287 /* arguments to these map_*() methods are all ignored */
1288 map_solo (false, 0, false);
1293 if (_current_route == session->monitor_out()) {
1301 list<boost::shared_ptr<ARDOUR::Bundle> >
1302 FaderPort::bundles ()
1304 list<boost::shared_ptr<ARDOUR::Bundle> > b;
1306 if (_input_bundle) {
1307 b.push_back (_input_bundle);
1308 b.push_back (_output_bundle);
1314 boost::shared_ptr<Port>
1315 FaderPort::output_port()
1317 return _output_port;
1320 boost::shared_ptr<Port>
1321 FaderPort::input_port()
1327 FaderPort::set_action (ButtonID id, std::string const& action_name, bool on_press, ButtonState bs)
1329 get_button(id).set_action (action_name, on_press, bs);
1333 FaderPort::get_action (ButtonID id, bool press, ButtonState bs)
1335 return get_button(id).get_action (press, bs);