/*
- Copyright (C) 2002-2006 Paul Davis
+ Copyright (C) 2009 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
*/
-#include <ardour/port.h>
+#ifdef WAF_BUILD
+#include "libardour-config.h"
+#endif
-using namespace ARDOUR;
-using namespace std;
+#include "pbd/compose.h"
+#include "pbd/error.h"
+#include "pbd/failed_constructor.h"
+
+#include "ardour/audioengine.h"
+#include "ardour/debug.h"
+#include "ardour/port.h"
+#include "ardour/port_engine.h"
-AudioEngine* Port::engine = 0;
+#include "pbd/i18n.h"
-Port::Port (const std::string& name, Flags flgs)
- : _flags (flgs)
- , _name (name)
- , _metering (0)
- , _last_monitor (false)
+using namespace std;
+using namespace ARDOUR;
+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;
+
+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, PortFlags f)
+ : _port_buffer_offset (0)
+ , _name (n)
+ , _flags (f)
+ , _last_monitor (false)
{
+ _private_playback_latency.min = 0;
+ _private_playback_latency.max = 0;
+ _private_capture_latency.min = 0;
+ _private_capture_latency.max = 0;
+
+ /* Unfortunately we have to pass the DataType into this constructor so that
+ 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 ((_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 */
Port::~Port ()
{
- disconnect_all ();
+ drop ();
}
-void
-Port::reset ()
+
+std::string
+Port::pretty_name(bool fallback_to_name) const
{
- _last_monitor = false;
+ 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 "";
}
-void
-Port::set_engine (AudioEngine* e)
+bool
+Port::set_pretty_name(const std::string& n)
{
- engine = e;
+ if (_port_handle) {
+ if (0 == port_engine.set_port_property (_port_handle,
+ "http://jackaudio.org/metadata/pretty-name", n, ""))
+ {
+ return true;
+ }
+ }
+ return false;
}
-int
-Port::connect (Port& other)
+void
+Port::signal_drop ()
{
- /* caller must hold process lock */
-
- pair<set<Port*>::iterator,bool> result;
-
- result = _connections.insert (&other);
+ engine_connection.disconnect ();
+}
- if (result.second) {
- return 0;
- } else {
- return 1;
+void
+Port::drop ()
+{
+ 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;
}
}
-int
-Port::disconnect (Port& other)
-{
- /* caller must hold process lock */
-
- for (set<Port*>::iterator i = _connections.begin(); i != _connections.end(); ++i) {
- if ((*i) == &other) {
- _connections.erase (i);
- return 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());
- return -1;
+ if (p0 == pself) {
+ PostDisconnect (p0, p1); // emit signal
+ }
+ if (p1 == pself) {
+ PostDisconnect (p1, p0); // emit signal
+ }
}
+/** @return true if this port is connected to anything */
+bool
+Port::connected () const
+{
+ if (_port_handle) {
+ return (port_engine.connected (_port_handle) != 0);
+ }
+ return false;
+}
int
Port::disconnect_all ()
{
- /* caller must hold process lock */
+ if (_port_handle) {
+
+ std::vector<std::string> connections;
+ get_connections (connections);
+
+ 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
+ }
+ }
+ }
- _connections.clear ();
return 0;
}
-void
-Port::set_latency (nframes_t val)
-{
- _latency = val;
-}
-
+/** @param o Port name
+ * @return true if this port is connected to o, otherwise false.
+ */
bool
-Port::connected() const
+Port::connected_to (std::string const & o) const
{
- /* caller must hold process lock */
- return !_connections.empty();
+ if (!_port_handle) {
+ return false;
+ }
+
+ if (!port_engine.available()) {
+ return false;
+ }
+
+ return port_engine.connected_to (_port_handle, AudioEngine::instance()->make_port_name_non_relative (o));
}
-bool
-Port::connected_to (const string& portname) const
+int
+Port::get_connections (std::vector<std::string> & c) const
{
- /* caller must hold process lock */
+ if (!port_engine.available()) {
+ c.insert (c.end(), _connections.begin(), _connections.end());
+ return c.size();
+ }
- for (set<Port*>::const_iterator p = _connections.begin(); p != _connections.end(); ++p) {
- if ((*p)->name() == portname) {
- return true;
- }
+ if (_port_handle) {
+ return port_engine.get_connections (_port_handle, c);
}
- return false;
+ return 0;
}
int
-Port::get_connections (vector<string>& names) const
+Port::connect (std::string const & other)
{
- /* caller must hold process lock */
- int i = 0;
- set<Port*>::const_iterator p;
+ 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;
- for (i = 0, p = _connections.begin(); p != _connections.end(); ++p, ++i) {
- names.push_back ((*p)->name());
+ if (_connecting_blocked) {
+ return r;
}
- return i;
-}
+ if (sends_output ()) {
+ DEBUG_TRACE (DEBUG::Ports, string_compose ("Connect %1 to %2\n", our_name, other_name));
+ r = port_engine.connect (our_name, other_name);
+ } else {
+ 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) {
+ _connections.insert (other);
+ }
-//-------------------------------------
+ return r;
+}
int
-PortFacade::set_name (const std::string& str)
+Port::disconnect (std::string const & other)
{
- int ret;
+ 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);
- if (_ext_port) {
- if ((ret = _ext_port->set_name (str)) == 0) {
- _name = _ext_port->name();
- }
+ int r = 0;
+
+ if (sends_output ()) {
+ r = port_engine.disconnect (this_fullname, other_fullname);
} else {
- _name = str;
- ret = 0;
+ r = port_engine.disconnect (other_fullname, this_fullname);
}
- return ret;
-}
+ if (r == 0) {
+ _connections.erase (other);
+ }
-string
-PortFacade::short_name () const
-{
- if (_ext_port) {
- return _ext_port->short_name();
- } else {
- return _name;
+ /* 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
}
+
+ return r;
}
-int
-PortFacade::reestablish ()
+bool
+Port::connected_to (Port* o) const
{
- if (_ext_port) {
- return _ext_port->reestablish ();
- } else {
- return 0;
- }
+ return connected_to (o->name ());
}
+int
+Port::connect (Port* o)
+{
+ return connect (o->name ());
+}
int
-PortFacade::reconnect()
+Port::disconnect (Port* o)
{
- if (_ext_port) {
- return _ext_port->reconnect ();
- } else {
- return 0;
- }
+ return disconnect (o->name ());
}
void
-PortFacade::set_latency (nframes_t val)
+Port::request_input_monitoring (bool yn)
{
- if (_ext_port) {
- _ext_port->set_latency (val);
- } else {
- _latency = val;
+ if (_port_handle) {
+ port_engine.request_input_monitoring (_port_handle, yn);
}
}
-nframes_t
-PortFacade::latency() const
+void
+Port::ensure_input_monitoring (bool yn)
{
- if (_ext_port) {
- return _ext_port->latency();
- } else {
- return _latency;
+ if (_port_handle) {
+ port_engine.ensure_input_monitoring (_port_handle, yn);
}
}
-nframes_t
-PortFacade::total_latency() const
+bool
+Port::monitoring_input () const
{
- if (_ext_port) {
- return _ext_port->total_latency();
- } else {
- return _latency;
+ if (_port_handle) {
+ return port_engine.monitoring_input (_port_handle);
}
+ return false;
}
-bool
-PortFacade::monitoring_input() const
+void
+Port::reset ()
{
- if (_ext_port) {
- return _ext_port->monitoring_input ();
- } else {
- return false;
- }
+ _last_monitor = false;
+}
+
+void
+Port::cycle_start (pframes_t)
+{
+ _port_buffer_offset = 0;
}
void
-PortFacade::ensure_monitor_input (bool yn)
+Port::increment_port_buffer_offset (pframes_t nframes)
{
- if (_ext_port) {
- _ext_port->ensure_monitor_input (yn);
+ _port_buffer_offset += nframes;
+}
+
+void
+Port::set_public_latency_range (LatencyRange& range, bool playback) const
+{
+ /* 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.
+ */
+
+ DEBUG_TRACE (DEBUG::Latency,
+ string_compose ("SET PORT %1 %4 PUBLIC latency now [%2 - %3]\n",
+ name(), range.min, range.max,
+ (playback ? "PLAYBACK" : "CAPTURE")));;
+
+ if (_port_handle) {
+ port_engine.set_latency_range (_port_handle, playback, range);
}
}
void
-PortFacade::request_monitor_input (bool yn)
+Port::set_private_latency_range (LatencyRange& range, bool playback)
{
- if (_ext_port) {
- _ext_port->request_monitor_input (yn);
- }
+ if (playback) {
+ _private_playback_latency = range;
+ DEBUG_TRACE (DEBUG::Latency, string_compose (
+ "SET PORT %1 playback PRIVATE latency now [%2 - %3]\n",
+ name(),
+ _private_playback_latency.min,
+ _private_playback_latency.max));
+ } else {
+ _private_capture_latency = range;
+ DEBUG_TRACE (DEBUG::Latency, string_compose (
+ "SET PORT %1 capture PRIVATE latency now [%2 - %3]\n",
+ name(),
+ _private_capture_latency.min,
+ _private_capture_latency.max));
+ }
+
+ /* push to public (port system) location so that everyone else can see it */
+
+ set_public_latency_range (range, playback);
}
-int
-PortFacade::connect (Port& other)
+const LatencyRange&
+Port::private_latency_range (bool playback) const
{
- int ret;
-
- if (_ext_port) {
- ret = _ext_port->connect (other);
+ if (playback) {
+ DEBUG_TRACE (DEBUG::Latency, string_compose (
+ "GET PORT %1 playback PRIVATE latency now [%2 - %3]\n",
+ name(),
+ _private_playback_latency.min,
+ _private_playback_latency.max));
+ return _private_playback_latency;
} else {
- ret = 0;
+ DEBUG_TRACE (DEBUG::Latency, string_compose (
+ "GET PORT %1 capture PRIVATE latency now [%2 - %3]\n",
+ name(),
+ _private_playback_latency.min,
+ _private_playback_latency.max));
+ return _private_capture_latency;
}
+}
+
+LatencyRange
+Port::public_latency_range (bool /*playback*/) const
+{
+ LatencyRange r;
- if (ret == 0) {
- ret = Port::connect (other);
+
+ 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"));
}
- return ret;
+ return r;
}
-int
-PortFacade::connect (const std::string& other)
+void
+Port::get_connected_latency_range (LatencyRange& range, bool playback) const
{
- PortConnectableByName* pcn;
+ vector<string> connections;
- if (!_ext_port) {
- return -1;
- }
-
- pcn = dynamic_cast<PortConnectableByName*>(_ext_port);
+ get_connections (connections);
+
+ if (!connections.empty()) {
+
+ 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()));
+
+ for (vector<string>::const_iterator c = connections.begin();
+ c != connections.end(); ++c) {
+
+ LatencyRange lr;
+
+ if (!AudioEngine::instance()->port_is_mine (*c)) {
+
+ /* port belongs to some other port-system client, use
+ * the port engine to lookup its latency information.
+ */
+
+ PortEngine::PortHandle remote_port = port_engine.get_port_by_name (*c);
+
+ if (remote_port) {
+ 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",
+ name(), *c, lr.min, lr.max));
+
+ range.min = min (range.min, lr.min);
+ range.max = max (range.max, lr.max);
+ }
+
+ } else {
+
+ /* port belongs to this instance of ardour,
+ so look up its latency information
+ internally, because our published/public
+ values already contain our plugin
+ latency compensation.
+ */
+
+ boost::shared_ptr<Port> remote_port = AudioEngine::instance()->get_port_by_name (*c);
+ if (remote_port) {
+ 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));
+
+ range.min = min (range.min, lr.min);
+ range.max = max (range.max, lr.max);
+ }
+ }
+ }
- if (pcn) {
- return pcn->connect (other);
} else {
- return -1;
+ DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: not connected to anything\n", name()));
+ range.min = 0;
+ range.max = 0;
}
-}
+ DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: final connected latency range [ %2 .. %3 ] \n", name(), range.min, range.max));
+}
int
-PortFacade::disconnect (Port& other)
+Port::reestablish ()
{
- int reta;
- int retb;
-
- if (_ext_port) {
- reta = _ext_port->disconnect (other);
- } else {
- reta = 0;
+ 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);
+
+ if (_port_handle == 0) {
+ PBD::error << string_compose (_("could not reregister %1"), _name) << endmsg;
+ return -1;
}
- retb = Port::disconnect (other);
+ reset ();
- return reta || retb;
+ port_manager->PortConnectedOrDisconnected.connect_same_thread (engine_connection,
+ boost::bind (&Port::port_connected_or_disconnected, this, _1, _3, _5));
+ return 0;
}
-int
-PortFacade::disconnect_all ()
+
+int
+Port::reconnect ()
{
- int reta = 0;
- int retb = 0;
+ /* caller must hold process lock; intended to be used only after reestablish() */
- if (_ext_port) {
- reta = _ext_port->disconnect_all ();
- }
+ DEBUG_TRACE (DEBUG::Ports, string_compose ("Connect %1 to %2 destinations\n",name(), _connections.size()));
- retb = Port::disconnect_all ();
+ for (std::set<string>::iterator i = _connections.begin(); i != _connections.end(); ++i) {
+ if (connect (*i)) {
+ return -1;
+ }
+ }
- return reta || retb;
+ return 0;
}
-
+
+/** @param n Short port name (no port-system client name) */
int
-PortFacade::disconnect (const std::string& other)
+Port::set_name (std::string const & n)
{
- PortConnectableByName* pcn;
-
- if (!_ext_port) {
- return -1;
+ if (n == _name || !_port_handle) {
+ return 0;
}
-
- pcn = dynamic_cast<PortConnectableByName*>(_ext_port);
- if (pcn) {
- return pcn->disconnect (other);
- } else {
- return -1;
+ int const r = port_engine.set_port_name (_port_handle, n);
+
+ if (r == 0) {
+ AudioEngine::instance()->port_renamed (_name, n);
+ _name = n;
}
+
+
+ return r;
}
bool
-PortFacade::connected () const
+Port::physically_connected () const
{
- if (Port::connected()) {
- return true;
- }
-
- if (_ext_port) {
- return _ext_port->connected();
+ if (!_port_handle) {
+ return false;
}
- return false;
+ return port_engine.physically_connected (_port_handle);
}
-bool
-PortFacade::connected_to (const std::string& portname) const
+
+XMLNode&
+Port::get_state () const
{
- if (Port::connected_to (portname)) {
- return true;
- }
+ XMLNode* root = new XMLNode (state_node_name);
+
+ root->add_property (X_("name"), AudioEngine::instance()->make_port_name_relative (name()));
- if (_ext_port) {
- return _ext_port->connected_to (portname);
+ if (receives_input()) {
+ root->add_property (X_("direction"), X_("input"));
+ } else {
+ root->add_property (X_("direction"), X_("output"));
}
- return false;
+ 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 *root;
}
int
-PortFacade::get_connections (vector<string>& names) const
+Port::set_state (const XMLNode& node, int)
{
- int i = 0;
+ XMLProperty const * prop;
- if (_ext_port) {
- i = _ext_port->get_connections (names);
+ if (node.name() != state_node_name) {
+ return -1;
}
- i += Port::get_connections (names);
+ if ((prop = node.property (X_("name"))) != 0) {
+ set_name (prop->value());
+ }
- return i;
-}
+ const XMLNodeList& children (node.children());
-void
-PortFacade::reset ()
-{
- Port::reset ();
+ _connections.clear ();
+
+ for (XMLNodeList::const_iterator c = children.begin(); c != children.end(); ++c) {
- if (_ext_port) {
- _ext_port->reset ();
+ if ((*c)->name() != X_("Connection")) {
+ continue;
+ }
+
+ if ((prop = (*c)->property (X_("other"))) == 0) {
+ continue;
+ }
+
+ _connections.insert (prop->value());
}
+
+ return 0;
}
projects / ardour.git / blobdiff