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, _("PreSonus FaderPort"))
69 , AbstractUI<FaderPortRequest> (name())
71 , connection_state (ConnectionState (0))
72 , _device_active (false)
75 , fader_is_touched (false)
76 , button_state (ButtonState (0))
78 , rec_enable_state (false)
80 last_encoder_time = 0;
82 boost::shared_ptr<ARDOUR::Port> inp;
83 boost::shared_ptr<ARDOUR::Port> outp;
85 inp = AudioEngine::instance()->register_input_port (DataType::MIDI, "Faderport Recv", true);
86 outp = AudioEngine::instance()->register_output_port (DataType::MIDI, "Faderport Send", true);
88 _input_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(inp);
89 _output_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(outp);
91 if (_input_port == 0 || _output_port == 0) {
92 throw failed_constructor();
95 _input_bundle.reset (new ARDOUR::Bundle (_("Faderport Support (Receive)"), true));
96 _output_bundle.reset (new ARDOUR::Bundle (_("Faderport Support (Send) "), false));
98 _input_bundle->add_channel (
100 ARDOUR::DataType::MIDI,
101 session->engine().make_port_name_non_relative (inp->name())
104 _output_bundle->add_channel (
106 ARDOUR::DataType::MIDI,
107 session->engine().make_port_name_non_relative (outp->name())
111 TrackSelectionChanged.connect (selection_connection, MISSING_INVALIDATOR, boost::bind (&FaderPort::gui_track_selection_changed, this, _1), this);
113 /* Catch port connections and disconnections */
114 ARDOUR::AudioEngine::instance()->PortConnectedOrDisconnected.connect (port_connection, MISSING_INVALIDATOR, boost::bind (&FaderPort::connection_handler, this, _1, _2, _3, _4, _5), this);
116 buttons.insert (std::make_pair (Mute, Button (*this, _("Mute"), Mute, 21)));
117 buttons.insert (std::make_pair (Solo, Button (*this, _("Solo"), Solo, 22)));
118 buttons.insert (std::make_pair (Rec, Button (*this, _("Rec"), Rec, 23)));
119 buttons.insert (std::make_pair (Left, Button (*this, _("Left"), Left, 20)));
120 buttons.insert (std::make_pair (Bank, Button (*this, _("Bank"), Bank, 19)));
121 buttons.insert (std::make_pair (Right, Button (*this, _("Right"), Right, 18)));
122 buttons.insert (std::make_pair (Output, Button (*this, _("Output"), Output, 17)));
123 buttons.insert (std::make_pair (FP_Read, Button (*this, _("Read"), FP_Read, 13)));
124 buttons.insert (std::make_pair (FP_Write, Button (*this, _("Write"), FP_Write, 14)));
125 buttons.insert (std::make_pair (FP_Touch, Button (*this, _("Touch"), FP_Touch, 15)));
126 buttons.insert (std::make_pair (FP_Off, Button (*this, _("Off"), FP_Off, 16)));
127 buttons.insert (std::make_pair (Mix, Button (*this, _("Mix"), Mix, 12)));
128 buttons.insert (std::make_pair (Proj, Button (*this, _("Proj"), Proj, 11)));
129 buttons.insert (std::make_pair (Trns, Button (*this, _("Trns"), Trns, 10)));
130 buttons.insert (std::make_pair (Undo, Button (*this, _("Undo"), Undo, 9)));
131 buttons.insert (std::make_pair (Shift, Button (*this, _("Shift"), Shift, 5)));
132 buttons.insert (std::make_pair (Punch, Button (*this, _("Punch"), Punch, 6)));
133 buttons.insert (std::make_pair (User, Button (*this, _("User"), User, 7)));
134 buttons.insert (std::make_pair (Loop, Button (*this, _("Loop"), Loop, 8)));
135 buttons.insert (std::make_pair (Rewind, Button (*this, _("Rewind"), Rewind, 4)));
136 buttons.insert (std::make_pair (Ffwd, Button (*this, _("Ffwd"), Ffwd, 3)));
137 buttons.insert (std::make_pair (Stop, Button (*this, _("Stop"), Stop, 2)));
138 buttons.insert (std::make_pair (Play, Button (*this, _("Play"), Play, 1)));
139 buttons.insert (std::make_pair (RecEnable, Button (*this, _("RecEnable"), RecEnable, 0)));
140 buttons.insert (std::make_pair (Footswitch, Button (*this, _("Footswitch"), Footswitch, -1)));
141 buttons.insert (std::make_pair (FaderTouch, Button (*this, _("Fader (touch)"), FaderTouch, -1)));
143 get_button (Shift).set_flash (true);
144 get_button (Mix).set_flash (true);
145 get_button (Proj).set_flash (true);
146 get_button (Trns).set_flash (true);
147 get_button (User).set_flash (true);
149 get_button (Left).set_action ( boost::bind (&FaderPort::left, this), true);
150 get_button (Right).set_action ( boost::bind (&FaderPort::right, this), true);
152 get_button (Undo).set_action (boost::bind (&FaderPort::undo, this), true);
153 get_button (Undo).set_action (boost::bind (&FaderPort::redo, this), true, ShiftDown);
154 get_button (Undo).set_flash (true);
156 get_button (FP_Read).set_action (boost::bind (&FaderPort::read, this), true);
157 get_button (FP_Read).set_action (boost::bind (&FaderPort::off, this), false, LongPress);
158 get_button (FP_Write).set_action (boost::bind (&FaderPort::write, this), true);
159 get_button (FP_Write).set_action (boost::bind (&FaderPort::off, this), false, LongPress);
160 get_button (FP_Touch).set_action (boost::bind (&FaderPort::touch, this), true);
161 get_button (FP_Touch).set_action (boost::bind (&FaderPort::off, this), false, LongPress);
162 get_button (FP_Off).set_action (boost::bind (&FaderPort::off, this), true);
164 get_button (Play).set_action (boost::bind (&BasicUI::transport_play, this, true), true);
165 get_button (RecEnable).set_action (boost::bind (&BasicUI::rec_enable_toggle, this), true);
166 /* Stop is a modifier, so we have to use its own button state to get
167 the default action (since StopDown will be set when looking for the
170 get_button (Stop).set_action (boost::bind (&BasicUI::transport_stop, this), true, StopDown);
171 get_button (Ffwd).set_action (boost::bind (&BasicUI::ffwd, this), true);
173 /* See comments about Stop above .. */
174 get_button (Rewind).set_action (boost::bind (&BasicUI::rewind, this), true, RewindDown);
175 get_button (Rewind).set_action (boost::bind (&BasicUI::goto_zero, this), true, ButtonState (RewindDown|StopDown));
176 get_button (Rewind).set_action (boost::bind (&BasicUI::goto_start, this), true, ButtonState (RewindDown|ShiftDown));
178 get_button (Ffwd).set_action (boost::bind (&BasicUI::ffwd, this), true);
179 get_button (Ffwd).set_action (boost::bind (&BasicUI::goto_end, this), true, ShiftDown);
181 get_button (Punch).set_action (boost::bind (&FaderPort::punch, this), true);
183 get_button (Loop).set_action (boost::bind (&BasicUI::loop_toggle, this), true);
184 get_button (Loop).set_action (boost::bind (&BasicUI::add_marker, this, string()), true, ShiftDown);
186 get_button (Punch).set_action (boost::bind (&BasicUI::prev_marker, this), true, ShiftDown);
187 get_button (User).set_action (boost::bind (&BasicUI::next_marker, this), true, ButtonState(ShiftDown|UserDown));
189 get_button (Mute).set_action (boost::bind (&FaderPort::mute, this), true);
190 get_button (Solo).set_action (boost::bind (&FaderPort::solo, this), true);
191 get_button (Rec).set_action (boost::bind (&FaderPort::rec_enable, this), true);
193 get_button (Output).set_action (boost::bind (&FaderPort::use_master, this), true);
194 get_button (Output).set_action (boost::bind (&FaderPort::use_monitor, this), true, ShiftDown);
197 FaderPort::~FaderPort ()
202 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("unregistering input port %1\n", boost::shared_ptr<ARDOUR::Port>(_input_port)->name()));
203 AudioEngine::instance()->unregister_port (_input_port);
204 _input_port.reset ();
208 _output_port->drain (10000, 250000); /* check every 10 msecs, wait up to 1/4 second for the port to drain */
209 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("unregistering output port %1\n", boost::shared_ptr<ARDOUR::Port>(_output_port)->name()));
210 AudioEngine::instance()->unregister_port (_output_port);
211 _output_port.reset ();
216 /* stop event loop */
217 DEBUG_TRACE (DEBUG::FaderPort, "BaseUI::quit ()\n");
222 FaderPort::request_factory (uint32_t num_requests)
224 /* AbstractUI<T>::request_buffer_factory() is a template method only
225 instantiated in this source module. To provide something visible for
226 use in the interface/descriptor, we have this static method that is
229 return request_buffer_factory (num_requests);
233 FaderPort::start_midi_handling ()
235 /* handle device inquiry response */
236 _input_port->parser()->sysex.connect_same_thread (midi_connections, boost::bind (&FaderPort::sysex_handler, this, _1, _2, _3));
238 _input_port->parser()->poly_pressure.connect_same_thread (midi_connections, boost::bind (&FaderPort::button_handler, this, _1, _2));
240 _input_port->parser()->pitchbend.connect_same_thread (midi_connections, boost::bind (&FaderPort::encoder_handler, this, _1, _2));
242 _input_port->parser()->controller.connect_same_thread (midi_connections, boost::bind (&FaderPort::fader_handler, this, _1, _2));
244 /* This connection means that whenever data is ready from the input
245 * port, the relevant thread will invoke our ::midi_input_handler()
246 * method, which will read the data, and invoke the parser.
249 _input_port->xthread().set_receive_handler (sigc::bind (sigc::mem_fun (this, &FaderPort::midi_input_handler), _input_port));
250 _input_port->xthread().attach (main_loop()->get_context());
254 FaderPort::stop_midi_handling ()
256 midi_connections.drop_connections ();
258 /* Note: the input handler is still active at this point, but we're no
259 * longer connected to any of the parser signals
264 FaderPort::do_request (FaderPortRequest* req)
266 if (req->type == CallSlot) {
268 call_slot (MISSING_INVALIDATOR, req->the_slot);
270 } else if (req->type == Quit) {
285 FaderPort::thread_init ()
287 struct sched_param rtparam;
289 pthread_set_name (event_loop_name().c_str());
291 PBD::notify_event_loops_about_thread_creation (pthread_self(), event_loop_name(), 2048);
292 ARDOUR::SessionEvent::create_per_thread_pool (event_loop_name(), 128);
294 memset (&rtparam, 0, sizeof (rtparam));
295 rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
297 if (pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam) != 0) {
298 // do we care? not particularly.
303 FaderPort::all_lights_out ()
305 for (ButtonMap::iterator b = buttons.begin(); b != buttons.end(); ++b) {
306 b->second.set_led_state (_output_port, false);
311 FaderPort::get_button (ButtonID id) const
313 ButtonMap::const_iterator b = buttons.find (id);
314 assert (b != buttons.end());
315 return const_cast<Button&>(b->second);
319 FaderPort::button_long_press_timeout (ButtonID id)
321 if (buttons_down.find (id) != buttons_down.end()) {
322 get_button (id).invoke (ButtonState (LongPress|button_state), false);
324 /* release happened and somehow we were not cancelled */
327 /* whichever button this was, we've used it ... don't invoke the
330 consumed.insert (id);
332 return false; /* don't get called again */
336 FaderPort::start_press_timeout (Button& button, ButtonID id)
338 Glib::RefPtr<Glib::TimeoutSource> timeout = Glib::TimeoutSource::create (500); // milliseconds
339 button.timeout_connection = timeout->connect (sigc::bind (sigc::mem_fun (*this, &FaderPort::button_long_press_timeout), id));
340 timeout->attach (main_loop()->get_context());
344 FaderPort::button_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
346 ButtonID id (ButtonID (tb->controller_number));
347 Button& button (get_button (id));
349 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("button event for ID %1 press ? %2\n", (int) tb->controller_number, (tb->value ? "yes" : "no")));
352 buttons_down.insert (id);
354 buttons_down.erase (id);
355 button.timeout_connection.disconnect ();
358 ButtonState bs (ButtonState (0));
374 fader_is_touched = tb->value;
375 if (_current_route) {
376 boost::shared_ptr<AutomationControl> gain = _current_route->gain_control ();
378 framepos_t now = session->engine().sample_time();
380 gain->start_touch (now);
382 gain->stop_touch (true, now);
389 start_press_timeout (button, id);
395 button_state = (tb->value ? ButtonState (button_state|bs) : ButtonState (button_state&~bs));
396 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("reset button state to %1 using %2\n", button_state, (int) bs));
399 if (button.uses_flash()) {
400 button.set_led_state (_output_port, (int)tb->value);
403 set<ButtonID>::iterator c = consumed.find (id);
405 if (c == consumed.end()) {
406 button.invoke (button_state, tb->value ? true : false);
408 DEBUG_TRACE (DEBUG::FaderPort, "button was consumed, ignored\n");
414 FaderPort::encoder_handler (MIDI::Parser &, MIDI::pitchbend_t pb)
422 //knob debouncing and hysteresis. The presonus encoder often sends bursts of events, or goes the wrong direction
424 last_last_encoder_delta = last_encoder_delta;
425 last_encoder_delta = delta;
426 microseconds_t now = get_microseconds ();
427 if ((now - last_encoder_time) < 10*1000) { //require at least 10ms interval between changes, because the device sometimes sends multiple deltas
430 if ((now - last_encoder_time) < 100*1000) { //avoid directional changes while "spinning", 100ms window
431 if ( (delta == last_encoder_delta) && (delta == last_last_encoder_delta) ) {
432 last_good_encoder_delta = delta; //3 in a row, grudgingly accept this as the new direction
434 if (delta != last_good_encoder_delta) { //otherwise ensure we keep going the same way
435 delta = last_good_encoder_delta;
437 } else { //we aren't yet in a spin window, just assume this move is really what we want
438 //NOTE: if you are worried about where these get initialized, here it is.
439 last_last_encoder_delta = delta;
440 last_encoder_delta = delta;
442 last_encoder_time = now;
443 last_good_encoder_delta = delta;
446 if (_current_route) {
448 ButtonState trim_modifier;
449 ButtonState width_modifier;
451 if (Profile->get_mixbus()) {
452 trim_modifier = ShiftDown;
453 width_modifier = ButtonState (0);
455 trim_modifier = UserDown;
456 width_modifier = ShiftDown;
459 if ((button_state & trim_modifier) == trim_modifier ) { // mod+encoder = input trim
460 boost::shared_ptr<AutomationControl> trim = _current_route->trim()->gain_control ();
462 float val = trim->get_user(); //for gain elements, the "user" value is in dB
466 } else if (width_modifier && ((button_state & width_modifier) == width_modifier)) {
467 ardour_pan_width (delta);
469 } else { // pan/balance
470 if (!Profile->get_mixbus()) {
471 ardour_pan_azimuth (delta);
478 /* if the user button was pressed, mark it as consumed so that its
479 * release action has no effect.
482 if (!Profile->get_mixbus() && (button_state & UserDown)) {
483 consumed.insert (User);
488 FaderPort::fader_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
490 bool was_fader = false;
492 if (tb->controller_number == 0x0) {
493 fader_msb = tb->value;
495 } else if (tb->controller_number == 0x20) {
496 fader_lsb = tb->value;
501 if (_current_route) {
502 boost::shared_ptr<AutomationControl> gain = _current_route->gain_control ();
504 int ival = (fader_msb << 7) | fader_lsb;
505 float val = gain->interface_to_internal (ival/16384.0);
506 /* even though the faderport only controls a
507 single route at a time, allow the fader to
508 modify the group, if appropriate.
510 _current_route->gain_control()->set_value (val, Controllable::UseGroup);
517 FaderPort::sysex_handler (MIDI::Parser &p, MIDI::byte *buf, size_t sz)
519 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("sysex message received, size = %1\n", sz));
525 if (buf[2] != 0x7f ||
538 _device_active = true;
540 DEBUG_TRACE (DEBUG::FaderPort, "FaderPort identified via MIDI Device Inquiry response\n");
542 /* put it into native mode */
544 MIDI::byte native[3];
549 _output_port->write (native, 3, 0);
553 /* catch up on state */
555 /* make sure that rec_enable_state is consistent with current device state */
556 get_button (RecEnable).set_led_state (_output_port, rec_enable_state);
558 map_transport_state ();
559 map_recenable_state ();
563 FaderPort::set_active (bool yn)
565 DEBUG_TRACE (DEBUG::FaderPort, string_compose("Faderport::set_active init with yn: '%1'\n", yn));
567 if (yn == active()) {
573 /* start event loop */
577 connect_session_signals ();
579 Glib::RefPtr<Glib::TimeoutSource> blink_timeout = Glib::TimeoutSource::create (200); // milliseconds
580 blink_connection = blink_timeout->connect (sigc::mem_fun (*this, &FaderPort::blink));
581 blink_timeout->attach (main_loop()->get_context());
583 Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
584 periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &FaderPort::periodic));
585 periodic_timeout->attach (main_loop()->get_context());
594 ControlProtocol::set_active (yn);
596 DEBUG_TRACE (DEBUG::FaderPort, string_compose("Faderport::set_active done with yn: '%1'\n", yn));
602 FaderPort::periodic ()
604 if (!_current_route) {
608 ARDOUR::AutoState gain_state = _current_route->gain_control()->automation_state();
610 if (gain_state == ARDOUR::Touch || gain_state == ARDOUR::Play) {
618 FaderPort::stop_blinking (ButtonID id)
620 blinkers.remove (id);
621 get_button (id).set_led_state (_output_port, false);
625 FaderPort::start_blinking (ButtonID id)
627 blinkers.push_back (id);
628 get_button (id).set_led_state (_output_port, true);
634 blink_state = !blink_state;
636 for (Blinkers::iterator b = blinkers.begin(); b != blinkers.end(); b++) {
637 get_button(*b).set_led_state (_output_port, blink_state);
640 map_recenable_state ();
650 stop_midi_handling ();
651 session_connections.drop_connections ();
652 port_connection.disconnect ();
653 blink_connection.disconnect ();
654 selection_connection.disconnect ();
655 route_connections.drop_connections ();
658 route_connections.drop_connections ();
663 FaderPort::map_recenable_state ()
665 /* special case for RecEnable because its status can change as a
666 * confluence of unrelated parameters: (a) session rec-enable state (b)
667 * rec-enabled tracks. So we don't add the button to the blinkers list,
670 * * from the blink callback
671 * * when the session tells us about a status change
673 * We do the last one so that the button changes state promptly rather
674 * than waiting for the next blink callback. The change in "blinking"
675 * based on having record-enabled tracks isn't urgent, and that happens
676 * during the blink callback.
681 switch (session->record_status()) {
682 case Session::Disabled:
685 case Session::Enabled:
688 case Session::Recording:
689 if (session->have_rec_enabled_track ()) {
697 if (onoff != rec_enable_state) {
698 get_button(RecEnable).set_led_state (_output_port, onoff);
699 rec_enable_state = onoff;
704 FaderPort::map_transport_state ()
706 get_button (Loop).set_led_state (_output_port, session->get_play_loop());
708 float ts = session->transport_speed();
711 stop_blinking (Play);
712 } else if (fabs (ts) == 1.0) {
713 stop_blinking (Play);
714 get_button (Play).set_led_state (_output_port, true);
716 start_blinking (Play);
719 get_button (Stop).set_led_state (_output_port, session->transport_stopped ());
720 get_button (Rewind).set_led_state (_output_port, session->transport_speed() < 0.0);
721 get_button (Ffwd).set_led_state (_output_port, session->transport_speed() > 1.0);
725 FaderPort::parameter_changed (string what)
727 if (what == "punch-in" || what == "punch-out") {
728 bool in = session->config.get_punch_in ();
729 bool out = session->config.get_punch_out ();
731 get_button (Punch).set_led_state (_output_port, true);
732 blinkers.remove (Punch);
733 } else if (in || out) {
734 start_blinking (Punch);
736 stop_blinking (Punch);
742 FaderPort::connect_session_signals()
744 session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_recenable_state, this), this);
745 session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_transport_state, this), this);
746 /* not session, but treat it similarly */
747 session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::parameter_changed, this, _1), this);
751 FaderPort::midi_input_handler (Glib::IOCondition ioc, boost::shared_ptr<ARDOUR::AsyncMIDIPort> port)
753 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("something happend on %1\n", boost::shared_ptr<MIDI::Port>(port)->name()));
762 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("data available on %1\n", boost::shared_ptr<MIDI::Port>(port)->name()));
763 framepos_t now = session->engine().sample_time();
772 FaderPort::get_state ()
774 XMLNode& node (ControlProtocol::get_state());
778 child = new XMLNode (X_("Input"));
779 child->add_child_nocopy (boost::shared_ptr<ARDOUR::Port>(_input_port)->get_state());
780 node.add_child_nocopy (*child);
783 child = new XMLNode (X_("Output"));
784 child->add_child_nocopy (boost::shared_ptr<ARDOUR::Port>(_output_port)->get_state());
785 node.add_child_nocopy (*child);
787 /* Save action state for Mix, Proj, Trns and User buttons, since these
788 * are user controlled. We can only save named-action operations, since
789 * internal functions are just pointers to functions and hard to
790 * serialize without enumerating them all somewhere.
793 node.add_child_nocopy (get_button (Mix).get_state());
794 node.add_child_nocopy (get_button (Proj).get_state());
795 node.add_child_nocopy (get_button (Trns).get_state());
796 node.add_child_nocopy (get_button (User).get_state());
797 node.add_child_nocopy (get_button (Footswitch).get_state());
803 FaderPort::set_state (const XMLNode& node, int version)
806 XMLNodeConstIterator niter;
807 XMLNode const* child;
809 if (ControlProtocol::set_state (node, version)) {
813 if ((child = node.child (X_("Input"))) != 0) {
814 XMLNode* portnode = child->child (Port::state_node_name.c_str());
816 boost::shared_ptr<ARDOUR::Port>(_input_port)->set_state (*portnode, version);
820 if ((child = node.child (X_("Output"))) != 0) {
821 XMLNode* portnode = child->child (Port::state_node_name.c_str());
823 boost::shared_ptr<ARDOUR::Port>(_output_port)->set_state (*portnode, version);
827 for (XMLNodeList::const_iterator n = node.children().begin(); n != node.children().end(); ++n) {
828 if ((*n)->name() == X_("Button")) {
829 XMLProperty const * prop = (*n)->property (X_("id"));
833 int xid = atoi (prop->value());
834 ButtonMap::iterator b = buttons.find (ButtonID (xid));
835 if (b == buttons.end()) {
838 b->second.set_state (**n);
846 FaderPort::connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool yn)
848 DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler start\n");
849 if (!_input_port || !_output_port) {
853 string ni = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_input_port)->name());
854 string no = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_output_port)->name());
856 if (ni == name1 || ni == name2) {
858 connection_state |= InputConnected;
860 connection_state &= ~InputConnected;
862 } else if (no == name1 || no == name2) {
864 connection_state |= OutputConnected;
866 connection_state &= ~OutputConnected;
869 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("Connections between %1 and %2 changed, but I ignored it\n", name1, name2));
874 if ((connection_state & (InputConnected|OutputConnected)) == (InputConnected|OutputConnected)) {
876 /* XXX this is a horrible hack. Without a short sleep here,
877 something prevents the device wakeup messages from being
878 sent and/or the responses from being received.
882 DEBUG_TRACE (DEBUG::FaderPort, "device now connected for both input and output\n");
886 DEBUG_TRACE (DEBUG::FaderPort, "Device disconnected (input or output or both) or not yet fully connected\n");
887 _device_active = false;
890 ConnectionChange (); /* emit signal for our GUI */
892 DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler end\n");
894 return true; /* connection status changed */
898 FaderPort::connected ()
900 DEBUG_TRACE (DEBUG::FaderPort, "sending device inquiry message...\n");
902 start_midi_handling ();
904 /* send device inquiry */
915 _output_port->write (buf, 6, 0);
919 FaderPort::Button::invoke (FaderPort::ButtonState bs, bool press)
921 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("invoke button %1 for %2 state %3%4%5\n", id, (press ? "press":"release"), hex, bs, dec));
926 if ((x = on_press.find (bs)) == on_press.end()) {
927 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("no press action for button %1 state %2 @ %3 in %4\n", id, bs, this, &on_press));
931 if ((x = on_release.find (bs)) == on_release.end()) {
932 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("no release action for button %1 state %2 @%3 in %4\n", id, bs, this, &on_release));
937 switch (x->second.type) {
939 if (!x->second.action_name.empty()) {
940 fp.access_action (x->second.action_name);
943 case InternalFunction:
944 if (x->second.function) {
945 x->second.function ();
951 FaderPort::Button::set_action (string const& name, bool when_pressed, FaderPort::ButtonState bs)
955 todo.type = NamedAction;
961 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 to action %2 on press + %3%4%5\n", id, name, bs));
962 todo.action_name = name;
967 on_release.erase (bs);
969 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 to action %2 on release + %3%4%5\n", id, name, bs));
970 todo.action_name = name;
971 on_release[bs] = todo;
977 FaderPort::Button::get_action (bool press, FaderPort::ButtonState bs)
982 if ((x = on_press.find (bs)) == on_press.end()) {
985 if (x->second.type != NamedAction) {
988 return x->second.action_name;
990 if ((x = on_release.find (bs)) == on_release.end()) {
993 if (x->second.type != NamedAction) {
996 return x->second.action_name;
1001 FaderPort::Button::set_action (boost::function<void()> f, bool when_pressed, FaderPort::ButtonState bs)
1004 todo.type = InternalFunction;
1007 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));
1009 on_press[bs] = todo;
1011 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 (%2) @ %5 to some functor on release + %3\n", id, name, bs, this));
1013 on_release[bs] = todo;
1018 FaderPort::Button::set_led_state (boost::shared_ptr<MIDI::Port> port, bool onoff)
1021 /* fader button ID - no LED */
1028 buf[2] = onoff ? 1 : 0;
1029 port->write (buf, 3, 0);
1033 FaderPort::Button::set_state (XMLNode const& node)
1035 const XMLProperty* prop = node.property ("id");
1040 int xid = atoi (prop->value());
1045 typedef pair<string,FaderPort::ButtonState> state_pair_t;
1046 vector<state_pair_t> state_pairs;
1048 state_pairs.push_back (make_pair (string ("plain"), ButtonState (0)));
1049 state_pairs.push_back (make_pair (string ("shift"), ShiftDown));
1050 state_pairs.push_back (make_pair (string ("long"), LongPress));
1052 for (vector<state_pair_t>::const_iterator sp = state_pairs.begin(); sp != state_pairs.end(); ++sp) {
1055 propname = sp->first + X_("-press");
1056 if ((prop = node.property (propname)) != 0) {
1057 set_action (prop->value(), true, sp->second);
1060 propname = sp->first + X_("-release");
1061 if ((prop = node.property (propname)) != 0) {
1062 set_action (prop->value(), false, sp->second);
1070 FaderPort::Button::get_state () const
1072 XMLNode* node = new XMLNode (X_("Button"));
1074 snprintf (buf, sizeof (buf), "%d", id);
1076 node->add_property (X_("id"), buf);
1078 ToDoMap::const_iterator x;
1080 null.type = NamedAction;
1082 typedef pair<string,FaderPort::ButtonState> state_pair_t;
1083 vector<state_pair_t> state_pairs;
1085 state_pairs.push_back (make_pair (string ("plain"), ButtonState (0)));
1086 state_pairs.push_back (make_pair (string ("shift"), ShiftDown));
1087 state_pairs.push_back (make_pair (string ("long"), LongPress));
1089 for (vector<state_pair_t>::const_iterator sp = state_pairs.begin(); sp != state_pairs.end(); ++sp) {
1090 if ((x = on_press.find (sp->second)) != on_press.end()) {
1091 if (x->second.type == NamedAction) {
1092 node->add_property (string (sp->first + X_("-press")).c_str(), x->second.action_name);
1096 if ((x = on_release.find (sp->second)) != on_release.end()) {
1097 if (x->second.type == NamedAction) {
1098 node->add_property (string (sp->first + X_("-release")).c_str(), x->second.action_name);
1107 FaderPort::gui_track_selection_changed (RouteNotificationListPtr routes)
1109 boost::shared_ptr<Route> r;
1111 if (!routes->empty()) {
1112 r = routes->front().lock();
1115 set_current_route (r);
1119 FaderPort::drop_current_route ()
1121 if (_current_route) {
1122 if (_current_route == session->monitor_out()) {
1123 set_current_route (session->master_out());
1125 set_current_route (boost::shared_ptr<Route>());
1131 FaderPort::set_current_route (boost::shared_ptr<Route> r)
1133 route_connections.drop_connections ();
1137 /* turn this off. It will be turned on back on in use_master() or
1138 use_monitor() as appropriate.
1140 get_button(Output).set_led_state (_output_port, false);
1142 if (_current_route) {
1143 _current_route->DropReferences.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::drop_current_route, this), this);
1145 _current_route->mute_control()->Changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_mute, this), this);
1146 _current_route->solo_control()->Changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_solo, this), this);
1148 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_route);
1150 t->rec_enable_control()->Changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_recenable, this), this);
1153 boost::shared_ptr<AutomationControl> control = _current_route->gain_control ();
1155 control->Changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_gain, this), this);
1156 control->alist()->automation_state_changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_auto, this), this);
1159 boost::shared_ptr<MonitorProcessor> mp = _current_route->monitor_control();
1161 mp->cut_control()->Changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_cut, this), this);
1165 //ToDo: subscribe to the fader automation modes so we can light the LEDs
1171 FaderPort::map_auto ()
1173 /* Under no circumstances send a message to "enable" the LED state of
1174 * the Off button, because this will disable the fader.
1177 boost::shared_ptr<AutomationControl> control = _current_route->gain_control ();
1178 const AutoState as = control->automation_state ();
1182 get_button (FP_Read).set_led_state (_output_port, true);
1183 get_button (FP_Write).set_led_state (_output_port, false);
1184 get_button (FP_Touch).set_led_state (_output_port, false);
1187 get_button (FP_Read).set_led_state (_output_port, false);
1188 get_button (FP_Write).set_led_state (_output_port, true);
1189 get_button (FP_Touch).set_led_state (_output_port, false);
1192 get_button (FP_Read).set_led_state (_output_port, false);
1193 get_button (FP_Write).set_led_state (_output_port, false);
1194 get_button (FP_Touch).set_led_state (_output_port, true);
1197 get_button (FP_Read).set_led_state (_output_port, false);
1198 get_button (FP_Write).set_led_state (_output_port, false);
1199 get_button (FP_Touch).set_led_state (_output_port, false);
1207 FaderPort::map_cut ()
1209 boost::shared_ptr<MonitorProcessor> mp = _current_route->monitor_control();
1212 bool yn = mp->cut_all ();
1214 start_blinking (Mute);
1216 stop_blinking (Mute);
1219 stop_blinking (Mute);
1224 FaderPort::map_mute ()
1226 if (_current_route) {
1227 if (_current_route->muted()) {
1228 stop_blinking (Mute);
1229 get_button (Mute).set_led_state (_output_port, true);
1230 } else if (_current_route->muted_by_others_soloing () || _current_route->muted_by_masters()) {
1231 start_blinking (Mute);
1233 stop_blinking (Mute);
1236 stop_blinking (Mute);
1241 FaderPort::map_solo ()
1243 if (_current_route) {
1244 get_button (Solo).set_led_state (_output_port, _current_route->soloed());
1246 get_button (Solo).set_led_state (_output_port, false);
1251 FaderPort::map_recenable ()
1253 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_route);
1255 get_button (Rec).set_led_state (_output_port, t->rec_enable_control()->get_value());
1257 get_button (Rec).set_led_state (_output_port, false);
1262 FaderPort::map_gain ()
1264 if (fader_is_touched) {
1265 /* Do not send fader moves while the user is touching the fader */
1269 if (!_current_route) {
1273 boost::shared_ptr<AutomationControl> control = _current_route->gain_control ();
1279 val = control->internal_to_interface (control->get_value ());
1282 /* Faderport sends fader position with range 0..16384 (though some of
1283 * the least-significant bits at the top end are missing - it may only
1284 * get to 1636X or so).
1286 * But ... position must be sent in the range 0..1023.
1291 int ival = (int) lrintf (val * 1023.0);
1293 /* MIDI normalization requires that we send two separate messages here,
1294 * not one single 6 byte one.
1303 _output_port->write (buf, 3, 0);
1306 buf[2] = ival & 0x7f;
1308 _output_port->write (buf, 3, 0);
1312 FaderPort::map_route_state ()
1314 if (!_current_route) {
1315 stop_blinking (Mute);
1316 stop_blinking (Solo);
1317 get_button (Rec).set_led_state (_output_port, false);
1324 if (_current_route == session->monitor_out()) {
1332 list<boost::shared_ptr<ARDOUR::Bundle> >
1333 FaderPort::bundles ()
1335 list<boost::shared_ptr<ARDOUR::Bundle> > b;
1337 if (_input_bundle) {
1338 b.push_back (_input_bundle);
1339 b.push_back (_output_bundle);
1345 boost::shared_ptr<Port>
1346 FaderPort::output_port()
1348 return _output_port;
1351 boost::shared_ptr<Port>
1352 FaderPort::input_port()
1358 FaderPort::set_action (ButtonID id, std::string const& action_name, bool on_press, ButtonState bs)
1360 get_button(id).set_action (action_name, on_press, bs);
1364 FaderPort::get_action (ButtonID id, bool press, ButtonState bs)
1366 return get_button(id).get_action (press, bs);