/*
- Copyright (C) 2009 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"
-#include "ardour/audioengine.h"
-#include "ardour/i18n.h"
-#include "pbd/failed_constructor.h"
-#include "pbd/error.h"
+#ifdef WAF_BUILD
+#include "libardour-config.h"
+#endif
+
#include "pbd/compose.h"
-#include <stdexcept>
+#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"
+
+#include "i18n.h"
-ARDOUR::AudioEngine* ARDOUR::Port::_engine = 0;
+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;
+
+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 */
-ARDOUR::Port::Port (std::string const & n, DataType t, Flags f, bool e) : _jack_port (0), _last_monitor (false), _latency (0), _name (n), _flags (f)
+Port::Port (std::string const & n, DataType t, PortFlags f)
+ : _port_buffer_offset (0)
+ , _name (n)
+ , _flags (f)
+ , _last_monitor (false)
{
- /* 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 virtual function type ()
- to establish type. */
+ _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 (e) {
- try {
- do_make_external (t);
- }
- catch (...) {
- throw failed_constructor ();
- }
+
+ 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));
}
/** Port destructor */
-ARDOUR::Port::~Port ()
+Port::~Port ()
{
- if (_jack_port) {
- jack_port_unregister (_engine->jack (), _jack_port);
- }
+ drop ();
}
-/** Make this port externally visible by setting it up to use a JACK port.
- * @param t Data type, so that we can call this method from the constructor.
- */
void
-ARDOUR::Port::do_make_external (DataType t)
+Port::drop ()
{
- if (_jack_port) {
- /* already external */
- return;
- }
-
- _jack_port = jack_port_register (_engine->jack (), _name.c_str (), t.to_jack_type (), _flags, 0);
- if (_jack_port == 0) {
- throw std::runtime_error ("Could not register JACK port");
+ 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
-ARDOUR::Port::make_external ()
-{
- do_make_external (type ());
-}
-
/** @return true if this port is connected to anything */
bool
-ARDOUR::Port::connected () const
+Port::connected () const
{
- if (!_connections.empty ()) {
- /* connected to a Port* */
- return true;
- }
-
- if (_jack_port == 0) {
- /* not using a JACK port, so can't be connected to anything else */
- return false;
- }
-
- return (jack_port_connected (_jack_port) != 0);
+ if (_port_handle) {
+ return (port_engine.connected (_port_handle) != 0);
+ }
+ return false;
}
int
-ARDOUR::Port::disconnect_all ()
+Port::disconnect_all ()
{
- /* Disconnect from Port* connections */
- for (std::set<Port*>::iterator i = _connections.begin (); i != _connections.end (); ++i) {
- (*i)->_connections.erase (this);
+ if (_port_handle) {
+
+ 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());
+ PostDisconnect (pself, boost::shared_ptr<Port>()); // emit signal
}
- _connections.clear ();
-
- /* And JACK connections */
- jack_port_disconnect (_engine->jack(), _jack_port);
- _named_connections.clear ();
-
return 0;
}
* @return true if this port is connected to o, otherwise false.
*/
bool
-ARDOUR::Port::connected_to (std::string const & o) const
+Port::connected_to (std::string const & o) const
{
- std::string const full = _engine->make_port_name_non_relative (o);
- std::string const shrt = _engine->make_port_name_non_relative (o);
-
- if (_jack_port && jack_port_connected_to (_jack_port, full.c_str ())) {
- /* connected via JACK */
- return true;
+ if (!_port_handle) {
+ return false;
}
- for (std::set<Port*>::iterator i = _connections.begin (); i != _connections.end (); ++i) {
- if ((*i)->name () == shrt) {
- /* connected internally */
- return true;
- }
+ if (!port_engine.available()) {
+ return false;
}
- 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
-ARDOUR::Port::get_connections (std::vector<std::string> & c) const
+Port::get_connections (std::vector<std::string> & c) const
{
- int n = 0;
-
- /* JACK connections */
- if (_jack_port) {
- 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();
}
- /* Internal connections */
- for (std::set<Port*>::iterator i = _connections.begin (); i != _connections.end (); ++i) {
- std::string const full = _engine->make_port_name_non_relative ((*i)->name());
- c.push_back (full);
- ++n;
- }
-
- return n;
+ return port_engine.get_connections (_port_handle, c);
}
int
-ARDOUR::Port::connect (std::string const & other)
+Port::connect (std::string const & other)
{
- /* caller must hold process lock */
-
- std::string const other_shrt = _engine->make_port_name_non_relative (other);
-
- Port* p = _engine->get_port_by_name_locked (other_shrt);
-
- int r;
-
- if (p && !p->external ()) {
- /* non-external Ardour port; connect using Port* */
- r = connect (p);
- } else {
- /* connect using 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);
- /* for this to work, we must be an external port */
- if (!external ()) {
- make_external ();
- }
+ int r = 0;
- std::string const this_shrt = _engine->make_port_name_non_relative (_name);
+ if (_connecting_blocked) {
+ return r;
+ }
- if (sends_output ()) {
- r = jack_connect (_engine->jack (), this_shrt.c_str (), other_shrt.c_str ());
- } else {
- r = jack_connect (_engine->jack (), other_shrt.c_str (), this_shrt.c_str());
- }
+ 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) {
- _named_connections.insert (other);
- }
+ if (r == 0) {
+ _connections.insert (other);
}
return r;
}
int
-ARDOUR::Port::disconnect (std::string const & other)
+Port::disconnect (std::string const & other)
{
- /* caller must hold process lock */
+ 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);
- std::string const other_shrt = _engine->make_port_name_non_relative (other);
-
- Port* p = _engine->get_port_by_name_locked (other_shrt);
- int r;
+ int r = 0;
- if (p && !p->external ()) {
- /* non-external Ardour port; disconnect using Port* */
- r = disconnect (p);
+ if (sends_output ()) {
+ r = port_engine.disconnect (this_fullname, other_fullname);
} else {
- /* disconnect using name */
-
- std::string const this_shrt = _engine->make_port_name_non_relative (_name);
+ r = port_engine.disconnect (other_fullname, this_fullname);
+ }
- if (sends_output ()) {
- r = jack_disconnect (_engine->jack (), this_shrt.c_str (), other_shrt.c_str ());
- } else {
- r = jack_disconnect (_engine->jack (), other_shrt.c_str (), this_shrt.c_str ());
- }
+ if (r == 0) {
+ _connections.erase (other);
+ }
- if (r == 0) {
- _named_connections.erase (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
}
return r;
bool
-ARDOUR::Port::connected_to (Port* o) const
+Port::connected_to (Port* o) const
{
return connected_to (o->name ());
}
int
-ARDOUR::Port::connect (Port* o)
+Port::connect (Port* o)
{
- /* caller must hold process lock */
-
- if (external () && o->external ()) {
- /* we're both external; connect using name */
- return connect (o->name ());
- }
-
- /* otherwise connect by Port* */
- _connections.insert (o);
- o->_connections.insert (this);
-
- return 0;
+ return connect (o->name ());
}
int
-ARDOUR::Port::disconnect (Port* o)
+Port::disconnect (Port* o)
{
- if (external () && o->external ()) {
- /* we're both external; try disconnecting using name */
- int const r = disconnect (o->name ());
- if (r == 0) {
- return 0;
- }
- }
-
- _connections.erase (o);
- o->_connections.erase (this);
-
- return 0;
+ return disconnect (o->name ());
}
void
-ARDOUR::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
-ARDOUR::Port::ensure_monitor_input (bool yn)
+Port::ensure_input_monitoring (bool yn)
{
- if (_jack_port) {
- jack_port_ensure_monitor (_jack_port, yn);
+ if (_port_handle) {
+ port_engine.ensure_input_monitoring (_port_handle, yn);
}
}
bool
-ARDOUR::Port::monitoring_input () const
+Port::monitoring_input () const
{
- if (_jack_port) {
- return jack_port_monitoring_input (_jack_port);
- } else {
- return false;
+ if (_port_handle) {
+ return port_engine.monitoring_input (_port_handle);
}
+ return false;
}
void
-ARDOUR::Port::reset ()
+Port::reset ()
{
_last_monitor = false;
+}
+
+void
+Port::cycle_start (pframes_t)
+{
+ _port_buffer_offset = 0;
+}
+
+void
+Port::increment_port_buffer_offset (pframes_t nframes)
+{
+ _port_buffer_offset += nframes;
+}
- // XXX
- // _metering = 0;
- // reset_meters ();
+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
-ARDOUR::Port::recompute_total_latency () const
+Port::set_private_latency_range (LatencyRange& range, bool playback)
{
-#ifdef HAVE_JACK_RECOMPUTE_LATENCY
- if (_jack_port) {
- jack_recompute_total_latency (_engine->jack (), _jack_port);
+ 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));
}
-#endif
+
+ /* push to public (port system) location so that everyone else can see it */
+
+ set_public_latency_range (range, playback);
}
-nframes_t
-ARDOUR::Port::total_latency () const
+const LatencyRange&
+Port::private_latency_range (bool playback) const
{
- if (_jack_port) {
- return jack_port_get_total_latency (_engine->jack (), _jack_port);
+ 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 {
- return _latency;
+ 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;
}
}
-int
-ARDOUR::Port::reestablish ()
+LatencyRange
+Port::public_latency_range (bool /*playback*/) const
{
- if (!_jack_port) {
- return 0;
+ 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"));
+ }
+
+ return r;
+}
+
+void
+Port::get_connected_latency_range (LatencyRange& range, bool playback) const
+{
+ vector<string> connections;
+
+ 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);
+ }
+ }
+ }
+
+ } else {
+ DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: not connected to anything\n", name()));
+ range.min = 0;
+ range.max = 0;
}
- _jack_port = jack_port_register (_engine->jack(), _name.c_str(), type().to_jack_type(), _flags, 0);
+ DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: final connected latency range [ %2 .. %3 ] \n", name(), range.min, range.max));
+}
- if (_jack_port == 0) {
+int
+Port::reestablish ()
+{
+ 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;
}
int
-ARDOUR::Port::reconnect ()
+Port::reconnect ()
{
/* caller must hold process lock; intended to be used only after reestablish() */
- if (!_jack_port) {
- return 0;
- }
-
- for (std::set<string>::iterator i = _named_connections.begin(); i != _named_connections.end(); ++i) {
+ 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;
}
return 0;
}
-/** @param n Short name */
+/** @param n Short port name (no port-system client name) */
int
-ARDOUR::Port::set_name (std::string const & n)
+Port::set_name (std::string const & n)
{
- assert (_name.find_first_of (':') == std::string::npos);
+ if (n == _name || !_port_handle) {
+ return 0;
+ }
- int r = 0;
-
- if (_jack_port) {
- r = jack_port_set_name (_jack_port, n.c_str());
- if (r) {
- _name = n;
- }
- } else {
+ int const r = port_engine.set_port_name (_port_handle, n);
+
+ if (r == 0) {
+ AudioEngine::instance()->port_renamed (_name, n);
_name = n;
}
+
return r;
}
-void
-ARDOUR::Port::set_latency (nframes_t n)
+bool
+Port::physically_connected () const
{
- _latency = n;
+ if (!_port_handle) {
+ return false;
+ }
+
+ return port_engine.physically_connected (_port_handle);
}
-void
-ARDOUR::Port::request_monitor_input (bool yn)
+XMLNode&
+Port::get_state () const
{
- if (_jack_port) {
- jack_port_request_monitor (_jack_port, yn);
+ XMLNode* root = new XMLNode (state_node_name);
+
+ root->add_property (X_("name"), AudioEngine::instance()->make_port_name_relative (name()));
+
+ if (receives_input()) {
+ root->add_property (X_("direction"), X_("input"));
+ } else {
+ root->add_property (X_("direction"), X_("output"));
+ }
+
+ 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
+Port::set_state (const XMLNode& node, int)
+{
+ const XMLProperty* 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;
}