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/error.h"
30 #include "pbd/failed_constructor.h"
31 #include "pbd/file_utils.h"
32 #include "pbd/pthread_utils.h"
33 #include "pbd/compose.h"
34 #include "pbd/xml++.h"
36 #include "midi++/port.h"
38 #include "ardour/async_midi_port.h"
39 #include "ardour/audioengine.h"
40 #include "ardour/amp.h"
41 #include "ardour/bundle.h"
42 #include "ardour/controllable_descriptor.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);
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 ()
202 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("unregistering input port %1\n", boost::shared_ptr<ARDOUR::Port>(_input_port)->name()));
203 Glib::Threads::Mutex::Lock em (AudioEngine::instance()->process_lock());
204 AudioEngine::instance()->unregister_port (_input_port);
205 _input_port.reset ();
209 _output_port->drain (10000, 250000); /* check every 10 msecs, wait up to 1/4 second for the port to drain */
210 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("unregistering output port %1\n", boost::shared_ptr<ARDOUR::Port>(_output_port)->name()));
211 Glib::Threads::Mutex::Lock em (AudioEngine::instance()->process_lock());
212 AudioEngine::instance()->unregister_port (_output_port);
213 _output_port.reset ();
218 /* stop event loop */
219 DEBUG_TRACE (DEBUG::FaderPort, "BaseUI::quit ()\n");
224 FaderPort::request_factory (uint32_t num_requests)
226 /* AbstractUI<T>::request_buffer_factory() is a template method only
227 instantiated in this source module. To provide something visible for
228 use in the interface/descriptor, we have this static method that is
231 return request_buffer_factory (num_requests);
235 FaderPort::start_midi_handling ()
237 /* handle device inquiry response */
238 _input_port->parser()->sysex.connect_same_thread (midi_connections, boost::bind (&FaderPort::sysex_handler, this, _1, _2, _3));
240 _input_port->parser()->poly_pressure.connect_same_thread (midi_connections, boost::bind (&FaderPort::button_handler, this, _1, _2));
242 _input_port->parser()->pitchbend.connect_same_thread (midi_connections, boost::bind (&FaderPort::encoder_handler, this, _1, _2));
244 _input_port->parser()->controller.connect_same_thread (midi_connections, boost::bind (&FaderPort::fader_handler, this, _1, _2));
246 /* This connection means that whenever data is ready from the input
247 * port, the relevant thread will invoke our ::midi_input_handler()
248 * method, which will read the data, and invoke the parser.
251 _input_port->xthread().set_receive_handler (sigc::bind (sigc::mem_fun (this, &FaderPort::midi_input_handler), boost::weak_ptr<AsyncMIDIPort> (_input_port)));
252 _input_port->xthread().attach (main_loop()->get_context());
256 FaderPort::stop_midi_handling ()
258 midi_connections.drop_connections ();
260 /* Note: the input handler is still active at this point, but we're no
261 * longer connected to any of the parser signals
266 FaderPort::do_request (FaderPortRequest* req)
268 if (req->type == CallSlot) {
270 call_slot (MISSING_INVALIDATOR, req->the_slot);
272 } else if (req->type == Quit) {
287 FaderPort::thread_init ()
289 struct sched_param rtparam;
291 pthread_set_name (event_loop_name().c_str());
293 PBD::notify_event_loops_about_thread_creation (pthread_self(), event_loop_name(), 2048);
294 ARDOUR::SessionEvent::create_per_thread_pool (event_loop_name(), 128);
296 memset (&rtparam, 0, sizeof (rtparam));
297 rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
299 if (pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam) != 0) {
300 // do we care? not particularly.
305 FaderPort::all_lights_out ()
307 for (ButtonMap::iterator b = buttons.begin(); b != buttons.end(); ++b) {
308 b->second.set_led_state (_output_port, false);
313 FaderPort::get_button (ButtonID id) const
315 ButtonMap::const_iterator b = buttons.find (id);
316 assert (b != buttons.end());
317 return const_cast<Button&>(b->second);
321 FaderPort::button_long_press_timeout (ButtonID id)
323 if (buttons_down.find (id) != buttons_down.end()) {
324 get_button (id).invoke (ButtonState (LongPress|button_state), false);
326 /* release happened and somehow we were not cancelled */
329 /* whichever button this was, we've used it ... don't invoke the
332 consumed.insert (id);
334 return false; /* don't get called again */
338 FaderPort::start_press_timeout (Button& button, ButtonID id)
340 Glib::RefPtr<Glib::TimeoutSource> timeout = Glib::TimeoutSource::create (500); // milliseconds
341 button.timeout_connection = timeout->connect (sigc::bind (sigc::mem_fun (*this, &FaderPort::button_long_press_timeout), id));
342 timeout->attach (main_loop()->get_context());
346 FaderPort::button_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
348 ButtonID id (ButtonID (tb->controller_number));
349 Button& button (get_button (id));
351 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("button event for ID %1 press ? %2\n", (int) tb->controller_number, (tb->value ? "yes" : "no")));
354 buttons_down.insert (id);
356 buttons_down.erase (id);
357 button.timeout_connection.disconnect ();
360 ButtonState bs (ButtonState (0));
376 fader_is_touched = tb->value;
377 if (_current_stripable) {
378 boost::shared_ptr<AutomationControl> gain = _current_stripable->gain_control ();
380 framepos_t now = session->engine().sample_time();
382 gain->start_touch (now);
384 gain->stop_touch (now);
391 start_press_timeout (button, id);
397 button_state = (tb->value ? ButtonState (button_state|bs) : ButtonState (button_state&~bs));
398 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("reset button state to %1 using %2\n", button_state, (int) bs));
401 if (button.uses_flash()) {
402 button.set_led_state (_output_port, (int)tb->value);
405 set<ButtonID>::iterator c = consumed.find (id);
407 if (c == consumed.end()) {
408 button.invoke (button_state, tb->value ? true : false);
410 DEBUG_TRACE (DEBUG::FaderPort, "button was consumed, ignored\n");
416 FaderPort::encoder_handler (MIDI::Parser &, MIDI::pitchbend_t pb)
424 //knob debouncing and hysteresis. The presonus encoder often sends bursts of events, or goes the wrong direction
426 last_last_encoder_delta = last_encoder_delta;
427 last_encoder_delta = delta;
428 microseconds_t now = get_microseconds ();
429 if ((now - last_encoder_time) < 10*1000) { //require at least 10ms interval between changes, because the device sometimes sends multiple deltas
432 if ((now - last_encoder_time) < 100*1000) { //avoid directional changes while "spinning", 100ms window
433 if ( (delta == last_encoder_delta) && (delta == last_last_encoder_delta) ) {
434 last_good_encoder_delta = delta; //3 in a row, grudgingly accept this as the new direction
436 if (delta != last_good_encoder_delta) { //otherwise ensure we keep going the same way
437 delta = last_good_encoder_delta;
439 } else { //we aren't yet in a spin window, just assume this move is really what we want
440 //NOTE: if you are worried about where these get initialized, here it is.
441 last_last_encoder_delta = delta;
442 last_encoder_delta = delta;
444 last_encoder_time = now;
445 last_good_encoder_delta = delta;
448 if (_current_stripable) {
450 ButtonState trim_modifier;
451 ButtonState width_modifier;
453 if (Profile->get_mixbus()) {
454 trim_modifier = ShiftDown;
455 width_modifier = ButtonState (0);
457 trim_modifier = UserDown;
458 width_modifier = ShiftDown;
461 if ((button_state & trim_modifier) == trim_modifier ) { // mod+encoder = input trim
462 boost::shared_ptr<AutomationControl> trim = _current_stripable->trim_control ();
464 float val = accurate_coefficient_to_dB (trim->get_value());
465 val += delta * .5f; // use 1/2 dB Steps -20..+20
466 trim->set_value (dB_to_coefficient (val), Controllable::UseGroup);
468 } else if (width_modifier && ((button_state & width_modifier) == width_modifier)) {
469 ardour_pan_width (delta);
471 } else { // pan/balance
472 if (!Profile->get_mixbus()) {
473 ardour_pan_azimuth (delta);
480 /* if the user button was pressed, mark it as consumed so that its
481 * release action has no effect.
484 if (!Profile->get_mixbus() && (button_state & UserDown)) {
485 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 ());
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 framepos_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);
950 case InternalFunction:
951 if (x->second.function) {
952 x->second.function ();
958 FaderPort::Button::set_action (string const& name, bool when_pressed, FaderPort::ButtonState bs)
962 todo.type = NamedAction;
968 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 to action %2 on press + %3%4%5\n", id, name, bs));
969 todo.action_name = name;
974 on_release.erase (bs);
976 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 to action %2 on release + %3%4%5\n", id, name, bs));
977 todo.action_name = name;
978 on_release[bs] = todo;
984 FaderPort::Button::get_action (bool press, FaderPort::ButtonState bs)
989 if ((x = on_press.find (bs)) == on_press.end()) {
992 if (x->second.type != NamedAction) {
995 return x->second.action_name;
997 if ((x = on_release.find (bs)) == on_release.end()) {
1000 if (x->second.type != NamedAction) {
1003 return x->second.action_name;
1008 FaderPort::Button::set_action (boost::function<void()> f, bool when_pressed, FaderPort::ButtonState bs)
1011 todo.type = InternalFunction;
1014 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));
1016 on_press[bs] = todo;
1018 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 (%2) @ %5 to some functor on release + %3\n", id, name, bs, this));
1020 on_release[bs] = todo;
1025 FaderPort::Button::set_led_state (boost::shared_ptr<MIDI::Port> port, bool onoff)
1028 /* fader button ID - no LED */
1035 buf[2] = onoff ? 1 : 0;
1036 port->write (buf, 3, 0);
1040 FaderPort::Button::set_state (XMLNode const& node)
1043 if (!node.get_property ("id", xid) || xid != id) {
1047 typedef pair<string,FaderPort::ButtonState> state_pair_t;
1048 vector<state_pair_t> state_pairs;
1050 state_pairs.push_back (make_pair (string ("plain"), ButtonState (0)));
1051 state_pairs.push_back (make_pair (string ("shift"), ShiftDown));
1052 state_pairs.push_back (make_pair (string ("long"), LongPress));
1054 for (vector<state_pair_t>::const_iterator sp = state_pairs.begin(); sp != state_pairs.end(); ++sp) {
1056 string propname = sp->first + X_("-press");
1058 if (node.get_property (propname.c_str(), value)) {
1059 set_action (value, true, sp->second);
1062 propname = sp->first + X_("-release");
1063 if (node.get_property (propname.c_str(), value)) {
1064 set_action (value, false, sp->second);
1072 FaderPort::Button::get_state () const
1074 XMLNode* node = new XMLNode (X_("Button"));
1076 node->set_property (X_("id"), to_string<int32_t>(id));
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->set_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->set_property (string (sp->first + X_("-release")).c_str(), x->second.action_name);
1107 FaderPort::stripable_selection_changed ()
1109 set_current_stripable (ControlProtocol::first_selected_stripable());
1113 FaderPort::drop_current_stripable ()
1115 if (_current_stripable) {
1116 if (_current_stripable == session->monitor_out()) {
1117 set_current_stripable (session->master_out());
1119 set_current_stripable (boost::shared_ptr<Stripable>());
1125 FaderPort::set_current_stripable (boost::shared_ptr<Stripable> r)
1127 stripable_connections.drop_connections ();
1129 _current_stripable = r;
1131 /* turn this off. It will be turned on back on in use_master() or
1132 use_monitor() as appropriate.
1134 get_button(Output).set_led_state (_output_port, false);
1136 if (_current_stripable) {
1137 _current_stripable->DropReferences.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::drop_current_stripable, this), this);
1139 _current_stripable->mute_control()->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_mute, this), this);
1140 _current_stripable->solo_control()->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_solo, this), this);
1142 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_stripable);
1144 t->rec_enable_control()->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_recenable, this), this);
1147 boost::shared_ptr<AutomationControl> control = _current_stripable->gain_control ();
1149 control->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_gain, this), this);
1150 control->alist()->automation_state_changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_auto, this), this);
1153 boost::shared_ptr<MonitorProcessor> mp = _current_stripable->monitor_control();
1155 mp->cut_control()->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_cut, this), this);
1159 //ToDo: subscribe to the fader automation modes so we can light the LEDs
1161 map_stripable_state ();
1165 FaderPort::map_auto ()
1167 /* Under no circumstances send a message to "enable" the LED state of
1168 * the Off button, because this will disable the fader.
1171 boost::shared_ptr<AutomationControl> control = _current_stripable->gain_control ();
1172 const AutoState as = control->automation_state ();
1176 get_button (FP_Read).set_led_state (_output_port, true);
1177 get_button (FP_Write).set_led_state (_output_port, false);
1178 get_button (FP_Touch).set_led_state (_output_port, false);
1181 get_button (FP_Read).set_led_state (_output_port, false);
1182 get_button (FP_Write).set_led_state (_output_port, true);
1183 get_button (FP_Touch).set_led_state (_output_port, false);
1186 get_button (FP_Read).set_led_state (_output_port, false);
1187 get_button (FP_Write).set_led_state (_output_port, false);
1188 get_button (FP_Touch).set_led_state (_output_port, true);
1191 get_button (FP_Read).set_led_state (_output_port, false);
1192 get_button (FP_Write).set_led_state (_output_port, false);
1193 get_button (FP_Touch).set_led_state (_output_port, false);
1201 FaderPort::map_cut ()
1203 boost::shared_ptr<MonitorProcessor> mp = _current_stripable->monitor_control();
1206 bool yn = mp->cut_all ();
1208 start_blinking (Mute);
1210 stop_blinking (Mute);
1213 stop_blinking (Mute);
1218 FaderPort::map_mute ()
1220 if (_current_stripable) {
1221 if (_current_stripable->mute_control()->muted()) {
1222 stop_blinking (Mute);
1223 get_button (Mute).set_led_state (_output_port, true);
1224 } else if (_current_stripable->mute_control()->muted_by_others_soloing () || _current_stripable->mute_control()->muted_by_masters()) {
1225 start_blinking (Mute);
1227 stop_blinking (Mute);
1230 stop_blinking (Mute);
1235 FaderPort::map_solo ()
1237 if (_current_stripable) {
1238 get_button (Solo).set_led_state (_output_port, _current_stripable->solo_control()->soloed());
1240 get_button (Solo).set_led_state (_output_port, false);
1245 FaderPort::map_recenable ()
1247 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_stripable);
1249 get_button (Rec).set_led_state (_output_port, t->rec_enable_control()->get_value());
1251 get_button (Rec).set_led_state (_output_port, false);
1256 FaderPort::map_gain ()
1258 if (fader_is_touched) {
1259 /* Do not send fader moves while the user is touching the fader */
1263 if (!_current_stripable) {
1267 boost::shared_ptr<AutomationControl> control = _current_stripable->gain_control ();
1273 val = control->internal_to_interface (control->get_value ());
1276 /* Faderport sends fader position with range 0..16384 (though some of
1277 * the least-significant bits at the top end are missing - it may only
1278 * get to 1636X or so).
1280 * But ... position must be sent in the range 0..1023.
1285 int ival = (int) lrintf (val * 1023.0);
1287 /* MIDI normalization requires that we send two separate messages here,
1288 * not one single 6 byte one.
1297 _output_port->write (buf, 3, 0);
1300 buf[2] = ival & 0x7f;
1302 _output_port->write (buf, 3, 0);
1306 FaderPort::map_stripable_state ()
1308 if (!_current_stripable) {
1309 stop_blinking (Mute);
1310 stop_blinking (Solo);
1311 get_button (Rec).set_led_state (_output_port, false);
1318 if (_current_stripable == session->monitor_out()) {
1326 list<boost::shared_ptr<ARDOUR::Bundle> >
1327 FaderPort::bundles ()
1329 list<boost::shared_ptr<ARDOUR::Bundle> > b;
1331 if (_input_bundle) {
1332 b.push_back (_input_bundle);
1333 b.push_back (_output_bundle);
1339 boost::shared_ptr<Port>
1340 FaderPort::output_port()
1342 return _output_port;
1345 boost::shared_ptr<Port>
1346 FaderPort::input_port()
1352 FaderPort::set_action (ButtonID id, std::string const& action_name, bool on_press, ButtonState bs)
1354 get_button(id).set_action (action_name, on_press, bs);
1358 FaderPort::get_action (ButtonID id, bool press, ButtonState bs)
1360 return get_button(id).get_action (press, bs);