a more reliable/robust/less complex version of previous commit
[ardour.git] / libs / surfaces / generic_midi / generic_midi_control_protocol.cc
index e171cfbcc39a88f4dadf734c0da74663a09f66a4..d14a9ca24cac00bfae61d4c743dce1b4b7904d58 100644 (file)
@@ -1,6 +1,6 @@
 /*
     Copyright (C) 2006 Paul Davis
+
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
@@ -25,7 +25,6 @@
 #include <glibmm/fileutils.h>
 #include <glibmm/miscutils.h>
 
-#include "pbd/controllable_descriptor.h"
 #include "pbd/error.h"
 #include "pbd/failed_constructor.h"
 #include "pbd/file_utils.h"
 
 #include "midi++/port.h"
 
+#include "ardour/async_midi_port.h"
+#include "ardour/audioengine.h"
 #include "ardour/audioengine.h"
+#include "ardour/controllable_descriptor.h"
 #include "ardour/filesystem_paths.h"
 #include "ardour/session.h"
-#include "ardour/route.h"
 #include "ardour/midi_ui.h"
 #include "ardour/rc_configuration.h"
 #include "ardour/midiport_manager.h"
@@ -52,18 +53,19 @@ using namespace ARDOUR;
 using namespace PBD;
 using namespace std;
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 #define midi_ui_context() MidiControlUI::instance() /* a UICallback-derived object that specifies the event loop for signal handling */
 
 GenericMidiControlProtocol::GenericMidiControlProtocol (Session& s)
        : ControlProtocol (s, _("Generic MIDI"))
+       , connection_state (ConnectionState (0))
        , _motorised (false)
        , _threshold (10)
        , gui (0)
 {
-       _input_port = s.midi_input_port ();
-       _output_port = s.midi_output_port ();
+       _input_port = boost::dynamic_pointer_cast<AsyncMIDIPort> (s.midi_input_port ());
+       _output_port = boost::dynamic_pointer_cast<AsyncMIDIPort> (s.midi_output_port ());
 
        do_feedback = false;
        _feedback_interval = 10000; // microseconds
@@ -92,7 +94,12 @@ GenericMidiControlProtocol::GenericMidiControlProtocol (Session& s)
 
        /* this one is cross-thread */
 
-       Route::RemoteControlIDChange.connect (*this, MISSING_INVALIDATOR, boost::bind (&GenericMidiControlProtocol::reset_controllables, this), midi_ui_context());
+       PresentationInfo::Change.connect (*this, MISSING_INVALIDATOR, boost::bind (&GenericMidiControlProtocol::reset_controllables, this), midi_ui_context());
+
+       /* Catch port connections and disconnections (cross-thread) */
+       ARDOUR::AudioEngine::instance()->PortConnectedOrDisconnected.connect (port_connection, MISSING_INVALIDATOR,
+                                                                             boost::bind (&GenericMidiControlProtocol::connection_handler, this, _1, _2, _3, _4, _5),
+                                                                             midi_ui_context());
 
        reload_maps ();
 }
@@ -160,7 +167,7 @@ GenericMidiControlProtocol::reload_maps ()
 
                MapInfo mi;
 
-               XMLProperty* prop = tree.root()->property ("name");
+               XMLProperty const * prop = tree.root()->property ("name");
 
                if (!prop) {
                        continue;
@@ -168,11 +175,11 @@ GenericMidiControlProtocol::reload_maps ()
 
                mi.name = prop->value ();
                mi.path = fullpath;
-               
+
                map_info.push_back (mi);
        }
 }
-       
+
 void
 GenericMidiControlProtocol::drop_all ()
 {
@@ -229,7 +236,9 @@ GenericMidiControlProtocol::drop_bindings ()
 int
 GenericMidiControlProtocol::set_active (bool /*yn*/)
 {
-       /* start/stop delivery/outbound thread */
+       /* nothing to do here: the MIDI UI thread in libardour handles all our
+          I/O needs.
+       */
        return 0;
 }
 
@@ -239,7 +248,7 @@ GenericMidiControlProtocol::set_feedback_interval (microseconds_t ms)
        _feedback_interval = ms;
 }
 
-void 
+void
 GenericMidiControlProtocol::send_feedback ()
 {
        /* This is executed in RT "process" context", so no blocking calls
@@ -258,11 +267,11 @@ GenericMidiControlProtocol::send_feedback ()
        }
 
        _send_feedback ();
-       
+
        last_feedback_time = now;
 }
 
-void 
+void
 GenericMidiControlProtocol::_send_feedback ()
 {
        /* This is executed in RT "process" context", so no blocking calls
@@ -282,7 +291,7 @@ GenericMidiControlProtocol::_send_feedback ()
        if (!lm.locked ()) {
                return;
        }
-       
+
        for (MIDIControllables::iterator r = controllables.begin(); r != controllables.end(); ++r) {
                MIDI::byte* end = (*r)->write_feedback (buf, bsize);
                if (end != buf) {
@@ -314,14 +323,16 @@ GenericMidiControlProtocol::start_learning (Controllable* c)
 
        {
                Glib::Threads::Mutex::Lock lm (pending_lock);
-               
+
                MIDIPendingControllables::iterator ptmp;
                for (MIDIPendingControllables::iterator i = pending_controllables.begin(); i != pending_controllables.end(); ) {
                        ptmp = i;
                        ++ptmp;
-                       if (((*i)->first)->get_controllable() == c) {
-                               (*i)->second.disconnect();
-                               delete (*i)->first;
+                       if (((*i)->mc)->get_controllable() == c) {
+                               if ((*i)->own_mc) {
+                                       delete (*i)->mc;
+                               }
+                               (*i)->connection.disconnect();
                                delete *i;
                                pending_controllables.erase (i);
                        }
@@ -330,6 +341,7 @@ GenericMidiControlProtocol::start_learning (Controllable* c)
        }
 
        MIDIControllable* mc = 0;
+       bool own_mc = false;
 
        for (MIDIControllables::iterator i = controllables.begin(); i != controllables.end(); ++i) {
                if ((*i)->get_controllable() && ((*i)->get_controllable()->id() == c->id())) {
@@ -340,14 +352,14 @@ GenericMidiControlProtocol::start_learning (Controllable* c)
 
        if (!mc) {
                mc = new MIDIControllable (this, *_input_port->parser(), *c, false);
+               own_mc = true;
        }
-       
+
        {
                Glib::Threads::Mutex::Lock lm (pending_lock);
 
-               MIDIPendingControllable* element = new MIDIPendingControllable;
-               element->first = mc;
-               c->LearningFinished.connect_same_thread (element->second, boost::bind (&GenericMidiControlProtocol::learning_stopped, this, mc));
+               MIDIPendingControllable* element = new MIDIPendingControllable (mc, own_mc);
+               c->LearningFinished.connect_same_thread (element->connection, boost::bind (&GenericMidiControlProtocol::learning_stopped, this, mc));
 
                pending_controllables.push_back (element);
        }
@@ -360,15 +372,15 @@ GenericMidiControlProtocol::learning_stopped (MIDIControllable* mc)
 {
        Glib::Threads::Mutex::Lock lm (pending_lock);
        Glib::Threads::Mutex::Lock lm2 (controllables_lock);
-       
+
        MIDIPendingControllables::iterator tmp;
 
        for (MIDIPendingControllables::iterator i = pending_controllables.begin(); i != pending_controllables.end(); ) {
                tmp = i;
                ++tmp;
 
-               if ( (*i)->first == mc) {
-                       (*i)->second.disconnect();
+               if ( (*i)->mc == mc) {
+                       (*i)->connection.disconnect();
                        delete *i;
                        pending_controllables.erase(i);
                }
@@ -391,17 +403,17 @@ GenericMidiControlProtocol::stop_learning (Controllable* c)
        */
 
        for (MIDIPendingControllables::iterator i = pending_controllables.begin(); i != pending_controllables.end(); ++i) {
-               if (((*i)->first)->get_controllable() == c) {
-                       (*i)->first->stop_learning ();
-                       dptr = (*i)->first;
-                       (*i)->second.disconnect();
+               if (((*i)->mc)->get_controllable() == c) {
+                       (*i)->mc->stop_learning ();
+                       dptr = (*i)->mc;
+                       (*i)->connection.disconnect();
 
                        delete *i;
                        pending_controllables.erase (i);
                        break;
                }
        }
-       
+
        delete dptr;
 }
 
@@ -410,17 +422,17 @@ GenericMidiControlProtocol::delete_binding (PBD::Controllable* control)
 {
        if (control != 0) {
                Glib::Threads::Mutex::Lock lm2 (controllables_lock);
-               
+
                for (MIDIControllables::iterator iter = controllables.begin(); iter != controllables.end();) {
                        MIDIControllable* existingBinding = (*iter);
-                       
+
                        if (control == (existingBinding->get_controllable())) {
                                delete existingBinding;
                                iter = controllables.erase (iter);
                        } else {
                                ++iter;
                        }
-                       
+
                }
        }
 }
@@ -431,10 +443,10 @@ GenericMidiControlProtocol::create_binding (PBD::Controllable* control, int pos,
 {
        if (control != NULL) {
                Glib::Threads::Mutex::Lock lm2 (controllables_lock);
-               
+
                MIDI::channel_t channel = (pos & 0xf);
                MIDI::byte value = control_number;
-               
+
                // Create a MIDIControllable
                MIDIControllable* mc = new MIDIControllable (this, *_input_port->parser(), *control, false);
 
@@ -442,19 +454,19 @@ GenericMidiControlProtocol::create_binding (PBD::Controllable* control, int pos,
                // Note:  can't use delete_binding() here because we don't know the specific controllable we want to remove, only the midi information
                for (MIDIControllables::iterator iter = controllables.begin(); iter != controllables.end();) {
                        MIDIControllable* existingBinding = (*iter);
-                       
+
                        if ((existingBinding->get_control_channel() & 0xf ) == channel &&
                            existingBinding->get_control_additional() == value &&
                            (existingBinding->get_control_type() & 0xf0 ) == MIDI::controller) {
-                               
+
                                delete existingBinding;
                                iter = controllables.erase (iter);
                        } else {
                                ++iter;
                        }
-                       
+
                }
-               
+
                // Update the MIDI Controllable based on the the pos param
                // Here is where a table lookup for user mappings could go; for now we'll just wing it...
                mc->bind_midi(channel, MIDI::controller, value);
@@ -523,7 +535,7 @@ GenericMidiControlProtocol::check_used_event (int pos, int control_number)
 }
 
 XMLNode&
-GenericMidiControlProtocol::get_state () 
+GenericMidiControlProtocol::get_state ()
 {
        XMLNode& node (ControlProtocol::get_state());
        char buf[32];
@@ -533,6 +545,8 @@ GenericMidiControlProtocol::get_state ()
        snprintf (buf, sizeof (buf), "%d", _threshold);
        node.add_property (X_("threshold"), buf);
 
+       node.add_property (X_("motorized"), _motorised ? "yes" : "no");
+
        if (!_current_binding.empty()) {
                node.add_property ("binding", _current_binding);
        }
@@ -584,8 +598,14 @@ GenericMidiControlProtocol::set_state (const XMLNode& node, int version)
                _threshold = 10;
        }
 
+       if ((prop = node.property ("motorized")) != 0) {
+               _motorised = string_is_affirmative (prop->value ());
+       } else {
+               _motorised = false;
+       }
+
        boost::shared_ptr<Controllable> c;
-       
+
        {
                Glib::Threads::Mutex::Lock lm (pending_lock);
                for (MIDIPendingControllables::iterator i = pending_controllables.begin(); i != pending_controllables.end(); ++i) {
@@ -617,20 +637,20 @@ GenericMidiControlProtocol::set_state (const XMLNode& node, int version)
 
                        if (!nlist.empty()) {
                                for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
-                                       
+
                                        if ((prop = (*niter)->property ("id")) != 0) {
-                                               
+
                                                ID id = prop->value ();
                                                DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Relearned binding for session: Control ID: %1\n", id.to_s()));
                                                Controllable* c = Controllable::by_id (id);
-                                               
+
                                                if (c) {
                                                        MIDIControllable* mc = new MIDIControllable (this, *_input_port->parser(), *c, false);
-                                                       
+
                                                        if (mc->set_state (**niter, version) == 0) {
                                                                controllables.push_back (mc);
                                                        }
-                                                       
+
                                                } else {
                                                        warning << string_compose (
                                                                _("Generic MIDI control: controllable %1 not found in session (ignored)"),
@@ -689,7 +709,7 @@ GenericMidiControlProtocol::load_bindings (const string& xmlpath)
                sscanf (prop->value().c_str(), "%d.%d.%d", &major, &minor, &micro);
                Stateful::loading_state_version = (major * 1000) + minor;
        }
-       
+
        const XMLNodeList& children (root->children());
        XMLNodeConstIterator citer;
        XMLNodeConstIterator gciter;
@@ -700,7 +720,7 @@ GenericMidiControlProtocol::load_bindings (const string& xmlpath)
 
        DEBUG_TRACE (DEBUG::GenericMidi, "Loading bindings\n");
        for (citer = children.begin(); citer != children.end(); ++citer) {
-               
+
                if ((*citer)->name() == "DeviceInfo") {
                        const XMLProperty* prop;
 
@@ -709,7 +729,7 @@ GenericMidiControlProtocol::load_bindings (const string& xmlpath)
                                _current_bank = 0;
                        }
 
-                       if ((prop = (*citer)->property ("motorised")) != 0 || ((prop = (*citer)->property ("motorized")) != 0)) {
+                       if ((prop = (*citer)->property ("motorized")) != 0) {
                                _motorised = string_is_affirmative (prop->value ());
                        } else {
                                _motorised = false;
@@ -728,7 +748,7 @@ GenericMidiControlProtocol::load_bindings (const string& xmlpath)
 
                        if (child->property ("uri")) {
                                /* controllable */
-                               
+
                                if ((mc = create_binding (*child)) != 0) {
                                        Glib::Threads::Mutex::Lock lm2 (controllables_lock);
                                        controllables.push_back (mc);
@@ -752,7 +772,7 @@ GenericMidiControlProtocol::load_bindings (const string& xmlpath)
                         }
                }
        }
-       
+
        if ((prop = root->property ("name")) != 0) {
                _current_binding = prop->value ();
        }
@@ -772,7 +792,11 @@ GenericMidiControlProtocol::create_binding (const XMLNode& node)
        MIDI::eventType ev;
        int intval;
        bool momentary;
-       bool encoder = false;
+       MIDIControllable::Encoder encoder = MIDIControllable::No_enc;
+       bool rpn_value = false;
+       bool nrpn_value = false;
+       bool rpn_change = false;
+       bool nrpn_change = false;
 
        if ((prop = node.property (X_("ctl"))) != 0) {
                ev = MIDI::controller;
@@ -782,23 +806,40 @@ GenericMidiControlProtocol::create_binding (const XMLNode& node)
                ev = MIDI::program;
        } else if ((prop = node.property (X_("pb"))) != 0) {
                ev = MIDI::pitchbend;
-       } else if ((prop = node.property (X_("enc"))) != 0) {
-               encoder = true;
+       } else if ((prop = node.property (X_("enc-l"))) != 0) {
+               encoder = MIDIControllable::Enc_L;
+               ev = MIDI::controller;
+       } else if ((prop = node.property (X_("enc-r"))) != 0) {
+               encoder = MIDIControllable::Enc_R;
                ev = MIDI::controller;
+       } else if ((prop = node.property (X_("enc-2"))) != 0) {
+               encoder = MIDIControllable::Enc_2;
+               ev = MIDI::controller;
+       } else if ((prop = node.property (X_("enc-b"))) != 0) {
+               encoder = MIDIControllable::Enc_B;
+               ev = MIDI::controller;
+       } else if ((prop = node.property (X_("rpn"))) != 0) {
+               rpn_value = true;
+       } else if ((prop = node.property (X_("nrpn"))) != 0) {
+               nrpn_value = true;
+       } else if ((prop = node.property (X_("rpn-delta"))) != 0) {
+               rpn_change = true;
+       } else if ((prop = node.property (X_("nrpn-delta"))) != 0) {
+               nrpn_change = true;
        } else {
                return 0;
        }
-       
+
        if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
                return 0;
        }
-       
+
        detail = (MIDI::byte) intval;
 
        if ((prop = node.property (X_("channel"))) == 0) {
                return 0;
        }
-       
+
        if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
                return 0;
        }
@@ -813,7 +854,7 @@ GenericMidiControlProtocol::create_binding (const XMLNode& node)
        } else {
                momentary = false;
        }
-       
+
        prop = node.property (X_("uri"));
        uri = prop->value();
 
@@ -824,8 +865,18 @@ GenericMidiControlProtocol::create_binding (const XMLNode& node)
                return 0;
        }
 
-       mc->set_encoder (encoder);
-       mc->bind_midi (channel, ev, detail);
+       if (rpn_value) {
+               mc->bind_rpn_value (channel, detail);
+       } else if (nrpn_value) {
+               mc->bind_nrpn_value (channel, detail);
+       } else if (rpn_change) {
+               mc->bind_rpn_change (channel, detail);
+       } else if (nrpn_change) {
+               mc->bind_nrpn_change (channel, detail);
+       } else {
+               mc->set_encoder (encoder);
+               mc->bind_midi (channel, ev, detail);
+       }
 
        return mc;
 }
@@ -901,7 +952,7 @@ GenericMidiControlProtocol::create_function (const XMLNode& node)
                        cnt = 0;
                        stringstream ss (prop->value());
                        ss << hex;
-                       
+
                        while (ss >> val) {
                                cnt++;
                        }
@@ -913,12 +964,12 @@ GenericMidiControlProtocol::create_function (const XMLNode& node)
 
                data = new MIDI::byte[cnt];
                data_size = cnt;
-               
+
                {
                        stringstream ss (prop->value());
                        ss << hex;
                        cnt = 0;
-                       
+
                        while (ss >> val) {
                                data[cnt++] = (MIDI::byte) val;
                        }
@@ -933,13 +984,13 @@ GenericMidiControlProtocol::create_function (const XMLNode& node)
                if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
                        return 0;
                }
-               
+
                detail = (MIDI::byte) intval;
 
                if ((prop = node.property (X_("channel"))) == 0) {
                        return 0;
                }
-       
+
                if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
                        return 0;
                }
@@ -955,9 +1006,9 @@ GenericMidiControlProtocol::create_function (const XMLNode& node)
        }
 
        prop = node.property (X_("function"));
-       
+
        MIDIFunction* mf = new MIDIFunction (*_input_port->parser());
-       
+
        if (mf->setup (*this, prop->value(), argument, data, data_size)) {
                delete mf;
                return 0;
@@ -1001,7 +1052,7 @@ GenericMidiControlProtocol::create_action (const XMLNode& node)
                        cnt = 0;
                        stringstream ss (prop->value());
                        ss << hex;
-                       
+
                        while (ss >> val) {
                                cnt++;
                        }
@@ -1013,12 +1064,12 @@ GenericMidiControlProtocol::create_action (const XMLNode& node)
 
                data = new MIDI::byte[cnt];
                data_size = cnt;
-               
+
                {
                        stringstream ss (prop->value());
                        ss << hex;
                        cnt = 0;
-                       
+
                        while (ss >> val) {
                                data[cnt++] = (MIDI::byte) val;
                        }
@@ -1033,13 +1084,13 @@ GenericMidiControlProtocol::create_action (const XMLNode& node)
                if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
                        return 0;
                }
-               
+
                detail = (MIDI::byte) intval;
 
                if ((prop = node.property (X_("channel"))) == 0) {
                        return 0;
                }
-       
+
                if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
                        return 0;
                }
@@ -1051,9 +1102,9 @@ GenericMidiControlProtocol::create_action (const XMLNode& node)
        }
 
        prop = node.property (X_("action"));
-       
+
        MIDIAction* ma = new MIDIAction (*_input_port->parser());
-        
+
        if (ma->init (*this, prop->value(), data, data_size)) {
                delete ma;
                return 0;
@@ -1098,3 +1149,67 @@ GenericMidiControlProtocol::set_threshold (int t)
 {
        _threshold = t;
 }
+
+bool
+GenericMidiControlProtocol::connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool yn)
+{
+       if (!_input_port || !_output_port) {
+               return false;
+       }
+
+       string ni = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_input_port)->name());
+       string no = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_output_port)->name());
+
+       if (ni == name1 || ni == name2) {
+               if (yn) {
+                       connection_state |= InputConnected;
+               } else {
+                       connection_state &= ~InputConnected;
+               }
+       } else if (no == name1 || no == name2) {
+               if (yn) {
+                       connection_state |= OutputConnected;
+               } else {
+                       connection_state &= ~OutputConnected;
+               }
+       } else {
+               /* not our ports */
+               return false;
+       }
+
+       if ((connection_state & (InputConnected|OutputConnected)) == (InputConnected|OutputConnected)) {
+
+               /* XXX this is a horrible hack. Without a short sleep here,
+                  something prevents the device wakeup messages from being
+                  sent and/or the responses from being received.
+               */
+
+               g_usleep (100000);
+               connected ();
+
+       } else {
+
+       }
+
+       ConnectionChange (); /* emit signal for our GUI */
+
+       return true; /* connection status changed */
+}
+
+void
+GenericMidiControlProtocol::connected ()
+{
+       cerr << "Now connected\n";
+}
+
+boost::shared_ptr<Port>
+GenericMidiControlProtocol::output_port() const
+{
+       return _output_port;
+}
+
+boost::shared_ptr<Port>
+GenericMidiControlProtocol::input_port() const
+{
+       return _input_port;
+}