2 * Copyright (C) 2015-2018 Ben Loftis <ben@harrisonconsoles.com>
3 * Copyright (C) 2015-2018 Paul Davis <paul@linuxaudiosystems.com>
4 * Copyright (C) 2016-2019 Robin Gareus <robin@gareus.org>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 #include <glibmm/fileutils.h>
28 #include <glibmm/miscutils.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/record_enable_control.h"
51 #include "ardour/stripable.h"
52 #include "ardour/session.h"
53 #include "ardour/session_configuration.h"
54 #include "ardour/track.h"
56 #include "faderport.h"
58 using namespace ARDOUR;
59 using namespace ArdourSurface;
66 #include "pbd/abstract_ui.cc" // instantiate template
68 FaderPort::FaderPort (Session& s)
69 : ControlProtocol (s, _("PreSonus FaderPort"))
70 , AbstractUI<FaderPortRequest> (name())
72 , connection_state (ConnectionState (0))
73 , _device_active (false)
76 , fader_is_touched (false)
77 , button_state (ButtonState (0))
79 , rec_enable_state (false)
81 last_encoder_time = 0;
83 boost::shared_ptr<ARDOUR::Port> inp;
84 boost::shared_ptr<ARDOUR::Port> outp;
86 inp = AudioEngine::instance()->register_input_port (DataType::MIDI, "Faderport Recv", true);
87 outp = AudioEngine::instance()->register_output_port (DataType::MIDI, "Faderport Send", true);
89 _input_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(inp);
90 _output_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(outp);
92 if (_input_port == 0 || _output_port == 0) {
93 throw failed_constructor();
96 _input_bundle.reset (new ARDOUR::Bundle (_("Faderport Support (Receive)"), true));
97 _output_bundle.reset (new ARDOUR::Bundle (_("Faderport Support (Send) "), false));
99 _input_bundle->add_channel (
101 ARDOUR::DataType::MIDI,
102 session->engine().make_port_name_non_relative (inp->name())
105 _output_bundle->add_channel (
107 ARDOUR::DataType::MIDI,
108 session->engine().make_port_name_non_relative (outp->name())
111 /* Catch port connections and disconnections */
112 ARDOUR::AudioEngine::instance()->PortConnectedOrDisconnected.connect (port_connection, MISSING_INVALIDATOR, boost::bind (&FaderPort::connection_handler, this, _1, _2, _3, _4, _5), this);
114 buttons.insert (std::make_pair (Mute, Button (*this, _("Mute"), Mute, 21)));
115 buttons.insert (std::make_pair (Solo, Button (*this, _("Solo"), Solo, 22)));
116 buttons.insert (std::make_pair (Rec, Button (*this, _("Rec"), Rec, 23)));
117 buttons.insert (std::make_pair (Left, Button (*this, _("Left"), Left, 20)));
118 buttons.insert (std::make_pair (Bank, Button (*this, _("Bank"), Bank, 19)));
119 buttons.insert (std::make_pair (Right, Button (*this, _("Right"), Right, 18)));
120 buttons.insert (std::make_pair (Output, Button (*this, _("Output"), Output, 17)));
121 buttons.insert (std::make_pair (FP_Read, Button (*this, _("Read"), FP_Read, 13)));
122 buttons.insert (std::make_pair (FP_Write, Button (*this, _("Write"), FP_Write, 14)));
123 buttons.insert (std::make_pair (FP_Touch, Button (*this, _("Touch"), FP_Touch, 15)));
124 buttons.insert (std::make_pair (FP_Off, Button (*this, _("Off"), FP_Off, 16)));
125 buttons.insert (std::make_pair (Mix, Button (*this, _("Mix"), Mix, 12)));
126 buttons.insert (std::make_pair (Proj, Button (*this, _("Proj"), Proj, 11)));
127 buttons.insert (std::make_pair (Trns, Button (*this, _("Trns"), Trns, 10)));
128 buttons.insert (std::make_pair (Undo, Button (*this, _("Undo"), Undo, 9)));
129 buttons.insert (std::make_pair (Shift, Button (*this, _("Shift"), Shift, 5)));
130 buttons.insert (std::make_pair (Punch, Button (*this, _("Punch"), Punch, 6)));
131 buttons.insert (std::make_pair (User, Button (*this, _("User"), User, 7)));
132 buttons.insert (std::make_pair (Loop, Button (*this, _("Loop"), Loop, 8)));
133 buttons.insert (std::make_pair (Rewind, Button (*this, _("Rewind"), Rewind, 4)));
134 buttons.insert (std::make_pair (Ffwd, Button (*this, _("Ffwd"), Ffwd, 3)));
135 buttons.insert (std::make_pair (Stop, Button (*this, _("Stop"), Stop, 2)));
136 buttons.insert (std::make_pair (Play, Button (*this, _("Play"), Play, 1)));
137 buttons.insert (std::make_pair (RecEnable, Button (*this, _("RecEnable"), RecEnable, 0)));
138 buttons.insert (std::make_pair (Footswitch, Button (*this, _("Footswitch"), Footswitch, -1)));
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, false), 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);
186 get_button (User).set_action (boost::bind (&BasicUI::next_marker, this), true, ShiftDown);
188 get_button (User).set_action (boost::bind (&BasicUI::next_marker, this), true, ButtonState(ShiftDown|UserDown));
191 get_button (Mute).set_action (boost::bind (&FaderPort::mute, this), true);
192 get_button (Solo).set_action (boost::bind (&FaderPort::solo, this), true);
193 get_button (Rec).set_action (boost::bind (&FaderPort::rec_enable, this), true);
195 get_button (Output).set_action (boost::bind (&FaderPort::use_master, this), true);
196 get_button (Output).set_action (boost::bind (&FaderPort::use_monitor, this), true, ShiftDown);
199 FaderPort::~FaderPort ()
206 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("unregistering input port %1\n", boost::shared_ptr<ARDOUR::Port>(_input_port)->name()));
207 Glib::Threads::Mutex::Lock em (AudioEngine::instance()->process_lock());
208 AudioEngine::instance()->unregister_port (_input_port);
209 _input_port.reset ();
213 _output_port->drain (10000, 250000); /* check every 10 msecs, wait up to 1/4 second for the port to drain */
214 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("unregistering output port %1\n", boost::shared_ptr<ARDOUR::Port>(_output_port)->name()));
215 Glib::Threads::Mutex::Lock em (AudioEngine::instance()->process_lock());
216 AudioEngine::instance()->unregister_port (_output_port);
217 _output_port.reset ();
222 /* stop event loop */
223 DEBUG_TRACE (DEBUG::FaderPort, "BaseUI::quit ()\n");
228 FaderPort::request_factory (uint32_t num_requests)
230 /* AbstractUI<T>::request_buffer_factory() is a template method only
231 instantiated in this source module. To provide something visible for
232 use in the interface/descriptor, we have this static method that is
235 return request_buffer_factory (num_requests);
239 FaderPort::start_midi_handling ()
241 /* handle device inquiry response */
242 _input_port->parser()->sysex.connect_same_thread (midi_connections, boost::bind (&FaderPort::sysex_handler, this, _1, _2, _3));
244 _input_port->parser()->poly_pressure.connect_same_thread (midi_connections, boost::bind (&FaderPort::button_handler, this, _1, _2));
246 _input_port->parser()->pitchbend.connect_same_thread (midi_connections, boost::bind (&FaderPort::encoder_handler, this, _1, _2));
248 _input_port->parser()->controller.connect_same_thread (midi_connections, boost::bind (&FaderPort::fader_handler, this, _1, _2));
250 /* This connection means that whenever data is ready from the input
251 * port, the relevant thread will invoke our ::midi_input_handler()
252 * method, which will read the data, and invoke the parser.
255 _input_port->xthread().set_receive_handler (sigc::bind (sigc::mem_fun (this, &FaderPort::midi_input_handler), boost::weak_ptr<AsyncMIDIPort> (_input_port)));
256 _input_port->xthread().attach (main_loop()->get_context());
260 FaderPort::stop_midi_handling ()
262 midi_connections.drop_connections ();
264 /* Note: the input handler is still active at this point, but we're no
265 * longer connected to any of the parser signals
270 FaderPort::do_request (FaderPortRequest* req)
272 if (req->type == CallSlot) {
274 call_slot (MISSING_INVALIDATOR, req->the_slot);
276 } else if (req->type == Quit) {
291 FaderPort::thread_init ()
293 pthread_set_name (event_loop_name().c_str());
295 PBD::notify_event_loops_about_thread_creation (pthread_self(), event_loop_name(), 2048);
296 ARDOUR::SessionEvent::create_per_thread_pool (event_loop_name(), 128);
298 set_thread_priority ();
302 FaderPort::all_lights_out ()
304 for (ButtonMap::iterator b = buttons.begin(); b != buttons.end(); ++b) {
305 b->second.set_led_state (_output_port, false);
310 FaderPort::get_button (ButtonID id) const
312 ButtonMap::const_iterator b = buttons.find (id);
313 assert (b != buttons.end());
314 return const_cast<Button&>(b->second);
318 FaderPort::button_long_press_timeout (ButtonID id)
320 if (buttons_down.find (id) != buttons_down.end()) {
321 if (get_button (id).invoke (ButtonState (LongPress|button_state), false)) {
322 /* whichever button this was, we've used it ... don't invoke the
325 consumed.insert (id);
328 /* release happened and somehow we were not cancelled */
331 return false; /* don't get called again */
335 FaderPort::start_press_timeout (Button& button, ButtonID id)
337 Glib::RefPtr<Glib::TimeoutSource> timeout = Glib::TimeoutSource::create (500); // milliseconds
338 button.timeout_connection = timeout->connect (sigc::bind (sigc::mem_fun (*this, &FaderPort::button_long_press_timeout), id));
339 timeout->attach (main_loop()->get_context());
343 FaderPort::button_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
345 ButtonID id (ButtonID (tb->controller_number));
346 Button& button (get_button (id));
348 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("button event for ID %1 press ? %2\n", (int) tb->controller_number, (tb->value ? "yes" : "no")));
351 buttons_down.insert (id);
353 buttons_down.erase (id);
354 button.timeout_connection.disconnect ();
357 ButtonState bs (ButtonState (0));
373 start_press_timeout (button, id);
378 fader_is_touched = tb->value;
379 if (_current_stripable) {
380 boost::shared_ptr<AutomationControl> gain = _current_stripable->gain_control ();
382 samplepos_t now = session->engine().sample_time();
384 gain->start_touch (now);
386 gain->stop_touch (now);
393 start_press_timeout (button, id);
399 button_state = (tb->value ? ButtonState (button_state|bs) : ButtonState (button_state&~bs));
400 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("reset button state to %1 using %2\n", button_state, (int) bs));
403 if (button.uses_flash()) {
404 button.set_led_state (_output_port, (int)tb->value);
407 set<ButtonID>::iterator c = consumed.find (id);
409 if (c == consumed.end()) {
410 (void) button.invoke (button_state, tb->value ? true : false);
412 DEBUG_TRACE (DEBUG::FaderPort, "button was consumed, ignored\n");
418 FaderPort::encoder_handler (MIDI::Parser &, MIDI::pitchbend_t pb)
426 //knob debouncing and hysteresis. The presonus encoder often sends bursts of events, or goes the wrong direction
428 last_last_encoder_delta = last_encoder_delta;
429 last_encoder_delta = delta;
430 microseconds_t now = get_microseconds ();
431 if ((now - last_encoder_time) < 10*1000) { //require at least 10ms interval between changes, because the device sometimes sends multiple deltas
434 if ((now - last_encoder_time) < 100*1000) { //avoid directional changes while "spinning", 100ms window
435 if ( (delta == last_encoder_delta) && (delta == last_last_encoder_delta) ) {
436 last_good_encoder_delta = delta; //3 in a row, grudgingly accept this as the new direction
438 if (delta != last_good_encoder_delta) { //otherwise ensure we keep going the same way
439 delta = last_good_encoder_delta;
441 } else { //we aren't yet in a spin window, just assume this move is really what we want
442 //NOTE: if you are worried about where these get initialized, here it is.
443 last_last_encoder_delta = delta;
444 last_encoder_delta = delta;
446 last_encoder_time = now;
447 last_good_encoder_delta = delta;
450 if (_current_stripable) {
452 ButtonState trim_modifier;
453 ButtonState width_modifier;
455 if (Profile->get_mixbus()) {
456 trim_modifier = ShiftDown;
457 width_modifier = ButtonState (0);
459 trim_modifier = UserDown;
460 width_modifier = ShiftDown;
463 if ((button_state & trim_modifier) == trim_modifier ) { // mod+encoder = input trim
464 boost::shared_ptr<AutomationControl> trim = _current_stripable->trim_control ();
466 float val = accurate_coefficient_to_dB (trim->get_value());
467 val += delta * .5f; // use 1/2 dB Steps -20..+20
468 trim->set_value (dB_to_coefficient (val), Controllable::UseGroup);
470 } else if (width_modifier && ((button_state & width_modifier) == width_modifier)) {
473 } else { // pan/balance
479 /* if the user button was pressed, mark it as consumed so that its
480 * release action has no effect.
483 if (!Profile->get_mixbus() && (button_state & UserDown)) {
484 consumed.insert (User);
490 FaderPort::fader_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
492 bool was_fader = false;
494 if (tb->controller_number == 0x0) {
495 fader_msb = tb->value;
497 } else if (tb->controller_number == 0x20) {
498 fader_lsb = tb->value;
503 if (_current_stripable) {
504 boost::shared_ptr<AutomationControl> gain = _current_stripable->gain_control ();
506 int ival = (fader_msb << 7) | fader_lsb;
507 float val = gain->interface_to_internal (ival/16384.0);
508 /* even though the faderport only controls a
509 single stripable at a time, allow the fader to
510 modify the group, if appropriate.
512 _current_stripable->gain_control()->set_value (val, Controllable::UseGroup);
519 FaderPort::sysex_handler (MIDI::Parser &p, MIDI::byte *buf, size_t sz)
521 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("sysex message received, size = %1\n", sz));
527 if (buf[2] != 0x7f ||
540 _device_active = true;
542 DEBUG_TRACE (DEBUG::FaderPort, "FaderPort identified via MIDI Device Inquiry response\n");
544 /* put it into native mode */
546 MIDI::byte native[3];
551 _output_port->write (native, 3, 0);
555 /* catch up on state */
557 /* make sure that rec_enable_state is consistent with current device state */
558 get_button (RecEnable).set_led_state (_output_port, rec_enable_state);
560 map_transport_state ();
561 map_recenable_state ();
565 FaderPort::set_active (bool yn)
567 DEBUG_TRACE (DEBUG::FaderPort, string_compose("Faderport::set_active init with yn: '%1'\n", yn));
569 if (yn == active()) {
575 /* start event loop */
579 connect_session_signals ();
581 Glib::RefPtr<Glib::TimeoutSource> blink_timeout = Glib::TimeoutSource::create (200); // milliseconds
582 blink_connection = blink_timeout->connect (sigc::mem_fun (*this, &FaderPort::blink));
583 blink_timeout->attach (main_loop()->get_context());
585 Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
586 periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &FaderPort::periodic));
587 periodic_timeout->attach (main_loop()->get_context());
596 ControlProtocol::set_active (yn);
598 DEBUG_TRACE (DEBUG::FaderPort, string_compose("Faderport::set_active done with yn: '%1'\n", yn));
604 FaderPort::periodic ()
606 if (!_current_stripable) {
610 ARDOUR::AutoState gain_state = _current_stripable->gain_control()->automation_state();
612 if (gain_state == ARDOUR::Touch || gain_state == ARDOUR::Play) {
620 FaderPort::stop_blinking (ButtonID id)
622 blinkers.remove (id);
623 get_button (id).set_led_state (_output_port, false);
627 FaderPort::start_blinking (ButtonID id)
629 blinkers.push_back (id);
630 get_button (id).set_led_state (_output_port, true);
636 blink_state = !blink_state;
638 for (Blinkers::iterator b = blinkers.begin(); b != blinkers.end(); b++) {
639 get_button(*b).set_led_state (_output_port, blink_state);
642 map_recenable_state ();
652 stop_midi_handling ();
653 session_connections.drop_connections ();
654 port_connection.disconnect ();
655 blink_connection.disconnect ();
656 selection_connection.disconnect ();
657 stripable_connections.drop_connections ();
660 stripable_connections.drop_connections ();
665 FaderPort::map_recenable_state ()
667 /* special case for RecEnable because its status can change as a
668 * confluence of unrelated parameters: (a) session rec-enable state (b)
669 * rec-enabled tracks. So we don't add the button to the blinkers list,
672 * * from the blink callback
673 * * when the session tells us about a status change
675 * We do the last one so that the button changes state promptly rather
676 * than waiting for the next blink callback. The change in "blinking"
677 * based on having record-enabled tracks isn't urgent, and that happens
678 * during the blink callback.
683 switch (session->record_status()) {
684 case Session::Disabled:
687 case Session::Enabled:
690 case Session::Recording:
691 if (session->have_rec_enabled_track ()) {
699 if (onoff != rec_enable_state) {
700 get_button(RecEnable).set_led_state (_output_port, onoff);
701 rec_enable_state = onoff;
706 FaderPort::map_transport_state ()
708 get_button (Loop).set_led_state (_output_port, session->get_play_loop());
710 float ts = session->transport_speed();
713 stop_blinking (Play);
714 } else if (fabs (ts) == 1.0) {
715 stop_blinking (Play);
716 get_button (Play).set_led_state (_output_port, true);
718 start_blinking (Play);
721 get_button (Stop).set_led_state (_output_port, session->transport_stopped_or_stopping ());
722 get_button (Rewind).set_led_state (_output_port, session->transport_speed() < 0.0);
723 get_button (Ffwd).set_led_state (_output_port, session->transport_speed() > 1.0);
727 FaderPort::parameter_changed (string what)
729 if (what == "punch-in" || what == "punch-out") {
730 bool in = session->config.get_punch_in ();
731 bool out = session->config.get_punch_out ();
733 get_button (Punch).set_led_state (_output_port, true);
734 blinkers.remove (Punch);
735 } else if (in || out) {
736 start_blinking (Punch);
738 stop_blinking (Punch);
744 FaderPort::connect_session_signals()
746 session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_recenable_state, this), this);
747 session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_transport_state, this), this);
748 /* not session, but treat it similarly */
749 session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::parameter_changed, this, _1), this);
753 FaderPort::midi_input_handler (Glib::IOCondition ioc, boost::weak_ptr<ARDOUR::AsyncMIDIPort> wport)
755 boost::shared_ptr<AsyncMIDIPort> port (wport.lock());
761 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("something happend on %1\n", boost::shared_ptr<MIDI::Port>(port)->name()));
770 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("data available on %1\n", boost::shared_ptr<MIDI::Port>(port)->name()));
771 samplepos_t now = session->engine().sample_time();
780 FaderPort::get_state ()
782 XMLNode& node (ControlProtocol::get_state());
786 child = new XMLNode (X_("Input"));
787 child->add_child_nocopy (boost::shared_ptr<ARDOUR::Port>(_input_port)->get_state());
788 node.add_child_nocopy (*child);
791 child = new XMLNode (X_("Output"));
792 child->add_child_nocopy (boost::shared_ptr<ARDOUR::Port>(_output_port)->get_state());
793 node.add_child_nocopy (*child);
795 /* Save action state for Mix, Proj, Trns and User buttons, since these
796 * are user controlled. We can only save named-action operations, since
797 * internal functions are just pointers to functions and hard to
798 * serialize without enumerating them all somewhere.
801 node.add_child_nocopy (get_button (Mix).get_state());
802 node.add_child_nocopy (get_button (Proj).get_state());
803 node.add_child_nocopy (get_button (Trns).get_state());
804 node.add_child_nocopy (get_button (User).get_state());
805 node.add_child_nocopy (get_button (Footswitch).get_state());
811 FaderPort::set_state (const XMLNode& node, int version)
814 XMLNodeConstIterator niter;
815 XMLNode const* child;
817 if (ControlProtocol::set_state (node, version)) {
821 if ((child = node.child (X_("Input"))) != 0) {
822 XMLNode* portnode = child->child (Port::state_node_name.c_str());
824 boost::shared_ptr<ARDOUR::Port>(_input_port)->set_state (*portnode, version);
828 if ((child = node.child (X_("Output"))) != 0) {
829 XMLNode* portnode = child->child (Port::state_node_name.c_str());
831 boost::shared_ptr<ARDOUR::Port>(_output_port)->set_state (*portnode, version);
835 for (XMLNodeList::const_iterator n = node.children().begin(); n != node.children().end(); ++n) {
836 if ((*n)->name() == X_("Button")) {
838 if (!(*n)->get_property (X_("id"), xid)) {
841 ButtonMap::iterator b = buttons.find (ButtonID (xid));
842 if (b == buttons.end()) {
845 b->second.set_state (**n);
853 FaderPort::connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool yn)
855 DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler start\n");
856 if (!_input_port || !_output_port) {
860 string ni = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_input_port)->name());
861 string no = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_output_port)->name());
863 if (ni == name1 || ni == name2) {
865 connection_state |= InputConnected;
867 connection_state &= ~InputConnected;
869 } else if (no == name1 || no == name2) {
871 connection_state |= OutputConnected;
873 connection_state &= ~OutputConnected;
876 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("Connections between %1 and %2 changed, but I ignored it\n", name1, name2));
881 if ((connection_state & (InputConnected|OutputConnected)) == (InputConnected|OutputConnected)) {
883 /* XXX this is a horrible hack. Without a short sleep here,
884 something prevents the device wakeup messages from being
885 sent and/or the responses from being received.
889 DEBUG_TRACE (DEBUG::FaderPort, "device now connected for both input and output\n");
893 DEBUG_TRACE (DEBUG::FaderPort, "Device disconnected (input or output or both) or not yet fully connected\n");
894 _device_active = false;
897 ConnectionChange (); /* emit signal for our GUI */
899 DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler end\n");
901 return true; /* connection status changed */
905 FaderPort::connected ()
907 DEBUG_TRACE (DEBUG::FaderPort, "sending device inquiry message...\n");
909 start_midi_handling ();
911 /* send device inquiry */
922 _output_port->write (buf, 6, 0);
926 FaderPort::Button::invoke (FaderPort::ButtonState bs, bool press)
928 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("invoke button %1 for %2 state %3%4%5\n", id, (press ? "press":"release"), hex, bs, dec));
933 if ((x = on_press.find (bs)) == on_press.end()) {
934 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("no press action for button %1 state %2 @ %3 in %4\n", id, bs, this, &on_press));
938 if ((x = on_release.find (bs)) == on_release.end()) {
939 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("no release action for button %1 state %2 @%3 in %4\n", id, bs, this, &on_release));
944 switch (x->second.type) {
946 if (!x->second.action_name.empty()) {
947 fp.access_action (x->second.action_name);
951 case InternalFunction:
952 if (x->second.function) {
953 x->second.function ();
962 FaderPort::Button::set_action (string const& name, bool when_pressed, FaderPort::ButtonState bs)
966 todo.type = NamedAction;
972 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 to action %2 on press + %3%4%5\n", id, name, bs));
973 todo.action_name = name;
978 on_release.erase (bs);
982 /* if the binding is for the User button, we
983 need to store the button state as it will be
984 seen on button release, which will include UserDown.
986 bs = FaderPort::ButtonState (bs|UserDown);
989 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 to action %2 on release + %3%4%5\n", id, name, bs));
990 todo.action_name = name;
991 on_release[bs] = todo;
997 FaderPort::Button::get_action (bool press, FaderPort::ButtonState bs)
1002 if ((x = on_press.find (bs)) == on_press.end()) {
1005 if (x->second.type != NamedAction) {
1008 return x->second.action_name;
1010 if ((x = on_release.find (bs)) == on_release.end()) {
1013 if (x->second.type != NamedAction) {
1016 return x->second.action_name;
1021 FaderPort::Button::set_action (boost::function<void()> f, bool when_pressed, FaderPort::ButtonState bs)
1024 todo.type = InternalFunction;
1027 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));
1029 on_press[bs] = todo;
1031 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 (%2) @ %5 to some functor on release + %3\n", id, name, bs, this));
1033 on_release[bs] = todo;
1038 FaderPort::Button::set_led_state (boost::shared_ptr<MIDI::Port> port, bool onoff)
1041 /* fader button ID - no LED */
1048 buf[2] = onoff ? 1 : 0;
1049 port->write (buf, 3, 0);
1053 FaderPort::Button::set_state (XMLNode const& node)
1056 if (!node.get_property ("id", xid) || xid != id) {
1060 typedef pair<string,FaderPort::ButtonState> state_pair_t;
1061 vector<state_pair_t> state_pairs;
1063 state_pairs.push_back (make_pair (string ("plain"), ButtonState (0)));
1064 state_pairs.push_back (make_pair (string ("shift"), ShiftDown));
1065 state_pairs.push_back (make_pair (string ("long"), LongPress));
1067 for (vector<state_pair_t>::const_iterator sp = state_pairs.begin(); sp != state_pairs.end(); ++sp) {
1069 string propname = sp->first + X_("-press");
1071 if (node.get_property (propname.c_str(), value)) {
1072 set_action (value, true, sp->second);
1075 propname = sp->first + X_("-release");
1076 if (node.get_property (propname.c_str(), value)) {
1077 set_action (value, false, sp->second);
1085 FaderPort::Button::get_state () const
1087 XMLNode* node = new XMLNode (X_("Button"));
1089 node->set_property (X_("id"), to_string<int32_t>(id));
1091 ToDoMap::const_iterator x;
1093 null.type = NamedAction;
1095 typedef pair<string,FaderPort::ButtonState> state_pair_t;
1096 vector<state_pair_t> state_pairs;
1098 state_pairs.push_back (make_pair (string ("plain"), ButtonState (0)));
1099 state_pairs.push_back (make_pair (string ("shift"), ShiftDown));
1100 state_pairs.push_back (make_pair (string ("long"), LongPress));
1103 state_pairs.push_back (make_pair (string ("plain"), UserDown));
1104 state_pairs.push_back (make_pair (string ("long"), ButtonState (LongPress | UserDown)));
1107 for (vector<state_pair_t>::const_iterator sp = state_pairs.begin(); sp != state_pairs.end(); ++sp) {
1108 if ((x = on_press.find (sp->second)) != on_press.end()) {
1109 if (x->second.type == NamedAction) {
1110 node->set_property (string (sp->first + X_("-press")).c_str(), x->second.action_name);
1114 if ((x = on_release.find (sp->second)) != on_release.end()) {
1115 if (x->second.type == NamedAction) {
1116 node->set_property (string (sp->first + X_("-release")).c_str(), x->second.action_name);
1125 FaderPort::stripable_selection_changed ()
1127 set_current_stripable (ControlProtocol::first_selected_stripable());
1131 FaderPort::drop_current_stripable ()
1133 if (_current_stripable) {
1134 if (_current_stripable == session->monitor_out()) {
1135 set_current_stripable (session->master_out());
1137 set_current_stripable (boost::shared_ptr<Stripable>());
1143 FaderPort::set_current_stripable (boost::shared_ptr<Stripable> r)
1145 stripable_connections.drop_connections ();
1147 _current_stripable = r;
1149 /* turn this off. It will be turned on back on in use_master() or
1150 use_monitor() as appropriate.
1152 get_button(Output).set_led_state (_output_port, false);
1154 if (_current_stripable) {
1155 _current_stripable->DropReferences.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::drop_current_stripable, this), this);
1157 _current_stripable->mute_control()->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_mute, this), this);
1158 _current_stripable->solo_control()->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_solo, this), this);
1160 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_stripable);
1162 t->rec_enable_control()->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_recenable, this), this);
1165 boost::shared_ptr<AutomationControl> control = _current_stripable->gain_control ();
1167 control->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_gain, this), this);
1168 control->alist()->automation_state_changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_auto, this), this);
1171 boost::shared_ptr<MonitorProcessor> mp = _current_stripable->monitor_control();
1173 mp->cut_control()->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_cut, this), this);
1177 //ToDo: subscribe to the fader automation modes so we can light the LEDs
1179 map_stripable_state ();
1183 FaderPort::map_auto ()
1185 /* Under no circumstances send a message to "enable" the LED state of
1186 * the Off button, because this will disable the fader.
1189 boost::shared_ptr<AutomationControl> control = _current_stripable->gain_control ();
1190 const AutoState as = control->automation_state ();
1194 get_button (FP_Read).set_led_state (_output_port, true);
1195 get_button (FP_Write).set_led_state (_output_port, false);
1196 get_button (FP_Touch).set_led_state (_output_port, false);
1199 get_button (FP_Read).set_led_state (_output_port, false);
1200 get_button (FP_Write).set_led_state (_output_port, true);
1201 get_button (FP_Touch).set_led_state (_output_port, false);
1204 case ARDOUR::Latch: // XXX
1205 get_button (FP_Read).set_led_state (_output_port, false);
1206 get_button (FP_Write).set_led_state (_output_port, false);
1207 get_button (FP_Touch).set_led_state (_output_port, true);
1210 get_button (FP_Read).set_led_state (_output_port, false);
1211 get_button (FP_Write).set_led_state (_output_port, false);
1212 get_button (FP_Touch).set_led_state (_output_port, false);
1220 FaderPort::map_cut ()
1222 boost::shared_ptr<MonitorProcessor> mp = _current_stripable->monitor_control();
1225 bool yn = mp->cut_all ();
1227 start_blinking (Mute);
1229 stop_blinking (Mute);
1232 stop_blinking (Mute);
1237 FaderPort::map_mute ()
1239 if (_current_stripable) {
1240 if (_current_stripable->mute_control()->muted()) {
1241 stop_blinking (Mute);
1242 get_button (Mute).set_led_state (_output_port, true);
1243 } else if (_current_stripable->mute_control()->muted_by_others_soloing () || _current_stripable->mute_control()->muted_by_masters()) {
1244 start_blinking (Mute);
1246 stop_blinking (Mute);
1249 stop_blinking (Mute);
1254 FaderPort::map_solo ()
1256 if (_current_stripable) {
1257 get_button (Solo).set_led_state (_output_port, _current_stripable->solo_control()->soloed());
1259 get_button (Solo).set_led_state (_output_port, false);
1264 FaderPort::map_recenable ()
1266 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_stripable);
1268 get_button (Rec).set_led_state (_output_port, t->rec_enable_control()->get_value());
1270 get_button (Rec).set_led_state (_output_port, false);
1275 FaderPort::map_gain ()
1277 if (fader_is_touched) {
1278 /* Do not send fader moves while the user is touching the fader */
1282 if (!_current_stripable) {
1286 boost::shared_ptr<AutomationControl> control = _current_stripable->gain_control ();
1292 val = control->internal_to_interface (control->get_value ());
1295 /* Faderport sends fader position with range 0..16384 (though some of
1296 * the least-significant bits at the top end are missing - it may only
1297 * get to 1636X or so).
1299 * But ... position must be sent in the range 0..1023.
1304 int ival = (int) lrintf (val * 1023.0);
1306 /* MIDI normalization requires that we send two separate messages here,
1307 * not one single 6 byte one.
1316 _output_port->write (buf, 3, 0);
1319 buf[2] = ival & 0x7f;
1321 _output_port->write (buf, 3, 0);
1325 FaderPort::map_stripable_state ()
1327 if (!_current_stripable) {
1328 stop_blinking (Mute);
1329 stop_blinking (Solo);
1330 get_button (Rec).set_led_state (_output_port, false);
1337 if (_current_stripable == session->monitor_out()) {
1345 list<boost::shared_ptr<ARDOUR::Bundle> >
1346 FaderPort::bundles ()
1348 list<boost::shared_ptr<ARDOUR::Bundle> > b;
1350 if (_input_bundle) {
1351 b.push_back (_input_bundle);
1352 b.push_back (_output_bundle);
1358 boost::shared_ptr<Port>
1359 FaderPort::output_port()
1361 return _output_port;
1364 boost::shared_ptr<Port>
1365 FaderPort::input_port()
1371 FaderPort::set_action (ButtonID id, std::string const& action_name, bool on_press, ButtonState bs)
1373 get_button(id).set_action (action_name, on_press, bs);
1377 FaderPort::get_action (ButtonID id, bool press, ButtonState bs)
1379 return get_button(id).get_action (press, bs);