Clarify stop-at-session-end behaviour; should fix #4033.
[ardour.git] / libs / ardour / port.cc
index 8bf08a7dff3d25105fdf6786f788372f9dbffb24..f36984a523f46d5882a69bb2763627f79abc2a11 100644 (file)
 #include "libardour-config.h"
 #endif
 
+#include <stdexcept>
+
+#include <jack/weakjack.h> // 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 "pbd/failed_constructor.h"
-#include "pbd/error.h"
-#include "pbd/compose.h"
-#include <stdexcept>
 
 #include "i18n.h"
 
 using namespace std;
 using namespace ARDOUR;
+using namespace PBD;
 
 AudioEngine* Port::_engine = 0;
-nframes_t Port::_port_offset = 0;
-nframes_t Port::_buffer_size = 0;
-bool Port::_connecting_blocked = false;
+bool         Port::_connecting_blocked = false;
+pframes_t    Port::_global_port_buffer_offset = 0;
+pframes_t    Port::_cycle_nframes = 0;
 
 /** @param n Port short name */
 Port::Port (std::string const & n, DataType t, Flags f)
-       : _last_monitor (false)
+       : _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 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 ();
+       }
+
        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 ();
        }
 }
@@ -60,7 +76,9 @@ Port::Port (std::string const & n, DataType t, Flags f)
 /** Port destructor */
 Port::~Port ()
 {
-       jack_port_unregister (_engine->jack (), _jack_port);
+       if (_engine->jack ()) {
+               jack_port_unregister (_engine->jack (), _jack_port);
+       }
 }
 
 /** @return true if this port is connected to anything */
@@ -85,7 +103,16 @@ Port::disconnect_all ()
 bool
 Port::connected_to (std::string const & o) const
 {
-       return jack_port_connected_to (_jack_port, _engine->make_port_name_non_relative(o).c_str ());
+       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 ());
 }
 
 /** @param o Filled in with port full names of ports that we are connected to */
@@ -94,14 +121,20 @@ Port::get_connections (std::vector<std::string> & c) const
 {
        int n = 0;
 
-       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 (_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 (jack_free) {
+                                jack_free (jc);
+                        } else {
+                                free (jc);
+                        }
+               }
        }
 
        return n;
@@ -110,8 +143,6 @@ Port::get_connections (std::vector<std::string> & c) const
 int
 Port::connect (std::string const & other)
 {
-       /* caller must hold process lock */
-
        std::string const other_shrt = _engine->make_port_name_non_relative (other);
        std::string const this_shrt = _engine->make_port_name_non_relative (_name);
 
@@ -137,8 +168,6 @@ Port::connect (std::string const & other)
 int
 Port::disconnect (std::string const & other)
 {
-       /* caller must hold process lock */
-
        std::string const other_shrt = _engine->make_port_name_non_relative (other);
        std::string const this_shrt = _engine->make_port_name_non_relative (_name);
 
@@ -154,7 +183,7 @@ Port::disconnect (std::string const & other)
                _connections.erase (other);
        }
 
-        return r;
+       return r;
 }
 
 
@@ -198,36 +227,182 @@ void
 Port::reset ()
 {
        _last_monitor = false;
+}
 
-       // XXX
-       // _metering = 0;
-       // reset_meters ();
+void
+Port::cycle_start (pframes_t)
+{
+        _port_buffer_offset = 0;
 }
 
 void
-Port::recompute_total_latency () const
+Port::increment_port_buffer_offset (pframes_t nframes)
 {
-#ifdef HAVE_JACK_RECOMPUTE_LATENCY
-       jack_client_t* jack = _engine->jack();
+        _port_buffer_offset += nframes;
+}
 
-       if (!jack) {
+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;
        }
 
-       jack_recompute_total_latency (jack, _jack_port);
-#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")));;
+
+       jack_port_set_latency_range (_jack_port,
+                                    (playback ? JackPlaybackLatency : JackCaptureLatency),
+                                    &range);
 }
 
-nframes_t
-Port::total_latency () const
+void
+Port::set_private_latency_range (jack_latency_range_t& range, bool playback)
 {
+       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 (JACK) location so that everyone else can see it */
+
+       set_public_latency_range (range, playback);
+}
+
+const jack_latency_range_t&
+Port::private_latency_range (bool playback) const
+{
+       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;
+       }
+}
+
+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<string> connections;
        jack_client_t* jack = _engine->jack();
 
        if (!jack) {
-               return 0;
+               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<string>::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.
+                                */
+
+                                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));
+                                        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;
        }
 
-       return jack_port_get_total_latency (jack, _jack_port);
+        DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: final connected latency range [ %2 .. %3 ] \n", name(), range.min, range.max));
 }
 
 int
@@ -239,7 +414,6 @@ Port::reestablish ()
                return -1;
        }
 
-       cerr << "RE-REGISTER: " << _name.c_str() << endl;
        _jack_port = jack_port_register (jack, _name.c_str(), type().to_jack_type(), _flags, 0);
 
        if (_jack_port == 0) {
@@ -290,12 +464,6 @@ Port::request_monitor_input (bool yn)
        jack_port_request_monitor (_jack_port, yn);
 }
 
-void
-Port::set_latency (nframes_t n)
-{
-       jack_port_set_latency (_jack_port, n);
-}
-
 bool
 Port::physically_connected () const
 {
@@ -304,17 +472,24 @@ Port::physically_connected () const
        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)) {
-                                jack_free (jc);
-                                return true;
-                        }
+                       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;
+                       }
                }
-                
-               jack_free (jc);
+                if (jack_free) {
+                        jack_free (jc);
+                } else {
+                        free (jc);
+                }
        }
 
-        return false;
+       return false;
 }