fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / port.cc
index 0f28b31b579b8626c9c82e447e63298ac6c54cfb..33b41f5c046e40dd05a23a97ea1afd494a712378 100644 (file)
 #include "libardour-config.h"
 #endif
 
-#ifndef PLATFORM_WINDOWS
-#include <jack/weakjack.h> // so that we can test for new functions at runtime
-#endif
-
 #include "pbd/compose.h"
 #include "pbd/error.h"
 #include "pbd/failed_constructor.h"
@@ -32,8 +28,9 @@
 #include "ardour/audioengine.h"
 #include "ardour/debug.h"
 #include "ardour/port.h"
+#include "ardour/port_engine.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace ARDOUR;
@@ -41,14 +38,21 @@ using namespace PBD;
 
 PBD::Signal2<void,boost::shared_ptr<Port>, boost::shared_ptr<Port> > Port::PostDisconnect;
 PBD::Signal0<void> Port::PortDrop;
+PBD::Signal0<void> Port::PortSignalDrop;
 
-AudioEngine* Port::_engine = 0;
 bool         Port::_connecting_blocked = false;
 pframes_t    Port::_global_port_buffer_offset = 0;
 pframes_t    Port::_cycle_nframes = 0;
+std::string  Port::state_node_name = X_("Port");
+
+/* a handy define to shorten what would otherwise be a needlessly verbose
+ * repeated phrase
+ */
+#define port_engine AudioEngine::instance()->port_engine()
+#define port_manager AudioEngine::instance()
 
 /** @param n Port short name */
-Port::Port (std::string const & n, DataType t, Flags f)
+Port::Port (std::string const & n, DataType t, PortFlags f)
        : _port_buffer_offset (0)
        , _name (n)
        , _flags (f)
@@ -60,22 +64,21 @@ Port::Port (std::string const & n, DataType t, Flags f)
        _private_capture_latency.max = 0;
 
        /* Unfortunately we have to pass the DataType into this constructor so that
-          we can create the right kind of JACK port; aside from this we'll use the
+          we can create the right kind of port; aside from this we'll use the
           virtual function type () to establish type.
        */
 
        assert (_name.find_first_of (':') == std::string::npos);
 
-       if (!_engine->connected()) {
-               throw failed_constructor ();
-       }
-
-       if ((_jack_port = jack_port_register (_engine->jack (), _name.c_str (), t.to_jack_type (), _flags, 0)) == 0) {
-               cerr << "Failed to register JACK port \"" << _name << "\", reason is unknown from here\n";
+       if ((_port_handle = port_engine.register_port (_name, t, _flags)) == 0) {
+               cerr << "Failed to register port \"" << _name << "\", reason is unknown from here\n";
                throw failed_constructor ();
        }
 
        PortDrop.connect_same_thread (drop_connection, boost::bind (&Port::drop, this));
+       PortSignalDrop.connect_same_thread (drop_connection, boost::bind (&Port::signal_drop, this));
+       port_manager->PortConnectedOrDisconnected.connect_same_thread (engine_connection,
+                       boost::bind (&Port::port_connected_or_disconnected, this, _1, _3, _5));
 }
 
 /** Port destructor */
@@ -84,14 +87,72 @@ Port::~Port ()
        drop ();
 }
 
+
+std::string
+Port::pretty_name(bool fallback_to_name) const
+{
+       if (_port_handle) {
+               std::string value;
+               std::string type;
+               if (0 == port_engine.get_port_property (_port_handle,
+                                       "http://jackaudio.org/metadata/pretty-name",
+                                       value, type))
+               {
+                       return value;
+               }
+       }
+       if (fallback_to_name) {
+               return name ();
+       }
+       return "";
+}
+
+bool
+Port::set_pretty_name(const std::string& n)
+{
+       if (_port_handle) {
+               if (0 == port_engine.set_port_property (_port_handle,
+                                       "http://jackaudio.org/metadata/pretty-name", n, ""))
+               {
+                       return true;
+               }
+       }
+       return false;
+}
+
+void
+Port::signal_drop ()
+{
+       engine_connection.disconnect ();
+}
+
 void
 Port::drop ()
 {
-       if (_jack_port) {
-               if (_engine->jack ()) {
-                       jack_port_unregister (_engine->jack (), _jack_port);
-               }
-               _jack_port = 0;
+       if (_port_handle) {
+               DEBUG_TRACE (DEBUG::Ports, string_compose ("drop handle for port %1\n", name()));
+               port_engine.unregister_port (_port_handle);
+               _port_handle = 0;
+       }
+}
+
+void
+Port::port_connected_or_disconnected (boost::weak_ptr<Port> w0, boost::weak_ptr<Port> w1, bool con)
+{
+       if (con) {
+               /* we're only interested in disconnect */
+               return;
+       }
+       boost::shared_ptr<Port> p0 = w0.lock ();
+       boost::shared_ptr<Port> p1 = w1.lock ();
+       /* a cheaper, less hacky way to do boost::shared_from_this() ...  */
+       boost::shared_ptr<Port> pself = AudioEngine::instance()->get_port_by_name (name());
+
+       if (p0 == pself) {
+               PostDisconnect (p0, p1); // emit signal
+       }
+       if (p1 == pself) {
+               PostDisconnect (p1, p0); // emit signal
        }
 }
 
@@ -99,19 +160,33 @@ Port::drop ()
 bool
 Port::connected () const
 {
-       return (jack_port_connected (_jack_port) != 0);
+       if (_port_handle) {
+               return (port_engine.connected (_port_handle) != 0);
+       }
+       return false;
 }
 
 int
 Port::disconnect_all ()
 {
-       jack_port_disconnect (_engine->jack(), _jack_port);
-       _connections.clear ();
+       if (_port_handle) {
+
+               std::vector<std::string> connections;
+               get_connections (connections);
 
-       /* a cheaper, less hacky way to do boost::shared_from_this() ... 
-        */
-       boost::shared_ptr<Port> pself = _engine->get_port_by_name (name());
-       PostDisconnect (pself, boost::shared_ptr<Port>()); // emit signal
+               port_engine.disconnect_all (_port_handle);
+               _connections.clear ();
+
+               /* a cheaper, less hacky way to do boost::shared_from_this() ...
+                */
+               boost::shared_ptr<Port> pself = port_manager->get_port_by_name (name());
+               for (vector<string>::const_iterator c = connections.begin(); c != connections.end() && pself; ++c) {
+                       boost::shared_ptr<Port> pother = AudioEngine::instance()->get_port_by_name (*c);
+                       if (pother) {
+                               PostDisconnect (pself, pother); // emit signal
+                       }
+               }
+       }
 
        return 0;
 }
@@ -122,48 +197,37 @@ Port::disconnect_all ()
 bool
 Port::connected_to (std::string const & o) const
 {
-       if (!_engine->connected()) {
-               /* in some senses, this answer isn't the right one all the time,
-                  because we know about our connections and will re-establish
-                  them when we reconnect to JACK.
-               */
+       if (!_port_handle) {
                return false;
        }
 
-       return jack_port_connected_to (_jack_port,
-                                      _engine->make_port_name_non_relative(o).c_str ());
+       if (!port_engine.available()) {
+               return false;
+       }
+
+       return port_engine.connected_to (_port_handle, AudioEngine::instance()->make_port_name_non_relative (o));
 }
 
-/** @param o Filled in with port full names of ports that we are connected to */
 int
 Port::get_connections (std::vector<std::string> & c) const
 {
-       int n = 0;
-
-       if (_engine->connected()) {
-               const char** jc = jack_port_get_connections (_jack_port);
-               if (jc) {
-                       for (int i = 0; jc[i]; ++i) {
-                               c.push_back (jc[i]);
-                               ++n;
-                       }
+       if (!port_engine.available()) {
+               c.insert (c.end(), _connections.begin(), _connections.end());
+               return c.size();
+       }
 
-                        if (jack_free) {
-                                jack_free (jc);
-                        } else {
-                                free (jc);
-                        }
-               }
+       if (_port_handle) {
+               return port_engine.get_connections (_port_handle, c);
        }
 
-       return n;
+       return 0;
 }
 
 int
 Port::connect (std::string const & other)
 {
-       std::string const other_shrt = _engine->make_port_name_non_relative (other);
-       std::string const this_shrt = _engine->make_port_name_non_relative (_name);
+       std::string const other_name = AudioEngine::instance()->make_port_name_non_relative (other);
+       std::string const our_name = AudioEngine::instance()->make_port_name_non_relative (_name);
 
        int r = 0;
 
@@ -172,9 +236,11 @@ Port::connect (std::string const & other)
        }
 
        if (sends_output ()) {
-               r = jack_connect (_engine->jack (), this_shrt.c_str (), other_shrt.c_str ());
+               DEBUG_TRACE (DEBUG::Ports, string_compose ("Connect %1 to %2\n", our_name, other_name));
+               r = port_engine.connect (our_name, other_name);
        } else {
-               r = jack_connect (_engine->jack (), other_shrt.c_str (), this_shrt.c_str());
+               DEBUG_TRACE (DEBUG::Ports, string_compose ("Connect %1 to %2\n", other_name, our_name));
+               r = port_engine.connect (other_name, our_name);
        }
 
        if (r == 0) {
@@ -187,32 +253,31 @@ Port::connect (std::string const & other)
 int
 Port::disconnect (std::string const & other)
 {
-       std::string const other_fullname = _engine->make_port_name_non_relative (other);
-       std::string const this_fullname = _engine->make_port_name_non_relative (_name);
+       std::string const other_fullname = port_manager->make_port_name_non_relative (other);
+       std::string const this_fullname = port_manager->make_port_name_non_relative (_name);
 
        int r = 0;
 
        if (sends_output ()) {
-               r = jack_disconnect (_engine->jack (), this_fullname.c_str (), other_fullname.c_str ());
+               r = port_engine.disconnect (this_fullname, other_fullname);
        } else {
-               r = jack_disconnect (_engine->jack (), other_fullname.c_str (), this_fullname.c_str ());
+               r = port_engine.disconnect (other_fullname, this_fullname);
        }
 
        if (r == 0) {
                _connections.erase (other);
        }
 
-       /* a cheaper, less hacky way to do boost::shared_from_this() ... 
-        */
-       boost::shared_ptr<Port> pself = _engine->get_port_by_name (name());
-       boost::shared_ptr<Port> pother = _engine->get_port_by_name (other);
+       /* a cheaper, less hacky way to do boost::shared_from_this() ...  */
+       boost::shared_ptr<Port> pself = AudioEngine::instance()->get_port_by_name (name());
+       boost::shared_ptr<Port> pother = AudioEngine::instance()->get_port_by_name (other);
 
        if (pself && pother) {
                /* Disconnecting from another Ardour port: need to allow
                   a check on whether this may affect anything that we
                   need to know about.
                */
-               PostDisconnect (pself, pother); // emit signal 
+               PostDisconnect (pself, pother); // emit signal
        }
 
        return r;
@@ -238,21 +303,28 @@ Port::disconnect (Port* o)
 }
 
 void
-Port::set_engine (AudioEngine* e)
+Port::request_input_monitoring (bool yn)
 {
-       _engine = e;
+       if (_port_handle) {
+               port_engine.request_input_monitoring (_port_handle, yn);
+       }
 }
 
 void
-Port::ensure_jack_monitors_input (bool yn)
+Port::ensure_input_monitoring (bool yn)
 {
-       jack_port_ensure_monitor (_jack_port, yn);
+       if (_port_handle) {
+               port_engine.ensure_input_monitoring (_port_handle, yn);
+       }
 }
 
 bool
-Port::jack_monitoring_input () const
+Port::monitoring_input () const
 {
-       return jack_port_monitoring_input (_jack_port);
+       if (_port_handle) {
+               return port_engine.monitoring_input (_port_handle);
+       }
+       return false;
 }
 
 void
@@ -274,28 +346,25 @@ Port::increment_port_buffer_offset (pframes_t nframes)
 }
 
 void
-Port::set_public_latency_range (jack_latency_range_t& range, bool playback) const
+Port::set_public_latency_range (LatencyRange& range, bool playback) const
 {
-       /* this sets the visible latency that the rest of JACK sees. because we do latency
-          compensation, all (most) of our visible port latency values are identical.
+       /* this sets the visible latency that the rest of the port system
+          sees. because we do latency compensation, all (most) of our visible
+          port latency values are identical.
        */
 
-       if (!jack_port_set_latency_range) {
-               return;
-       }
-
        DEBUG_TRACE (DEBUG::Latency,
                     string_compose ("SET PORT %1 %4 PUBLIC latency now [%2 - %3]\n",
                                     name(), range.min, range.max,
                                     (playback ? "PLAYBACK" : "CAPTURE")));;
 
-       jack_port_set_latency_range (_jack_port,
-                                    (playback ? JackPlaybackLatency : JackCaptureLatency),
-                                    &range);
+       if (_port_handle) {
+               port_engine.set_latency_range (_port_handle, playback, range);
+       }
 }
 
 void
-Port::set_private_latency_range (jack_latency_range_t& range, bool playback)
+Port::set_private_latency_range (LatencyRange& range, bool playback)
 {
        if (playback) {
                _private_playback_latency = range;
@@ -313,12 +382,12 @@ Port::set_private_latency_range (jack_latency_range_t& range, bool playback)
                                     _private_capture_latency.max));
        }
 
-       /* push to public (JACK) location so that everyone else can see it */
+       /* push to public (port system) location so that everyone else can see it */
 
        set_public_latency_range (range, playback);
 }
 
-const jack_latency_range_t&
+const LatencyRange&
 Port::private_latency_range (bool playback) const
 {
        if (playback) {
@@ -338,43 +407,34 @@ Port::private_latency_range (bool playback) const
        }
 }
 
-jack_latency_range_t
+LatencyRange
 Port::public_latency_range (bool /*playback*/) const
 {
-       jack_latency_range_t r;
+       LatencyRange r;
+
+
+       if (_port_handle) {
+               r = port_engine.get_latency_range (_port_handle, sends_output() ? true : false);
+
+               DEBUG_TRACE (DEBUG::Latency, string_compose (
+                                    "GET PORT %1: %4 PUBLIC latency range %2 .. %3\n",
+                                    name(), r.min, r.max,
+                                    sends_output() ? "PLAYBACK" : "CAPTURE"));
+       }
 
-       jack_port_get_latency_range (_jack_port,
-                                    sends_output() ? JackPlaybackLatency : JackCaptureLatency,
-                                    &r);
-       DEBUG_TRACE (DEBUG::Latency, string_compose (
-                            "GET PORT %1: %4 PUBLIC latency range %2 .. %3\n",
-                            name(), r.min, r.max,
-                            sends_output() ? "PLAYBACK" : "CAPTURE"));
        return r;
 }
 
 void
-Port::get_connected_latency_range (jack_latency_range_t& range, bool playback) const
+Port::get_connected_latency_range (LatencyRange& range, bool playback) const
 {
-       if (!jack_port_get_latency_range) {
-               return;
-       }
-
        vector<string> connections;
-       jack_client_t* jack = _engine->jack();
-
-       if (!jack) {
-               range.min = 0;
-               range.max = 0;
-               PBD::warning << _("get_connected_latency_range() called while disconnected from JACK") << endmsg;
-               return;
-       }
 
        get_connections (connections);
 
        if (!connections.empty()) {
 
-               range.min = ~((jack_nframes_t) 0);
+               range.min = ~((pframes_t) 0);
                range.max = 0;
 
                DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: %2 connections to check for latency range\n", name(), connections.size()));
@@ -382,21 +442,18 @@ Port::get_connected_latency_range (jack_latency_range_t& range, bool playback) c
                for (vector<string>::const_iterator c = connections.begin();
                     c != connections.end(); ++c) {
 
-                        jack_latency_range_t lr;
+                        LatencyRange lr;
 
                         if (!AudioEngine::instance()->port_is_mine (*c)) {
 
-                                /* port belongs to some other JACK client, use
-                                 * JACK to lookup its latency information.
+                                /* port belongs to some other port-system client, use
+                                 * the port engine to lookup its latency information.
                                  */
 
-                                jack_port_t* remote_port = jack_port_by_name (_engine->jack(), (*c).c_str());
+                               PortEngine::PortHandle remote_port = port_engine.get_port_by_name (*c);
 
                                 if (remote_port) {
-                                        jack_port_get_latency_range (
-                                                remote_port,
-                                                (playback ? JackPlaybackLatency : JackCaptureLatency),
-                                                &lr);
+                                        lr = port_engine.get_latency_range (remote_port, playback);
 
                                         DEBUG_TRACE (DEBUG::Latency, string_compose (
                                                              "\t%1 <-> %2 : latter has latency range %3 .. %4\n",
@@ -417,7 +474,7 @@ Port::get_connected_latency_range (jack_latency_range_t& range, bool playback) c
 
                                 boost::shared_ptr<Port> remote_port = AudioEngine::instance()->get_port_by_name (*c);
                                 if (remote_port) {
-                                        lr = remote_port->private_latency_range ((playback ? JackPlaybackLatency : JackCaptureLatency));
+                                        lr = remote_port->private_latency_range ((playback ? true : false));
                                         DEBUG_TRACE (DEBUG::Latency, string_compose (
                                                              "\t%1 <-LOCAL-> %2 : latter has latency range %3 .. %4\n",
                                                              name(), *c, lr.min, lr.max));
@@ -440,21 +497,18 @@ Port::get_connected_latency_range (jack_latency_range_t& range, bool playback) c
 int
 Port::reestablish ()
 {
-       jack_client_t* jack = _engine->jack();
-
-       if (!jack) {
-               return -1;
-       }
+       DEBUG_TRACE (DEBUG::Ports, string_compose ("re-establish %1 port %2\n", type().to_string(), _name));
+       _port_handle = port_engine.register_port (_name, type(), _flags);
 
-       _jack_port = jack_port_register (jack, _name.c_str(), type().to_jack_type(), _flags, 0);
-
-       if (_jack_port == 0) {
+       if (_port_handle == 0) {
                PBD::error << string_compose (_("could not reregister %1"), _name) << endmsg;
                return -1;
        }
 
        reset ();
 
+       port_manager->PortConnectedOrDisconnected.connect_same_thread (engine_connection,
+                       boost::bind (&Port::port_connected_or_disconnected, this, _1, _3, _5));
        return 0;
 }
 
@@ -464,6 +518,8 @@ Port::reconnect ()
 {
        /* caller must hold process lock; intended to be used only after reestablish() */
 
+       DEBUG_TRACE (DEBUG::Ports, string_compose ("Connect %1 to %2 destinations\n",name(), _connections.size()));
+
        for (std::set<string>::iterator i = _connections.begin(); i != _connections.end(); ++i) {
                if (connect (*i)) {
                        return -1;
@@ -473,18 +529,18 @@ Port::reconnect ()
        return 0;
 }
 
-/** @param n Short port name (no JACK client name) */
+/** @param n Short port name (no port-system client name) */
 int
 Port::set_name (std::string const & n)
 {
-       if (n == _name) {
+       if (n == _name || !_port_handle) {
                return 0;
        }
 
-       int const r = jack_port_set_name (_jack_port, n.c_str());
+       int const r = port_engine.set_port_name (_port_handle, n);
 
        if (r == 0) {
-               _engine->port_renamed (_name, n);
+               AudioEngine::instance()->port_renamed (_name, n);
                _name = n;
        }
 
@@ -492,38 +548,71 @@ Port::set_name (std::string const & n)
        return r;
 }
 
-void
-Port::request_jack_monitors_input (bool yn)
+bool
+Port::physically_connected () const
 {
-       jack_port_request_monitor (_jack_port, yn);
+       if (!_port_handle) {
+               return false;
+       }
+
+       return port_engine.physically_connected (_port_handle);
 }
 
-bool
-Port::physically_connected () const
+XMLNode&
+Port::get_state () const
 {
-       const char** jc = jack_port_get_connections (_jack_port);
+       XMLNode* root = new XMLNode (state_node_name);
 
-       if (jc) {
-               for (int i = 0; jc[i]; ++i) {
+       root->add_property (X_("name"), AudioEngine::instance()->make_port_name_relative (name()));
 
-                       jack_port_t* port = jack_port_by_name (_engine->jack(), jc[i]);
+       if (receives_input()) {
+               root->add_property (X_("direction"), X_("input"));
+       } else {
+               root->add_property (X_("direction"), X_("output"));
+       }
 
-                       if (port && (jack_port_flags (port) & JackPortIsPhysical)) {
-                                if (jack_free) {
-                                        jack_free (jc);
-                                } else {
-                                        free (jc);
-                                }
-                               return true;
-                       }
-               }
-                if (jack_free) {
-                        jack_free (jc);
-                } else {
-                        free (jc);
-                }
+       vector<string> c;
+
+       get_connections (c);
+
+       for (vector<string>::const_iterator i = c.begin(); i != c.end(); ++i) {
+               XMLNode* child = new XMLNode (X_("Connection"));
+               child->add_property (X_("other"), *i);
+               root->add_child_nocopy (*child);
        }
 
-       return false;
+       return *root;
 }
 
+int
+Port::set_state (const XMLNode& node, int)
+{
+       XMLProperty const * prop;
+
+       if (node.name() != state_node_name) {
+               return -1;
+       }
+
+       if ((prop = node.property (X_("name"))) != 0) {
+               set_name (prop->value());
+       }
+
+       const XMLNodeList& children (node.children());
+
+       _connections.clear ();
+
+       for (XMLNodeList::const_iterator c = children.begin(); c != children.end(); ++c) {
+
+               if ((*c)->name() != X_("Connection")) {
+                       continue;
+               }
+
+               if ((prop = (*c)->property (X_("other"))) == 0) {
+                       continue;
+               }
+
+               _connections.insert (prop->value());
+       }
+
+       return 0;
+}