Clarify stop-at-session-end behaviour; should fix #4033.
[ardour.git] / libs / ardour / io.cc
index 21afdbae5657d1be5cd266fa1139f7928ba15965..24bc587c0d4503a4fa52045bd9e6fc8883765a6c 100644 (file)
@@ -34,6 +34,7 @@
 
 #include "ardour/audioengine.h"
 #include "ardour/buffer.h"
+#include "ardour/debug.h"
 #include "ardour/io.h"
 #include "ardour/route.h"
 #include "ardour/port.h"
@@ -96,31 +97,36 @@ IO::~IO ()
 }
 
 void
-IO::silence (framecnt_t nframes)
+IO::increment_port_buffer_offset (pframes_t offset)
 {
        /* io_lock, not taken: function must be called from Session::process() calltree */
 
-       for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
-               i->get_buffer(nframes).silence (nframes);
-       }
+        if (_direction == Output) {
+                for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
+                        i->increment_port_buffer_offset (offset);
+                }
+        }
 }
 
 void
-IO::check_bundles_connected ()
+IO::silence (framecnt_t nframes)
 {
-       check_bundles (_bundles_connected, ports());
+       /* io_lock, not taken: function must be called from Session::process() calltree */
+
+       for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
+               i->get_buffer(nframes).silence (nframes);
+       }
 }
 
-/** Check the bundles in list to see which are connected to a given PortSet,
- *  and update list with those that are connected such that every port on every
- *  bundle channel x is connected to port x in ports.
+/** Set _bundles_connected to those bundles that are connected such that every
+ *  port on every bundle channel x is connected to port x in _ports.
  */
 void
-IO::check_bundles (std::vector<UserBundleInfo*>& list, const PortSet& ports)
+IO::check_bundles_connected ()
 {
        std::vector<UserBundleInfo*> new_list;
 
-       for (std::vector<UserBundleInfo*>::iterator i = list.begin(); i != list.end(); ++i) {
+       for (std::vector<UserBundleInfo*>::iterator i = _bundles_connected.begin(); i != _bundles_connected.end(); ++i) {
 
                uint32_t const N = (*i)->bundle->nchannels().n_total();
 
@@ -134,7 +140,7 @@ IO::check_bundles (std::vector<UserBundleInfo*>& list, const PortSet& ports)
                        /* Every port on bundle channel j must be connected to our input j */
                        Bundle::PortList const pl = (*i)->bundle->channel_ports (j);
                        for (uint32_t k = 0; k < pl.size(); ++k) {
-                               if (ports.port(j)->connected_to (pl[k]) == false) {
+                               if (_ports.port(j)->connected_to (pl[k]) == false) {
                                        ok = false;
                                        break;
                                }
@@ -152,12 +158,12 @@ IO::check_bundles (std::vector<UserBundleInfo*>& list, const PortSet& ports)
                }
        }
 
-       list = new_list;
+       _bundles_connected = new_list;
 }
 
 
 int
-IO::disconnect (Port* our_port, string other_port, void* src)
+IO::disconnect (boost::shared_ptr<Port> our_port, string other_port, void* src)
 {
        if (other_port.length() == 0 || our_port == 0) {
                return 0;
@@ -165,23 +171,23 @@ IO::disconnect (Port* our_port, string other_port, void* src)
 
         {
                 Glib::Mutex::Lock lm (io_lock);
-                
+
                 /* check that our_port is really one of ours */
-                
+
                 if ( ! _ports.contains(our_port)) {
                         return -1;
                 }
-                
+
                 /* disconnect it from the source */
-                
+
                 if (our_port->disconnect (other_port)) {
                         error << string_compose(_("IO: cannot disconnect port %1 from %2"), our_port->name(), other_port) << endmsg;
                         return -1;
                 }
-                
+
                 check_bundles_connected ();
         }
-        
+
         changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
 
        _session.set_dirty ();
@@ -190,7 +196,7 @@ IO::disconnect (Port* our_port, string other_port, void* src)
 }
 
 int
-IO::connect (Port* our_port, string other_port, void* src)
+IO::connect (boost::shared_ptr<Port> our_port, string other_port, void* src)
 {
        if (other_port.length() == 0 || our_port == 0) {
                return 0;
@@ -198,27 +204,26 @@ IO::connect (Port* our_port, string other_port, void* src)
 
        {
                Glib::Mutex::Lock lm (io_lock);
-               
+
                /* check that our_port is really one of ours */
-               
+
                if ( ! _ports.contains(our_port) ) {
                        return -1;
                }
-               
+
                /* connect it to the source */
-               
+
                if (our_port->connect (other_port)) {
                        return -1;
                }
        }
-
        changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
        _session.set_dirty ();
        return 0;
 }
 
 int
-IO::remove_port (Port* port, void* src)
+IO::remove_port (boost::shared_ptr<Port> port, void* src)
 {
        ChanCount before = _ports.count ();
        ChanCount after = before;
@@ -246,7 +251,7 @@ IO::remove_port (Port* port, void* src)
                                        change.type = IOChange::Type (change.type | IOChange::ConnectionsChanged);
                                }
 
-                               _session.engine().unregister_port (*port);
+                               _session.engine().unregister_port (port);
                                check_bundles_connected ();
                        }
                }
@@ -255,7 +260,7 @@ IO::remove_port (Port* port, void* src)
 
                if (change.type != IOChange::NoChange) {
                        changed (change, src);
-                       _session.set_dirty ();
+                       _buffers.attach_buffers (_ports);
                }
        }
 
@@ -267,6 +272,8 @@ IO::remove_port (Port* port, void* src)
                return -1;
        }
 
+       _session.set_dirty ();
+       
        return 0;
 }
 
@@ -279,12 +286,21 @@ IO::remove_port (Port* port, void* src)
 int
 IO::add_port (string destination, void* src, DataType type)
 {
-       Port* our_port;
+       boost::shared_ptr<Port> our_port;
 
        if (type == DataType::NIL) {
                type = _default_type;
        }
 
+       ChanCount before = _ports.count ();
+       ChanCount after = before;
+       after.set (type, after.get (type) + 1);
+       
+       bool const r = PortCountChanging (after); /* EMIT SIGNAL */
+       if (r) {
+               return -1;
+       }
+       
        IOChange change;
 
        {
@@ -297,7 +313,7 @@ IO::add_port (string destination, void* src, DataType type)
                        /* Create a new port */
 
                        string portname = build_legal_port_name (type);
-
+                       
                        if (_direction == Input) {
                                if ((our_port = _session.engine().register_input_port (type, portname)) == 0) {
                                        error << string_compose(_("IO: cannot register input port %1"), portname) << endmsg;
@@ -313,16 +329,15 @@ IO::add_port (string destination, void* src, DataType type)
                        change.before = _ports.count ();
                        _ports.add (our_port);
                }
-
-               PortCountChanged (n_ports()); /* EMIT SIGNAL */
                
-               // pan_changed (src); /* EMIT SIGNAL */
+               PortCountChanged (n_ports()); /* EMIT SIGNAL */
                change.type = IOChange::ConfigurationChanged;
                change.after = _ports.count ();
                changed (change, src); /* EMIT SIGNAL */
+               _buffers.attach_buffers (_ports);
        }
 
-       if (destination.length()) {
+       if (!destination.empty()) {
                if (our_port->connect (destination)) {
                        return -1;
                }
@@ -339,27 +354,28 @@ IO::disconnect (void* src)
 {
        {
                Glib::Mutex::Lock lm (io_lock);
-               
+
                for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
                        i->disconnect_all ();
                }
-               
+
                check_bundles_connected ();
        }
-       
+
        changed (IOChange (IOChange::ConnectionsChanged), src); /* EMIT SIGNAL */
 
        return 0;
 }
 
 /** Caller must hold process lock */
-bool
-IO::ensure_ports_locked (ChanCount count, bool clear, void* /*src*/)
+int
+IO::ensure_ports_locked (ChanCount count, bool clear, bool& changed)
 {
        assert (!AudioEngine::instance()->process_lock().trylock());
-       
-       Port* port = 0;
-       bool  changed    = false;
+
+       boost::shared_ptr<Port> port;
+
+       changed    = false;
 
        for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
 
@@ -371,7 +387,7 @@ IO::ensure_ports_locked (ChanCount count, bool clear, void* /*src*/)
 
                        assert(port);
                        _ports.remove(port);
-                       _session.engine().unregister_port (*port);
+                       _session.engine().unregister_port (port);
 
                        changed = true;
                }
@@ -419,7 +435,7 @@ IO::ensure_ports_locked (ChanCount count, bool clear, void* /*src*/)
                }
        }
 
-       return changed;
+       return 0;
 }
 
 /** Caller must hold process lock */
@@ -427,7 +443,7 @@ int
 IO::ensure_ports (ChanCount count, bool clear, void* src)
 {
        assert (!AudioEngine::instance()->process_lock().trylock());
-       
+
        bool changed = false;
 
        if (count == n_ports() && !clear) {
@@ -437,10 +453,12 @@ IO::ensure_ports (ChanCount count, bool clear, void* src)
        IOChange change;
 
        change.before = _ports.count ();
-       
+
        {
                Glib::Mutex::Lock im (io_lock);
-               changed = ensure_ports_locked (count, clear, src);
+               if (ensure_ports_locked (count, clear, changed)) {
+                       return -1;
+               }
        }
 
        if (changed) {
@@ -460,12 +478,12 @@ int
 IO::ensure_io (ChanCount count, bool clear, void* src)
 {
        assert (!AudioEngine::instance()->process_lock().trylock());
-       
+
        return ensure_ports (count, clear, src);
 }
 
 XMLNode&
-IO::get_state (void)
+IO::get_state ()
 {
        return state (true);
 }
@@ -522,6 +540,9 @@ IO::state (bool /*full_state*/)
                node->add_child_nocopy (*pnode);
        }
 
+       snprintf (buf, sizeof (buf), "%" PRId64, _user_latency);
+       node->add_property (X_("user-latency"), buf);
+       
        return *node;
 }
 
@@ -556,9 +577,7 @@ IO::set_state (const XMLNode& node, int version)
                assert(_default_type != DataType::NIL);
        }
 
-       if ((prop = node.property ("id")) != 0) {
-               _id = prop->value ();
-       }
+       set_id (node);
 
        if ((prop = node.property ("direction")) != 0) {
                _direction = (Direction) string_2_enum (prop->value(), _direction);
@@ -582,6 +601,9 @@ IO::set_state (const XMLNode& node, int version)
                ConnectingLegal.connect_same_thread (connection_legal_c, boost::bind (&IO::connecting_became_legal, this));
        }
 
+       if ((prop = node.property ("user-latency")) != 0) {
+               _user_latency = atoi (prop->value ());
+       }
 
        return 0;
 }
@@ -611,9 +633,7 @@ IO::set_state_2X (const XMLNode& node, int version, bool in)
                assert(_default_type != DataType::NIL);
        }
 
-       if ((prop = node.property ("id")) != 0) {
-               _id = prop->value ();
-       }
+       set_id (node);
 
        _direction = in ? Input : Output;
 
@@ -840,7 +860,7 @@ IO::create_ports (const XMLNode& node, int version)
 
        {
                Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
-               
+
                if (ensure_ports (n, true, this)) {
                        error << string_compose(_("%1: cannot create I/O ports"), _name) << endmsg;
                        return -1;
@@ -883,7 +903,7 @@ IO::make_connections (const XMLNode& node, int version, bool in)
                                continue;
                        }
 
-                       Port* p = port_by_name (prop->value());
+                       boost::shared_ptr<Port> p = port_by_name (prop->value());
 
                        if (p) {
                                for (XMLNodeConstIterator c = (*i)->children().begin(); c != (*i)->children().end(); ++c) {
@@ -897,12 +917,12 @@ IO::make_connections (const XMLNode& node, int version, bool in)
                                        if ((prop = cnode->property (X_("other"))) == 0) {
                                                continue;
                                        }
-                                        
+
                                        if (prop) {
-                                               p->connect (prop->value());
+                                                connect (p, prop->value(), this);
                                        }
                                }
-                       } 
+                       }
                }
        }
 
@@ -1018,7 +1038,7 @@ IO::set_ports (const string& str)
 
        {
                Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
-               
+
                // FIXME: audio-only
                if (ensure_ports (ChanCount(DataType::AUDIO, nports), true, this)) {
                        return -1;
@@ -1117,7 +1137,7 @@ IO::set_name (const string& requested_name)
 
        /* replace all colons in the name. i wish we didn't have to do this */
 
-       replace_all (name, ":", "-"); 
+       replace_all (name, ":", "-");
 
        for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
                string current_name = i->name();
@@ -1132,16 +1152,6 @@ IO::set_name (const string& requested_name)
        return r;
 }
 
-void
-IO::set_port_latency (framecnt_t nframes)
-{
-       Glib::Mutex::Lock lm (io_lock);
-
-       for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
-               i->set_latency (nframes);
-       }
-}
-
 framecnt_t
 IO::latency () const
 {
@@ -1153,24 +1163,21 @@ IO::latency () const
        /* io lock not taken - must be protected by other means */
 
        for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
-               if ((latency = i->total_latency ()) > max_latency) {
+               if ((latency = i->private_latency_range (_direction == Output).max) > max_latency) {
+                        DEBUG_TRACE (DEBUG::Latency, string_compose ("port %1 has %2 latency of %3 - use\n",
+                                                                     name(),
+                                                                     ((_direction == Output) ? "PLAYBACK" : "CAPTURE"),
+                                                                     latency));
                        max_latency = latency;
                }
        }
 
+        DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: max %4 latency from %2 ports = %3\n",
+                                                     name(), _ports.num_ports(), max_latency,
+                                                     ((_direction == Output) ? "PLAYBACK" : "CAPTURE")));
        return max_latency;
 }
 
-void
-IO::update_port_total_latencies ()
-{
-       /* io_lock, not taken: function must be called from Session::process() calltree */
-
-       for (PortSet::iterator i = _ports.begin(); i != _ports.end(); ++i) {
-               _session.engine().update_total_latency (*i);
-       }
-}
-
 int
 IO::connect_ports_to_bundle (boost::shared_ptr<Bundle> c, void* src)
 {
@@ -1253,7 +1260,7 @@ IO::enable_connecting ()
 void
 IO::bundle_changed (Bundle::Change /*c*/)
 {
-       //XXX
+       /* XXX */
 //     connect_input_ports_to_bundle (_input_bundle, this);
 }
 
@@ -1292,7 +1299,12 @@ IO::build_legal_port_name (DataType type)
        char buf1[name_size+1];
        char buf2[name_size+1];
 
-       snprintf (buf1, name_size+1, ("%.*s/%s"), limit, _name.val().c_str(), suffix.c_str());
+       /* colons are illegal in port names, so fix that */
+
+       string nom = _name.val();
+       replace_all (nom, ":", ";");
+
+       snprintf (buf1, name_size+1, ("%.*s/%s"), limit, nom.c_str(), suffix.c_str());
 
        int port_number = find_port_hole (buf1);
        snprintf (buf2, name_size+1, "%s %d", buf1, port_number);
@@ -1334,14 +1346,14 @@ IO::find_port_hole (const char* base)
 }
 
 
-AudioPort*
+boost::shared_ptr<AudioPort>
 IO::audio(uint32_t n) const
 {
        return _ports.nth_audio_port (n);
 
 }
 
-MidiPort*
+boost::shared_ptr<MidiPort>
 IO::midi(uint32_t n) const
 {
        return _ports.nth_midi_port (n);
@@ -1475,10 +1487,14 @@ IO::name_from_state (const XMLNode& node)
 void
 IO::set_name_in_state (XMLNode& node, const string& new_name)
 {
-       const XMLProperty* prop;
-
-       if ((prop = node.property ("name")) != 0) {
-               node.add_property ("name", new_name);
+       node.add_property (X_("name"), new_name);
+       XMLNodeList children = node.children ();
+       for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
+               if ((*i)->name() == X_("Port")) {
+                       string const old_name = (*i)->property(X_("name"))->value();
+                       string const old_name_second_part = old_name.substr (old_name.find_first_of ("/") + 1);
+                       (*i)->add_property (X_("name"), string_compose ("%1/%2", new_name, old_name_second_part));
+               }
        }
 }
 
@@ -1486,13 +1502,13 @@ bool
 IO::connected () const
 {
         /* do we have any connections at all? */
-        
+
         for (PortSet::const_iterator p = _ports.begin(); p != _ports.end(); ++p) {
                 if (p->connected()) {
                         return true;
                 }
         }
-        
+
         return false;
 }
 
@@ -1520,12 +1536,30 @@ IO::connected_to (boost::shared_ptr<const IO> other) const
        return false;
 }
 
+bool
+IO::connected_to (const string& str) const
+{
+       for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
+               if (i->connected_to (str)) {
+                       return true;
+               }
+       }
+
+       return false;
+}
+
+/** Caller must hold process lock */
 void
 IO::process_input (boost::shared_ptr<Processor> proc, framepos_t start_frame, framepos_t end_frame, pframes_t nframes)
 {
        /* don't read the data into new buffers - just use the port buffers directly */
 
-       _buffers.get_jack_port_addresses (_ports, nframes, 0);
+       if (n_ports().n_total() == 0) {
+               /* We have no ports, so nothing to process */
+               return;
+       }
+
+       _buffers.get_jack_port_addresses (_ports, nframes);
        proc->run (_buffers, start_frame, end_frame, nframes, true);
 }
 
@@ -1583,21 +1617,19 @@ IO::copy_to_outputs (BufferSet& bufs, DataType type, pframes_t nframes, framecnt
        }
 }
 
-Port*
+boost::shared_ptr<Port>
 IO::port_by_name (const std::string& str) const
 {
        /* to be called only from ::set_state() - no locking */
 
        for (PortSet::const_iterator i = _ports.begin(); i != _ports.end(); ++i) {
 
-               const Port& p(*i);
-
-               if (p.name() == str) {
-                       return const_cast<Port*>(&p);
+               if (i->name() == str) {
+                       return boost::const_pointer_cast<Port> (*i);
                }
        }
 
-       return 0;
+       return boost::shared_ptr<Port> ();
 }
 
 bool
@@ -1613,7 +1645,7 @@ IO::physically_connected () const
 }
 
 bool
-IO::has_port (Port* p) const
+IO::has_port (boost::shared_ptr<Port> p) const
 {
        Glib::Mutex::Lock lm (io_lock);
        return _ports.contains (p);