#include "libardour-config.h"
#endif
-#include <jack/weakjack.h> // so that we can test for new functions at runtime
+#include "pbd/compose.h"
+#include "pbd/error.h"
+#include "pbd/failed_constructor.h"
-#include "ardour/port.h"
#include "ardour/audioengine.h"
-#include "pbd/failed_constructor.h"
-#include "pbd/error.h"
-#include "pbd/compose.h"
-#include <stdexcept>
+#include "ardour/debug.h"
+#include "ardour/port.h"
+#include "ardour/port_engine.h"
#include "i18n.h"
using namespace std;
using namespace ARDOUR;
+using namespace PBD;
-AudioEngine* Port::_engine = 0;
-pframes_t Port::_buffer_size = 0;
-bool Port::_connecting_blocked = false;
+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 */
-Port::Port (std::string const & n, DataType t, Flags f)
- : _last_monitor (false)
+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 (!_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, 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));
}
/** Port destructor */
Port::~Port ()
{
- if (_engine->jack ()) {
- jack_port_unregister (_engine->jack (), _jack_port);
+ drop ();
+}
+
+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;
}
}
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) {
+
+ 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
+ }
return 0;
}
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.
- */
- return false;
- }
-
- return jack_port_connected_to (_jack_port, _engine->make_port_name_non_relative(o).c_str ());
+ 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));
}
-/** @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;
- }
-
- jack_free (jc);
- }
- }
+ if (!port_engine.available()) {
+ c.insert (c.end(), _connections.begin(), _connections.end());
+ return c.size();
+ }
- return n;
+ return port_engine.get_connections (_port_handle, c);
}
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;
}
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) {
int
Port::disconnect (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_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_shrt.c_str (), other_shrt.c_str ());
+ r = port_engine.disconnect (this_fullname, other_fullname);
} else {
- r = jack_disconnect (_engine->jack (), other_shrt.c_str (), this_shrt.c_str ());
+ r = port_engine.disconnect (other_fullname, this_fullname);
}
if (r == 0) {
_connections.erase (other);
}
- return r;
+ /* 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;
}
}
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_monitor_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::monitoring_input () const
{
- return jack_port_monitoring_input (_jack_port);
+ if (_port_handle) {
+ return port_engine.monitoring_input (_port_handle);
+ }
+ return false;
}
void
Port::reset ()
{
_last_monitor = false;
-
- // XXX
- // _metering = 0;
- // reset_meters ();
}
void
-Port::recompute_total_latency () const
+Port::cycle_start (pframes_t)
{
-#if !HAVE_JACK_NEW_LATENCY
-#ifdef HAVE_JACK_RECOMPUTE_LATENCY
- jack_client_t* jack = _engine->jack();
-
- if (!jack) {
- return;
- }
+ _port_buffer_offset = 0;
+}
- jack_recompute_total_latency (jack, _jack_port);
-#endif
-#endif
+void
+Port::increment_port_buffer_offset (pframes_t nframes)
+{
+ _port_buffer_offset += nframes;
}
void
-Port::set_latency_range (jack_latency_range_t& range, jack_latency_callback_mode_t mode) const
+Port::set_public_latency_range (LatencyRange& range, bool playback) const
{
-#if HAVE_JACK_NEW_LATENCY
- if (!jack_port_set_latency_range) {
- return;
- }
+ /* 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.
+ */
- jack_port_set_latency_range (_jack_port, mode, &range);
-#endif
+ 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
-Port::get_connected_latency_range (jack_latency_range_t& range, jack_latency_callback_mode_t mode) const
+Port::set_private_latency_range (LatencyRange& range, bool playback)
{
-#if HAVE_JACK_NEW_LATENCY
- 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.max = 0;
-
- for (vector<string>::iterator c = connections.begin(); c != connections.end(); ++c) {
- jack_port_t* remote_port = jack_port_by_name (_engine->jack(), (*c).c_str());
- jack_latency_range_t lr;
-
- if (remote_port) {
- jack_port_get_latency_range (remote_port, mode, &lr);
- range.min = min (range.min, lr.min);
- range.min = max (range.max, lr.max);
- }
- }
+ 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));
+ }
- } else {
+ /* push to public (port system) location so that everyone else can see it */
- range.min = 0;
- range.max = 0;
- }
-#endif /* HAVE_JACK_NEW_LATENCY */
+ set_public_latency_range (range, playback);
}
-framecnt_t
-Port::total_latency () const
+const LatencyRange&
+Port::private_latency_range (bool playback) const
{
-#if !HAVE_JACK_NEW_LATENCY
- jack_client_t* jack = _engine->jack();
+ 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 {
+ 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;
+ }
+}
- if (!jack) {
- return 0;
+LatencyRange
+Port::public_latency_range (bool /*playback*/) const
+{
+ 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 jack_port_get_total_latency (jack, _jack_port);
-#else
- return 0;
-#endif
+ return r;
}
-int
-Port::reestablish ()
+void
+Port::get_connected_latency_range (LatencyRange& range, bool playback) const
{
- jack_client_t* jack = _engine->jack();
+ vector<string> connections;
- if (!jack) {
- return -1;
+ 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;
}
- cerr << "RE-REGISTER: " << _name.c_str() << endl;
- _jack_port = jack_port_register (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;
}
{
/* 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;
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) {
+ AudioEngine::instance()->port_renamed (_name, n);
_name = n;
}
+
return r;
}
-void
-Port::request_monitor_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);
}
-void
-Port::set_latency (framecnt_t n)
+XMLNode&
+Port::get_state () const
{
-#if !HAVE_JACK_NEW_LATENCY
- jack_port_set_latency (_jack_port, n);
-#endif
+ 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;
}
-bool
-Port::physically_connected () const
+int
+Port::set_state (const XMLNode& node, int)
{
- const char** jc = jack_port_get_connections (_jack_port);
+ const XMLProperty* prop;
- if (jc) {
- for (int i = 0; jc[i]; ++i) {
+ if (node.name() != state_node_name) {
+ return -1;
+ }
- jack_port_t* port = jack_port_by_name (_engine->jack(), jc[i]);
-
- if (port && (jack_port_flags (port) & JackPortIsPhysical)) {
- jack_free (jc);
- return true;
- }
+ 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;
}
-
- jack_free (jc);
+
+ _connections.insert (prop->value());
}
- return false;
+ return 0;
}
-