X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fport.cc;h=5a7c859dbd29109015ff9895d0ba744c9bd8f711;hb=a473d630eb165272992e90f8d854b1d66ec0be63;hp=208c3914324027b0332fcd3f3c2ba0ba44d13f3e;hpb=d6637dad5a239d74038fdf9e5800e5108ba0c44f;p=ardour.git diff --git a/libs/ardour/port.cc b/libs/ardour/port.cc index 208c391432..5a7c859dbd 100644 --- a/libs/ardour/port.cc +++ b/libs/ardour/port.cc @@ -1,5 +1,5 @@ /* - 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 @@ -17,93 +17,82 @@ */ +#ifdef WAF_BUILD +#include "libardour-config.h" +#endif + +#include + +#include // so that we can test for new functions at runtime + +#include "pbd/error.h" +#include "pbd/compose.h" + +#include "ardour/debug.h" #include "ardour/port.h" #include "ardour/audioengine.h" -#include "ardour/i18n.h" #include "pbd/failed_constructor.h" -#include "pbd/error.h" -#include "pbd/compose.h" -#include -ARDOUR::AudioEngine* ARDOUR::Port::_engine = 0; +#include "i18n.h" -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) -{ - /* 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. */ - - if (e) { - try { - do_make_external (t); - } - catch (...) { - throw failed_constructor (); - } - } -} +using namespace std; +using namespace ARDOUR; +using namespace PBD; -/** Port destructor */ -ARDOUR::Port::~Port () -{ - if (_jack_port) { - jack_port_unregister (_engine->jack (), _jack_port); - } -} +AudioEngine* Port::_engine = 0; +bool Port::_connecting_blocked = false; +pframes_t Port::_global_port_buffer_offset = 0; +pframes_t Port::_cycle_nframes = 0; -/** 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) +/** @param n Port short name */ +Port::Port (std::string const & n, DataType t, Flags f) + : _port_buffer_offset (0) + , _name (n) + , _flags (f) + , _last_monitor (false) { - if (_jack_port) { - /* already external */ - return; + _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 JACK 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 (); } - - _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 ((_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"; + throw failed_constructor (); } } -void -ARDOUR::Port::make_external () +/** Port destructor */ +Port::~Port () { - do_make_external (type ()); + if (_engine->jack ()) { + jack_port_unregister (_engine->jack (), _jack_port); + } } /** @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); } int -ARDOUR::Port::disconnect_all () +Port::disconnect_all () { - /* Disconnect from Port* connections */ - for (std::set::iterator i = _connections.begin (); i != _connections.end (); ++i) { - (*i)->_connections.erase (this); - } - - _connections.clear (); - - /* And JACK connections */ jack_port_disconnect (_engine->jack(), _jack_port); - _named_connections.clear (); + _connections.clear (); return 0; } @@ -112,111 +101,86 @@ ARDOUR::Port::disconnect_all () * @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 { - if (_jack_port && jack_port_connected_to (_jack_port, o.c_str ())) { - /* connected via JACK */ - return true; - } - - for (std::set::iterator i = _connections.begin (); i != _connections.end (); ++i) { - if ((*i)->name () == o) { - /* connected internally */ - return true; - } + 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 false; + return jack_port_connected_to (_jack_port, + _engine->make_port_name_non_relative(o).c_str ()); } +/** @param o Filled in with port full names of ports that we are connected to */ int -ARDOUR::Port::get_connections (std::vector & c) const +Port::get_connections (std::vector & c) const { int n = 0; - /* JACK connections */ - if (_jack_port) { + 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; } - } - } - /* Internal connections */ - for (std::set::iterator i = _connections.begin (); i != _connections.end (); ++i) { - c.push_back ((*i)->name ()); - ++n; + if (jack_free) { + jack_free (jc); + } else { + free (jc); + } + } } return n; } int -ARDOUR::Port::connect (std::string const & other) +Port::connect (std::string const & other) { - /* caller must hold process lock */ - - Port* p = _engine->get_port_by_name_locked (other); - - int r; - - if (p && !p->external ()) { - /* non-external Ardour port; connect using Port* */ - r = connect (p); - } else { - /* connect using name */ + std::string const other_shrt = _engine->make_port_name_non_relative (other); + std::string const this_shrt = _engine->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_nr = _engine->make_port_name_non_relative (_name); - std::string const other_nr = _engine->make_port_name_non_relative (other); + if (_connecting_blocked) { + return r; + } - if (sends_output ()) { - r = jack_connect (_engine->jack (), this_nr.c_str (), other_nr.c_str ()); - } else { - r = jack_connect (_engine->jack (), other_nr.c_str (), this_nr.c_str()); - } + 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 (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 */ - - Port* p = _engine->get_port_by_name_locked (other); - int r; - - if (p && !p->external ()) { - /* non-external Ardour port; disconnect using Port* */ - r = disconnect (p); - } else { - /* disconnect using name */ + 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 this_nr = _engine->make_port_name_non_relative (_name); - std::string const other_nr = _engine->make_port_name_non_relative (other); + int r = 0; - if (sends_output ()) { - r = jack_disconnect (_engine->jack (), this_nr.c_str (), other_nr.c_str ()); - } else { - r = jack_disconnect (_engine->jack (), other_nr.c_str (), this_nr.c_str ()); - } + 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) { - _named_connections.erase (other); - } + if (r == 0) { + _connections.erase (other); } return r; @@ -224,107 +188,233 @@ ARDOUR::Port::disconnect (std::string const & other) 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::set_engine (AudioEngine* e) { _engine = e; } void -ARDOUR::Port::ensure_monitor_input (bool yn) +Port::ensure_monitor_input (bool yn) { - if (_jack_port) { - jack_port_ensure_monitor (_jack_port, yn); - } + jack_port_ensure_monitor (_jack_port, yn); } bool -ARDOUR::Port::monitoring_input () const +Port::monitoring_input () const { - if (_jack_port) { - return jack_port_monitoring_input (_jack_port); - } else { - return false; - } + return jack_port_monitoring_input (_jack_port); } void -ARDOUR::Port::reset () +Port::reset () { _last_monitor = false; +} + +void +Port::cycle_start (pframes_t nframes) +{ + _port_buffer_offset = 0; +} + +void +Port::increment_port_buffer_offset (pframes_t nframes) +{ + _port_buffer_offset += nframes; +} + +void +Port::set_public_latency_range (jack_latency_range_t& 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. + */ + + if (!jack_port_set_latency_range) { + return; + } - // XXX - // _metering = 0; - // reset_meters (); + 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); } void -ARDOUR::Port::recompute_total_latency () const +Port::set_private_latency_range (jack_latency_range_t& 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 (JACK) location so that everyone else can see it */ + + set_public_latency_range (range, playback); } -nframes_t -ARDOUR::Port::total_latency () const +const jack_latency_range_t& +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; } } +jack_latency_range_t +Port::public_latency_range (bool playback) const +{ + jack_latency_range_t r; + + 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 +{ + if (!jack_port_get_latency_range) { + return; + } + + vector 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; + + DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: %2 connections to check for latency range\n", name(), connections.size())); + + for (vector::const_iterator c = connections.begin(); + c != connections.end(); ++c) { + + jack_latency_range_t lr; + + if (!AudioEngine::instance()->port_is_mine (*c)) { + + /* port belongs to some other JACK client, use + * JACK to lookup its latency information. + */ + + jack_port_t* remote_port = jack_port_by_name (_engine->jack(), (*c).c_str()); + + if (remote_port) { + jack_port_get_latency_range ( + remote_port, + (playback ? JackPlaybackLatency : JackCaptureLatency), + &lr); + + 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. + */ + + Port* remote_port = AudioEngine::instance()->get_port_by_name (*c); + if (remote_port) { + lr = remote_port->private_latency_range ((playback ? JackPlaybackLatency : JackCaptureLatency)); + 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; + } + + DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: final connected latency range [ %2 .. %3 ] \n", name(), range.min, range.max)); +} + int -ARDOUR::Port::reestablish () +Port::reestablish () { - if (!_jack_port) { - return 0; + jack_client_t* jack = _engine->jack(); + + if (!jack) { + return -1; } - _jack_port = jack_port_register (_engine->jack(), _name.c_str(), type().to_jack_type(), _flags, 0); + _jack_port = jack_port_register (jack, _name.c_str(), type().to_jack_type(), _flags, 0); if (_jack_port == 0) { PBD::error << string_compose (_("could not reregister %1"), _name) << endmsg; @@ -338,15 +428,11 @@ ARDOUR::Port::reestablish () 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::iterator i = _named_connections.begin(); i != _named_connections.end(); ++i) { + for (std::set::iterator i = _connections.begin(); i != _connections.end(); ++i) { if (connect (*i)) { return -1; } @@ -355,18 +441,17 @@ ARDOUR::Port::reconnect () return 0; } - +/** @param n Short port name (no JACK client name) */ int -ARDOUR::Port::set_name (std::string const & n) +Port::set_name (std::string const & n) { - int r = 0; - - if (_jack_port) { - r = jack_port_set_name (_jack_port, n.c_str()); - if (r) { - _name = n; - } - } else { + if (n == _name) { + return 0; + } + + int const r = jack_port_set_name (_jack_port, n.c_str()); + + if (r == 0) { _name = n; } @@ -374,15 +459,37 @@ ARDOUR::Port::set_name (std::string const & n) } void -ARDOUR::Port::set_latency (nframes_t n) +Port::request_monitor_input (bool yn) { - _latency = n; + jack_port_request_monitor (_jack_port, yn); } -void -ARDOUR::Port::request_monitor_input (bool yn) +bool +Port::physically_connected () const { - if (_jack_port) { - jack_port_request_monitor (_jack_port, yn); + const char** jc = jack_port_get_connections (_jack_port); + + if (jc) { + for (int i = 0; jc[i]; ++i) { + + jack_port_t* port = jack_port_by_name (_engine->jack(), jc[i]); + + 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); + } } + + return false; } +